DynFlags.hs 149 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 15 16
{-# OPTIONS -fno-cse #-}
-- -fno-cse is needed for GLOBAL_VAR's to behave properly

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

51 52
        printOutputForUser, printInfoForUser,

53
        Way(..), mkBuildTag, wayRTSOnly, addWay', updateWays,
54
        wayGeneralFlags, wayUnsetGeneralFlags,
ian@well-typed.com's avatar
ian@well-typed.com committed
55

56
        -- ** Safe Haskell
57
        SafeHaskellMode(..),
58
        safeHaskellOn, safeImportsOn, safeLanguageOn, safeInferOn,
59
        packageTrustOn,
60
        safeDirectImpsReq, safeImplicitImpsReq,
61
        unsafeFlags,
62

63
        -- ** System tool settings and locations
64
        Settings(..),
65
        targetPlatform,
66 67 68
        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,
69
        pgm_sysman, pgm_windres, pgm_libtool, pgm_lo, pgm_lc,
Ian Lynagh's avatar
Ian Lynagh committed
70
        opt_L, opt_P, opt_F, opt_c, opt_a, opt_l,
71
        opt_windres, opt_lo, opt_lc,
72 73


74
        -- ** Manipulating DynFlags
75
        defaultDynFlags,                -- Settings -> DynFlags
76
        defaultWays,
ian@well-typed.com's avatar
ian@well-typed.com committed
77
        interpWays,
Ian Lynagh's avatar
Ian Lynagh committed
78
        initDynFlags,                   -- DynFlags -> IO DynFlags
Ian Lynagh's avatar
Ian Lynagh committed
79
        defaultFatalMessager,
80
        defaultLogAction,
81
        defaultLogActionHPrintDoc,
82
        defaultLogActionHPutStrDoc,
83 84
        defaultFlushOut,
        defaultFlushErr,
Ian Lynagh's avatar
Ian Lynagh committed
85

86
        getOpts,                        -- DynFlags -> (DynFlags -> [a]) -> [a]
87
        getVerbFlags,
Ian Lynagh's avatar
Ian Lynagh committed
88 89 90 91
        updOptLevel,
        setTmpDir,
        setPackageName,

92
        -- ** Parsing DynFlags
93 94
        parseDynamicFlagsCmdLine,
        parseDynamicFilePragma,
95 96 97
        parseDynamicFlagsFull,

        -- ** Available DynFlags
98
        allFlags,
99 100 101
        flagsAll,
        flagsDynamic,
        flagsPackage,
102

103
        supportedLanguagesAndExtensions,
104
        languageExtensions,
105

106
        -- ** DynFlags C compiler options
Ian Lynagh's avatar
Ian Lynagh committed
107
        picCCOpts, picPOpts,
108 109 110 111 112 113

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

        -- * Compiler configuration suitable for display to the user
114 115
        compilerInfo,

116
#ifdef GHCI
dterei's avatar
dterei committed
117
-- Only in stage 2 can we be sure that the RTS
118
-- exposes the appropriate runtime boolean
119
        rtsIsProfiled,
120
#endif
121 122

#include "../includes/dist-derivedconstants/header/GHCConstantsHaskellExports.hs"
123
        bLOCK_SIZE_W,
124
        wORD_SIZE_IN_BITS,
125 126
        tAG_MASK,
        mAX_PTR_TAG,
127
        tARGET_MIN_INT, tARGET_MAX_INT, tARGET_MAX_WORD,
128

129 130
        unsafeGlobalDynFlags, setUnsafeGlobalDynFlags,

131 132 133
        -- * SSE
        isSse2Enabled,
        isSse4_2Enabled,
134 135 136

        -- * Linker information
        LinkerInfo(..),
137 138 139 140
  ) where

#include "HsVersions.h"

141
import Platform
142
import PlatformConstants
143
import Module
Simon Marlow's avatar
Simon Marlow committed
144
import PackageConfig
145
import {-# SOURCE #-} PrelNames ( mAIN )
146
import {-# SOURCE #-} Packages (PackageState)
Ian Lynagh's avatar
Ian Lynagh committed
147
import DriverPhases     ( Phase(..), phaseInputExt )
148 149
import Config
import CmdLineParser
150
import Constants
151
import Panic
152
import Util
153
import Maybes           ( orElse )
154
import MonadUtils
155
import qualified Pretty
156
import SrcLoc
157
import FastString
Simon Marlow's avatar
Simon Marlow committed
158
import Outputable
Ian Lynagh's avatar
Ian Lynagh committed
159
#ifdef GHCI
Ian Lynagh's avatar
Ian Lynagh committed
160
import Foreign.C        ( CInt(..) )
Ian Lynagh's avatar
Ian Lynagh committed
161
#endif
162
import {-# SOURCE #-} ErrUtils ( Severity(..), MsgDoc, mkLocMessage )
163

164
import System.IO.Unsafe ( unsafePerformIO )
165
import Data.IORef
ian@well-typed.com's avatar
ian@well-typed.com committed
166
import Control.Monad
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
167

168
import Data.Bits
169
import Data.Char
170
import Data.Int
171
import Data.List
172 173
import Data.Map (Map)
import qualified Data.Map as Map
174
import Data.Maybe
175 176
import Data.Set (Set)
import qualified Data.Set as Set
177
import Data.Word
Ian Lynagh's avatar
Ian Lynagh committed
178
import System.FilePath
179
import System.IO
180
import System.IO.Error
181

182 183 184
import Data.IntSet (IntSet)
import qualified Data.IntSet as IntSet

185 186
import GHC.Foreign (withCString, peekCString)

187 188 189
-- -----------------------------------------------------------------------------
-- DynFlags

190
data DumpFlag
191 192 193

   -- debugging flags
   = Opt_D_dump_cmm
194 195 196 197 198 199 200 201 202 203 204 205 206
   | Opt_D_dump_cmm_raw
   -- All of the cmm subflags (there are a lot!)  Automatically
   -- enabled if you run -ddump-cmm
   | Opt_D_dump_cmm_cfg
   | Opt_D_dump_cmm_cbe
   | Opt_D_dump_cmm_proc
   | Opt_D_dump_cmm_rewrite
   | Opt_D_dump_cmm_sp
   | Opt_D_dump_cmm_procmap
   | Opt_D_dump_cmm_split
   | Opt_D_dump_cmm_info
   | Opt_D_dump_cmm_cps
   -- end cmm subflags
207
   | Opt_D_dump_asm
208 209 210 211 212
   | Opt_D_dump_asm_native
   | Opt_D_dump_asm_liveness
   | Opt_D_dump_asm_regalloc
   | Opt_D_dump_asm_regalloc_stages
   | Opt_D_dump_asm_conflicts
213
   | Opt_D_dump_asm_stats
214
   | Opt_D_dump_asm_expanded
215
   | Opt_D_dump_llvm
216
   | Opt_D_dump_core_stats
217 218 219 220
   | Opt_D_dump_deriv
   | Opt_D_dump_ds
   | Opt_D_dump_foreign
   | Opt_D_dump_inlinings
221
   | Opt_D_dump_rule_firings
222
   | Opt_D_dump_rule_rewrites
223
   | Opt_D_dump_simpl_trace
224 225 226
   | Opt_D_dump_occur_anal
   | Opt_D_dump_parsed
   | Opt_D_dump_rn
227
   | Opt_D_dump_core_pipeline -- TODO FIXME: dump after simplifier stats
228 229
   | Opt_D_dump_simpl
   | Opt_D_dump_simpl_iterations
230
   | Opt_D_dump_simpl_phases
231 232 233 234 235 236 237 238 239 240 241 242 243
   | 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
244
   | Opt_D_dump_cs_trace -- Constraint solver in type checker
245 246
   | Opt_D_dump_tc_trace
   | Opt_D_dump_if_trace
247
   | Opt_D_dump_vt_trace
248 249 250
   | Opt_D_dump_splices
   | Opt_D_dump_BCOs
   | Opt_D_dump_vect
251
   | Opt_D_dump_ticked
pepe's avatar
pepe committed
252
   | Opt_D_dump_rtti
253 254 255 256
   | Opt_D_source_stats
   | Opt_D_verbose_stg2stg
   | Opt_D_dump_hi
   | Opt_D_dump_hi_diffs
257
   | Opt_D_dump_mod_cycles
258
   | Opt_D_dump_view_pattern_commoning
259 260 261 262 263 264 265 266
   | Opt_D_verbose_core2core

   deriving (Eq, Show, Enum)

-- | Enumerates the simple on-or-off dynamic flags
data GeneralFlag

   = Opt_DumpToFile                     -- ^ Append dump output to files instead of stdout.
267
   | Opt_D_faststring_stats
268
   | Opt_D_dump_minimal_imports
269 270 271
   | Opt_DoCoreLinting
   | Opt_DoStgLinting
   | Opt_DoCmmLinting
Ben.Lippmeier@anu.edu.au's avatar
Ben.Lippmeier@anu.edu.au committed
272
   | Opt_DoAsmLinting
273
   | Opt_NoLlvmMangler                 -- hidden flag
274

Ian Lynagh's avatar
Ian Lynagh committed
275
   | Opt_WarnIsError                    -- -Werror; makes warnings fatal
276

277 278
   | Opt_PrintExplicitForalls

279 280
   -- optimisation opts
   | Opt_Strictness
281
   | Opt_LateDmdAnal
282 283
   | Opt_KillAbsence
   | Opt_KillOneShot
284
   | Opt_FullLaziness
285 286
   | Opt_FloatIn
   | Opt_Specialise
287
   | Opt_StaticArgumentTransformation
288
   | Opt_CSE
289 290
   | Opt_LiberateCase
   | Opt_SpecConstr
291 292 293 294 295
   | Opt_DoLambdaEtaExpansion
   | Opt_IgnoreAsserts
   | Opt_DoEtaReduction
   | Opt_CaseMerge
   | Opt_UnboxStrictFields
296
   | Opt_UnboxSmallStrictFields
297
   | Opt_DictsCheap
298
   | Opt_EnableRewriteRules             -- Apply rewrite rules during simplification
rl@cse.unsw.edu.au's avatar
rl@cse.unsw.edu.au committed
299
   | Opt_Vectorise
300
   | Opt_VectorisationAvoidance
Ian Lynagh's avatar
Ian Lynagh committed
301 302
   | Opt_RegsGraph                      -- do graph coloring register allocation
   | Opt_RegsIterative                  -- do iterative coalescing graph coloring register allocation
303
   | Opt_PedanticBottoms                -- Be picky about how we treat bottom
304
   | Opt_LlvmTBAA                       -- Use LLVM TBAA infastructure for improving AA (hidden flag)
305
   | Opt_IrrefutableTuples
306
   | Opt_CmmSink
307
   | Opt_CmmElimCommonBlocks
308
   | Opt_OmitYields
309
   | Opt_SimpleListLiterals
310
   | Opt_FunToThunk               -- allow WwLib.mkWorkerArgs to remove all value lambdas
311 312
   | Opt_DictsStrict                     -- be strict in argument dictionaries
   | Opt_DmdTxDictSel              -- use a special demand transformer for dictionary selectors
313

314 315 316 317 318
   -- Interface files
   | Opt_IgnoreInterfacePragmas
   | Opt_OmitInterfacePragmas
   | Opt_ExposeAllUnfoldings

Ian Lynagh's avatar
Ian Lynagh committed
319 320
   -- profiling opts
   | Opt_AutoSccsOnIndividualCafs
321
   | Opt_ProfCountEntries
Ian Lynagh's avatar
Ian Lynagh committed
322

323 324
   -- misc opts
   | Opt_Pp
325
   | Opt_ForceRecomp
326
   | Opt_ExcessPrecision
327
   | Opt_EagerBlackHoling
328 329 330
   | Opt_NoHsMain
   | Opt_SplitObjs
   | Opt_StgStats
331
   | Opt_HideAllPackages
332
   | Opt_PrintBindResult
333
   | Opt_Haddock
David Waern's avatar
David Waern committed
334
   | Opt_HaddockOptions
335
   | Opt_Hpc_No_Auto
336
   | Opt_BreakOnException
337
   | Opt_BreakOnError
338
   | Opt_PrintEvldWithShow
339
   | Opt_PrintBindContents
340 341
   | Opt_GenManifest
   | Opt_EmbedManifest
342
   | Opt_EmitExternalCore
Ian Lynagh's avatar
Ian Lynagh committed
343
   | Opt_SharedImplib
344
   | Opt_BuildingCabalPackage
345
   | Opt_IgnoreDotGhci
346
   | Opt_GhciSandbox
Ian Lynagh's avatar
Ian Lynagh committed
347
   | Opt_GhciHistory
348
   | Opt_HelpfulErrors
349
   | Opt_DeferTypeErrors
Ian Lynagh's avatar
Ian Lynagh committed
350
   | Opt_Parallel
Ian Lynagh's avatar
Ian Lynagh committed
351
   | Opt_GranMacros
Ian Lynagh's avatar
Ian Lynagh committed
352
   | Opt_PIC
353
   | Opt_SccProfilingOn
ian@well-typed.com's avatar
ian@well-typed.com committed
354
   | Opt_Ticky
nfrisby's avatar
nfrisby committed
355 356 357
   | Opt_Ticky_Allocd
   | Opt_Ticky_LNE
   | Opt_Ticky_Dyn_Thunk
ian@well-typed.com's avatar
ian@well-typed.com committed
358
   | Opt_Static
359
   | Opt_RPath
360
   | Opt_RelativeDynlibPaths
ian@well-typed.com's avatar
ian@well-typed.com committed
361
   | Opt_Hpc
362
   | Opt_FlatCache
363

364 365 366 367
   -- PreInlining is on by default. The option is there just to see how
   -- bad things get if you turn it off!
   | Opt_SimplPreInlining

368
   -- output style opts
369 370
   | Opt_ErrorSpans -- Include full span info in error messages,
                    -- instead of just the start position.
371
   | Opt_PprCaseAsLet
372

373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389
   -- Suppress all coercions, them replacing with '...'
   | Opt_SuppressCoercions
   | Opt_SuppressVarKinds
   -- Suppress module id prefixes on variables.
   | Opt_SuppressModulePrefixes
   -- Suppress type applications.
   | Opt_SuppressTypeApplications
   -- Suppress info such as arity and unfoldings on identifiers.
   | Opt_SuppressIdInfo
   -- Suppress separate type signatures in core, but leave types on
   -- lambda bound vars
   | Opt_SuppressTypeSignatures
   -- Suppress unique ids on variables.
   -- Except for uniques, as some simplifier phases introduce new
   -- variables that have otherwise identical names.
   | Opt_SuppressUniques

390
   -- temporary flags
391
   | Opt_RunCPS
392
   | Opt_RunCPSZ
393
   | Opt_AutoLinkPackages
394
   | Opt_ImplicitImportQualified
395 396 397 398 399 400

   -- keeping stuff
   | Opt_KeepHiDiffs
   | Opt_KeepHcFiles
   | Opt_KeepSFiles
   | Opt_KeepTmpFiles
Jedai's avatar
Jedai committed
401
   | Opt_KeepRawTokenStream
402
   | Opt_KeepLlvmFiles
403

404 405
   | Opt_BuildDynamicToo

406
   -- safe haskell flags
dterei's avatar
dterei committed
407
   | Opt_DistrustAllPackages
408 409
   | Opt_PackageTrust

410
   deriving (Eq, Show, Enum)
Ian Lynagh's avatar
Ian Lynagh committed
411

412 413
data WarningFlag =
     Opt_WarnDuplicateExports
414
   | Opt_WarnDuplicateConstraints
415 416 417 418 419
   | Opt_WarnHiShadows
   | Opt_WarnImplicitPrelude
   | Opt_WarnIncompletePatterns
   | Opt_WarnIncompleteUniPatterns
   | Opt_WarnIncompletePatternsRecUpd
420
   | Opt_WarnOverflowedLiterals
421
   | Opt_WarnEmptyEnumerations
422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447
   | 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
448 449
   | Opt_WarnUnsafe
   | Opt_WarnSafe
Ian Lynagh's avatar
Ian Lynagh committed
450
   | Opt_WarnPointlessPragmas
451
   | Opt_WarnUnsupportedCallingConventions
452
   | Opt_WarnUnsupportedLlvmVersion
453
   | Opt_WarnInlineRuleShadowing
454
   deriving (Eq, Show, Enum)
455

456
data Language = Haskell98 | Haskell2010
457
   deriving Enum
458

459
-- | The various Safe Haskell modes
460 461
data SafeHaskellMode
   = Sf_None
dterei's avatar
dterei committed
462
   | Sf_Unsafe
463 464
   | Sf_Trustworthy
   | Sf_Safe
465
   | Sf_SafeInferred
466 467
   deriving (Eq)

Ian Lynagh's avatar
Ian Lynagh committed
468
instance Show SafeHaskellMode where
Ian Lynagh's avatar
Ian Lynagh committed
469 470 471 472 473
    show Sf_None         = "None"
    show Sf_Unsafe       = "Unsafe"
    show Sf_Trustworthy  = "Trustworthy"
    show Sf_Safe         = "Safe"
    show Sf_SafeInferred = "Safe-Inferred"
Ian Lynagh's avatar
Ian Lynagh committed
474

475
instance Outputable SafeHaskellMode where
Ian Lynagh's avatar
Ian Lynagh committed
476
    ppr = text . show
477

478
data ExtensionFlag
479 480 481 482 483 484 485
   = Opt_Cpp
   | Opt_OverlappingInstances
   | Opt_UndecidableInstances
   | Opt_IncoherentInstances
   | Opt_MonomorphismRestriction
   | Opt_MonoPatBinds
   | Opt_MonoLocalBinds
486 487
   | Opt_RelaxedPolyRec           -- Deprecated
   | Opt_ExtendedDefaultRules     -- Use GHC's extended rules for defaulting
488 489
   | Opt_ForeignFunctionInterface
   | Opt_UnliftedFFITypes
490
   | Opt_InterruptibleFFI
491
   | Opt_CApiFFI
492
   | Opt_GHCForeignImportPrim
thoughtpolice's avatar
thoughtpolice committed
493
   | Opt_JavaScriptFFI
494 495
   | Opt_ParallelArrays           -- Syntactic support for parallel arrays
   | Opt_Arrows                   -- Arrow-notation syntax
496 497 498 499 500
   | Opt_TemplateHaskell
   | Opt_QuasiQuotes
   | Opt_ImplicitParams
   | Opt_ImplicitPrelude
   | Opt_ScopedTypeVariables
501
   | Opt_AllowAmbiguousTypes
502 503 504 505
   | Opt_UnboxedTuples
   | Opt_BangPatterns
   | Opt_TypeFamilies
   | Opt_OverloadedStrings
506
   | Opt_OverloadedLists
507
   | Opt_NumDecimals
508 509 510 511 512
   | Opt_DisambiguateRecordFields
   | Opt_RecordWildCards
   | Opt_RecordPuns
   | Opt_ViewPatterns
   | Opt_GADTs
Ian Lynagh's avatar
Ian Lynagh committed
513
   | Opt_GADTSyntax
514
   | Opt_NPlusKPatterns
Ian Lynagh's avatar
Ian Lynagh committed
515
   | Opt_DoAndIfThenElse
516
   | Opt_RebindableSyntax
517
   | Opt_ConstraintKinds
dreixel's avatar
dreixel committed
518
   | Opt_PolyKinds                -- Kind polymorphism
dreixel's avatar
dreixel committed
519
   | Opt_DataKinds                -- Datatype promotion
520
   | Opt_InstanceSigs
521

522 523
   | Opt_StandaloneDeriving
   | Opt_DeriveDataTypeable
524
   | Opt_AutoDeriveTypeable       -- Automatic derivation of Typeable
525 526 527
   | Opt_DeriveFunctor
   | Opt_DeriveTraversable
   | Opt_DeriveFoldable
528
   | Opt_DeriveGeneric            -- Allow deriving Generic/1
dreixel's avatar
dreixel committed
529
   | Opt_DefaultSignatures        -- Allow extra signatures for defmeths
530 531 532 533 534 535

   | Opt_TypeSynonymInstances
   | Opt_FlexibleContexts
   | Opt_FlexibleInstances
   | Opt_ConstrainedClassMethods
   | Opt_MultiParamTypeClasses
536
   | Opt_NullaryTypeClasses
537 538 539 540 541 542
   | Opt_FunctionalDependencies
   | Opt_UnicodeSyntax
   | Opt_ExistentialQuantification
   | Opt_MagicHash
   | Opt_EmptyDataDecls
   | Opt_KindSignatures
543
   | Opt_RoleAnnotations
544 545
   | Opt_ParallelListComp
   | Opt_TransformListComp
546
   | Opt_MonadComprehensions
547 548 549 550 551 552 553 554 555
   | Opt_GeneralizedNewtypeDeriving
   | Opt_RecursiveDo
   | Opt_PostfixOperators
   | Opt_TupleSections
   | Opt_PatternGuards
   | Opt_LiberalTypeSynonyms
   | Opt_RankNTypes
   | Opt_ImpredicativeTypes
   | Opt_TypeOperators
556
   | Opt_ExplicitNamespaces
557 558 559 560 561
   | Opt_PackageImports
   | Opt_ExplicitForAll
   | Opt_AlternativeLayoutRule
   | Opt_AlternativeLayoutRuleTransitional
   | Opt_DatatypeContexts
562
   | Opt_NondecreasingIndentation
563
   | Opt_RelaxedLayout
564
   | Opt_TraditionalRecordSyntax
565
   | Opt_LambdaCase
566
   | Opt_MultiWayIf
567
   | Opt_TypeHoles
568
   | Opt_NegativeLiterals
569
   | Opt_EmptyCase
570
   deriving (Eq, Enum, Show)
571

572
-- | Contains not only a collection of 'GeneralFlag's but also a plethora of
573
-- information relating to the compilation of a single file or GHC session
574
data DynFlags = DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
575 576 577
  ghcMode               :: GhcMode,
  ghcLink               :: GhcLink,
  hscTarget             :: HscTarget,
578
  settings              :: Settings,
579
  verbosity             :: Int,         -- ^ Verbosity level: see Note [Verbosity levels]
580 581 582
  optLevel              :: Int,         -- ^ Optimisation level
  simplPhases           :: Int,         -- ^ Number of simplifier phases
  maxSimplIterations    :: Int,         -- ^ Max simplifier iterations
583
  shouldDumpSimplPhase  :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
584
  ruleCheck             :: Maybe String,
585
  strictnessBefore      :: [Int],       -- ^ Additional demand analysis
586

587 588
  parMakeCount          :: Maybe Int,   -- ^ The number of modules to compile in parallel
                                        --   in --make mode, where Nothing ==> compile as
parcs's avatar
parcs committed
589 590
                                        --   many in parallel as there are CPUs.

591 592
  maxRelevantBinds      :: Maybe Int,   -- ^ Maximum number of bindings from the type envt
                                        --   to show in type error messages
593
  simplTickFactor       :: Int,         -- ^ Multiplier for simplifier ticks
594 595
  specConstrThreshold   :: Maybe Int,   -- ^ Threshold for SpecConstr
  specConstrCount       :: Maybe Int,   -- ^ Max number of specialisations for any one function
596 597
  specConstrRecursive   :: Int,         -- ^ Max number of specialisations for recursive types
                                        --   Not optional; otherwise ForceSpecConstr can diverge.
598
  liberateCaseThreshold :: Maybe Int,   -- ^ Threshold for LiberateCase
599
  floatLamArgs          :: Maybe Int,   -- ^ Arg count for lambda floating
600
                                        --   See CoreMonad.FloatOutSwitches
601

602
  historySize           :: Int,
603

604
  cmdlineHcIncludes     :: [String],    -- ^ @\-\#includes@
Ian Lynagh's avatar
Ian Lynagh committed
605 606 607
  importPaths           :: [FilePath],
  mainModIs             :: Module,
  mainFunIs             :: Maybe String,
608
  ctxtStkDepth          :: Int,         -- ^ Typechecker context stack depth
609

610
  thisPackage           :: PackageId,   -- ^ name of package currently being compiled
611 612

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

617 618 619
  -- For object splitting
  splitInfo             :: Maybe (String,Int),

620
  -- paths etc.
Ian Lynagh's avatar
Ian Lynagh committed
621
  objectDir             :: Maybe String,
622
  dylibInstallName      :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
623 624
  hiDir                 :: Maybe String,
  stubDir               :: Maybe String,
625
  dumpDir               :: Maybe String,
626

Ian Lynagh's avatar
Ian Lynagh committed
627 628 629
  objectSuf             :: String,
  hcSuf                 :: String,
  hiSuf                 :: String,
630

631 632 633 634
  canGenerateDynamicToo :: IORef Bool,
  dynObjectSuf          :: String,
  dynHiSuf              :: String,

635 636 637 638 639 640 641 642
  -- Packages.isDllName needs to know whether a call is within a
  -- single DLL or not. Normally it does this by seeing if the call
  -- is to the same package, but for the ghc package, we split the
  -- package between 2 DLLs. The dllSplit tells us which sets of
  -- modules are in which package.
  dllSplitFile          :: Maybe FilePath,
  dllSplit              :: Maybe [Set String],

Ian Lynagh's avatar
Ian Lynagh committed
643
  outputFile            :: Maybe String,
ian@well-typed.com's avatar
ian@well-typed.com committed
644
  dynOutputFile         :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
645 646
  outputHi              :: Maybe String,
  dynLibLoader          :: DynLibLoader,
647

648
  -- | This is set by 'DriverPipeline.runPipeline' based on where
Ian Lynagh's avatar
Ian Lynagh committed
649 650
  --    its output is going.
  dumpPrefix            :: Maybe FilePath,
651

652 653
  -- | Override the 'dumpPrefix' set by 'DriverPipeline.runPipeline'.
  --    Set by @-ddump-file-prefix@
Ian Lynagh's avatar
Ian Lynagh committed
654 655
  dumpPrefixForce       :: Maybe FilePath,

656
  ldInputs              :: [Option],
657

Ian Lynagh's avatar
Ian Lynagh committed
658 659 660 661 662
  includePaths          :: [String],
  libraryPaths          :: [String],
  frameworkPaths        :: [String],    -- used on darwin only
  cmdlineFrameworks     :: [String],    -- ditto

663
  rtsOpts               :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
664
  rtsOptsEnabled        :: RtsOptsEnabled,
665

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

668 669 670 671
  -- Plugins
  pluginModNames        :: [ModuleName],
  pluginModNameOpts     :: [(ModuleName,String)],

672 673 674 675 676 677
  --  For ghc -M
  depMakefile           :: FilePath,
  depIncludePkgDeps     :: Bool,
  depExcludeMods        :: [ModuleName],
  depSuffixes           :: [String],

678
  --  Package flags
679
  extraPkgConfs         :: [PkgConfRef] -> [PkgConfRef],
680
        -- ^ The @-package-db@ flags given on the command line, in the order
Ian Lynagh's avatar
Ian Lynagh committed
681
        -- they appeared.
682

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

686
  -- Package state
Ian Lynagh's avatar
Ian Lynagh committed
687
  -- NB. do not modify this field, it is calculated by
688
  -- Packages.initPackages and Packages.updatePackages.
689
  pkgDatabase           :: Maybe [PackageConfig],
Ian Lynagh's avatar
Ian Lynagh committed
690
  pkgState              :: PackageState,
691

692 693 694 695
  -- Temporary files
  -- These have to be IORefs, because the defaultCleanupHandler needs to
  -- know what to clean when an exception happens
  filesToClean          :: IORef [FilePath],
696
  dirsToClean           :: IORef (Map FilePath FilePath),
697
  filesToNotIntermediateClean :: IORef [FilePath],
698 699
  -- The next available suffix to uniquely name a temp file, updated atomically
  nextTempSuffix        :: IORef Int,
700

701 702 703 704 705
  -- 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),

706
  -- hsc dynamic flags
707 708
  dumpFlags             :: IntSet,
  generalFlags          :: IntSet,
709
  warningFlags          :: IntSet,
710
  -- Don't change this without updating extensionFlags:
711
  language              :: Maybe Language,
712 713
  -- | Safe Haskell mode
  safeHaskell           :: SafeHaskellMode,
714 715 716
  -- 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.
717 718
  thOnLoc               :: SrcSpan,
  newDerivOnLoc         :: SrcSpan,
719
  pkgTrustOnLoc         :: SrcSpan,
720 721
  warnSafeOnLoc         :: SrcSpan,
  warnUnsafeOnLoc       :: SrcSpan,
722 723 724 725
  -- Don't change this without updating extensionFlags:
  extensions            :: [OnOff ExtensionFlag],
  -- extensionFlags should always be equal to
  --     flattenExtensionFlags language extensions
726
  extensionFlags        :: IntSet,
Ian Lynagh's avatar
Ian Lynagh committed
727

728 729 730 731 732 733 734 735 736
  -- Unfolding control
  -- See Note [Discounts and thresholds] in CoreUnfold
  ufCreationThreshold   :: Int,
  ufUseThreshold        :: Int,
  ufFunAppDiscount      :: Int,
  ufDictDiscount        :: Int,
  ufKeenessFactor       :: Float,
  ufDearOp              :: Int,

737 738
  maxWorkerArgs         :: Int,

739 740
  ghciHistSize          :: Int,

741
  -- | MsgDoc output action: use "ErrUtils" instead of this if you can
742
  log_action            :: LogAction,
743 744
  flushOut              :: FlushOut,
  flushErr              :: FlushErr,
David Waern's avatar
David Waern committed
745

746
  haddockOptions        :: Maybe String,
747
  ghciScripts           :: [String],
748

749 750
  -- Output style options
  pprUserLength         :: Int,
Ian Lynagh's avatar
Ian Lynagh committed
751
  pprCols               :: Int,
Ian Lynagh's avatar
Ian Lynagh committed
752
  traceLevel            :: Int, -- Standard level is 1. Less verbose is 0.
753

754 755
  useUnicodeQuotes      :: Bool,

756
  -- | what kind of {-# SCC #-} to add automatically
757 758
  profAuto              :: ProfAuto,

759
  interactivePrint      :: Maybe String,
760

761
  llvmVersion           :: IORef Int,
762

763
  nextWrapperNum        :: IORef (ModuleEnv Int),
tibbe's avatar
tibbe committed
764 765

  -- | Machine dependant flags (-m<blah> stuff)
766 767 768 769
  sseVersion            :: Maybe (Int, Int),  -- (major, minor)

  -- | Run-time linker information (what options we need, etc.)
  rtldFlags             :: IORef (Maybe LinkerInfo)
770 771
 }

772 773 774
class HasDynFlags m where
    getDynFlags :: m DynFlags

Ian Lynagh's avatar
Ian Lynagh committed
775 776
class ContainsDynFlags t where
    extractDynFlags :: t -> DynFlags
777
    replaceDynFlags :: t -> DynFlags -> t
Ian Lynagh's avatar
Ian Lynagh committed
778

779 780 781 782 783
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
784
  | ProfAutoCalls      -- ^ annotate call-sites
Simon Marlow's avatar
Simon Marlow committed
785
  deriving (Enum)
786

787
data Settings = Settings {
788
  sTargetPlatform        :: Platform,    -- Filled in by SysTools
789 790 791 792 793 794 795 796 797
  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,
798 799
  sLdSupportsCompactUnwind :: Bool,
  sLdSupportsBuildId       :: Bool,
800
  sLdSupportsFilelist      :: Bool,
801
  sLdIsGnuLd               :: Bool,
802 803 804 805 806 807 808 809 810 811 812 813
  -- commands for particular phases
  sPgm_L                 :: String,
  sPgm_P                 :: (String,[Option]),
  sPgm_F                 :: String,
  sPgm_c                 :: (String,[Option]),
  sPgm_s                 :: (String,[<