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

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

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

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

176 177 178
-- -----------------------------------------------------------------------------
-- DynFlags

179
data DumpFlag
180 181 182

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

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

266 267
   | Opt_PrintExplicitForalls

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

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

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

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

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

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

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

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

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

383 384
   | Opt_BuildDynamicToo

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

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

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

433
data Language = Haskell98 | Haskell2010
434
   deriving Enum
435

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

611 612
  ldInputs              :: [String],

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

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

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

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

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

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

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

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

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

654

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

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

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

691 692
  maxWorkerArgs         :: Int,

693 694
  ghciHistSize          :: Int,

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

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

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

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

711
  interactivePrint      :: Maybe String,
712

713
  llvmVersion           :: IORef Int,
714

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

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

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

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

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

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

775
  sPlatformConstants     :: PlatformConstants
776 777
 }

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

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

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