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

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
        unsafeGlobalDynFlags, setUnsafeGlobalDynFlags,

124 125 126
        -- * SSE
        isSse2Enabled,
        isSse4_2Enabled,
127 128 129 130
  ) where

#include "HsVersions.h"

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

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

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

169 170 171
import Data.IntSet (IntSet)
import qualified Data.IntSet as IntSet

172 173 174
-- -----------------------------------------------------------------------------
-- DynFlags

175
data DumpFlag
176 177 178

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

Ian Lynagh's avatar
Ian Lynagh committed
260
   | Opt_WarnIsError                    -- -Werror; makes warnings fatal
261

262 263
   | Opt_PrintExplicitForalls

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

293 294 295 296 297
   -- Interface files
   | Opt_IgnoreInterfacePragmas
   | Opt_OmitInterfacePragmas
   | Opt_ExposeAllUnfoldings

Ian Lynagh's avatar
Ian Lynagh committed
298 299
   -- profiling opts
   | Opt_AutoSccsOnIndividualCafs
300
   | Opt_ProfCountEntries
Ian Lynagh's avatar
Ian Lynagh committed
301

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

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

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

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

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

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

379 380
   | Opt_BuildDynamicToo

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

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

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

429
data Language = Haskell98 | Haskell2010
430
   deriving Enum
431

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

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

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

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

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

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

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

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

569
  thisPackage           :: PackageId,   -- ^ name of package currently being compiled
570 571

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

576 577 578
  -- For object splitting
  splitInfo             :: Maybe (String,Int),

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

Ian Lynagh's avatar
Ian Lynagh committed
586 587 588
  objectSuf             :: String,
  hcSuf                 :: String,
  hiSuf                 :: String,
589

590 591 592 593
  canGenerateDynamicToo :: IORef Bool,
  dynObjectSuf          :: String,
  dynHiSuf              :: String,

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

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

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

607 608
  ldInputs              :: [String],

Ian Lynagh's avatar
Ian Lynagh committed
609 610 611 612 613
  includePaths          :: [String],
  libraryPaths          :: [String],
  frameworkPaths        :: [String],    -- used on darwin only
  cmdlineFrameworks     :: [String],    -- ditto

614
  rtsOpts               :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
615
  rtsOptsEnabled        :: RtsOptsEnabled,
616

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

619 620 621 622
  -- Plugins
  pluginModNames        :: [ModuleName],
  pluginModNameOpts     :: [(ModuleName,String)],

623 624 625 626 627 628
  --  For ghc -M
  depMakefile           :: FilePath,
  depIncludePkgDeps     :: Bool,
  depExcludeMods        :: [ModuleName],
  depSuffixes           :: [String],

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

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

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

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

650

651 652 653 654 655
  -- 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),

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

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

687 688
  maxWorkerArgs         :: Int,

689 690
  ghciHistSize          :: Int,

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

696
  haddockOptions        :: Maybe String,
697
  ghciScripts           :: [String],
698

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

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

707
  interactivePrint      :: Maybe String,
708

709
  llvmVersion           :: IORef Int,
710

tibbe's avatar
tibbe committed
711 712 713 714
  nextWrapperNum        :: IORef Int,

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

717 718 719
class HasDynFlags m where
    getDynFlags :: m DynFlags

Ian Lynagh's avatar
Ian Lynagh committed
720 721
class ContainsDynFlags t where
    extractDynFlags :: t -> DynFlags
722
    replaceDynFlags :: t -> DynFlags -> t
Ian Lynagh's avatar
Ian Lynagh committed
723

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

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

771
  sPlatformConstants     :: PlatformConstants
772 773
 }

774 775 776
targetPlatform :: DynFlags -> Platform
targetPlatform dflags = sTargetPlatform (settings dflags)

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

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

867
-- | Will this target result in an object file on the disk?