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

54 55
        printOutputForUser, printInfoForUser,

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

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

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


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

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

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

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

106
        supportedLanguagesAndExtensions,
107
        languageExtensions,
108

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

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

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

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

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

131 132
        unsafeGlobalDynFlags, setUnsafeGlobalDynFlags,

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

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

#include "HsVersions.h"

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

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

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

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

199 200
import GHC.Foreign (withCString, peekCString)

201 202 203
-- -----------------------------------------------------------------------------
-- DynFlags

204
data DumpFlag
205 206 207

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

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

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

297
   -- optimisation opts
298
   | Opt_CallArity
299
   | Opt_Strictness
300
   | Opt_LateDmdAnal
301 302
   | Opt_KillAbsence
   | Opt_KillOneShot
303
   | Opt_FullLaziness
304 305
   | Opt_FloatIn
   | Opt_Specialise
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 454 455
   | 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
456
   | Opt_WarnAMP
457 458 459 460 461 462 463 464 465 466 467
   | Opt_WarnDodgyExports
   | Opt_WarnDodgyImports
   | Opt_WarnOrphans
   | Opt_WarnAutoOrphans
   | Opt_WarnIdentities
   | Opt_WarnTabs
   | Opt_WarnUnrecognisedPragmas
   | Opt_WarnDodgyForeignImports
   | Opt_WarnUnusedDoBind
   | Opt_WarnWrongDoBind
   | Opt_WarnAlternativeLayoutRuleTransitional
468 469
   | Opt_WarnUnsafe
   | Opt_WarnSafe
Ian Lynagh's avatar
Ian Lynagh committed
470
   | Opt_WarnPointlessPragmas
471
   | Opt_WarnUnsupportedCallingConventions
472
   | Opt_WarnUnsupportedLlvmVersion
473
   | Opt_WarnInlineRuleShadowing
474
   | Opt_WarnTypedHoles
475
   deriving (Eq, Show, Enum)
476

477
data Language = Haskell98 | Haskell2010
478
   deriving Enum
479

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

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

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

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

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

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

592
-- | Contains not only a collection of 'GeneralFlag's but also a plethora of
593
-- information relating to the compilation of a single file or GHC session
594
data DynFlags = DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
595 596 597
  ghcMode               :: GhcMode,
  ghcLink               :: GhcLink,
  hscTarget             :: HscTarget,
598
  settings              :: Settings,
599
  verbosity             :: Int,         -- ^ Verbosity level: see Note [Verbosity levels]
600 601 602
  optLevel              :: Int,         -- ^ Optimisation level
  simplPhases           :: Int,         -- ^ Number of simplifier phases
  maxSimplIterations    :: Int,         -- ^ Max simplifier iterations
603
  shouldDumpSimplPhase  :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
604
  ruleCheck             :: Maybe String,
605
  strictnessBefore      :: [Int],       -- ^ Additional demand analysis
606

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

611 612 613
  enableTimeStats       :: Bool,        -- ^ Enable RTS timing statistics?
  ghcHeapSize           :: Maybe Int,   -- ^ The heap size to set.

614 615
  maxRelevantBinds      :: Maybe Int,   -- ^ Maximum number of bindings from the type envt
                                        --   to show in type error messages
616
  simplTickFactor       :: Int,         -- ^ Multiplier for simplifier ticks
617 618
  specConstrThreshold   :: Maybe Int,   -- ^ Threshold for SpecConstr
  specConstrCount       :: Maybe Int,   -- ^ Max number of specialisations for any one function
619 620
  specConstrRecursive   :: Int,         -- ^ Max number of specialisations for recursive types
                                        --   Not optional; otherwise ForceSpecConstr can diverge.
621
  liberateCaseThreshold :: Maybe Int,   -- ^ Threshold for LiberateCase
622
  floatLamArgs          :: Maybe Int,   -- ^ Arg count for lambda floating
623
                                        --   See CoreMonad.FloatOutSwitches
624

625
  historySize           :: Int,
626

627
  cmdlineHcIncludes     :: [String],    -- ^ @\-\#includes@
Ian Lynagh's avatar
Ian Lynagh committed
628 629 630
  importPaths           :: [FilePath],
  mainModIs             :: Module,
  mainFunIs             :: Maybe String,
631
  ctxtStkDepth          :: Int,         -- ^ Typechecker context stack depth
632
  tyFunStkDepth         :: Int,         -- ^ Typechecker type function stack depth
633

634
  thisPackage           :: PackageKey,   -- ^ name of package currently being compiled
635 636

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

641 642 643
  -- For object splitting
  splitInfo             :: Maybe (String,Int),

644
  -- paths etc.
Ian Lynagh's avatar
Ian Lynagh committed
645
  objectDir             :: Maybe String,
646
  dylibInstallName      :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
647 648
  hiDir                 :: Maybe String,
  stubDir               :: Maybe String,
649
  dumpDir               :: Maybe String,
650

Ian Lynagh's avatar
Ian Lynagh committed
651 652 653
  objectSuf             :: String,
  hcSuf                 :: String,
  hiSuf                 :: String,
654

655 656 657 658
  canGenerateDynamicToo :: IORef Bool,
  dynObjectSuf          :: String,
  dynHiSuf              :: String,

659 660 661 662 663 664 665 666
  -- 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
667
  outputFile            :: Maybe String,
ian@well-typed.com's avatar
ian@well-typed.com committed
668
  dynOutputFile         :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
669 670
  outputHi              :: Maybe String,
  dynLibLoader          :: DynLibLoader,
671

672
  -- | This is set by 'DriverPipeline.runPipeline' based on where
Ian Lynagh's avatar
Ian Lynagh committed
673 674
  --    its output is going.
  dumpPrefix            :: Maybe FilePath,
675

676 677
  -- | Override the 'dumpPrefix' set by 'DriverPipeline.runPipeline'.
  --    Set by @-ddump-file-prefix@
Ian Lynagh's avatar
Ian Lynagh committed
678 679
  dumpPrefixForce       :: Maybe FilePath,

680
  ldInputs              :: [Option],
681

Ian Lynagh's avatar
Ian Lynagh committed
682 683 684 685 686
  includePaths          :: [String],
  libraryPaths          :: [String],
  frameworkPaths        :: [String],    -- used on darwin only
  cmdlineFrameworks     :: [String],    -- ditto

687
  rtsOpts               :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
688
  rtsOptsEnabled        :: RtsOptsEnabled,
689

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

692 693 694 695
  -- Plugins
  pluginModNames        :: [ModuleName],
  pluginModNameOpts     :: [(ModuleName,String)],

696 697 698
  -- GHC API hooks
  hooks                 :: Hooks,

699 700 701 702 703 704
  --  For ghc -M
  depMakefile           :: FilePath,
  depIncludePkgDeps     :: Bool,
  depExcludeMods        :: [ModuleName],
  depSuffixes           :: [String],

705
  --  Package flags
706
  extraPkgConfs         :: [PkgConfRef] -> [PkgConfRef],
707
        -- ^ The @-package-db@ flags given on the command line, in the order
Ian Lynagh's avatar
Ian Lynagh committed
708
        -- they appeared.
709

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

713
  -- Package state
Ian Lynagh's avatar
Ian Lynagh committed
714
  -- NB. do not modify this field, it is calculated by
715
  -- Packages.initPackages and Packages.updatePackages.
716
  pkgDatabase           :: Maybe [PackageConfig],
Ian Lynagh's avatar
Ian Lynagh committed
717
  pkgState              :: PackageState,
718

719 720 721 722
  -- Temporary files
  -- These have to be IORefs, because the defaultCleanupHandler needs to
  -- know what to clean when an exception happens
  filesToClean          :: IORef [FilePath],
723
  dirsToClean           :: IORef (Map FilePath FilePath),
724
  filesToNotIntermediateClean :: IORef [FilePath],
725 726
  -- The next available suffix to uniquely name a temp file, updated atomically
  nextTempSuffix        :: IORef Int,
727

728 729 730 731 732
  -- 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),

733
  -- hsc dynamic flags
734 735
  dumpFlags             :: IntSet,
  generalFlags          :: IntSet,
736
  warningFlags          :: IntSet,
737
  -- Don't change this without updating extensionFlags:
738
  language              :: Maybe Language,
739 740
  -- | Safe Haskell mode
  safeHaskell           :: SafeHaskellMode,
741 742
  safeInfer             :: Bool,
  safeInferred          :: Bool,
743 744 745
  -- 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.
746 747
  thOnLoc               :: SrcSpan,
  newDerivOnLoc         :: SrcSpan,
748
  overlapInstLoc        :: SrcSpan,
749
  pkgTrustOnLoc         :: SrcSpan,
750 751
  warnSafeOnLoc         :: SrcSpan,
  warnUnsafeOnLoc       :: SrcSpan,
752 753 754 755
  -- Don't change this without updating extensionFlags:
  extensions            :: [OnOff ExtensionFlag],
  -- extensionFlags should always be equal to
  --     flattenExtensionFlags language extensions
756
  extensionFlags        :: IntSet,
Ian Lynagh's avatar
Ian Lynagh committed
757

758 759 760 761 762 763 764 765 766
  -- Unfolding control
  -- See Note [Discounts and thresholds] in CoreUnfold
  ufCreationThreshold   :: Int,
  ufUseThreshold        :: Int,
  ufFunAppDiscount      :: Int,
  ufDictDiscount        :: Int,
  ufKeenessFactor       :: Float,
  ufDearOp              :: Int,

767 768
  maxWorkerArgs         :: Int,

769 770
  ghciHistSize          :: Int,

771
  -- | MsgDoc output action: use "ErrUtils" instead of this if you can
772
  log_action            :: LogAction,
773 774
  flushOut              :: FlushOut,
  flushErr              :: FlushErr,
David Waern's avatar
David Waern committed
775

776
  haddockOptions        :: Maybe String,
777
  ghciScripts           :: [String],
778

779 780
  -- Output style options
  pprUserLength         :: Int,
Ian Lynagh's avatar
Ian Lynagh committed
781
  pprCols               :: Int,
Ian Lynagh's avatar
Ian Lynagh committed
782
  traceLevel            :: Int, -- Standard level is 1. Less verbose is 0.
Simon Marlow's avatar