DynFlags.hs 151 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
        -- * SSE and AVX
132 133
        isSse2Enabled,
        isSse4_2Enabled,
134 135
        isAvxEnabled,
        isAvx2Enabled,
136 137 138 139
        isAvx512cdEnabled,
        isAvx512erEnabled,
        isAvx512fEnabled,
        isAvx512pfEnabled,
140 141 142

        -- * Linker information
        LinkerInfo(..),
143 144 145 146
  ) where

#include "HsVersions.h"

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

171
import System.IO.Unsafe ( unsafePerformIO )
172
import Data.IORef
ian@well-typed.com's avatar
ian@well-typed.com committed
173
import Control.Monad
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
174

175
import Data.Bits
176
import Data.Char
177
import Data.Int
178
import Data.List
179 180
import Data.Map (Map)
import qualified Data.Map as Map
181
import Data.Maybe
182 183
import Data.Set (Set)
import qualified Data.Set as Set
184
import Data.Word
Ian Lynagh's avatar
Ian Lynagh committed
185
import System.FilePath
186
import System.IO
187
import System.IO.Error
188

189 190 191
import Data.IntSet (IntSet)
import qualified Data.IntSet as IntSet

192 193
import GHC.Foreign (withCString, peekCString)

194 195 196
-- -----------------------------------------------------------------------------
-- DynFlags

197
data DumpFlag
198 199 200

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

Ian Lynagh's avatar
Ian Lynagh committed
282
   | Opt_WarnIsError                    -- -Werror; makes warnings fatal
283

284 285
   | Opt_PrintExplicitForalls

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

323 324 325 326 327
   -- Interface files
   | Opt_IgnoreInterfacePragmas
   | Opt_OmitInterfacePragmas
   | Opt_ExposeAllUnfoldings

Ian Lynagh's avatar
Ian Lynagh committed
328 329
   -- profiling opts
   | Opt_AutoSccsOnIndividualCafs
330
   | Opt_ProfCountEntries
Ian Lynagh's avatar
Ian Lynagh committed
331

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

373 374 375 376
   -- PreInlining is on by default. The option is there just to see how
   -- bad things get if you turn it off!
   | Opt_SimplPreInlining

377
   -- output style opts
378 379
   | Opt_ErrorSpans -- Include full span info in error messages,
                    -- instead of just the start position.
380
   | Opt_PprCaseAsLet
381

382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398
   -- 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

399
   -- temporary flags
400
   | Opt_RunCPS
401
   | Opt_RunCPSZ
402
   | Opt_AutoLinkPackages
403
   | Opt_ImplicitImportQualified
404 405 406 407 408 409

   -- keeping stuff
   | Opt_KeepHiDiffs
   | Opt_KeepHcFiles
   | Opt_KeepSFiles
   | Opt_KeepTmpFiles
Jedai's avatar
Jedai committed
410
   | Opt_KeepRawTokenStream
411
   | Opt_KeepLlvmFiles
412

413 414
   | Opt_BuildDynamicToo

415
   -- safe haskell flags
dterei's avatar
dterei committed
416
   | Opt_DistrustAllPackages
417 418
   | Opt_PackageTrust

419
   deriving (Eq, Show, Enum)
Ian Lynagh's avatar
Ian Lynagh committed
420

421 422
data WarningFlag =
     Opt_WarnDuplicateExports
423
   | Opt_WarnDuplicateConstraints
424 425 426 427 428
   | Opt_WarnHiShadows
   | Opt_WarnImplicitPrelude
   | Opt_WarnIncompletePatterns
   | Opt_WarnIncompleteUniPatterns
   | Opt_WarnIncompletePatternsRecUpd
429
   | Opt_WarnOverflowedLiterals
430
   | Opt_WarnEmptyEnumerations
431 432 433 434 435 436 437 438 439 440 441 442 443 444
   | 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
445
   | Opt_WarnAMP
446 447 448 449 450 451 452 453 454 455 456 457
   | Opt_WarnDodgyExports
   | Opt_WarnDodgyImports
   | Opt_WarnOrphans
   | Opt_WarnAutoOrphans
   | Opt_WarnIdentities
   | Opt_WarnTabs
   | Opt_WarnUnrecognisedPragmas
   | Opt_WarnDodgyForeignImports
   | Opt_WarnLazyUnliftedBindings
   | Opt_WarnUnusedDoBind
   | Opt_WarnWrongDoBind
   | Opt_WarnAlternativeLayoutRuleTransitional
458 459
   | Opt_WarnUnsafe
   | Opt_WarnSafe
Ian Lynagh's avatar
Ian Lynagh committed
460
   | Opt_WarnPointlessPragmas
461
   | Opt_WarnUnsupportedCallingConventions
462
   | Opt_WarnUnsupportedLlvmVersion
463
   | Opt_WarnInlineRuleShadowing
464
   deriving (Eq, Show, Enum)
465

466
data Language = Haskell98 | Haskell2010
467
   deriving Enum
468

469
-- | The various Safe Haskell modes
470 471
data SafeHaskellMode
   = Sf_None
dterei's avatar
dterei committed
472
   | Sf_Unsafe
473 474
   | Sf_Trustworthy
   | Sf_Safe
475
   | Sf_SafeInferred
476 477
   deriving (Eq)

Ian Lynagh's avatar
Ian Lynagh committed
478
instance Show SafeHaskellMode where
Ian Lynagh's avatar
Ian Lynagh committed
479 480 481 482 483
    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
484

485
instance Outputable SafeHaskellMode where
Ian Lynagh's avatar
Ian Lynagh committed
486
    ppr = text . show
487

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

532 533
   | Opt_StandaloneDeriving
   | Opt_DeriveDataTypeable
534
   | Opt_AutoDeriveTypeable       -- Automatic derivation of Typeable
535 536 537
   | Opt_DeriveFunctor
   | Opt_DeriveTraversable
   | Opt_DeriveFoldable
538
   | Opt_DeriveGeneric            -- Allow deriving Generic/1
dreixel's avatar
dreixel committed
539
   | Opt_DefaultSignatures        -- Allow extra signatures for defmeths
540 541 542 543 544 545

   | Opt_TypeSynonymInstances
   | Opt_FlexibleContexts
   | Opt_FlexibleInstances
   | Opt_ConstrainedClassMethods
   | Opt_MultiParamTypeClasses
546
   | Opt_NullaryTypeClasses
547 548 549 550 551 552
   | Opt_FunctionalDependencies
   | Opt_UnicodeSyntax
   | Opt_ExistentialQuantification
   | Opt_MagicHash
   | Opt_EmptyDataDecls
   | Opt_KindSignatures
553
   | Opt_RoleAnnotations
554 555
   | Opt_ParallelListComp
   | Opt_TransformListComp
556
   | Opt_MonadComprehensions
557 558 559 560 561 562 563 564 565
   | Opt_GeneralizedNewtypeDeriving
   | Opt_RecursiveDo
   | Opt_PostfixOperators
   | Opt_TupleSections
   | Opt_PatternGuards
   | Opt_LiberalTypeSynonyms
   | Opt_RankNTypes
   | Opt_ImpredicativeTypes
   | Opt_TypeOperators
566
   | Opt_ExplicitNamespaces
567 568 569 570 571
   | Opt_PackageImports
   | Opt_ExplicitForAll
   | Opt_AlternativeLayoutRule
   | Opt_AlternativeLayoutRuleTransitional
   | Opt_DatatypeContexts
572
   | Opt_NondecreasingIndentation
573
   | Opt_RelaxedLayout
574
   | Opt_TraditionalRecordSyntax
575
   | Opt_LambdaCase
576
   | Opt_MultiWayIf
577
   | Opt_TypeHoles
578
   | Opt_NegativeLiterals
579
   | Opt_EmptyCase
580
   deriving (Eq, Enum, Show)
581

582
-- | Contains not only a collection of 'GeneralFlag's but also a plethora of
583
-- information relating to the compilation of a single file or GHC session
584
data DynFlags = DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
585 586 587
  ghcMode               :: GhcMode,
  ghcLink               :: GhcLink,
  hscTarget             :: HscTarget,
588
  settings              :: Settings,
589
  verbosity             :: Int,         -- ^ Verbosity level: see Note [Verbosity levels]
590 591 592
  optLevel              :: Int,         -- ^ Optimisation level
  simplPhases           :: Int,         -- ^ Number of simplifier phases
  maxSimplIterations    :: Int,         -- ^ Max simplifier iterations
593
  shouldDumpSimplPhase  :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
594
  ruleCheck             :: Maybe String,
595
  strictnessBefore      :: [Int],       -- ^ Additional demand analysis
596

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

601 602
  maxRelevantBinds      :: Maybe Int,   -- ^ Maximum number of bindings from the type envt
                                        --   to show in type error messages
603
  simplTickFactor       :: Int,         -- ^ Multiplier for simplifier ticks
604 605
  specConstrThreshold   :: Maybe Int,   -- ^ Threshold for SpecConstr
  specConstrCount       :: Maybe Int,   -- ^ Max number of specialisations for any one function
606 607
  specConstrRecursive   :: Int,         -- ^ Max number of specialisations for recursive types
                                        --   Not optional; otherwise ForceSpecConstr can diverge.
608
  liberateCaseThreshold :: Maybe Int,   -- ^ Threshold for LiberateCase
609
  floatLamArgs          :: Maybe Int,   -- ^ Arg count for lambda floating
610
                                        --   See CoreMonad.FloatOutSwitches
611

612
  historySize           :: Int,
613

614
  cmdlineHcIncludes     :: [String],    -- ^ @\-\#includes@
Ian Lynagh's avatar
Ian Lynagh committed
615 616 617
  importPaths           :: [FilePath],
  mainModIs             :: Module,
  mainFunIs             :: Maybe String,
618
  ctxtStkDepth          :: Int,         -- ^ Typechecker context stack depth
619

620
  thisPackage           :: PackageId,   -- ^ name of package currently being compiled
621 622

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

627 628 629
  -- For object splitting
  splitInfo             :: Maybe (String,Int),

630
  -- paths etc.
Ian Lynagh's avatar
Ian Lynagh committed
631
  objectDir             :: Maybe String,
632
  dylibInstallName      :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
633 634
  hiDir                 :: Maybe String,
  stubDir               :: Maybe String,
635
  dumpDir               :: Maybe String,
636

Ian Lynagh's avatar
Ian Lynagh committed
637 638 639
  objectSuf             :: String,
  hcSuf                 :: String,
  hiSuf                 :: String,
640

641 642 643 644
  canGenerateDynamicToo :: IORef Bool,
  dynObjectSuf          :: String,
  dynHiSuf              :: String,

645 646 647 648 649 650 651 652
  -- 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
653
  outputFile            :: Maybe String,
ian@well-typed.com's avatar
ian@well-typed.com committed
654
  dynOutputFile         :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
655 656
  outputHi              :: Maybe String,
  dynLibLoader          :: DynLibLoader,
657

658
  -- | This is set by 'DriverPipeline.runPipeline' based on where
Ian Lynagh's avatar
Ian Lynagh committed
659 660
  --    its output is going.
  dumpPrefix            :: Maybe FilePath,
661

662 663
  -- | Override the 'dumpPrefix' set by 'DriverPipeline.runPipeline'.
  --    Set by @-ddump-file-prefix@
Ian Lynagh's avatar
Ian Lynagh committed
664 665
  dumpPrefixForce       :: Maybe FilePath,

666
  ldInputs              :: [Option],
667

Ian Lynagh's avatar
Ian Lynagh committed
668 669 670 671 672
  includePaths          :: [String],
  libraryPaths          :: [String],
  frameworkPaths        :: [String],    -- used on darwin only
  cmdlineFrameworks     :: [String],    -- ditto

673
  rtsOpts               :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
674
  rtsOptsEnabled        :: RtsOptsEnabled,
675

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

678 679 680 681
  -- Plugins
  pluginModNames        :: [ModuleName],
  pluginModNameOpts     :: [(ModuleName,String)],

682 683 684
  -- GHC API hooks
  hooks                 :: Hooks,

685 686 687 688 689 690
  --  For ghc -M
  depMakefile           :: FilePath,
  depIncludePkgDeps     :: Bool,
  depExcludeMods        :: [ModuleName],
  depSuffixes           :: [String],

691
  --  Package flags
692
  extraPkgConfs         :: [PkgConfRef] -> [PkgConfRef],
693
        -- ^ The @-package-db@ flags given on the command line, in the order
Ian Lynagh's avatar
Ian Lynagh committed
694
        -- they appeared.
695

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

699
  -- Package state
Ian Lynagh's avatar
Ian Lynagh committed
700
  -- NB. do not modify this field, it is calculated by
701
  -- Packages.initPackages and Packages.updatePackages.
702
  pkgDatabase           :: Maybe [PackageConfig],
Ian Lynagh's avatar
Ian Lynagh committed
703
  pkgState              :: PackageState,
704

705 706 707 708
  -- Temporary files
  -- These have to be IORefs, because the defaultCleanupHandler needs to
  -- know what to clean when an exception happens
  filesToClean          :: IORef [FilePath],
709
  dirsToClean           :: IORef (Map FilePath FilePath),
710
  filesToNotIntermediateClean :: IORef [FilePath],
711 712
  -- The next available suffix to uniquely name a temp file, updated atomically
  nextTempSuffix        :: IORef Int,
713

714 715 716 717 718
  -- 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),

719
  -- hsc dynamic flags
720 721
  dumpFlags             :: IntSet,
  generalFlags          :: IntSet,
722
  warningFlags          :: IntSet,
723
  -- Don't change this without updating extensionFlags:
724
  language              :: Maybe Language,
725 726
  -- | Safe Haskell mode
  safeHaskell           :: SafeHaskellMode,
727 728 729
  -- 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.
730 731
  thOnLoc               :: SrcSpan,
  newDerivOnLoc         :: SrcSpan,
732
  pkgTrustOnLoc         :: SrcSpan,
733 734
  warnSafeOnLoc         :: SrcSpan,
  warnUnsafeOnLoc       :: SrcSpan,
735 736 737 738
  -- Don't change this without updating extensionFlags:
  extensions            :: [OnOff ExtensionFlag],
  -- extensionFlags should always be equal to
  --     flattenExtensionFlags language extensions
739
  extensionFlags        :: IntSet,
Ian Lynagh's avatar
Ian Lynagh committed
740

741 742 743 744 745 746 747 748 749
  -- Unfolding control
  -- See Note [Discounts and thresholds] in CoreUnfold
  ufCreationThreshold   :: Int,
  ufUseThreshold        :: Int,
  ufFunAppDiscount      :: Int,
  ufDictDiscount        :: Int,
  ufKeenessFactor       :: Float,
  ufDearOp              :: Int,

750 751
  maxWorkerArgs         :: Int,

752 753
  ghciHistSize          :: Int,

754
  -- | MsgDoc output action: use "ErrUtils" instead of this if you can
755
  log_action            :: LogAction,
756 757
  flushOut              :: FlushOut,
  flushErr              :: FlushErr,
David Waern's avatar
David Waern committed
758

759
  haddockOptions        :: Maybe String,
760
  ghciScripts           :: [String],
761

762 763
  -- Output style options
  pprUserLength         :: Int,
Ian Lynagh's avatar
Ian Lynagh committed
764
  pprCols               :: Int,
Ian Lynagh's avatar
Ian Lynagh committed
765
  traceLevel            :: Int, -- Standard level is 1. Less verbose is 0.
766

767 768
  useUnicodeQuotes      :: Bool,

769
  -- | what kind of {-# SCC #-} to add automatically
770 771
  profAuto              :: ProfAuto,

772
  interactivePrint      :: Maybe String,
773

774
  llvmVersion           :: IORef Int,
775

776
  nextWrapperNum        :: IORef (ModuleEnv Int),
tibbe's avatar
tibbe committed
777 778

  -- | Machine dependant flags (-m<blah> stuff)
779
  sseVersion            :: Maybe (Int, Int),  -- (major, minor)
780 781
  avx                   :: Bool,
  avx2                  :: Bool,
782 783 784 785
  avx512cd              :: Bool, -- Enable AVX-512 Conflict Detection Instructions.
  avx512er              :: Bool, -- Enable AVX-512 Exponential and Reciprocal Instructions.
  avx512f               :: Bool, -- Enable AVX-512 instructions.
  avx512pf              :: Bool, -- Enable AVX-512 PreFetch Instructions.
786 787 788

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

791 792 793
class HasDynFlags m where
    getDynFlags :: m DynFlags

Ian Lynagh's avatar
Ian Lynagh committed
794 795
class ContainsDynFlags t where
    extractDynFlags :: t -> DynFlags
796
    replaceDynFlags :: t -> DynFlags -> t
Ian Lynagh's avatar
Ian Lynagh committed
797

798 799 800 801