DynFlags.hs 115 KB
Newer Older
dterei's avatar
dterei committed
1
-------------------------------------------------------------------------------
2
--
dterei's avatar
dterei committed
3
4
5
6
7
8
-- | Dynamic flags
--
-- Most flags are dynamic flags, which means they can change from 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.
9
10
11
--
-- (c) The University of Glasgow 2005
--
dterei's avatar
dterei committed
12
-------------------------------------------------------------------------------
13
14

module DynFlags (
15
        -- * Dynamic flags and associated configuration types
Ian Lynagh's avatar
Ian Lynagh committed
16
        DynFlag(..),
17
        WarningFlag(..),
18
        ExtensionFlag(..),
19
        Language(..),
Ian Lynagh's avatar
Ian Lynagh committed
20
        FatalMessager, LogAction, FlushOut(..), FlushErr(..),
21
        ProfAuto(..),
22
        glasgowExtsFlags,
23
24
25
        dopt,
        dopt_set,
        dopt_unset,
26
27
28
        wopt,
        wopt_set,
        wopt_unset,
29
30
31
        xopt,
        xopt_set,
        xopt_unset,
32
        lang_set,
Ian Lynagh's avatar
Ian Lynagh committed
33
        DynFlags(..),
Ian Lynagh's avatar
Ian Lynagh committed
34
        HasDynFlags(..), ContainsDynFlags(..),
Ian Lynagh's avatar
Ian Lynagh committed
35
        RtsOptsEnabled(..),
Ian Lynagh's avatar
Ian Lynagh committed
36
        HscTarget(..), isObjectTarget, defaultObjectTarget,
37
        targetRetainsAllBindings,
Ian Lynagh's avatar
Ian Lynagh committed
38
39
40
        GhcMode(..), isOneShot,
        GhcLink(..), isNoLink,
        PackageFlag(..),
41
        PkgConfRef(..),
Ian Lynagh's avatar
Ian Lynagh committed
42
        Option(..), showOpt,
Ian Lynagh's avatar
Ian Lynagh committed
43
        DynLibLoader(..),
44
        fFlags, fWarningFlags, fLangFlags, xFlags,
45
        wayNames, dynFlagDependencies,
46

47
48
        printOutputForUser, printInfoForUser,

49
        -- ** Safe Haskell
50
        SafeHaskellMode(..),
51
        safeHaskellOn, safeImportsOn, safeLanguageOn, safeInferOn,
52
        packageTrustOn,
53
        safeDirectImpsReq, safeImplicitImpsReq,
54
        unsafeFlags,
55

56
        -- ** System tool settings and locations
57
        Settings(..),
58
        targetPlatform,
59
60
61
62
        ghcUsagePath, ghciUsagePath, topDir, tmpDir, rawSettings,
        extraGccViaCFlags, systemPackageConfig,
        pgm_L, pgm_P, pgm_F, pgm_c, pgm_s, pgm_a, pgm_l, pgm_dll, pgm_T,
        pgm_sysman, pgm_windres, pgm_lo, pgm_lc,
Ian Lynagh's avatar
Ian Lynagh committed
63
        opt_L, opt_P, opt_F, opt_c, opt_a, opt_l,
64
        opt_windres, opt_lo, opt_lc,
65
66


67
        -- ** Manipulating DynFlags
68
        defaultDynFlags,                -- Settings -> DynFlags
Ian Lynagh's avatar
Ian Lynagh committed
69
        initDynFlags,                   -- DynFlags -> IO DynFlags
Ian Lynagh's avatar
Ian Lynagh committed
70
        defaultFatalMessager,
71
        defaultLogAction,
72
        defaultLogActionHPrintDoc,
73
74
        defaultFlushOut,
        defaultFlushErr,
Ian Lynagh's avatar
Ian Lynagh committed
75

76
        getOpts,                        -- DynFlags -> (DynFlags -> [a]) -> [a]
77
        getVerbFlags,
Ian Lynagh's avatar
Ian Lynagh committed
78
79
80
        updOptLevel,
        setTmpDir,
        setPackageName,
81
        doingTickyProfiling,
Ian Lynagh's avatar
Ian Lynagh committed
82

83
        -- ** Parsing DynFlags
84
85
        parseDynamicFlagsCmdLine,
        parseDynamicFilePragma,
86
        allFlags,
87

88
        supportedLanguagesAndExtensions,
89
90

        -- ** DynFlag C compiler options
91
        picCCOpts,
92
93
94
95
96
97

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

        -- * Compiler configuration suitable for display to the user
98
99
        compilerInfo,

100
#ifdef GHCI
dterei's avatar
dterei committed
101
-- Only in stage 2 can we be sure that the RTS
102
-- exposes the appropriate runtime boolean
103
        rtsIsProfiled,
104
#endif
105
106
        -- ** Only for use in the tracing functions in Outputable
        tracingDynFlags,
107
108
109
110
  ) where

#include "HsVersions.h"

111
import Platform
112
import Module
Simon Marlow's avatar
Simon Marlow committed
113
import PackageConfig
114
import PrelNames        ( mAIN )
115
import StaticFlags
116
import {-# SOURCE #-} Packages (PackageState)
Ian Lynagh's avatar
Ian Lynagh committed
117
import DriverPhases     ( Phase(..), phaseInputExt )
118
119
import Config
import CmdLineParser
Ian Lynagh's avatar
Ian Lynagh committed
120
import Constants        ( mAX_CONTEXT_REDUCTION_DEPTH )
121
import Panic
122
import Util
123
import Maybes           ( orElse )
124
import qualified Pretty
125
import SrcLoc
126
import FastString
Simon Marlow's avatar
Simon Marlow committed
127
import Outputable
Ian Lynagh's avatar
Ian Lynagh committed
128
#ifdef GHCI
Ian Lynagh's avatar
Ian Lynagh committed
129
import Foreign.C        ( CInt(..) )
Ian Lynagh's avatar
Ian Lynagh committed
130
#endif
131
import {-# SOURCE #-} ErrUtils ( Severity(..), MsgDoc, mkLocMessage )
132

Ian Lynagh's avatar
Ian Lynagh committed
133
#ifdef GHCI
134
import System.IO.Unsafe ( unsafePerformIO )
Ian Lynagh's avatar
Ian Lynagh committed
135
#endif
136
import Data.IORef
Ian Lynagh's avatar
Ian Lynagh committed
137
import Control.Monad    ( when )
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
138

139
import Data.Char
140
import Data.List
141
142
import Data.Map (Map)
import qualified Data.Map as Map
143
144
import Data.Set (Set)
import qualified Data.Set as Set
Ian Lynagh's avatar
Ian Lynagh committed
145
import System.FilePath
146
import System.IO
147

148
149
150
import Data.IntSet (IntSet)
import qualified Data.IntSet as IntSet

151
152
153
-- -----------------------------------------------------------------------------
-- DynFlags

154
-- | Enumerates the simple on-or-off dynamic flags
155
156
157
158
data DynFlag

   -- debugging flags
   = Opt_D_dump_cmm
159
   | Opt_D_dump_raw_cmm
160
   | Opt_D_dump_cmmz
161
   | Opt_D_dump_cmmz_pretty
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
   -- All of the cmmz subflags (there are a lot!)  Automatically
   -- enabled if you run -ddump-cmmz
   | Opt_D_dump_cmmz_cbe
   | Opt_D_dump_cmmz_proc
   | Opt_D_dump_cmmz_spills
   | Opt_D_dump_cmmz_rewrite
   | Opt_D_dump_cmmz_dead
   | Opt_D_dump_cmmz_stub
   | Opt_D_dump_cmmz_sp
   | Opt_D_dump_cmmz_procmap
   | Opt_D_dump_cmmz_split
   | Opt_D_dump_cmmz_lower
   | Opt_D_dump_cmmz_info
   | Opt_D_dump_cmmz_cafs
   -- end cmmz subflags
177
   | Opt_D_dump_cps_cmm
178
   | Opt_D_dump_cvt_cmm
179
   | Opt_D_dump_asm
180
181
   | Opt_D_dump_asm_native
   | Opt_D_dump_asm_liveness
182
   | Opt_D_dump_asm_coalesce
183
184
185
   | Opt_D_dump_asm_regalloc
   | Opt_D_dump_asm_regalloc_stages
   | Opt_D_dump_asm_conflicts
186
   | Opt_D_dump_asm_stats
187
   | Opt_D_dump_asm_expanded
188
   | Opt_D_dump_llvm
189
   | Opt_D_dump_core_stats
190
191
192
193
194
195
   | Opt_D_dump_cpranal
   | Opt_D_dump_deriv
   | Opt_D_dump_ds
   | Opt_D_dump_flatC
   | Opt_D_dump_foreign
   | Opt_D_dump_inlinings
196
   | Opt_D_dump_rule_firings
197
   | Opt_D_dump_rule_rewrites
198
199
200
   | Opt_D_dump_occur_anal
   | Opt_D_dump_parsed
   | Opt_D_dump_rn
201
   | Opt_D_dump_core_pipeline -- TODO FIXME: dump after simplifier stats
202
203
   | Opt_D_dump_simpl
   | Opt_D_dump_simpl_iterations
204
   | Opt_D_dump_simpl_phases
205
206
207
208
209
210
211
212
213
214
215
216
217
   | 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
218
   | Opt_D_dump_cs_trace -- Constraint solver in type checker
219
220
   | Opt_D_dump_tc_trace
   | Opt_D_dump_if_trace
221
   | Opt_D_dump_vt_trace
222
223
224
   | Opt_D_dump_splices
   | Opt_D_dump_BCOs
   | Opt_D_dump_vect
225
   | Opt_D_dump_avoid_vect
226
   | Opt_D_dump_ticked
pepe's avatar
pepe committed
227
   | Opt_D_dump_rtti
228
229
230
231
232
233
   | 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
234
   | Opt_D_dump_mod_cycles
235
   | Opt_D_dump_view_pattern_commoning
236
   | Opt_D_faststring_stats
Ian Lynagh's avatar
Ian Lynagh committed
237
   | Opt_DumpToFile                     -- ^ Append dump output to files instead of stdout.
Simon Marlow's avatar
Simon Marlow committed
238
   | Opt_D_no_debug_output
239
240
241
   | Opt_DoCoreLinting
   | Opt_DoStgLinting
   | Opt_DoCmmLinting
Ben.Lippmeier@anu.edu.au's avatar
Ben.Lippmeier@anu.edu.au committed
242
   | Opt_DoAsmLinting
243
   | Opt_NoLlvmMangler                 -- hidden flag
244

Ian Lynagh's avatar
Ian Lynagh committed
245
   | Opt_WarnIsError                    -- -Werror; makes warnings fatal
246

247
248
   | Opt_PrintExplicitForalls

249
250
251
   -- optimisation opts
   | Opt_Strictness
   | Opt_FullLaziness
252
253
   | Opt_FloatIn
   | Opt_Specialise
254
   | Opt_StaticArgumentTransformation
255
   | Opt_CSE
256
257
   | Opt_LiberateCase
   | Opt_SpecConstr
258
259
260
261
262
   | Opt_DoLambdaEtaExpansion
   | Opt_IgnoreAsserts
   | Opt_DoEtaReduction
   | Opt_CaseMerge
   | Opt_UnboxStrictFields
263
   | Opt_DictsCheap
264
   | Opt_EnableRewriteRules             -- Apply rewrite rules during simplification
rl@cse.unsw.edu.au's avatar
rl@cse.unsw.edu.au committed
265
   | Opt_Vectorise
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
266
   | Opt_AvoidVect
Ian Lynagh's avatar
Ian Lynagh committed
267
268
   | Opt_RegsGraph                      -- do graph coloring register allocation
   | Opt_RegsIterative                  -- do iterative coalescing graph coloring register allocation
269
   | Opt_PedanticBottoms                -- Be picky about how we treat bottom
270
271
   | Opt_LlvmTBAA                       -- Use LLVM TBAA infastructure for improving AA (hidden flag)
   | Opt_RegLiveness                    -- Use the STG Reg liveness information (hidden flag)
272

273
274
275
276
277
   -- Interface files
   | Opt_IgnoreInterfacePragmas
   | Opt_OmitInterfacePragmas
   | Opt_ExposeAllUnfoldings

Ian Lynagh's avatar
Ian Lynagh committed
278
279
   -- profiling opts
   | Opt_AutoSccsOnIndividualCafs
280
   | Opt_ProfCountEntries
Ian Lynagh's avatar
Ian Lynagh committed
281

282
283
   -- misc opts
   | Opt_Pp
284
   | Opt_ForceRecomp
285
   | Opt_ExcessPrecision
286
   | Opt_EagerBlackHoling
287
288
289
   | Opt_NoHsMain
   | Opt_SplitObjs
   | Opt_StgStats
290
   | Opt_HideAllPackages
291
   | Opt_PrintBindResult
292
   | Opt_Haddock
David Waern's avatar
David Waern committed
293
   | Opt_HaddockOptions
294
   | Opt_Hpc_No_Auto
295
   | Opt_BreakOnException
296
   | Opt_BreakOnError
297
   | Opt_PrintEvldWithShow
298
   | Opt_PrintBindContents
299
300
   | Opt_GenManifest
   | Opt_EmbedManifest
301
   | Opt_EmitExternalCore
Ian Lynagh's avatar
Ian Lynagh committed
302
   | Opt_SharedImplib
303
   | Opt_BuildingCabalPackage
304
   | Opt_SSE2
tibbe's avatar
tibbe committed
305
   | Opt_SSE4_2
306
   | Opt_IgnoreDotGhci
307
   | Opt_GhciSandbox
Ian Lynagh's avatar
Ian Lynagh committed
308
   | Opt_GhciHistory
309
   | Opt_HelpfulErrors
310
   | Opt_DeferTypeErrors
311

312
313
314
   -- output style opts
   | Opt_PprCaseAsLet

315
   -- temporary flags
316
   | Opt_RunCPS
317
   | Opt_RunCPSZ
318
   | Opt_AutoLinkPackages
319
   | Opt_ImplicitImportQualified
320
   | Opt_TryNewCodeGen
321
322
323
324
325
326

   -- keeping stuff
   | Opt_KeepHiDiffs
   | Opt_KeepHcFiles
   | Opt_KeepSFiles
   | Opt_KeepTmpFiles
Jedai's avatar
Jedai committed
327
   | Opt_KeepRawTokenStream
328
   | Opt_KeepLlvmFiles
329

330
   -- safe haskell flags
dterei's avatar
dterei committed
331
   | Opt_DistrustAllPackages
332
333
   | Opt_PackageTrust

334
   deriving (Eq, Show, Enum)
Ian Lynagh's avatar
Ian Lynagh committed
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
data WarningFlag =
     Opt_WarnDuplicateExports
   | Opt_WarnHiShadows
   | Opt_WarnImplicitPrelude
   | Opt_WarnIncompletePatterns
   | Opt_WarnIncompleteUniPatterns
   | Opt_WarnIncompletePatternsRecUpd
   | Opt_WarnMissingFields
   | Opt_WarnMissingImportList
   | Opt_WarnMissingMethods
   | Opt_WarnMissingSigs
   | Opt_WarnMissingLocalSigs
   | Opt_WarnNameShadowing
   | Opt_WarnOverlappingPatterns
   | Opt_WarnTypeDefaults
   | Opt_WarnMonomorphism
   | Opt_WarnUnusedBinds
   | Opt_WarnUnusedImports
   | Opt_WarnUnusedMatches
   | Opt_WarnWarningsDeprecations
   | Opt_WarnDeprecatedFlags
   | Opt_WarnDodgyExports
   | Opt_WarnDodgyImports
   | Opt_WarnOrphans
   | Opt_WarnAutoOrphans
   | Opt_WarnIdentities
   | Opt_WarnTabs
   | Opt_WarnUnrecognisedPragmas
   | Opt_WarnDodgyForeignImports
   | Opt_WarnLazyUnliftedBindings
   | Opt_WarnUnusedDoBind
   | Opt_WarnWrongDoBind
   | Opt_WarnAlternativeLayoutRuleTransitional
369
370
   | Opt_WarnUnsafe
   | Opt_WarnSafe
Ian Lynagh's avatar
Ian Lynagh committed
371
   | Opt_WarnPointlessPragmas
372
   | Opt_WarnUnsupportedCallingConventions
373
   deriving (Eq, Show, Enum)
374

375
data Language = Haskell98 | Haskell2010
376
   deriving Enum
377

378
-- | The various Safe Haskell modes
379
380
data SafeHaskellMode
   = Sf_None
dterei's avatar
dterei committed
381
   | Sf_Unsafe
382
383
   | Sf_Trustworthy
   | Sf_Safe
384
   | Sf_SafeInferred
385
386
   deriving (Eq)

Ian Lynagh's avatar
Ian Lynagh committed
387
instance Show SafeHaskellMode where
Ian Lynagh's avatar
Ian Lynagh committed
388
389
390
391
392
    show Sf_None         = "None"
    show Sf_Unsafe       = "Unsafe"
    show Sf_Trustworthy  = "Trustworthy"
    show Sf_Safe         = "Safe"
    show Sf_SafeInferred = "Safe-Inferred"
Ian Lynagh's avatar
Ian Lynagh committed
393

394
instance Outputable SafeHaskellMode where
Ian Lynagh's avatar
Ian Lynagh committed
395
    ppr = text . show
396

397
data ExtensionFlag
398
399
400
401
402
403
404
   = Opt_Cpp
   | Opt_OverlappingInstances
   | Opt_UndecidableInstances
   | Opt_IncoherentInstances
   | Opt_MonomorphismRestriction
   | Opt_MonoPatBinds
   | Opt_MonoLocalBinds
405
406
   | Opt_RelaxedPolyRec           -- Deprecated
   | Opt_ExtendedDefaultRules     -- Use GHC's extended rules for defaulting
407
408
   | Opt_ForeignFunctionInterface
   | Opt_UnliftedFFITypes
409
   | Opt_InterruptibleFFI
410
   | Opt_CApiFFI
411
   | Opt_GHCForeignImportPrim
412
413
   | Opt_ParallelArrays           -- Syntactic support for parallel arrays
   | Opt_Arrows                   -- Arrow-notation syntax
414
415
416
417
418
419
420
421
422
423
424
425
426
427
   | Opt_TemplateHaskell
   | Opt_QuasiQuotes
   | Opt_ImplicitParams
   | 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
428
   | Opt_GADTSyntax
429
   | Opt_NPlusKPatterns
Ian Lynagh's avatar
Ian Lynagh committed
430
   | Opt_DoAndIfThenElse
431
   | Opt_RebindableSyntax
432
   | Opt_ConstraintKinds
dreixel's avatar
dreixel committed
433
   | Opt_PolyKinds                -- Kind polymorphism
dreixel's avatar
dreixel committed
434
   | Opt_DataKinds                -- Datatype promotion
435
436
   | Opt_InstanceSigs
 
437
438
439
440
441
   | Opt_StandaloneDeriving
   | Opt_DeriveDataTypeable
   | Opt_DeriveFunctor
   | Opt_DeriveTraversable
   | Opt_DeriveFoldable
442
   | Opt_DeriveGeneric            -- Allow deriving Generic/1
dreixel's avatar
dreixel committed
443
   | Opt_DefaultSignatures        -- Allow extra signatures for defmeths
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458

   | 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
459
   | Opt_MonadComprehensions
460
461
462
463
464
465
466
467
468
469
   | Opt_GeneralizedNewtypeDeriving
   | Opt_RecursiveDo
   | Opt_PostfixOperators
   | Opt_TupleSections
   | Opt_PatternGuards
   | Opt_LiberalTypeSynonyms
   | Opt_Rank2Types
   | Opt_RankNTypes
   | Opt_ImpredicativeTypes
   | Opt_TypeOperators
470
   | Opt_ExplicitNamespaces
471
472
473
474
475
   | Opt_PackageImports
   | Opt_ExplicitForAll
   | Opt_AlternativeLayoutRule
   | Opt_AlternativeLayoutRuleTransitional
   | Opt_DatatypeContexts
476
   | Opt_NondecreasingIndentation
477
   | Opt_RelaxedLayout
478
   | Opt_TraditionalRecordSyntax
479
   deriving (Eq, Enum, Show)
480

481
482
-- | 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
483
data DynFlags = DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
484
485
486
  ghcMode               :: GhcMode,
  ghcLink               :: GhcLink,
  hscTarget             :: HscTarget,
487
  settings              :: Settings,
488
  hscOutName            :: String,      -- ^ Name of the output file
489
  extCoreName           :: String,      -- ^ Name of the .hcr output file
490
  verbosity             :: Int,         -- ^ Verbosity level: see Note [Verbosity levels]
491
492
493
  optLevel              :: Int,         -- ^ Optimisation level
  simplPhases           :: Int,         -- ^ Number of simplifier phases
  maxSimplIterations    :: Int,         -- ^ Max simplifier iterations
494
  shouldDumpSimplPhase  :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
495
  ruleCheck             :: Maybe String,
496
  strictnessBefore      :: [Int],       -- ^ Additional demand analysis
497

498
  simplTickFactor       :: Int,         -- ^ Multiplier for simplifier ticks
499
500
501
  specConstrThreshold   :: Maybe Int,   -- ^ Threshold for SpecConstr
  specConstrCount       :: Maybe Int,   -- ^ Max number of specialisations for any one function
  liberateCaseThreshold :: Maybe Int,   -- ^ Threshold for LiberateCase
502
  floatLamArgs          :: Maybe Int,   -- ^ Arg count for lambda floating
503
                                        --   See CoreMonad.FloatOutSwitches
504

505
  cmdlineHcIncludes     :: [String],    -- ^ @\-\#includes@
Ian Lynagh's avatar
Ian Lynagh committed
506
507
508
  importPaths           :: [FilePath],
  mainModIs             :: Module,
  mainFunIs             :: Maybe String,
509
  ctxtStkDepth          :: Int,         -- ^ Typechecker context stack depth
510

511
  thisPackage           :: PackageId,   -- ^ name of package currently being compiled
512
513

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

518
519
520
  -- For object splitting
  splitInfo             :: Maybe (String,Int),

521
  -- paths etc.
Ian Lynagh's avatar
Ian Lynagh committed
522
  objectDir             :: Maybe String,
523
  dylibInstallName      :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
524
525
  hiDir                 :: Maybe String,
  stubDir               :: Maybe String,
526
  dumpDir               :: Maybe String,
527

Ian Lynagh's avatar
Ian Lynagh committed
528
529
530
  objectSuf             :: String,
  hcSuf                 :: String,
  hiSuf                 :: String,
531

Ian Lynagh's avatar
Ian Lynagh committed
532
533
534
  outputFile            :: Maybe String,
  outputHi              :: Maybe String,
  dynLibLoader          :: DynLibLoader,
535

536
  -- | This is set by 'DriverPipeline.runPipeline' based on where
Ian Lynagh's avatar
Ian Lynagh committed
537
538
  --    its output is going.
  dumpPrefix            :: Maybe FilePath,
539

540
541
  -- | Override the 'dumpPrefix' set by 'DriverPipeline.runPipeline'.
  --    Set by @-ddump-file-prefix@
Ian Lynagh's avatar
Ian Lynagh committed
542
543
544
545
546
547
548
  dumpPrefixForce       :: Maybe FilePath,

  includePaths          :: [String],
  libraryPaths          :: [String],
  frameworkPaths        :: [String],    -- used on darwin only
  cmdlineFrameworks     :: [String],    -- ditto

549
  rtsOpts               :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
550
  rtsOptsEnabled        :: RtsOptsEnabled,
551

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

554
555
556
557
  -- Plugins
  pluginModNames        :: [ModuleName],
  pluginModNameOpts     :: [(ModuleName,String)],

558
559
560
561
562
563
  --  For ghc -M
  depMakefile           :: FilePath,
  depIncludePkgDeps     :: Bool,
  depExcludeMods        :: [ModuleName],
  depSuffixes           :: [String],

564
  --  Package flags
565
  extraPkgConfs         :: [PkgConfRef] -> [PkgConfRef],
566
        -- ^ The @-package-db@ flags given on the command line, in the order
Ian Lynagh's avatar
Ian Lynagh committed
567
        -- they appeared.
568

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

572
  -- Package state
Ian Lynagh's avatar
Ian Lynagh committed
573
  -- NB. do not modify this field, it is calculated by
574
  -- Packages.initPackages and Packages.updatePackages.
575
  pkgDatabase           :: Maybe [PackageConfig],
Ian Lynagh's avatar
Ian Lynagh committed
576
  pkgState              :: PackageState,
577

578
579
580
581
  -- Temporary files
  -- These have to be IORefs, because the defaultCleanupHandler needs to
  -- know what to clean when an exception happens
  filesToClean          :: IORef [FilePath],
582
  dirsToClean           :: IORef (Map FilePath FilePath),
583

584
585
586
587
588
  -- Names of files which were generated from -ddump-to-file; used to
  -- track which ones we need to truncate because it's our first run
  -- through
  generatedDumps        :: IORef (Set FilePath),

589
  -- hsc dynamic flags
590
591
  flags                 :: IntSet,
  warningFlags          :: IntSet,
592
  -- Don't change this without updating extensionFlags:
593
  language              :: Maybe Language,
594
595
  -- | Safe Haskell mode
  safeHaskell           :: SafeHaskellMode,
596
597
598
  -- We store the location of where some extension and flags were turned on so
  -- we can produce accurate error messages when Safe Haskell fails due to
  -- them.
599
600
  thOnLoc               :: SrcSpan,
  newDerivOnLoc         :: SrcSpan,
601
  pkgTrustOnLoc         :: SrcSpan,
602
603
  warnSafeOnLoc         :: SrcSpan,
  warnUnsafeOnLoc       :: SrcSpan,
604
605
606
607
  -- Don't change this without updating extensionFlags:
  extensions            :: [OnOff ExtensionFlag],
  -- extensionFlags should always be equal to
  --     flattenExtensionFlags language extensions
608
  extensionFlags        :: IntSet,
Ian Lynagh's avatar
Ian Lynagh committed
609

610
  -- | MsgDoc output action: use "ErrUtils" instead of this if you can
611
  log_action            :: LogAction,
612
613
  flushOut              :: FlushOut,
  flushErr              :: FlushErr,
David Waern's avatar
David Waern committed
614

615
  haddockOptions        :: Maybe String,
616
  ghciScripts           :: [String],
617

618
619
  -- Output style options
  pprUserLength         :: Int,
Ian Lynagh's avatar
Ian Lynagh committed
620
  pprCols               :: Int,
Ian Lynagh's avatar
Ian Lynagh committed
621
  traceLevel            :: Int, -- Standard level is 1. Less verbose is 0.
622

623
  -- | what kind of {-# SCC #-} to add automatically
624
625
626
  profAuto              :: ProfAuto,

  llvmVersion           :: IORef (Int)
627
628
 }

629
630
631
class HasDynFlags m where
    getDynFlags :: m DynFlags

Ian Lynagh's avatar
Ian Lynagh committed
632
633
634
class ContainsDynFlags t where
    extractDynFlags :: t -> DynFlags

635
636
637
638
639
data ProfAuto
  = NoProfAuto         -- ^ no SCC annotations added
  | ProfAutoAll        -- ^ top-level and nested functions are annotated
  | ProfAutoTop        -- ^ top-level functions annotated only
  | ProfAutoExports    -- ^ exported functions annotated only
640
  | ProfAutoCalls      -- ^ annotate call-sites
Simon Marlow's avatar
Simon Marlow committed
641
  deriving (Enum)
642

643
data Settings = Settings {
644
  sTargetPlatform        :: Platform,    -- Filled in by SysTools
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
  sGhcUsagePath          :: FilePath,    -- Filled in by SysTools
  sGhciUsagePath         :: FilePath,    -- ditto
  sTopDir                :: FilePath,
  sTmpDir                :: String,      -- no trailing '/'
  -- You shouldn't need to look things up in rawSettings directly.
  -- They should have their own fields instead.
  sRawSettings           :: [(String, String)],
  sExtraGccViaCFlags     :: [String],
  sSystemPackageConfig   :: FilePath,
  -- commands for particular phases
  sPgm_L                 :: String,
  sPgm_P                 :: (String,[Option]),
  sPgm_F                 :: String,
  sPgm_c                 :: (String,[Option]),
  sPgm_s                 :: (String,[Option]),
  sPgm_a                 :: (String,[Option]),
  sPgm_l                 :: (String,[Option]),
  sPgm_dll               :: (String,[Option]),
  sPgm_T                 :: String,
  sPgm_sysman            :: String,
  sPgm_windres           :: String,
  sPgm_lo                :: (String,[Option]), -- LLVM: opt llvm optimiser
667
668
669
670
671
672
673
674
675
676
677
678
  sPgm_lc                :: (String,[Option]), -- LLVM: llc static compiler
  -- options for particular phases
  sOpt_L                 :: [String],
  sOpt_P                 :: [String],
  sOpt_F                 :: [String],
  sOpt_c                 :: [String],
  sOpt_a                 :: [String],
  sOpt_l                 :: [String],
  sOpt_windres           :: [String],
  sOpt_lo                :: [String], -- LLVM: llvm optimiser
  sOpt_lc                :: [String]  -- LLVM: llc static compiler

679
680
 }

681
682
683
targetPlatform :: DynFlags -> Platform
targetPlatform dflags = sTargetPlatform (settings dflags)

684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
ghcUsagePath          :: DynFlags -> FilePath
ghcUsagePath dflags = sGhcUsagePath (settings dflags)
ghciUsagePath         :: DynFlags -> FilePath
ghciUsagePath dflags = sGhciUsagePath (settings dflags)
topDir                :: DynFlags -> FilePath
topDir dflags = sTopDir (settings dflags)
tmpDir                :: DynFlags -> String
tmpDir dflags = sTmpDir (settings dflags)
rawSettings           :: DynFlags -> [(String, String)]
rawSettings dflags = sRawSettings (settings dflags)
extraGccViaCFlags     :: DynFlags -> [String]
extraGccViaCFlags dflags = sExtraGccViaCFlags (settings dflags)
systemPackageConfig   :: DynFlags -> FilePath
systemPackageConfig dflags = sSystemPackageConfig (settings dflags)
pgm_L                 :: DynFlags -> String
pgm_L dflags = sPgm_L (settings dflags)
pgm_P                 :: DynFlags -> (String,[Option])
pgm_P dflags = sPgm_P (settings dflags)
pgm_F                 :: DynFlags -> String
pgm_F dflags = sPgm_F (settings dflags)
pgm_c                 :: DynFlags -> (String,[Option])
pgm_c dflags = sPgm_c (settings dflags)
pgm_s                 :: DynFlags -> (String,[Option])
pgm_s dflags = sPgm_s (settings dflags)
pgm_a                 :: DynFlags -> (String,[Option])
pgm_a dflags = sPgm_a (settings dflags)
pgm_l                 :: DynFlags -> (String,[Option])
pgm_l dflags = sPgm_l (settings dflags)
pgm_dll               :: DynFlags -> (String,[Option])
pgm_dll dflags = sPgm_dll (settings dflags)
pgm_T                 :: DynFlags -> String
pgm_T dflags = sPgm_T (settings dflags)
pgm_sysman            :: DynFlags -> String
pgm_sysman dflags = sPgm_sysman (settings dflags)
pgm_windres           :: DynFlags -> String
pgm_windres dflags = sPgm_windres (settings dflags)
pgm_lo                :: DynFlags -> (String,[Option])
pgm_lo dflags = sPgm_lo (settings dflags)
pgm_lc                :: DynFlags -> (String,[Option])
pgm_lc dflags = sPgm_lc (settings dflags)
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
opt_L                 :: DynFlags -> [String]
opt_L dflags = sOpt_L (settings dflags)
opt_P                 :: DynFlags -> [String]
opt_P dflags = sOpt_P (settings dflags)
opt_F                 :: DynFlags -> [String]
opt_F dflags = sOpt_F (settings dflags)
opt_c                 :: DynFlags -> [String]
opt_c dflags = sOpt_c (settings dflags)
opt_a                 :: DynFlags -> [String]
opt_a dflags = sOpt_a (settings dflags)
opt_l                 :: DynFlags -> [String]
opt_l dflags = sOpt_l (settings dflags)
opt_windres           :: DynFlags -> [String]
opt_windres dflags = sOpt_windres (settings dflags)
opt_lo                :: DynFlags -> [String]
opt_lo dflags = sOpt_lo (settings dflags)
opt_lc                :: DynFlags -> [String]
opt_lc dflags = sOpt_lc (settings dflags)
742

743
744
745
wayNames :: DynFlags -> [WayName]
wayNames = map wayName . ways

746
747
-- | The target code type of the compilation (if any).
--
748
749
750
-- Whenever you change the target, also make sure to set 'ghcLink' to
-- something sensible.
--
751
752
753
754
-- 'HscNothing' can be used to avoid generating any output, however, note
-- that:
--
--  * This will not run the desugaring step, thus no warnings generated in
755
756
757
--    this step will be output.  In particular, this includes warnings related
--    to pattern matching.  You can run the desugarer manually using
--    'GHC.desugarModule'.
758
--
759
760
761
762
--  * 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
Simon Hengel's avatar
Simon Hengel committed
763
--    different target or avoid typechecking such modules.  (The latter may be
764
--    preferable for security reasons.)
765
--
766
data HscTarget
767
768
  = HscC           -- ^ Generate C code.
  | HscAsm         -- ^ Generate assembly using the native code generator.
769
  | HscLlvm        -- ^ Generate assembly using the llvm code generator.
770
771
  | HscInterpreted -- ^ Generate bytecode.  (Requires 'LinkInMemory')
  | HscNothing     -- ^ Don't generate any code.  See notes above.
772
773
  deriving (Eq, Show)

Ian Lynagh's avatar
Ian Lynagh committed
774
775
776
777
778
779
780
showHscTargetFlag :: HscTarget -> String
showHscTargetFlag HscC           = "-fvia-c"
showHscTargetFlag HscAsm         = "-fasm"
showHscTargetFlag HscLlvm        = "-fllvm"
showHscTargetFlag HscInterpreted = "-fbyte-code"
showHscTargetFlag HscNothing     = "-fno-code"

781
-- | Will this target result in an object file on the disk?
782
783
784
isObjectTarget :: HscTarget -> Bool
isObjectTarget HscC     = True
isObjectTarget HscAsm   = True
785
isObjectTarget HscLlvm  = True
786
787
isObjectTarget _        = False

788
789
790
791
792
793
794
795
796
797
798
-- | Does this target retain *all* top-level bindings for a module,
-- rather than just the exported bindings, in the TypeEnv and compiled
-- code (if any)?  In interpreted mode we do this, so that GHCi can
-- call functions inside a module.  In HscNothing mode we also do it,
-- so that Haddock can get access to the GlobalRdrEnv for a module
-- after typechecking it.
targetRetainsAllBindings :: HscTarget -> Bool
targetRetainsAllBindings HscInterpreted = True
targetRetainsAllBindings HscNothing     = True
targetRetainsAllBindings _              = False

799
800
801
802
803
804
-- | 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.
805
data GhcMode
806
807
808
  = CompManager         -- ^ @\-\-make@, GHCi, etc.
  | OneShot             -- ^ @ghc -c Foo.hs@
  | MkDepend            -- ^ @ghc -M@, see "Finder" for why we need this
809
810
  deriving Eq

811
812
813
814
815
instance Outputable GhcMode where
  ppr CompManager = ptext (sLit "CompManager")
  ppr OneShot     = ptext (sLit "OneShot")
  ppr MkDepend    = ptext (sLit "MkDepend")

816
817
818
819
isOneShot :: GhcMode -> Bool
isOneShot OneShot = True
isOneShot _other  = False

820
821
822
823
-- | 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
824
825
  | LinkInMemory        -- ^ Use the in-memory dynamic linker (works for both
                        --   bytecode and object code).
826
  | LinkDynLib          -- ^ Link objects into a dynamic lib (DLL on Windows, DSO on ELF platforms)
827
  deriving (Eq, Show)
828
829
830

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

833
834
835
-- Is it worth evaluating this Bool and caching it in the DynFlags value
-- during initDynFlags?
doingTickyProfiling :: DynFlags -> Bool
836
837
838
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.
839

840
data PackageFlag
841
  = ExposePackage   String
842
  | ExposePackageId String
843
844
845
846
  | HidePackage     String
  | IgnorePackage   String
  | TrustPackage    String
  | DistrustPackage String
847
  deriving Eq
848

twanvl's avatar
twanvl committed
849
defaultHscTarget :: HscTarget
850
851
defaultHscTarget = defaultObjectTarget

852
-- | The 'HscTarget' value corresponding to the default way to create
853
-- object files on the current platform.
twanvl's avatar
twanvl committed
854
defaultObjectTarget :: HscTarget
855
defaultObjectTarget
856
  | cGhcUnregisterised    == "YES"      =  HscC
Ian Lynagh's avatar
Ian Lynagh committed
857
  | cGhcWithNativeCodeGen == "YES"      =  HscAsm
858
  | otherwise                           =  HscLlvm
859

860
861
862
863
864
data DynLibLoader
  = Deployable
  | SystemDependent
  deriving Eq

Ian Lynagh's avatar
Ian Lynagh committed
865
data RtsOptsEnabled = RtsOptsNone | RtsOptsSafeOnly | RtsOptsAll
866
  deriving (Show)
Ian Lynagh's avatar
Ian Lynagh committed
867

868
-- | Used by 'GHC.newSession' to partially initialize a new 'DynFlags' value
twanvl's avatar
twanvl committed
869
initDynFlags :: DynFlags -> IO DynFlags
870
871
872
initDynFlags dflags = do
 -- someday these will be dynamic flags
 ways <- readIORef v_Ways
873
 refFilesToClean <- newIORef []
874
 refDirsToClean <- newIORef Map.empty
875
 refGeneratedDumps <- newIORef Set.empty
876
 refLlvmVersion <- newIORef 28
877
 return dflags{
878
879
880
881
882
883
884
        ways           = ways,
        buildTag       = mkBuildTag (filter (not . wayRTSOnly) ways),
        rtsBuildTag    = mkBuildTag ways,
        filesToClean   = refFilesToClean,
        dirsToClean    = refDirsToClean,
        generatedDumps = refGeneratedDumps,
        llvmVersion    = refLlvmVersion
Ian Lynagh's avatar
Ian Lynagh committed
885
        }
886

887
888
-- | The normal 'DynFlags'. Note that they is not suitable for use in this form
-- and must be fully initialized by 'GHC.newSession' first.
889
890
defaultDynFlags :: Settings -> DynFlags
defaultDynFlags mySettings =
891
     DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
892
893
894
895
896
897
898
        ghcMode                 = CompManager,
        ghcLink                 = LinkBinary,
        hscTarget               = defaultHscTarget,
        hscOutName              = "",
        extCoreName             = "",
        verbosity               = 0,
        optLevel                = 0,
899
        simplPhases             = 2,
Ian Lynagh's avatar
Ian Lynagh committed
900
        maxSimplIterations      = 4,
901
        shouldDumpSimplPhase    = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
902
        ruleCheck               = Nothing,
dterei's avatar
dterei committed
903
        simplTickFactor         = 100,
904
        specConstrThreshold     = Just 2000,
Ian Lynagh's avatar
Ian Lynagh committed
905
        specConstrCount         = Just 3,
906
        liberateCaseThreshold   = Just 2000,
907
        floatLamArgs            = Just 0, -- Default: float only if no fvs
908
909
        strictnessBefore        = [],

Ian Lynagh's avatar
Ian Lynagh committed
910
911
912
913
914
915
916
917
918
        cmdlineHcIncludes       = [],
        importPaths             = ["."],
        mainModIs               = mAIN,
        mainFunIs               = Nothing,
        ctxtStkDepth            = mAX_CONTEXT_REDUCTION_DEPTH,

        thisPackage             = mainPackageId,

        objectDir               = Nothing,
919
        dylibInstallName        = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
920
921
        hiDir                   = Nothing,
        stubDir                 = Nothing,
922
        dumpDir                 = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
923
924
925
926
927

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

928
929
930
        pluginModNames          = [],
        pluginModNameOpts       = [],

Ian Lynagh's avatar
Ian Lynagh committed
931
932
        outputFile              = Nothing,
        outputHi                = Nothing,
933
        dynLibLoader            = SystemDependent,
Ian Lynagh's avatar
Ian Lynagh committed
934
935
936
937
938
939
        dumpPrefix              = Nothing,
        dumpPrefixForce         = Nothing,
        includePaths            = [],
        libraryPaths            = [],
        frameworkPaths          = [],
        cmdlineFrameworks       = [],
940
        rtsOpts                 = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
941
        rtsOptsEnabled          = RtsOptsSafeOnly,
Ian Lynagh's avatar
Ian Lynagh committed
942
943
944

        hpcDir                  = ".hpc",

945
        extraPkgConfs           = id,
Ian Lynagh's avatar
Ian Lynagh committed
946
        packageFlags            = [],
947
948
        pkgDatabase             = Nothing,
        pkgState                = panic "no package state yet: call GHC.setSessionDynFlags",
949
        ways                    = panic "defaultDynFlags: No ways",
Ian Lynagh's avatar
Ian Lynagh committed
950
951
        buildTag                = panic "defaultDynFlags: No buildTag",
        rtsBuildTag             = panic "defaultDynFlags: No rtsBuildTag",
952
        splitInfo               = Nothing,