DynFlags.hs 143 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 35
        whenGeneratingDynamicToo, ifGeneratingDynamicToo,
        whenCannotGenerateDynamicToo,
        doDynamicToo,
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 54
        Way(..), mkBuildTag, wayRTSOnly, updateWays,
        wayGeneralFlags,
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 69
        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,
        pgm_sysman, pgm_windres, 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 Lynagh's avatar
Ian Lynagh committed
77
        initDynFlags,                   -- DynFlags -> IO DynFlags
Ian Lynagh's avatar
Ian Lynagh committed
78
        defaultFatalMessager,
79
        defaultLogAction,
80
        defaultLogActionHPrintDoc,
81 82
        defaultFlushOut,
        defaultFlushErr,
Ian Lynagh's avatar
Ian Lynagh committed
83

84
        getOpts,                        -- DynFlags -> (DynFlags -> [a]) -> [a]
85
        getVerbFlags,
Ian Lynagh's avatar
Ian Lynagh committed
86 87 88 89
        updOptLevel,
        setTmpDir,
        setPackageName,

90
        -- ** Parsing DynFlags
91 92
        parseDynamicFlagsCmdLine,
        parseDynamicFilePragma,
93 94 95
        parseDynamicFlagsFull,

        -- ** Available DynFlags
96
        allFlags,
97 98 99
        flagsAll,
        flagsDynamic,
        flagsPackage,
100

101
        supportedLanguagesAndExtensions,
102

103
        -- ** DynFlags C compiler options
Ian Lynagh's avatar
Ian Lynagh committed
104
        picCCOpts, picPOpts,
105 106 107 108 109 110

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

        -- * Compiler configuration suitable for display to the user
111 112
        compilerInfo,

113
#ifdef GHCI
dterei's avatar
dterei committed
114
-- Only in stage 2 can we be sure that the RTS
115
-- exposes the appropriate runtime boolean
116
        rtsIsProfiled,
117
#endif
118 119

#include "../includes/dist-derivedconstants/header/GHCConstantsHaskellExports.hs"
120
        bLOCK_SIZE_W,
121
        wORD_SIZE_IN_BITS,
122 123
        tAG_MASK,
        mAX_PTR_TAG,
124
        tARGET_MIN_INT, tARGET_MAX_INT, tARGET_MAX_WORD,
125

126 127
        unsafeGlobalDynFlags, setUnsafeGlobalDynFlags,

128 129 130
        -- * SSE
        isSse2Enabled,
        isSse4_2Enabled,
131 132 133 134
  ) where

#include "HsVersions.h"

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

158
import System.IO.Unsafe ( unsafePerformIO )
159
import Data.IORef
ian@well-typed.com's avatar
ian@well-typed.com committed
160
import Control.Monad
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
161

162
import Data.Bits
163
import Data.Char
164
import Data.Int
165
import Data.List
166 167
import Data.Map (Map)
import qualified Data.Map as Map
168
import Data.Maybe
169 170
import Data.Set (Set)
import qualified Data.Set as Set
171
import Data.Word
Ian Lynagh's avatar
Ian Lynagh committed
172
import System.FilePath
173
import System.IO
174
import System.IO.Error
175

176 177 178
import Data.IntSet (IntSet)
import qualified Data.IntSet as IntSet

179 180
import GHC.Foreign (withCString, peekCString)

181 182 183
-- -----------------------------------------------------------------------------
-- DynFlags

184
data DumpFlag
185 186 187

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

Ian Lynagh's avatar
Ian Lynagh committed
269
   | Opt_WarnIsError                    -- -Werror; makes warnings fatal
270

271 272
   | Opt_PrintExplicitForalls

273 274 275
   -- optimisation opts
   | Opt_Strictness
   | Opt_FullLaziness
276 277
   | Opt_FloatIn
   | Opt_Specialise
278
   | Opt_StaticArgumentTransformation
279
   | Opt_CSE
280 281
   | Opt_LiberateCase
   | Opt_SpecConstr
282 283 284 285 286
   | Opt_DoLambdaEtaExpansion
   | Opt_IgnoreAsserts
   | Opt_DoEtaReduction
   | Opt_CaseMerge
   | Opt_UnboxStrictFields
287
   | Opt_UnboxSmallStrictFields
288
   | Opt_DictsCheap
289
   | Opt_EnableRewriteRules             -- Apply rewrite rules during simplification
rl@cse.unsw.edu.au's avatar
rl@cse.unsw.edu.au committed
290
   | Opt_Vectorise
291
   | Opt_VectorisationAvoidance
Ian Lynagh's avatar
Ian Lynagh committed
292 293
   | Opt_RegsGraph                      -- do graph coloring register allocation
   | Opt_RegsIterative                  -- do iterative coalescing graph coloring register allocation
294
   | Opt_PedanticBottoms                -- Be picky about how we treat bottom
295
   | Opt_LlvmTBAA                       -- Use LLVM TBAA infastructure for improving AA (hidden flag)
296
   | Opt_IrrefutableTuples
297
   | Opt_CmmSink
298
   | Opt_CmmElimCommonBlocks
299
   | Opt_OmitYields
300
   | Opt_SimpleListLiterals
301

302 303 304 305 306
   -- Interface files
   | Opt_IgnoreInterfacePragmas
   | Opt_OmitInterfacePragmas
   | Opt_ExposeAllUnfoldings

Ian Lynagh's avatar
Ian Lynagh committed
307 308
   -- profiling opts
   | Opt_AutoSccsOnIndividualCafs
309
   | Opt_ProfCountEntries
Ian Lynagh's avatar
Ian Lynagh committed
310

311 312
   -- misc opts
   | Opt_Pp
313
   | Opt_ForceRecomp
314
   | Opt_ExcessPrecision
315
   | Opt_EagerBlackHoling
316 317 318
   | Opt_NoHsMain
   | Opt_SplitObjs
   | Opt_StgStats
319
   | Opt_HideAllPackages
320
   | Opt_PrintBindResult
321
   | Opt_Haddock
David Waern's avatar
David Waern committed
322
   | Opt_HaddockOptions
323
   | Opt_Hpc_No_Auto
324
   | Opt_BreakOnException
325
   | Opt_BreakOnError
326
   | Opt_PrintEvldWithShow
327
   | Opt_PrintBindContents
328 329
   | Opt_GenManifest
   | Opt_EmbedManifest
330
   | Opt_EmitExternalCore
Ian Lynagh's avatar
Ian Lynagh committed
331
   | Opt_SharedImplib
332
   | Opt_BuildingCabalPackage
333
   | Opt_IgnoreDotGhci
334
   | Opt_GhciSandbox
Ian Lynagh's avatar
Ian Lynagh committed
335
   | Opt_GhciHistory
336
   | Opt_HelpfulErrors
337
   | Opt_DeferTypeErrors
Ian Lynagh's avatar
Ian Lynagh committed
338
   | Opt_Parallel
Ian Lynagh's avatar
Ian Lynagh committed
339
   | Opt_GranMacros
Ian Lynagh's avatar
Ian Lynagh committed
340
   | Opt_PIC
341
   | Opt_SccProfilingOn
ian@well-typed.com's avatar
ian@well-typed.com committed
342 343
   | Opt_Ticky
   | Opt_Static
344
   | Opt_RPath
345
   | Opt_RelativeDynlibPaths
ian@well-typed.com's avatar
ian@well-typed.com committed
346
   | Opt_Hpc
347

348 349 350 351
   -- PreInlining is on by default. The option is there just to see how
   -- bad things get if you turn it off!
   | Opt_SimplPreInlining

352
   -- output style opts
353 354
   | Opt_ErrorSpans -- Include full span info in error messages,
                    -- instead of just the start position.
355
   | Opt_PprCaseAsLet
356

357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373
   -- 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

374
   -- temporary flags
375
   | Opt_RunCPS
376
   | Opt_RunCPSZ
377
   | Opt_AutoLinkPackages
378
   | Opt_ImplicitImportQualified
379 380 381 382 383 384

   -- keeping stuff
   | Opt_KeepHiDiffs
   | Opt_KeepHcFiles
   | Opt_KeepSFiles
   | Opt_KeepTmpFiles
Jedai's avatar
Jedai committed
385
   | Opt_KeepRawTokenStream
386
   | Opt_KeepLlvmFiles
387

388 389
   | Opt_BuildDynamicToo

390
   -- safe haskell flags
dterei's avatar
dterei committed
391
   | Opt_DistrustAllPackages
392 393
   | Opt_PackageTrust

394
   deriving (Eq, Show, Enum)
Ian Lynagh's avatar
Ian Lynagh committed
395

396 397
data WarningFlag =
     Opt_WarnDuplicateExports
398
   | Opt_WarnDuplicateConstraints
399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429
   | Opt_WarnHiShadows
   | Opt_WarnImplicitPrelude
   | Opt_WarnIncompletePatterns
   | Opt_WarnIncompleteUniPatterns
   | Opt_WarnIncompletePatternsRecUpd
   | 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
   | Opt_WarnDodgyExports
   | Opt_WarnDodgyImports
   | Opt_WarnOrphans
   | Opt_WarnAutoOrphans
   | Opt_WarnIdentities
   | Opt_WarnTabs
   | Opt_WarnUnrecognisedPragmas
   | Opt_WarnDodgyForeignImports
   | Opt_WarnLazyUnliftedBindings
   | Opt_WarnUnusedDoBind
   | Opt_WarnWrongDoBind
   | Opt_WarnAlternativeLayoutRuleTransitional
430 431
   | Opt_WarnUnsafe
   | Opt_WarnSafe
Ian Lynagh's avatar
Ian Lynagh committed
432
   | Opt_WarnPointlessPragmas
433
   | Opt_WarnUnsupportedCallingConventions
434
   | Opt_WarnUnsupportedLlvmVersion
435
   | Opt_WarnInlineRuleShadowing
436
   | Opt_WarnTypeableInstances
437
   deriving (Eq, Show, Enum)
438

439
data Language = Haskell98 | Haskell2010
440
   deriving Enum
441

442
-- | The various Safe Haskell modes
443 444
data SafeHaskellMode
   = Sf_None
dterei's avatar
dterei committed
445
   | Sf_Unsafe
446 447
   | Sf_Trustworthy
   | Sf_Safe
448
   | Sf_SafeInferred
449 450
   deriving (Eq)

Ian Lynagh's avatar
Ian Lynagh committed
451
instance Show SafeHaskellMode where
Ian Lynagh's avatar
Ian Lynagh committed
452 453 454 455 456
    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
457

458
instance Outputable SafeHaskellMode where
Ian Lynagh's avatar
Ian Lynagh committed
459
    ppr = text . show
460

461
data ExtensionFlag
462 463 464 465 466 467 468
   = Opt_Cpp
   | Opt_OverlappingInstances
   | Opt_UndecidableInstances
   | Opt_IncoherentInstances
   | Opt_MonomorphismRestriction
   | Opt_MonoPatBinds
   | Opt_MonoLocalBinds
469 470
   | Opt_RelaxedPolyRec           -- Deprecated
   | Opt_ExtendedDefaultRules     -- Use GHC's extended rules for defaulting
471 472
   | Opt_ForeignFunctionInterface
   | Opt_UnliftedFFITypes
473
   | Opt_InterruptibleFFI
474
   | Opt_CApiFFI
475
   | Opt_GHCForeignImportPrim
476 477
   | Opt_ParallelArrays           -- Syntactic support for parallel arrays
   | Opt_Arrows                   -- Arrow-notation syntax
478 479 480 481 482
   | Opt_TemplateHaskell
   | Opt_QuasiQuotes
   | Opt_ImplicitParams
   | Opt_ImplicitPrelude
   | Opt_ScopedTypeVariables
483
   | Opt_AllowAmbiguousTypes
484 485 486 487
   | Opt_UnboxedTuples
   | Opt_BangPatterns
   | Opt_TypeFamilies
   | Opt_OverloadedStrings
488
   | Opt_OverloadedLists
489 490 491 492 493
   | Opt_DisambiguateRecordFields
   | Opt_RecordWildCards
   | Opt_RecordPuns
   | Opt_ViewPatterns
   | Opt_GADTs
Ian Lynagh's avatar
Ian Lynagh committed
494
   | Opt_GADTSyntax
495
   | Opt_NPlusKPatterns
Ian Lynagh's avatar
Ian Lynagh committed
496
   | Opt_DoAndIfThenElse
497
   | Opt_RebindableSyntax
498
   | Opt_ConstraintKinds
dreixel's avatar
dreixel committed
499
   | Opt_PolyKinds                -- Kind polymorphism
dreixel's avatar
dreixel committed
500
   | Opt_DataKinds                -- Datatype promotion
501 502
   | Opt_InstanceSigs
 
503 504
   | Opt_StandaloneDeriving
   | Opt_DeriveDataTypeable
505
   | Opt_AutoDeriveTypeable       -- Automatic derivation of Typeable
506 507 508
   | Opt_DeriveFunctor
   | Opt_DeriveTraversable
   | Opt_DeriveFoldable
509
   | Opt_DeriveGeneric            -- Allow deriving Generic/1
dreixel's avatar
dreixel committed
510
   | Opt_DefaultSignatures        -- Allow extra signatures for defmeths
511 512 513 514 515 516

   | Opt_TypeSynonymInstances
   | Opt_FlexibleContexts
   | Opt_FlexibleInstances
   | Opt_ConstrainedClassMethods
   | Opt_MultiParamTypeClasses
517
   | Opt_NullaryTypeClasses
518 519 520 521 522 523 524 525
   | Opt_FunctionalDependencies
   | Opt_UnicodeSyntax
   | Opt_ExistentialQuantification
   | Opt_MagicHash
   | Opt_EmptyDataDecls
   | Opt_KindSignatures
   | Opt_ParallelListComp
   | Opt_TransformListComp
526
   | Opt_MonadComprehensions
527 528 529 530 531 532 533 534 535
   | Opt_GeneralizedNewtypeDeriving
   | Opt_RecursiveDo
   | Opt_PostfixOperators
   | Opt_TupleSections
   | Opt_PatternGuards
   | Opt_LiberalTypeSynonyms
   | Opt_RankNTypes
   | Opt_ImpredicativeTypes
   | Opt_TypeOperators
536
   | Opt_ExplicitNamespaces
537 538 539 540 541
   | Opt_PackageImports
   | Opt_ExplicitForAll
   | Opt_AlternativeLayoutRule
   | Opt_AlternativeLayoutRuleTransitional
   | Opt_DatatypeContexts
542
   | Opt_NondecreasingIndentation
543
   | Opt_RelaxedLayout
544
   | Opt_TraditionalRecordSyntax
545
   | Opt_LambdaCase
546
   | Opt_MultiWayIf
547
   | Opt_TypeHoles
548
   | Opt_EmptyCase
549
   deriving (Eq, Enum, Show)
550

551
-- | Contains not only a collection of 'GeneralFlag's but also a plethora of
552
-- information relating to the compilation of a single file or GHC session
553
data DynFlags = DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
554 555 556
  ghcMode               :: GhcMode,
  ghcLink               :: GhcLink,
  hscTarget             :: HscTarget,
557
  settings              :: Settings,
558
  hscOutName            :: String,      -- ^ Name of the output file
559
  extCoreName           :: String,      -- ^ Name of the .hcr output file
560
  verbosity             :: Int,         -- ^ Verbosity level: see Note [Verbosity levels]
561 562 563
  optLevel              :: Int,         -- ^ Optimisation level
  simplPhases           :: Int,         -- ^ Number of simplifier phases
  maxSimplIterations    :: Int,         -- ^ Max simplifier iterations
564
  shouldDumpSimplPhase  :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
565
  ruleCheck             :: Maybe String,
566
  strictnessBefore      :: [Int],       -- ^ Additional demand analysis
567

568
  simplTickFactor       :: Int,         -- ^ Multiplier for simplifier ticks
569 570 571
  specConstrThreshold   :: Maybe Int,   -- ^ Threshold for SpecConstr
  specConstrCount       :: Maybe Int,   -- ^ Max number of specialisations for any one function
  liberateCaseThreshold :: Maybe Int,   -- ^ Threshold for LiberateCase
572
  floatLamArgs          :: Maybe Int,   -- ^ Arg count for lambda floating
573
                                        --   See CoreMonad.FloatOutSwitches
574
  historySize           :: Int,
575

576
  cmdlineHcIncludes     :: [String],    -- ^ @\-\#includes@
Ian Lynagh's avatar
Ian Lynagh committed
577 578 579
  importPaths           :: [FilePath],
  mainModIs             :: Module,
  mainFunIs             :: Maybe String,
580
  ctxtStkDepth          :: Int,         -- ^ Typechecker context stack depth
581

582
  thisPackage           :: PackageId,   -- ^ name of package currently being compiled
583 584

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

589 590 591
  -- For object splitting
  splitInfo             :: Maybe (String,Int),

592
  -- paths etc.
Ian Lynagh's avatar
Ian Lynagh committed
593
  objectDir             :: Maybe String,
594
  dylibInstallName      :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
595 596
  hiDir                 :: Maybe String,
  stubDir               :: Maybe String,
597
  dumpDir               :: Maybe String,
598

Ian Lynagh's avatar
Ian Lynagh committed
599 600 601
  objectSuf             :: String,
  hcSuf                 :: String,
  hiSuf                 :: String,
602

603 604 605 606
  canGenerateDynamicToo :: IORef Bool,
  dynObjectSuf          :: String,
  dynHiSuf              :: String,

Ian Lynagh's avatar
Ian Lynagh committed
607
  outputFile            :: Maybe String,
ian@well-typed.com's avatar
ian@well-typed.com committed
608
  dynOutputFile         :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
609 610
  outputHi              :: Maybe String,
  dynLibLoader          :: DynLibLoader,
611

612
  -- | This is set by 'DriverPipeline.runPipeline' based on where
Ian Lynagh's avatar
Ian Lynagh committed
613 614
  --    its output is going.
  dumpPrefix            :: Maybe FilePath,
615

616 617
  -- | Override the 'dumpPrefix' set by 'DriverPipeline.runPipeline'.
  --    Set by @-ddump-file-prefix@
Ian Lynagh's avatar
Ian Lynagh committed
618 619
  dumpPrefixForce       :: Maybe FilePath,

620 621
  ldInputs              :: [String],

Ian Lynagh's avatar
Ian Lynagh committed
622 623 624 625 626
  includePaths          :: [String],
  libraryPaths          :: [String],
  frameworkPaths        :: [String],    -- used on darwin only
  cmdlineFrameworks     :: [String],    -- ditto

627
  rtsOpts               :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
628
  rtsOptsEnabled        :: RtsOptsEnabled,
629

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

632 633 634 635
  -- Plugins
  pluginModNames        :: [ModuleName],
  pluginModNameOpts     :: [(ModuleName,String)],

636 637 638 639 640 641
  --  For ghc -M
  depMakefile           :: FilePath,
  depIncludePkgDeps     :: Bool,
  depExcludeMods        :: [ModuleName],
  depSuffixes           :: [String],

642
  --  Package flags
643
  extraPkgConfs         :: [PkgConfRef] -> [PkgConfRef],
644
        -- ^ The @-package-db@ flags given on the command line, in the order
Ian Lynagh's avatar
Ian Lynagh committed
645
        -- they appeared.
646

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

650
  -- Package state
Ian Lynagh's avatar
Ian Lynagh committed
651
  -- NB. do not modify this field, it is calculated by
652
  -- Packages.initPackages and Packages.updatePackages.
653
  pkgDatabase           :: Maybe [PackageConfig],
Ian Lynagh's avatar
Ian Lynagh committed
654
  pkgState              :: PackageState,
655

656 657 658 659
  -- Temporary files
  -- These have to be IORefs, because the defaultCleanupHandler needs to
  -- know what to clean when an exception happens
  filesToClean          :: IORef [FilePath],
660
  dirsToClean           :: IORef (Map FilePath FilePath),
661 662
  filesToNotIntermediateClean :: IORef [FilePath],

663

664 665 666 667 668
  -- 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),

669
  -- hsc dynamic flags
670 671
  dumpFlags             :: IntSet,
  generalFlags          :: IntSet,
672
  warningFlags          :: IntSet,
673
  -- Don't change this without updating extensionFlags:
674
  language              :: Maybe Language,
675 676
  -- | Safe Haskell mode
  safeHaskell           :: SafeHaskellMode,
677 678 679
  -- 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.
680 681
  thOnLoc               :: SrcSpan,
  newDerivOnLoc         :: SrcSpan,
682
  pkgTrustOnLoc         :: SrcSpan,
683 684
  warnSafeOnLoc         :: SrcSpan,
  warnUnsafeOnLoc       :: SrcSpan,
685 686 687 688
  -- Don't change this without updating extensionFlags:
  extensions            :: [OnOff ExtensionFlag],
  -- extensionFlags should always be equal to
  --     flattenExtensionFlags language extensions
689
  extensionFlags        :: IntSet,
Ian Lynagh's avatar
Ian Lynagh committed
690

691 692 693 694 695 696 697 698 699
  -- Unfolding control
  -- See Note [Discounts and thresholds] in CoreUnfold
  ufCreationThreshold   :: Int,
  ufUseThreshold        :: Int,
  ufFunAppDiscount      :: Int,
  ufDictDiscount        :: Int,
  ufKeenessFactor       :: Float,
  ufDearOp              :: Int,

700 701
  maxWorkerArgs         :: Int,

702 703
  ghciHistSize          :: Int,

704
  -- | MsgDoc output action: use "ErrUtils" instead of this if you can
705
  log_action            :: LogAction,
706 707
  flushOut              :: FlushOut,
  flushErr              :: FlushErr,
David Waern's avatar
David Waern committed
708

709
  haddockOptions        :: Maybe String,
710
  ghciScripts           :: [String],
711

712 713
  -- Output style options
  pprUserLength         :: Int,
Ian Lynagh's avatar
Ian Lynagh committed
714
  pprCols               :: Int,
Ian Lynagh's avatar
Ian Lynagh committed
715
  traceLevel            :: Int, -- Standard level is 1. Less verbose is 0.
716

717 718
  useUnicodeQuotes      :: Bool,

719
  -- | what kind of {-# SCC #-} to add automatically
720 721
  profAuto              :: ProfAuto,

722
  interactivePrint      :: Maybe String,
723

724
  llvmVersion           :: IORef Int,
725

tibbe's avatar
tibbe committed
726 727 728 729
  nextWrapperNum        :: IORef Int,

  -- | Machine dependant flags (-m<blah> stuff)
  sseVersion            :: Maybe (Int, Int)  -- (major, minor)
730 731
 }

732 733 734
class HasDynFlags m where
    getDynFlags :: m DynFlags

Ian Lynagh's avatar
Ian Lynagh committed
735 736
class ContainsDynFlags t where
    extractDynFlags :: t -> DynFlags
737
    replaceDynFlags :: t -> DynFlags -> t
Ian Lynagh's avatar
Ian Lynagh committed
738

739 740 741 742 743
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
744
  | ProfAutoCalls      -- ^ annotate call-sites
Simon Marlow's avatar
Simon Marlow committed
745
  deriving (Enum)
746

747
data Settings = Settings {
748
  sTargetPlatform        :: Platform,    -- Filled in by SysTools
749 750 751 752 753 754 755 756 757
  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,
758 759 760
  sLdSupportsCompactUnwind :: Bool,
  sLdSupportsBuildId       :: Bool,
  sLdIsGnuLd               :: Bool,
761 762 763 764 765 766 767 768 769 770 771 772 773
  -- commands for particular phases
  sPgm_L                 :: String,
  sPgm_P                 :: (String,[Option]),
  sPgm_F                 :: String,
  sPgm_c                 :: (String,[Option]),
  sPgm_s                 :: (String,[Option]),
  sPgm_a                 :: (String,[Option]),
  sPgm_l                 :: (String,[Option]),
  sPgm_dll               :: (String,[Option]),
  sPgm_T                 :: String,
  sPgm_sysman            :: String,
  sPgm_windres           :: String,
  sPgm_lo                :: (String,[Option]), -- LLVM: opt llvm optimiser
774 775 776 777 778 779 780 781 782 783
  sPgm_lc                :: (String,[Option]), -- LLVM: llc static compiler
  -- options for particular phases
  sOpt_L                 :: [String],
  sOpt_P                 :: [String],
  sOpt_F                 :: [String],
  sOpt_c                 :: [String],
  sOpt_a                 :: [String],
  sOpt_l                 :: [String],
  sOpt_windres           :: [String],
  sOpt_lo                :: [String], -- LLVM: llvm optimiser
784
  sOpt_lc                :: [String], -- LLVM: llc static compiler
785

786
  sPlatformConstants     :: PlatformConstants
787 788
 }

789 790 791
targetPlatform :: DynFlags -> Platform
targetPlatform dflags = sTargetPlatform (settings dflags)

792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831
ghcUsagePath          :: DynFlags -> FilePath
ghcUsagePath dflags = sGhcUsagePath (settings dflags)
ghciUsagePath         :: DynFlags -> FilePath
ghciUsagePath dflags = sGhciUsagePath (settings dflags)
topDir                :: DynFlags -> FilePath
topDir dflags = sTopDir (settings dflags)
tmpDir                :: DynFlags -> String
tmpDir dflags = sTmpDir (settings dflags)
rawSettings           :: DynFlags -> [(String, String)]
rawSettings dflags = sRawSettings (settings dflags)
extraGccViaCFlags     :: DynFlags -> [String]
extraGccViaCFlags dflags = sExtraGccViaCFlags (settings dflags)
systemPackageConfig   :: DynFlags -> FilePath
systemPackageConfig dflags = sSystemPackageConfig (settings dflags)
pgm_L                 :: DynFlags -> String
pgm_L dflags = sPgm_L (settings dflags)
pgm_P                 :: DynFlags -> (String,[Option])
pgm_P dflags = sPgm_P (settings dflags)
pgm_F                 :: DynFlags -> String
pgm_F dflags = sPgm_F (settings dflags)
pgm_c                 :: DynFlags -> (String,[Option])
pgm_c dflags = sPgm_c (settings dflags)
pgm_s                 :: DynFlags -> (String,[Option])
pgm_s dflags = sPgm_s (settings dflags)
pgm_a                 :: DynFlags -> (String,[Option])
pgm_a dflags = sPgm_a (settings dflags)
pgm_l                 :: DynFlags -> (String,[Option])
pgm_l dflags = sPgm_l (settings dflags)
pgm_dll               :: DynFlags -> (String,[Option])
pgm_dll dflags = sPgm_dll (settings dflags)
pgm_T                 :: DynFlags -> String
pgm_T dflags = sPgm_T (settings dflags)
pgm_sysman            :: DynFlags -> String
pgm_sysman dflags = sPgm_sysman (settings dflags)
pgm_windres           :: DynFlags -> String
pgm_windres dflags = sPgm_windres (settings dflags)
pgm_lo                :: DynFlags -> (String,[Option])
pgm_lo dflags = sPgm_lo (settings dflags)
pgm_lc                :: DynFlags -> (String,[Option])
pgm_lc dflags = sPgm_lc (settings dflags)
832 833 834
opt_L                 :: DynFlags -> [String]
opt_L dflags = sOpt_L (settings dflags)
opt_P                 :: DynFlags -> [String]
835 836
opt_P dflags = concatMap (wayOptP (targetPlatform dflags)) (ways dflags)
            ++ sOpt_P (settings dflags)
837 838 839
opt_F                 :: DynFlags -> [String]
opt_F dflags = sOpt_F (settings dflags)
opt_c                 :: DynFlags -> [String]
840 841
opt_c dflags = concatMap (wayOptc (targetPlatform dflags)) (ways dflags)
            ++ sOpt_c (settings dflags)
842 843 844
opt_a                 :: DynFlags -> [String]
opt_a dflags = sOpt_a (settings dflags)
opt_l                 :: DynFlags -> [String]
845 846
opt_l dflags = concatMap (wayOptl (targetPlatform dflags)) (ways dflags)
            ++ sOpt_l (settings dflags)
847 848 849 850 851 852
opt_windres           :: DynFlags -> [String]
opt_windres dflags = sOpt_windres (settings dflags)
opt_lo                :: DynFlags -> [String]
opt_lo dflags = sOpt_lo (settings dflags)
opt_lc                :: DynFlags -> [String]
opt_lc dflags = sOpt_lc (settings dflags)
853

854 855
-- | The target code type of the compilation (if any).
--
856