DynFlags.hs 107 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
        LogAction,
20
        ProfAuto(..),
21
        glasgowExtsFlags,
22 23 24
        dopt,
        dopt_set,
        dopt_unset,
25 26 27
        wopt,
        wopt_set,
        wopt_unset,
28 29 30
        xopt,
        xopt_set,
        xopt_unset,
Ian Lynagh's avatar
Ian Lynagh committed
31
        DynFlags(..),
Ian Lynagh's avatar
Ian Lynagh committed
32
        RtsOptsEnabled(..),
Ian Lynagh's avatar
Ian Lynagh committed
33 34 35 36
        HscTarget(..), isObjectTarget, defaultObjectTarget,
        GhcMode(..), isOneShot,
        GhcLink(..), isNoLink,
        PackageFlag(..),
Ian Lynagh's avatar
Ian Lynagh committed
37
        Option(..), showOpt,
Ian Lynagh's avatar
Ian Lynagh committed
38
        DynLibLoader(..),
39
        fFlags, fWarningFlags, fLangFlags, xFlags,
40
        wayNames, dynFlagDependencies,
41

42
        -- ** Safe Haskell
43
        SafeHaskellMode(..),
44
        safeHaskellOn, safeImportsOn, safeLanguageOn, safeInferOn,
45
        packageTrustOn,
46
        safeDirectImpsReq, safeImplicitImpsReq,
47

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


59
        -- ** Manipulating DynFlags
60
        defaultDynFlags,                -- Settings -> DynFlags
Ian Lynagh's avatar
Ian Lynagh committed
61
        initDynFlags,                   -- DynFlags -> IO DynFlags
62
        defaultLogAction,
Ian Lynagh's avatar
Ian Lynagh committed
63

64
        getOpts,                        -- DynFlags -> (DynFlags -> [a]) -> [a]
65
        getVerbFlags,
Ian Lynagh's avatar
Ian Lynagh committed
66 67 68
        updOptLevel,
        setTmpDir,
        setPackageName,
69
        doingTickyProfiling,
Ian Lynagh's avatar
Ian Lynagh committed
70

71
        -- ** Parsing DynFlags
72 73
        parseDynamicFlagsCmdLine,
        parseDynamicFilePragma,
74
        allFlags,
75

76
        supportedLanguagesAndExtensions,
77 78

        -- ** DynFlag C compiler options
79
        picCCOpts,
80 81 82 83 84 85

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

        -- * Compiler configuration suitable for display to the user
86 87
        compilerInfo
#ifdef GHCI
dterei's avatar
dterei committed
88
-- Only in stage 2 can we be sure that the RTS
89
-- exposes the appropriate runtime boolean
dterei's avatar
dterei committed
90
      , rtsIsProfiled
91
#endif
92 93 94 95
  ) where

#include "HsVersions.h"

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

Ian Lynagh's avatar
Ian Lynagh committed
117
#ifdef GHCI
118
import System.IO.Unsafe ( unsafePerformIO )
Ian Lynagh's avatar
Ian Lynagh committed
119
#endif
120
import Data.IORef
Ian Lynagh's avatar
Ian Lynagh committed
121
import Control.Monad    ( when )
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
122

123
import Data.Char
124
import Data.List
125 126
import Data.Map (Map)
import qualified Data.Map as Map
127 128
import Data.Set (Set)
import qualified Data.Set as Set
Ian Lynagh's avatar
Ian Lynagh committed
129
import System.FilePath
130
import System.IO        ( stderr, hPutChar )
131

132 133 134
import Data.IntSet (IntSet)
import qualified Data.IntSet as IntSet

135 136 137
-- -----------------------------------------------------------------------------
-- DynFlags

138
-- | Enumerates the simple on-or-off dynamic flags
139 140 141 142
data DynFlag

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

Ian Lynagh's avatar
Ian Lynagh committed
228
   | Opt_WarnIsError                    -- -Werror; makes warnings fatal
229

230 231
   | Opt_PrintExplicitForalls

232 233 234
   -- optimisation opts
   | Opt_Strictness
   | Opt_FullLaziness
235 236
   | Opt_FloatIn
   | Opt_Specialise
237
   | Opt_StaticArgumentTransformation
238
   | Opt_CSE
239 240
   | Opt_LiberateCase
   | Opt_SpecConstr
241 242 243 244 245
   | Opt_DoLambdaEtaExpansion
   | Opt_IgnoreAsserts
   | Opt_DoEtaReduction
   | Opt_CaseMerge
   | Opt_UnboxStrictFields
246
   | Opt_DictsCheap
247
   | Opt_EnableRewriteRules             -- Apply rewrite rules during simplification
rl@cse.unsw.edu.au's avatar
rl@cse.unsw.edu.au committed
248
   | Opt_Vectorise
Ian Lynagh's avatar
Ian Lynagh committed
249 250
   | Opt_RegsGraph                      -- do graph coloring register allocation
   | Opt_RegsIterative                  -- do iterative coalescing graph coloring register allocation
251
   | Opt_PedanticBottoms                -- Be picky about how we treat bottom
252

253 254 255 256 257
   -- Interface files
   | Opt_IgnoreInterfacePragmas
   | Opt_OmitInterfacePragmas
   | Opt_ExposeAllUnfoldings

Ian Lynagh's avatar
Ian Lynagh committed
258 259
   -- profiling opts
   | Opt_AutoSccsOnIndividualCafs
260
   | Opt_ProfCountEntries
Ian Lynagh's avatar
Ian Lynagh committed
261

262 263
   -- misc opts
   | Opt_Pp
264
   | Opt_ForceRecomp
265
   | Opt_ExcessPrecision
266
   | Opt_EagerBlackHoling
267 268 269 270
   | Opt_ReadUserPackageConf
   | Opt_NoHsMain
   | Opt_SplitObjs
   | Opt_StgStats
271
   | Opt_HideAllPackages
272
   | Opt_PrintBindResult
273
   | Opt_Haddock
David Waern's avatar
David Waern committed
274
   | Opt_HaddockOptions
275
   | Opt_Hpc_No_Auto
276
   | Opt_BreakOnException
277
   | Opt_BreakOnError
278
   | Opt_PrintEvldWithShow
279
   | Opt_PrintBindContents
280 281
   | Opt_GenManifest
   | Opt_EmbedManifest
282
   | Opt_EmitExternalCore
Ian Lynagh's avatar
Ian Lynagh committed
283
   | Opt_SharedImplib
284
   | Opt_BuildingCabalPackage
285
   | Opt_SSE2
tibbe's avatar
tibbe committed
286
   | Opt_SSE4_2
287
   | Opt_GhciSandbox
Ian Lynagh's avatar
Ian Lynagh committed
288
   | Opt_GhciHistory
289
   | Opt_HelpfulErrors
290

291
   -- temporary flags
292
   | Opt_RunCPS
293
   | Opt_RunCPSZ
294
   | Opt_AutoLinkPackages
295
   | Opt_ImplicitImportQualified
296
   | Opt_TryNewCodeGen
297 298 299 300 301 302

   -- keeping stuff
   | Opt_KeepHiDiffs
   | Opt_KeepHcFiles
   | Opt_KeepSFiles
   | Opt_KeepTmpFiles
Jedai's avatar
Jedai committed
303
   | Opt_KeepRawTokenStream
304
   | Opt_KeepLlvmFiles
305

306
   -- safe haskell flags
dterei's avatar
dterei committed
307
   | Opt_DistrustAllPackages
308 309
   | Opt_PackageTrust

310
   deriving (Eq, Show, Enum)
Ian Lynagh's avatar
Ian Lynagh committed
311

312 313 314 315 316 317 318 319 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
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
345 346
   | Opt_WarnUnsafe
   | Opt_WarnSafe
347
   deriving (Eq, Show, Enum)
348

349
data Language = Haskell98 | Haskell2010
350
   deriving Enum
351

352
-- | The various Safe Haskell modes
353 354
data SafeHaskellMode
   = Sf_None
dterei's avatar
dterei committed
355
   | Sf_Unsafe
356 357
   | Sf_Trustworthy
   | Sf_Safe
dterei's avatar
dterei committed
358
   | Sf_SafeInfered
359 360
   deriving (Eq)

361
instance Outputable SafeHaskellMode where
dterei's avatar
dterei committed
362 363
    ppr Sf_None        = ptext $ sLit "None"
    ppr Sf_Unsafe      = ptext $ sLit "Unsafe"
364
    ppr Sf_Trustworthy = ptext $ sLit "Trustworthy"
dterei's avatar
dterei committed
365 366
    ppr Sf_Safe        = ptext $ sLit "Safe"
    ppr Sf_SafeInfered = ptext $ sLit "Safe-Infered"
367

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

   | 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
429
   | Opt_MonadComprehensions
430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445
   | 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
446
   | Opt_NondecreasingIndentation
447
   | Opt_RelaxedLayout
448
   | Opt_TraditionalRecordSyntax
449
   deriving (Eq, Enum, Show)
450

451 452
-- | 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
453
data DynFlags = DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
454 455 456
  ghcMode               :: GhcMode,
  ghcLink               :: GhcLink,
  hscTarget             :: HscTarget,
457
  settings              :: Settings,
458
  hscOutName            :: String,      -- ^ Name of the output file
459
  extCoreName           :: String,      -- ^ Name of the .hcr output file
460
  verbosity             :: Int,         -- ^ Verbosity level: see Note [Verbosity levels]
461 462 463
  optLevel              :: Int,         -- ^ Optimisation level
  simplPhases           :: Int,         -- ^ Number of simplifier phases
  maxSimplIterations    :: Int,         -- ^ Max simplifier iterations
464
  shouldDumpSimplPhase  :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
465
  ruleCheck             :: Maybe String,
466
  strictnessBefore      :: [Int],       -- ^ Additional demand analysis
467

468
  simplTickFactor       :: Int,         -- ^ Multiplier for simplifier ticks
469 470 471
  specConstrThreshold   :: Maybe Int,   -- ^ Threshold for SpecConstr
  specConstrCount       :: Maybe Int,   -- ^ Max number of specialisations for any one function
  liberateCaseThreshold :: Maybe Int,   -- ^ Threshold for LiberateCase
472
  floatLamArgs          :: Maybe Int,   -- ^ Arg count for lambda floating
473
                                        --   See CoreMonad.FloatOutSwitches
474

475
  cmdlineHcIncludes     :: [String],    -- ^ @\-\#includes@
Ian Lynagh's avatar
Ian Lynagh committed
476 477 478
  importPaths           :: [FilePath],
  mainModIs             :: Module,
  mainFunIs             :: Maybe String,
479
  ctxtStkDepth          :: Int,         -- ^ Typechecker context stack depth
480

481
  thisPackage           :: PackageId,   -- ^ name of package currently being compiled
482 483

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

488 489 490
  -- For object splitting
  splitInfo             :: Maybe (String,Int),

491
  -- paths etc.
Ian Lynagh's avatar
Ian Lynagh committed
492
  objectDir             :: Maybe String,
493
  dylibInstallName      :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
494 495
  hiDir                 :: Maybe String,
  stubDir               :: Maybe String,
496
  dumpDir               :: Maybe String,
497

Ian Lynagh's avatar
Ian Lynagh committed
498 499 500
  objectSuf             :: String,
  hcSuf                 :: String,
  hiSuf                 :: String,
501

Ian Lynagh's avatar
Ian Lynagh committed
502 503 504
  outputFile            :: Maybe String,
  outputHi              :: Maybe String,
  dynLibLoader          :: DynLibLoader,
505

506
  -- | This is set by 'DriverPipeline.runPipeline' based on where
Ian Lynagh's avatar
Ian Lynagh committed
507 508
  --    its output is going.
  dumpPrefix            :: Maybe FilePath,
509

510 511
  -- | Override the 'dumpPrefix' set by 'DriverPipeline.runPipeline'.
  --    Set by @-ddump-file-prefix@
Ian Lynagh's avatar
Ian Lynagh committed
512 513 514 515 516 517 518
  dumpPrefixForce       :: Maybe FilePath,

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

519
  rtsOpts               :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
520
  rtsOptsEnabled        :: RtsOptsEnabled,
521

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

524 525 526 527
  -- Plugins
  pluginModNames        :: [ModuleName],
  pluginModNameOpts     :: [(ModuleName,String)],

528 529 530 531 532 533
  --  For ghc -M
  depMakefile           :: FilePath,
  depIncludePkgDeps     :: Bool,
  depExcludeMods        :: [ModuleName],
  depSuffixes           :: [String],

534
  --  Package flags
Ian Lynagh's avatar
Ian Lynagh committed
535
  extraPkgConfs         :: [FilePath],
536
        -- ^ The @-package-conf@ flags given on the command line, in the order
Ian Lynagh's avatar
Ian Lynagh committed
537
        -- they appeared.
538

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

542
  -- Package state
Ian Lynagh's avatar
Ian Lynagh committed
543
  -- NB. do not modify this field, it is calculated by
544
  -- Packages.initPackages and Packages.updatePackages.
545
  pkgDatabase           :: Maybe [PackageConfig],
Ian Lynagh's avatar
Ian Lynagh committed
546
  pkgState              :: PackageState,
547

548 549 550 551
  -- Temporary files
  -- These have to be IORefs, because the defaultCleanupHandler needs to
  -- know what to clean when an exception happens
  filesToClean          :: IORef [FilePath],
552
  dirsToClean           :: IORef (Map FilePath FilePath),
553

554 555 556 557 558
  -- 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),

559
  -- hsc dynamic flags
560 561
  flags                 :: IntSet,
  warningFlags          :: IntSet,
562
  -- Don't change this without updating extensionFlags:
563
  language              :: Maybe Language,
564 565
  -- | Safe Haskell mode
  safeHaskell           :: SafeHaskellMode,
566 567 568 569 570
  -- We store the location of where template haskell and newtype deriving were
  -- turned on so we can produce accurate error messages when Safe Haskell turns
  -- them off.
  thOnLoc               :: SrcSpan,
  newDerivOnLoc         :: SrcSpan,
571 572
  warnSafeOnLoc         :: SrcSpan,
  warnUnsafeOnLoc       :: SrcSpan,
573 574 575 576
  -- Don't change this without updating extensionFlags:
  extensions            :: [OnOff ExtensionFlag],
  -- extensionFlags should always be equal to
  --     flattenExtensionFlags language extensions
577
  extensionFlags        :: IntSet,
Ian Lynagh's avatar
Ian Lynagh committed
578

579
  -- | Message output action: use "ErrUtils" instead of this if you can
580
  log_action            :: LogAction,
David Waern's avatar
David Waern committed
581

582 583 584 585
  haddockOptions        :: Maybe String,

  -- | what kind of {-# SCC #-} to add automatically
  profAuto              :: ProfAuto
586 587
 }

588 589 590 591 592
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
593
  | ProfAutoCalls      -- ^ annotate call-sites
Simon Marlow's avatar
Simon Marlow committed
594
  deriving (Enum)
595

596
data Settings = Settings {
597
  sTargetPlatform        :: Platform,    -- Filled in by SysTools
598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619
  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
620 621 622 623 624 625 626 627 628 629 630 631
  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

632 633
 }

634 635 636
targetPlatform :: DynFlags -> Platform
targetPlatform dflags = sTargetPlatform (settings dflags)

637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676
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)
677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694
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)
695

696 697 698
wayNames :: DynFlags -> [WayName]
wayNames = map wayName . ways

699 700
-- | The target code type of the compilation (if any).
--
701 702 703
-- Whenever you change the target, also make sure to set 'ghcLink' to
-- something sensible.
--
704 705 706 707
-- 'HscNothing' can be used to avoid generating any output, however, note
-- that:
--
--  * This will not run the desugaring step, thus no warnings generated in
708 709 710
--    this step will be output.  In particular, this includes warnings related
--    to pattern matching.  You can run the desugarer manually using
--    'GHC.desugarModule'.
711
--
712 713 714 715 716 717
--  * If a program uses Template Haskell the typechecker may try to run code
--    from an imported module.  This will fail if no code has been generated
--    for this module.  You can use 'GHC.needsTemplateHaskell' to detect
--    whether this might be the case and choose to either switch to a
--    different target or avoid typechecking such modules.  (The latter may
--    preferable for security reasons.)
718
--
719
data HscTarget
720 721
  = HscC           -- ^ Generate C code.
  | HscAsm         -- ^ Generate assembly using the native code generator.
722
  | HscLlvm        -- ^ Generate assembly using the llvm code generator.
723 724
  | HscInterpreted -- ^ Generate bytecode.  (Requires 'LinkInMemory')
  | HscNothing     -- ^ Don't generate any code.  See notes above.
725 726
  deriving (Eq, Show)

Ian Lynagh's avatar
Ian Lynagh committed
727 728 729 730 731 732 733
showHscTargetFlag :: HscTarget -> String
showHscTargetFlag HscC           = "-fvia-c"
showHscTargetFlag HscAsm         = "-fasm"
showHscTargetFlag HscLlvm        = "-fllvm"
showHscTargetFlag HscInterpreted = "-fbyte-code"
showHscTargetFlag HscNothing     = "-fno-code"

734
-- | Will this target result in an object file on the disk?
735 736 737
isObjectTarget :: HscTarget -> Bool
isObjectTarget HscC     = True
isObjectTarget HscAsm   = True
738
isObjectTarget HscLlvm  = True
739 740 741 742 743 744 745 746
isObjectTarget _        = False

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

753 754 755 756 757
instance Outputable GhcMode where
  ppr CompManager = ptext (sLit "CompManager")
  ppr OneShot     = ptext (sLit "OneShot")
  ppr MkDepend    = ptext (sLit "MkDepend")

758 759 760 761
isOneShot :: GhcMode -> Bool
isOneShot OneShot = True
isOneShot _other  = False

762 763 764 765
-- | 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
766 767
  | LinkInMemory        -- ^ Use the in-memory dynamic linker (works for both
                        --   bytecode and object code).
768
  | LinkDynLib          -- ^ Link objects into a dynamic lib (DLL on Windows, DSO on ELF platforms)
769
  deriving (Eq, Show)
770 771 772

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

775 776 777
-- Is it worth evaluating this Bool and caching it in the DynFlags value
-- during initDynFlags?
doingTickyProfiling :: DynFlags -> Bool
778 779 780
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.
781

782
data PackageFlag
783
  = ExposePackage   String
784
  | ExposePackageId String
785 786 787 788
  | HidePackage     String
  | IgnorePackage   String
  | TrustPackage    String
  | DistrustPackage String
789
  deriving Eq
790

twanvl's avatar
twanvl committed
791
defaultHscTarget :: HscTarget
792 793
defaultHscTarget = defaultObjectTarget

794
-- | The 'HscTarget' value corresponding to the default way to create
795
-- object files on the current platform.
twanvl's avatar
twanvl committed
796
defaultObjectTarget :: HscTarget
797
defaultObjectTarget
798
  | cGhcUnregisterised    == "YES"      =  HscC
Ian Lynagh's avatar
Ian Lynagh committed
799
  | cGhcWithNativeCodeGen == "YES"      =  HscAsm
800
  | otherwise                           =  HscLlvm
801

802 803 804 805 806
data DynLibLoader
  = Deployable
  | SystemDependent
  deriving Eq

Ian Lynagh's avatar
Ian Lynagh committed
807
data RtsOptsEnabled = RtsOptsNone | RtsOptsSafeOnly | RtsOptsAll
808
  deriving (Show)
Ian Lynagh's avatar
Ian Lynagh committed
809

810
-- | Used by 'GHC.newSession' to partially initialize a new 'DynFlags' value
twanvl's avatar
twanvl committed
811
initDynFlags :: DynFlags -> IO DynFlags
812 813 814
initDynFlags dflags = do
 -- someday these will be dynamic flags
 ways <- readIORef v_Ways
815
 refFilesToClean <- newIORef []
816
 refDirsToClean <- newIORef Map.empty
817
 refGeneratedDumps <- newIORef Set.empty
818
 return dflags{
819 820 821
        ways            = ways,
        buildTag        = mkBuildTag (filter (not . wayRTSOnly) ways),
        rtsBuildTag     = mkBuildTag ways,
822
        filesToClean    = refFilesToClean,
823 824
        dirsToClean     = refDirsToClean,
        generatedDumps   = refGeneratedDumps
Ian Lynagh's avatar
Ian Lynagh committed
825
        }
826

827 828
-- | The normal 'DynFlags'. Note that they is not suitable for use in this form
-- and must be fully initialized by 'GHC.newSession' first.
829 830
defaultDynFlags :: Settings -> DynFlags
defaultDynFlags mySettings =
831
     DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
832 833 834 835 836 837 838
        ghcMode                 = CompManager,
        ghcLink                 = LinkBinary,
        hscTarget               = defaultHscTarget,
        hscOutName              = "",
        extCoreName             = "",
        verbosity               = 0,
        optLevel                = 0,
839
        simplPhases             = 2,
Ian Lynagh's avatar
Ian Lynagh committed
840
        maxSimplIterations      = 4,
841
        shouldDumpSimplPhase    = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
842
        ruleCheck               = Nothing,
dterei's avatar
dterei committed
843
        simplTickFactor         = 100,
844
        specConstrThreshold     = Just 2000,
Ian Lynagh's avatar
Ian Lynagh committed
845
        specConstrCount         = Just 3,
846
        liberateCaseThreshold   = Just 2000,