DynFlags.hs 112 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(..),
20
        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
        -- ** Safe Haskell
48
        SafeHaskellMode(..),
49
        safeHaskellOn, safeImportsOn, safeLanguageOn, safeInferOn,
50
        packageTrustOn,
51
        safeDirectImpsReq, safeImplicitImpsReq,
52
        unsafeFlags,
53

54
        -- ** System tool settings and locations
55
        Settings(..),
56
        targetPlatform,
57 58 59 60
        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
61
        opt_L, opt_P, opt_F, opt_c, opt_a, opt_l,
62
        opt_windres, opt_lo, opt_lc,
63 64


65
        -- ** Manipulating DynFlags
66
        defaultDynFlags,                -- Settings -> DynFlags
Ian Lynagh's avatar
Ian Lynagh committed
67
        initDynFlags,                   -- DynFlags -> IO DynFlags
68
        defaultLogAction,
69 70
        defaultFlushOut,
        defaultFlushErr,
Ian Lynagh's avatar
Ian Lynagh committed
71

72
        getOpts,                        -- DynFlags -> (DynFlags -> [a]) -> [a]
73
        getVerbFlags,
Ian Lynagh's avatar
Ian Lynagh committed
74 75 76
        updOptLevel,
        setTmpDir,
        setPackageName,
77
        doingTickyProfiling,
Ian Lynagh's avatar
Ian Lynagh committed
78

79
        -- ** Parsing DynFlags
80 81
        parseDynamicFlagsCmdLine,
        parseDynamicFilePragma,
82
        allFlags,
83

84
        supportedLanguagesAndExtensions,
85 86

        -- ** DynFlag C compiler options
87
        picCCOpts,
88 89 90 91 92 93

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

        -- * Compiler configuration suitable for display to the user
94 95
        compilerInfo
#ifdef GHCI
dterei's avatar
dterei committed
96
-- Only in stage 2 can we be sure that the RTS
97
-- exposes the appropriate runtime boolean
dterei's avatar
dterei committed
98
      , rtsIsProfiled
99
#endif
100 101 102 103
  ) where

#include "HsVersions.h"

104
import Platform
105
import Module
Simon Marlow's avatar
Simon Marlow committed
106
import PackageConfig
107
import PrelNames        ( mAIN )
108
import StaticFlags
109
import {-# SOURCE #-} Packages (PackageState)
Ian Lynagh's avatar
Ian Lynagh committed
110
import DriverPhases     ( Phase(..), phaseInputExt )
111 112
import Config
import CmdLineParser
Ian Lynagh's avatar
Ian Lynagh committed
113
import Constants        ( mAX_CONTEXT_REDUCTION_DEPTH )
114
import Panic
115
import Util
116
import Maybes           ( orElse )
117
import SrcLoc
118
import FastString
Simon Marlow's avatar
Simon Marlow committed
119
import Outputable
Ian Lynagh's avatar
Ian Lynagh committed
120
#ifdef GHCI
Ian Lynagh's avatar
Ian Lynagh committed
121
import Foreign.C        ( CInt(..) )
Ian Lynagh's avatar
Ian Lynagh committed
122
#endif
123
import {-# SOURCE #-} ErrUtils ( Severity(..), MsgDoc, mkLocMessage )
124

Ian Lynagh's avatar
Ian Lynagh committed
125
#ifdef GHCI
126
import System.IO.Unsafe ( unsafePerformIO )
Ian Lynagh's avatar
Ian Lynagh committed
127
#endif
128
import Data.IORef
Ian Lynagh's avatar
Ian Lynagh committed
129
import Control.Monad    ( when )
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
130

131
import Data.Char
132
import Data.List
133 134
import Data.Map (Map)
import qualified Data.Map as Map
135 136
import Data.Set (Set)
import qualified Data.Set as Set
Ian Lynagh's avatar
Ian Lynagh committed
137
import System.FilePath
138
import System.IO
139

140 141 142
import Data.IntSet (IntSet)
import qualified Data.IntSet as IntSet

143 144 145
-- -----------------------------------------------------------------------------
-- DynFlags

146
-- | Enumerates the simple on-or-off dynamic flags
147 148 149 150
data DynFlag

   -- debugging flags
   = Opt_D_dump_cmm
151
   | Opt_D_dump_raw_cmm
152
   | Opt_D_dump_cmmz
153
   | Opt_D_dump_cmmz_pretty
154 155 156 157 158 159 160 161 162 163 164 165 166 167 168
   -- 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
169
   | Opt_D_dump_cps_cmm
170
   | Opt_D_dump_cvt_cmm
171
   | Opt_D_dump_asm
172 173
   | Opt_D_dump_asm_native
   | Opt_D_dump_asm_liveness
174
   | Opt_D_dump_asm_coalesce
175 176 177
   | Opt_D_dump_asm_regalloc
   | Opt_D_dump_asm_regalloc_stages
   | Opt_D_dump_asm_conflicts
178
   | Opt_D_dump_asm_stats
179
   | Opt_D_dump_asm_expanded
180
   | Opt_D_dump_llvm
181
   | Opt_D_dump_core_stats
182 183 184 185 186 187
   | Opt_D_dump_cpranal
   | Opt_D_dump_deriv
   | Opt_D_dump_ds
   | Opt_D_dump_flatC
   | Opt_D_dump_foreign
   | Opt_D_dump_inlinings
188
   | Opt_D_dump_rule_firings
189
   | Opt_D_dump_rule_rewrites
190 191 192
   | Opt_D_dump_occur_anal
   | Opt_D_dump_parsed
   | Opt_D_dump_rn
193
   | Opt_D_dump_core_pipeline -- TODO FIXME: dump after simplifier stats
194 195
   | Opt_D_dump_simpl
   | Opt_D_dump_simpl_iterations
196
   | Opt_D_dump_simpl_phases
197 198 199 200 201 202 203 204 205 206 207 208 209
   | 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
210
   | Opt_D_dump_cs_trace -- Constraint solver in type checker
211 212
   | Opt_D_dump_tc_trace
   | Opt_D_dump_if_trace
213
   | Opt_D_dump_vt_trace
214 215 216
   | Opt_D_dump_splices
   | Opt_D_dump_BCOs
   | Opt_D_dump_vect
217
   | Opt_D_dump_avoid_vect
218
   | Opt_D_dump_ticked
pepe's avatar
pepe committed
219
   | Opt_D_dump_rtti
220 221 222 223 224 225
   | 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
226
   | Opt_D_dump_mod_cycles
227
   | Opt_D_dump_view_pattern_commoning
228
   | Opt_D_faststring_stats
Ian Lynagh's avatar
Ian Lynagh committed
229
   | Opt_DumpToFile                     -- ^ Append dump output to files instead of stdout.
Simon Marlow's avatar
Simon Marlow committed
230
   | Opt_D_no_debug_output
231 232 233
   | Opt_DoCoreLinting
   | Opt_DoStgLinting
   | Opt_DoCmmLinting
Ben.Lippmeier@anu.edu.au's avatar
Ben.Lippmeier@anu.edu.au committed
234
   | Opt_DoAsmLinting
235
   | Opt_NoLlvmMangler                 -- hidden flag
236

Ian Lynagh's avatar
Ian Lynagh committed
237
   | Opt_WarnIsError                    -- -Werror; makes warnings fatal
238

239 240
   | Opt_PrintExplicitForalls

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

265 266 267 268 269
   -- Interface files
   | Opt_IgnoreInterfacePragmas
   | Opt_OmitInterfacePragmas
   | Opt_ExposeAllUnfoldings

Ian Lynagh's avatar
Ian Lynagh committed
270 271
   -- profiling opts
   | Opt_AutoSccsOnIndividualCafs
272
   | Opt_ProfCountEntries
Ian Lynagh's avatar
Ian Lynagh committed
273

274 275
   -- misc opts
   | Opt_Pp
276
   | Opt_ForceRecomp
277
   | Opt_ExcessPrecision
278
   | Opt_EagerBlackHoling
279 280 281
   | Opt_NoHsMain
   | Opt_SplitObjs
   | Opt_StgStats
282
   | Opt_HideAllPackages
283
   | Opt_PrintBindResult
284
   | Opt_Haddock
David Waern's avatar
David Waern committed
285
   | Opt_HaddockOptions
286
   | Opt_Hpc_No_Auto
287
   | Opt_BreakOnException
288
   | Opt_BreakOnError
289
   | Opt_PrintEvldWithShow
290
   | Opt_PrintBindContents
291 292
   | Opt_GenManifest
   | Opt_EmbedManifest
293
   | Opt_EmitExternalCore
Ian Lynagh's avatar
Ian Lynagh committed
294
   | Opt_SharedImplib
295
   | Opt_BuildingCabalPackage
296
   | Opt_SSE2
tibbe's avatar
tibbe committed
297
   | Opt_SSE4_2
298
   | Opt_GhciSandbox
Ian Lynagh's avatar
Ian Lynagh committed
299
   | Opt_GhciHistory
300
   | Opt_HelpfulErrors
301
   | Opt_DeferTypeErrors
302

303
   -- temporary flags
304
   | Opt_RunCPS
305
   | Opt_RunCPSZ
306
   | Opt_AutoLinkPackages
307
   | Opt_ImplicitImportQualified
308
   | Opt_TryNewCodeGen
309 310 311 312 313 314

   -- keeping stuff
   | Opt_KeepHiDiffs
   | Opt_KeepHcFiles
   | Opt_KeepSFiles
   | Opt_KeepTmpFiles
Jedai's avatar
Jedai committed
315
   | Opt_KeepRawTokenStream
316
   | Opt_KeepLlvmFiles
317

318
   -- safe haskell flags
dterei's avatar
dterei committed
319
   | Opt_DistrustAllPackages
320 321
   | Opt_PackageTrust

322
   deriving (Eq, Show, Enum)
Ian Lynagh's avatar
Ian Lynagh committed
323

324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356
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
357 358
   | Opt_WarnUnsafe
   | Opt_WarnSafe
Ian Lynagh's avatar
Ian Lynagh committed
359
   | Opt_WarnPointlessPragmas
360
   | Opt_WarnUnsupportedCallingConventions
361
   deriving (Eq, Show, Enum)
362

363
data Language = Haskell98 | Haskell2010
364
   deriving Enum
365

366
-- | The various Safe Haskell modes
367 368
data SafeHaskellMode
   = Sf_None
dterei's avatar
dterei committed
369
   | Sf_Unsafe
370 371
   | Sf_Trustworthy
   | Sf_Safe
dterei's avatar
dterei committed
372
   | Sf_SafeInfered
373 374
   deriving (Eq)

375
instance Outputable SafeHaskellMode where
dterei's avatar
dterei committed
376 377
    ppr Sf_None        = ptext $ sLit "None"
    ppr Sf_Unsafe      = ptext $ sLit "Unsafe"
378
    ppr Sf_Trustworthy = ptext $ sLit "Trustworthy"
dterei's avatar
dterei committed
379 380
    ppr Sf_Safe        = ptext $ sLit "Safe"
    ppr Sf_SafeInfered = ptext $ sLit "Safe-Infered"
381

382
data ExtensionFlag
383 384 385 386 387 388 389
   = Opt_Cpp
   | Opt_OverlappingInstances
   | Opt_UndecidableInstances
   | Opt_IncoherentInstances
   | Opt_MonomorphismRestriction
   | Opt_MonoPatBinds
   | Opt_MonoLocalBinds
390 391
   | Opt_RelaxedPolyRec           -- Deprecated
   | Opt_ExtendedDefaultRules     -- Use GHC's extended rules for defaulting
392 393
   | Opt_ForeignFunctionInterface
   | Opt_UnliftedFFITypes
394
   | Opt_InterruptibleFFI
395
   | Opt_CApiFFI
396
   | Opt_GHCForeignImportPrim
397 398
   | Opt_ParallelArrays           -- Syntactic support for parallel arrays
   | Opt_Arrows                   -- Arrow-notation syntax
399 400 401 402 403 404 405 406 407 408 409 410 411 412
   | 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
413
   | Opt_GADTSyntax
414
   | Opt_NPlusKPatterns
Ian Lynagh's avatar
Ian Lynagh committed
415
   | Opt_DoAndIfThenElse
416
   | Opt_RebindableSyntax
417
   | Opt_ConstraintKinds
dreixel's avatar
dreixel committed
418
   | Opt_PolyKinds                -- Kind polymorphism
dreixel's avatar
dreixel committed
419
   | Opt_DataKinds                -- Datatype promotion
420 421
   | Opt_InstanceSigs
 
422 423 424 425 426
   | Opt_StandaloneDeriving
   | Opt_DeriveDataTypeable
   | Opt_DeriveFunctor
   | Opt_DeriveTraversable
   | Opt_DeriveFoldable
427
   | Opt_DeriveGeneric            -- Allow deriving Generic/1
dreixel's avatar
dreixel committed
428
   | Opt_DefaultSignatures        -- Allow extra signatures for defmeths
429 430 431 432 433 434 435 436 437 438 439 440 441 442 443

   | 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
444
   | Opt_MonadComprehensions
445 446 447 448 449 450 451 452 453 454 455
   | Opt_GeneralizedNewtypeDeriving
   | Opt_RecursiveDo
   | Opt_DoRec
   | Opt_PostfixOperators
   | Opt_TupleSections
   | Opt_PatternGuards
   | Opt_LiberalTypeSynonyms
   | Opt_Rank2Types
   | Opt_RankNTypes
   | Opt_ImpredicativeTypes
   | Opt_TypeOperators
456
   | Opt_ExplicitNamespaces
457 458 459 460 461
   | Opt_PackageImports
   | Opt_ExplicitForAll
   | Opt_AlternativeLayoutRule
   | Opt_AlternativeLayoutRuleTransitional
   | Opt_DatatypeContexts
462
   | Opt_NondecreasingIndentation
463
   | Opt_RelaxedLayout
464
   | Opt_TraditionalRecordSyntax
465
   deriving (Eq, Enum, Show)
466

467 468
-- | 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
469
data DynFlags = DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
470 471 472
  ghcMode               :: GhcMode,
  ghcLink               :: GhcLink,
  hscTarget             :: HscTarget,
473
  settings              :: Settings,
474
  hscOutName            :: String,      -- ^ Name of the output file
475
  extCoreName           :: String,      -- ^ Name of the .hcr output file
476
  verbosity             :: Int,         -- ^ Verbosity level: see Note [Verbosity levels]
477 478 479
  optLevel              :: Int,         -- ^ Optimisation level
  simplPhases           :: Int,         -- ^ Number of simplifier phases
  maxSimplIterations    :: Int,         -- ^ Max simplifier iterations
480
  shouldDumpSimplPhase  :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
481
  ruleCheck             :: Maybe String,
482
  strictnessBefore      :: [Int],       -- ^ Additional demand analysis
483

484
  simplTickFactor       :: Int,         -- ^ Multiplier for simplifier ticks
485 486 487
  specConstrThreshold   :: Maybe Int,   -- ^ Threshold for SpecConstr
  specConstrCount       :: Maybe Int,   -- ^ Max number of specialisations for any one function
  liberateCaseThreshold :: Maybe Int,   -- ^ Threshold for LiberateCase
488
  floatLamArgs          :: Maybe Int,   -- ^ Arg count for lambda floating
489
                                        --   See CoreMonad.FloatOutSwitches
490

491
  cmdlineHcIncludes     :: [String],    -- ^ @\-\#includes@
Ian Lynagh's avatar
Ian Lynagh committed
492 493 494
  importPaths           :: [FilePath],
  mainModIs             :: Module,
  mainFunIs             :: Maybe String,
495
  ctxtStkDepth          :: Int,         -- ^ Typechecker context stack depth
496

497
  thisPackage           :: PackageId,   -- ^ name of package currently being compiled
498 499

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

504 505 506
  -- For object splitting
  splitInfo             :: Maybe (String,Int),

507
  -- paths etc.
Ian Lynagh's avatar
Ian Lynagh committed
508
  objectDir             :: Maybe String,
509
  dylibInstallName      :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
510 511
  hiDir                 :: Maybe String,
  stubDir               :: Maybe String,
512
  dumpDir               :: Maybe String,
513

Ian Lynagh's avatar
Ian Lynagh committed
514 515 516
  objectSuf             :: String,
  hcSuf                 :: String,
  hiSuf                 :: String,
517

Ian Lynagh's avatar
Ian Lynagh committed
518 519 520
  outputFile            :: Maybe String,
  outputHi              :: Maybe String,
  dynLibLoader          :: DynLibLoader,
521

522
  -- | This is set by 'DriverPipeline.runPipeline' based on where
Ian Lynagh's avatar
Ian Lynagh committed
523 524
  --    its output is going.
  dumpPrefix            :: Maybe FilePath,
525

526 527
  -- | Override the 'dumpPrefix' set by 'DriverPipeline.runPipeline'.
  --    Set by @-ddump-file-prefix@
Ian Lynagh's avatar
Ian Lynagh committed
528 529 530 531 532 533 534
  dumpPrefixForce       :: Maybe FilePath,

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

535
  rtsOpts               :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
536
  rtsOptsEnabled        :: RtsOptsEnabled,
537

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

540 541 542 543
  -- Plugins
  pluginModNames        :: [ModuleName],
  pluginModNameOpts     :: [(ModuleName,String)],

544 545 546 547 548 549
  --  For ghc -M
  depMakefile           :: FilePath,
  depIncludePkgDeps     :: Bool,
  depExcludeMods        :: [ModuleName],
  depSuffixes           :: [String],

550
  --  Package flags
551
  extraPkgConfs         :: [PkgConfRef] -> [PkgConfRef],
552
        -- ^ The @-package-db@ flags given on the command line, in the order
Ian Lynagh's avatar
Ian Lynagh committed
553
        -- they appeared.
554

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

558
  -- Package state
Ian Lynagh's avatar
Ian Lynagh committed
559
  -- NB. do not modify this field, it is calculated by
560
  -- Packages.initPackages and Packages.updatePackages.
561
  pkgDatabase           :: Maybe [PackageConfig],
Ian Lynagh's avatar
Ian Lynagh committed
562
  pkgState              :: PackageState,
563

564 565 566 567
  -- Temporary files
  -- These have to be IORefs, because the defaultCleanupHandler needs to
  -- know what to clean when an exception happens
  filesToClean          :: IORef [FilePath],
568
  dirsToClean           :: IORef (Map FilePath FilePath),
569

570 571 572 573 574
  -- 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),

575
  -- hsc dynamic flags
576 577
  flags                 :: IntSet,
  warningFlags          :: IntSet,
578
  -- Don't change this without updating extensionFlags:
579
  language              :: Maybe Language,
580 581
  -- | Safe Haskell mode
  safeHaskell           :: SafeHaskellMode,
582 583 584
  -- 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.
585 586
  thOnLoc               :: SrcSpan,
  newDerivOnLoc         :: SrcSpan,
587
  pkgTrustOnLoc         :: SrcSpan,
588 589
  warnSafeOnLoc         :: SrcSpan,
  warnUnsafeOnLoc       :: SrcSpan,
590 591 592 593
  -- Don't change this without updating extensionFlags:
  extensions            :: [OnOff ExtensionFlag],
  -- extensionFlags should always be equal to
  --     flattenExtensionFlags language extensions
594
  extensionFlags        :: IntSet,
Ian Lynagh's avatar
Ian Lynagh committed
595

596
  -- | MsgDoc output action: use "ErrUtils" instead of this if you can
597
  log_action            :: LogAction,
598 599
  flushOut              :: FlushOut,
  flushErr              :: FlushErr,
David Waern's avatar
David Waern committed
600

601
  haddockOptions        :: Maybe String,
602
  ghciScripts           :: [String],
603 604

  -- | what kind of {-# SCC #-} to add automatically
605 606 607
  profAuto              :: ProfAuto,

  llvmVersion           :: IORef (Int)
608 609
 }

610 611 612
class HasDynFlags m where
    getDynFlags :: m DynFlags

Ian Lynagh's avatar
Ian Lynagh committed
613 614 615
class ContainsDynFlags t where
    extractDynFlags :: t -> DynFlags

616 617 618 619 620
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
621
  | ProfAutoCalls      -- ^ annotate call-sites
Simon Marlow's avatar
Simon Marlow committed
622
  deriving (Enum)
623

624
data Settings = Settings {
625
  sTargetPlatform        :: Platform,    -- Filled in by SysTools
626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647
  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
648 649 650 651 652 653 654 655 656 657 658 659
  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

660 661
 }

662 663 664
targetPlatform :: DynFlags -> Platform
targetPlatform dflags = sTargetPlatform (settings dflags)

665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704
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)
705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722
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)
723

724 725 726
wayNames :: DynFlags -> [WayName]
wayNames = map wayName . ways

727 728
-- | The target code type of the compilation (if any).
--
729 730 731
-- Whenever you change the target, also make sure to set 'ghcLink' to
-- something sensible.
--
732 733 734 735
-- 'HscNothing' can be used to avoid generating any output, however, note
-- that:
--
--  * This will not run the desugaring step, thus no warnings generated in
736 737 738
--    this step will be output.  In particular, this includes warnings related
--    to pattern matching.  You can run the desugarer manually using
--    'GHC.desugarModule'.
739
--
740 741 742 743
--  * 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
SimonHengel's avatar
SimonHengel committed
744
--    different target or avoid typechecking such modules.  (The latter may be
745
--    preferable for security reasons.)
746
--
747
data HscTarget
748 749
  = HscC           -- ^ Generate C code.
  | HscAsm         -- ^ Generate assembly using the native code generator.
750
  | HscLlvm        -- ^ Generate assembly using the llvm code generator.
751 752
  | HscInterpreted -- ^ Generate bytecode.  (Requires 'LinkInMemory')
  | HscNothing     -- ^ Don't generate any code.  See notes above.
753 754
  deriving (Eq, Show)

Ian Lynagh's avatar
Ian Lynagh committed
755 756 757 758 759 760 761
showHscTargetFlag :: HscTarget -> String
showHscTargetFlag HscC           = "-fvia-c"
showHscTargetFlag HscAsm         = "-fasm"
showHscTargetFlag HscLlvm        = "-fllvm"
showHscTargetFlag HscInterpreted = "-fbyte-code"
showHscTargetFlag HscNothing     = "-fno-code"

762
-- | Will this target result in an object file on the disk?
763 764 765
isObjectTarget :: HscTarget -> Bool
isObjectTarget HscC     = True
isObjectTarget HscAsm   = True
766
isObjectTarget HscLlvm  = True
767 768
isObjectTarget _        = False

769 770 771 772 773 774 775 776 777 778 779
-- | 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

780 781 782 783 784 785
-- | 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.
786
data GhcMode
787 788 789
  = CompManager         -- ^ @\-\-make@, GHCi, etc.
  | OneShot             -- ^ @ghc -c Foo.hs@
  | MkDepend            -- ^ @ghc -M@, see "Finder" for why we need this
790 791
  deriving Eq

792 793 794 795 796
instance Outputable GhcMode where
  ppr CompManager = ptext (sLit "CompManager")
  ppr OneShot     = ptext (sLit "OneShot")
  ppr MkDepend    = ptext (sLit "MkDepend")

797 798 799 800
isOneShot :: GhcMode -> Bool
isOneShot OneShot = True
isOneShot _other  = False

801 802 803 804
-- | 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
805 806
  | LinkInMemory        -- ^ Use the in-memory dynamic linker (works for both
                        --   bytecode and object code).
807
  | LinkDynLib          -- ^ Link objects into a dynamic lib (DLL on Windows, DSO on ELF platforms)
808
  deriving (Eq, Show)
809 810 811

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

814 815 816
-- Is it worth evaluating this Bool and caching it in the DynFlags value
-- during initDynFlags?
doingTickyProfiling :: DynFlags -> Bool
817 818 819
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.
820

821
data PackageFlag
822
  = ExposePackage   String
823
  | ExposePackageId String
824 825 826 827
  | HidePackage     String
  | IgnorePackage   String
  | TrustPackage    String
  | DistrustPackage String
828
  deriving Eq
829

twanvl's avatar
twanvl committed
830
defaultHscTarget :: HscTarget
831 832
defaultHscTarget = defaultObjectTarget

833
-- | The 'HscTarget' value corresponding to the default way to create
834
-- object files on the current platform.
twanvl's avatar
twanvl committed
835
defaultObjectTarget :: HscTarget
836
defaultObjectTarget
837
  | cGhcUnregisterised    == "YES"      =  HscC
Ian Lynagh's avatar
Ian Lynagh committed
838
  | cGhcWithNativeCodeGen == "YES"      =  HscAsm
839
  | otherwise                           =  HscLlvm
840

841 842 843 844 845
data DynLibLoader
  = Deployable
  | SystemDependent
  deriving Eq

Ian Lynagh's avatar
Ian Lynagh committed
846
data RtsOptsEnabled = RtsOptsNone | RtsOptsSafeOnly | RtsOptsAll
847
  deriving (Show)
Ian Lynagh's avatar
Ian Lynagh committed
848

849
-- | Used by 'GHC.newSession' to partially initialize a new 'DynFlags' value
twanvl's avatar
twanvl committed
850
initDynFlags :: DynFlags -> IO DynFlags
851 852 853
initDynFlags dflags = do
 -- someday these will be dynamic flags
 ways <- readIORef v_Ways
854
 refFilesToClean <- newIORef []
855
 refDirsToClean <- newIORef Map.empty
856
 refGeneratedDumps <- newIORef Set.empty
857
 refLlvmVersion <- newIORef 28
858
 return dflags{
859 860 861 862 863 864 865
        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
866
        }
867

868 869
-- | The normal 'DynFlags'. Note that they is not suitable for use in this form
-- and must be fully initialized by 'GHC.newSession' first.
870 871
defaultDynFlags :: Settings -> DynFlags
defaultDynFlags mySettings =
872
     DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
873 874 875 876 877 878 879
        ghcMode                 = CompManager,
        ghcLink                 = LinkBinary,
        hscTarget               = defaultHscTarget,
        hscOutName              = "",
        extCoreName             = "",
        verbosity               = 0,
        optLevel                = 0,
880
        simplPhases             = 2,
Ian Lynagh's avatar
Ian Lynagh committed
881
        maxSimplIterations      = 4,
882
        shouldDumpSimplPhase    = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
883
        ruleCheck               = Nothing,
dterei's avatar
dterei committed
884
        simplTickFactor         = 100,
885
        specConstrThreshold     = Just 2000,
Ian Lynagh's avatar
Ian Lynagh committed
886
        specConstrCount         = Just 3,
887
        liberateCaseThreshold   = Just 2000,
888
        floatLamArgs            = Just 0, -- Default: float only if no fvs
889 890
        strictnessBefore        = [],

Ian Lynagh's avatar
Ian Lynagh committed
891 892 893 894 895 896 897 898 899
        cmdlineHcIncludes       = [],
        importPaths             = ["."],
        mainModIs               = mAIN,
        mainFunIs               = Nothing,
        ctxtStkDepth            = mAX_CONTEXT_REDUCTION_DEPTH,

        thisPackage