DynFlags.hs 156 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

Austin Seipp's avatar
Austin Seipp committed
141
        -- * Linker/compiler information
142
        LinkerInfo(..),
Austin Seipp's avatar
Austin Seipp committed
143
        CompilerInfo(..),
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(..) )
169
import System.IO.Unsafe ( unsafeDupablePerformIO )
Ian Lynagh's avatar
Ian Lynagh committed
170
#endif
171
import {-# SOURCE #-} ErrUtils ( Severity(..), MsgDoc, mkLocMessage )
172

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

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

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

194 195
import GHC.Foreign (withCString, peekCString)

196 197 198
-- -----------------------------------------------------------------------------
-- DynFlags

199
data DumpFlag
200 201 202

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

Ian Lynagh's avatar
Ian Lynagh committed
286
   | Opt_WarnIsError                    -- -Werror; makes warnings fatal
287

288
   | Opt_PrintExplicitForalls
unknown's avatar
unknown committed
289
   | Opt_PrintExplicitKinds
290

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

329 330 331 332 333
   -- Interface files
   | Opt_IgnoreInterfacePragmas
   | Opt_OmitInterfacePragmas
   | Opt_ExposeAllUnfoldings

Ian Lynagh's avatar
Ian Lynagh committed
334 335
   -- profiling opts
   | Opt_AutoSccsOnIndividualCafs
336
   | Opt_ProfCountEntries
Ian Lynagh's avatar
Ian Lynagh committed
337

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

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

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

388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404
   -- 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

405
   -- temporary flags
406
   | Opt_RunCPS
407
   | Opt_RunCPSZ
408
   | Opt_AutoLinkPackages
409
   | Opt_ImplicitImportQualified
410 411 412 413 414 415

   -- keeping stuff
   | Opt_KeepHiDiffs
   | Opt_KeepHcFiles
   | Opt_KeepSFiles
   | Opt_KeepTmpFiles
Jedai's avatar
Jedai committed
416
   | Opt_KeepRawTokenStream
417
   | Opt_KeepLlvmFiles
418

419 420
   | Opt_BuildDynamicToo

421
   -- safe haskell flags
dterei's avatar
dterei committed
422
   | Opt_DistrustAllPackages
423 424
   | Opt_PackageTrust

425
   deriving (Eq, Show, Enum)
Ian Lynagh's avatar
Ian Lynagh committed
426

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

472
data Language = Haskell98 | Haskell2010
473
   deriving Enum
474

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

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

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

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

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

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

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

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

607 608 609
  enableTimeStats       :: Bool,        -- ^ Enable RTS timing statistics?
  ghcHeapSize           :: Maybe Int,   -- ^ The heap size to set.

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

621
  historySize           :: Int,
622

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

630
  thisPackage           :: PackageId,   -- ^ name of package currently being compiled
631 632

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

637 638 639
  -- For object splitting
  splitInfo             :: Maybe (String,Int),

640
  -- paths etc.
Ian Lynagh's avatar
Ian Lynagh committed
641
  objectDir             :: Maybe String,
642
  dylibInstallName      :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
643 644
  hiDir                 :: Maybe String,
  stubDir               :: Maybe String,
645
  dumpDir               :: Maybe String,
646

Ian Lynagh's avatar
Ian Lynagh committed
647 648 649
  objectSuf             :: String,
  hcSuf                 :: String,
  hiSuf                 :: String,
650

651 652 653 654
  canGenerateDynamicToo :: IORef Bool,
  dynObjectSuf          :: String,
  dynHiSuf              :: String,

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

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

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

676
  ldInputs              :: [Option],
677

Ian Lynagh's avatar
Ian Lynagh committed
678 679 680 681 682
  includePaths          :: [String],
  libraryPaths          :: [String],
  frameworkPaths        :: [String],    -- used on darwin only
  cmdlineFrameworks     :: [String],    -- ditto

683
  rtsOpts               :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
684
  rtsOptsEnabled        :: RtsOptsEnabled,
685

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

688 689 690 691
  -- Plugins
  pluginModNames        :: [ModuleName],
  pluginModNameOpts     :: [(ModuleName,String)],

692 693 694
  -- GHC API hooks
  hooks                 :: Hooks,

695 696 697 698 699 700
  --  For ghc -M
  depMakefile           :: FilePath,
  depIncludePkgDeps     :: Bool,
  depExcludeMods        :: [ModuleName],
  depSuffixes           :: [String],

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

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

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

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

724 725 726 727 728
  -- 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),

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

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

760 761
  maxWorkerArgs         :: Int,

762 763
  ghciHistSize          :: Int,

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

769
  haddockOptions        :: Maybe String,
770
  ghciScripts           :: [String],
771

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

777 778
  useUnicodeQuotes      :: Bool,

779
  -- | what kind of {-# SCC #-} to add automatically
780 781
  profAuto              :: ProfAuto,

782
  interactivePrint      :: Maybe String,
783

784
  llvmVersion           :: IORef Int,
785