DynFlags.hs 135 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 26 27 28
        dopt,
        gopt, gopt_set, gopt_unset,
        wopt, wopt_set, wopt_unset,
        xopt, xopt_set, xopt_unset,
29
        lang_set,
Ian Lynagh's avatar
Ian Lynagh committed
30
        DynFlags(..),
Ian Lynagh's avatar
Ian Lynagh committed
31
        HasDynFlags(..), ContainsDynFlags(..),
Ian Lynagh's avatar
Ian Lynagh committed
32
        RtsOptsEnabled(..),
Ian Lynagh's avatar
Ian Lynagh committed
33
        HscTarget(..), isObjectTarget, defaultObjectTarget,
34
        targetRetainsAllBindings,
Ian Lynagh's avatar
Ian Lynagh committed
35 36 37
        GhcMode(..), isOneShot,
        GhcLink(..), isNoLink,
        PackageFlag(..),
38
        PkgConfRef(..),
Ian Lynagh's avatar
Ian Lynagh committed
39
        Option(..), showOpt,
Ian Lynagh's avatar
Ian Lynagh committed
40
        DynLibLoader(..),
41
        fFlags, fWarningFlags, fLangFlags, xFlags,
42
        dynFlagDependencies,
43
        tablesNextToCode, mkTablesNextToCode,
44

45 46
        printOutputForUser, printInfoForUser,

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

49
        -- ** Safe Haskell
50
        SafeHaskellMode(..),
51
        safeHaskellOn, safeImportsOn, safeLanguageOn, safeInferOn,
52
        packageTrustOn,
53
        safeDirectImpsReq, safeImplicitImpsReq,
54
        unsafeFlags,
55

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


67
        -- ** Manipulating DynFlags
68
        defaultDynFlags,                -- Settings -> DynFlags
Ian Lynagh's avatar
Ian Lynagh committed
69
        initDynFlags,                   -- DynFlags -> IO DynFlags
Ian Lynagh's avatar
Ian Lynagh committed
70
        defaultFatalMessager,
71
        defaultLogAction,
72
        defaultLogActionHPrintDoc,
73 74
        defaultFlushOut,
        defaultFlushErr,
Ian Lynagh's avatar
Ian Lynagh committed
75

76
        getOpts,                        -- DynFlags -> (DynFlags -> [a]) -> [a]
77
        getVerbFlags,
Ian Lynagh's avatar
Ian Lynagh committed
78 79 80 81
        updOptLevel,
        setTmpDir,
        setPackageName,

82
        -- ** Parsing DynFlags
83 84
        parseDynamicFlagsCmdLine,
        parseDynamicFilePragma,
85 86 87
        parseDynamicFlagsFull,

        -- ** Available DynFlags
88
        allFlags,
89 90 91
        flagsAll,
        flagsDynamic,
        flagsPackage,
92

93
        supportedLanguagesAndExtensions,
94

95
        -- ** DynFlags C compiler options
Ian Lynagh's avatar
Ian Lynagh committed
96
        picCCOpts, picPOpts,
97 98 99 100 101 102

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

        -- * Compiler configuration suitable for display to the user
103 104
        compilerInfo,

105
#ifdef GHCI
dterei's avatar
dterei committed
106
-- Only in stage 2 can we be sure that the RTS
107
-- exposes the appropriate runtime boolean
108
        rtsIsProfiled,
109
#endif
110 111

#include "../includes/dist-derivedconstants/header/GHCConstantsHaskellExports.hs"
112
        bLOCK_SIZE_W,
113
        wORD_SIZE_IN_BITS,
114 115
        tAG_MASK,
        mAX_PTR_TAG,
116
        tARGET_MIN_INT, tARGET_MAX_INT, tARGET_MAX_WORD,
117 118 119 120
  ) where

#include "HsVersions.h"

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

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

150
import Data.Bits
151
import Data.Char
152
import Data.Int
153
import Data.List
154 155
import Data.Map (Map)
import qualified Data.Map as Map
156 157
import Data.Set (Set)
import qualified Data.Set as Set
158
import Data.Word
Ian Lynagh's avatar
Ian Lynagh committed
159
import System.FilePath
160
import System.IO
161

162 163 164
import Data.IntSet (IntSet)
import qualified Data.IntSet as IntSet

165 166 167
-- -----------------------------------------------------------------------------
-- DynFlags

168
data DumpFlag
169 170 171

   -- debugging flags
   = Opt_D_dump_cmm
172
   | Opt_D_dump_raw_cmm
173
   | Opt_D_dump_cmmz
174 175
   -- All of the cmmz subflags (there are a lot!)  Automatically
   -- enabled if you run -ddump-cmmz
Simon Marlow's avatar
Simon Marlow committed
176
   | Opt_D_dump_cmmz_cfg
177 178 179 180 181 182 183 184
   | Opt_D_dump_cmmz_cbe
   | Opt_D_dump_cmmz_proc
   | Opt_D_dump_cmmz_rewrite
   | Opt_D_dump_cmmz_sp
   | Opt_D_dump_cmmz_procmap
   | Opt_D_dump_cmmz_split
   | Opt_D_dump_cmmz_info
   -- end cmmz subflags
185
   | Opt_D_dump_cps_cmm
186
   | Opt_D_dump_asm
187 188 189 190 191
   | 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
192
   | Opt_D_dump_asm_stats
193
   | Opt_D_dump_asm_expanded
194
   | Opt_D_dump_llvm
195
   | Opt_D_dump_core_stats
196 197 198 199
   | Opt_D_dump_deriv
   | Opt_D_dump_ds
   | Opt_D_dump_foreign
   | Opt_D_dump_inlinings
200
   | Opt_D_dump_rule_firings
201
   | Opt_D_dump_rule_rewrites
202 203 204
   | Opt_D_dump_occur_anal
   | Opt_D_dump_parsed
   | Opt_D_dump_rn
205
   | Opt_D_dump_core_pipeline -- TODO FIXME: dump after simplifier stats
206 207
   | Opt_D_dump_simpl
   | Opt_D_dump_simpl_iterations
208
   | Opt_D_dump_simpl_phases
209 210 211 212 213 214 215 216 217 218 219 220 221
   | 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
222
   | Opt_D_dump_cs_trace -- Constraint solver in type checker
223 224
   | Opt_D_dump_tc_trace
   | Opt_D_dump_if_trace
225
   | Opt_D_dump_vt_trace
226 227 228
   | Opt_D_dump_splices
   | Opt_D_dump_BCOs
   | Opt_D_dump_vect
229
   | Opt_D_dump_ticked
pepe's avatar
pepe committed
230
   | Opt_D_dump_rtti
231 232 233 234
   | Opt_D_source_stats
   | Opt_D_verbose_stg2stg
   | Opt_D_dump_hi
   | Opt_D_dump_hi_diffs
235
   | Opt_D_dump_mod_cycles
236
   | Opt_D_dump_view_pattern_commoning
237 238 239 240 241 242 243 244
   | 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.
245
   | Opt_D_faststring_stats
246
   | Opt_D_dump_minimal_imports
247 248 249
   | Opt_DoCoreLinting
   | Opt_DoStgLinting
   | Opt_DoCmmLinting
Ben.Lippmeier@anu.edu.au's avatar
Ben.Lippmeier@anu.edu.au committed
250
   | Opt_DoAsmLinting
251
   | Opt_NoLlvmMangler                 -- hidden flag
252

Ian Lynagh's avatar
Ian Lynagh committed
253
   | Opt_WarnIsError                    -- -Werror; makes warnings fatal
254

255 256
   | Opt_PrintExplicitForalls

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

286 287 288 289 290
   -- Interface files
   | Opt_IgnoreInterfacePragmas
   | Opt_OmitInterfacePragmas
   | Opt_ExposeAllUnfoldings

Ian Lynagh's avatar
Ian Lynagh committed
291 292
   -- profiling opts
   | Opt_AutoSccsOnIndividualCafs
293
   | Opt_ProfCountEntries
Ian Lynagh's avatar
Ian Lynagh committed
294

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

334 335 336 337
   -- PreInlining is on by default. The option is there just to see how
   -- bad things get if you turn it off!
   | Opt_SimplPreInlining

338
   -- output style opts
339 340
   | Opt_ErrorSpans -- Include full span info in error messages,
                    -- instead of just the start position.
341
   | Opt_PprCaseAsLet
342

343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359
   -- 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

360
   -- temporary flags
361
   | Opt_RunCPS
362
   | Opt_RunCPSZ
363
   | Opt_AutoLinkPackages
364
   | Opt_ImplicitImportQualified
365 366 367 368 369 370

   -- keeping stuff
   | Opt_KeepHiDiffs
   | Opt_KeepHcFiles
   | Opt_KeepSFiles
   | Opt_KeepTmpFiles
Jedai's avatar
Jedai committed
371
   | Opt_KeepRawTokenStream
372
   | Opt_KeepLlvmFiles
373

374
   -- safe haskell flags
dterei's avatar
dterei committed
375
   | Opt_DistrustAllPackages
376 377
   | Opt_PackageTrust

378
   deriving (Eq, Show, Enum)
Ian Lynagh's avatar
Ian Lynagh committed
379

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

420
data Language = Haskell98 | Haskell2010
421
   deriving Enum
422

423
-- | The various Safe Haskell modes
424 425
data SafeHaskellMode
   = Sf_None
dterei's avatar
dterei committed
426
   | Sf_Unsafe
427 428
   | Sf_Trustworthy
   | Sf_Safe
429
   | Sf_SafeInferred
430 431
   deriving (Eq)

Ian Lynagh's avatar
Ian Lynagh committed
432
instance Show SafeHaskellMode where
Ian Lynagh's avatar
Ian Lynagh committed
433 434 435 436 437
    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
438

439
instance Outputable SafeHaskellMode where
Ian Lynagh's avatar
Ian Lynagh committed
440
    ppr = text . show
441

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

   | Opt_TypeSynonymInstances
   | Opt_FlexibleContexts
   | Opt_FlexibleInstances
   | Opt_ConstrainedClassMethods
   | Opt_MultiParamTypeClasses
   | Opt_FunctionalDependencies
   | Opt_UnicodeSyntax
   | Opt_PolymorphicComponents
   | Opt_ExistentialQuantification
   | Opt_MagicHash
   | Opt_EmptyDataDecls
   | Opt_KindSignatures
   | Opt_ParallelListComp
   | Opt_TransformListComp
504
   | Opt_MonadComprehensions
505 506 507 508 509 510 511 512 513 514
   | Opt_GeneralizedNewtypeDeriving
   | Opt_RecursiveDo
   | Opt_PostfixOperators
   | Opt_TupleSections
   | Opt_PatternGuards
   | Opt_LiberalTypeSynonyms
   | Opt_Rank2Types
   | Opt_RankNTypes
   | Opt_ImpredicativeTypes
   | Opt_TypeOperators
515
   | Opt_ExplicitNamespaces
516 517 518 519 520
   | Opt_PackageImports
   | Opt_ExplicitForAll
   | Opt_AlternativeLayoutRule
   | Opt_AlternativeLayoutRuleTransitional
   | Opt_DatatypeContexts
521
   | Opt_NondecreasingIndentation
522
   | Opt_RelaxedLayout
523
   | Opt_TraditionalRecordSyntax
524
   | Opt_LambdaCase
525
   | Opt_MultiWayIf
526
   | Opt_TypeHoles
527
   deriving (Eq, Enum, Show)
528

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

546
  simplTickFactor       :: Int,         -- ^ Multiplier for simplifier ticks
547 548 549
  specConstrThreshold   :: Maybe Int,   -- ^ Threshold for SpecConstr
  specConstrCount       :: Maybe Int,   -- ^ Max number of specialisations for any one function
  liberateCaseThreshold :: Maybe Int,   -- ^ Threshold for LiberateCase
550
  floatLamArgs          :: Maybe Int,   -- ^ Arg count for lambda floating
551
                                        --   See CoreMonad.FloatOutSwitches
552
  historySize           :: Int,
553

554
  cmdlineHcIncludes     :: [String],    -- ^ @\-\#includes@
Ian Lynagh's avatar
Ian Lynagh committed
555 556 557
  importPaths           :: [FilePath],
  mainModIs             :: Module,
  mainFunIs             :: Maybe String,
558
  ctxtStkDepth          :: Int,         -- ^ Typechecker context stack depth
559

560
  thisPackage           :: PackageId,   -- ^ name of package currently being compiled
561 562

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

567 568 569
  -- For object splitting
  splitInfo             :: Maybe (String,Int),

570
  -- paths etc.
Ian Lynagh's avatar
Ian Lynagh committed
571
  objectDir             :: Maybe String,
572
  dylibInstallName      :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
573 574
  hiDir                 :: Maybe String,
  stubDir               :: Maybe String,
575
  dumpDir               :: Maybe String,
576

Ian Lynagh's avatar
Ian Lynagh committed
577 578 579
  objectSuf             :: String,
  hcSuf                 :: String,
  hiSuf                 :: String,
580

Ian Lynagh's avatar
Ian Lynagh committed
581 582 583
  outputFile            :: Maybe String,
  outputHi              :: Maybe String,
  dynLibLoader          :: DynLibLoader,
584

585
  -- | This is set by 'DriverPipeline.runPipeline' based on where
Ian Lynagh's avatar
Ian Lynagh committed
586 587
  --    its output is going.
  dumpPrefix            :: Maybe FilePath,
588

589 590
  -- | Override the 'dumpPrefix' set by 'DriverPipeline.runPipeline'.
  --    Set by @-ddump-file-prefix@
Ian Lynagh's avatar
Ian Lynagh committed
591 592
  dumpPrefixForce       :: Maybe FilePath,

593 594
  ldInputs              :: [String],

Ian Lynagh's avatar
Ian Lynagh committed
595 596 597 598 599
  includePaths          :: [String],
  libraryPaths          :: [String],
  frameworkPaths        :: [String],    -- used on darwin only
  cmdlineFrameworks     :: [String],    -- ditto

600
  rtsOpts               :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
601
  rtsOptsEnabled        :: RtsOptsEnabled,
602

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

605 606 607 608
  -- Plugins
  pluginModNames        :: [ModuleName],
  pluginModNameOpts     :: [(ModuleName,String)],

609 610 611 612 613 614
  --  For ghc -M
  depMakefile           :: FilePath,
  depIncludePkgDeps     :: Bool,
  depExcludeMods        :: [ModuleName],
  depSuffixes           :: [String],

615
  --  Package flags
616
  extraPkgConfs         :: [PkgConfRef] -> [PkgConfRef],
617
        -- ^ The @-package-db@ flags given on the command line, in the order
Ian Lynagh's avatar
Ian Lynagh committed
618
        -- they appeared.
619

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

623
  -- Package state
Ian Lynagh's avatar
Ian Lynagh committed
624
  -- NB. do not modify this field, it is calculated by
625
  -- Packages.initPackages and Packages.updatePackages.
626
  pkgDatabase           :: Maybe [PackageConfig],
Ian Lynagh's avatar
Ian Lynagh committed
627
  pkgState              :: PackageState,
628

629 630 631 632
  -- Temporary files
  -- These have to be IORefs, because the defaultCleanupHandler needs to
  -- know what to clean when an exception happens
  filesToClean          :: IORef [FilePath],
633
  dirsToClean           :: IORef (Map FilePath FilePath),
634 635
  filesToNotIntermediateClean :: IORef [FilePath],

636

637 638 639 640 641
  -- 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),

642
  -- hsc dynamic flags
643 644
  dumpFlags             :: IntSet,
  generalFlags          :: IntSet,
645
  warningFlags          :: IntSet,
646
  -- Don't change this without updating extensionFlags:
647
  language              :: Maybe Language,
648 649
  -- | Safe Haskell mode
  safeHaskell           :: SafeHaskellMode,
650 651 652
  -- 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.
653 654
  thOnLoc               :: SrcSpan,
  newDerivOnLoc         :: SrcSpan,
655
  pkgTrustOnLoc         :: SrcSpan,
656 657
  warnSafeOnLoc         :: SrcSpan,
  warnUnsafeOnLoc       :: SrcSpan,
658 659 660 661
  -- Don't change this without updating extensionFlags:
  extensions            :: [OnOff ExtensionFlag],
  -- extensionFlags should always be equal to
  --     flattenExtensionFlags language extensions
662
  extensionFlags        :: IntSet,
Ian Lynagh's avatar
Ian Lynagh committed
663

664 665 666 667 668 669 670 671 672
  -- Unfolding control
  -- See Note [Discounts and thresholds] in CoreUnfold
  ufCreationThreshold   :: Int,
  ufUseThreshold        :: Int,
  ufFunAppDiscount      :: Int,
  ufDictDiscount        :: Int,
  ufKeenessFactor       :: Float,
  ufDearOp              :: Int,

673 674
  maxWorkerArgs         :: Int,

675
  -- | MsgDoc output action: use "ErrUtils" instead of this if you can
676
  log_action            :: LogAction,
677 678
  flushOut              :: FlushOut,
  flushErr              :: FlushErr,
David Waern's avatar
David Waern committed
679

680
  haddockOptions        :: Maybe String,
681
  ghciScripts           :: [String],
682

683 684
  -- Output style options
  pprUserLength         :: Int,
Ian Lynagh's avatar
Ian Lynagh committed
685
  pprCols               :: Int,
Ian Lynagh's avatar
Ian Lynagh committed
686
  traceLevel            :: Int, -- Standard level is 1. Less verbose is 0.
687 688

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

691
  interactivePrint      :: Maybe String,
692

693
  llvmVersion           :: IORef (Int)
694 695
 }

696 697 698
class HasDynFlags m where
    getDynFlags :: m DynFlags

Ian Lynagh's avatar
Ian Lynagh committed
699 700 701
class ContainsDynFlags t where
    extractDynFlags :: t -> DynFlags

702 703 704 705 706
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
707
  | ProfAutoCalls      -- ^ annotate call-sites
Simon Marlow's avatar
Simon Marlow committed
708
  deriving (Enum)
709

710
data Settings = Settings {
711
  sTargetPlatform        :: Platform,    -- Filled in by SysTools
712 713 714 715 716 717 718 719 720
  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,
721 722 723
  sLdSupportsCompactUnwind :: Bool,
  sLdSupportsBuildId       :: Bool,
  sLdIsGnuLd               :: Bool,
724 725 726 727 728 729 730 731 732 733 734 735 736
  -- 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
737 738 739 740 741 742 743 744 745 746
  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
747
  sOpt_lc                :: [String], -- LLVM: llc static compiler
748

749
  sPlatformConstants     :: PlatformConstants
750 751
 }

752 753 754
targetPlatform :: DynFlags -> Platform
targetPlatform dflags = sTargetPlatform (settings dflags)

755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794
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)
795 796 797
opt_L                 :: DynFlags -> [String]
opt_L dflags = sOpt_L (settings dflags)
opt_P                 :: DynFlags -> [String]
798 799
opt_P dflags = concatMap (wayOptP (targetPlatform dflags)) (ways dflags)
            ++ sOpt_P (settings dflags)
800 801 802
opt_F                 :: DynFlags -> [String]
opt_F dflags = sOpt_F (settings dflags)
opt_c                 :: DynFlags -> [String]
803 804
opt_c dflags = concatMap (wayOptc (targetPlatform dflags)) (ways dflags)
            ++ sOpt_c (settings dflags)
805 806 807
opt_a                 :: DynFlags -> [String]
opt_a dflags = sOpt_a (settings dflags)
opt_l                 :: DynFlags -> [String]
808 809
opt_l dflags = concatMap (wayOptl (targetPlatform dflags)) (ways dflags)
            ++ sOpt_l (settings dflags)
810 811 812 813 814 815
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)
816

817 818
-- | The target code type of the compilation (if any).
--
819 820 821
-- Whenever you change the target, also make sure to set 'ghcLink' to
-- something sensible.
--
822 823 824 825
-- 'HscNothing' can be used to avoid generating any output, however, note
-- that:
--
--  * This will not run the desugaring step, thus no warnings generated in
826 827 828
--    this step will be output.  In particular, this includes warnings related
--    to pattern matching.  You can run the desugarer manually using
--    'GHC.desugarModule'.
829
--
830 831 832 833
--  * 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
834
--    different target or avoid typechecking such modules.  (The latter may be
835
--    preferable for security reasons.)
836
--
837
data HscTarget
838 839
  = HscC           -- ^ Generate C code.
  | HscAsm         -- ^ Generate assembly using the native code generator.
840
  | HscLlvm        -- ^ Generate assembly using the llvm code generator.
841 842
  | HscInterpreted -- ^ Generate bytecode.  (Requires 'LinkInMemory')
  | HscNothing     -- ^ Don't generate any code.  See notes above.
843 844
  deriving (Eq, Show)

845
-- | Will this target result in an object file on the disk?
846 847 848
isObjectTarget :: HscTarget -> Bool
isObjectTarget HscC     = True
isObjectTarget HscAsm   = True
849
isObjectTarget HscLlvm  = True
850 851
isObjectTarget _        = False

852 853 854 855 856 857 858 859 860 861 862
-- | Does this target retain *all* top-level bindings for a module,
-- rather than just the exported bindings, in the TypeEnv and compiled
-- code (if any)?  In interpreted mode we do this, so that GHCi can
-- call functions inside a module.  In HscNothing mode we also do it,
-- so that Haddock can get access to the GlobalRdrEnv for a module
-- after typechecking it.
targetRetainsAllBindings :: HscTarget -> Bool
targetRetainsAllBindings HscInterpreted = True
targetRetainsAllBindings HscNothing     = True
targetRetainsAllBindings _              = False

863 864 865 866 867 868
-- | The 'GhcMode' tells us whether we're doing multi-module
-- compilation (controlled via the "GHC" API) or one-shot
-- (single-module) compilation.  This makes a difference primarily to
-- the "Finder": in one-shot mode we look for interface files for
-- imported modules, but in multi-module mode we look for source files
-- in order to check whether they need to be recompiled.
869
data GhcMode
870 871 872
  = CompManager         -- ^ @\-\-make@, GHCi, etc.
  | OneShot             -- ^ @ghc -c Foo.hs@
  | MkDepend            -- ^ @ghc -M@, see "Finder" for why we need this
873 874
  deriving Eq

875 876 877 878 879
instance Outputable GhcMode where
  ppr CompManager = ptext (sLit "CompManager")
  ppr OneShot     = ptext (sLit "OneShot")
  ppr MkDepend    = ptext (sLit "MkDepend")

simonmar's avatar