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

        -- * Linker information
        LinkerInfo(..),
139 140 141 142
  ) where

#include "HsVersions.h"

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

167
import System.IO.Unsafe ( unsafePerformIO )
168
import Data.IORef
ian@well-typed.com's avatar
ian@well-typed.com committed
169
import Control.Monad
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
170

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

185 186 187
import Data.IntSet (IntSet)
import qualified Data.IntSet as IntSet

188 189
import GHC.Foreign (withCString, peekCString)

190 191 192
-- -----------------------------------------------------------------------------
-- DynFlags

193
data DumpFlag
194 195 196

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

Ian Lynagh's avatar
Ian Lynagh committed
278
   | Opt_WarnIsError                    -- -Werror; makes warnings fatal
279

280 281
   | Opt_PrintExplicitForalls

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

318 319 320 321 322
   -- Interface files
   | Opt_IgnoreInterfacePragmas
   | Opt_OmitInterfacePragmas
   | Opt_ExposeAllUnfoldings

Ian Lynagh's avatar
Ian Lynagh committed
323 324
   -- profiling opts
   | Opt_AutoSccsOnIndividualCafs
325
   | Opt_ProfCountEntries
Ian Lynagh's avatar
Ian Lynagh committed
326

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

368 369 370 371
   -- PreInlining is on by default. The option is there just to see how
   -- bad things get if you turn it off!
   | Opt_SimplPreInlining

372
   -- output style opts
373 374
   | Opt_ErrorSpans -- Include full span info in error messages,
                    -- instead of just the start position.
375
   | Opt_PprCaseAsLet
376

377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393
   -- 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

394
   -- temporary flags
395
   | Opt_RunCPS
396
   | Opt_RunCPSZ
397
   | Opt_AutoLinkPackages
398
   | Opt_ImplicitImportQualified
399 400 401 402 403 404

   -- keeping stuff
   | Opt_KeepHiDiffs
   | Opt_KeepHcFiles
   | Opt_KeepSFiles
   | Opt_KeepTmpFiles
Jedai's avatar
Jedai committed
405
   | Opt_KeepRawTokenStream
406
   | Opt_KeepLlvmFiles
407

408 409
   | Opt_BuildDynamicToo

410
   -- safe haskell flags
dterei's avatar
dterei committed
411
   | Opt_DistrustAllPackages
412 413
   | Opt_PackageTrust

414
   deriving (Eq, Show, Enum)
Ian Lynagh's avatar
Ian Lynagh committed
415

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

461
data Language = Haskell98 | Haskell2010
462
   deriving Enum
463

464
-- | The various Safe Haskell modes
465 466
data SafeHaskellMode
   = Sf_None
dterei's avatar
dterei committed
467
   | Sf_Unsafe
468 469
   | Sf_Trustworthy
   | Sf_Safe
470
   | Sf_SafeInferred
471 472
   deriving (Eq)

Ian Lynagh's avatar
Ian Lynagh committed
473
instance Show SafeHaskellMode where
Ian Lynagh's avatar
Ian Lynagh committed
474 475 476 477 478
    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
479

480
instance Outputable SafeHaskellMode where
Ian Lynagh's avatar
Ian Lynagh committed
481
    ppr = text . show
482

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

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

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

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

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

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

607
  historySize           :: Int,
608

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

615
  thisPackage           :: PackageId,   -- ^ name of package currently being compiled
616 617

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

622 623 624
  -- For object splitting
  splitInfo             :: Maybe (String,Int),

625
  -- paths etc.
Ian Lynagh's avatar
Ian Lynagh committed
626
  objectDir             :: Maybe String,
627
  dylibInstallName      :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
628 629
  hiDir                 :: Maybe String,
  stubDir               :: Maybe String,
630
  dumpDir               :: Maybe String,
631

Ian Lynagh's avatar
Ian Lynagh committed
632 633 634
  objectSuf             :: String,
  hcSuf                 :: String,
  hiSuf                 :: String,
635

636 637 638 639
  canGenerateDynamicToo :: IORef Bool,
  dynObjectSuf          :: String,
  dynHiSuf              :: String,

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

653
  -- | This is set by 'DriverPipeline.runPipeline' based on where
Ian Lynagh's avatar
Ian Lynagh committed
654 655
  --    its output is going.
  dumpPrefix            :: Maybe FilePath,
656

657 658
  -- | Override the 'dumpPrefix' set by 'DriverPipeline.runPipeline'.
  --    Set by @-ddump-file-prefix@
Ian Lynagh's avatar
Ian Lynagh committed
659 660
  dumpPrefixForce       :: Maybe FilePath,

661
  ldInputs              :: [Option],
662

Ian Lynagh's avatar
Ian Lynagh committed
663 664 665 666 667
  includePaths          :: [String],
  libraryPaths          :: [String],
  frameworkPaths        :: [String],    -- used on darwin only
  cmdlineFrameworks     :: [String],    -- ditto

668
  rtsOpts               :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
669
  rtsOptsEnabled        :: RtsOptsEnabled,
670

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

673 674 675 676
  -- Plugins
  pluginModNames        :: [ModuleName],
  pluginModNameOpts     :: [(ModuleName,String)],

677 678 679
  -- GHC API hooks
  hooks                 :: Hooks,

680 681 682 683 684 685
  --  For ghc -M
  depMakefile           :: FilePath,
  depIncludePkgDeps     :: Bool,
  depExcludeMods        :: [ModuleName],
  depSuffixes           :: [String],

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

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

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

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

709 710 711 712 713
  -- 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),

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

736 737 738 739 740 741 742 743 744
  -- Unfolding control
  -- See Note [Discounts and thresholds] in CoreUnfold
  ufCreationThreshold   :: Int,
  ufUseThreshold        :: Int,
  ufFunAppDiscount      :: Int,
  ufDictDiscount        :: Int,
  ufKeenessFactor       :: Float,
  ufDearOp              :: Int,

745 746
  maxWorkerArgs         :: Int,

747 748
  ghciHistSize          :: Int,

749
  -- | MsgDoc output action: use "ErrUtils" instead of this if you can
750
  log_action            :: LogAction,
751 752
  flushOut              :: FlushOut,
  flushErr              :: FlushErr,
David Waern's avatar
David Waern committed
753

754
  haddockOptions        :: Maybe String,
755
  ghciScripts           :: [String],
756

757 758
  -- Output style options
  pprUserLength         :: Int,
Ian Lynagh's avatar
Ian Lynagh committed
759
  pprCols               :: Int,
Ian Lynagh's avatar
Ian Lynagh committed
760
  traceLevel            :: Int, -- Standard level is 1. Less verbose is 0.
761

762 763
  useUnicodeQuotes      :: Bool,

764
  -- | what kind of {-# SCC #-} to add automatically
765 766
  profAuto              :: ProfAuto,

767
  interactivePrint      :: Maybe String,
768

769
  llvmVersion           :: IORef Int,
770

771
  nextWrapperNum        :: IORef (ModuleEnv Int),
tibbe's avatar
tibbe committed
772 773

  -- | Machine dependant flags (-m<blah> stuff)
774
  sseVersion            :: Maybe (Int, Int),  -- (major, minor)
775 776
  avx                   :: Bool,
  avx2                  :: Bool,
777 778 779

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

782 783 784
class HasDynFlags m where
    getDynFlags :: m DynFlags

Ian Lynagh's avatar
Ian Lynagh committed
785 786
class ContainsDynFlags t where
    extractDynFlags :: t -> DynFlags
787
    replaceDynFlags :: t -> DynFlags -> t
Ian Lynagh's avatar
Ian Lynagh committed
788

789 790 791 792 793
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
794
  | ProfAutoCalls      -- ^ annotate call-sites
Simon Marlow's avatar
Simon Marlow committed
795
  deriving (Enum)
796