DynFlags.hs 133 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
        GeneralFlag(..),
17
        WarningFlag(..),
18
        ExtensionFlag(..),
19
        Language(..),
20
        PlatformConstants(..),
Ian Lynagh's avatar
Ian Lynagh committed
21
        FatalMessager, LogAction, FlushOut(..), FlushErr(..),
22
        ProfAuto(..),
23
        glasgowExtsFlags,
ian@well-typed.com's avatar
ian@well-typed.com committed
24 25 26
        gopt,
        gopt_set,
        gopt_unset,
27 28 29
        wopt,
        wopt_set,
        wopt_unset,
30 31 32
        xopt,
        xopt_set,
        xopt_unset,
33
        lang_set,
Ian Lynagh's avatar
Ian Lynagh committed
34
        DynFlags(..),
Ian Lynagh's avatar
Ian Lynagh committed
35
        HasDynFlags(..), ContainsDynFlags(..),
Ian Lynagh's avatar
Ian Lynagh committed
36
        RtsOptsEnabled(..),
Ian Lynagh's avatar
Ian Lynagh committed
37
        HscTarget(..), isObjectTarget, defaultObjectTarget,
38
        targetRetainsAllBindings,
Ian Lynagh's avatar
Ian Lynagh committed
39 40 41
        GhcMode(..), isOneShot,
        GhcLink(..), isNoLink,
        PackageFlag(..),
42
        PkgConfRef(..),
Ian Lynagh's avatar
Ian Lynagh committed
43
        Option(..), showOpt,
Ian Lynagh's avatar
Ian Lynagh committed
44
        DynLibLoader(..),
45
        fFlags, fWarningFlags, fLangFlags, xFlags,
46
        dynFlagDependencies,
47
        tablesNextToCode, mkTablesNextToCode,
48

49 50
        printOutputForUser, printInfoForUser,

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

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

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


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

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

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

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

97
        supportedLanguagesAndExtensions,
98

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

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

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

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

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

#include "HsVersions.h"

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

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

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

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

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

172
-- | Enumerates the simple on-or-off dynamic flags
173
data GeneralFlag
174 175 176

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

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

254 255
   | Opt_PrintExplicitForalls

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

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

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

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

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

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

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

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

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

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

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

379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411
data WarningFlag =
     Opt_WarnDuplicateExports
   | Opt_WarnHiShadows
   | Opt_WarnImplicitPrelude
   | Opt_WarnIncompletePatterns
   | Opt_WarnIncompleteUniPatterns
   | Opt_WarnIncompletePatternsRecUpd
   | Opt_WarnMissingFields
   | Opt_WarnMissingImportList
   | Opt_WarnMissingMethods
   | Opt_WarnMissingSigs
   | Opt_WarnMissingLocalSigs
   | Opt_WarnNameShadowing
   | Opt_WarnOverlappingPatterns
   | Opt_WarnTypeDefaults
   | Opt_WarnMonomorphism
   | Opt_WarnUnusedBinds
   | Opt_WarnUnusedImports
   | Opt_WarnUnusedMatches
   | Opt_WarnWarningsDeprecations
   | Opt_WarnDeprecatedFlags
   | Opt_WarnDodgyExports
   | Opt_WarnDodgyImports
   | Opt_WarnOrphans
   | Opt_WarnAutoOrphans
   | Opt_WarnIdentities
   | Opt_WarnTabs
   | Opt_WarnUnrecognisedPragmas
   | Opt_WarnDodgyForeignImports
   | Opt_WarnLazyUnliftedBindings
   | Opt_WarnUnusedDoBind
   | Opt_WarnWrongDoBind
   | Opt_WarnAlternativeLayoutRuleTransitional
412 413
   | Opt_WarnUnsafe
   | Opt_WarnSafe
Ian Lynagh's avatar
Ian Lynagh committed
414
   | Opt_WarnPointlessPragmas
415
   | Opt_WarnUnsupportedCallingConventions
416
   | Opt_WarnInlineRuleShadowing
417
   deriving (Eq, Show, Enum)
418

419
data Language = Haskell98 | Haskell2010
420
   deriving Enum
421

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

592 593
  ldInputs              :: [String],

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

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

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

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

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

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

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

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

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

635

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

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

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

671 672
  maxWorkerArgs         :: Int,

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

678
  haddockOptions        :: Maybe String,
679
  ghciScripts           :: [String],
680

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

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

689
  interactivePrint      :: Maybe String,
690

691
  llvmVersion           :: IORef (Int)
692 693
 }

694 695 696
class HasDynFlags m where
    getDynFlags :: m DynFlags

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

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

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

747
  sPlatformConstants     :: PlatformConstants
748 749
 }

750 751 752
targetPlatform :: DynFlags -> Platform
targetPlatform dflags = sTargetPlatform (settings dflags)

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

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

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

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

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

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

878 879 880 881
isOneShot :: GhcMode -> Bool
isOneShot OneShot = True