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

51 52
        printOutputForUser, printInfoForUser,

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
        updOptLevel,
        setTmpDir,
        setPackageName,
85
        doingTickyProfiling,
Ian Lynagh's avatar
Ian Lynagh committed
86

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

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

98
        supportedLanguagesAndExtensions,
99 100

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

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

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

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

#include "HsVersions.h"

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

Ian Lynagh's avatar
Ian Lynagh committed
143
#ifdef GHCI
144
import System.IO.Unsafe ( unsafePerformIO )
Ian Lynagh's avatar
Ian Lynagh committed
145
#endif
146
import Data.IORef
Ian Lynagh's avatar
Ian Lynagh committed
147
import Control.Monad    ( when )
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
148

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

158 159 160
import Data.IntSet (IntSet)
import qualified Data.IntSet as IntSet

161 162 163
-- -----------------------------------------------------------------------------
-- DynFlags

164
-- | Enumerates the simple on-or-off dynamic flags
165 166 167 168
data DynFlag

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

Ian Lynagh's avatar
Ian Lynagh committed
255
   | Opt_WarnIsError                    -- -Werror; makes warnings fatal
256

257 258
   | Opt_PrintExplicitForalls

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

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

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

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

329 330
   -- output style opts
   | Opt_PprCaseAsLet
331

332
   -- temporary flags
333
   | Opt_RunCPS
334
   | Opt_RunCPSZ
335
   | Opt_AutoLinkPackages
336
   | Opt_ImplicitImportQualified
337
   | Opt_TryNewCodeGen
338 339 340 341 342 343

   -- keeping stuff
   | Opt_KeepHiDiffs
   | Opt_KeepHcFiles
   | Opt_KeepSFiles
   | Opt_KeepTmpFiles
Jedai's avatar
Jedai committed
344
   | Opt_KeepRawTokenStream
345
   | Opt_KeepLlvmFiles
346

347
   -- safe haskell flags
dterei's avatar
dterei committed
348
   | Opt_DistrustAllPackages
349 350
   | Opt_PackageTrust

351
   deriving (Eq, Show, Enum)
Ian Lynagh's avatar
Ian Lynagh committed
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 379 380 381 382 383 384 385
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
386 387
   | Opt_WarnUnsafe
   | Opt_WarnSafe
Ian Lynagh's avatar
Ian Lynagh committed
388
   | Opt_WarnPointlessPragmas
389
   | Opt_WarnUnsupportedCallingConventions
390
   | Opt_WarnInlineRuleShadowing
391
   deriving (Eq, Show, Enum)
392

393
data Language = Haskell98 | Haskell2010
394
   deriving Enum
395

396
-- | The various Safe Haskell modes
397 398
data SafeHaskellMode
   = Sf_None
dterei's avatar
dterei committed
399
   | Sf_Unsafe
400 401
   | Sf_Trustworthy
   | Sf_Safe
402
   | Sf_SafeInferred
403 404
   deriving (Eq)

Ian Lynagh's avatar
Ian Lynagh committed
405
instance Show SafeHaskellMode where
Ian Lynagh's avatar
Ian Lynagh committed
406 407 408 409 410
    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
411

412
instance Outputable SafeHaskellMode where
Ian Lynagh's avatar
Ian Lynagh committed
413
    ppr = text . show
414

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

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

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

518
  simplTickFactor       :: Int,         -- ^ Multiplier for simplifier ticks
519 520 521
  specConstrThreshold   :: Maybe Int,   -- ^ Threshold for SpecConstr
  specConstrCount       :: Maybe Int,   -- ^ Max number of specialisations for any one function
  liberateCaseThreshold :: Maybe Int,   -- ^ Threshold for LiberateCase
522
  floatLamArgs          :: Maybe Int,   -- ^ Arg count for lambda floating
523
                                        --   See CoreMonad.FloatOutSwitches
524

525
  cmdlineHcIncludes     :: [String],    -- ^ @\-\#includes@
Ian Lynagh's avatar
Ian Lynagh committed
526 527 528
  importPaths           :: [FilePath],
  mainModIs             :: Module,
  mainFunIs             :: Maybe String,
529
  ctxtStkDepth          :: Int,         -- ^ Typechecker context stack depth
530

531
  thisPackage           :: PackageId,   -- ^ name of package currently being compiled
532 533

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

538 539 540
  -- For object splitting
  splitInfo             :: Maybe (String,Int),

541
  -- paths etc.
Ian Lynagh's avatar
Ian Lynagh committed
542
  objectDir             :: Maybe String,
543
  dylibInstallName      :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
544 545
  hiDir                 :: Maybe String,
  stubDir               :: Maybe String,
546
  dumpDir               :: Maybe String,
547

Ian Lynagh's avatar
Ian Lynagh committed
548 549 550
  objectSuf             :: String,
  hcSuf                 :: String,
  hiSuf                 :: String,
551

Ian Lynagh's avatar
Ian Lynagh committed
552 553 554
  outputFile            :: Maybe String,
  outputHi              :: Maybe String,
  dynLibLoader          :: DynLibLoader,
555

556
  -- | This is set by 'DriverPipeline.runPipeline' based on where
Ian Lynagh's avatar
Ian Lynagh committed
557 558
  --    its output is going.
  dumpPrefix            :: Maybe FilePath,
559

560 561
  -- | Override the 'dumpPrefix' set by 'DriverPipeline.runPipeline'.
  --    Set by @-ddump-file-prefix@
Ian Lynagh's avatar
Ian Lynagh committed
562 563 564 565 566 567 568
  dumpPrefixForce       :: Maybe FilePath,

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

569
  rtsOpts               :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
570
  rtsOptsEnabled        :: RtsOptsEnabled,
571

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

574 575 576 577
  -- Plugins
  pluginModNames        :: [ModuleName],
  pluginModNameOpts     :: [(ModuleName,String)],

578 579 580 581 582 583
  --  For ghc -M
  depMakefile           :: FilePath,
  depIncludePkgDeps     :: Bool,
  depExcludeMods        :: [ModuleName],
  depSuffixes           :: [String],

584
  --  Package flags
585
  extraPkgConfs         :: [PkgConfRef] -> [PkgConfRef],
586
        -- ^ The @-package-db@ flags given on the command line, in the order
Ian Lynagh's avatar
Ian Lynagh committed
587
        -- they appeared.
588

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

592
  -- Package state
Ian Lynagh's avatar
Ian Lynagh committed
593
  -- NB. do not modify this field, it is calculated by
594
  -- Packages.initPackages and Packages.updatePackages.
595
  pkgDatabase           :: Maybe [PackageConfig],
Ian Lynagh's avatar
Ian Lynagh committed
596
  pkgState              :: PackageState,
597

598 599 600 601
  -- Temporary files
  -- These have to be IORefs, because the defaultCleanupHandler needs to
  -- know what to clean when an exception happens
  filesToClean          :: IORef [FilePath],
602
  dirsToClean           :: IORef (Map FilePath FilePath),
603

604 605 606 607 608
  -- 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),

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

630
  -- | MsgDoc output action: use "ErrUtils" instead of this if you can
631
  log_action            :: LogAction,
632 633
  flushOut              :: FlushOut,
  flushErr              :: FlushErr,
David Waern's avatar
David Waern committed
634

635
  haddockOptions        :: Maybe String,
636
  ghciScripts           :: [String],
637

638 639
  -- Output style options
  pprUserLength         :: Int,
Ian Lynagh's avatar
Ian Lynagh committed
640
  pprCols               :: Int,
Ian Lynagh's avatar
Ian Lynagh committed
641
  traceLevel            :: Int, -- Standard level is 1. Less verbose is 0.
642 643

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

646
  interactivePrint      :: Maybe String,
647

648
  llvmVersion           :: IORef (Int)
649 650
 }

651 652 653
class HasDynFlags m where
    getDynFlags :: m DynFlags

Ian Lynagh's avatar
Ian Lynagh committed
654 655 656
class ContainsDynFlags t where
    extractDynFlags :: t -> DynFlags

657 658 659 660 661
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
662
  | ProfAutoCalls      -- ^ annotate call-sites
Simon Marlow's avatar
Simon Marlow committed
663
  deriving (Enum)
664

665
data Settings = Settings {
666
  sTargetPlatform        :: Platform,    -- Filled in by SysTools
667 668 669 670 671 672 673 674 675
  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,
676 677 678
  sLdSupportsCompactUnwind :: Bool,
  sLdSupportsBuildId       :: Bool,
  sLdIsGnuLd               :: Bool,
679 680 681 682 683 684 685 686 687 688 689 690 691
  -- 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
692 693 694 695 696 697 698 699 700 701 702 703
  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

704 705
 }

706 707 708
targetPlatform :: DynFlags -> Platform
targetPlatform dflags = sTargetPlatform (settings dflags)

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 738 739 740 741 742 743 744 745 746 747 748
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)
749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766
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)
767

768 769 770
wayNames :: DynFlags -> [WayName]
wayNames = map wayName . ways

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

Ian Lynagh's avatar
Ian Lynagh committed
799 800 801 802 803 804 805
showHscTargetFlag :: HscTarget -> String
showHscTargetFlag HscC           = "-fvia-c"
showHscTargetFlag HscAsm         = "-fasm"
showHscTargetFlag HscLlvm        = "-fllvm"
showHscTargetFlag HscInterpreted = "-fbyte-code"
showHscTargetFlag HscNothing     = "-fno-code"

806
-- | Will this target result in an object file on the disk?
807 808 809
isObjectTarget :: HscTarget -> Bool
isObjectTarget HscC     = True
isObjectTarget HscAsm   = True
810
isObjectTarget HscLlvm  = True
811 812
isObjectTarget _        = False

813 814 815 816 817 818 819 820 821 822 823
-- | 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

824 825 826 827 828 829
-- | 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.
830
data GhcMode
831 832 833
  = CompManager         -- ^ @\-\-make@, GHCi, etc.
  | OneShot             -- ^ @ghc -c Foo.hs@
  | MkDepend            -- ^ @ghc -M@, see "Finder" for why we need this
834 835
  deriving Eq

836 837 838 839 840
instance Outputable GhcMode where
  ppr CompManager = ptext (sLit "CompManager")
  ppr OneShot     = ptext (sLit "OneShot")
  ppr MkDepend    = ptext (sLit "MkDepend")

841 842 843 844
isOneShot :: GhcMode -> Bool
isOneShot OneShot = True
isOneShot _other  = False

845 846 847 848
-- | 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
849 850
  | LinkInMemory        -- ^ Use the in-memory dynamic linker (works for both
                        --   bytecode and object code).
851
  | LinkDynLib          -- ^ Link objects into a dynamic lib (DLL on Windows, DSO on ELF platforms)
852
  deriving (Eq, Show)
853 854 855

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

858 859 860
-- Is it worth evaluating this Bool and caching it in the DynFlags value
-- during initDynFlags?
doingTickyProfiling :: DynFlags -> Bool
861 862 863
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.
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

twanvl's avatar
twanvl committed
874
defaultHscTarget :: HscTarget
875 876
defaultHscTarget = defaultObjectTarget

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