DynFlags.hs 155 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
117
        rtsIsProfiled,
118
#endif
119
        dynamicGhc,
120 121

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

128 129
        unsafeGlobalDynFlags, setUnsafeGlobalDynFlags,

130
        -- * SSE and AVX
131
        isSseEnabled,
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(..) )
168
import System.IO.Unsafe ( unsafeDupablePerformIO )
Ian Lynagh's avatar
Ian Lynagh committed
169
#endif
170
import {-# SOURCE #-} ErrUtils ( Severity(..), MsgDoc, mkLocMessage )
171

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

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

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

193 194
import GHC.Foreign (withCString, peekCString)

195 196 197
-- -----------------------------------------------------------------------------
-- DynFlags

198
data DumpFlag
199 200 201

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

Ian Lynagh's avatar
Ian Lynagh committed
284
   | Opt_WarnIsError                    -- -Werror; makes warnings fatal
285

286
   | Opt_PrintExplicitForalls
unknown's avatar
unknown committed
287
   | Opt_PrintExplicitKinds
288

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

326 327 328 329 330
   -- Interface files
   | Opt_IgnoreInterfacePragmas
   | Opt_OmitInterfacePragmas
   | Opt_ExposeAllUnfoldings

Ian Lynagh's avatar
Ian Lynagh committed
331 332
   -- profiling opts
   | Opt_AutoSccsOnIndividualCafs
333
   | Opt_ProfCountEntries
Ian Lynagh's avatar
Ian Lynagh committed
334

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

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

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

385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401
   -- 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

402
   -- temporary flags
403
   | Opt_RunCPS
404
   | Opt_RunCPSZ
405
   | Opt_AutoLinkPackages
406
   | Opt_ImplicitImportQualified
407 408 409 410 411 412

   -- keeping stuff
   | Opt_KeepHiDiffs
   | Opt_KeepHcFiles
   | Opt_KeepSFiles
   | Opt_KeepTmpFiles
Jedai's avatar
Jedai committed
413
   | Opt_KeepRawTokenStream
414
   | Opt_KeepLlvmFiles
415

416 417
   | Opt_BuildDynamicToo

418
   -- safe haskell flags
dterei's avatar
dterei committed
419
   | Opt_DistrustAllPackages
420 421
   | Opt_PackageTrust

422
   deriving (Eq, Show, Enum)
Ian Lynagh's avatar
Ian Lynagh committed
423

424 425
data WarningFlag =
     Opt_WarnDuplicateExports
426
   | Opt_WarnDuplicateConstraints
427 428 429 430 431
   | Opt_WarnHiShadows
   | Opt_WarnImplicitPrelude
   | Opt_WarnIncompletePatterns
   | Opt_WarnIncompleteUniPatterns
   | Opt_WarnIncompletePatternsRecUpd
432
   | Opt_WarnOverflowedLiterals
433
   | Opt_WarnEmptyEnumerations
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
448
   | Opt_WarnAMP
449 450 451 452 453 454 455 456 457 458 459 460
   | Opt_WarnDodgyExports
   | Opt_WarnDodgyImports
   | Opt_WarnOrphans
   | Opt_WarnAutoOrphans
   | Opt_WarnIdentities
   | Opt_WarnTabs
   | Opt_WarnUnrecognisedPragmas
   | Opt_WarnDodgyForeignImports
   | Opt_WarnLazyUnliftedBindings
   | Opt_WarnUnusedDoBind
   | Opt_WarnWrongDoBind
   | Opt_WarnAlternativeLayoutRuleTransitional
461 462
   | Opt_WarnUnsafe
   | Opt_WarnSafe
Ian Lynagh's avatar
Ian Lynagh committed
463
   | Opt_WarnPointlessPragmas
464
   | Opt_WarnUnsupportedCallingConventions
465
   | Opt_WarnUnsupportedLlvmVersion
466
   | Opt_WarnInlineRuleShadowing
467
   | Opt_WarnTypeHoles
468
   deriving (Eq, Show, Enum)
469

470
data Language = Haskell98 | Haskell2010
471
   deriving Enum
472

473
-- | The various Safe Haskell modes
474 475
data SafeHaskellMode
   = Sf_None
dterei's avatar
dterei committed
476
   | Sf_Unsafe
477 478
   | Sf_Trustworthy
   | Sf_Safe
479
   | Sf_SafeInferred
480 481
   deriving (Eq)

Ian Lynagh's avatar
Ian Lynagh committed
482
instance Show SafeHaskellMode where
Ian Lynagh's avatar
Ian Lynagh committed
483 484 485 486 487
    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
488

489
instance Outputable SafeHaskellMode where
Ian Lynagh's avatar
Ian Lynagh committed
490
    ppr = text . show
491

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

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

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

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

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

604 605 606
  enableTimeStats       :: Bool,        -- ^ Enable RTS timing statistics?
  ghcHeapSize           :: Maybe Int,   -- ^ The heap size to set.

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

618
  historySize           :: Int,
619

620
  cmdlineHcIncludes     :: [String],    -- ^ @\-\#includes@
Ian Lynagh's avatar
Ian Lynagh committed
621 622 623
  importPaths           :: [FilePath],
  mainModIs             :: Module,
  mainFunIs             :: Maybe String,
624
  ctxtStkDepth          :: Int,         -- ^ Typechecker context stack depth
625
  tyFunStkDepth         :: Int,         -- ^ Typechecker type function stack depth
626

627
  thisPackage           :: PackageId,   -- ^ name of package currently being compiled
628 629

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

634 635 636
  -- For object splitting
  splitInfo             :: Maybe (String,Int),

637
  -- paths etc.
Ian Lynagh's avatar
Ian Lynagh committed
638
  objectDir             :: Maybe String,
639
  dylibInstallName      :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
640 641
  hiDir                 :: Maybe String,
  stubDir               :: Maybe String,
642
  dumpDir               :: Maybe String,
643

Ian Lynagh's avatar
Ian Lynagh committed
644 645 646
  objectSuf             :: String,
  hcSuf                 :: String,
  hiSuf                 :: String,
647

648 649 650 651
  canGenerateDynamicToo :: IORef Bool,
  dynObjectSuf          :: String,
  dynHiSuf              :: String,

652 653 654 655 656 657 658 659
  -- 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
660
  outputFile            :: Maybe String,
ian@well-typed.com's avatar
ian@well-typed.com committed
661
  dynOutputFile         :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
662 663
  outputHi              :: Maybe String,
  dynLibLoader          :: DynLibLoader,
664

665
  -- | This is set by 'DriverPipeline.runPipeline' based on where
Ian Lynagh's avatar
Ian Lynagh committed
666 667
  --    its output is going.
  dumpPrefix            :: Maybe FilePath,
668

669 670
  -- | Override the 'dumpPrefix' set by 'DriverPipeline.runPipeline'.
  --    Set by @-ddump-file-prefix@
Ian Lynagh's avatar
Ian Lynagh committed
671 672
  dumpPrefixForce       :: Maybe FilePath,

673
  ldInputs              :: [Option],
674

Ian Lynagh's avatar
Ian Lynagh committed
675 676 677 678 679
  includePaths          :: [String],
  libraryPaths          :: [String],
  frameworkPaths        :: [String],    -- used on darwin only
  cmdlineFrameworks     :: [String],    -- ditto

680
  rtsOpts               :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
681
  rtsOptsEnabled        :: RtsOptsEnabled,
682

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

685 686 687 688
  -- Plugins
  pluginModNames        :: [ModuleName],
  pluginModNameOpts     :: [(ModuleName,String)],

689 690 691
  -- GHC API hooks
  hooks                 :: Hooks,

692 693 694 695 696 697
  --  For ghc -M
  depMakefile           :: FilePath,
  depIncludePkgDeps     :: Bool,
  depExcludeMods        :: [ModuleName],
  depSuffixes           :: [String],

698
  --  Package flags
699
  extraPkgConfs         :: [PkgConfRef] -> [PkgConfRef],
700
        -- ^ The @-package-db@ flags given on the command line, in the order
Ian Lynagh's avatar
Ian Lynagh committed
701
        -- they appeared.
702

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

706
  -- Package state
Ian Lynagh's avatar
Ian Lynagh committed
707
  -- NB. do not modify this field, it is calculated by
708
  -- Packages.initPackages and Packages.updatePackages.
709
  pkgDatabase           :: Maybe [PackageConfig],
Ian Lynagh's avatar
Ian Lynagh committed
710
  pkgState              :: PackageState,
711

712 713 714 715
  -- Temporary files
  -- These have to be IORefs, because the defaultCleanupHandler needs to
  -- know what to clean when an exception happens
  filesToClean          :: IORef [FilePath],
716
  dirsToClean           :: IORef (Map FilePath FilePath),
717
  filesToNotIntermediateClean :: IORef [FilePath],
718 719
  -- The next available suffix to uniquely name a temp file, updated atomically
  nextTempSuffix        :: IORef Int,
720

721 722 723 724 725
  -- 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),

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

748 749 750 751 752 753 754 755 756
  -- Unfolding control
  -- See Note [Discounts and thresholds] in CoreUnfold
  ufCreationThreshold   :: Int,
  ufUseThreshold        :: Int,
  ufFunAppDiscount      :: Int,
  ufDictDiscount        :: Int,
  ufKeenessFactor       :: Float,
  ufDearOp              :: Int,

757 758
  maxWorkerArgs         :: Int,

759 760
  ghciHistSize          :: Int,

761
  -- | MsgDoc output action: use "ErrUtils" instead of this if you can
762
  log_action            :: LogAction,
763 764
  flushOut              :: FlushOut,
  flushErr              :: FlushErr,
David Waern's avatar
David Waern committed
765

766
  haddockOptions        :: Maybe String,
767
  ghciScripts           :: [String],
768

769 770
  -- Output style options
  pprUserLength         :: Int,
Ian Lynagh's avatar
Ian Lynagh committed
771
  pprCols               :: Int,
Ian Lynagh's avatar
Ian Lynagh committed
772
  traceLevel            :: Int, -- Standard level is 1. Less verbose is 0.
773

774 775
  useUnicodeQuotes      :: Bool,

776
  -- | what kind of {-# SCC #-} to add automatically
777 778
  profAuto              :: ProfAuto,

779
  interactivePrint      :: Maybe String,
780

781
  llvmVersion           :: IORef Int,
782

783
  nextWrapperNum        :: IORef (ModuleEnv Int),
tibbe's avatar
tibbe committed
784 785

  -- | Machine dependant flags (-m<blah> stuff)
786
  sseVersion            :: Maybe (Int, Int),  -- (major, minor)
787 788
  avx                   :: Bool,
  avx2                  :: Bool,
789 790 791 792
  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.
793 794 795

  -- | Run-time linker information (what options we need, etc.)