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_IrrefutableTuples
313
   | Opt_CmmSink
314
   | Opt_CmmElimCommonBlocks
315
   | Opt_OmitYields
316
   | Opt_SimpleListLiterals
317
   | Opt_FunToThunk               -- allow WwLib.mkWorkerArgs to remove all value lambdas
318 319
   | Opt_DictsStrict                     -- be strict in argument dictionaries
   | Opt_DmdTxDictSel              -- use a special demand transformer for dictionary selectors
320
   | Opt_Loopification                  -- See Note [Self-recursive tail calls]
321

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

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

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

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

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

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

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

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

412 413
   | Opt_BuildDynamicToo

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

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

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

465
data Language = Haskell98 | Haskell2010
466
   deriving Enum
467

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

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

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

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

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

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

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

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

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

611
  historySize           :: Int,
612

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

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

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

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

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

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

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

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

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

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

665
  ldInputs              :: [Option],
666

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

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

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

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

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

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

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

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

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

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

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

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

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

749 750
  maxWorkerArgs         :: Int,

751 752
  ghciHistSize          :: Int,

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

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

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

766 767
  useUnicodeQuotes      :: Bool,

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

771
  interactivePrint      :: Maybe String,
772

773
  llvmVersion           :: IORef Int,
774

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

  -- | Machine dependant flags (-m<blah> stuff)
778
  sseVersion            :: Maybe (Int, Int),  -- (major, minor)
779 780
  avx                   :: Bool,
  avx2                  :: Bool,
781 782 783 784
  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.
785 786 787

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

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

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

797 798 799 800 801
data ProfAuto
  = NoProfAuto         -- ^ no SCC annotations added
  | ProfAutoAll        -- ^ top-level and nested functions are annotated
  | ProfAutoTop        -- ^ top-level functions annotated only
  | ProfAutoExports    -- ^ exported functions annotated only