DynFlags.hs 158 KB
Newer Older
1 2
{-# LANGUAGE CPP #-}

dterei's avatar
dterei committed
3
-------------------------------------------------------------------------------
4
--
dterei's avatar
dterei committed
5 6 7 8 9 10
-- | 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.
11 12 13
--
-- (c) The University of Glasgow 2005
--
dterei's avatar
dterei committed
14
-------------------------------------------------------------------------------
15

16
{-# OPTIONS_GHC -fno-cse #-}
17 18
-- -fno-cse is needed for GLOBAL_VAR's to behave properly

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

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

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

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


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

88
        getOpts,                        -- DynFlags -> (DynFlags -> [a]) -> [a]
89
        getVerbFlags,
Ian Lynagh's avatar
Ian Lynagh committed
90 91
        updOptLevel,
        setTmpDir,
92
        setPackageKey,
Ian Lynagh's avatar
Ian Lynagh committed
93

94
        -- ** Parsing DynFlags
95 96
        parseDynamicFlagsCmdLine,
        parseDynamicFilePragma,
97 98 99
        parseDynamicFlagsFull,

        -- ** Available DynFlags
100
        allFlags,
101 102 103
        flagsAll,
        flagsDynamic,
        flagsPackage,
104

105
        supportedLanguagesAndExtensions,
106
        languageExtensions,
107

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

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

        -- * Compiler configuration suitable for display to the user
116 117
        compilerInfo,

118
#ifdef GHCI
119
        rtsIsProfiled,
120
#endif
121
        dynamicGhc,
122 123

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

130 131
        unsafeGlobalDynFlags, setUnsafeGlobalDynFlags,

132
        -- * SSE and AVX
133
        isSseEnabled,
134 135
        isSse2Enabled,
        isSse4_2Enabled,
136 137
        isAvxEnabled,
        isAvx2Enabled,
138 139 140 141
        isAvx512cdEnabled,
        isAvx512erEnabled,
        isAvx512fEnabled,
        isAvx512pfEnabled,
142

Austin Seipp's avatar
Austin Seipp committed
143
        -- * Linker/compiler information
144
        LinkerInfo(..),
Austin Seipp's avatar
Austin Seipp committed
145
        CompilerInfo(..),
146 147 148 149
  ) where

#include "HsVersions.h"

150
import Platform
151
import PlatformConstants
152
import Module
Simon Marlow's avatar
Simon Marlow committed
153
import PackageConfig
154
import {-# SOURCE #-} Hooks
155
import {-# SOURCE #-} PrelNames ( mAIN )
156
import {-# SOURCE #-} Packages (PackageState)
Ian Lynagh's avatar
Ian Lynagh committed
157
import DriverPhases     ( Phase(..), phaseInputExt )
158 159
import Config
import CmdLineParser
160
import Constants
161
import Panic
162
import Util
163
import Maybes           ( orElse )
164
import MonadUtils
165
import qualified Pretty
166
import SrcLoc
167
import FastString
Simon Marlow's avatar
Simon Marlow committed
168
import Outputable
Ian Lynagh's avatar
Ian Lynagh committed
169
#ifdef GHCI
Ian Lynagh's avatar
Ian Lynagh committed
170
import Foreign.C        ( CInt(..) )
171
import System.IO.Unsafe ( unsafeDupablePerformIO )
Ian Lynagh's avatar
Ian Lynagh committed
172
#endif
173
import {-# SOURCE #-} ErrUtils ( Severity(..), MsgDoc, mkLocMessage )
174

175
import System.IO.Unsafe ( unsafePerformIO )
176
import Data.IORef
ian@well-typed.com's avatar
ian@well-typed.com committed
177
import Control.Monad
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
178

179
import Data.Bits
180
import Data.Char
181
import Data.Int
182
import Data.List
183 184
import Data.Map (Map)
import qualified Data.Map as Map
185
import Data.Maybe
186 187
import Data.Set (Set)
import qualified Data.Set as Set
188
import Data.Word
Ian Lynagh's avatar
Ian Lynagh committed
189
import System.FilePath
190
import System.IO
191
import System.IO.Error
192 193
import Text.ParserCombinators.ReadP hiding (char)
import Text.ParserCombinators.ReadP as R
194

195 196 197
import Data.IntSet (IntSet)
import qualified Data.IntSet as IntSet

198 199
import GHC.Foreign (withCString, peekCString)

200 201 202
-- -----------------------------------------------------------------------------
-- DynFlags

203
data DumpFlag
204 205 206

   -- debugging flags
   = Opt_D_dump_cmm
207 208 209 210 211 212
   | 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
213
   | Opt_D_dump_cmm_sink
214 215 216 217 218 219
   | 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
220
   | Opt_D_dump_asm
221 222 223 224 225
   | 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
226
   | Opt_D_dump_asm_stats
227
   | Opt_D_dump_asm_expanded
228
   | Opt_D_dump_llvm
229
   | Opt_D_dump_core_stats
230 231 232 233
   | Opt_D_dump_deriv
   | Opt_D_dump_ds
   | Opt_D_dump_foreign
   | Opt_D_dump_inlinings
234
   | Opt_D_dump_rule_firings
235
   | Opt_D_dump_rule_rewrites
236
   | Opt_D_dump_simpl_trace
237 238 239
   | Opt_D_dump_occur_anal
   | Opt_D_dump_parsed
   | Opt_D_dump_rn
240
   | Opt_D_dump_core_pipeline -- TODO FIXME: dump after simplifier stats
241 242
   | Opt_D_dump_simpl
   | Opt_D_dump_simpl_iterations
243
   | Opt_D_dump_simpl_phases
244 245 246
   | Opt_D_dump_spec
   | Opt_D_dump_prep
   | Opt_D_dump_stg
247
   | Opt_D_dump_call_arity
248
   | Opt_D_dump_stranal
Joachim Breitner's avatar
Joachim Breitner committed
249
   | Opt_D_dump_strsigs
250 251 252 253 254 255 256 257 258
   | 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
259
   | Opt_D_dump_cs_trace -- Constraint solver in type checker
260 261
   | Opt_D_dump_tc_trace
   | Opt_D_dump_if_trace
262
   | Opt_D_dump_vt_trace
263 264 265
   | Opt_D_dump_splices
   | Opt_D_dump_BCOs
   | Opt_D_dump_vect
266
   | Opt_D_dump_ticked
pepe's avatar
pepe committed
267
   | Opt_D_dump_rtti
268 269 270 271
   | Opt_D_source_stats
   | Opt_D_verbose_stg2stg
   | Opt_D_dump_hi
   | Opt_D_dump_hi_diffs
272
   | Opt_D_dump_mod_cycles
273
   | Opt_D_dump_mod_map
274
   | Opt_D_dump_view_pattern_commoning
275 276 277 278 279 280 281 282
   | 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.
283
   | Opt_D_faststring_stats
284
   | Opt_D_dump_minimal_imports
285 286 287
   | Opt_DoCoreLinting
   | Opt_DoStgLinting
   | Opt_DoCmmLinting
Ben.Lippmeier@anu.edu.au's avatar
Ben.Lippmeier@anu.edu.au committed
288
   | Opt_DoAsmLinting
289
   | Opt_NoLlvmMangler                 -- hidden flag
290

Ian Lynagh's avatar
Ian Lynagh committed
291
   | Opt_WarnIsError                    -- -Werror; makes warnings fatal
292

293
   | Opt_PrintExplicitForalls
unknown's avatar
unknown committed
294
   | Opt_PrintExplicitKinds
295

296
   -- optimisation opts
297
   | Opt_CallArity
298
   | Opt_Strictness
299
   | Opt_LateDmdAnal
300 301
   | Opt_KillAbsence
   | Opt_KillOneShot
302
   | Opt_FullLaziness
303 304
   | Opt_FloatIn
   | Opt_Specialise
305
   | Opt_SpecialiseAggressively
306
   | Opt_StaticArgumentTransformation
307
   | Opt_CSE
308 309
   | Opt_LiberateCase
   | Opt_SpecConstr
310 311 312 313 314
   | Opt_DoLambdaEtaExpansion
   | Opt_IgnoreAsserts
   | Opt_DoEtaReduction
   | Opt_CaseMerge
   | Opt_UnboxStrictFields
315
   | Opt_UnboxSmallStrictFields
316
   | Opt_DictsCheap
317
   | Opt_EnableRewriteRules             -- Apply rewrite rules during simplification
rl@cse.unsw.edu.au's avatar
rl@cse.unsw.edu.au committed
318
   | Opt_Vectorise
319
   | Opt_VectorisationAvoidance
Ian Lynagh's avatar
Ian Lynagh committed
320 321
   | Opt_RegsGraph                      -- do graph coloring register allocation
   | Opt_RegsIterative                  -- do iterative coalescing graph coloring register allocation
322
   | Opt_PedanticBottoms                -- Be picky about how we treat bottom
323
   | Opt_LlvmTBAA                       -- Use LLVM TBAA infastructure for improving AA (hidden flag)
324
   | Opt_LlvmPassVectorsInRegisters     -- Pass SIMD vectors in registers (requires a patched LLVM) (hidden flag)
325
   | Opt_IrrefutableTuples
326
   | Opt_CmmSink
327
   | Opt_CmmElimCommonBlocks
328
   | Opt_OmitYields
329
   | Opt_SimpleListLiterals
330
   | Opt_FunToThunk               -- allow WwLib.mkWorkerArgs to remove all value lambdas
331 332
   | Opt_DictsStrict                     -- be strict in argument dictionaries
   | Opt_DmdTxDictSel              -- use a special demand transformer for dictionary selectors
333
   | Opt_Loopification                  -- See Note [Self-recursive tail calls]
334

335 336 337 338
   -- Interface files
   | Opt_IgnoreInterfacePragmas
   | Opt_OmitInterfacePragmas
   | Opt_ExposeAllUnfoldings
339
   | Opt_WriteInterface -- forces .hi files to be written even with -fno-code
340

Ian Lynagh's avatar
Ian Lynagh committed
341 342
   -- profiling opts
   | Opt_AutoSccsOnIndividualCafs
343
   | Opt_ProfCountEntries
Ian Lynagh's avatar
Ian Lynagh committed
344

345 346
   -- misc opts
   | Opt_Pp
347
   | Opt_ForceRecomp
348
   | Opt_ExcessPrecision
349
   | Opt_EagerBlackHoling
350 351 352
   | Opt_NoHsMain
   | Opt_SplitObjs
   | Opt_StgStats
353
   | Opt_HideAllPackages
354
   | Opt_PrintBindResult
355
   | Opt_Haddock
David Waern's avatar
David Waern committed
356
   | Opt_HaddockOptions
357
   | Opt_Hpc_No_Auto
358
   | Opt_BreakOnException
359
   | Opt_BreakOnError
360
   | Opt_PrintEvldWithShow
361
   | Opt_PrintBindContents
362 363
   | Opt_GenManifest
   | Opt_EmbedManifest
364
   | Opt_EmitExternalCore
Ian Lynagh's avatar
Ian Lynagh committed
365
   | Opt_SharedImplib
366
   | Opt_BuildingCabalPackage
367
   | Opt_IgnoreDotGhci
368
   | Opt_GhciSandbox
Ian Lynagh's avatar
Ian Lynagh committed
369
   | Opt_GhciHistory
370
   | Opt_HelpfulErrors
371
   | Opt_DeferTypeErrors
Ian Lynagh's avatar
Ian Lynagh committed
372
   | Opt_Parallel
Ian Lynagh's avatar
Ian Lynagh committed
373
   | Opt_GranMacros
Ian Lynagh's avatar
Ian Lynagh committed
374
   | Opt_PIC
375
   | Opt_SccProfilingOn
ian@well-typed.com's avatar
ian@well-typed.com committed
376
   | Opt_Ticky
nfrisby's avatar
nfrisby committed
377 378 379
   | Opt_Ticky_Allocd
   | Opt_Ticky_LNE
   | Opt_Ticky_Dyn_Thunk
ian@well-typed.com's avatar
ian@well-typed.com committed
380
   | Opt_Static
381
   | Opt_RPath
382
   | Opt_RelativeDynlibPaths
ian@well-typed.com's avatar
ian@well-typed.com committed
383
   | Opt_Hpc
384
   | Opt_FlatCache
385

386 387 388 389
   -- PreInlining is on by default. The option is there just to see how
   -- bad things get if you turn it off!
   | Opt_SimplPreInlining

390
   -- output style opts
391 392
   | Opt_ErrorSpans -- Include full span info in error messages,
                    -- instead of just the start position.
393
   | Opt_PprCaseAsLet
394

395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411
   -- 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

412
   -- temporary flags
413
   | Opt_AutoLinkPackages
414
   | Opt_ImplicitImportQualified
415 416 417 418 419 420

   -- keeping stuff
   | Opt_KeepHiDiffs
   | Opt_KeepHcFiles
   | Opt_KeepSFiles
   | Opt_KeepTmpFiles
Jedai's avatar
Jedai committed
421
   | Opt_KeepRawTokenStream
422
   | Opt_KeepLlvmFiles
423

424 425
   | Opt_BuildDynamicToo

426
   -- safe haskell flags
dterei's avatar
dterei committed
427
   | Opt_DistrustAllPackages
428 429
   | Opt_PackageTrust

430
   deriving (Eq, Show, Enum)
Ian Lynagh's avatar
Ian Lynagh committed
431

432 433
data WarningFlag =
     Opt_WarnDuplicateExports
434
   | Opt_WarnDuplicateConstraints
435 436 437 438 439
   | Opt_WarnHiShadows
   | Opt_WarnImplicitPrelude
   | Opt_WarnIncompletePatterns
   | Opt_WarnIncompleteUniPatterns
   | Opt_WarnIncompletePatternsRecUpd
440
   | Opt_WarnOverflowedLiterals
441
   | Opt_WarnEmptyEnumerations
442 443 444 445 446 447 448 449 450 451 452 453
   | Opt_WarnMissingFields
   | Opt_WarnMissingImportList
   | Opt_WarnMissingMethods
   | Opt_WarnMissingSigs
   | Opt_WarnMissingLocalSigs
   | Opt_WarnNameShadowing
   | Opt_WarnOverlappingPatterns
   | Opt_WarnTypeDefaults
   | Opt_WarnMonomorphism
   | Opt_WarnUnusedBinds
   | Opt_WarnUnusedImports
   | Opt_WarnUnusedMatches
454
   | Opt_WarnContextQuantification
455 456
   | Opt_WarnWarningsDeprecations
   | Opt_WarnDeprecatedFlags
457
   | Opt_WarnAMP
458 459 460 461 462 463 464 465 466 467 468
   | Opt_WarnDodgyExports
   | Opt_WarnDodgyImports
   | Opt_WarnOrphans
   | Opt_WarnAutoOrphans
   | Opt_WarnIdentities
   | Opt_WarnTabs
   | Opt_WarnUnrecognisedPragmas
   | Opt_WarnDodgyForeignImports
   | Opt_WarnUnusedDoBind
   | Opt_WarnWrongDoBind
   | Opt_WarnAlternativeLayoutRuleTransitional
469 470
   | Opt_WarnUnsafe
   | Opt_WarnSafe
Ian Lynagh's avatar
Ian Lynagh committed
471
   | Opt_WarnPointlessPragmas
472
   | Opt_WarnUnsupportedCallingConventions
473
   | Opt_WarnUnsupportedLlvmVersion
474
   | Opt_WarnInlineRuleShadowing
475
   | Opt_WarnTypedHoles
476
   deriving (Eq, Show, Enum)
477

478
data Language = Haskell98 | Haskell2010
479
   deriving Enum
480

481
-- | The various Safe Haskell modes
482 483
data SafeHaskellMode
   = Sf_None
dterei's avatar
dterei committed
484
   | Sf_Unsafe
485 486 487 488
   | Sf_Trustworthy
   | Sf_Safe
   deriving (Eq)

Ian Lynagh's avatar
Ian Lynagh committed
489
instance Show SafeHaskellMode where
Ian Lynagh's avatar
Ian Lynagh committed
490 491 492 493
    show Sf_None         = "None"
    show Sf_Unsafe       = "Unsafe"
    show Sf_Trustworthy  = "Trustworthy"
    show Sf_Safe         = "Safe"
Ian Lynagh's avatar
Ian Lynagh committed
494

495
instance Outputable SafeHaskellMode where
Ian Lynagh's avatar
Ian Lynagh committed
496
    ppr = text . show
497

498
data ExtensionFlag
499 500 501 502 503 504 505
   = Opt_Cpp
   | Opt_OverlappingInstances
   | Opt_UndecidableInstances
   | Opt_IncoherentInstances
   | Opt_MonomorphismRestriction
   | Opt_MonoPatBinds
   | Opt_MonoLocalBinds
506 507
   | Opt_RelaxedPolyRec           -- Deprecated
   | Opt_ExtendedDefaultRules     -- Use GHC's extended rules for defaulting
508 509
   | Opt_ForeignFunctionInterface
   | Opt_UnliftedFFITypes
510
   | Opt_InterruptibleFFI
511
   | Opt_CApiFFI
512
   | Opt_GHCForeignImportPrim
thoughtpolice's avatar
thoughtpolice committed
513
   | Opt_JavaScriptFFI
514 515
   | Opt_ParallelArrays           -- Syntactic support for parallel arrays
   | Opt_Arrows                   -- Arrow-notation syntax
516 517 518 519 520
   | Opt_TemplateHaskell
   | Opt_QuasiQuotes
   | Opt_ImplicitParams
   | Opt_ImplicitPrelude
   | Opt_ScopedTypeVariables
521
   | Opt_AllowAmbiguousTypes
522 523 524 525
   | Opt_UnboxedTuples
   | Opt_BangPatterns
   | Opt_TypeFamilies
   | Opt_OverloadedStrings
526
   | Opt_OverloadedLists
527
   | Opt_NumDecimals
528 529 530 531 532
   | Opt_DisambiguateRecordFields
   | Opt_RecordWildCards
   | Opt_RecordPuns
   | Opt_ViewPatterns
   | Opt_GADTs
Ian Lynagh's avatar
Ian Lynagh committed
533
   | Opt_GADTSyntax
534
   | Opt_NPlusKPatterns
Ian Lynagh's avatar
Ian Lynagh committed
535
   | Opt_DoAndIfThenElse
536
   | Opt_RebindableSyntax
537
   | Opt_ConstraintKinds
dreixel's avatar
dreixel committed
538
   | Opt_PolyKinds                -- Kind polymorphism
dreixel's avatar
dreixel committed
539
   | Opt_DataKinds                -- Datatype promotion
540
   | Opt_InstanceSigs
541

542 543
   | Opt_StandaloneDeriving
   | Opt_DeriveDataTypeable
544
   | Opt_AutoDeriveTypeable       -- Automatic derivation of Typeable
545 546 547
   | Opt_DeriveFunctor
   | Opt_DeriveTraversable
   | Opt_DeriveFoldable
548
   | Opt_DeriveGeneric            -- Allow deriving Generic/1
dreixel's avatar
dreixel committed
549
   | Opt_DefaultSignatures        -- Allow extra signatures for defmeths
550 551 552 553 554 555

   | Opt_TypeSynonymInstances
   | Opt_FlexibleContexts
   | Opt_FlexibleInstances
   | Opt_ConstrainedClassMethods
   | Opt_MultiParamTypeClasses
556
   | Opt_NullaryTypeClasses
557 558 559 560 561 562
   | Opt_FunctionalDependencies
   | Opt_UnicodeSyntax
   | Opt_ExistentialQuantification
   | Opt_MagicHash
   | Opt_EmptyDataDecls
   | Opt_KindSignatures
563
   | Opt_RoleAnnotations
564 565
   | Opt_ParallelListComp
   | Opt_TransformListComp
566
   | Opt_MonadComprehensions
567 568 569 570 571 572 573 574 575
   | Opt_GeneralizedNewtypeDeriving
   | Opt_RecursiveDo
   | Opt_PostfixOperators
   | Opt_TupleSections
   | Opt_PatternGuards
   | Opt_LiberalTypeSynonyms
   | Opt_RankNTypes
   | Opt_ImpredicativeTypes
   | Opt_TypeOperators
576
   | Opt_ExplicitNamespaces
577 578 579 580 581
   | Opt_PackageImports
   | Opt_ExplicitForAll
   | Opt_AlternativeLayoutRule
   | Opt_AlternativeLayoutRuleTransitional
   | Opt_DatatypeContexts
582
   | Opt_NondecreasingIndentation
583
   | Opt_RelaxedLayout
584
   | Opt_TraditionalRecordSyntax
585
   | Opt_LambdaCase
586
   | Opt_MultiWayIf
587
   | Opt_BinaryLiterals
588
   | Opt_NegativeLiterals
589
   | Opt_EmptyCase
Gergő Érdi's avatar
Gergő Érdi committed
590
   | Opt_PatternSynonyms
591
   deriving (Eq, Enum, Show)
592

593 594 595 596 597 598 599 600 601 602 603
data SigOf = NotSigOf
           | SigOf Module
           | SigOfMap (Map ModuleName Module)

getSigOf :: DynFlags -> ModuleName -> Maybe Module
getSigOf dflags n =
    case sigOf dflags of
        NotSigOf -> Nothing
        SigOf m -> Just m
        SigOfMap m -> Map.lookup n m

604
-- | Contains not only a collection of 'GeneralFlag's but also a plethora of
605
-- information relating to the compilation of a single file or GHC session
606
data DynFlags = DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
607 608 609
  ghcMode               :: GhcMode,
  ghcLink               :: GhcLink,
  hscTarget             :: HscTarget,
610
  settings              :: Settings,
611 612
  -- See Note [Signature parameters in TcGblEnv and DynFlags]
  sigOf                 :: SigOf,       -- ^ Compiling an hs-boot against impl.
613
  verbosity             :: Int,         -- ^ Verbosity level: see Note [Verbosity levels]
614 615 616
  optLevel              :: Int,         -- ^ Optimisation level
  simplPhases           :: Int,         -- ^ Number of simplifier phases
  maxSimplIterations    :: Int,         -- ^ Max simplifier iterations
617
  shouldDumpSimplPhase  :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
618
  ruleCheck             :: Maybe String,
619
  strictnessBefore      :: [Int],       -- ^ Additional demand analysis
620

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

625 626 627
  enableTimeStats       :: Bool,        -- ^ Enable RTS timing statistics?
  ghcHeapSize           :: Maybe Int,   -- ^ The heap size to set.

628 629
  maxRelevantBinds      :: Maybe Int,   -- ^ Maximum number of bindings from the type envt
                                        --   to show in type error messages
630
  simplTickFactor       :: Int,         -- ^ Multiplier for simplifier ticks
631 632
  specConstrThreshold   :: Maybe Int,   -- ^ Threshold for SpecConstr
  specConstrCount       :: Maybe Int,   -- ^ Max number of specialisations for any one function
633 634
  specConstrRecursive   :: Int,         -- ^ Max number of specialisations for recursive types
                                        --   Not optional; otherwise ForceSpecConstr can diverge.
635
  liberateCaseThreshold :: Maybe Int,   -- ^ Threshold for LiberateCase
636
  floatLamArgs          :: Maybe Int,   -- ^ Arg count for lambda floating
637
                                        --   See CoreMonad.FloatOutSwitches
638

639
  historySize           :: Int,
640

641
  cmdlineHcIncludes     :: [String],    -- ^ @\-\#includes@
Ian Lynagh's avatar
Ian Lynagh committed
642 643 644
  importPaths           :: [FilePath],
  mainModIs             :: Module,
  mainFunIs             :: Maybe String,
645
  ctxtStkDepth          :: Int,         -- ^ Typechecker context stack depth
646
  tyFunStkDepth         :: Int,         -- ^ Typechecker type function stack depth
647

648
  thisPackage           :: PackageKey,   -- ^ name of package currently being compiled
649 650

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

655 656 657
  -- For object splitting
  splitInfo             :: Maybe (String,Int),

658
  -- paths etc.
Ian Lynagh's avatar
Ian Lynagh committed
659
  objectDir             :: Maybe String,
660
  dylibInstallName      :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
661 662
  hiDir                 :: Maybe String,
  stubDir               :: Maybe String,
663
  dumpDir               :: Maybe String,
664

Ian Lynagh's avatar
Ian Lynagh committed
665 666 667
  objectSuf             :: String,
  hcSuf                 :: String,
  hiSuf                 :: String,
668

669 670 671 672
  canGenerateDynamicToo :: IORef Bool,
  dynObjectSuf          :: String,
  dynHiSuf              :: String,

673 674 675 676 677 678 679 680
  -- 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
681
  outputFile            :: Maybe String,
ian@well-typed.com's avatar
ian@well-typed.com committed
682
  dynOutputFile         :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
683 684
  outputHi              :: Maybe String,
  dynLibLoader          :: DynLibLoader,
685

686
  -- | This is set by 'DriverPipeline.runPipeline' based on where
Ian Lynagh's avatar
Ian Lynagh committed
687 688
  --    its output is going.
  dumpPrefix            :: Maybe FilePath,
689

690 691
  -- | Override the 'dumpPrefix' set by 'DriverPipeline.runPipeline'.
  --    Set by @-ddump-file-prefix@
Ian Lynagh's avatar
Ian Lynagh committed
692 693
  dumpPrefixForce       :: Maybe FilePath,

694
  ldInputs              :: [Option],
695

Ian Lynagh's avatar
Ian Lynagh committed
696 697 698 699 700
  includePaths          :: [String],
  libraryPaths          :: [String],
  frameworkPaths        :: [String],    -- used on darwin only
  cmdlineFrameworks     :: [String],    -- ditto

701
  rtsOpts               :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
702
  rtsOptsEnabled        :: RtsOptsEnabled,
703

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

706 707 708 709
  -- Plugins
  pluginModNames        :: [ModuleName],
  pluginModNameOpts     :: [(ModuleName,String)],

710 711 712
  -- GHC API hooks
  hooks                 :: Hooks,

713 714 715 716 717 718
  --  For ghc -M
  depMakefile           :: FilePath,
  depIncludePkgDeps     :: Bool,
  depExcludeMods        :: [ModuleName],
  depSuffixes           :: [String],

719
  --  Package flags
720
  extraPkgConfs         :: [PkgConfRef] -> [PkgConfRef],
721
        -- ^ The @-package-db@ flags given on the command line, in the order
Ian Lynagh's avatar
Ian Lynagh committed
722
        -- they appeared.
723

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

727
  -- Package state
Ian Lynagh's avatar
Ian Lynagh committed
728
  -- NB. do not modify this field, it is calculated by
729
  -- Packages.initPackages and Packages.updatePackages.
730
  pkgDatabase           :: Maybe [PackageConfig],
Ian Lynagh's avatar
Ian Lynagh committed
731
  pkgState              :: PackageState,
732

733 734 735 736