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
Ian Lynagh's avatar
Ian Lynagh committed
255 256
   | Opt_RegsGraph                      -- do graph coloring register allocation
   | Opt_RegsIterative                  -- do iterative coalescing graph coloring register allocation
257
   | Opt_PedanticBottoms                -- Be picky about how we treat bottom
258
   | Opt_LlvmTBAA                       -- Use LLVM TBAA infastructure for improving AA
259
   | Opt_RegLiveness                    -- Use the STG Reg liveness information
260

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

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

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

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

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

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

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

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

359
data Language = Haskell98 | Haskell2010
360
   deriving Enum
361

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

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

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

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

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

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

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

492
  thisPackage           :: PackageId,   -- ^ name of package currently being compiled
493 494

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

499 500 501
  -- For object splitting
  splitInfo             :: Maybe (String,Int),

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

Ian Lynagh's avatar
Ian Lynagh committed
509 510 511
  objectSuf             :: String,
  hcSuf                 :: String,
  hiSuf                 :: String,
512

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

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

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

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

530
  rtsOpts               :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
531
  rtsOptsEnabled        :: RtsOptsEnabled,
532

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

535 536 537 538
  -- Plugins
  pluginModNames        :: [ModuleName],
  pluginModNameOpts     :: [(ModuleName,String)],

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

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

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

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

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

565 566 567 568 569
  -- 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),

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

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

596 597 598
  haddockOptions        :: Maybe String,

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

  llvmVersion           :: IORef (Int)
602 603
 }

604 605 606
class HasDynFlags m where
    getDynFlags :: m DynFlags

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

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

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

654 655
 }

656 657 658
targetPlatform :: DynFlags -> Platform
targetPlatform dflags = sTargetPlatform (settings dflags)

659 660 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
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)
699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716
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)
717

718 719 720
wayNames :: DynFlags -> [WayName]
wayNames = map wayName . ways

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

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

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

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

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

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

791 792 793 794
isOneShot :: GhcMode -> Bool
isOneShot OneShot = True
isOneShot _other  = False

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

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

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

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

twanvl's avatar
twanvl committed
824
defaultHscTarget :: HscTarget
825 826
defaultHscTarget = defaultObjectTarget

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

835 836 837 838 839
data DynLibLoader
  = Deployable
  | SystemDependent
  deriving Eq

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

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

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

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

        thisPackage             = mainPackageId,

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

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

903 904 905
        pluginModNames          = [],
        pluginModNameOpts       = [],

Ian Lynagh's avatar
Ian Lynagh committed
906 907
        outputFile              = Nothing,