DynFlags.hs 153 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
        isSseEnabled,
133 134
        isSse2Enabled,
        isSse4_2Enabled,
135 136
        isAvxEnabled,
        isAvx2Enabled,
137 138 139 140
        isAvx512cdEnabled,
        isAvx512erEnabled,
        isAvx512fEnabled,
        isAvx512pfEnabled,
141 142 143

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

#include "HsVersions.h"

148
import Platform
149
import PlatformConstants
150
import Module
Simon Marlow's avatar
Simon Marlow committed
151
import PackageConfig
152
import {-# SOURCE #-} Hooks
153
import {-# SOURCE #-} PrelNames ( mAIN )
154
import {-# SOURCE #-} Packages (PackageState)
Ian Lynagh's avatar
Ian Lynagh committed
155
import DriverPhases     ( Phase(..), phaseInputExt )
156 157
import Config
import CmdLineParser
158
import Constants
159
import Panic
160
import Util
161
import Maybes           ( orElse )
162
import MonadUtils
163
import qualified Pretty
164
import SrcLoc
165
import FastString
Simon Marlow's avatar
Simon Marlow committed
166
import Outputable
Ian Lynagh's avatar
Ian Lynagh committed
167
#ifdef GHCI
Ian Lynagh's avatar
Ian Lynagh committed
168
import Foreign.C        ( CInt(..) )
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 243 244 245 246 247 248 249 250 251
   | 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
252
   | Opt_D_dump_cs_trace -- Constraint solver in type checker
253 254
   | Opt_D_dump_tc_trace
   | Opt_D_dump_if_trace
255
   | Opt_D_dump_vt_trace
256 257 258
   | Opt_D_dump_splices
   | Opt_D_dump_BCOs
   | Opt_D_dump_vect
259
   | Opt_D_dump_ticked
pepe's avatar
pepe committed
260
   | Opt_D_dump_rtti
261 262 263 264
   | Opt_D_source_stats
   | Opt_D_verbose_stg2stg
   | Opt_D_dump_hi
   | Opt_D_dump_hi_diffs
265
   | Opt_D_dump_mod_cycles
266
   | Opt_D_dump_view_pattern_commoning
267 268 269 270 271 272 273 274
   | 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.
275
   | Opt_D_faststring_stats
276
   | Opt_D_dump_minimal_imports
277 278 279
   | Opt_DoCoreLinting
   | Opt_DoStgLinting
   | Opt_DoCmmLinting
Ben.Lippmeier@anu.edu.au's avatar
Ben.Lippmeier@anu.edu.au committed
280
   | Opt_DoAsmLinting
281
   | Opt_NoLlvmMangler                 -- hidden flag
282

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

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

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

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

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

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

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

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

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

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

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

415 416
   | Opt_BuildDynamicToo

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

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

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

468
data Language = Haskell98 | Haskell2010
469
   deriving Enum
470

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

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

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

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

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

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

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

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

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

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

617
  historySize           :: Int,
618

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

625
  thisPackage           :: PackageId,   -- ^ name of package currently being compiled
626 627

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

632 633 634
  -- For object splitting
  splitInfo             :: Maybe (String,Int),

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

Ian Lynagh's avatar
Ian Lynagh committed
642 643 644
  objectSuf             :: String,
  hcSuf                 :: String,
  hiSuf                 :: String,
645

646 647 648 649
  canGenerateDynamicToo :: IORef Bool,
  dynObjectSuf          :: String,
  dynHiSuf              :: String,

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

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

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

671
  ldInputs              :: [Option],
672

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

678
  rtsOpts               :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
679
  rtsOptsEnabled        :: RtsOptsEnabled,
680

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

683 684 685 686
  -- Plugins
  pluginModNames        :: [ModuleName],
  pluginModNameOpts     :: [(ModuleName,String)],

687 688 689
  -- GHC API hooks
  hooks                 :: Hooks,

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

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

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

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

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

719 720 721 722 723
  -- 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),

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

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

755 756
  maxWorkerArgs         :: Int,

757 758
  ghciHistSize          :: Int,

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

764
  haddockOptions        :: Maybe String,
765
  ghciScripts           :: [String],
766

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

772 773
  useUnicodeQuotes      :: Bool,

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

777
  interactivePrint      :: Maybe String,
778

779
  llvmVersion           :: IORef Int,
780

781
  nextWrapperNum        :: IORef (ModuleEnv Int),
tibbe's avatar
tibbe committed
782 783

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

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

796 797 798
class HasDynFlags m where
    getDynFlags :: m DynFlags