DynFlags.hs 149 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 132 133
        -- * SSE
        isSse2Enabled,
        isSse4_2Enabled,
134 135 136

        -- * Linker information
        LinkerInfo(..),
137 138 139 140
  ) where

#include "HsVersions.h"

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

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

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

183 184 185
import Data.IntSet (IntSet)
import qualified Data.IntSet as IntSet

186 187
import GHC.Foreign (withCString, peekCString)

188 189 190
-- -----------------------------------------------------------------------------
-- DynFlags

191
data DumpFlag
192 193 194

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

Ian Lynagh's avatar
Ian Lynagh committed
276
   | Opt_WarnIsError                    -- -Werror; makes warnings fatal
277

278 279
   | Opt_PrintExplicitForalls

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

316 317 318 319 320
   -- Interface files
   | Opt_IgnoreInterfacePragmas
   | Opt_OmitInterfacePragmas
   | Opt_ExposeAllUnfoldings

Ian Lynagh's avatar
Ian Lynagh committed
321 322
   -- profiling opts
   | Opt_AutoSccsOnIndividualCafs
323
   | Opt_ProfCountEntries
Ian Lynagh's avatar
Ian Lynagh committed
324

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

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

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

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

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

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

406 407
   | Opt_BuildDynamicToo

408
   -- safe haskell flags
dterei's avatar
dterei committed
409
   | Opt_DistrustAllPackages
410 411
   | Opt_PackageTrust

412
   deriving (Eq, Show, Enum)
Ian Lynagh's avatar
Ian Lynagh committed
413

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

459
data Language = Haskell98 | Haskell2010
460
   deriving Enum
461

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

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

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

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

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

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

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

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

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

605
  historySize           :: Int,
606

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

613
  thisPackage           :: PackageId,   -- ^ name of package currently being compiled
614 615

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

620 621 622
  -- For object splitting
  splitInfo             :: Maybe (String,Int),

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

Ian Lynagh's avatar
Ian Lynagh committed
630 631 632
  objectSuf             :: String,
  hcSuf                 :: String,
  hiSuf                 :: String,
633

634 635 636 637
  canGenerateDynamicToo :: IORef Bool,
  dynObjectSuf          :: String,
  dynHiSuf              :: String,

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

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

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

659
  ldInputs              :: [Option],
660

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

666
  rtsOpts               :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
667
  rtsOptsEnabled        :: RtsOptsEnabled,
668

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

671 672 673 674
  -- Plugins
  pluginModNames        :: [ModuleName],
  pluginModNameOpts     :: [(ModuleName,String)],

675 676 677
  -- GHC API hooks
  hooks                 :: Hooks,

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

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

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

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

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

707 708 709 710 711
  -- 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),

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

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

743 744
  maxWorkerArgs         :: Int,

745 746
  ghciHistSize          :: Int,

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

752
  haddockOptions        :: Maybe String,
753
  ghciScripts           :: [String],
754

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

760 761
  useUnicodeQuotes      :: Bool,

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

765
  interactivePrint      :: Maybe String,
766

767
  llvmVersion           :: IORef Int,
768

769
  nextWrapperNum        :: IORef (ModuleEnv Int),
tibbe's avatar
tibbe committed
770 771

  -- | Machine dependant flags (-m<blah> stuff)
772 773 774 775
  sseVersion            :: Maybe (Int, Int),  -- (major, minor)

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

778 779 780
class HasDynFlags m where
    getDynFlags :: m DynFlags

Ian Lynagh's avatar
Ian Lynagh committed
781 782
class ContainsDynFlags t where
    extractDynFlags :: t -> DynFlags
783
    replaceDynFlags :: t -> DynFlags -> t
Ian Lynagh's avatar
Ian Lynagh committed
784

785 786 787 788 789
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
790
  | ProfAutoCalls      -- ^ annotate call-sites
Simon Marlow's avatar
Simon Marlow committed
791
  deriving (Enum)
792

793
data Settings = Settings {
794
  sTargetPlatform        :: Platform,    -- Filled in by SysTools
795 796 797 798 799 800 801 802 803
  sGhcUsagePath          :: FilePath,    -- Filled in by SysTools
  sGhciUsagePath         :: FilePath,    -- ditto
  sTopDir                :: FilePath,
  sTmpDir                :: String,      -- no trailing '/'
  -- You shouldn't need to look things up in rawSettings directly.
  -- They should have their own fields instead.
  sRawSettings           :: [(String, String)],
  sExtraGccViaCFlags     :: [String],
  sSystemPackageConfig   :: FilePath,