DynFlags.hs 94.6 KB
Newer Older
1
2
3
{-# OPTIONS_GHC -w #-}
-- Temporary, until rtsIsProfiled is fixed

4
-- |
5
6
7
8
9
10
-- Dynamic flags
--
--
-- (c) The University of Glasgow 2005
--

11
-- Most flags are dynamic flags, which means they can change from
12
13
14
-- compilation to compilation using @OPTIONS_GHC@ pragmas, and in a
-- multi-session GHC each session can be using different dynamic
-- flags.  Dynamic flags can also be set at the prompt in GHCi.
15
module DynFlags (
16
        -- * Dynamic flags and associated configuration types
Ian Lynagh's avatar
Ian Lynagh committed
17
        DynFlag(..),
18
        ExtensionFlag(..),
19
        glasgowExtsFlags,
20
21
22
23
24
25
        dopt,
        dopt_set,
        dopt_unset,
        xopt,
        xopt_set,
        xopt_unset,
Ian Lynagh's avatar
Ian Lynagh committed
26
        DynFlags(..),
Ian Lynagh's avatar
Ian Lynagh committed
27
        RtsOptsEnabled(..),
Ian Lynagh's avatar
Ian Lynagh committed
28
29
30
31
        HscTarget(..), isObjectTarget, defaultObjectTarget,
        GhcMode(..), isOneShot,
        GhcLink(..), isNoLink,
        PackageFlag(..),
Ian Lynagh's avatar
Ian Lynagh committed
32
        Option(..), showOpt,
Ian Lynagh's avatar
Ian Lynagh committed
33
        DynLibLoader(..),
34
        fFlags, fLangFlags, xFlags,
35
        DPHBackend(..), dphPackageMaybe,
36
        wayNames,
37

38
        -- ** Manipulating DynFlags
Ian Lynagh's avatar
Ian Lynagh committed
39
40
41
        defaultDynFlags,                -- DynFlags
        initDynFlags,                   -- DynFlags -> IO DynFlags

42
        getOpts,                        -- DynFlags -> (DynFlags -> [a]) -> [a]
Ian Lynagh's avatar
Ian Lynagh committed
43
44
45
46
        getVerbFlag,
        updOptLevel,
        setTmpDir,
        setPackageName,
47
        doingTickyProfiling,
Ian Lynagh's avatar
Ian Lynagh committed
48

49
        -- ** Parsing DynFlags
Ian Lynagh's avatar
Ian Lynagh committed
50
        parseDynamicFlags,
51
        parseDynamicNoPackageFlags,
52
        allFlags,
53

54
        supportedLanguagesAndExtensions,
55
56

        -- ** DynFlag C compiler options
Ian Lynagh's avatar
Ian Lynagh committed
57
        machdepCCOpts, picCCOpts,
58
59
60
61
62
63

        -- * Configuration of the stg-to-stg passes
        StgToDo(..),
        getStgToDo,

        -- * Compiler configuration suitable for display to the user
64
        Printable(..),
65
66
67
68
69
70
        compilerInfo
#ifdef GHCI
-- Only in stage 2 can we be sure that the RTS 
-- exposes the appropriate runtime boolean
        , rtsIsProfiled
#endif
71
72
73
74
  ) where

#include "HsVersions.h"

75
#ifndef OMIT_NATIVE_CODEGEN
76
import Platform
77
#endif
78
import Module
Simon Marlow's avatar
Simon Marlow committed
79
import PackageConfig
80
import PrelNames        ( mAIN )
81
import StaticFlags
82
import {-# SOURCE #-} Packages (PackageState)
Ian Lynagh's avatar
Ian Lynagh committed
83
import DriverPhases     ( Phase(..), phaseInputExt )
84
85
import Config
import CmdLineParser
Ian Lynagh's avatar
Ian Lynagh committed
86
import Constants        ( mAX_CONTEXT_REDUCTION_DEPTH )
87
import Panic
88
import Util
89
import Maybes           ( orElse )
90
import SrcLoc
91
import FastString
Simon Marlow's avatar
Simon Marlow committed
92
import Outputable
93
import Foreign.C	( CInt )
Simon Marlow's avatar
Simon Marlow committed
94
import {-# SOURCE #-} ErrUtils ( Severity(..), Message, mkLocMessage )
95

96
import System.IO.Unsafe	( unsafePerformIO )
97
import Data.IORef
Ian Lynagh's avatar
Ian Lynagh committed
98
import Control.Monad    ( when )
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
99

100
import Data.Char
101
import Data.List
102
103
import Data.Map (Map)
import qualified Data.Map as Map
104
import Data.Maybe
Ian Lynagh's avatar
Ian Lynagh committed
105
import System.FilePath
106
import System.IO        ( stderr, hPutChar )
107

108
109
110
-- -----------------------------------------------------------------------------
-- DynFlags

111
-- | Enumerates the simple on-or-off dynamic flags
112
113
114
115
data DynFlag

   -- debugging flags
   = Opt_D_dump_cmm
116
   | Opt_D_dump_cmmz
117
   | Opt_D_dump_cmmz_pretty
118
   | Opt_D_dump_cps_cmm
119
   | Opt_D_dump_cvt_cmm
120
   | Opt_D_dump_asm
121
122
   | Opt_D_dump_asm_native
   | Opt_D_dump_asm_liveness
123
   | Opt_D_dump_asm_coalesce
124
125
126
   | Opt_D_dump_asm_regalloc
   | Opt_D_dump_asm_regalloc_stages
   | Opt_D_dump_asm_conflicts
127
   | Opt_D_dump_asm_stats
128
   | Opt_D_dump_asm_expanded
129
   | Opt_D_dump_llvm
130
131
132
133
134
135
   | Opt_D_dump_cpranal
   | Opt_D_dump_deriv
   | Opt_D_dump_ds
   | Opt_D_dump_flatC
   | Opt_D_dump_foreign
   | Opt_D_dump_inlinings
136
   | Opt_D_dump_rule_firings
137
   | Opt_D_dump_rule_rewrites
138
139
140
141
142
   | Opt_D_dump_occur_anal
   | Opt_D_dump_parsed
   | Opt_D_dump_rn
   | Opt_D_dump_simpl
   | Opt_D_dump_simpl_iterations
143
   | Opt_D_dump_simpl_phases
144
145
146
147
148
149
150
151
152
153
154
155
156
   | Opt_D_dump_spec
   | Opt_D_dump_prep
   | Opt_D_dump_stg
   | Opt_D_dump_stranal
   | Opt_D_dump_tc
   | Opt_D_dump_types
   | Opt_D_dump_rules
   | Opt_D_dump_cse
   | Opt_D_dump_worker_wrapper
   | Opt_D_dump_rn_trace
   | Opt_D_dump_rn_stats
   | Opt_D_dump_opt_cmm
   | Opt_D_dump_simpl_stats
157
   | Opt_D_dump_cs_trace	-- Constraint solver in type checker
158
159
   | Opt_D_dump_tc_trace
   | Opt_D_dump_if_trace
160
   | Opt_D_dump_vt_trace
161
162
163
   | Opt_D_dump_splices
   | Opt_D_dump_BCOs
   | Opt_D_dump_vect
andy@galois.com's avatar
andy@galois.com committed
164
   | Opt_D_dump_hpc
pepe's avatar
pepe committed
165
   | Opt_D_dump_rtti
166
167
168
169
170
171
   | Opt_D_source_stats
   | Opt_D_verbose_core2core
   | Opt_D_verbose_stg2stg
   | Opt_D_dump_hi
   | Opt_D_dump_hi_diffs
   | Opt_D_dump_minimal_imports
172
   | Opt_D_dump_mod_cycles
173
   | Opt_D_dump_view_pattern_commoning
174
   | Opt_D_faststring_stats
Ian Lynagh's avatar
Ian Lynagh committed
175
   | Opt_DumpToFile                     -- ^ Append dump output to files instead of stdout.
Simon Marlow's avatar
Simon Marlow committed
176
   | Opt_D_no_debug_output
177
178
179
   | Opt_DoCoreLinting
   | Opt_DoStgLinting
   | Opt_DoCmmLinting
Ben.Lippmeier@anu.edu.au's avatar
Ben.Lippmeier@anu.edu.au committed
180
   | Opt_DoAsmLinting
181

Ian Lynagh's avatar
Ian Lynagh committed
182
   | Opt_WarnIsError                    -- -Werror; makes warnings fatal
183
184
   | Opt_WarnDuplicateExports
   | Opt_WarnHiShadows
185
   | Opt_WarnImplicitPrelude
186
   | Opt_WarnIncompletePatterns
187
   | Opt_WarnIncompleteUniPatterns
188
189
   | Opt_WarnIncompletePatternsRecUpd
   | Opt_WarnMissingFields
190
   | Opt_WarnMissingImportList
191
192
   | Opt_WarnMissingMethods
   | Opt_WarnMissingSigs
193
   | Opt_WarnMissingLocalSigs
194
195
196
   | Opt_WarnNameShadowing
   | Opt_WarnOverlappingPatterns
   | Opt_WarnTypeDefaults
197
   | Opt_WarnMonomorphism
198
199
200
   | Opt_WarnUnusedBinds
   | Opt_WarnUnusedImports
   | Opt_WarnUnusedMatches
Ian Lynagh's avatar
Ian Lynagh committed
201
   | Opt_WarnWarningsDeprecations
202
   | Opt_WarnDeprecatedFlags
203
   | Opt_WarnDodgyExports
204
205
   | Opt_WarnDodgyImports
   | Opt_WarnOrphans
206
   | Opt_WarnAutoOrphans
207
   | Opt_WarnIdentities
208
   | Opt_WarnTabs
209
   | Opt_WarnUnrecognisedPragmas
210
   | Opt_WarnDodgyForeignImports
211
   | Opt_WarnLazyUnliftedBindings
212
213
   | Opt_WarnUnusedDoBind
   | Opt_WarnWrongDoBind
214
   | Opt_WarnAlternativeLayoutRuleTransitional
215

216
217
   | Opt_PrintExplicitForalls

218
219
220
   -- optimisation opts
   | Opt_Strictness
   | Opt_FullLaziness
221
222
   | Opt_FloatIn
   | Opt_Specialise
223
   | Opt_StaticArgumentTransformation
224
   | Opt_CSE
225
226
   | Opt_LiberateCase
   | Opt_SpecConstr
227
228
229
230
231
   | Opt_DoLambdaEtaExpansion
   | Opt_IgnoreAsserts
   | Opt_DoEtaReduction
   | Opt_CaseMerge
   | Opt_UnboxStrictFields
232
   | Opt_MethodSharing	-- Now a no-op; remove in GHC 7.2
233
   | Opt_DictsCheap
234
   | Opt_EnableRewriteRules		-- Apply rewrite rules during simplification
rl@cse.unsw.edu.au's avatar
rl@cse.unsw.edu.au committed
235
   | Opt_Vectorise
Ian Lynagh's avatar
Ian Lynagh committed
236
237
   | Opt_RegsGraph                      -- do graph coloring register allocation
   | Opt_RegsIterative                  -- do iterative coalescing graph coloring register allocation
238

239
240
241
242
243
   -- Interface files
   | Opt_IgnoreInterfacePragmas
   | Opt_OmitInterfacePragmas
   | Opt_ExposeAllUnfoldings

Ian Lynagh's avatar
Ian Lynagh committed
244
245
246
247
248
   -- profiling opts
   | Opt_AutoSccsOnAllToplevs
   | Opt_AutoSccsOnExportedToplevs
   | Opt_AutoSccsOnIndividualCafs

249
250
   -- misc opts
   | Opt_Pp
251
   | Opt_ForceRecomp
252
253
254
   | Opt_DryRun
   | Opt_DoAsmMangling
   | Opt_ExcessPrecision
255
   | Opt_EagerBlackHoling
256
257
258
259
   | Opt_ReadUserPackageConf
   | Opt_NoHsMain
   | Opt_SplitObjs
   | Opt_StgStats
260
   | Opt_HideAllPackages
261
   | Opt_PrintBindResult
262
   | Opt_Haddock
David Waern's avatar
David Waern committed
263
   | Opt_HaddockOptions
264
   | Opt_Hpc_No_Auto
265
   | Opt_BreakOnException
266
   | Opt_BreakOnError
267
   | Opt_PrintEvldWithShow
268
   | Opt_PrintBindContents
269
270
   | Opt_GenManifest
   | Opt_EmbedManifest
271
   | Opt_EmitExternalCore
Ian Lynagh's avatar
Ian Lynagh committed
272
   | Opt_SharedImplib
273
   | Opt_BuildingCabalPackage
274
   | Opt_SSE2
275
   | Opt_GhciSandbox
276
   | Opt_HelpfulErrors
277
278
279

	-- temporary flags
   | Opt_RunCPS
280
281
   | Opt_RunCPSZ
   | Opt_ConvertToZipCfgAndBack
282
   | Opt_AutoLinkPackages
283
   | Opt_ImplicitImportQualified
284
   | Opt_TryNewCodeGen
285
286
287
288
289
290
291

   -- keeping stuff
   | Opt_KeepHiDiffs
   | Opt_KeepHcFiles
   | Opt_KeepSFiles
   | Opt_KeepRawSFiles
   | Opt_KeepTmpFiles
Jedai's avatar
Jedai committed
292
   | Opt_KeepRawTokenStream
293
   | Opt_KeepLlvmFiles
294

295
   deriving (Eq, Show)
Ian Lynagh's avatar
Ian Lynagh committed
296

297
298
data Language = Haskell98 | Haskell2010

299
data ExtensionFlag
300
301
302
303
304
305
306
   = Opt_Cpp
   | Opt_OverlappingInstances
   | Opt_UndecidableInstances
   | Opt_IncoherentInstances
   | Opt_MonomorphismRestriction
   | Opt_MonoPatBinds
   | Opt_MonoLocalBinds
307
   | Opt_RelaxedPolyRec		-- Deprecated
308
309
310
311
   | Opt_ExtendedDefaultRules           -- Use GHC's extended rules for defaulting
   | Opt_ForeignFunctionInterface
   | Opt_UnliftedFFITypes
   | Opt_GHCForeignImportPrim
benl's avatar
benl committed
312
   | Opt_ParallelArrays                 -- Syntactic support for parallel arrays
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
   | Opt_Arrows                         -- Arrow-notation syntax
   | Opt_TemplateHaskell
   | Opt_QuasiQuotes
   | Opt_ImplicitParams
   | Opt_Generics			-- "Derivable type classes"
   | Opt_ImplicitPrelude
   | Opt_ScopedTypeVariables
   | Opt_UnboxedTuples
   | Opt_BangPatterns
   | Opt_TypeFamilies
   | Opt_OverloadedStrings
   | Opt_DisambiguateRecordFields
   | Opt_RecordWildCards
   | Opt_RecordPuns
   | Opt_ViewPatterns
   | Opt_GADTs
Ian Lynagh's avatar
Ian Lynagh committed
329
   | Opt_GADTSyntax
330
   | Opt_NPlusKPatterns
Ian Lynagh's avatar
Ian Lynagh committed
331
   | Opt_DoAndIfThenElse
332
   | Opt_RebindableSyntax
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369

   | Opt_StandaloneDeriving
   | Opt_DeriveDataTypeable
   | Opt_DeriveFunctor
   | Opt_DeriveTraversable
   | Opt_DeriveFoldable

   | Opt_TypeSynonymInstances
   | Opt_FlexibleContexts
   | Opt_FlexibleInstances
   | Opt_ConstrainedClassMethods
   | Opt_MultiParamTypeClasses
   | Opt_FunctionalDependencies
   | Opt_UnicodeSyntax
   | Opt_PolymorphicComponents
   | Opt_ExistentialQuantification
   | Opt_MagicHash
   | Opt_EmptyDataDecls
   | Opt_KindSignatures
   | Opt_ParallelListComp
   | Opt_TransformListComp
   | Opt_GeneralizedNewtypeDeriving
   | Opt_RecursiveDo
   | Opt_DoRec
   | Opt_PostfixOperators
   | Opt_TupleSections
   | Opt_PatternGuards
   | Opt_LiberalTypeSynonyms
   | Opt_Rank2Types
   | Opt_RankNTypes
   | Opt_ImpredicativeTypes
   | Opt_TypeOperators
   | Opt_PackageImports
   | Opt_ExplicitForAll
   | Opt_AlternativeLayoutRule
   | Opt_AlternativeLayoutRuleTransitional
   | Opt_DatatypeContexts
370
   | Opt_NondecreasingIndentation
371
   | Opt_RelaxedLayout
372
373
   deriving (Eq, Show)

374
375
-- | Contains not only a collection of 'DynFlag's but also a plethora of
-- information relating to the compilation of a single file or GHC session
376
data DynFlags = DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
377
378
379
  ghcMode               :: GhcMode,
  ghcLink               :: GhcLink,
  hscTarget             :: HscTarget,
380
  hscOutName            :: String,      -- ^ Name of the output file
381
  extCoreName           :: String,      -- ^ Name of the .hcr output file
382
  verbosity             :: Int,         -- ^ Verbosity level: see Note [Verbosity levels]
383
384
385
  optLevel              :: Int,         -- ^ Optimisation level
  simplPhases           :: Int,         -- ^ Number of simplifier phases
  maxSimplIterations    :: Int,         -- ^ Max simplifier iterations
386
  shouldDumpSimplPhase  :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
387
  ruleCheck             :: Maybe String,
388
  strictnessBefore      :: [Int],       -- ^ Additional demand analysis
389

390
391
392
  specConstrThreshold   :: Maybe Int,   -- ^ Threshold for SpecConstr
  specConstrCount       :: Maybe Int,   -- ^ Max number of specialisations for any one function
  liberateCaseThreshold :: Maybe Int,   -- ^ Threshold for LiberateCase
393
394
  floatLamArgs          :: Maybe Int,   -- ^ Arg count for lambda floating
  			   	 	--   See CoreMonad.FloatOutSwitches
395

396
#ifndef OMIT_NATIVE_CODEGEN
397
  targetPlatform	:: Platform,	-- ^ The platform we're compiling for. Used by the NCG.
398
#endif
Ian Lynagh's avatar
Ian Lynagh committed
399
  stolen_x86_regs       :: Int,
400
  cmdlineHcIncludes     :: [String],    -- ^ @\-\#includes@
Ian Lynagh's avatar
Ian Lynagh committed
401
402
403
  importPaths           :: [FilePath],
  mainModIs             :: Module,
  mainFunIs             :: Maybe String,
404
  ctxtStkDepth          :: Int,         -- ^ Typechecker context stack depth
405

406
407
  dphBackend            :: DPHBackend,

408
  thisPackage           :: PackageId,   -- ^ name of package currently being compiled
409
410

  -- ways
411
  ways                  :: [Way],       -- ^ Way flags from the command line
412
413
  buildTag              :: String,      -- ^ The global \"way\" (e.g. \"p\" for prof)
  rtsBuildTag           :: String,      -- ^ The RTS \"way\"
Ian Lynagh's avatar
Ian Lynagh committed
414

415
416
417
  -- For object splitting
  splitInfo             :: Maybe (String,Int),

418
  -- paths etc.
Ian Lynagh's avatar
Ian Lynagh committed
419
  objectDir             :: Maybe String,
420
  dylibInstallName      :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
421
422
  hiDir                 :: Maybe String,
  stubDir               :: Maybe String,
423

Ian Lynagh's avatar
Ian Lynagh committed
424
425
426
  objectSuf             :: String,
  hcSuf                 :: String,
  hiSuf                 :: String,
427

Ian Lynagh's avatar
Ian Lynagh committed
428
429
430
  outputFile            :: Maybe String,
  outputHi              :: Maybe String,
  dynLibLoader          :: DynLibLoader,
431

432
  -- | This is set by 'DriverPipeline.runPipeline' based on where
Ian Lynagh's avatar
Ian Lynagh committed
433
434
  --    its output is going.
  dumpPrefix            :: Maybe FilePath,
435

436
437
  -- | Override the 'dumpPrefix' set by 'DriverPipeline.runPipeline'.
  --    Set by @-ddump-file-prefix@
Ian Lynagh's avatar
Ian Lynagh committed
438
439
440
441
442
443
444
445
  dumpPrefixForce       :: Maybe FilePath,

  includePaths          :: [String],
  libraryPaths          :: [String],
  frameworkPaths        :: [String],    -- used on darwin only
  cmdlineFrameworks     :: [String],    -- ditto
  tmpDir                :: String,      -- no trailing '/'

446
447
  ghcUsagePath          :: FilePath,    -- Filled in by SysTools
  ghciUsagePath         :: FilePath,    -- ditto
448
  rtsOpts               :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
449
  rtsOptsEnabled        :: RtsOptsEnabled,
450

451
  hpcDir                :: String,      -- ^ Path to store the .mix files
andy@galois.com's avatar
andy@galois.com committed
452

453
  -- options for particular phases
Ian Lynagh's avatar
Ian Lynagh committed
454
455
456
457
458
459
460
461
  opt_L                 :: [String],
  opt_P                 :: [String],
  opt_F                 :: [String],
  opt_c                 :: [String],
  opt_m                 :: [String],
  opt_a                 :: [String],
  opt_l                 :: [String],
  opt_windres           :: [String],
462
463
  opt_lo                :: [String], -- LLVM: llvm optimiser
  opt_lc                :: [String], -- LLVM: llc static compiler
464
465

  -- commands for particular phases
Ian Lynagh's avatar
Ian Lynagh committed
466
467
468
469
470
471
472
473
474
  pgm_L                 :: String,
  pgm_P                 :: (String,[Option]),
  pgm_F                 :: String,
  pgm_c                 :: (String,[Option]),
  pgm_m                 :: (String,[Option]),
  pgm_s                 :: (String,[Option]),
  pgm_a                 :: (String,[Option]),
  pgm_l                 :: (String,[Option]),
  pgm_dll               :: (String,[Option]),
475
476
  pgm_T                 :: String,
  pgm_sysman            :: String,
477
  pgm_windres           :: String,
478
479
  pgm_lo                :: (String,[Option]), -- LLVM: opt llvm optimiser
  pgm_lc                :: (String,[Option]), -- LLVM: llc static compiler
480

481
482
483
484
485
486
  --  For ghc -M
  depMakefile           :: FilePath,
  depIncludePkgDeps     :: Bool,
  depExcludeMods        :: [ModuleName],
  depSuffixes           :: [String],

487
  --  Package flags
Ian Lynagh's avatar
Ian Lynagh committed
488
  extraPkgConfs         :: [FilePath],
489
490
  topDir                :: FilePath,    -- filled in by SysTools
  systemPackageConfig   :: FilePath,    -- ditto
491
        -- ^ The @-package-conf@ flags given on the command line, in the order
Ian Lynagh's avatar
Ian Lynagh committed
492
        -- they appeared.
493

Ian Lynagh's avatar
Ian Lynagh committed
494
  packageFlags          :: [PackageFlag],
495
        -- ^ The @-package@ and @-hide-package@ flags from the command-line
496

497
  -- Package state
Ian Lynagh's avatar
Ian Lynagh committed
498
  -- NB. do not modify this field, it is calculated by
499
  -- Packages.initPackages and Packages.updatePackages.
500
  pkgDatabase           :: Maybe [PackageConfig],
Ian Lynagh's avatar
Ian Lynagh committed
501
  pkgState              :: PackageState,
502

503
504
505
506
  -- Temporary files
  -- These have to be IORefs, because the defaultCleanupHandler needs to
  -- know what to clean when an exception happens
  filesToClean          :: IORef [FilePath],
507
  dirsToClean           :: IORef (Map FilePath FilePath),
508

509
  -- hsc dynamic flags
Ian Lynagh's avatar
Ian Lynagh committed
510
  flags                 :: [DynFlag],
511
  -- Don't change this without updating extensionFlags:
512
  language              :: Maybe Language,
513
514
515
516
517
  -- Don't change this without updating extensionFlags:
  extensions            :: [OnOff ExtensionFlag],
  -- extensionFlags should always be equal to
  --     flattenExtensionFlags language extensions
  extensionFlags        :: [ExtensionFlag],
Ian Lynagh's avatar
Ian Lynagh committed
518

519
  -- | Message output action: use "ErrUtils" instead of this if you can
David Waern's avatar
David Waern committed
520
521
522
  log_action            :: Severity -> SrcSpan -> PprStyle -> Message -> IO (),

  haddockOptions :: Maybe String
523
524
 }

525
526
527
wayNames :: DynFlags -> [WayName]
wayNames = map wayName . ways

528
529
-- | The target code type of the compilation (if any).
--
530
531
532
-- Whenever you change the target, also make sure to set 'ghcLink' to
-- something sensible.
--
533
534
535
536
-- 'HscNothing' can be used to avoid generating any output, however, note
-- that:
--
--  * This will not run the desugaring step, thus no warnings generated in
537
538
539
--    this step will be output.  In particular, this includes warnings related
--    to pattern matching.  You can run the desugarer manually using
--    'GHC.desugarModule'.
540
--
541
542
543
544
545
546
--  * If a program uses Template Haskell the typechecker may try to run code
--    from an imported module.  This will fail if no code has been generated
--    for this module.  You can use 'GHC.needsTemplateHaskell' to detect
--    whether this might be the case and choose to either switch to a
--    different target or avoid typechecking such modules.  (The latter may
--    preferable for security reasons.)
547
--
548
data HscTarget
549
550
  = HscC           -- ^ Generate C code.
  | HscAsm         -- ^ Generate assembly using the native code generator.
551
  | HscLlvm        -- ^ Generate assembly using the llvm code generator.
552
553
554
  | HscJava        -- ^ Generate Java bytecode.
  | HscInterpreted -- ^ Generate bytecode.  (Requires 'LinkInMemory')
  | HscNothing     -- ^ Don't generate any code.  See notes above.
555
556
  deriving (Eq, Show)

557
-- | Will this target result in an object file on the disk?
558
559
560
isObjectTarget :: HscTarget -> Bool
isObjectTarget HscC     = True
isObjectTarget HscAsm   = True
561
isObjectTarget HscLlvm  = True
562
563
564
565
566
567
568
569
isObjectTarget _        = False

-- | The 'GhcMode' tells us whether we're doing multi-module
-- compilation (controlled via the "GHC" API) or one-shot
-- (single-module) compilation.  This makes a difference primarily to
-- the "Finder": in one-shot mode we look for interface files for
-- imported modules, but in multi-module mode we look for source files
-- in order to check whether they need to be recompiled.
570
data GhcMode
571
572
573
  = CompManager         -- ^ @\-\-make@, GHCi, etc.
  | OneShot             -- ^ @ghc -c Foo.hs@
  | MkDepend            -- ^ @ghc -M@, see "Finder" for why we need this
574
575
  deriving Eq

576
577
578
579
580
instance Outputable GhcMode where
  ppr CompManager = ptext (sLit "CompManager")
  ppr OneShot     = ptext (sLit "OneShot")
  ppr MkDepend    = ptext (sLit "MkDepend")

581
582
583
584
isOneShot :: GhcMode -> Bool
isOneShot OneShot = True
isOneShot _other  = False

585
586
587
588
-- | What to do in the link step, if there is one.
data GhcLink
  = NoLink              -- ^ Don't link at all
  | LinkBinary          -- ^ Link object code into a binary
589
590
  | LinkInMemory        -- ^ Use the in-memory dynamic linker (works for both
                        --   bytecode and object code).
591
  | LinkDynLib          -- ^ Link objects into a dynamic lib (DLL on Windows, DSO on ELF platforms)
592
  deriving (Eq, Show)
593
594
595

isNoLink :: GhcLink -> Bool
isNoLink NoLink = True
twanvl's avatar
twanvl committed
596
isNoLink _      = False
597

598
599
600
-- Is it worth evaluating this Bool and caching it in the DynFlags value
-- during initDynFlags?
doingTickyProfiling :: DynFlags -> Bool
601
602
603
doingTickyProfiling _ = opt_Ticky
  -- XXX -ticky is a static flag, because it implies -debug which is also
  -- static.  If the way flags were made dynamic, we could fix this.
604

605
606
data PackageFlag
  = ExposePackage  String
607
  | ExposePackageId String
608
609
  | HidePackage    String
  | IgnorePackage  String
610
  deriving Eq
611

twanvl's avatar
twanvl committed
612
defaultHscTarget :: HscTarget
613
614
defaultHscTarget = defaultObjectTarget

615
-- | The 'HscTarget' value corresponding to the default way to create
616
-- object files on the current platform.
twanvl's avatar
twanvl committed
617
defaultObjectTarget :: HscTarget
618
defaultObjectTarget
Ian Lynagh's avatar
Ian Lynagh committed
619
620
  | cGhcWithNativeCodeGen == "YES"      =  HscAsm
  | otherwise                           =  HscC
621

622
623
624
625
626
data DynLibLoader
  = Deployable
  | SystemDependent
  deriving Eq

Ian Lynagh's avatar
Ian Lynagh committed
627
628
data RtsOptsEnabled = RtsOptsNone | RtsOptsSafeOnly | RtsOptsAll

629
-- | Used by 'GHC.newSession' to partially initialize a new 'DynFlags' value
twanvl's avatar
twanvl committed
630
initDynFlags :: DynFlags -> IO DynFlags
631
632
633
initDynFlags dflags = do
 -- someday these will be dynamic flags
 ways <- readIORef v_Ways
634
 refFilesToClean <- newIORef []
635
 refDirsToClean <- newIORef Map.empty
636
 return dflags{
637
638
639
        ways            = ways,
        buildTag        = mkBuildTag (filter (not . wayRTSOnly) ways),
        rtsBuildTag     = mkBuildTag ways,
640
641
        filesToClean    = refFilesToClean,
        dirsToClean     = refDirsToClean
Ian Lynagh's avatar
Ian Lynagh committed
642
        }
643

644
645
-- | The normal 'DynFlags'. Note that they is not suitable for use in this form
-- and must be fully initialized by 'GHC.newSession' first.
twanvl's avatar
twanvl committed
646
defaultDynFlags :: DynFlags
647
648
defaultDynFlags =
     DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
649
650
651
652
653
654
655
        ghcMode                 = CompManager,
        ghcLink                 = LinkBinary,
        hscTarget               = defaultHscTarget,
        hscOutName              = "",
        extCoreName             = "",
        verbosity               = 0,
        optLevel                = 0,
656
        simplPhases             = 2,
Ian Lynagh's avatar
Ian Lynagh committed
657
        maxSimplIterations      = 4,
658
        shouldDumpSimplPhase    = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
659
660
661
        ruleCheck               = Nothing,
        specConstrThreshold     = Just 200,
        specConstrCount         = Just 3,
662
        liberateCaseThreshold   = Just 200,
663
        floatLamArgs            = Just 0,	-- Default: float only if no fvs
664
665
        strictnessBefore        = [],

666
#ifndef OMIT_NATIVE_CODEGEN
667
        targetPlatform          = defaultTargetPlatform,
668
#endif
Ian Lynagh's avatar
Ian Lynagh committed
669
670
671
672
673
674
675
        stolen_x86_regs         = 4,
        cmdlineHcIncludes       = [],
        importPaths             = ["."],
        mainModIs               = mAIN,
        mainFunIs               = Nothing,
        ctxtStkDepth            = mAX_CONTEXT_REDUCTION_DEPTH,

chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
676
        dphBackend              = DPHNone,
677

Ian Lynagh's avatar
Ian Lynagh committed
678
679
680
        thisPackage             = mainPackageId,

        objectDir               = Nothing,
681
        dylibInstallName        = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
682
683
684
685
686
687
688
689
690
        hiDir                   = Nothing,
        stubDir                 = Nothing,

        objectSuf               = phaseInputExt StopLn,
        hcSuf                   = phaseInputExt HCc,
        hiSuf                   = "hi",

        outputFile              = Nothing,
        outputHi                = Nothing,
691
        dynLibLoader            = SystemDependent,
Ian Lynagh's avatar
Ian Lynagh committed
692
693
694
695
696
697
698
        dumpPrefix              = Nothing,
        dumpPrefixForce         = Nothing,
        includePaths            = [],
        libraryPaths            = [],
        frameworkPaths          = [],
        cmdlineFrameworks       = [],
        tmpDir                  = cDEFAULT_TMPDIR,
699
        rtsOpts                 = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
700
        rtsOptsEnabled          = RtsOptsSafeOnly,
Ian Lynagh's avatar
Ian Lynagh committed
701
702
703
704
705

        hpcDir                  = ".hpc",

        opt_L                   = [],
        opt_P                   = (if opt_PIC
706
                                   then ["-D__PIC__", "-U __PIC__"] -- this list is reversed
Ian Lynagh's avatar
Ian Lynagh committed
707
708
709
710
711
712
                                   else []),
        opt_F                   = [],
        opt_c                   = [],
        opt_a                   = [],
        opt_m                   = [],
        opt_l                   = [],
713
        opt_windres             = [],
714
715
        opt_lo                  = [],
        opt_lc                  = [],
Ian Lynagh's avatar
Ian Lynagh committed
716
717
718

        extraPkgConfs           = [],
        packageFlags            = [],
719
720
        pkgDatabase             = Nothing,
        pkgState                = panic "no package state yet: call GHC.setSessionDynFlags",
721
        ways                    = panic "defaultDynFlags: No ways",
Ian Lynagh's avatar
Ian Lynagh committed
722
723
        buildTag                = panic "defaultDynFlags: No buildTag",
        rtsBuildTag             = panic "defaultDynFlags: No rtsBuildTag",
724
        splitInfo               = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
725
726
727
728
        -- initSysTools fills all these in
        ghcUsagePath            = panic "defaultDynFlags: No ghciUsagePath",
        ghciUsagePath           = panic "defaultDynFlags: No ghciUsagePath",
        topDir                  = panic "defaultDynFlags: No topDir",
729
        systemPackageConfig     = panic  "no systemPackageConfig: call GHC.setSessionDynFlags",
Ian Lynagh's avatar
Ian Lynagh committed
730
731
732
733
734
735
736
737
738
739
740
741
        pgm_L                   = panic "defaultDynFlags: No pgm_L",
        pgm_P                   = panic "defaultDynFlags: No pgm_P",
        pgm_F                   = panic "defaultDynFlags: No pgm_F",
        pgm_c                   = panic "defaultDynFlags: No pgm_c",
        pgm_m                   = panic "defaultDynFlags: No pgm_m",
        pgm_s                   = panic "defaultDynFlags: No pgm_s",
        pgm_a                   = panic "defaultDynFlags: No pgm_a",
        pgm_l                   = panic "defaultDynFlags: No pgm_l",
        pgm_dll                 = panic "defaultDynFlags: No pgm_dll",
        pgm_T                   = panic "defaultDynFlags: No pgm_T",
        pgm_sysman              = panic "defaultDynFlags: No pgm_sysman",
        pgm_windres             = panic "defaultDynFlags: No pgm_windres",
742
743
        pgm_lo                  = panic "defaultDynFlags: No pgm_lo",
        pgm_lc                  = panic "defaultDynFlags: No pgm_lc",
Ian Lynagh's avatar
Ian Lynagh committed
744
        -- end of initSysTools values
745
746
747
748
749
750
        -- ghc -M values
        depMakefile       = "Makefile",
        depIncludePkgDeps = False,
        depExcludeMods    = [],
        depSuffixes       = [],
        -- end of ghc -M values
751
752
        filesToClean   = panic "defaultDynFlags: No filesToClean",
        dirsToClean    = panic "defaultDynFlags: No dirsToClean",
Ian Lynagh's avatar
Ian Lynagh committed
753
        haddockOptions = Nothing,
754
        flags = defaultFlags,
755
        language = Nothing,
756
757
        extensions = [],
        extensionFlags = flattenExtensionFlags Nothing [],
758

Ian Lynagh's avatar
Ian Lynagh committed
759
        log_action = \severity srcSpan style msg ->
760
                        case severity of
761
762
763
764
                          SevOutput -> printOutput (msg style)
                          SevInfo   -> printErrs (msg style)
                          SevFatal  -> printErrs (msg style)
                          _         -> do 
765
766
767
768
769
                                hPutChar stderr '\n'
                                printErrs ((mkLocMessage srcSpan msg) style)
                     -- careful (#2302): printErrs prints in UTF-8, whereas
                     -- converting to string first and using hPutStr would
                     -- just emit the low 8 bits of each unicode char.
770
771
      }

Ian Lynagh's avatar
Ian Lynagh committed
772
{-
773
774
Note [Verbosity levels]
~~~~~~~~~~~~~~~~~~~~~~~
Ian Lynagh's avatar
Ian Lynagh committed
775
    0   |   print errors & warnings only
776
777
778
779
780
781
782
    1   |   minimal verbosity: print "compiling M ... done." for each module.
    2   |   equivalent to -dshow-passes
    3   |   equivalent to existing "ghc -v"
    4   |   "ghc -v -ddump-most"
    5   |   "ghc -v -ddump-all"
-}

783
784
785
786
787
data OnOff a = On a
             | Off a

-- OnOffs accumulate in reverse order, so we use foldr in order to
-- process them in the right order
788
789
790
flattenExtensionFlags :: Maybe Language -> [OnOff ExtensionFlag]
                      -> [ExtensionFlag]
flattenExtensionFlags ml = foldr f defaultExtensionFlags
791
792
    where f (On f)  flags = f : delete f flags
          f (Off f) flags =     delete f flags
793
794
795
          defaultExtensionFlags = languageExtensions ml

languageExtensions :: Maybe Language -> [ExtensionFlag]
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
796

797
languageExtensions Nothing
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
798
    -- Nothing => the default case
799
800
801
    = Opt_MonoPatBinds   -- Experimentally, I'm making this non-standard
                         -- behaviour the default, to see if anyone notices
                         -- SLPJ July 06
Ian Lynagh's avatar
Ian Lynagh committed
802
      -- In due course I'd like Opt_MonoLocalBinds to be on by default
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
803
      -- But NB it's implied by GADTs etc
Ian Lynagh's avatar
Ian Lynagh committed
804
      -- SLPJ September 2010
805
    : Opt_NondecreasingIndentation -- This has been on by default for some time
806
    : languageExtensions (Just Haskell2010)
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
807

808
809
810
811
languageExtensions (Just Haskell98)
    = [Opt_ImplicitPrelude,
       Opt_MonomorphismRestriction,
       Opt_NPlusKPatterns,
812
813
814
815
816
817
818
819
       Opt_DatatypeContexts,
       Opt_NondecreasingIndentation
           -- strictly speaking non-standard, but we always had this
           -- on implicitly before the option was added in 7.1, and
           -- turning it off breaks code, so we're keeping it on for
           -- backwards compatibility.  Cabal uses -XHaskell98 by
           -- default unless you specify another language.
      ]
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
820

821
822
823
824
825
826
827
languageExtensions (Just Haskell2010)
    = [Opt_ImplicitPrelude,
       Opt_MonomorphismRestriction,
       Opt_DatatypeContexts,
       Opt_EmptyDataDecls,
       Opt_ForeignFunctionInterface,
       Opt_PatternGuards,
Ian Lynagh's avatar
Ian Lynagh committed
828
       Opt_DoAndIfThenElse,
829
       Opt_RelaxedPolyRec]
830

831
-- | Test whether a 'DynFlag' is set
832
833
dopt :: DynFlag -> DynFlags -> Bool
dopt f dflags  = f `elem` (flags dflags)
834

835
-- | Set a 'DynFlag'
836
837
dopt_set :: DynFlags -> DynFlag -> DynFlags
dopt_set dfs f = dfs{ flags = f : flags dfs }
838

839
-- | Unset a 'DynFlag'
840
841
dopt_unset :: DynFlags -> DynFlag -> DynFlags
dopt_unset dfs f = dfs{ flags = filter (/= f) (flags dfs) }
842

843
-- | Test whether a 'ExtensionFlag' is set
844
xopt :: ExtensionFlag -> DynFlags -> Bool
845
xopt f dflags = f `elem` extensionFlags dflags
846

847
-- | Set a 'ExtensionFlag'
848
xopt_set :: DynFlags -> ExtensionFlag -> DynFlags
849
850
851
852
xopt_set dfs f
    = let onoffs = On f : extensions dfs
      in dfs { extensions = onoffs,
               extensionFlags = flattenExtensionFlags (language dfs) onoffs }
853

854
-- | Unset a 'ExtensionFlag'
855
xopt_unset :: DynFlags -> ExtensionFlag -> DynFlags
856
857
858
859
xopt_unset dfs f
    = let onoffs = Off f : extensions dfs
      in dfs { extensions = onoffs,
               extensionFlags = flattenExtensionFlags (language dfs) onoffs }
860

861
862
863
864
865
866
867
868
setLanguage :: Language -> DynP ()
setLanguage l = upd f
    where f dfs = let mLang = Just l
                      oneoffs = extensions dfs
                  in dfs {
                         language = mLang,
                         extensionFlags = flattenExtensionFlags mLang oneoffs
                     }
869

870
871
872
873
-- | Retrieve the options corresponding to a particular @opt_*@ field in the correct order
getOpts :: DynFlags             -- ^ 'DynFlags' to retrieve the options from
        -> (DynFlags -> [a])    -- ^ Relevant record accessor: one of the @opt_*@ accessors
        -> [a]                  -- ^ Correctly ordered extracted options
874
getOpts dflags opts = reverse (opts dflags)
Ian Lynagh's avatar
Ian Lynagh committed
875
        -- We add to the options from the front, so we need to reverse the list
876

877
878
-- | Gets the verbosity flag for the current verbosity level. This is fed to
-- other tools, so GHC-specific verbosity flags like @-ddump-most@ are not included
879
getVerbFlag :: DynFlags -> String
Ian Lynagh's avatar
Ian Lynagh committed
880
881
getVerbFlag dflags
  | verbosity dflags >= 3  = "-v"
882
883
  | otherwise =  ""

884
setObjectDir, setHiDir, setStubDir, setOutputDir, setDylibInstallName,
Simon Marlow's avatar
Simon Marlow committed
885
         setObjectSuf, setHiSuf, setHcSuf, parseDynLibLoaderMode,
886
         setPgmP, addOptl, addOptP,
887
         addCmdlineFramework, addHaddockOpts
twanvl's avatar
twanvl committed
888
889
890
891
   :: String -> DynFlags -> DynFlags
setOutputFile, setOutputHi, setDumpPrefixForce
   :: Maybe String -> DynFlags -> DynFlags

892
893
894
895
setObjectDir  f d = d{ objectDir  = Just f}
setHiDir      f d = d{ hiDir      = Just f}
setStubDir    f d = d{ stubDir    = Just f, includePaths = f : includePaths d }
  -- -stubdir D adds an implicit -I D, so that gcc can find the _stub.h file
Thomas Schilling's avatar
Thomas Schilling committed
896
  -- \#included from the .hc file when compiling with -fvia-C.
Simon Marlow's avatar
Simon Marlow committed
897
setOutputDir  f = setObjectDir f . setHiDir f . setStubDir f
898
setDylibInstallName  f d = d{ dylibInstallName = Just f}
899

900
901
setObjectSuf  f d = d{ objectSuf  = f}
setHiSuf      f d = d{ hiSuf      = f}
902
903
904
905
setHcSuf      f d = d{ hcSuf      = f}

setOutputFile f d = d{ outputFile = f}
setOutputHi   f d = d{ outputHi   = f}
906

907
908
909
910
parseDynLibLoaderMode f d =
 case splitAt 8 f of
   ("deploy", "")       -> d{ dynLibLoader = Deployable }
   ("sysdep", "")       -> d{ dynLibLoader = SystemDependent }
911
   _                    -> ghcError (CmdLineError ("Unknown dynlib loader: " ++ f))
912

913
914
setDumpPrefixForce f d = d { dumpPrefixForce = f}

915
916
917
918
-- XXX HACK: Prelude> words "'does not' work" ===> ["'does","not'","work"]
-- Config.hs should really use Option.
setPgmP   f d = let (pgm:args) = words f in d{ pgm_P   = (pgm, map Option args)}
addOptl   f d = d{ opt_l   = f : opt_l d}
919
920
addOptP   f d = d{ opt_P   = f : opt_P d}

921

922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
setDepMakefile :: FilePath -> DynFlags -> DynFlags
setDepMakefile f d = d { depMakefile = deOptDep f }

setDepIncludePkgDeps :: Bool -> DynFlags -> DynFlags
setDepIncludePkgDeps b d = d { depIncludePkgDeps = b }

addDepExcludeMod :: String -> DynFlags -> DynFlags
addDepExcludeMod m d
    = d { depExcludeMods = mkModuleName (deOptDep m) : depExcludeMods d }

addDepSuffix :: FilePath -> DynFlags -> DynFlags
addDepSuffix s d = d { depSuffixes = deOptDep s : depSuffixes d }

-- XXX Legacy code:
-- We used to use "-optdep-flag -optdeparg", so for legacy applications
-- we need to strip the "-optdep" off of the arg
deOptDep :: String -> String
939
deOptDep x = case stripPrefix "-optdep" x of
940
941
942
             Just rest -> rest
             Nothing -> x

943
944
addCmdlineFramework f d = d{ cmdlineFrameworks = f : cmdlineFrameworks d}

David Waern's avatar
David Waern committed
945
946
addHaddockOpts f d = d{ haddockOptions = Just f}

947
948
949
-- -----------------------------------------------------------------------------
-- Command-line options

950
-- | When invoking external tools as part of the compilation pipeline, we
951
952
-- pass these a sequence of options on the command-line. Rather than
-- just using a list of Strings, we use a type that allows us to distinguish
953
-- between filepaths and 'other stuff'. The reason for this is that
954
-- this type gives us a handle on transforming filenames, and filenames only,
955
-- to whatever format they're expected to be on a particular platform.
956
957
data Option
 = FileOption -- an entry that _contains_ filename(s) / filepaths.
Ian Lynagh's avatar
Ian Lynagh committed
958
959
960
              String  -- a non-filepath prefix that shouldn't be
                      -- transformed (e.g., "/out=")
              String  -- the filepath/filename portion