DynFlags.hs 110 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(..),
Ian Lynagh's avatar
Ian Lynagh committed
41
        Option(..), showOpt,
Ian Lynagh's avatar
Ian Lynagh committed
42
        DynLibLoader(..),
43
        fFlags, fWarningFlags, fLangFlags, xFlags,
44
        wayNames, dynFlagDependencies,
45

46
        -- ** Safe Haskell
47
        SafeHaskellMode(..),
48
        safeHaskellOn, safeImportsOn, safeLanguageOn, safeInferOn,
49
        packageTrustOn,
50
        safeDirectImpsReq, safeImplicitImpsReq,
51

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


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

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

77
        -- ** Parsing DynFlags
78 79
        parseDynamicFlagsCmdLine,
        parseDynamicFilePragma,
80
        allFlags,
81

82
        supportedLanguagesAndExtensions,
83 84

        -- ** DynFlag C compiler options
85
        picCCOpts,
86 87 88 89 90 91

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

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

#include "HsVersions.h"

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

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

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

138 139 140
import Data.IntSet (IntSet)
import qualified Data.IntSet as IntSet

141 142 143
-- -----------------------------------------------------------------------------
-- DynFlags

144
-- | Enumerates the simple on-or-off dynamic flags
145 146 147 148
data DynFlag

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

Ian Lynagh's avatar
Ian Lynagh committed
234
   | Opt_WarnIsError                    -- -Werror; makes warnings fatal
235

236 237
   | Opt_PrintExplicitForalls

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

262 263 264 265 266
   -- Interface files
   | Opt_IgnoreInterfacePragmas
   | Opt_OmitInterfacePragmas
   | Opt_ExposeAllUnfoldings

Ian Lynagh's avatar
Ian Lynagh committed
267 268
   -- profiling opts
   | Opt_AutoSccsOnIndividualCafs
269
   | Opt_ProfCountEntries
Ian Lynagh's avatar
Ian Lynagh committed
270

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

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

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

316
   -- safe haskell flags
dterei's avatar
dterei committed
317
   | Opt_DistrustAllPackages
318 319
   | Opt_PackageTrust

320
   deriving (Eq, Show, Enum)
Ian Lynagh's avatar
Ian Lynagh committed
321

322 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
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
355 356
   | Opt_WarnUnsafe
   | Opt_WarnSafe
Ian Lynagh's avatar
Ian Lynagh committed
357
   | Opt_WarnPointlessPragmas
358
   deriving (Eq, Show, Enum)
359

360
data Language = Haskell98 | Haskell2010
361
   deriving Enum
362

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

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

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

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

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

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

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

494
  thisPackage           :: PackageId,   -- ^ name of package currently being compiled
495 496

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

501 502 503
  -- For object splitting
  splitInfo             :: Maybe (String,Int),

504
  -- paths etc.
Ian Lynagh's avatar
Ian Lynagh committed
505
  objectDir             :: Maybe String,
506
  dylibInstallName      :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
507 508
  hiDir                 :: Maybe String,
  stubDir               :: Maybe String,
509
  dumpDir               :: Maybe String,
510

Ian Lynagh's avatar
Ian Lynagh committed
511 512 513
  objectSuf             :: String,
  hcSuf                 :: String,
  hiSuf                 :: String,
514

Ian Lynagh's avatar
Ian Lynagh committed
515 516 517
  outputFile            :: Maybe String,
  outputHi              :: Maybe String,
  dynLibLoader          :: DynLibLoader,
518

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

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

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

532
  rtsOpts               :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
533
  rtsOptsEnabled        :: RtsOptsEnabled,
534

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

537 538 539 540
  -- Plugins
  pluginModNames        :: [ModuleName],
  pluginModNameOpts     :: [(ModuleName,String)],

541 542 543 544 545 546
  --  For ghc -M
  depMakefile           :: FilePath,
  depIncludePkgDeps     :: Bool,
  depExcludeMods        :: [ModuleName],
  depSuffixes           :: [String],

547
  --  Package flags
Ian Lynagh's avatar
Ian Lynagh committed
548
  extraPkgConfs         :: [FilePath],
549
        -- ^ The @-package-conf@ flags given on the command line, in the order
Ian Lynagh's avatar
Ian Lynagh committed
550
        -- they appeared.
551

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

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

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

567 568 569 570 571
  -- 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),

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

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

598 599 600
  haddockOptions        :: Maybe String,

  -- | what kind of {-# SCC #-} to add automatically
601 602 603
  profAuto              :: ProfAuto,

  llvmVersion           :: IORef (Int)
604 605
 }

606 607 608
class HasDynFlags m where
    getDynFlags :: m DynFlags

Ian Lynagh's avatar
Ian Lynagh committed
609 610 611
class ContainsDynFlags t where
    extractDynFlags :: t -> DynFlags

612 613 614 615 616
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
617
  | ProfAutoCalls      -- ^ annotate call-sites
Simon Marlow's avatar
Simon Marlow committed
618
  deriving (Enum)
619

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

656 657
 }

658 659 660
targetPlatform :: DynFlags -> Platform
targetPlatform dflags = sTargetPlatform (settings dflags)

661 662 663 664 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
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)
701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718
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)
719

720 721 722
wayNames :: DynFlags -> [WayName]
wayNames = map wayName . ways

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

Ian Lynagh's avatar
Ian Lynagh committed
751 752 753 754 755 756 757
showHscTargetFlag :: HscTarget -> String
showHscTargetFlag HscC           = "-fvia-c"
showHscTargetFlag HscAsm         = "-fasm"
showHscTargetFlag HscLlvm        = "-fllvm"
showHscTargetFlag HscInterpreted = "-fbyte-code"
showHscTargetFlag HscNothing     = "-fno-code"

758
-- | Will this target result in an object file on the disk?
759 760 761
isObjectTarget :: HscTarget -> Bool
isObjectTarget HscC     = True
isObjectTarget HscAsm   = True
762
isObjectTarget HscLlvm  = True
763 764
isObjectTarget _        = False

765 766 767 768 769 770 771 772 773 774 775
-- | 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

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

788 789 790 791 792
instance Outputable GhcMode where
  ppr CompManager = ptext (sLit "CompManager")
  ppr OneShot     = ptext (sLit "OneShot")
  ppr MkDepend    = ptext (sLit "MkDepend")

793 794 795 796
isOneShot :: GhcMode -> Bool
isOneShot OneShot = True
isOneShot _other  = False

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

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

810 811 812
-- Is it worth evaluating this Bool and caching it in the DynFlags value
-- during initDynFlags?
doingTickyProfiling :: DynFlags -> Bool
813 814 815
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.
816

817
data PackageFlag
818
  = ExposePackage   String
819
  | ExposePackageId String
820 821 822 823
  | HidePackage     String
  | IgnorePackage   String
  | TrustPackage    String
  | DistrustPackage String
824
  deriving Eq
825

twanvl's avatar
twanvl committed
826
defaultHscTarget :: HscTarget
827 828
defaultHscTarget = defaultObjectTarget

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

837 838 839 840 841
data DynLibLoader
  = Deployable
  | SystemDependent
  deriving Eq

Ian Lynagh's avatar
Ian Lynagh committed
842
data RtsOptsEnabled = RtsOptsNone | RtsOptsSafeOnly | RtsOptsAll
843
  deriving (Show)
Ian Lynagh's avatar
Ian Lynagh committed
844

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

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

Ian Lynagh's avatar
Ian Lynagh committed
887 888 889 890 891 892 893 894 895
        cmdlineHcIncludes       = [],
        importPaths             = ["."],
        mainModIs               = mAIN,
        mainFunIs               = Nothing,
        ctxtStkDepth            = mAX_CONTEXT_REDUCTION_DEPTH,

        thisPackage             = mainPackageId,

        objectDir               = Nothing,
896
        dylibInstallName        = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
897 898
        hiDir                   = Nothing,
        stubDir                 = Nothing,
899
        dumpDir                 = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
900 901 902 903 904

        objectSuf               = phaseInputExt StopLn,