DynFlags.hs 128 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_GHC -fno-warn-missing-fields #-}
-- So that tracingSettings works properly

17
module DynFlags (
18
        -- * Dynamic flags and associated configuration types
Ian Lynagh's avatar
Ian Lynagh committed
19
        DynFlag(..),
20
        WarningFlag(..),
21
        ExtensionFlag(..),
22
        Language(..),
23
        PlatformConstants(..),
Ian Lynagh's avatar
Ian Lynagh committed
24
        FatalMessager, LogAction, FlushOut(..), FlushErr(..),
25
        ProfAuto(..),
26
        glasgowExtsFlags,
27 28 29
        dopt,
        dopt_set,
        dopt_unset,
30 31 32
        wopt,
        wopt_set,
        wopt_unset,
33 34 35
        xopt,
        xopt_set,
        xopt_unset,
36
        lang_set,
Ian Lynagh's avatar
Ian Lynagh committed
37
        DynFlags(..),
Ian Lynagh's avatar
Ian Lynagh committed
38
        HasDynFlags(..), ContainsDynFlags(..),
Ian Lynagh's avatar
Ian Lynagh committed
39
        RtsOptsEnabled(..),
Ian Lynagh's avatar
Ian Lynagh committed
40
        HscTarget(..), isObjectTarget, defaultObjectTarget,
41
        targetRetainsAllBindings,
Ian Lynagh's avatar
Ian Lynagh committed
42 43 44
        GhcMode(..), isOneShot,
        GhcLink(..), isNoLink,
        PackageFlag(..),
45
        PkgConfRef(..),
Ian Lynagh's avatar
Ian Lynagh committed
46
        Option(..), showOpt,
Ian Lynagh's avatar
Ian Lynagh committed
47
        DynLibLoader(..),
48
        fFlags, fWarningFlags, fLangFlags, xFlags,
49
        dynFlagDependencies,
50
        tablesNextToCode, mkTablesNextToCode,
51

52 53
        printOutputForUser, printInfoForUser,

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

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

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


74
        -- ** Manipulating DynFlags
75
        defaultDynFlags,                -- Settings -> DynFlags
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

        -- ** DynFlag 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
        -- ** Only for use in the tracing functions in Outputable
        tracingDynFlags,
119 120

#include "../includes/dist-derivedconstants/header/GHCConstantsHaskellExports.hs"
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 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
Ian Lynagh's avatar
Ian Lynagh committed
133
import Constants        ( mAX_CONTEXT_REDUCTION_DEPTH )
134
import Panic
135
import Util
136
import Maybes           ( orElse )
137
import qualified Pretty
138
import SrcLoc
139
import FastString
Simon Marlow's avatar
Simon Marlow committed
140
import Outputable
Ian Lynagh's avatar
Ian Lynagh committed
141
#ifdef GHCI
Ian Lynagh's avatar
Ian Lynagh committed
142
import Foreign.C        ( CInt(..) )
Ian Lynagh's avatar
Ian Lynagh committed
143
#endif
144
import {-# SOURCE #-} ErrUtils ( Severity(..), MsgDoc, mkLocMessage )
145

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

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

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

164 165 166
-- -----------------------------------------------------------------------------
-- DynFlags

167
-- | Enumerates the simple on-or-off dynamic flags
168 169 170 171
data DynFlag

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

Ian Lynagh's avatar
Ian Lynagh committed
258
   | Opt_WarnIsError                    -- -Werror; makes warnings fatal
259

260 261
   | Opt_PrintExplicitForalls

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

289 290 291 292 293
   -- Interface files
   | Opt_IgnoreInterfacePragmas
   | Opt_OmitInterfacePragmas
   | Opt_ExposeAllUnfoldings

Ian Lynagh's avatar
Ian Lynagh committed
294 295
   -- profiling opts
   | Opt_AutoSccsOnIndividualCafs
296
   | Opt_ProfCountEntries
Ian Lynagh's avatar
Ian Lynagh committed
297

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

335 336
   -- output style opts
   | Opt_PprCaseAsLet
337

338
   -- temporary flags
339
   | Opt_RunCPS
340
   | Opt_RunCPSZ
341
   | Opt_AutoLinkPackages
342
   | Opt_ImplicitImportQualified
343
   | Opt_TryNewCodeGen
344 345 346 347 348 349

   -- keeping stuff
   | Opt_KeepHiDiffs
   | Opt_KeepHcFiles
   | Opt_KeepSFiles
   | Opt_KeepTmpFiles
Jedai's avatar
Jedai committed
350
   | Opt_KeepRawTokenStream
351
   | Opt_KeepLlvmFiles
352

353
   -- safe haskell flags
dterei's avatar
dterei committed
354
   | Opt_DistrustAllPackages
355 356
   | Opt_PackageTrust

357
   deriving (Eq, Show, Enum)
Ian Lynagh's avatar
Ian Lynagh committed
358

359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391
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
392 393
   | Opt_WarnUnsafe
   | Opt_WarnSafe
Ian Lynagh's avatar
Ian Lynagh committed
394
   | Opt_WarnPointlessPragmas
395
   | Opt_WarnUnsupportedCallingConventions
396
   | Opt_WarnInlineRuleShadowing
397
   deriving (Eq, Show, Enum)
398

399
data Language = Haskell98 | Haskell2010
400
   deriving Enum
401

402
-- | The various Safe Haskell modes
403 404
data SafeHaskellMode
   = Sf_None
dterei's avatar
dterei committed
405
   | Sf_Unsafe
406 407
   | Sf_Trustworthy
   | Sf_Safe
408
   | Sf_SafeInferred
409 410
   deriving (Eq)

Ian Lynagh's avatar
Ian Lynagh committed
411
instance Show SafeHaskellMode where
Ian Lynagh's avatar
Ian Lynagh committed
412 413 414 415 416
    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
417

418
instance Outputable SafeHaskellMode where
Ian Lynagh's avatar
Ian Lynagh committed
419
    ppr = text . show
420

421
data ExtensionFlag
422 423 424 425 426 427 428
   = Opt_Cpp
   | Opt_OverlappingInstances
   | Opt_UndecidableInstances
   | Opt_IncoherentInstances
   | Opt_MonomorphismRestriction
   | Opt_MonoPatBinds
   | Opt_MonoLocalBinds
429 430
   | Opt_RelaxedPolyRec           -- Deprecated
   | Opt_ExtendedDefaultRules     -- Use GHC's extended rules for defaulting
431 432
   | Opt_ForeignFunctionInterface
   | Opt_UnliftedFFITypes
433
   | Opt_InterruptibleFFI
434
   | Opt_CApiFFI
435
   | Opt_GHCForeignImportPrim
436 437
   | Opt_ParallelArrays           -- Syntactic support for parallel arrays
   | Opt_Arrows                   -- Arrow-notation syntax
438 439 440 441 442 443 444 445 446 447 448 449 450 451
   | 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
452
   | Opt_GADTSyntax
453
   | Opt_NPlusKPatterns
Ian Lynagh's avatar
Ian Lynagh committed
454
   | Opt_DoAndIfThenElse
455
   | Opt_RebindableSyntax
456
   | Opt_ConstraintKinds
dreixel's avatar
dreixel committed
457
   | Opt_PolyKinds                -- Kind polymorphism
dreixel's avatar
dreixel committed
458
   | Opt_DataKinds                -- Datatype promotion
459 460
   | Opt_InstanceSigs
 
461 462 463 464 465
   | Opt_StandaloneDeriving
   | Opt_DeriveDataTypeable
   | Opt_DeriveFunctor
   | Opt_DeriveTraversable
   | Opt_DeriveFoldable
466
   | Opt_DeriveGeneric            -- Allow deriving Generic/1
dreixel's avatar
dreixel committed
467
   | Opt_DefaultSignatures        -- Allow extra signatures for defmeths
468 469 470 471 472 473 474 475 476 477 478 479 480 481 482

   | 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
483
   | Opt_MonadComprehensions
484 485 486 487 488 489 490 491 492 493
   | Opt_GeneralizedNewtypeDeriving
   | Opt_RecursiveDo
   | Opt_PostfixOperators
   | Opt_TupleSections
   | Opt_PatternGuards
   | Opt_LiberalTypeSynonyms
   | Opt_Rank2Types
   | Opt_RankNTypes
   | Opt_ImpredicativeTypes
   | Opt_TypeOperators
494
   | Opt_ExplicitNamespaces
495 496 497 498 499
   | Opt_PackageImports
   | Opt_ExplicitForAll
   | Opt_AlternativeLayoutRule
   | Opt_AlternativeLayoutRuleTransitional
   | Opt_DatatypeContexts
500
   | Opt_NondecreasingIndentation
501
   | Opt_RelaxedLayout
502
   | Opt_TraditionalRecordSyntax
503
   | Opt_LambdaCase
504
   | Opt_MultiWayIf
505
   deriving (Eq, Enum, Show)
506

507 508
-- | Contains not only a collection of 'DynFlag's but also a plethora of
-- information relating to the compilation of a single file or GHC session
509
data DynFlags = DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
510 511 512
  ghcMode               :: GhcMode,
  ghcLink               :: GhcLink,
  hscTarget             :: HscTarget,
513
  settings              :: Settings,
514
  hscOutName            :: String,      -- ^ Name of the output file
515
  extCoreName           :: String,      -- ^ Name of the .hcr output file
516
  verbosity             :: Int,         -- ^ Verbosity level: see Note [Verbosity levels]
517 518 519
  optLevel              :: Int,         -- ^ Optimisation level
  simplPhases           :: Int,         -- ^ Number of simplifier phases
  maxSimplIterations    :: Int,         -- ^ Max simplifier iterations
520
  shouldDumpSimplPhase  :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
521
  ruleCheck             :: Maybe String,
522
  strictnessBefore      :: [Int],       -- ^ Additional demand analysis
523

524
  simplTickFactor       :: Int,         -- ^ Multiplier for simplifier ticks
525 526 527
  specConstrThreshold   :: Maybe Int,   -- ^ Threshold for SpecConstr
  specConstrCount       :: Maybe Int,   -- ^ Max number of specialisations for any one function
  liberateCaseThreshold :: Maybe Int,   -- ^ Threshold for LiberateCase
528
  floatLamArgs          :: Maybe Int,   -- ^ Arg count for lambda floating
529
                                        --   See CoreMonad.FloatOutSwitches
530
  historySize           :: Int,
531

532
  cmdlineHcIncludes     :: [String],    -- ^ @\-\#includes@
Ian Lynagh's avatar
Ian Lynagh committed
533 534 535
  importPaths           :: [FilePath],
  mainModIs             :: Module,
  mainFunIs             :: Maybe String,
536
  ctxtStkDepth          :: Int,         -- ^ Typechecker context stack depth
537

538
  thisPackage           :: PackageId,   -- ^ name of package currently being compiled
539 540

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

545 546 547
  -- For object splitting
  splitInfo             :: Maybe (String,Int),

548
  -- paths etc.
Ian Lynagh's avatar
Ian Lynagh committed
549
  objectDir             :: Maybe String,
550
  dylibInstallName      :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
551 552
  hiDir                 :: Maybe String,
  stubDir               :: Maybe String,
553
  dumpDir               :: Maybe String,
554

Ian Lynagh's avatar
Ian Lynagh committed
555 556 557
  objectSuf             :: String,
  hcSuf                 :: String,
  hiSuf                 :: String,
558

Ian Lynagh's avatar
Ian Lynagh committed
559 560 561
  outputFile            :: Maybe String,
  outputHi              :: Maybe String,
  dynLibLoader          :: DynLibLoader,
562

563
  -- | This is set by 'DriverPipeline.runPipeline' based on where
Ian Lynagh's avatar
Ian Lynagh committed
564 565
  --    its output is going.
  dumpPrefix            :: Maybe FilePath,
566

567 568
  -- | Override the 'dumpPrefix' set by 'DriverPipeline.runPipeline'.
  --    Set by @-ddump-file-prefix@
Ian Lynagh's avatar
Ian Lynagh committed
569 570
  dumpPrefixForce       :: Maybe FilePath,

571 572
  ldInputs              :: [String],

Ian Lynagh's avatar
Ian Lynagh committed
573 574 575 576 577
  includePaths          :: [String],
  libraryPaths          :: [String],
  frameworkPaths        :: [String],    -- used on darwin only
  cmdlineFrameworks     :: [String],    -- ditto

578
  rtsOpts               :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
579
  rtsOptsEnabled        :: RtsOptsEnabled,
580

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

583 584 585 586
  -- Plugins
  pluginModNames        :: [ModuleName],
  pluginModNameOpts     :: [(ModuleName,String)],

587 588 589 590 591 592
  --  For ghc -M
  depMakefile           :: FilePath,
  depIncludePkgDeps     :: Bool,
  depExcludeMods        :: [ModuleName],
  depSuffixes           :: [String],

593
  --  Package flags
594
  extraPkgConfs         :: [PkgConfRef] -> [PkgConfRef],
595
        -- ^ The @-package-db@ flags given on the command line, in the order
Ian Lynagh's avatar
Ian Lynagh committed
596
        -- they appeared.
597

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

601
  -- Package state
Ian Lynagh's avatar
Ian Lynagh committed
602
  -- NB. do not modify this field, it is calculated by
603
  -- Packages.initPackages and Packages.updatePackages.
604
  pkgDatabase           :: Maybe [PackageConfig],
Ian Lynagh's avatar
Ian Lynagh committed
605
  pkgState              :: PackageState,
606

607 608 609 610
  -- Temporary files
  -- These have to be IORefs, because the defaultCleanupHandler needs to
  -- know what to clean when an exception happens
  filesToClean          :: IORef [FilePath],
611
  dirsToClean           :: IORef (Map FilePath FilePath),
612

613 614 615 616 617
  -- 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),

618
  -- hsc dynamic flags
619 620
  flags                 :: IntSet,
  warningFlags          :: IntSet,
621
  -- Don't change this without updating extensionFlags:
622
  language              :: Maybe Language,
623 624
  -- | Safe Haskell mode
  safeHaskell           :: SafeHaskellMode,
625 626 627
  -- 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.
628 629
  thOnLoc               :: SrcSpan,
  newDerivOnLoc         :: SrcSpan,
630
  pkgTrustOnLoc         :: SrcSpan,
631 632
  warnSafeOnLoc         :: SrcSpan,
  warnUnsafeOnLoc       :: SrcSpan,
633 634 635 636
  -- Don't change this without updating extensionFlags:
  extensions            :: [OnOff ExtensionFlag],
  -- extensionFlags should always be equal to
  --     flattenExtensionFlags language extensions
637
  extensionFlags        :: IntSet,
Ian Lynagh's avatar
Ian Lynagh committed
638

639
  -- | MsgDoc output action: use "ErrUtils" instead of this if you can
640
  log_action            :: LogAction,
641 642
  flushOut              :: FlushOut,
  flushErr              :: FlushErr,
David Waern's avatar
David Waern committed
643

644
  haddockOptions        :: Maybe String,
645
  ghciScripts           :: [String],
646

647 648
  -- Output style options
  pprUserLength         :: Int,
Ian Lynagh's avatar
Ian Lynagh committed
649
  pprCols               :: Int,
Ian Lynagh's avatar
Ian Lynagh committed
650
  traceLevel            :: Int, -- Standard level is 1. Less verbose is 0.
651 652

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

655
  interactivePrint      :: Maybe String,
656

657
  llvmVersion           :: IORef (Int)
658 659
 }

660 661 662
class HasDynFlags m where
    getDynFlags :: m DynFlags

Ian Lynagh's avatar
Ian Lynagh committed
663 664 665
class ContainsDynFlags t where
    extractDynFlags :: t -> DynFlags

666 667 668 669 670
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
671
  | ProfAutoCalls      -- ^ annotate call-sites
Simon Marlow's avatar
Simon Marlow committed
672
  deriving (Enum)
673

674
data Settings = Settings {
675
  sTargetPlatform        :: Platform,    -- Filled in by SysTools
676 677 678 679 680 681 682 683 684
  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,
685 686 687
  sLdSupportsCompactUnwind :: Bool,
  sLdSupportsBuildId       :: Bool,
  sLdIsGnuLd               :: Bool,
688 689 690 691 692 693 694 695 696 697 698 699 700
  -- 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
701 702 703 704 705 706 707 708 709 710
  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
711
  sOpt_lc                :: [String], -- LLVM: llc static compiler
712

713
  sPlatformConstants     :: PlatformConstants
714 715
 }

716 717 718
targetPlatform :: DynFlags -> Platform
targetPlatform dflags = sTargetPlatform (settings dflags)

719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758
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)
759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776
opt_L                 :: DynFlags -> [String]
opt_L dflags = sOpt_L (settings dflags)
opt_P                 :: DynFlags -> [String]
opt_P dflags = sOpt_P (settings dflags)
opt_F                 :: DynFlags -> [String]
opt_F dflags = sOpt_F (settings dflags)
opt_c                 :: DynFlags -> [String]
opt_c dflags = sOpt_c (settings dflags)
opt_a                 :: DynFlags -> [String]
opt_a dflags = sOpt_a (settings dflags)
opt_l                 :: DynFlags -> [String]
opt_l dflags = sOpt_l (settings dflags)
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)
777

778 779
-- | The target code type of the compilation (if any).
--
780 781 782
-- Whenever you change the target, also make sure to set 'ghcLink' to
-- something sensible.
--
783 784 785 786
-- 'HscNothing' can be used to avoid generating any output, however, note
-- that:
--
--  * This will not run the desugaring step, thus no warnings generated in
787 788 789
--    this step will be output.  In particular, this includes warnings related
--    to pattern matching.  You can run the desugarer manually using
--    'GHC.desugarModule'.
790
--
791 792 793 794
--  * 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
795
--    different target or avoid typechecking such modules.  (The latter may be
796
--    preferable for security reasons.)
797
--
798
data HscTarget
799 800
  = HscC           -- ^ Generate C code.
  | HscAsm         -- ^ Generate assembly using the native code generator.
801
  | HscLlvm        -- ^ Generate assembly using the llvm code generator.
802 803
  | HscInterpreted -- ^ Generate bytecode.  (Requires 'LinkInMemory')
  | HscNothing     -- ^ Don't generate any code.  See notes above.
804 805
  deriving (Eq, Show)

Ian Lynagh's avatar
Ian Lynagh committed
806 807 808 809 810 811 812
showHscTargetFlag :: HscTarget -> String
showHscTargetFlag HscC           = "-fvia-c"
showHscTargetFlag HscAsm         = "-fasm"
showHscTargetFlag HscLlvm        = "-fllvm"
showHscTargetFlag HscInterpreted = "-fbyte-code"
showHscTargetFlag HscNothing     = "-fno-code"

813
-- | Will this target result in an object file on the disk?
814 815 816
isObjectTarget :: HscTarget -> Bool
isObjectTarget HscC     = True
isObjectTarget HscAsm   = True
817
isObjectTarget HscLlvm  = True
818 819
isObjectTarget _        = False

820 821 822 823 824 825 826 827 828 829 830
-- | 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

831 832 833 834 835 836
-- | 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.
837
data GhcMode
838 839 840
  = CompManager         -- ^ @\-\-make@, GHCi, etc.
  | OneShot             -- ^ @ghc -c Foo.hs@
  | MkDepend            -- ^ @ghc -M@, see "Finder" for why we need this
841 842
  deriving Eq

843 844 845 846 847
instance Outputable GhcMode where
  ppr CompManager = ptext (sLit "CompManager")
  ppr OneShot     = ptext (sLit "OneShot")
  ppr MkDepend    = ptext (sLit "MkDepend")

848 849 850 851
isOneShot :: GhcMode -> Bool
isOneShot OneShot = True
isOneShot _other  = False

852 853 854 855
-- | What to do in the link step, if there is one.
data GhcLink
  = NoLink              -- ^ Don't link at all
  | LinkBinary          -- ^ Link object code into a binary
856 857
  | LinkInMemory        -- ^ Use the in-memory dynamic linker (works for both
                        --   bytecode and object code).
858
  | LinkDynLib          -- ^ Link objects into a dynamic lib (DLL on Windows, DSO on ELF platforms)
859
  deriving (Eq, Show)
860 861 862

isNoLink :: GhcLink -> Bool
isNoLink NoLink = True
twanvl's avatar
twanvl committed
863
isNoLink _      = False
864 865

data PackageFlag
866
  = ExposePackage   String
867
  | ExposePackageId String
868 869 870 871
  | HidePackage     String
  | IgnorePackage   String
  | TrustPackage    String
  | DistrustPackage String
872
  deriving Eq
873

874
defaultHscTarget :: Platform -> HscTarget
875 876
defaultHscTarget = defaultObjectTarget

877
-- | The 'HscTarget' value corresponding to the default way to create
878
-- object files on the current platform.
879 880 881
defaultObjectTarget :: Platform -> HscTarget
defaultObjectTarget platform
  | platformUnregisterised platform     =  HscC
Ian Lynagh's avatar
Ian Lynagh committed
882
  | cGhcWithNativeCodeGen == "YES"      =  HscAsm