DynFlags.hs 167 KB
Newer Older
1 2
{-# LANGUAGE CPP #-}

dterei's avatar
dterei committed
3
-------------------------------------------------------------------------------
4
--
dterei's avatar
dterei committed
5 6 7 8 9 10
-- | 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.
11 12 13
--
-- (c) The University of Glasgow 2005
--
dterei's avatar
dterei committed
14
-------------------------------------------------------------------------------
15

16
{-# OPTIONS_GHC -fno-cse #-}
17 18
-- -fno-cse is needed for GLOBAL_VAR's to behave properly

19
module DynFlags (
20
        -- * Dynamic flags and associated configuration types
21
        DumpFlag(..),
22
        GeneralFlag(..),
23
        WarningFlag(..),
24
        ExtensionFlag(..),
25
        Language(..),
26
        PlatformConstants(..),
Ian Lynagh's avatar
Ian Lynagh committed
27
        FatalMessager, LogAction, FlushOut(..), FlushErr(..),
28
        ProfAuto(..),
29
        glasgowExtsFlags,
30
        dopt, dopt_set, dopt_unset,
31 32 33
        gopt, gopt_set, gopt_unset,
        wopt, wopt_set, wopt_unset,
        xopt, xopt_set, xopt_unset,
34
        lang_set,
35
        useUnicodeSyntax,
36 37
        whenGeneratingDynamicToo, ifGeneratingDynamicToo,
        whenCannotGenerateDynamicToo,
38
        dynamicTooMkDynamicDynFlags,
Ian Lynagh's avatar
Ian Lynagh committed
39
        DynFlags(..),
40
        FlagSpec(..),
Ian Lynagh's avatar
Ian Lynagh committed
41
        HasDynFlags(..), ContainsDynFlags(..),
Ian Lynagh's avatar
Ian Lynagh committed
42
        RtsOptsEnabled(..),
Ian Lynagh's avatar
Ian Lynagh committed
43
        HscTarget(..), isObjectTarget, defaultObjectTarget,
44
        targetRetainsAllBindings,
Ian Lynagh's avatar
Ian Lynagh committed
45 46
        GhcMode(..), isOneShot,
        GhcLink(..), isNoLink,
47
        PackageFlag(..), PackageArg(..), ModRenaming(..),
48
        PkgConfRef(..),
Ian Lynagh's avatar
Ian Lynagh committed
49
        Option(..), showOpt,
Ian Lynagh's avatar
Ian Lynagh committed
50
        DynLibLoader(..),
51
        fFlags, fWarningFlags, fLangFlags, xFlags,
52
        dynFlagDependencies,
53
        tablesNextToCode, mkTablesNextToCode,
54
        SigOf(..), getSigOf,
55

56
        Way(..), mkBuildTag, wayRTSOnly, addWay', updateWays,
57
        wayGeneralFlags, wayUnsetGeneralFlags,
ian@well-typed.com's avatar
ian@well-typed.com committed
58

59
        -- ** Safe Haskell
60
        SafeHaskellMode(..),
61
        safeHaskellOn, safeImportsOn, safeLanguageOn, safeInferOn,
62
        packageTrustOn,
63
        safeDirectImpsReq, safeImplicitImpsReq,
64
        unsafeFlags, unsafeFlagsForInfer,
65

66
        -- ** System tool settings and locations
67
        Settings(..),
68
        targetPlatform,
69 70 71
        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,
72
        pgm_sysman, pgm_windres, pgm_libtool, pgm_lo, pgm_lc,
Ian Lynagh's avatar
Ian Lynagh committed
73
        opt_L, opt_P, opt_F, opt_c, opt_a, opt_l,
74
        opt_windres, opt_lo, opt_lc,
75 76


77
        -- ** Manipulating DynFlags
78
        defaultDynFlags,                -- Settings -> DynFlags
79
        defaultWays,
ian@well-typed.com's avatar
ian@well-typed.com committed
80
        interpWays,
Ian Lynagh's avatar
Ian Lynagh committed
81
        initDynFlags,                   -- DynFlags -> IO DynFlags
Ian Lynagh's avatar
Ian Lynagh committed
82
        defaultFatalMessager,
83
        defaultLogAction,
84
        defaultLogActionHPrintDoc,
85
        defaultLogActionHPutStrDoc,
86 87
        defaultFlushOut,
        defaultFlushErr,
Ian Lynagh's avatar
Ian Lynagh committed
88

89
        getOpts,                        -- DynFlags -> (DynFlags -> [a]) -> [a]
90
        getVerbFlags,
Ian Lynagh's avatar
Ian Lynagh committed
91 92
        updOptLevel,
        setTmpDir,
93
        setPackageKey,
Ian Lynagh's avatar
Ian Lynagh committed
94

95
        -- ** Parsing DynFlags
96 97
        parseDynamicFlagsCmdLine,
        parseDynamicFilePragma,
98 99 100
        parseDynamicFlagsFull,

        -- ** Available DynFlags
101
        allFlags,
102 103 104
        flagsAll,
        flagsDynamic,
        flagsPackage,
105
        flagsForCompletion,
106

107
        supportedLanguagesAndExtensions,
108
        languageExtensions,
109

110
        -- ** DynFlags C compiler options
Ian Lynagh's avatar
Ian Lynagh committed
111
        picCCOpts, picPOpts,
112 113 114 115 116 117

        -- * Configuration of the stg-to-stg passes
        StgToDo(..),
        getStgToDo,

        -- * Compiler configuration suitable for display to the user
118 119
        compilerInfo,

120
#ifdef GHCI
121
        rtsIsProfiled,
122
#endif
123
        dynamicGhc,
124 125

#include "../includes/dist-derivedconstants/header/GHCConstantsHaskellExports.hs"
126
        bLOCK_SIZE_W,
127
        wORD_SIZE_IN_BITS,
128 129
        tAG_MASK,
        mAX_PTR_TAG,
130
        tARGET_MIN_INT, tARGET_MAX_INT, tARGET_MAX_WORD,
131

132 133
        unsafeGlobalDynFlags, setUnsafeGlobalDynFlags,

134
        -- * SSE and AVX
135
        isSseEnabled,
136 137
        isSse2Enabled,
        isSse4_2Enabled,
138 139
        isAvxEnabled,
        isAvx2Enabled,
140 141 142 143
        isAvx512cdEnabled,
        isAvx512erEnabled,
        isAvx512fEnabled,
        isAvx512pfEnabled,
144

Austin Seipp's avatar
Austin Seipp committed
145
        -- * Linker/compiler information
146
        LinkerInfo(..),
Austin Seipp's avatar
Austin Seipp committed
147
        CompilerInfo(..),
148 149 150 151
  ) where

#include "HsVersions.h"

152
import Platform
153
import PlatformConstants
154
import Module
Simon Marlow's avatar
Simon Marlow committed
155
import PackageConfig
156
import {-# SOURCE #-} Hooks
157
import {-# SOURCE #-} PrelNames ( mAIN )
158
import {-# SOURCE #-} Packages (PackageState)
Ian Lynagh's avatar
Ian Lynagh committed
159
import DriverPhases     ( Phase(..), phaseInputExt )
160 161
import Config
import CmdLineParser
162
import Constants
163
import Panic
164
import Util
165
import Maybes           ( orElse )
166
import MonadUtils
167
import qualified Pretty
168
import SrcLoc
169
import FastString
Simon Marlow's avatar
Simon Marlow committed
170
import Outputable
Ian Lynagh's avatar
Ian Lynagh committed
171
#ifdef GHCI
Ian Lynagh's avatar
Ian Lynagh committed
172
import Foreign.C        ( CInt(..) )
173
import System.IO.Unsafe ( unsafeDupablePerformIO )
Ian Lynagh's avatar
Ian Lynagh committed
174
#endif
175
import {-# SOURCE #-} ErrUtils ( Severity(..), MsgDoc, mkLocMessage )
176

177
import System.IO.Unsafe ( unsafePerformIO )
178
import Data.IORef
ian@well-typed.com's avatar
ian@well-typed.com committed
179
import Control.Monad
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
180

181
import Data.Bits
182
import Data.Char
183
import Data.Int
184
import Data.List
185 186
import Data.Map (Map)
import qualified Data.Map as Map
187
import Data.Maybe
188 189
import Data.Set (Set)
import qualified Data.Set as Set
190
import Data.Word
Ian Lynagh's avatar
Ian Lynagh committed
191
import System.FilePath
192
import System.IO
193
import System.IO.Error
194 195
import Text.ParserCombinators.ReadP hiding (char)
import Text.ParserCombinators.ReadP as R
196

197 198 199
import Data.IntSet (IntSet)
import qualified Data.IntSet as IntSet

200 201
import GHC.Foreign (withCString, peekCString)

202 203 204 205 206 207 208 209 210 211 212 213 214
-- Note [Updating flag description in the User's Guide]
-- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
--
-- If you modify anything in this file please make sure that your changes are
-- described in the User's Guide. Usually at least two sections need to be
-- updated:
--
--  * Flag Reference section in docs/users-guide/flags.xml lists all available
--    flags together with a short description
--
--  * Flag description in docs/users_guide/using.xml provides a detailed
--    explanation of flags' usage.

215 216 217 218 219 220 221 222 223 224 225 226
-- Note [Supporting CLI completion]
-- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
--
-- The command line interface completion (in for example bash) is an easy way
-- for the developer to learn what flags are available from GHC.
-- GHC helps by separating which flags are available when compiling with GHC,
-- and which flags are available when using GHCi.
-- A flag is assumed to either work in both these modes, or only in one of them.
-- When adding or changing a flag, please consider for which mode the flag will
-- have effect, and annotate it accordingly. For Flags use defFlag, defGhcFlag,
-- defGhciFlag, and for FlagSpec use flagSpec or flagGhciSpec.

227 228 229
-- -----------------------------------------------------------------------------
-- DynFlags

230
data DumpFlag
231
-- See Note [Updating flag description in the User's Guide]
232 233 234

   -- debugging flags
   = Opt_D_dump_cmm
235 236 237 238 239 240
   | 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
241
   | Opt_D_dump_cmm_sink
242 243 244 245 246 247
   | 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
248
   | Opt_D_dump_asm
249 250 251 252 253
   | 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
254
   | Opt_D_dump_asm_stats
255
   | Opt_D_dump_asm_expanded
256
   | Opt_D_dump_llvm
257
   | Opt_D_dump_core_stats
258 259 260 261
   | Opt_D_dump_deriv
   | Opt_D_dump_ds
   | Opt_D_dump_foreign
   | Opt_D_dump_inlinings
262
   | Opt_D_dump_rule_firings
263
   | Opt_D_dump_rule_rewrites
264
   | Opt_D_dump_simpl_trace
265 266 267 268 269 270 271 272
   | Opt_D_dump_occur_anal
   | Opt_D_dump_parsed
   | Opt_D_dump_rn
   | Opt_D_dump_simpl
   | Opt_D_dump_simpl_iterations
   | Opt_D_dump_spec
   | Opt_D_dump_prep
   | Opt_D_dump_stg
273
   | Opt_D_dump_call_arity
274
   | Opt_D_dump_stranal
Joachim Breitner's avatar
Joachim Breitner committed
275
   | Opt_D_dump_strsigs
276 277 278 279 280 281 282 283 284
   | 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
285
   | Opt_D_dump_cs_trace -- Constraint solver in type checker
286 287
   | Opt_D_dump_tc_trace
   | Opt_D_dump_if_trace
288
   | Opt_D_dump_vt_trace
289 290 291
   | Opt_D_dump_splices
   | Opt_D_dump_BCOs
   | Opt_D_dump_vect
292
   | Opt_D_dump_ticked
pepe's avatar
pepe committed
293
   | Opt_D_dump_rtti
294 295 296 297
   | Opt_D_source_stats
   | Opt_D_verbose_stg2stg
   | Opt_D_dump_hi
   | Opt_D_dump_hi_diffs
298
   | Opt_D_dump_mod_cycles
299
   | Opt_D_dump_mod_map
300
   | Opt_D_dump_view_pattern_commoning
301
   | Opt_D_verbose_core2core
302
   | Opt_D_dump_debug
303 304 305 306 307

   deriving (Eq, Show, Enum)

-- | Enumerates the simple on-or-off dynamic flags
data GeneralFlag
308
-- See Note [Updating flag description in the User's Guide]
309 310

   = Opt_DumpToFile                     -- ^ Append dump output to files instead of stdout.
311
   | Opt_D_faststring_stats
312
   | Opt_D_dump_minimal_imports
313 314 315
   | Opt_DoCoreLinting
   | Opt_DoStgLinting
   | Opt_DoCmmLinting
Ben.Lippmeier@anu.edu.au's avatar
Ben.Lippmeier@anu.edu.au committed
316
   | Opt_DoAsmLinting
Peter Wortmann's avatar
Peter Wortmann committed
317
   | Opt_DoAnnotationLinting
318
   | Opt_NoLlvmMangler                 -- hidden flag
319

Ian Lynagh's avatar
Ian Lynagh committed
320
   | Opt_WarnIsError                    -- -Werror; makes warnings fatal
321

322
   | Opt_PrintExplicitForalls
unknown's avatar
unknown committed
323
   | Opt_PrintExplicitKinds
324

325
   -- optimisation opts
326
   | Opt_CallArity
327
   | Opt_Strictness
328
   | Opt_LateDmdAnal
329 330
   | Opt_KillAbsence
   | Opt_KillOneShot
331
   | Opt_FullLaziness
332 333
   | Opt_FloatIn
   | Opt_Specialise
334
   | Opt_SpecialiseAggressively
335
   | Opt_StaticArgumentTransformation
336
   | Opt_CSE
337 338
   | Opt_LiberateCase
   | Opt_SpecConstr
339 340 341 342 343
   | Opt_DoLambdaEtaExpansion
   | Opt_IgnoreAsserts
   | Opt_DoEtaReduction
   | Opt_CaseMerge
   | Opt_UnboxStrictFields
344
   | Opt_UnboxSmallStrictFields
345
   | Opt_DictsCheap
346
   | Opt_EnableRewriteRules             -- Apply rewrite rules during simplification
rl@cse.unsw.edu.au's avatar
rl@cse.unsw.edu.au committed
347
   | Opt_Vectorise
348
   | Opt_VectorisationAvoidance
Ian Lynagh's avatar
Ian Lynagh committed
349 350
   | Opt_RegsGraph                      -- do graph coloring register allocation
   | Opt_RegsIterative                  -- do iterative coalescing graph coloring register allocation
351
   | Opt_PedanticBottoms                -- Be picky about how we treat bottom
352
   | Opt_LlvmTBAA                       -- Use LLVM TBAA infastructure for improving AA (hidden flag)
353
   | Opt_LlvmPassVectorsInRegisters     -- Pass SIMD vectors in registers (requires a patched LLVM) (hidden flag)
354
   | Opt_IrrefutableTuples
355
   | Opt_CmmSink
356
   | Opt_CmmElimCommonBlocks
357
   | Opt_OmitYields
358
   | Opt_SimpleListLiterals
359
   | Opt_FunToThunk               -- allow WwLib.mkWorkerArgs to remove all value lambdas
360 361
   | Opt_DictsStrict                     -- be strict in argument dictionaries
   | Opt_DmdTxDictSel              -- use a special demand transformer for dictionary selectors
362
   | Opt_Loopification                  -- See Note [Self-recursive tail calls]
363

364 365 366 367
   -- Interface files
   | Opt_IgnoreInterfacePragmas
   | Opt_OmitInterfacePragmas
   | Opt_ExposeAllUnfoldings
368
   | Opt_WriteInterface -- forces .hi files to be written even with -fno-code
369

Ian Lynagh's avatar
Ian Lynagh committed
370 371
   -- profiling opts
   | Opt_AutoSccsOnIndividualCafs
372
   | Opt_ProfCountEntries
Ian Lynagh's avatar
Ian Lynagh committed
373

374 375
   -- misc opts
   | Opt_Pp
376
   | Opt_ForceRecomp
377
   | Opt_ExcessPrecision
378
   | Opt_EagerBlackHoling
379 380 381
   | Opt_NoHsMain
   | Opt_SplitObjs
   | Opt_StgStats
382
   | Opt_HideAllPackages
383
   | Opt_PrintBindResult
384
   | Opt_Haddock
David Waern's avatar
David Waern committed
385
   | Opt_HaddockOptions
386
   | Opt_Hpc_No_Auto
387
   | Opt_BreakOnException
388
   | Opt_BreakOnError
389
   | Opt_PrintEvldWithShow
390
   | Opt_PrintBindContents
391 392
   | Opt_GenManifest
   | Opt_EmbedManifest
393
   | Opt_EmitExternalCore
Ian Lynagh's avatar
Ian Lynagh committed
394
   | Opt_SharedImplib
395
   | Opt_BuildingCabalPackage
396
   | Opt_IgnoreDotGhci
397
   | Opt_GhciSandbox
Ian Lynagh's avatar
Ian Lynagh committed
398
   | Opt_GhciHistory
399
   | Opt_HelpfulErrors
400
   | Opt_DeferTypeErrors
401
   | Opt_DeferTypedHoles
Ian Lynagh's avatar
Ian Lynagh committed
402
   | Opt_Parallel
Ian Lynagh's avatar
Ian Lynagh committed
403
   | Opt_GranMacros
Ian Lynagh's avatar
Ian Lynagh committed
404
   | Opt_PIC
405
   | Opt_SccProfilingOn
ian@well-typed.com's avatar
ian@well-typed.com committed
406
   | Opt_Ticky
nfrisby's avatar
nfrisby committed
407 408 409
   | Opt_Ticky_Allocd
   | Opt_Ticky_LNE
   | Opt_Ticky_Dyn_Thunk
ian@well-typed.com's avatar
ian@well-typed.com committed
410
   | Opt_Static
411
   | Opt_RPath
412
   | Opt_RelativeDynlibPaths
ian@well-typed.com's avatar
ian@well-typed.com committed
413
   | Opt_Hpc
414
   | Opt_FlatCache
415

416 417 418 419
   -- PreInlining is on by default. The option is there just to see how
   -- bad things get if you turn it off!
   | Opt_SimplPreInlining

420
   -- output style opts
421 422
   | Opt_ErrorSpans -- Include full span info in error messages,
                    -- instead of just the start position.
423
   | Opt_PprCaseAsLet
Peter Wortmann's avatar
Peter Wortmann committed
424
   | Opt_PprShowTicks
425

426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442
   -- 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

443
   -- temporary flags
444
   | Opt_AutoLinkPackages
445
   | Opt_ImplicitImportQualified
446 447 448 449 450 451

   -- keeping stuff
   | Opt_KeepHiDiffs
   | Opt_KeepHcFiles
   | Opt_KeepSFiles
   | Opt_KeepTmpFiles
Jedai's avatar
Jedai committed
452
   | Opt_KeepRawTokenStream
453
   | Opt_KeepLlvmFiles
454

455 456
   | Opt_BuildDynamicToo

457
   -- safe haskell flags
dterei's avatar
dterei committed
458
   | Opt_DistrustAllPackages
459 460
   | Opt_PackageTrust

Peter Wortmann's avatar
Peter Wortmann committed
461 462 463
   -- debugging flags
   | Opt_Debug

464
   deriving (Eq, Show, Enum)
Ian Lynagh's avatar
Ian Lynagh committed
465

466
data WarningFlag =
467
-- See Note [Updating flag description in the User's Guide]
468
     Opt_WarnDuplicateExports
469
   | Opt_WarnDuplicateConstraints
470 471 472 473 474
   | Opt_WarnHiShadows
   | Opt_WarnImplicitPrelude
   | Opt_WarnIncompletePatterns
   | Opt_WarnIncompleteUniPatterns
   | Opt_WarnIncompletePatternsRecUpd
475
   | Opt_WarnOverflowedLiterals
476
   | Opt_WarnEmptyEnumerations
477 478 479 480 481 482 483 484 485 486 487 488
   | Opt_WarnMissingFields
   | Opt_WarnMissingImportList
   | Opt_WarnMissingMethods
   | Opt_WarnMissingSigs
   | Opt_WarnMissingLocalSigs
   | Opt_WarnNameShadowing
   | Opt_WarnOverlappingPatterns
   | Opt_WarnTypeDefaults
   | Opt_WarnMonomorphism
   | Opt_WarnUnusedBinds
   | Opt_WarnUnusedImports
   | Opt_WarnUnusedMatches
489
   | Opt_WarnContextQuantification
490 491
   | Opt_WarnWarningsDeprecations
   | Opt_WarnDeprecatedFlags
492
   | Opt_WarnAMP
493 494 495 496 497 498 499 500 501 502 503
   | Opt_WarnDodgyExports
   | Opt_WarnDodgyImports
   | Opt_WarnOrphans
   | Opt_WarnAutoOrphans
   | Opt_WarnIdentities
   | Opt_WarnTabs
   | Opt_WarnUnrecognisedPragmas
   | Opt_WarnDodgyForeignImports
   | Opt_WarnUnusedDoBind
   | Opt_WarnWrongDoBind
   | Opt_WarnAlternativeLayoutRuleTransitional
504 505
   | Opt_WarnUnsafe
   | Opt_WarnSafe
506
   | Opt_WarnTrustworthySafe
Ian Lynagh's avatar
Ian Lynagh committed
507
   | Opt_WarnPointlessPragmas
508
   | Opt_WarnUnsupportedCallingConventions
509
   | Opt_WarnUnsupportedLlvmVersion
510
   | Opt_WarnInlineRuleShadowing
511
   | Opt_WarnTypedHoles
thomasw's avatar
thomasw committed
512
   | Opt_WarnPartialTypeSignatures
513
   | Opt_WarnMissingExportedSigs
carlostome's avatar
carlostome committed
514
   | Opt_WarnUntickedPromotedConstructors
515
   deriving (Eq, Show, Enum)
516

517
data Language = Haskell98 | Haskell2010
518
   deriving Enum
519

520
-- | The various Safe Haskell modes
521 522
data SafeHaskellMode
   = Sf_None
dterei's avatar
dterei committed
523
   | Sf_Unsafe
524 525 526 527
   | Sf_Trustworthy
   | Sf_Safe
   deriving (Eq)

Ian Lynagh's avatar
Ian Lynagh committed
528
instance Show SafeHaskellMode where
Ian Lynagh's avatar
Ian Lynagh committed
529 530 531 532
    show Sf_None         = "None"
    show Sf_Unsafe       = "Unsafe"
    show Sf_Trustworthy  = "Trustworthy"
    show Sf_Safe         = "Safe"
Ian Lynagh's avatar
Ian Lynagh committed
533

534
instance Outputable SafeHaskellMode where
Ian Lynagh's avatar
Ian Lynagh committed
535
    ppr = text . show
536

537
data ExtensionFlag
538
-- See Note [Updating flag description in the User's Guide]
539 540 541 542 543 544 545
   = Opt_Cpp
   | Opt_OverlappingInstances
   | Opt_UndecidableInstances
   | Opt_IncoherentInstances
   | Opt_MonomorphismRestriction
   | Opt_MonoPatBinds
   | Opt_MonoLocalBinds
546 547
   | Opt_RelaxedPolyRec           -- Deprecated
   | Opt_ExtendedDefaultRules     -- Use GHC's extended rules for defaulting
548 549
   | Opt_ForeignFunctionInterface
   | Opt_UnliftedFFITypes
550
   | Opt_InterruptibleFFI
551
   | Opt_CApiFFI
552
   | Opt_GHCForeignImportPrim
thoughtpolice's avatar
thoughtpolice committed
553
   | Opt_JavaScriptFFI
554 555
   | Opt_ParallelArrays           -- Syntactic support for parallel arrays
   | Opt_Arrows                   -- Arrow-notation syntax
556 557 558 559 560
   | Opt_TemplateHaskell
   | Opt_QuasiQuotes
   | Opt_ImplicitParams
   | Opt_ImplicitPrelude
   | Opt_ScopedTypeVariables
561
   | Opt_AllowAmbiguousTypes
562 563 564 565
   | Opt_UnboxedTuples
   | Opt_BangPatterns
   | Opt_TypeFamilies
   | Opt_OverloadedStrings
566
   | Opt_OverloadedLists
567
   | Opt_NumDecimals
568 569 570 571 572
   | Opt_DisambiguateRecordFields
   | Opt_RecordWildCards
   | Opt_RecordPuns
   | Opt_ViewPatterns
   | Opt_GADTs
Ian Lynagh's avatar
Ian Lynagh committed
573
   | Opt_GADTSyntax
574
   | Opt_NPlusKPatterns
Ian Lynagh's avatar
Ian Lynagh committed
575
   | Opt_DoAndIfThenElse
576
   | Opt_RebindableSyntax
577
   | Opt_ConstraintKinds
dreixel's avatar
dreixel committed
578
   | Opt_PolyKinds                -- Kind polymorphism
dreixel's avatar
dreixel committed
579
   | Opt_DataKinds                -- Datatype promotion
580
   | Opt_InstanceSigs
581

582 583
   | Opt_StandaloneDeriving
   | Opt_DeriveDataTypeable
584
   | Opt_AutoDeriveTypeable       -- Automatic derivation of Typeable
585 586 587
   | Opt_DeriveFunctor
   | Opt_DeriveTraversable
   | Opt_DeriveFoldable
588
   | Opt_DeriveGeneric            -- Allow deriving Generic/1
dreixel's avatar
dreixel committed
589
   | Opt_DefaultSignatures        -- Allow extra signatures for defmeths
590
   | Opt_DeriveAnyClass           -- Allow deriving any class
591 592 593 594 595 596

   | Opt_TypeSynonymInstances
   | Opt_FlexibleContexts
   | Opt_FlexibleInstances
   | Opt_ConstrainedClassMethods
   | Opt_MultiParamTypeClasses
597
   | Opt_NullaryTypeClasses
598 599 600 601 602 603
   | Opt_FunctionalDependencies
   | Opt_UnicodeSyntax
   | Opt_ExistentialQuantification
   | Opt_MagicHash
   | Opt_EmptyDataDecls
   | Opt_KindSignatures
604
   | Opt_RoleAnnotations
605 606
   | Opt_ParallelListComp
   | Opt_TransformListComp
607
   | Opt_MonadComprehensions
608 609 610 611 612 613 614 615 616
   | Opt_GeneralizedNewtypeDeriving
   | Opt_RecursiveDo
   | Opt_PostfixOperators
   | Opt_TupleSections
   | Opt_PatternGuards
   | Opt_LiberalTypeSynonyms
   | Opt_RankNTypes
   | Opt_ImpredicativeTypes
   | Opt_TypeOperators
617
   | Opt_ExplicitNamespaces
618 619 620 621 622
   | Opt_PackageImports
   | Opt_ExplicitForAll
   | Opt_AlternativeLayoutRule
   | Opt_AlternativeLayoutRuleTransitional
   | Opt_DatatypeContexts
623
   | Opt_NondecreasingIndentation
624
   | Opt_RelaxedLayout
625
   | Opt_TraditionalRecordSyntax
626
   | Opt_LambdaCase
627
   | Opt_MultiWayIf
628
   | Opt_BinaryLiterals
629
   | Opt_NegativeLiterals
630
   | Opt_EmptyCase
cactus's avatar
cactus committed
631
   | Opt_PatternSynonyms
thomasw's avatar
thomasw committed
632 633
   | Opt_PartialTypeSignatures
   | Opt_NamedWildcards
Facundo Domínguez's avatar
Facundo Domínguez committed
634
   | Opt_StaticPointers
635
   deriving (Eq, Enum, Show)
636

637 638 639 640 641 642 643 644 645 646 647
data SigOf = NotSigOf
           | SigOf Module
           | SigOfMap (Map ModuleName Module)

getSigOf :: DynFlags -> ModuleName -> Maybe Module
getSigOf dflags n =
    case sigOf dflags of
        NotSigOf -> Nothing
        SigOf m -> Just m
        SigOfMap m -> Map.lookup n m

648
-- | Contains not only a collection of 'GeneralFlag's but also a plethora of
649
-- information relating to the compilation of a single file or GHC session
650
data DynFlags = DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
651 652 653
  ghcMode               :: GhcMode,
  ghcLink               :: GhcLink,
  hscTarget             :: HscTarget,
654
  settings              :: Settings,
655 656
  -- See Note [Signature parameters in TcGblEnv and DynFlags]
  sigOf                 :: SigOf,       -- ^ Compiling an hs-boot against impl.
657
  verbosity             :: Int,         -- ^ Verbosity level: see Note [Verbosity levels]
658 659 660
  optLevel              :: Int,         -- ^ Optimisation level
  simplPhases           :: Int,         -- ^ Number of simplifier phases
  maxSimplIterations    :: Int,         -- ^ Max simplifier iterations
Ian Lynagh's avatar
Ian Lynagh committed
661
  ruleCheck             :: Maybe String,
662
  strictnessBefore      :: [Int],       -- ^ Additional demand analysis
663

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

668 669 670
  enableTimeStats       :: Bool,        -- ^ Enable RTS timing statistics?
  ghcHeapSize           :: Maybe Int,   -- ^ The heap size to set.

671 672
  maxRelevantBinds      :: Maybe Int,   -- ^ Maximum number of bindings from the type envt
                                        --   to show in type error messages
673
  simplTickFactor       :: Int,         -- ^ Multiplier for simplifier ticks
674 675
  specConstrThreshold   :: Maybe Int,   -- ^ Threshold for SpecConstr
  specConstrCount       :: Maybe Int,   -- ^ Max number of specialisations for any one function
676 677
  specConstrRecursive   :: Int,         -- ^ Max number of specialisations for recursive types
                                        --   Not optional; otherwise ForceSpecConstr can diverge.
678
  liberateCaseThreshold :: Maybe Int,   -- ^ Threshold for LiberateCase
679
  floatLamArgs          :: Maybe Int,   -- ^ Arg count for lambda floating
680
                                        --   See CoreMonad.FloatOutSwitches
681

682
  historySize           :: Int,
683

684
  cmdlineHcIncludes     :: [String],    -- ^ @\-\#includes@
Ian Lynagh's avatar
Ian Lynagh committed
685 686 687
  importPaths           :: [FilePath],
  mainModIs             :: Module,
  mainFunIs             :: Maybe String,
688
  ctxtStkDepth          :: Int,         -- ^ Typechecker context stack depth
689
  tyFunStkDepth         :: Int,         -- ^ Typechecker type function stack depth
690

691
  thisPackage           :: PackageKey,   -- ^ name of package currently being compiled
692 693

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

698 699 700
  -- For object splitting
  splitInfo             :: Maybe (String,Int),

701
  -- paths etc.
Ian Lynagh's avatar
Ian Lynagh committed
702
  objectDir             :: Maybe String,
703
  dylibInstallName      :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
704 705
  hiDir                 :: Maybe String,
  stubDir               :: Maybe String,
706
  dumpDir               :: Maybe String,
707

Ian Lynagh's avatar
Ian Lynagh committed
708 709 710
  objectSuf             :: String,
  hcSuf                 :: String,
  hiSuf                 :: String,
711

712 713 714 715
  canGenerateDynamicToo :: IORef Bool,
  dynObjectSuf          :: String,
  dynHiSuf              :: String,

716 717 718 719 720 721 722 723
  -- 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
724
  outputFile            :: Maybe String,
ian@well-typed.com's avatar
ian@well-typed.com committed
725
  dynOutputFile         :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
726 727
  outputHi              :: Maybe String,
  dynLibLoader          :: DynLibLoader,
728

729
  -- | This is set by 'DriverPipeline.runPipeline' based on where
Ian Lynagh's avatar
Ian Lynagh committed
730 731
  --    its output is going.
  dumpPrefix            :: Maybe FilePath,
732

733 734
  -- | Override the 'dumpPrefix' set by 'DriverPipeline.runPipeline'.
  --    Set by @-ddump-file-prefix@
Ian Lynagh's avatar
Ian Lynagh committed
735 736
  dumpPrefixForce       :: Maybe FilePath,

737
  ldInputs              :: [Option],
738

Ian Lynagh's avatar
Ian Lynagh committed
739 740 741 742 743
  includePaths          :: [String],
  libraryPaths          :: [String],
  frameworkPaths        :: [String],    -- used on darwin only
  cmdlineFrameworks     :: [String],    -- ditto

744
  rtsOpts               :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
745
  rtsOptsEnabled        :: RtsOptsEnabled,
746

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

749 750 751 752
  -- Plugins
  pluginModNames        :: [ModuleName],
  pluginModNameOpts     :: [(ModuleName,String)],

753 754 755
  -- GHC API hooks
  hooks                 :: Hooks,

756 757 758 759 760 761
  --  For ghc -M
  depMakefile           :: FilePath,
  depIncludePkgDeps     :: Bool,
  depExcludeMods        :: [ModuleName],
  depSuffixes           :: [String],

762
  --  Package flags
763
  extraPkgConfs         :: [PkgConfRef] -> [PkgConfRef],
764
        -- ^ The @-package-db@ flags given on the command line, in the order
Ian Lynagh's avatar
Ian Lynagh committed
765
        -- they appeared.
766

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

770
  -- Package state
Ian Lynagh's avatar
Ian Lynagh committed
771
  -- NB. do not modify this field, it is calculated by
772
  -- Packages.initPackages and Packages.updatePackages.
773
  pkgDatabase           :: Maybe [PackageConfig],
Ian Lynagh's avatar
Ian Lynagh committed
774
  pkgState              :: PackageState,
775

776 777 778 779
  -- Temporary files
  -- These have to be IORefs, because the defaultCleanupHandler needs to
  -- know what to clean when an exception happens
  filesToClean          :: IORef [FilePath],
780
  dirsToClean           :: IORef (Map FilePath FilePath),
781
  filesToNotIntermediateClean :: IORef [FilePath],
782 783
  -- The next available suffix to uniquely name a temp file, updated atomically
  nextTempSuffix        :: IORef Int,
784

785 786 787 788 789
  -- 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),

790
  -- hsc dynamic flags
791 792
  dumpFlags             :: IntSet,
  generalFlags          :: IntSet,