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

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

48 49
        printOutputForUser, printInfoForUser,

ian@well-typed.com's avatar
ian@well-typed.com committed
50 51
        Way(..), mkBuildTag, wayRTSOnly,

52
        -- ** Safe Haskell
53
        SafeHaskellMode(..),
54
        safeHaskellOn, safeImportsOn, safeLanguageOn, safeInferOn,
55
        packageTrustOn,
56
        safeDirectImpsReq, safeImplicitImpsReq,
57
        unsafeFlags,
58

59
        -- ** System tool settings and locations
60
        Settings(..),
61
        targetPlatform,
62 63 64 65
        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
66
        opt_L, opt_P, opt_F, opt_c, opt_a, opt_l,
67
        opt_windres, opt_lo, opt_lc,
68 69


70
        -- ** Manipulating DynFlags
71
        defaultDynFlags,                -- Settings -> DynFlags
72
        defaultWays,
Ian Lynagh's avatar
Ian Lynagh committed
73
        initDynFlags,                   -- DynFlags -> IO DynFlags
Ian Lynagh's avatar
Ian Lynagh committed
74
        defaultFatalMessager,
75
        defaultLogAction,
76
        defaultLogActionHPrintDoc,
77 78
        defaultFlushOut,
        defaultFlushErr,
Ian Lynagh's avatar
Ian Lynagh committed
79

80
        getOpts,                        -- DynFlags -> (DynFlags -> [a]) -> [a]
81
        getVerbFlags,
Ian Lynagh's avatar
Ian Lynagh committed
82 83 84 85
        updOptLevel,
        setTmpDir,
        setPackageName,

86
        -- ** Parsing DynFlags
87 88
        parseDynamicFlagsCmdLine,
        parseDynamicFilePragma,
89 90 91
        parseDynamicFlagsFull,

        -- ** Available DynFlags
92
        allFlags,
93 94 95
        flagsAll,
        flagsDynamic,
        flagsPackage,
96

97
        supportedLanguagesAndExtensions,
98

99
        -- ** DynFlags C compiler options
Ian Lynagh's avatar
Ian Lynagh committed
100
        picCCOpts, picPOpts,
101 102 103 104 105 106

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

        -- * Compiler configuration suitable for display to the user
107 108
        compilerInfo,

109
#ifdef GHCI
dterei's avatar
dterei committed
110
-- Only in stage 2 can we be sure that the RTS
111
-- exposes the appropriate runtime boolean
112
        rtsIsProfiled,
113
#endif
114 115

#include "../includes/dist-derivedconstants/header/GHCConstantsHaskellExports.hs"
116
        bLOCK_SIZE_W,
117
        wORD_SIZE_IN_BITS,
118 119
        tAG_MASK,
        mAX_PTR_TAG,
120
        tARGET_MIN_INT, tARGET_MAX_INT, tARGET_MAX_WORD,
121 122 123 124
  ) where

#include "HsVersions.h"

125
import Platform
126
import Module
Simon Marlow's avatar
Simon Marlow committed
127
import PackageConfig
128
import {-# SOURCE #-} PrelNames ( mAIN )
129
import {-# SOURCE #-} Packages (PackageState)
Ian Lynagh's avatar
Ian Lynagh committed
130
import DriverPhases     ( Phase(..), phaseInputExt )
131 132
import Config
import CmdLineParser
133
import Constants
134
import Panic
135
import StaticFlags
136
import Util
137
import Maybes           ( orElse )
138
import MonadUtils
139
import qualified Pretty
140
import SrcLoc
141
import FastString
Simon Marlow's avatar
Simon Marlow committed
142
import Outputable
Ian Lynagh's avatar
Ian Lynagh committed
143
#ifdef GHCI
Ian Lynagh's avatar
Ian Lynagh committed
144
import Foreign.C        ( CInt(..) )
Ian Lynagh's avatar
Ian Lynagh committed
145
#endif
146
import {-# SOURCE #-} ErrUtils ( Severity(..), MsgDoc, mkLocMessage )
147

Ian Lynagh's avatar
Ian Lynagh committed
148
#ifdef GHCI
149
import System.IO.Unsafe ( unsafePerformIO )
Ian Lynagh's avatar
Ian Lynagh committed
150
#endif
151
import Data.IORef
ian@well-typed.com's avatar
ian@well-typed.com committed
152
import Control.Monad
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
153

154
import Data.Bits
155
import Data.Char
156
import Data.Int
157
import Data.List
158 159
import Data.Map (Map)
import qualified Data.Map as Map
160 161
import Data.Set (Set)
import qualified Data.Set as Set
162
import Data.Word
Ian Lynagh's avatar
Ian Lynagh committed
163
import System.FilePath
164
import System.IO
165

166 167 168
import Data.IntSet (IntSet)
import qualified Data.IntSet as IntSet

169 170 171
-- -----------------------------------------------------------------------------
-- DynFlags

172
data DumpFlag
173 174 175

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

Ian Lynagh's avatar
Ian Lynagh committed
257
   | Opt_WarnIsError                    -- -Werror; makes warnings fatal
258

259 260
   | Opt_PrintExplicitForalls

261 262 263
   -- optimisation opts
   | Opt_Strictness
   | Opt_FullLaziness
264 265
   | Opt_FloatIn
   | Opt_Specialise
266
   | Opt_StaticArgumentTransformation
267
   | Opt_CSE
268 269
   | Opt_LiberateCase
   | Opt_SpecConstr
270 271 272 273 274
   | Opt_DoLambdaEtaExpansion
   | Opt_IgnoreAsserts
   | Opt_DoEtaReduction
   | Opt_CaseMerge
   | Opt_UnboxStrictFields
275
   | Opt_UnboxSmallStrictFields
276
   | Opt_DictsCheap
277
   | Opt_EnableRewriteRules             -- Apply rewrite rules during simplification
rl@cse.unsw.edu.au's avatar
rl@cse.unsw.edu.au committed
278
   | Opt_Vectorise
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
279
   | Opt_AvoidVect
Ian Lynagh's avatar
Ian Lynagh committed
280 281
   | Opt_RegsGraph                      -- do graph coloring register allocation
   | Opt_RegsIterative                  -- do iterative coalescing graph coloring register allocation
282
   | Opt_PedanticBottoms                -- Be picky about how we treat bottom
283
   | Opt_LlvmTBAA                       -- Use LLVM TBAA infastructure for improving AA (hidden flag)
284
   | Opt_IrrefutableTuples
285
   | Opt_CmmSink
286
   | Opt_CmmElimCommonBlocks
287
   | Opt_OmitYields
288
   | Opt_SimpleListLiterals
289

290 291 292 293 294
   -- Interface files
   | Opt_IgnoreInterfacePragmas
   | Opt_OmitInterfacePragmas
   | Opt_ExposeAllUnfoldings

Ian Lynagh's avatar
Ian Lynagh committed
295 296
   -- profiling opts
   | Opt_AutoSccsOnIndividualCafs
297
   | Opt_ProfCountEntries
Ian Lynagh's avatar
Ian Lynagh committed
298

299 300
   -- misc opts
   | Opt_Pp
301
   | Opt_ForceRecomp
302
   | Opt_ExcessPrecision
303
   | Opt_EagerBlackHoling
304 305 306
   | Opt_NoHsMain
   | Opt_SplitObjs
   | Opt_StgStats
307
   | Opt_HideAllPackages
308
   | Opt_PrintBindResult
309
   | Opt_Haddock
David Waern's avatar
David Waern committed
310
   | Opt_HaddockOptions
311
   | Opt_Hpc_No_Auto
312
   | Opt_BreakOnException
313
   | Opt_BreakOnError
314
   | Opt_PrintEvldWithShow
315
   | Opt_PrintBindContents
316 317
   | Opt_GenManifest
   | Opt_EmbedManifest
318
   | Opt_EmitExternalCore
Ian Lynagh's avatar
Ian Lynagh committed
319
   | Opt_SharedImplib
320
   | Opt_BuildingCabalPackage
321
   | Opt_SSE2
tibbe's avatar
tibbe committed
322
   | Opt_SSE4_2
323
   | Opt_IgnoreDotGhci
324
   | Opt_GhciSandbox
Ian Lynagh's avatar
Ian Lynagh committed
325
   | Opt_GhciHistory
326
   | Opt_HelpfulErrors
327
   | Opt_DeferTypeErrors
Ian Lynagh's avatar
Ian Lynagh committed
328
   | Opt_Parallel
Ian Lynagh's avatar
Ian Lynagh committed
329
   | Opt_GranMacros
Ian Lynagh's avatar
Ian Lynagh committed
330
   | Opt_PIC
331
   | Opt_SccProfilingOn
ian@well-typed.com's avatar
ian@well-typed.com committed
332 333
   | Opt_Ticky
   | Opt_Static
334
   | Opt_RPath
335
   | Opt_RelativeDynlibPaths
ian@well-typed.com's avatar
ian@well-typed.com committed
336
   | Opt_Hpc
337

338 339 340 341
   -- PreInlining is on by default. The option is there just to see how
   -- bad things get if you turn it off!
   | Opt_SimplPreInlining

342
   -- output style opts
343 344
   | Opt_ErrorSpans -- Include full span info in error messages,
                    -- instead of just the start position.
345
   | Opt_PprCaseAsLet
346

347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363
   -- 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

364
   -- temporary flags
365
   | Opt_RunCPS
366
   | Opt_RunCPSZ
367
   | Opt_AutoLinkPackages
368
   | Opt_ImplicitImportQualified
369 370 371 372 373 374

   -- keeping stuff
   | Opt_KeepHiDiffs
   | Opt_KeepHcFiles
   | Opt_KeepSFiles
   | Opt_KeepTmpFiles
Jedai's avatar
Jedai committed
375
   | Opt_KeepRawTokenStream
376
   | Opt_KeepLlvmFiles
377

378 379
   | Opt_BuildDynamicToo

380
   -- safe haskell flags
dterei's avatar
dterei committed
381
   | Opt_DistrustAllPackages
382 383
   | Opt_PackageTrust

384
   deriving (Eq, Show, Enum)
Ian Lynagh's avatar
Ian Lynagh committed
385

386 387
data WarningFlag =
     Opt_WarnDuplicateExports
388
   | Opt_WarnDuplicateConstraints
389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419
   | 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
420 421
   | Opt_WarnUnsafe
   | Opt_WarnSafe
Ian Lynagh's avatar
Ian Lynagh committed
422
   | Opt_WarnPointlessPragmas
423
   | Opt_WarnUnsupportedCallingConventions
424
   | Opt_WarnInlineRuleShadowing
425
   deriving (Eq, Show, Enum)
426

427
data Language = Haskell98 | Haskell2010
428
   deriving Enum
429

430
-- | The various Safe Haskell modes
431 432
data SafeHaskellMode
   = Sf_None
dterei's avatar
dterei committed
433
   | Sf_Unsafe
434 435
   | Sf_Trustworthy
   | Sf_Safe
436
   | Sf_SafeInferred
437 438
   deriving (Eq)

Ian Lynagh's avatar
Ian Lynagh committed
439
instance Show SafeHaskellMode where
Ian Lynagh's avatar
Ian Lynagh committed
440 441 442 443 444
    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
445

446
instance Outputable SafeHaskellMode where
Ian Lynagh's avatar
Ian Lynagh committed
447
    ppr = text . show
448

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

   | Opt_TypeSynonymInstances
   | Opt_FlexibleContexts
   | Opt_FlexibleInstances
   | Opt_ConstrainedClassMethods
   | Opt_MultiParamTypeClasses
   | Opt_FunctionalDependencies
   | Opt_UnicodeSyntax
   | Opt_ExistentialQuantification
   | Opt_MagicHash
   | Opt_EmptyDataDecls
   | Opt_KindSignatures
   | Opt_ParallelListComp
   | Opt_TransformListComp
511
   | Opt_MonadComprehensions
512 513 514 515 516 517 518 519 520
   | Opt_GeneralizedNewtypeDeriving
   | Opt_RecursiveDo
   | Opt_PostfixOperators
   | Opt_TupleSections
   | Opt_PatternGuards
   | Opt_LiberalTypeSynonyms
   | Opt_RankNTypes
   | Opt_ImpredicativeTypes
   | Opt_TypeOperators
521
   | Opt_ExplicitNamespaces
522 523 524 525 526
   | Opt_PackageImports
   | Opt_ExplicitForAll
   | Opt_AlternativeLayoutRule
   | Opt_AlternativeLayoutRuleTransitional
   | Opt_DatatypeContexts
527
   | Opt_NondecreasingIndentation
528
   | Opt_RelaxedLayout
529
   | Opt_TraditionalRecordSyntax
530
   | Opt_LambdaCase
531
   | Opt_MultiWayIf
532
   | Opt_TypeHoles
533
   | Opt_EmptyCase
534
   deriving (Eq, Enum, Show)
535

536
-- | Contains not only a collection of 'GeneralFlag's but also a plethora of
537
-- information relating to the compilation of a single file or GHC session
538
data DynFlags = DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
539 540 541
  ghcMode               :: GhcMode,
  ghcLink               :: GhcLink,
  hscTarget             :: HscTarget,
542
  settings              :: Settings,
543
  hscOutName            :: String,      -- ^ Name of the output file
544
  extCoreName           :: String,      -- ^ Name of the .hcr output file
545
  verbosity             :: Int,         -- ^ Verbosity level: see Note [Verbosity levels]
546 547 548
  optLevel              :: Int,         -- ^ Optimisation level
  simplPhases           :: Int,         -- ^ Number of simplifier phases
  maxSimplIterations    :: Int,         -- ^ Max simplifier iterations
549
  shouldDumpSimplPhase  :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
550
  ruleCheck             :: Maybe String,
551
  strictnessBefore      :: [Int],       -- ^ Additional demand analysis
552

553
  simplTickFactor       :: Int,         -- ^ Multiplier for simplifier ticks
554 555 556
  specConstrThreshold   :: Maybe Int,   -- ^ Threshold for SpecConstr
  specConstrCount       :: Maybe Int,   -- ^ Max number of specialisations for any one function
  liberateCaseThreshold :: Maybe Int,   -- ^ Threshold for LiberateCase
557
  floatLamArgs          :: Maybe Int,   -- ^ Arg count for lambda floating
558
                                        --   See CoreMonad.FloatOutSwitches
559
  historySize           :: Int,
560

561
  cmdlineHcIncludes     :: [String],    -- ^ @\-\#includes@
Ian Lynagh's avatar
Ian Lynagh committed
562 563 564
  importPaths           :: [FilePath],
  mainModIs             :: Module,
  mainFunIs             :: Maybe String,
565
  ctxtStkDepth          :: Int,         -- ^ Typechecker context stack depth
566

567
  thisPackage           :: PackageId,   -- ^ name of package currently being compiled
568 569

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

574 575 576
  -- For object splitting
  splitInfo             :: Maybe (String,Int),

577
  -- paths etc.
Ian Lynagh's avatar
Ian Lynagh committed
578
  objectDir             :: Maybe String,
579
  dylibInstallName      :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
580 581
  hiDir                 :: Maybe String,
  stubDir               :: Maybe String,
582
  dumpDir               :: Maybe String,
583

Ian Lynagh's avatar
Ian Lynagh committed
584 585 586
  objectSuf             :: String,
  hcSuf                 :: String,
  hiSuf                 :: String,
587

588 589 590 591
  canGenerateDynamicToo :: IORef Bool,
  dynObjectSuf          :: String,
  dynHiSuf              :: String,

Ian Lynagh's avatar
Ian Lynagh committed
592 593 594
  outputFile            :: Maybe String,
  outputHi              :: Maybe String,
  dynLibLoader          :: DynLibLoader,
595

596
  -- | This is set by 'DriverPipeline.runPipeline' based on where
Ian Lynagh's avatar
Ian Lynagh committed
597 598
  --    its output is going.
  dumpPrefix            :: Maybe FilePath,
599

600 601
  -- | Override the 'dumpPrefix' set by 'DriverPipeline.runPipeline'.
  --    Set by @-ddump-file-prefix@
Ian Lynagh's avatar
Ian Lynagh committed
602 603
  dumpPrefixForce       :: Maybe FilePath,

604 605
  ldInputs              :: [String],

Ian Lynagh's avatar
Ian Lynagh committed
606 607 608 609 610
  includePaths          :: [String],
  libraryPaths          :: [String],
  frameworkPaths        :: [String],    -- used on darwin only
  cmdlineFrameworks     :: [String],    -- ditto

611
  rtsOpts               :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
612
  rtsOptsEnabled        :: RtsOptsEnabled,
613

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

616 617 618 619
  -- Plugins
  pluginModNames        :: [ModuleName],
  pluginModNameOpts     :: [(ModuleName,String)],

620 621 622 623 624 625
  --  For ghc -M
  depMakefile           :: FilePath,
  depIncludePkgDeps     :: Bool,
  depExcludeMods        :: [ModuleName],
  depSuffixes           :: [String],

626
  --  Package flags
627
  extraPkgConfs         :: [PkgConfRef] -> [PkgConfRef],
628
        -- ^ The @-package-db@ flags given on the command line, in the order
Ian Lynagh's avatar
Ian Lynagh committed
629
        -- they appeared.
630

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

634
  -- Package state
Ian Lynagh's avatar
Ian Lynagh committed
635
  -- NB. do not modify this field, it is calculated by
636
  -- Packages.initPackages and Packages.updatePackages.
637
  pkgDatabase           :: Maybe [PackageConfig],
Ian Lynagh's avatar
Ian Lynagh committed
638
  pkgState              :: PackageState,
639

640 641 642 643
  -- Temporary files
  -- These have to be IORefs, because the defaultCleanupHandler needs to
  -- know what to clean when an exception happens
  filesToClean          :: IORef [FilePath],
644
  dirsToClean           :: IORef (Map FilePath FilePath),
645 646
  filesToNotIntermediateClean :: IORef [FilePath],

647

648 649 650 651 652
  -- 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),

653
  -- hsc dynamic flags
654 655
  dumpFlags             :: IntSet,
  generalFlags          :: IntSet,
656
  warningFlags          :: IntSet,
657
  -- Don't change this without updating extensionFlags:
658
  language              :: Maybe Language,
659 660
  -- | Safe Haskell mode
  safeHaskell           :: SafeHaskellMode,
661 662 663
  -- 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.
664 665
  thOnLoc               :: SrcSpan,
  newDerivOnLoc         :: SrcSpan,
666
  pkgTrustOnLoc         :: SrcSpan,
667 668
  warnSafeOnLoc         :: SrcSpan,
  warnUnsafeOnLoc       :: SrcSpan,
669 670 671 672
  -- Don't change this without updating extensionFlags:
  extensions            :: [OnOff ExtensionFlag],
  -- extensionFlags should always be equal to
  --     flattenExtensionFlags language extensions
673
  extensionFlags        :: IntSet,
Ian Lynagh's avatar
Ian Lynagh committed
674

675 676 677 678 679 680 681 682 683
  -- Unfolding control
  -- See Note [Discounts and thresholds] in CoreUnfold
  ufCreationThreshold   :: Int,
  ufUseThreshold        :: Int,
  ufFunAppDiscount      :: Int,
  ufDictDiscount        :: Int,
  ufKeenessFactor       :: Float,
  ufDearOp              :: Int,

684 685
  maxWorkerArgs         :: Int,

686 687
  ghciHistSize          :: Int,

688
  -- | MsgDoc output action: use "ErrUtils" instead of this if you can
689
  log_action            :: LogAction,
690 691
  flushOut              :: FlushOut,
  flushErr              :: FlushErr,
David Waern's avatar
David Waern committed
692

693
  haddockOptions        :: Maybe String,
694
  ghciScripts           :: [String],
695

696 697
  -- Output style options
  pprUserLength         :: Int,
Ian Lynagh's avatar
Ian Lynagh committed
698
  pprCols               :: Int,
Ian Lynagh's avatar
Ian Lynagh committed
699
  traceLevel            :: Int, -- Standard level is 1. Less verbose is 0.
700 701

  -- | what kind of {-# SCC #-} to add automatically
702 703
  profAuto              :: ProfAuto,

704
  interactivePrint      :: Maybe String,
705

706
  llvmVersion           :: IORef Int,
707 708

  nextWrapperNum        :: IORef Int
709 710
 }

711 712 713
class HasDynFlags m where
    getDynFlags :: m DynFlags

Ian Lynagh's avatar
Ian Lynagh committed
714 715
class ContainsDynFlags t where
    extractDynFlags :: t -> DynFlags
716
    replaceDynFlags :: t -> DynFlags -> t
Ian Lynagh's avatar
Ian Lynagh committed
717

718 719 720 721 722
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
723
  | ProfAutoCalls      -- ^ annotate call-sites
Simon Marlow's avatar
Simon Marlow committed
724
  deriving (Enum)
725

726
data Settings = Settings {
727
  sTargetPlatform        :: Platform,    -- Filled in by SysTools
728 729 730 731 732 733 734 735 736
  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,
737 738 739
  sLdSupportsCompactUnwind :: Bool,
  sLdSupportsBuildId       :: Bool,
  sLdIsGnuLd               :: Bool,
740 741 742 743 744 745 746 747 748 749 750 751 752
  -- 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
753 754 755 756 757 758 759 760 761 762
  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
763
  sOpt_lc                :: [String], -- LLVM: llc static compiler
764

765
  sPlatformConstants     :: PlatformConstants
766 767
 }

768 769 770
targetPlatform :: DynFlags -> Platform
targetPlatform dflags = sTargetPlatform (settings dflags)

771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810
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)
811 812 813
opt_L                 :: DynFlags -> [String]
opt_L dflags = sOpt_L (settings dflags)
opt_P                 :: DynFlags -> [String]
814 815
opt_P dflags = concatMap (wayOptP (targetPlatform dflags)) (ways dflags)
            ++ sOpt_P (settings dflags)
816 817 818
opt_F                 :: DynFlags -> [String]
opt_F dflags = sOpt_F (settings dflags)
opt_c                 :: DynFlags -> [String]
819 820
opt_c dflags = concatMap (wayOptc (targetPlatform dflags)) (ways dflags)
            ++ sOpt_c (settings dflags)
821 822 823
opt_a                 :: DynFlags -> [String]
opt_a dflags = sOpt_a (settings dflags)
opt_l                 :: DynFlags -> [String]
824 825
opt_l dflags = concatMap (wayOptl (targetPlatform dflags)) (ways dflags)
            ++ sOpt_l (settings dflags)
826 827 828 829 830 831
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)
832

833 834
-- | The target code type of the compilation (if any).
--
835 836 837
-- Whenever you change the target, also make sure to set 'ghcLink' to
-- something sensible.
--
838 839 840 841
-- 'HscNothing' can be used to avoid generating any output, however, note
-- that:
--
--  * This will not run the desugaring step, thus no warnings generated in
842 843 844
--    this step will be output.  In particular, this includes warnings related
--    to pattern matching.  You can run the desugarer manually using
--    'GHC.desugarModule'.
845
--
846 847 848 849
--  * If a program uses Template Haskell the typechecker may try to run code
--    from an imported module.  This will fail if no code has been generated
--    for this module.  You can use 'GHC.needsTemplateHaskell' to detect
--    whether this might be the case and choose to either switch to a
SimonHengel's avatar
SimonHengel committed
850
--    different target or avoid typechecking such modules.  (The latter may be
851
--    preferable for security reasons.)
852
--
853
data HscTarget
854 855
  = HscC           -- ^ Generate C code.
  | HscAsm         -- ^ Generate assembly using the native code generator.
856
  | HscLlvm        -- ^ Generate assembly using the llvm code generator.
857 858
  | HscInterpreted -- ^ Generate bytecode.  (Requires 'LinkInMemory')
  | HscNothing     -- ^ Don't generate any code.  See notes above.
859 860
  deriving (Eq, Show)

861
-- | Will this target result in an object file on the disk?
862 863 864
isObjectTarget :: HscTarget -> Bool
isObjectTarget HscC     = True
isObjectTarget HscAsm   = True