DynFlags.hs 113 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
        allFlags,
87

88
        supportedLanguagesAndExtensions,
89 90

        -- ** DynFlag C compiler options
91
        picCCOpts,
92 93 94 95 96 97

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

        -- * Compiler configuration suitable for display to the user
98 99
        compilerInfo
#ifdef GHCI
dterei's avatar
dterei committed
100
-- Only in stage 2 can we be sure that the RTS
101
-- exposes the appropriate runtime boolean
dterei's avatar
dterei committed
102
      , rtsIsProfiled
103
#endif
104 105 106 107
  ) where

#include "HsVersions.h"

108
import Platform
109
import Module
Simon Marlow's avatar
Simon Marlow committed
110
import PackageConfig
111
import PrelNames        ( mAIN )
112
import StaticFlags
113
import {-# SOURCE #-} Packages (PackageState)
Ian Lynagh's avatar
Ian Lynagh committed
114
import DriverPhases     ( Phase(..), phaseInputExt )
115 116
import Config
import CmdLineParser
Ian Lynagh's avatar
Ian Lynagh committed
117
import Constants        ( mAX_CONTEXT_REDUCTION_DEPTH )
118
import Panic
119
import Util
120
import Maybes           ( orElse )
121
import qualified Pretty
122
import SrcLoc
123
import FastString
Simon Marlow's avatar
Simon Marlow committed
124
import Outputable
Ian Lynagh's avatar
Ian Lynagh committed
125
#ifdef GHCI
Ian Lynagh's avatar
Ian Lynagh committed
126
import Foreign.C        ( CInt(..) )
Ian Lynagh's avatar
Ian Lynagh committed
127
#endif
128
import {-# SOURCE #-} ErrUtils ( Severity(..), MsgDoc, mkLocMessage )
129

Ian Lynagh's avatar
Ian Lynagh committed
130
#ifdef GHCI
131
import System.IO.Unsafe ( unsafePerformIO )
Ian Lynagh's avatar
Ian Lynagh committed
132
#endif
133
import Data.IORef
Ian Lynagh's avatar
Ian Lynagh committed
134
import Control.Monad    ( when )
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
135

136
import Data.Char
137
import Data.List
138 139
import Data.Map (Map)
import qualified Data.Map as Map
140 141
import Data.Set (Set)
import qualified Data.Set as Set
Ian Lynagh's avatar
Ian Lynagh committed
142
import System.FilePath
143
import System.IO
144

145 146 147
import Data.IntSet (IntSet)
import qualified Data.IntSet as IntSet

148 149 150
-- -----------------------------------------------------------------------------
-- DynFlags

151
-- | Enumerates the simple on-or-off dynamic flags
152 153 154 155
data DynFlag

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

Ian Lynagh's avatar
Ian Lynagh committed
242
   | Opt_WarnIsError                    -- -Werror; makes warnings fatal
243

244 245
   | Opt_PrintExplicitForalls

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

270 271 272 273 274
   -- Interface files
   | Opt_IgnoreInterfacePragmas
   | Opt_OmitInterfacePragmas
   | Opt_ExposeAllUnfoldings

Ian Lynagh's avatar
Ian Lynagh committed
275 276
   -- profiling opts
   | Opt_AutoSccsOnIndividualCafs
277
   | Opt_ProfCountEntries
Ian Lynagh's avatar
Ian Lynagh committed
278

279 280
   -- misc opts
   | Opt_Pp
281
   | Opt_ForceRecomp
282
   | Opt_ExcessPrecision
283
   | Opt_EagerBlackHoling
284 285 286
   | Opt_NoHsMain
   | Opt_SplitObjs
   | Opt_StgStats
287
   | Opt_HideAllPackages
288
   | Opt_PrintBindResult
289
   | Opt_Haddock
David Waern's avatar
David Waern committed
290
   | Opt_HaddockOptions
291
   | Opt_Hpc_No_Auto
292
   | Opt_BreakOnException
293
   | Opt_BreakOnError
294
   | Opt_PrintEvldWithShow
295
   | Opt_PrintBindContents
296 297
   | Opt_GenManifest
   | Opt_EmbedManifest
298
   | Opt_EmitExternalCore
Ian Lynagh's avatar
Ian Lynagh committed
299
   | Opt_SharedImplib
300
   | Opt_BuildingCabalPackage
301
   | Opt_SSE2
tibbe's avatar
tibbe committed
302
   | Opt_SSE4_2
303
   | Opt_GhciSandbox
Ian Lynagh's avatar
Ian Lynagh committed
304
   | Opt_GhciHistory
305
   | Opt_HelpfulErrors
306
   | Opt_DeferTypeErrors
307

308
   -- temporary flags
309
   | Opt_RunCPS
310
   | Opt_RunCPSZ
311
   | Opt_AutoLinkPackages
312
   | Opt_ImplicitImportQualified
313
   | Opt_TryNewCodeGen
314 315 316 317 318 319

   -- keeping stuff
   | Opt_KeepHiDiffs
   | Opt_KeepHcFiles
   | Opt_KeepSFiles
   | Opt_KeepTmpFiles
Jedai's avatar
Jedai committed
320
   | Opt_KeepRawTokenStream
321
   | Opt_KeepLlvmFiles
322

323
   -- safe haskell flags
dterei's avatar
dterei committed
324
   | Opt_DistrustAllPackages
325 326
   | Opt_PackageTrust

327
   deriving (Eq, Show, Enum)
Ian Lynagh's avatar
Ian Lynagh committed
328

329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361
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
362 363
   | Opt_WarnUnsafe
   | Opt_WarnSafe
Ian Lynagh's avatar
Ian Lynagh committed
364
   | Opt_WarnPointlessPragmas
365
   | Opt_WarnUnsupportedCallingConventions
366
   deriving (Eq, Show, Enum)
367

368
data Language = Haskell98 | Haskell2010
369
   deriving Enum
370

371
-- | The various Safe Haskell modes
372 373
data SafeHaskellMode
   = Sf_None
dterei's avatar
dterei committed
374
   | Sf_Unsafe
375 376
   | Sf_Trustworthy
   | Sf_Safe
dterei's avatar
dterei committed
377
   | Sf_SafeInfered
378 379
   deriving (Eq)

380
instance Outputable SafeHaskellMode where
dterei's avatar
dterei committed
381 382
    ppr Sf_None        = ptext $ sLit "None"
    ppr Sf_Unsafe      = ptext $ sLit "Unsafe"
383
    ppr Sf_Trustworthy = ptext $ sLit "Trustworthy"
dterei's avatar
dterei committed
384 385
    ppr Sf_Safe        = ptext $ sLit "Safe"
    ppr Sf_SafeInfered = ptext $ sLit "Safe-Infered"
386

387
data ExtensionFlag
388 389 390 391 392 393 394
   = Opt_Cpp
   | Opt_OverlappingInstances
   | Opt_UndecidableInstances
   | Opt_IncoherentInstances
   | Opt_MonomorphismRestriction
   | Opt_MonoPatBinds
   | Opt_MonoLocalBinds
395 396
   | Opt_RelaxedPolyRec           -- Deprecated
   | Opt_ExtendedDefaultRules     -- Use GHC's extended rules for defaulting
397 398
   | Opt_ForeignFunctionInterface
   | Opt_UnliftedFFITypes
399
   | Opt_InterruptibleFFI
400
   | Opt_CApiFFI
401
   | Opt_GHCForeignImportPrim
402 403
   | Opt_ParallelArrays           -- Syntactic support for parallel arrays
   | Opt_Arrows                   -- Arrow-notation syntax
404 405 406 407 408 409 410 411 412 413 414 415 416 417
   | 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
418
   | Opt_GADTSyntax
419
   | Opt_NPlusKPatterns
Ian Lynagh's avatar
Ian Lynagh committed
420
   | Opt_DoAndIfThenElse
421
   | Opt_RebindableSyntax
422
   | Opt_ConstraintKinds
dreixel's avatar
dreixel committed
423
   | Opt_PolyKinds                -- Kind polymorphism
dreixel's avatar
dreixel committed
424
   | Opt_DataKinds                -- Datatype promotion
425 426
   | Opt_InstanceSigs
 
427 428 429 430 431
   | Opt_StandaloneDeriving
   | Opt_DeriveDataTypeable
   | Opt_DeriveFunctor
   | Opt_DeriveTraversable
   | Opt_DeriveFoldable
432
   | Opt_DeriveGeneric            -- Allow deriving Generic/1
dreixel's avatar
dreixel committed
433
   | Opt_DefaultSignatures        -- Allow extra signatures for defmeths
434 435 436 437 438 439 440 441 442 443 444 445 446 447 448

   | 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
449
   | Opt_MonadComprehensions
450 451 452 453 454 455 456 457 458 459 460
   | Opt_GeneralizedNewtypeDeriving
   | Opt_RecursiveDo
   | Opt_DoRec
   | Opt_PostfixOperators
   | Opt_TupleSections
   | Opt_PatternGuards
   | Opt_LiberalTypeSynonyms
   | Opt_Rank2Types
   | Opt_RankNTypes
   | Opt_ImpredicativeTypes
   | Opt_TypeOperators
461
   | Opt_ExplicitNamespaces
462 463 464 465 466
   | Opt_PackageImports
   | Opt_ExplicitForAll
   | Opt_AlternativeLayoutRule
   | Opt_AlternativeLayoutRuleTransitional
   | Opt_DatatypeContexts
467
   | Opt_NondecreasingIndentation
468
   | Opt_RelaxedLayout
469
   | Opt_TraditionalRecordSyntax
470
   deriving (Eq, Enum, Show)
471

472 473
-- | 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
474
data DynFlags = DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
475 476 477
  ghcMode               :: GhcMode,
  ghcLink               :: GhcLink,
  hscTarget             :: HscTarget,
478
  settings              :: Settings,
479
  hscOutName            :: String,      -- ^ Name of the output file
480
  extCoreName           :: String,      -- ^ Name of the .hcr output file
481
  verbosity             :: Int,         -- ^ Verbosity level: see Note [Verbosity levels]
482 483 484
  optLevel              :: Int,         -- ^ Optimisation level
  simplPhases           :: Int,         -- ^ Number of simplifier phases
  maxSimplIterations    :: Int,         -- ^ Max simplifier iterations
485
  shouldDumpSimplPhase  :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
486
  ruleCheck             :: Maybe String,
487
  strictnessBefore      :: [Int],       -- ^ Additional demand analysis
488

489
  simplTickFactor       :: Int,         -- ^ Multiplier for simplifier ticks
490 491 492
  specConstrThreshold   :: Maybe Int,   -- ^ Threshold for SpecConstr
  specConstrCount       :: Maybe Int,   -- ^ Max number of specialisations for any one function
  liberateCaseThreshold :: Maybe Int,   -- ^ Threshold for LiberateCase
493
  floatLamArgs          :: Maybe Int,   -- ^ Arg count for lambda floating
494
                                        --   See CoreMonad.FloatOutSwitches
495

496
  cmdlineHcIncludes     :: [String],    -- ^ @\-\#includes@
Ian Lynagh's avatar
Ian Lynagh committed
497 498 499
  importPaths           :: [FilePath],
  mainModIs             :: Module,
  mainFunIs             :: Maybe String,
500
  ctxtStkDepth          :: Int,         -- ^ Typechecker context stack depth
501

502
  thisPackage           :: PackageId,   -- ^ name of package currently being compiled
503 504

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

509 510 511
  -- For object splitting
  splitInfo             :: Maybe (String,Int),

512
  -- paths etc.
Ian Lynagh's avatar
Ian Lynagh committed
513
  objectDir             :: Maybe String,
514
  dylibInstallName      :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
515 516
  hiDir                 :: Maybe String,
  stubDir               :: Maybe String,
517
  dumpDir               :: Maybe String,
518

Ian Lynagh's avatar
Ian Lynagh committed
519 520 521
  objectSuf             :: String,
  hcSuf                 :: String,
  hiSuf                 :: String,
522

Ian Lynagh's avatar
Ian Lynagh committed
523 524 525
  outputFile            :: Maybe String,
  outputHi              :: Maybe String,
  dynLibLoader          :: DynLibLoader,
526

527
  -- | This is set by 'DriverPipeline.runPipeline' based on where
Ian Lynagh's avatar
Ian Lynagh committed
528 529
  --    its output is going.
  dumpPrefix            :: Maybe FilePath,
530

531 532
  -- | Override the 'dumpPrefix' set by 'DriverPipeline.runPipeline'.
  --    Set by @-ddump-file-prefix@
Ian Lynagh's avatar
Ian Lynagh committed
533 534 535 536 537 538 539
  dumpPrefixForce       :: Maybe FilePath,

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

540
  rtsOpts               :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
541
  rtsOptsEnabled        :: RtsOptsEnabled,
542

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

545 546 547 548
  -- Plugins
  pluginModNames        :: [ModuleName],
  pluginModNameOpts     :: [(ModuleName,String)],

549 550 551 552 553 554
  --  For ghc -M
  depMakefile           :: FilePath,
  depIncludePkgDeps     :: Bool,
  depExcludeMods        :: [ModuleName],
  depSuffixes           :: [String],

555
  --  Package flags
556
  extraPkgConfs         :: [PkgConfRef] -> [PkgConfRef],
557
        -- ^ The @-package-db@ flags given on the command line, in the order
Ian Lynagh's avatar
Ian Lynagh committed
558
        -- they appeared.
559

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

563
  -- Package state
Ian Lynagh's avatar
Ian Lynagh committed
564
  -- NB. do not modify this field, it is calculated by
565
  -- Packages.initPackages and Packages.updatePackages.
566
  pkgDatabase           :: Maybe [PackageConfig],
Ian Lynagh's avatar
Ian Lynagh committed
567
  pkgState              :: PackageState,
568

569 570 571 572
  -- Temporary files
  -- These have to be IORefs, because the defaultCleanupHandler needs to
  -- know what to clean when an exception happens
  filesToClean          :: IORef [FilePath],
573
  dirsToClean           :: IORef (Map FilePath FilePath),
574

575 576 577 578 579
  -- 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),

580
  -- hsc dynamic flags
581 582
  flags                 :: IntSet,
  warningFlags          :: IntSet,
583
  -- Don't change this without updating extensionFlags:
584
  language              :: Maybe Language,
585 586
  -- | Safe Haskell mode
  safeHaskell           :: SafeHaskellMode,
587 588 589
  -- 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.
590 591
  thOnLoc               :: SrcSpan,
  newDerivOnLoc         :: SrcSpan,
592
  pkgTrustOnLoc         :: SrcSpan,
593 594
  warnSafeOnLoc         :: SrcSpan,
  warnUnsafeOnLoc       :: SrcSpan,
595 596 597 598
  -- Don't change this without updating extensionFlags:
  extensions            :: [OnOff ExtensionFlag],
  -- extensionFlags should always be equal to
  --     flattenExtensionFlags language extensions
599
  extensionFlags        :: IntSet,
Ian Lynagh's avatar
Ian Lynagh committed
600

601
  -- | MsgDoc output action: use "ErrUtils" instead of this if you can
602
  log_action            :: LogAction,
603 604
  flushOut              :: FlushOut,
  flushErr              :: FlushErr,
David Waern's avatar
David Waern committed
605

606
  haddockOptions        :: Maybe String,
607
  ghciScripts           :: [String],
608 609

  -- | what kind of {-# SCC #-} to add automatically
610 611 612
  profAuto              :: ProfAuto,

  llvmVersion           :: IORef (Int)
613 614
 }

615 616 617
class HasDynFlags m where
    getDynFlags :: m DynFlags

Ian Lynagh's avatar
Ian Lynagh committed
618 619 620
class ContainsDynFlags t where
    extractDynFlags :: t -> DynFlags

621 622 623 624 625
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
626
  | ProfAutoCalls      -- ^ annotate call-sites
Simon Marlow's avatar
Simon Marlow committed
627
  deriving (Enum)
628

629
data Settings = Settings {
630
  sTargetPlatform        :: Platform,    -- Filled in by SysTools
631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652
  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
653 654 655 656 657 658 659 660 661 662 663 664
  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

665 666
 }

667 668 669
targetPlatform :: DynFlags -> Platform
targetPlatform dflags = sTargetPlatform (settings dflags)

670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709
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)
710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727
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)
728

729 730 731
wayNames :: DynFlags -> [WayName]
wayNames = map wayName . ways

732 733
-- | The target code type of the compilation (if any).
--
734 735 736
-- Whenever you change the target, also make sure to set 'ghcLink' to
-- something sensible.
--
737 738 739 740
-- 'HscNothing' can be used to avoid generating any output, however, note
-- that:
--
--  * This will not run the desugaring step, thus no warnings generated in
741 742 743
--    this step will be output.  In particular, this includes warnings related
--    to pattern matching.  You can run the desugarer manually using
--    'GHC.desugarModule'.
744
--
745 746 747 748
--  * 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
749
--    different target or avoid typechecking such modules.  (The latter may be
750
--    preferable for security reasons.)
751
--
752
data HscTarget
753 754
  = HscC           -- ^ Generate C code.
  | HscAsm         -- ^ Generate assembly using the native code generator.
755
  | HscLlvm        -- ^ Generate assembly using the llvm code generator.
756 757
  | HscInterpreted -- ^ Generate bytecode.  (Requires 'LinkInMemory')
  | HscNothing     -- ^ Don't generate any code.  See notes above.
758 759
  deriving (Eq, Show)

Ian Lynagh's avatar
Ian Lynagh committed
760 761 762 763 764 765 766
showHscTargetFlag :: HscTarget -> String
showHscTargetFlag HscC           = "-fvia-c"
showHscTargetFlag HscAsm         = "-fasm"
showHscTargetFlag HscLlvm        = "-fllvm"
showHscTargetFlag HscInterpreted = "-fbyte-code"
showHscTargetFlag HscNothing     = "-fno-code"

767
-- | Will this target result in an object file on the disk?
768 769 770
isObjectTarget :: HscTarget -> Bool
isObjectTarget HscC     = True
isObjectTarget HscAsm   = True
771
isObjectTarget HscLlvm  = True
772 773
isObjectTarget _        = False

774 775 776 777 778 779 780 781 782 783 784
-- | 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

785 786 787 788 789 790
-- | 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.
791
data GhcMode
792 793 794
  = CompManager         -- ^ @\-\-make@, GHCi, etc.
  | OneShot             -- ^ @ghc -c Foo.hs@
  | MkDepend            -- ^ @ghc -M@, see "Finder" for why we need this
795 796
  deriving Eq

797 798 799 800 801
instance Outputable GhcMode where
  ppr CompManager = ptext (sLit "CompManager")
  ppr OneShot     = ptext (sLit "OneShot")
  ppr MkDepend    = ptext (sLit "MkDepend")

802 803 804 805
isOneShot :: GhcMode -> Bool
isOneShot OneShot = True
isOneShot _other  = False

806 807 808 809
-- | 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
810 811
  | LinkInMemory        -- ^ Use the in-memory dynamic linker (works for both
                        --   bytecode and object code).
812
  | LinkDynLib          -- ^ Link objects into a dynamic lib (DLL on Windows, DSO on ELF platforms)
813
  deriving (Eq, Show)
814 815 816

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

819 820 821
-- Is it worth evaluating this Bool and caching it in the DynFlags value
-- during initDynFlags?
doingTickyProfiling :: DynFlags -> Bool
822 823 824
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.
825

826
data PackageFlag
827
  = ExposePackage   String
828
  | ExposePackageId String
829 830 831 832
  | HidePackage     String
  | IgnorePackage   String
  | TrustPackage    String
  | DistrustPackage String
833
  deriving Eq
834

twanvl's avatar
twanvl committed
835
defaultHscTarget :: HscTarget
836 837
defaultHscTarget = defaultObjectTarget

838
-- | The 'HscTarget' value corresponding to the default way to create
839
-- object files on the current platform.
twanvl's avatar
twanvl committed
840
defaultObjectTarget :: HscTarget
841
defaultObjectTarget
842
  | cGhcUnregisterised    == "YES"      =  HscC
Ian Lynagh's avatar
Ian Lynagh committed
843
  | cGhcWithNativeCodeGen == "YES"      =  HscAsm
844
  | otherwise                           =  HscLlvm
845

846 847 848 849 850
data DynLibLoader
  = Deployable
  | SystemDependent
  deriving Eq

Ian Lynagh's avatar
Ian Lynagh committed
851
data RtsOptsEnabled = RtsOptsNone | RtsOptsSafeOnly | RtsOptsAll
852
  deriving (Show)
Ian Lynagh's avatar
Ian Lynagh committed
853

854
-- | Used by 'GHC.newSession' to partially initialize a new 'DynFlags' value
twanvl's avatar
twanvl committed
855
initDynFlags :: DynFlags -> IO DynFlags
856 857 858
initDynFlags dflags = do
 -- someday these will be dynamic flags
 ways <- readIORef v_Ways
859
 refFilesToClean <- newIORef []
860
 refDirsToClean <- newIORef Map.empty
861
 refGeneratedDumps <- newIORef Set.empty
862
 refLlvmVersion <- newIORef 28
863
 return dflags{
864 865 866 867 868 869 870
        ways           = ways,
        buildTag       = mkBuildTag (filter (not . wayRTSOnly) ways),
        rtsBuildTag    = mkBuildTag ways,
        filesToClean   = refFilesToClean,
        dirsToClean    = refDirsToClean,
        generatedDumps = refGeneratedDumps,
        llvmVersion    = refLlvmVersion
Ian Lynagh's avatar
Ian Lynagh committed
871
        }
872

873 874
-- | The normal 'DynFlags'. Note that they is not suitable for use in this form
-- and must be fully initialized by 'GHC.newSession' first.
875 876
defaultDynFlags :: Settings -> DynFlags
defaultDynFlags mySettings =
877
     DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
878 879 880 881 882 883 884
        ghcMode                 = CompManager,
        ghcLink                 = LinkBinary,
        hscTarget               = defaultHscTarget,
        hscOutName              = "",
        extCoreName             = "",
        verbosity               = 0,
        optLevel                = 0,
885
        simplPhases             = 2,
Ian Lynagh's avatar
Ian Lynagh committed
886
        maxSimplIterations      = 4,
887
        shouldDumpSimplPhase    = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
888
        ruleCheck               = Nothing,
dterei's avatar
dterei committed
889
        simplTickFactor         = 100,
890
        specConstrThreshold     = Just 2000,
Ian Lynagh's avatar
Ian Lynagh committed
891
        specConstrCount         = Just 3,
892
        liberateCaseThreshold   = Just 2000,