DynFlags.hs 110 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(..),
20
        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(..),
Ian Lynagh's avatar
Ian Lynagh committed
41
        Option(..), showOpt,
Ian Lynagh's avatar
Ian Lynagh committed
42
        DynLibLoader(..),
43
        fFlags, fWarningFlags, fLangFlags, xFlags,
44
        wayNames, dynFlagDependencies,
45

46
        -- ** Safe Haskell
47
        SafeHaskellMode(..),
48
        safeHaskellOn, safeImportsOn, safeLanguageOn, safeInferOn,
49
        packageTrustOn,
50
        safeDirectImpsReq, safeImplicitImpsReq,
51
        unsafeFlags,
52

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


64
        -- ** Manipulating DynFlags
65
        defaultDynFlags,                -- Settings -> DynFlags
Ian Lynagh's avatar
Ian Lynagh committed
66
        initDynFlags,                   -- DynFlags -> IO DynFlags
67
        defaultLogAction,
68 69
        defaultFlushOut,
        defaultFlushErr,
Ian Lynagh's avatar
Ian Lynagh committed
70

71
        getOpts,                        -- DynFlags -> (DynFlags -> [a]) -> [a]
72
        getVerbFlags,
Ian Lynagh's avatar
Ian Lynagh committed
73 74 75
        updOptLevel,
        setTmpDir,
        setPackageName,
76
        doingTickyProfiling,
Ian Lynagh's avatar
Ian Lynagh committed
77

78
        -- ** Parsing DynFlags
79 80
        parseDynamicFlagsCmdLine,
        parseDynamicFilePragma,
81
        allFlags,
82

83
        supportedLanguagesAndExtensions,
84 85

        -- ** DynFlag C compiler options
86
        picCCOpts,
87 88 89 90 91 92

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

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

#include "HsVersions.h"

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

Ian Lynagh's avatar
Ian Lynagh committed
124
#ifdef GHCI
125
import System.IO.Unsafe ( unsafePerformIO )
Ian Lynagh's avatar
Ian Lynagh committed
126
#endif
127
import Data.IORef
Ian Lynagh's avatar
Ian Lynagh committed
128
import Control.Monad    ( when )
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
129

130
import Data.Char
131
import Data.List
132 133
import Data.Map (Map)
import qualified Data.Map as Map
134 135
import Data.Set (Set)
import qualified Data.Set as Set
Ian Lynagh's avatar
Ian Lynagh committed
136
import System.FilePath
137
import System.IO
138

139 140 141
import Data.IntSet (IntSet)
import qualified Data.IntSet as IntSet

142 143 144
-- -----------------------------------------------------------------------------
-- DynFlags

145
-- | Enumerates the simple on-or-off dynamic flags
146 147 148 149
data DynFlag

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

Ian Lynagh's avatar
Ian Lynagh committed
235
   | Opt_WarnIsError                    -- -Werror; makes warnings fatal
236

237 238
   | Opt_PrintExplicitForalls

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

263 264 265 266 267
   -- Interface files
   | Opt_IgnoreInterfacePragmas
   | Opt_OmitInterfacePragmas
   | Opt_ExposeAllUnfoldings

Ian Lynagh's avatar
Ian Lynagh committed
268 269
   -- profiling opts
   | Opt_AutoSccsOnIndividualCafs
270
   | Opt_ProfCountEntries
Ian Lynagh's avatar
Ian Lynagh committed
271

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

302
   -- temporary flags
303
   | Opt_RunCPS
304
   | Opt_RunCPSZ
305
   | Opt_AutoLinkPackages
306
   | Opt_ImplicitImportQualified
307
   | Opt_TryNewCodeGen
308 309 310 311 312 313

   -- keeping stuff
   | Opt_KeepHiDiffs
   | Opt_KeepHcFiles
   | Opt_KeepSFiles
   | Opt_KeepTmpFiles
Jedai's avatar
Jedai committed
314
   | Opt_KeepRawTokenStream
315
   | Opt_KeepLlvmFiles
316

317
   -- safe haskell flags
dterei's avatar
dterei committed
318
   | Opt_DistrustAllPackages
319 320
   | Opt_PackageTrust

321
   deriving (Eq, Show, Enum)
Ian Lynagh's avatar
Ian Lynagh committed
322

323 324 325 326 327 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
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
356 357
   | Opt_WarnUnsafe
   | Opt_WarnSafe
Ian Lynagh's avatar
Ian Lynagh committed
358
   | Opt_WarnPointlessPragmas
359
   deriving (Eq, Show, Enum)
360

361
data Language = Haskell98 | Haskell2010
362
   deriving Enum
363

364
-- | The various Safe Haskell modes
365 366
data SafeHaskellMode
   = Sf_None
dterei's avatar
dterei committed
367
   | Sf_Unsafe
368 369
   | Sf_Trustworthy
   | Sf_Safe
dterei's avatar
dterei committed
370
   | Sf_SafeInfered
371 372
   deriving (Eq)

373
instance Outputable SafeHaskellMode where
dterei's avatar
dterei committed
374 375
    ppr Sf_None        = ptext $ sLit "None"
    ppr Sf_Unsafe      = ptext $ sLit "Unsafe"
376
    ppr Sf_Trustworthy = ptext $ sLit "Trustworthy"
dterei's avatar
dterei committed
377 378
    ppr Sf_Safe        = ptext $ sLit "Safe"
    ppr Sf_SafeInfered = ptext $ sLit "Safe-Infered"
379

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

   | 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
442
   | Opt_MonadComprehensions
443 444 445 446 447 448 449 450 451 452 453
   | Opt_GeneralizedNewtypeDeriving
   | Opt_RecursiveDo
   | Opt_DoRec
   | Opt_PostfixOperators
   | Opt_TupleSections
   | Opt_PatternGuards
   | Opt_LiberalTypeSynonyms
   | Opt_Rank2Types
   | Opt_RankNTypes
   | Opt_ImpredicativeTypes
   | Opt_TypeOperators
454
   | Opt_ExplicitNamespaces
455 456 457 458 459
   | Opt_PackageImports
   | Opt_ExplicitForAll
   | Opt_AlternativeLayoutRule
   | Opt_AlternativeLayoutRuleTransitional
   | Opt_DatatypeContexts
460
   | Opt_NondecreasingIndentation
461
   | Opt_RelaxedLayout
462
   | Opt_TraditionalRecordSyntax
463
   deriving (Eq, Enum, Show)
464

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

482
  simplTickFactor       :: Int,         -- ^ Multiplier for simplifier ticks
483 484 485
  specConstrThreshold   :: Maybe Int,   -- ^ Threshold for SpecConstr
  specConstrCount       :: Maybe Int,   -- ^ Max number of specialisations for any one function
  liberateCaseThreshold :: Maybe Int,   -- ^ Threshold for LiberateCase
486
  floatLamArgs          :: Maybe Int,   -- ^ Arg count for lambda floating
487
                                        --   See CoreMonad.FloatOutSwitches
488

489
  cmdlineHcIncludes     :: [String],    -- ^ @\-\#includes@
Ian Lynagh's avatar
Ian Lynagh committed
490 491 492
  importPaths           :: [FilePath],
  mainModIs             :: Module,
  mainFunIs             :: Maybe String,
493
  ctxtStkDepth          :: Int,         -- ^ Typechecker context stack depth
494

495
  thisPackage           :: PackageId,   -- ^ name of package currently being compiled
496 497

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

502 503 504
  -- For object splitting
  splitInfo             :: Maybe (String,Int),

505
  -- paths etc.
Ian Lynagh's avatar
Ian Lynagh committed
506
  objectDir             :: Maybe String,
507
  dylibInstallName      :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
508 509
  hiDir                 :: Maybe String,
  stubDir               :: Maybe String,
510
  dumpDir               :: Maybe String,
511

Ian Lynagh's avatar
Ian Lynagh committed
512 513 514
  objectSuf             :: String,
  hcSuf                 :: String,
  hiSuf                 :: String,
515

Ian Lynagh's avatar
Ian Lynagh committed
516 517 518
  outputFile            :: Maybe String,
  outputHi              :: Maybe String,
  dynLibLoader          :: DynLibLoader,
519

520
  -- | This is set by 'DriverPipeline.runPipeline' based on where
Ian Lynagh's avatar
Ian Lynagh committed
521 522
  --    its output is going.
  dumpPrefix            :: Maybe FilePath,
523

524 525
  -- | Override the 'dumpPrefix' set by 'DriverPipeline.runPipeline'.
  --    Set by @-ddump-file-prefix@
Ian Lynagh's avatar
Ian Lynagh committed
526 527 528 529 530 531 532
  dumpPrefixForce       :: Maybe FilePath,

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

533
  rtsOpts               :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
534
  rtsOptsEnabled        :: RtsOptsEnabled,
535

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

538 539 540 541
  -- Plugins
  pluginModNames        :: [ModuleName],
  pluginModNameOpts     :: [(ModuleName,String)],

542 543 544 545 546 547
  --  For ghc -M
  depMakefile           :: FilePath,
  depIncludePkgDeps     :: Bool,
  depExcludeMods        :: [ModuleName],
  depSuffixes           :: [String],

548
  --  Package flags
Ian Lynagh's avatar
Ian Lynagh committed
549
  extraPkgConfs         :: [FilePath],
550
        -- ^ The @-package-conf@ flags given on the command line, in the order
Ian Lynagh's avatar
Ian Lynagh committed
551
        -- they appeared.
552

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

556
  -- Package state
Ian Lynagh's avatar
Ian Lynagh committed
557
  -- NB. do not modify this field, it is calculated by
558
  -- Packages.initPackages and Packages.updatePackages.
559
  pkgDatabase           :: Maybe [PackageConfig],
Ian Lynagh's avatar
Ian Lynagh committed
560
  pkgState              :: PackageState,
561

562 563 564 565
  -- Temporary files
  -- These have to be IORefs, because the defaultCleanupHandler needs to
  -- know what to clean when an exception happens
  filesToClean          :: IORef [FilePath],
566
  dirsToClean           :: IORef (Map FilePath FilePath),
567

568 569 570 571 572
  -- 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),

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

594
  -- | MsgDoc output action: use "ErrUtils" instead of this if you can
595
  log_action            :: LogAction,
596 597
  flushOut              :: FlushOut,
  flushErr              :: FlushErr,
David Waern's avatar
David Waern committed
598

599 600 601
  haddockOptions        :: Maybe String,

  -- | what kind of {-# SCC #-} to add automatically
602 603 604
  profAuto              :: ProfAuto,

  llvmVersion           :: IORef (Int)
605 606
 }

607 608 609
class HasDynFlags m where
    getDynFlags :: m DynFlags

Ian Lynagh's avatar
Ian Lynagh committed
610 611 612
class ContainsDynFlags t where
    extractDynFlags :: t -> DynFlags

613 614 615 616 617
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
618
  | ProfAutoCalls      -- ^ annotate call-sites
Simon Marlow's avatar
Simon Marlow committed
619
  deriving (Enum)
620

621
data Settings = Settings {
622
  sTargetPlatform        :: Platform,    -- Filled in by SysTools
623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644
  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
645 646 647 648 649 650 651 652 653 654 655 656
  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

657 658
 }

659 660 661
targetPlatform :: DynFlags -> Platform
targetPlatform dflags = sTargetPlatform (settings dflags)

662 663 664 665 666 667 668 669 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
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)
702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719
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)
720

721 722 723
wayNames :: DynFlags -> [WayName]
wayNames = map wayName . ways

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

Ian Lynagh's avatar
Ian Lynagh committed
752 753 754 755 756 757 758
showHscTargetFlag :: HscTarget -> String
showHscTargetFlag HscC           = "-fvia-c"
showHscTargetFlag HscAsm         = "-fasm"
showHscTargetFlag HscLlvm        = "-fllvm"
showHscTargetFlag HscInterpreted = "-fbyte-code"
showHscTargetFlag HscNothing     = "-fno-code"

759
-- | Will this target result in an object file on the disk?
760 761 762
isObjectTarget :: HscTarget -> Bool
isObjectTarget HscC     = True
isObjectTarget HscAsm   = True
763
isObjectTarget HscLlvm  = True
764 765
isObjectTarget _        = False

766 767 768 769 770 771 772 773 774 775 776
-- | 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

777 778 779 780 781 782
-- | 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.
783
data GhcMode
784 785 786
  = CompManager         -- ^ @\-\-make@, GHCi, etc.
  | OneShot             -- ^ @ghc -c Foo.hs@
  | MkDepend            -- ^ @ghc -M@, see "Finder" for why we need this
787 788
  deriving Eq

789 790 791 792 793
instance Outputable GhcMode where
  ppr CompManager = ptext (sLit "CompManager")
  ppr OneShot     = ptext (sLit "OneShot")
  ppr MkDepend    = ptext (sLit "MkDepend")

794 795 796 797
isOneShot :: GhcMode -> Bool
isOneShot OneShot = True
isOneShot _other  = False

798 799 800 801
-- | 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
802 803
  | LinkInMemory        -- ^ Use the in-memory dynamic linker (works for both
                        --   bytecode and object code).
804
  | LinkDynLib          -- ^ Link objects into a dynamic lib (DLL on Windows, DSO on ELF platforms)
805
  deriving (Eq, Show)
806 807 808

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

811 812 813
-- Is it worth evaluating this Bool and caching it in the DynFlags value
-- during initDynFlags?
doingTickyProfiling :: DynFlags -> Bool
814 815 816
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.
817

818
data PackageFlag
819
  = ExposePackage   String
820
  | ExposePackageId String
821 822 823 824
  | HidePackage     String
  | IgnorePackage   String
  | TrustPackage    String
  | DistrustPackage String
825
  deriving Eq
826

twanvl's avatar
twanvl committed
827
defaultHscTarget :: HscTarget
828 829
defaultHscTarget = defaultObjectTarget

830
-- | The 'HscTarget' value corresponding to the default way to create
831
-- object files on the current platform.
twanvl's avatar
twanvl committed
832
defaultObjectTarget :: HscTarget
833
defaultObjectTarget
834
  | cGhcUnregisterised    == "YES"      =  HscC
Ian Lynagh's avatar
Ian Lynagh committed
835
  | cGhcWithNativeCodeGen == "YES"      =  HscAsm
836
  | otherwise                           =  HscLlvm
837

838 839 840 841 842
data DynLibLoader
  = Deployable
  | SystemDependent
  deriving Eq

Ian Lynagh's avatar
Ian Lynagh committed
843
data RtsOptsEnabled = RtsOptsNone | RtsOptsSafeOnly | RtsOptsAll
844
  deriving (Show)
Ian Lynagh's avatar
Ian Lynagh committed
845

846
-- | Used by 'GHC.newSession' to partially initialize a new 'DynFlags' value
twanvl's avatar
twanvl committed
847
initDynFlags :: DynFlags -> IO DynFlags
848 849 850
initDynFlags dflags = do
 -- someday these will be dynamic flags
 ways <- readIORef v_Ways
851
 refFilesToClean <- newIORef []
852
 refDirsToClean <- newIORef Map.empty
853
 refGeneratedDumps <- newIORef Set.empty
854
 refLlvmVersion <- newIORef 28
855
 return dflags{
856 857 858 859 860 861 862
        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
863
        }
864

865 866
-- | The normal 'DynFlags'. Note that they is not suitable for use in this form
-- and must be fully initialized by 'GHC.newSession' first.
867 868
defaultDynFlags :: Settings -> DynFlags
defaultDynFlags mySettings =
869
     DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
870 871 872 873 874 875 876
        ghcMode                 = CompManager,
        ghcLink                 = LinkBinary,
        hscTarget               = defaultHscTarget,
        hscOutName              = "",
        extCoreName             = "",
        verbosity               = 0,
        optLevel                = 0,
877
        simplPhases             = 2,
Ian Lynagh's avatar
Ian Lynagh committed
878
        maxSimplIterations      = 4,
879
        shouldDumpSimplPhase    = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
880
        ruleCheck               = Nothing,
dterei's avatar
dterei committed
881
        simplTickFactor         = 100,
882
        specConstrThreshold     = Just 2000,
Ian Lynagh's avatar
Ian Lynagh committed
883
        specConstrCount         = Just 3,
884
        liberateCaseThreshold   = Just 2000,
885
        floatLamArgs            = Just 0, -- Default: float only if no fvs
886 887
        strictnessBefore        = [],

Ian Lynagh's avatar
Ian Lynagh committed
888 889 890 891 892 893 894 895 896
        cmdlineHcIncludes       = [],
        importPaths             = ["."],
        mainModIs               = mAIN,
        mainFunIs               = Nothing,
        ctxtStkDepth            = mAX_CONTEXT_REDUCTION_DEPTH,

        thisPackage             = mainPackageId,

        objectDir               = Nothing,
897
        dylibInstallName        = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
898 899
        hiDir                   = Nothing,
        stubDir                 = Nothing,
900
        dumpDir                 = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
901 902 903 904