DynFlags.hs 142 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,
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,

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

55
        -- ** Safe Haskell
56
        SafeHaskellMode(..),
57
        safeHaskellOn, safeImportsOn, safeLanguageOn, safeInferOn,
58
        packageTrustOn,
59
        safeDirectImpsReq, safeImplicitImpsReq,
60
        unsafeFlags,
61

62
        -- ** System tool settings and locations
63
        Settings(..),
64
        targetPlatform,
65 66 67 68
        ghcUsagePath, ghciUsagePath, topDir, tmpDir, rawSettings,
        extraGccViaCFlags, systemPackageConfig,
        pgm_L, pgm_P, pgm_F, pgm_c, pgm_s, pgm_a, pgm_l, pgm_dll, pgm_T,
        pgm_sysman, pgm_windres, pgm_lo, pgm_lc,
Ian Lynagh's avatar
Ian Lynagh committed
69
        opt_L, opt_P, opt_F, opt_c, opt_a, opt_l,
70
        opt_windres, opt_lo, opt_lc,
71 72


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

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

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

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

100
        supportedLanguagesAndExtensions,
101

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

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

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

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

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

125 126
        unsafeGlobalDynFlags, setUnsafeGlobalDynFlags,

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

#include "HsVersions.h"

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

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

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

172 173 174
import Data.IntSet (IntSet)
import qualified Data.IntSet as IntSet

175 176 177
-- -----------------------------------------------------------------------------
-- DynFlags

178
data DumpFlag
179 180 181

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

Ian Lynagh's avatar
Ian Lynagh committed
263
   | Opt_WarnIsError                    -- -Werror; makes warnings fatal
264

265 266
   | Opt_PrintExplicitForalls

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

296 297 298 299 300
   -- Interface files
   | Opt_IgnoreInterfacePragmas
   | Opt_OmitInterfacePragmas
   | Opt_ExposeAllUnfoldings

Ian Lynagh's avatar
Ian Lynagh committed
301 302
   -- profiling opts
   | Opt_AutoSccsOnIndividualCafs
303
   | Opt_ProfCountEntries
Ian Lynagh's avatar
Ian Lynagh committed
304

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

342 343 344 345
   -- PreInlining is on by default. The option is there just to see how
   -- bad things get if you turn it off!
   | Opt_SimplPreInlining

346
   -- output style opts
347 348
   | Opt_ErrorSpans -- Include full span info in error messages,
                    -- instead of just the start position.
349
   | Opt_PprCaseAsLet
350

351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367
   -- 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

368
   -- temporary flags
369
   | Opt_RunCPS
370
   | Opt_RunCPSZ
371
   | Opt_AutoLinkPackages
372
   | Opt_ImplicitImportQualified
373 374 375 376 377 378

   -- keeping stuff
   | Opt_KeepHiDiffs
   | Opt_KeepHcFiles
   | Opt_KeepSFiles
   | Opt_KeepTmpFiles
Jedai's avatar
Jedai committed
379
   | Opt_KeepRawTokenStream
380
   | Opt_KeepLlvmFiles
381

382 383
   | Opt_BuildDynamicToo

384
   -- safe haskell flags
dterei's avatar
dterei committed
385
   | Opt_DistrustAllPackages
386 387
   | Opt_PackageTrust

388
   deriving (Eq, Show, Enum)
Ian Lynagh's avatar
Ian Lynagh committed
389

390 391
data WarningFlag =
     Opt_WarnDuplicateExports
392
   | Opt_WarnDuplicateConstraints
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 420 421 422 423
   | 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
424 425
   | Opt_WarnUnsafe
   | Opt_WarnSafe
Ian Lynagh's avatar
Ian Lynagh committed
426
   | Opt_WarnPointlessPragmas
427
   | Opt_WarnUnsupportedCallingConventions
428
   | Opt_WarnUnsupportedLlvmVersion
429
   | Opt_WarnInlineRuleShadowing
430
   deriving (Eq, Show, Enum)
431

432
data Language = Haskell98 | Haskell2010
433
   deriving Enum
434

435
-- | The various Safe Haskell modes
436 437
data SafeHaskellMode
   = Sf_None
dterei's avatar
dterei committed
438
   | Sf_Unsafe
439 440
   | Sf_Trustworthy
   | Sf_Safe
441
   | Sf_SafeInferred
442 443
   deriving (Eq)

Ian Lynagh's avatar
Ian Lynagh committed
444
instance Show SafeHaskellMode where
Ian Lynagh's avatar
Ian Lynagh committed
445 446 447 448 449
    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
450

451
instance Outputable SafeHaskellMode where
Ian Lynagh's avatar
Ian Lynagh committed
452
    ppr = text . show
453

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

   | 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
516
   | Opt_MonadComprehensions
517 518 519 520 521 522 523 524 525
   | Opt_GeneralizedNewtypeDeriving
   | Opt_RecursiveDo
   | Opt_PostfixOperators
   | Opt_TupleSections
   | Opt_PatternGuards
   | Opt_LiberalTypeSynonyms
   | Opt_RankNTypes
   | Opt_ImpredicativeTypes
   | Opt_TypeOperators
526
   | Opt_ExplicitNamespaces
527 528 529 530 531
   | Opt_PackageImports
   | Opt_ExplicitForAll
   | Opt_AlternativeLayoutRule
   | Opt_AlternativeLayoutRuleTransitional
   | Opt_DatatypeContexts
532
   | Opt_NondecreasingIndentation
533
   | Opt_RelaxedLayout
534
   | Opt_TraditionalRecordSyntax
535
   | Opt_LambdaCase
536
   | Opt_MultiWayIf
537
   | Opt_TypeHoles
538
   | Opt_EmptyCase
539
   deriving (Eq, Enum, Show)
540

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

558
  simplTickFactor       :: Int,         -- ^ Multiplier for simplifier ticks
559 560 561
  specConstrThreshold   :: Maybe Int,   -- ^ Threshold for SpecConstr
  specConstrCount       :: Maybe Int,   -- ^ Max number of specialisations for any one function
  liberateCaseThreshold :: Maybe Int,   -- ^ Threshold for LiberateCase
562
  floatLamArgs          :: Maybe Int,   -- ^ Arg count for lambda floating
563
                                        --   See CoreMonad.FloatOutSwitches
564
  historySize           :: Int,
565

566
  cmdlineHcIncludes     :: [String],    -- ^ @\-\#includes@
Ian Lynagh's avatar
Ian Lynagh committed
567 568 569
  importPaths           :: [FilePath],
  mainModIs             :: Module,
  mainFunIs             :: Maybe String,
570
  ctxtStkDepth          :: Int,         -- ^ Typechecker context stack depth
571

572
  thisPackage           :: PackageId,   -- ^ name of package currently being compiled
573 574

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

579 580 581
  -- For object splitting
  splitInfo             :: Maybe (String,Int),

582
  -- paths etc.
Ian Lynagh's avatar
Ian Lynagh committed
583
  objectDir             :: Maybe String,
584
  dylibInstallName      :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
585 586
  hiDir                 :: Maybe String,
  stubDir               :: Maybe String,
587
  dumpDir               :: Maybe String,
588

Ian Lynagh's avatar
Ian Lynagh committed
589 590 591
  objectSuf             :: String,
  hcSuf                 :: String,
  hiSuf                 :: String,
592

593 594 595 596
  canGenerateDynamicToo :: IORef Bool,
  dynObjectSuf          :: String,
  dynHiSuf              :: String,

Ian Lynagh's avatar
Ian Lynagh committed
597
  outputFile            :: Maybe String,
ian@well-typed.com's avatar
ian@well-typed.com committed
598
  dynOutputFile         :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
599 600
  outputHi              :: Maybe String,
  dynLibLoader          :: DynLibLoader,
601

602
  -- | This is set by 'DriverPipeline.runPipeline' based on where
Ian Lynagh's avatar
Ian Lynagh committed
603 604
  --    its output is going.
  dumpPrefix            :: Maybe FilePath,
605

606 607
  -- | Override the 'dumpPrefix' set by 'DriverPipeline.runPipeline'.
  --    Set by @-ddump-file-prefix@
Ian Lynagh's avatar
Ian Lynagh committed
608 609
  dumpPrefixForce       :: Maybe FilePath,

610 611
  ldInputs              :: [String],

Ian Lynagh's avatar
Ian Lynagh committed
612 613 614 615 616
  includePaths          :: [String],
  libraryPaths          :: [String],
  frameworkPaths        :: [String],    -- used on darwin only
  cmdlineFrameworks     :: [String],    -- ditto

617
  rtsOpts               :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
618
  rtsOptsEnabled        :: RtsOptsEnabled,
619

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

622 623 624 625
  -- Plugins
  pluginModNames        :: [ModuleName],
  pluginModNameOpts     :: [(ModuleName,String)],

626 627 628 629 630 631
  --  For ghc -M
  depMakefile           :: FilePath,
  depIncludePkgDeps     :: Bool,
  depExcludeMods        :: [ModuleName],
  depSuffixes           :: [String],

632
  --  Package flags
633
  extraPkgConfs         :: [PkgConfRef] -> [PkgConfRef],
634
        -- ^ The @-package-db@ flags given on the command line, in the order
Ian Lynagh's avatar
Ian Lynagh committed
635
        -- they appeared.
636

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

640
  -- Package state
Ian Lynagh's avatar
Ian Lynagh committed
641
  -- NB. do not modify this field, it is calculated by
642
  -- Packages.initPackages and Packages.updatePackages.
643
  pkgDatabase           :: Maybe [PackageConfig],
Ian Lynagh's avatar
Ian Lynagh committed
644
  pkgState              :: PackageState,
645

646 647 648 649
  -- Temporary files
  -- These have to be IORefs, because the defaultCleanupHandler needs to
  -- know what to clean when an exception happens
  filesToClean          :: IORef [FilePath],
650
  dirsToClean           :: IORef (Map FilePath FilePath),
651 652
  filesToNotIntermediateClean :: IORef [FilePath],

653

654 655 656 657 658
  -- 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),

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

681 682 683 684 685 686 687 688 689
  -- Unfolding control
  -- See Note [Discounts and thresholds] in CoreUnfold
  ufCreationThreshold   :: Int,
  ufUseThreshold        :: Int,
  ufFunAppDiscount      :: Int,
  ufDictDiscount        :: Int,
  ufKeenessFactor       :: Float,
  ufDearOp              :: Int,

690 691
  maxWorkerArgs         :: Int,

692 693
  ghciHistSize          :: Int,

694
  -- | MsgDoc output action: use "ErrUtils" instead of this if you can
695
  log_action            :: LogAction,
696 697
  flushOut              :: FlushOut,
  flushErr              :: FlushErr,
David Waern's avatar
David Waern committed
698

699
  haddockOptions        :: Maybe String,
700
  ghciScripts           :: [String],
701

702 703
  -- Output style options
  pprUserLength         :: Int,
Ian Lynagh's avatar
Ian Lynagh committed
704
  pprCols               :: Int,
Ian Lynagh's avatar
Ian Lynagh committed
705
  traceLevel            :: Int, -- Standard level is 1. Less verbose is 0.
706 707

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

710
  interactivePrint      :: Maybe String,
711

712
  llvmVersion           :: IORef Int,
713

tibbe's avatar
tibbe committed
714 715 716 717
  nextWrapperNum        :: IORef Int,

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

720 721 722
class HasDynFlags m where
    getDynFlags :: m DynFlags

Ian Lynagh's avatar
Ian Lynagh committed
723 724
class ContainsDynFlags t where
    extractDynFlags :: t -> DynFlags
725
    replaceDynFlags :: t -> DynFlags -> t
Ian Lynagh's avatar
Ian Lynagh committed
726

727 728 729 730 731
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
732
  | ProfAutoCalls      -- ^ annotate call-sites
Simon Marlow's avatar
Simon Marlow committed
733
  deriving (Enum)
734

735
data Settings = Settings {
736
  sTargetPlatform        :: Platform,    -- Filled in by SysTools
737 738 739 740 741 742 743 744 745
  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,
746 747 748
  sLdSupportsCompactUnwind :: Bool,
  sLdSupportsBuildId       :: Bool,
  sLdIsGnuLd               :: Bool,
749 750 751 752 753 754 755 756 757 758 759 760 761
  -- 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
762 763 764 765 766 767 768 769 770 771
  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
772
  sOpt_lc                :: [String], -- LLVM: llc static compiler
773

774
  sPlatformConstants     :: PlatformConstants
775 776
 }

777 778 779
targetPlatform :: DynFlags -> Platform
targetPlatform dflags = sTargetPlatform (settings dflags)

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 811 812 813 814 815 816 817 818 819
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)
820 821 822
opt_L                 :: DynFlags -> [String]
opt_L dflags = sOpt_L (settings dflags)
opt_P                 :: DynFlags -> [String]
823 824
opt_P dflags = concatMap (wayOptP (targetPlatform dflags)) (ways dflags)
            ++ sOpt_P (settings dflags)
825 826 827
opt_F                 :: DynFlags -> [String]
opt_F dflags = sOpt_F (settings dflags)
opt_c                 :: DynFlags -> [String]
828 829
opt_c dflags = concatMap (wayOptc (targetPlatform dflags)) (ways dflags)
            ++ sOpt_c (settings dflags)
830 831 832
opt_a                 :: DynFlags -> [String]
opt_a dflags = sOpt_a (settings dflags)
opt_l                 :: DynFlags -> [String]
833 834
opt_l dflags = concatMap (wayOptl (targetPlatform dflags)) (ways dflags)
            ++ sOpt_l (settings dflags)
835 836 837 838 839 840
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)
841

842 843
-- | The target code type of the compilation (if any).
--
844 845 846
-- Whenever you change the target, also make sure to set 'ghcLink' to
-- something sensible.
--
847 848 849 850
-- 'HscNothing' can be used to avoid generating any output, however, note
-- that:
--
--  * This will not run the desugaring step, thus no warnings generated in
851 852 853
--    this step will be output.  In particular, this includes warnings related
--    to pattern matching.  You can run the desugarer manually using
--    'GHC.desugarModule'.
854
--
855 856 857 858
--  * 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
859
--    different target or avoid typechecking such modules.  (The latter may be
860
--    preferable for security reasons.)
861
--
862
data HscTarget
863 864
  = HscC           -- ^ Generate C code.
  | HscAsm         -- ^ Generate assembly using the native code generator.
865
  | HscLlvm        -- ^ Generate assembly using the llvm code generator.
866 867
  | HscInterpreted -- ^ Generate bytecode.  (Requires 'LinkInMemory')
  | HscNothing     -- ^ Don't generate any code.  See notes above.