DynFlags.hs 119 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
Ian Lynagh's avatar
Ian Lynagh committed
16
        DynFlag(..),
17
        WarningFlag(..),
18
        ExtensionFlag(..),
19
        Language(..),
Ian Lynagh's avatar
Ian Lynagh committed
20
        FatalMessager, LogAction, FlushOut(..), FlushErr(..),
21
        ProfAuto(..),
22
        glasgowExtsFlags,
23 24 25
        dopt,
        dopt_set,
        dopt_unset,
26 27 28
        wopt,
        wopt_set,
        wopt_unset,
29 30 31
        xopt,
        xopt_set,
        xopt_unset,
32
        lang_set,
Ian Lynagh's avatar
Ian Lynagh committed
33
        DynFlags(..),
Ian Lynagh's avatar
Ian Lynagh committed
34
        HasDynFlags(..), ContainsDynFlags(..),
Ian Lynagh's avatar
Ian Lynagh committed
35
        RtsOptsEnabled(..),
Ian Lynagh's avatar
Ian Lynagh committed
36
        HscTarget(..), isObjectTarget, defaultObjectTarget,
37
        targetRetainsAllBindings,
Ian Lynagh's avatar
Ian Lynagh committed
38 39 40
        GhcMode(..), isOneShot,
        GhcLink(..), isNoLink,
        PackageFlag(..),
41
        PkgConfRef(..),
Ian Lynagh's avatar
Ian Lynagh committed
42
        Option(..), showOpt,
Ian Lynagh's avatar
Ian Lynagh committed
43
        DynLibLoader(..),
44
        fFlags, fWarningFlags, fLangFlags, xFlags,
45
        wayNames, dynFlagDependencies,
46

47 48
        printOutputForUser, printInfoForUser,

49
        -- ** Safe Haskell
50
        SafeHaskellMode(..),
51
        safeHaskellOn, safeImportsOn, safeLanguageOn, safeInferOn,
52
        packageTrustOn,
53
        safeDirectImpsReq, safeImplicitImpsReq,
54
        unsafeFlags,
55

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


67
        -- ** Manipulating DynFlags
68
        defaultDynFlags,                -- Settings -> DynFlags
Ian Lynagh's avatar
Ian Lynagh committed
69
        initDynFlags,                   -- DynFlags -> IO DynFlags
Ian Lynagh's avatar
Ian Lynagh committed
70
        defaultFatalMessager,
71
        defaultLogAction,
72
        defaultLogActionHPrintDoc,
73 74
        defaultFlushOut,
        defaultFlushErr,
Ian Lynagh's avatar
Ian Lynagh committed
75

76
        getOpts,                        -- DynFlags -> (DynFlags -> [a]) -> [a]
77
        getVerbFlags,
Ian Lynagh's avatar
Ian Lynagh committed
78 79 80
        updOptLevel,
        setTmpDir,
        setPackageName,
81
        doingTickyProfiling,
Ian Lynagh's avatar
Ian Lynagh committed
82

83
        -- ** Parsing DynFlags
84 85
        parseDynamicFlagsCmdLine,
        parseDynamicFilePragma,
86 87 88
        parseDynamicFlagsFull,

        -- ** Available DynFlags
89
        allFlags,
90 91 92
        flagsAll,
        flagsDynamic,
        flagsPackage,
93

94
        supportedLanguagesAndExtensions,
95 96

        -- ** DynFlag C compiler options
Ian Lynagh's avatar
Ian Lynagh committed
97
        picCCOpts, picPOpts,
98 99 100 101 102 103

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

        -- * Compiler configuration suitable for display to the user
104 105
        compilerInfo,

106
#ifdef GHCI
dterei's avatar
dterei committed
107
-- Only in stage 2 can we be sure that the RTS
108
-- exposes the appropriate runtime boolean
109
        rtsIsProfiled,
110
#endif
111 112
        -- ** Only for use in the tracing functions in Outputable
        tracingDynFlags,
113 114 115 116
  ) where

#include "HsVersions.h"

117
import Platform
118
import Module
Simon Marlow's avatar
Simon Marlow committed
119
import PackageConfig
120
import PrelNames        ( mAIN )
121
import StaticFlags
122
import {-# SOURCE #-} Packages (PackageState)
Ian Lynagh's avatar
Ian Lynagh committed
123
import DriverPhases     ( Phase(..), phaseInputExt )
124 125
import Config
import CmdLineParser
Ian Lynagh's avatar
Ian Lynagh committed
126
import Constants        ( mAX_CONTEXT_REDUCTION_DEPTH )
127
import Panic
128
import Util
129
import Maybes           ( orElse )
130
import qualified Pretty
131
import SrcLoc
132
import FastString
Simon Marlow's avatar
Simon Marlow committed
133
import Outputable
Ian Lynagh's avatar
Ian Lynagh committed
134
#ifdef GHCI
Ian Lynagh's avatar
Ian Lynagh committed
135
import Foreign.C        ( CInt(..) )
Ian Lynagh's avatar
Ian Lynagh committed
136
#endif
137
import {-# SOURCE #-} ErrUtils ( Severity(..), MsgDoc, mkLocMessage )
138

Ian Lynagh's avatar
Ian Lynagh committed
139
#ifdef GHCI
140
import System.IO.Unsafe ( unsafePerformIO )
Ian Lynagh's avatar
Ian Lynagh committed
141
#endif
142
import Data.IORef
Ian Lynagh's avatar
Ian Lynagh committed
143
import Control.Monad    ( when )
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
144

145
import Data.Char
146
import Data.List
147 148
import Data.Map (Map)
import qualified Data.Map as Map
149 150
import Data.Set (Set)
import qualified Data.Set as Set
Ian Lynagh's avatar
Ian Lynagh committed
151
import System.FilePath
152
import System.IO
153

154 155 156
import Data.IntSet (IntSet)
import qualified Data.IntSet as IntSet

157 158 159
-- -----------------------------------------------------------------------------
-- DynFlags

160
-- | Enumerates the simple on-or-off dynamic flags
161 162 163 164
data DynFlag

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

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

253 254
   | Opt_PrintExplicitForalls

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

280 281 282 283 284
   -- Interface files
   | Opt_IgnoreInterfacePragmas
   | Opt_OmitInterfacePragmas
   | Opt_ExposeAllUnfoldings

Ian Lynagh's avatar
Ian Lynagh committed
285 286
   -- profiling opts
   | Opt_AutoSccsOnIndividualCafs
287
   | Opt_ProfCountEntries
Ian Lynagh's avatar
Ian Lynagh committed
288

289 290
   -- misc opts
   | Opt_Pp
291
   | Opt_ForceRecomp
292
   | Opt_ExcessPrecision
293
   | Opt_EagerBlackHoling
294 295 296
   | Opt_NoHsMain
   | Opt_SplitObjs
   | Opt_StgStats
297
   | Opt_HideAllPackages
298
   | Opt_PrintBindResult
299
   | Opt_Haddock
David Waern's avatar
David Waern committed
300
   | Opt_HaddockOptions
301
   | Opt_Hpc_No_Auto
302
   | Opt_BreakOnException
303
   | Opt_BreakOnError
304
   | Opt_PrintEvldWithShow
305
   | Opt_PrintBindContents
306 307
   | Opt_GenManifest
   | Opt_EmbedManifest
308
   | Opt_EmitExternalCore
Ian Lynagh's avatar
Ian Lynagh committed
309
   | Opt_SharedImplib
310
   | Opt_BuildingCabalPackage
311
   | Opt_SSE2
tibbe's avatar
tibbe committed
312
   | Opt_SSE4_2
313
   | Opt_IgnoreDotGhci
314
   | Opt_GhciSandbox
Ian Lynagh's avatar
Ian Lynagh committed
315
   | Opt_GhciHistory
316
   | Opt_HelpfulErrors
317
   | Opt_DeferTypeErrors
Ian Lynagh's avatar
Ian Lynagh committed
318
   | Opt_Parallel
Ian Lynagh's avatar
Ian Lynagh committed
319
   | Opt_GranMacros
Ian Lynagh's avatar
Ian Lynagh committed
320
   | Opt_PIC
321

322 323
   -- output style opts
   | Opt_PprCaseAsLet
324

325
   -- temporary flags
326
   | Opt_RunCPS
327
   | Opt_RunCPSZ
328
   | Opt_AutoLinkPackages
329
   | Opt_ImplicitImportQualified
330
   | Opt_TryNewCodeGen
331 332 333 334 335 336

   -- keeping stuff
   | Opt_KeepHiDiffs
   | Opt_KeepHcFiles
   | Opt_KeepSFiles
   | Opt_KeepTmpFiles
Jedai's avatar
Jedai committed
337
   | Opt_KeepRawTokenStream
338
   | Opt_KeepLlvmFiles
339

340
   -- safe haskell flags
dterei's avatar
dterei committed
341
   | Opt_DistrustAllPackages
342 343
   | Opt_PackageTrust

344
   deriving (Eq, Show, Enum)
Ian Lynagh's avatar
Ian Lynagh committed
345

346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378
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
379 380
   | Opt_WarnUnsafe
   | Opt_WarnSafe
Ian Lynagh's avatar
Ian Lynagh committed
381
   | Opt_WarnPointlessPragmas
382
   | Opt_WarnUnsupportedCallingConventions
383
   deriving (Eq, Show, Enum)
384

385
data Language = Haskell98 | Haskell2010
386
   deriving Enum
387

388
-- | The various Safe Haskell modes
389 390
data SafeHaskellMode
   = Sf_None
dterei's avatar
dterei committed
391
   | Sf_Unsafe
392 393
   | Sf_Trustworthy
   | Sf_Safe
394
   | Sf_SafeInferred
395 396
   deriving (Eq)

Ian Lynagh's avatar
Ian Lynagh committed
397
instance Show SafeHaskellMode where
Ian Lynagh's avatar
Ian Lynagh committed
398 399 400 401 402
    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
403

404
instance Outputable SafeHaskellMode where
Ian Lynagh's avatar
Ian Lynagh committed
405
    ppr = text . show
406

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

   | 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
469
   | Opt_MonadComprehensions
470 471 472 473 474 475 476 477 478 479
   | Opt_GeneralizedNewtypeDeriving
   | Opt_RecursiveDo
   | Opt_PostfixOperators
   | Opt_TupleSections
   | Opt_PatternGuards
   | Opt_LiberalTypeSynonyms
   | Opt_Rank2Types
   | Opt_RankNTypes
   | Opt_ImpredicativeTypes
   | Opt_TypeOperators
480
   | Opt_ExplicitNamespaces
481 482 483 484 485
   | Opt_PackageImports
   | Opt_ExplicitForAll
   | Opt_AlternativeLayoutRule
   | Opt_AlternativeLayoutRuleTransitional
   | Opt_DatatypeContexts
486
   | Opt_NondecreasingIndentation
487
   | Opt_RelaxedLayout
488
   | Opt_TraditionalRecordSyntax
489
   | Opt_LambdaCase
490
   | Opt_MultiWayIf
491
   deriving (Eq, Enum, Show)
492

493 494
-- | 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
495
data DynFlags = DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
496 497 498
  ghcMode               :: GhcMode,
  ghcLink               :: GhcLink,
  hscTarget             :: HscTarget,
499
  settings              :: Settings,
500
  hscOutName            :: String,      -- ^ Name of the output file
501
  extCoreName           :: String,      -- ^ Name of the .hcr output file
502
  verbosity             :: Int,         -- ^ Verbosity level: see Note [Verbosity levels]
503 504 505
  optLevel              :: Int,         -- ^ Optimisation level
  simplPhases           :: Int,         -- ^ Number of simplifier phases
  maxSimplIterations    :: Int,         -- ^ Max simplifier iterations
506
  shouldDumpSimplPhase  :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
507
  ruleCheck             :: Maybe String,
508
  strictnessBefore      :: [Int],       -- ^ Additional demand analysis
509

510
  simplTickFactor       :: Int,         -- ^ Multiplier for simplifier ticks
511 512 513
  specConstrThreshold   :: Maybe Int,   -- ^ Threshold for SpecConstr
  specConstrCount       :: Maybe Int,   -- ^ Max number of specialisations for any one function
  liberateCaseThreshold :: Maybe Int,   -- ^ Threshold for LiberateCase
514
  floatLamArgs          :: Maybe Int,   -- ^ Arg count for lambda floating
515
                                        --   See CoreMonad.FloatOutSwitches
516

517
  cmdlineHcIncludes     :: [String],    -- ^ @\-\#includes@
Ian Lynagh's avatar
Ian Lynagh committed
518 519 520
  importPaths           :: [FilePath],
  mainModIs             :: Module,
  mainFunIs             :: Maybe String,
521
  ctxtStkDepth          :: Int,         -- ^ Typechecker context stack depth
522

523
  thisPackage           :: PackageId,   -- ^ name of package currently being compiled
524 525

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

530 531 532
  -- For object splitting
  splitInfo             :: Maybe (String,Int),

533
  -- paths etc.
Ian Lynagh's avatar
Ian Lynagh committed
534
  objectDir             :: Maybe String,
535
  dylibInstallName      :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
536 537
  hiDir                 :: Maybe String,
  stubDir               :: Maybe String,
538
  dumpDir               :: Maybe String,
539

Ian Lynagh's avatar
Ian Lynagh committed
540 541 542
  objectSuf             :: String,
  hcSuf                 :: String,
  hiSuf                 :: String,
543

Ian Lynagh's avatar
Ian Lynagh committed
544 545 546
  outputFile            :: Maybe String,
  outputHi              :: Maybe String,
  dynLibLoader          :: DynLibLoader,
547

548
  -- | This is set by 'DriverPipeline.runPipeline' based on where
Ian Lynagh's avatar
Ian Lynagh committed
549 550
  --    its output is going.
  dumpPrefix            :: Maybe FilePath,
551

552 553
  -- | Override the 'dumpPrefix' set by 'DriverPipeline.runPipeline'.
  --    Set by @-ddump-file-prefix@
Ian Lynagh's avatar
Ian Lynagh committed
554 555 556 557 558 559 560
  dumpPrefixForce       :: Maybe FilePath,

  includePaths          :: [String],
  libraryPaths          :: [String],
  frameworkPaths        :: [String],    -- used on darwin only
  cmdlineFrameworks     :: [String],    -- ditto

561
  rtsOpts               :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
562
  rtsOptsEnabled        :: RtsOptsEnabled,
563

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

566 567 568 569
  -- Plugins
  pluginModNames        :: [ModuleName],
  pluginModNameOpts     :: [(ModuleName,String)],

570 571 572 573 574 575
  --  For ghc -M
  depMakefile           :: FilePath,
  depIncludePkgDeps     :: Bool,
  depExcludeMods        :: [ModuleName],
  depSuffixes           :: [String],

576
  --  Package flags
577
  extraPkgConfs         :: [PkgConfRef] -> [PkgConfRef],
578
        -- ^ The @-package-db@ flags given on the command line, in the order
Ian Lynagh's avatar
Ian Lynagh committed
579
        -- they appeared.
580

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

584
  -- Package state
Ian Lynagh's avatar
Ian Lynagh committed
585
  -- NB. do not modify this field, it is calculated by
586
  -- Packages.initPackages and Packages.updatePackages.
587
  pkgDatabase           :: Maybe [PackageConfig],
Ian Lynagh's avatar
Ian Lynagh committed
588
  pkgState              :: PackageState,
589

590 591 592 593
  -- Temporary files
  -- These have to be IORefs, because the defaultCleanupHandler needs to
  -- know what to clean when an exception happens
  filesToClean          :: IORef [FilePath],
594
  dirsToClean           :: IORef (Map FilePath FilePath),
595

596 597 598 599 600
  -- 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),

601
  -- hsc dynamic flags
602 603
  flags                 :: IntSet,
  warningFlags          :: IntSet,
604
  -- Don't change this without updating extensionFlags:
605
  language              :: Maybe Language,
606 607
  -- | Safe Haskell mode
  safeHaskell           :: SafeHaskellMode,
608 609 610
  -- 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.
611 612
  thOnLoc               :: SrcSpan,
  newDerivOnLoc         :: SrcSpan,
613
  pkgTrustOnLoc         :: SrcSpan,
614 615
  warnSafeOnLoc         :: SrcSpan,
  warnUnsafeOnLoc       :: SrcSpan,
616 617 618 619
  -- Don't change this without updating extensionFlags:
  extensions            :: [OnOff ExtensionFlag],
  -- extensionFlags should always be equal to
  --     flattenExtensionFlags language extensions
620
  extensionFlags        :: IntSet,
Ian Lynagh's avatar
Ian Lynagh committed
621

622
  -- | MsgDoc output action: use "ErrUtils" instead of this if you can
623
  log_action            :: LogAction,
624 625
  flushOut              :: FlushOut,
  flushErr              :: FlushErr,
David Waern's avatar
David Waern committed
626

627
  haddockOptions        :: Maybe String,
628
  ghciScripts           :: [String],
629

630 631
  -- Output style options
  pprUserLength         :: Int,
Ian Lynagh's avatar
Ian Lynagh committed
632
  pprCols               :: Int,
Ian Lynagh's avatar
Ian Lynagh committed
633
  traceLevel            :: Int, -- Standard level is 1. Less verbose is 0.
634 635

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

638
  interactivePrint      :: Maybe String,
639

640
  llvmVersion           :: IORef (Int)
641 642
 }

643 644 645
class HasDynFlags m where
    getDynFlags :: m DynFlags

Ian Lynagh's avatar
Ian Lynagh committed
646 647 648
class ContainsDynFlags t where
    extractDynFlags :: t -> DynFlags

649 650 651 652 653
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
654
  | ProfAutoCalls      -- ^ annotate call-sites
Simon Marlow's avatar
Simon Marlow committed
655
  deriving (Enum)
656

657
data Settings = Settings {
658
  sTargetPlatform        :: Platform,    -- Filled in by SysTools
659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680
  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,
  -- 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
681 682 683 684 685 686 687 688 689 690 691 692
  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
  sOpt_lc                :: [String]  -- LLVM: llc static compiler

693 694
 }

695 696 697
targetPlatform :: DynFlags -> Platform
targetPlatform dflags = sTargetPlatform (settings dflags)

698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737
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)
738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755
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)
756

757 758 759
wayNames :: DynFlags -> [WayName]
wayNames = map wayName . ways

760 761
-- | The target code type of the compilation (if any).
--
762 763 764
-- Whenever you change the target, also make sure to set 'ghcLink' to
-- something sensible.
--
765 766 767 768
-- 'HscNothing' can be used to avoid generating any output, however, note
-- that:
--
--  * This will not run the desugaring step, thus no warnings generated in
769 770 771
--    this step will be output.  In particular, this includes warnings related
--    to pattern matching.  You can run the desugarer manually using
--    'GHC.desugarModule'.
772
--
773 774 775 776
--  * 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
777
--    different target or avoid typechecking such modules.  (The latter may be
778
--    preferable for security reasons.)
779
--
780
data HscTarget
781 782
  = HscC           -- ^ Generate C code.
  | HscAsm         -- ^ Generate assembly using the native code generator.
783
  | HscLlvm        -- ^ Generate assembly using the llvm code generator.
784 785
  | HscInterpreted -- ^ Generate bytecode.  (Requires 'LinkInMemory')
  | HscNothing     -- ^ Don't generate any code.  See notes above.
786 787
  deriving (Eq, Show)

Ian Lynagh's avatar
Ian Lynagh committed
788 789 790 791 792 793 794
showHscTargetFlag :: HscTarget -> String
showHscTargetFlag HscC           = "-fvia-c"
showHscTargetFlag HscAsm         = "-fasm"
showHscTargetFlag HscLlvm        = "-fllvm"
showHscTargetFlag HscInterpreted = "-fbyte-code"
showHscTargetFlag HscNothing     = "-fno-code"

795
-- | Will this target result in an object file on the disk?
796 797 798
isObjectTarget :: HscTarget -> Bool
isObjectTarget HscC     = True
isObjectTarget HscAsm   = True
799
isObjectTarget HscLlvm  = True
800 801
isObjectTarget _        = False

802 803 804 805 806 807 808 809 810 811 812
-- | 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

813 814 815 816 817 818
-- | 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.
819
data GhcMode
820 821 822
  = CompManager         -- ^ @\-\-make@, GHCi, etc.
  | OneShot             -- ^ @ghc -c Foo.hs@
  | MkDepend            -- ^ @ghc -M@, see "Finder" for why we need this
823 824
  deriving Eq

825 826 827 828 829
instance Outputable GhcMode where
  ppr CompManager = ptext (sLit "CompManager")
  ppr OneShot     = ptext (sLit "OneShot")
  ppr MkDepend    = ptext (sLit "MkDepend")

830 831 832 833
isOneShot :: GhcMode -> Bool
isOneShot OneShot = True
isOneShot _other  = False

834 835 836 837
-- | 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
838 839
  | LinkInMemory        -- ^ Use the in-memory dynamic linker (works for both
                        --   bytecode and object code).
840
  | LinkDynLib          -- ^ Link objects into a dynamic lib (DLL on Windows, DSO on ELF platforms)
841
  deriving (Eq, Show)
842 843 844

isNoLink :: GhcLink -> Bool
isNoLink NoLink = True
twanvl's avatar
twanvl committed
845
isNoLink _      = False
846

847 848 849
-- Is it worth evaluating this Bool and caching it in the DynFlags value
-- during initDynFlags?
doingTickyProfiling :: DynFlags -> Bool
850 851 852
doingTickyProfiling _ = opt_Ticky
  -- XXX -ticky is a static flag, because it implies -debug which is also
  -- static.  If the way flags were made dynamic, we could fix this.
853

854
data PackageFlag
855
  = ExposePackage   String
856
  | ExposePackageId String
857 858 859 860
  | HidePackage     String
  | IgnorePackage   String
  | TrustPackage    String
  | DistrustPackage String
861
  deriving Eq
862

twanvl's avatar
twanvl committed
863
defaultHscTarget :: HscTarget
864 865
defaultHscTarget = defaultObjectTarget

866
-- | The 'HscTarget' value corresponding to the default way to create
867
-- object files on the current platform.
twanvl's avatar
twanvl committed
868
defaultObjectTarget :: HscTarget
869
defaultObjectTarget
870
  | cGhcUnregisterised    == "YES"      =  HscC
Ian Lynagh's avatar
Ian Lynagh committed
871
  | cGhcWithNativeCodeGen == "YES"      =  HscAsm
872
  | otherwise                           =  HscLlvm
873

874 875 876 877 878
data DynLibLoader
  = Deployable
  | SystemDependent
  deriving Eq

Ian Lynagh's avatar
Ian Lynagh committed
879
data RtsOptsEnabled = RtsOptsNone | RtsOptsSafeOnly | RtsOptsAll
880
  deriving (Show)
Ian Lynagh's avatar
Ian Lynagh committed
881

882
-- | Used by 'GHC.newSession' to partially initialize a new 'DynFlags' value
twanvl's avatar
twanvl committed
883
initDynFlags :: DynFlags -> IO DynFlags
884 885 886
initDynFlags dflags = do
 -- someday these will be dynamic flags
 ways <- readIORef v_Ways