DynFlags.hs 105 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
        LogAction,
20
        ProfAuto(..),
21
        glasgowExtsFlags,
22 23 24
        dopt,
        dopt_set,
        dopt_unset,
25 26 27
        wopt,
        wopt_set,
        wopt_unset,
28 29 30
        xopt,
        xopt_set,
        xopt_unset,
Ian Lynagh's avatar
Ian Lynagh committed
31
        DynFlags(..),
Ian Lynagh's avatar
Ian Lynagh committed
32
        RtsOptsEnabled(..),
Ian Lynagh's avatar
Ian Lynagh committed
33 34 35 36
        HscTarget(..), isObjectTarget, defaultObjectTarget,
        GhcMode(..), isOneShot,
        GhcLink(..), isNoLink,
        PackageFlag(..),
Ian Lynagh's avatar
Ian Lynagh committed
37
        Option(..), showOpt,
Ian Lynagh's avatar
Ian Lynagh committed
38
        DynLibLoader(..),
39
        fFlags, fWarningFlags, fLangFlags, xFlags,
40
        wayNames, dynFlagDependencies,
41

42
        -- ** Safe Haskell
43
        SafeHaskellMode(..),
44
        safeHaskellOn, safeImportsOn, safeLanguageOn, safeInferOn,
45
        packageTrustOn,
46
        safeDirectImpsReq, safeImplicitImpsReq,
47

48
        -- ** System tool settings and locations
49
        Settings(..),
50
        targetPlatform,
51 52 53 54
        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
55
        opt_L, opt_P, opt_F, opt_c, opt_a, opt_l,
56
        opt_windres, opt_lo, opt_lc,
57 58


59
        -- ** Manipulating DynFlags
60
        defaultDynFlags,                -- Settings -> DynFlags
Ian Lynagh's avatar
Ian Lynagh committed
61
        initDynFlags,                   -- DynFlags -> IO DynFlags
62
        defaultLogAction,
Ian Lynagh's avatar
Ian Lynagh committed
63

64
        getOpts,                        -- DynFlags -> (DynFlags -> [a]) -> [a]
65
        getVerbFlags,
Ian Lynagh's avatar
Ian Lynagh committed
66 67 68
        updOptLevel,
        setTmpDir,
        setPackageName,
69
        doingTickyProfiling,
Ian Lynagh's avatar
Ian Lynagh committed
70

71
        -- ** Parsing DynFlags
72 73
        parseDynamicFlagsCmdLine,
        parseDynamicFilePragma,
74
        allFlags,
75

76
        supportedLanguagesAndExtensions,
77 78

        -- ** DynFlag C compiler options
79
        picCCOpts,
80 81 82 83 84 85

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

        -- * Compiler configuration suitable for display to the user
86 87
        compilerInfo
#ifdef GHCI
dterei's avatar
dterei committed
88
-- Only in stage 2 can we be sure that the RTS
89
-- exposes the appropriate runtime boolean
dterei's avatar
dterei committed
90
      , rtsIsProfiled
91
#endif
92 93 94 95
  ) where

#include "HsVersions.h"

96
import Platform
97
import Module
Simon Marlow's avatar
Simon Marlow committed
98
import PackageConfig
99
import PrelNames        ( mAIN )
100
import StaticFlags
101
import {-# SOURCE #-} Packages (PackageState)
Ian Lynagh's avatar
Ian Lynagh committed
102
import DriverPhases     ( Phase(..), phaseInputExt )
103 104
import Config
import CmdLineParser
Ian Lynagh's avatar
Ian Lynagh committed
105
import Constants        ( mAX_CONTEXT_REDUCTION_DEPTH )
106
import Panic
107
import Util
108
import Maybes           ( orElse )
109
import SrcLoc
110
import FastString
Simon Marlow's avatar
Simon Marlow committed
111
import Outputable
Ian Lynagh's avatar
Ian Lynagh committed
112
#ifdef GHCI
Ian Lynagh's avatar
Ian Lynagh committed
113
import Foreign.C        ( CInt(..) )
Ian Lynagh's avatar
Ian Lynagh committed
114
#endif
Simon Marlow's avatar
Simon Marlow committed
115
import {-# SOURCE #-} ErrUtils ( Severity(..), Message, mkLocMessage )
116

Ian Lynagh's avatar
Ian Lynagh committed
117
#ifdef GHCI
118
import System.IO.Unsafe ( unsafePerformIO )
Ian Lynagh's avatar
Ian Lynagh committed
119
#endif
120
import Data.IORef
Ian Lynagh's avatar
Ian Lynagh committed
121
import Control.Monad    ( when )
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
122

123
import Data.Char
124
import Data.List
125 126
import Data.Map (Map)
import qualified Data.Map as Map
127 128
import Data.Set (Set)
import qualified Data.Set as Set
Ian Lynagh's avatar
Ian Lynagh committed
129
import System.FilePath
130
import System.IO        ( stderr, hPutChar )
131

132 133 134
-- -----------------------------------------------------------------------------
-- DynFlags

135
-- | Enumerates the simple on-or-off dynamic flags
136 137 138 139
data DynFlag

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

Ian Lynagh's avatar
Ian Lynagh committed
224
   | Opt_WarnIsError                    -- -Werror; makes warnings fatal
225

226 227
   | Opt_PrintExplicitForalls

228 229 230
   -- optimisation opts
   | Opt_Strictness
   | Opt_FullLaziness
231 232
   | Opt_FloatIn
   | Opt_Specialise
233
   | Opt_StaticArgumentTransformation
234
   | Opt_CSE
235 236
   | Opt_LiberateCase
   | Opt_SpecConstr
237 238 239 240 241
   | Opt_DoLambdaEtaExpansion
   | Opt_IgnoreAsserts
   | Opt_DoEtaReduction
   | Opt_CaseMerge
   | Opt_UnboxStrictFields
242
   | Opt_DictsCheap
243
   | Opt_EnableRewriteRules             -- Apply rewrite rules during simplification
rl@cse.unsw.edu.au's avatar
rl@cse.unsw.edu.au committed
244
   | Opt_Vectorise
Ian Lynagh's avatar
Ian Lynagh committed
245 246
   | Opt_RegsGraph                      -- do graph coloring register allocation
   | Opt_RegsIterative                  -- do iterative coalescing graph coloring register allocation
247

248 249 250 251 252
   -- Interface files
   | Opt_IgnoreInterfacePragmas
   | Opt_OmitInterfacePragmas
   | Opt_ExposeAllUnfoldings

Ian Lynagh's avatar
Ian Lynagh committed
253 254
   -- profiling opts
   | Opt_AutoSccsOnIndividualCafs
255
   | Opt_ProfCountEntries
Ian Lynagh's avatar
Ian Lynagh committed
256

257 258
   -- misc opts
   | Opt_Pp
259
   | Opt_ForceRecomp
260
   | Opt_ExcessPrecision
261
   | Opt_EagerBlackHoling
262 263 264 265
   | Opt_ReadUserPackageConf
   | Opt_NoHsMain
   | Opt_SplitObjs
   | Opt_StgStats
266
   | Opt_HideAllPackages
267
   | Opt_DistrustAllPackages
268
   | Opt_PrintBindResult
269
   | Opt_Haddock
David Waern's avatar
David Waern committed
270
   | Opt_HaddockOptions
271
   | Opt_Hpc_No_Auto
272
   | Opt_BreakOnException
273
   | Opt_BreakOnError
274
   | Opt_PrintEvldWithShow
275
   | Opt_PrintBindContents
276 277
   | Opt_GenManifest
   | Opt_EmbedManifest
278
   | Opt_EmitExternalCore
Ian Lynagh's avatar
Ian Lynagh committed
279
   | Opt_SharedImplib
280
   | Opt_BuildingCabalPackage
281
   | Opt_SSE2
tibbe's avatar
tibbe committed
282
   | Opt_SSE4_2
283
   | Opt_GhciSandbox
Ian Lynagh's avatar
Ian Lynagh committed
284
   | Opt_GhciHistory
285
   | Opt_HelpfulErrors
286

287
   -- temporary flags
288
   | Opt_RunCPS
289
   | Opt_RunCPSZ
290
   | Opt_AutoLinkPackages
291
   | Opt_ImplicitImportQualified
292
   | Opt_TryNewCodeGen
293 294 295 296 297 298

   -- keeping stuff
   | Opt_KeepHiDiffs
   | Opt_KeepHcFiles
   | Opt_KeepSFiles
   | Opt_KeepTmpFiles
Jedai's avatar
Jedai committed
299
   | Opt_KeepRawTokenStream
300
   | Opt_KeepLlvmFiles
301

302 303 304
   -- safe haskell flags
   | Opt_PackageTrust

305
   deriving (Eq, Show)
Ian Lynagh's avatar
Ian Lynagh committed
306

307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341
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
   deriving (Eq, Show)

342
data Language = Haskell98 | Haskell2010
343
   deriving Enum
344

345
-- | The various Safe Haskell modes
346 347
data SafeHaskellMode
   = Sf_None
dterei's avatar
dterei committed
348
   | Sf_Unsafe
349 350
   | Sf_Trustworthy
   | Sf_Safe
dterei's avatar
dterei committed
351
   | Sf_SafeInfered
352 353
   deriving (Eq)

354
instance Outputable SafeHaskellMode where
dterei's avatar
dterei committed
355 356
    ppr Sf_None        = ptext $ sLit "None"
    ppr Sf_Unsafe      = ptext $ sLit "Unsafe"
357
    ppr Sf_Trustworthy = ptext $ sLit "Trustworthy"
dterei's avatar
dterei committed
358 359
    ppr Sf_Safe        = ptext $ sLit "Safe"
    ppr Sf_SafeInfered = ptext $ sLit "Safe-Infered"
360

361
data ExtensionFlag
362 363 364 365 366 367 368
   = Opt_Cpp
   | Opt_OverlappingInstances
   | Opt_UndecidableInstances
   | Opt_IncoherentInstances
   | Opt_MonomorphismRestriction
   | Opt_MonoPatBinds
   | Opt_MonoLocalBinds
369 370
   | Opt_RelaxedPolyRec           -- Deprecated
   | Opt_ExtendedDefaultRules     -- Use GHC's extended rules for defaulting
371 372
   | Opt_ForeignFunctionInterface
   | Opt_UnliftedFFITypes
373
   | Opt_InterruptibleFFI
374
   | Opt_GHCForeignImportPrim
375 376
   | Opt_ParallelArrays           -- Syntactic support for parallel arrays
   | Opt_Arrows                   -- Arrow-notation syntax
377 378 379 380 381 382 383 384 385 386 387 388 389 390
   | 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
391
   | Opt_GADTSyntax
392
   | Opt_NPlusKPatterns
Ian Lynagh's avatar
Ian Lynagh committed
393
   | Opt_DoAndIfThenElse
394
   | Opt_RebindableSyntax
395
   | Opt_ConstraintKinds
dterei's avatar
dterei committed
396

397 398 399 400 401
   | Opt_StandaloneDeriving
   | Opt_DeriveDataTypeable
   | Opt_DeriveFunctor
   | Opt_DeriveTraversable
   | Opt_DeriveFoldable
402
   | Opt_DeriveGeneric            -- Allow deriving Generic/1
dreixel's avatar
dreixel committed
403
   | Opt_DefaultSignatures        -- Allow extra signatures for defmeths
404 405 406 407 408 409 410 411 412 413 414 415 416 417 418

   | 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
419
   | Opt_MonadComprehensions
420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435
   | Opt_GeneralizedNewtypeDeriving
   | Opt_RecursiveDo
   | Opt_DoRec
   | Opt_PostfixOperators
   | Opt_TupleSections
   | Opt_PatternGuards
   | Opt_LiberalTypeSynonyms
   | Opt_Rank2Types
   | Opt_RankNTypes
   | Opt_ImpredicativeTypes
   | Opt_TypeOperators
   | Opt_PackageImports
   | Opt_ExplicitForAll
   | Opt_AlternativeLayoutRule
   | Opt_AlternativeLayoutRuleTransitional
   | Opt_DatatypeContexts
436
   | Opt_NondecreasingIndentation
437
   | Opt_RelaxedLayout
438
   | Opt_TraditionalRecordSyntax
439
   deriving (Eq, Enum, Show)
440

441 442
-- | 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
443
data DynFlags = DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
444 445 446
  ghcMode               :: GhcMode,
  ghcLink               :: GhcLink,
  hscTarget             :: HscTarget,
447
  hscOutName            :: String,      -- ^ Name of the output file
448
  extCoreName           :: String,      -- ^ Name of the .hcr output file
449
  verbosity             :: Int,         -- ^ Verbosity level: see Note [Verbosity levels]
450 451 452
  optLevel              :: Int,         -- ^ Optimisation level
  simplPhases           :: Int,         -- ^ Number of simplifier phases
  maxSimplIterations    :: Int,         -- ^ Max simplifier iterations
453
  shouldDumpSimplPhase  :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
454
  ruleCheck             :: Maybe String,
455
  strictnessBefore      :: [Int],       -- ^ Additional demand analysis
456

457
  simplTickFactor       :: Int,         -- ^ Multiplier for simplifier ticks
458 459 460
  specConstrThreshold   :: Maybe Int,   -- ^ Threshold for SpecConstr
  specConstrCount       :: Maybe Int,   -- ^ Max number of specialisations for any one function
  liberateCaseThreshold :: Maybe Int,   -- ^ Threshold for LiberateCase
461
  floatLamArgs          :: Maybe Int,   -- ^ Arg count for lambda floating
462
                                        --   See CoreMonad.FloatOutSwitches
463

464
  cmdlineHcIncludes     :: [String],    -- ^ @\-\#includes@
Ian Lynagh's avatar
Ian Lynagh committed
465 466 467
  importPaths           :: [FilePath],
  mainModIs             :: Module,
  mainFunIs             :: Maybe String,
468
  ctxtStkDepth          :: Int,         -- ^ Typechecker context stack depth
469

470
  thisPackage           :: PackageId,   -- ^ name of package currently being compiled
471 472

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

477 478 479
  -- For object splitting
  splitInfo             :: Maybe (String,Int),

480
  -- paths etc.
Ian Lynagh's avatar
Ian Lynagh committed
481
  objectDir             :: Maybe String,
482
  dylibInstallName      :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
483 484
  hiDir                 :: Maybe String,
  stubDir               :: Maybe String,
485

Ian Lynagh's avatar
Ian Lynagh committed
486 487 488
  objectSuf             :: String,
  hcSuf                 :: String,
  hiSuf                 :: String,
489

Ian Lynagh's avatar
Ian Lynagh committed
490 491 492
  outputFile            :: Maybe String,
  outputHi              :: Maybe String,
  dynLibLoader          :: DynLibLoader,
493

494
  -- | This is set by 'DriverPipeline.runPipeline' based on where
Ian Lynagh's avatar
Ian Lynagh committed
495 496
  --    its output is going.
  dumpPrefix            :: Maybe FilePath,
497

498 499
  -- | Override the 'dumpPrefix' set by 'DriverPipeline.runPipeline'.
  --    Set by @-ddump-file-prefix@
Ian Lynagh's avatar
Ian Lynagh committed
500 501 502 503 504 505 506
  dumpPrefixForce       :: Maybe FilePath,

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

507
  rtsOpts               :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
508
  rtsOptsEnabled        :: RtsOptsEnabled,
509

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

512 513 514 515
  -- Plugins
  pluginModNames        :: [ModuleName],
  pluginModNameOpts     :: [(ModuleName,String)],

516
  settings              :: Settings,
517

518 519 520 521 522 523
  --  For ghc -M
  depMakefile           :: FilePath,
  depIncludePkgDeps     :: Bool,
  depExcludeMods        :: [ModuleName],
  depSuffixes           :: [String],

524
  --  Package flags
Ian Lynagh's avatar
Ian Lynagh committed
525
  extraPkgConfs         :: [FilePath],
526
        -- ^ The @-package-conf@ flags given on the command line, in the order
Ian Lynagh's avatar
Ian Lynagh committed
527
        -- they appeared.
528

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

532
  -- Package state
Ian Lynagh's avatar
Ian Lynagh committed
533
  -- NB. do not modify this field, it is calculated by
534
  -- Packages.initPackages and Packages.updatePackages.
535
  pkgDatabase           :: Maybe [PackageConfig],
Ian Lynagh's avatar
Ian Lynagh committed
536
  pkgState              :: PackageState,
537

538 539 540 541
  -- Temporary files
  -- These have to be IORefs, because the defaultCleanupHandler needs to
  -- know what to clean when an exception happens
  filesToClean          :: IORef [FilePath],
542
  dirsToClean           :: IORef (Map FilePath FilePath),
543

544 545 546 547 548
  -- 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),

549
  -- hsc dynamic flags
Ian Lynagh's avatar
Ian Lynagh committed
550
  flags                 :: [DynFlag],
551
  warningFlags          :: [WarningFlag],
552
  -- Don't change this without updating extensionFlags:
553
  language              :: Maybe Language,
554 555
  -- | Safe Haskell mode
  safeHaskell           :: SafeHaskellMode,
556 557 558 559 560
  -- We store the location of where template haskell and newtype deriving were
  -- turned on so we can produce accurate error messages when Safe Haskell turns
  -- them off.
  thOnLoc               :: SrcSpan,
  newDerivOnLoc         :: SrcSpan,
561 562 563 564 565
  -- Don't change this without updating extensionFlags:
  extensions            :: [OnOff ExtensionFlag],
  -- extensionFlags should always be equal to
  --     flattenExtensionFlags language extensions
  extensionFlags        :: [ExtensionFlag],
Ian Lynagh's avatar
Ian Lynagh committed
566

567
  -- | Message output action: use "ErrUtils" instead of this if you can
568
  log_action            :: LogAction,
David Waern's avatar
David Waern committed
569

570 571 572 573
  haddockOptions        :: Maybe String,

  -- | what kind of {-# SCC #-} to add automatically
  profAuto              :: ProfAuto
574 575
 }

576 577 578 579 580 581
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

582
data Settings = Settings {
583
  sTargetPlatform        :: Platform,    -- Filled in by SysTools
584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605
  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
606 607 608 609 610 611 612 613 614 615 616 617
  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

618 619
 }

620 621 622
targetPlatform :: DynFlags -> Platform
targetPlatform dflags = sTargetPlatform (settings dflags)

623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662
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)
663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680
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)
681

682 683 684
wayNames :: DynFlags -> [WayName]
wayNames = map wayName . ways

685 686
-- | The target code type of the compilation (if any).
--
687 688 689
-- Whenever you change the target, also make sure to set 'ghcLink' to
-- something sensible.
--
690 691 692 693
-- 'HscNothing' can be used to avoid generating any output, however, note
-- that:
--
--  * This will not run the desugaring step, thus no warnings generated in
694 695 696
--    this step will be output.  In particular, this includes warnings related
--    to pattern matching.  You can run the desugarer manually using
--    'GHC.desugarModule'.
697
--
698 699 700 701 702 703
--  * 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
--    different target or avoid typechecking such modules.  (The latter may
--    preferable for security reasons.)
704
--
705
data HscTarget
706 707
  = HscC           -- ^ Generate C code.
  | HscAsm         -- ^ Generate assembly using the native code generator.
708
  | HscLlvm        -- ^ Generate assembly using the llvm code generator.
709 710
  | HscInterpreted -- ^ Generate bytecode.  (Requires 'LinkInMemory')
  | HscNothing     -- ^ Don't generate any code.  See notes above.
711 712
  deriving (Eq, Show)

Ian Lynagh's avatar
Ian Lynagh committed
713 714 715 716 717 718 719
showHscTargetFlag :: HscTarget -> String
showHscTargetFlag HscC           = "-fvia-c"
showHscTargetFlag HscAsm         = "-fasm"
showHscTargetFlag HscLlvm        = "-fllvm"
showHscTargetFlag HscInterpreted = "-fbyte-code"
showHscTargetFlag HscNothing     = "-fno-code"

720
-- | Will this target result in an object file on the disk?
721 722 723
isObjectTarget :: HscTarget -> Bool
isObjectTarget HscC     = True
isObjectTarget HscAsm   = True
724
isObjectTarget HscLlvm  = True
725 726 727 728 729 730 731 732
isObjectTarget _        = False

-- | 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.
733
data GhcMode
734 735 736
  = CompManager         -- ^ @\-\-make@, GHCi, etc.
  | OneShot             -- ^ @ghc -c Foo.hs@
  | MkDepend            -- ^ @ghc -M@, see "Finder" for why we need this
737 738
  deriving Eq

739 740 741 742 743
instance Outputable GhcMode where
  ppr CompManager = ptext (sLit "CompManager")
  ppr OneShot     = ptext (sLit "OneShot")
  ppr MkDepend    = ptext (sLit "MkDepend")

744 745 746 747
isOneShot :: GhcMode -> Bool
isOneShot OneShot = True
isOneShot _other  = False

748 749 750 751
-- | 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
752 753
  | LinkInMemory        -- ^ Use the in-memory dynamic linker (works for both
                        --   bytecode and object code).
754
  | LinkDynLib          -- ^ Link objects into a dynamic lib (DLL on Windows, DSO on ELF platforms)
755
  deriving (Eq, Show)
756 757 758

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

761 762 763
-- Is it worth evaluating this Bool and caching it in the DynFlags value
-- during initDynFlags?
doingTickyProfiling :: DynFlags -> Bool
764 765 766
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.
767

768
data PackageFlag
769
  = ExposePackage   String
770
  | ExposePackageId String
771 772 773 774
  | HidePackage     String
  | IgnorePackage   String
  | TrustPackage    String
  | DistrustPackage String
775
  deriving Eq
776

twanvl's avatar
twanvl committed
777
defaultHscTarget :: HscTarget
778 779
defaultHscTarget = defaultObjectTarget

780
-- | The 'HscTarget' value corresponding to the default way to create
781
-- object files on the current platform.
twanvl's avatar
twanvl committed
782
defaultObjectTarget :: HscTarget
783
defaultObjectTarget
784
  | cGhcUnregisterised    == "YES"      =  HscC
Ian Lynagh's avatar
Ian Lynagh committed
785
  | cGhcWithNativeCodeGen == "YES"      =  HscAsm
786
  | otherwise                           =  HscLlvm
787

788 789 790 791 792
data DynLibLoader
  = Deployable
  | SystemDependent
  deriving Eq

Ian Lynagh's avatar
Ian Lynagh committed
793
data RtsOptsEnabled = RtsOptsNone | RtsOptsSafeOnly | RtsOptsAll
794
  deriving (Show)
Ian Lynagh's avatar
Ian Lynagh committed
795

796
-- | Used by 'GHC.newSession' to partially initialize a new 'DynFlags' value
twanvl's avatar
twanvl committed
797
initDynFlags :: DynFlags -> IO DynFlags
798 799 800
initDynFlags dflags = do
 -- someday these will be dynamic flags
 ways <- readIORef v_Ways
801
 refFilesToClean <- newIORef []
802
 refDirsToClean <- newIORef Map.empty
803
 refGeneratedDumps <- newIORef Set.empty
804
 return dflags{
805 806 807
        ways            = ways,
        buildTag        = mkBuildTag (filter (not . wayRTSOnly) ways),
        rtsBuildTag     = mkBuildTag ways,
808
        filesToClean    = refFilesToClean,
809 810
        dirsToClean     = refDirsToClean,
        generatedDumps   = refGeneratedDumps
Ian Lynagh's avatar
Ian Lynagh committed
811
        }
812

813 814
-- | The normal 'DynFlags'. Note that they is not suitable for use in this form
-- and must be fully initialized by 'GHC.newSession' first.
815 816
defaultDynFlags :: Settings -> DynFlags
defaultDynFlags mySettings =
817
     DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
818 819 820 821 822 823 824
        ghcMode                 = CompManager,
        ghcLink                 = LinkBinary,
        hscTarget               = defaultHscTarget,
        hscOutName              = "",
        extCoreName             = "",
        verbosity               = 0,
        optLevel                = 0,
825
        simplPhases             = 2,
Ian Lynagh's avatar
Ian Lynagh committed
826
        maxSimplIterations      = 4,
827
        shouldDumpSimplPhase    = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
828
        ruleCheck               = Nothing,
dterei's avatar
dterei committed
829
        simplTickFactor         = 100,
830
        specConstrThreshold     = Just 2000,
Ian Lynagh's avatar
Ian Lynagh committed
831
        specConstrCount         = Just 3,
832
        liberateCaseThreshold   = Just 2000,
833
        floatLamArgs            = Just 0, -- Default: float only if no fvs
834 835
        strictnessBefore        = [],

Ian Lynagh's avatar
Ian Lynagh committed
836 837 838 839 840 841 842 843 844
        cmdlineHcIncludes       = [],
        importPaths             = ["."],
        mainModIs               = mAIN,
        mainFunIs               = Nothing,
        ctxtStkDepth            = mAX_CONTEXT_REDUCTION_DEPTH,

        thisPackage             = mainPackageId,

        objectDir               = Nothing,
845
        dylibInstallName        = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
846 847 848 849 850 851 852
        hiDir                   = Nothing,
        stubDir                 = Nothing,

        objectSuf               = phaseInputExt StopLn,
        hcSuf                   = phaseInputExt HCc,
        hiSuf                   = "hi",

853 854 855
        pluginModNames          = [],
        pluginModNameOpts       = [],

Ian Lynagh's avatar
Ian Lynagh committed
856 857
        outputFile              = Nothing,
        outputHi                = Nothing,
858
        dynLibLoader            = SystemDependent,
Ian Lynagh's avatar
Ian Lynagh committed
859 860 861 862 863 864
        dumpPrefix              = Nothing,
        dumpPrefixForce         = Nothing,
        includePaths            = [],
        libraryPaths            = [],
        frameworkPaths          = [],
        cmdlineFrameworks       = [],
865
        rtsOpts                 = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
866
        rtsOptsEnabled          = RtsOptsSafeOnly,
Ian Lynagh's avatar
Ian Lynagh committed
867 868 869 870 871

        hpcDir                  = ".hpc",

        extraPkgConfs           = [],
        packageFlags            = [],
872 873
        pkgDatabase             = Nothing,
        pkgState                = panic "no package state yet: call GHC.setSessionDynFlags",
874
        ways                    = panic "defaultDynFlags: No ways",
Ian Lynagh's avatar
Ian Lynagh committed
875 876
        buildTag                = panic "defaultDynFlags: No buildTag",
        rtsBuildTag             = panic "defaultDynFlags: No rtsBuildTag",
877
        splitInfo               = Nothing,
878
        settings                = mySettings,
879 880 881 882 883 884
        -- ghc -M values
        depMakefile       = "Makefile",
        depIncludePkgDeps = False,
        depExcludeMods    = [],
        depSuffixes       = [],
        -- end of ghc -M values
885 886
        filesToClean   = panic "defaultDynFlags: No filesToClean",
        dirsToClean    = panic "defaultDynFlags: No dirsToClean",
887
        generatedDumps = panic "defaultDynFlags: No generatedDumps",
Ian Lynagh's avatar
Ian Lynagh committed
888
        haddockOptions = Nothing,
889
        flags = defaultFlags,
890
        warningFlags = standardWarnings,
891
        language = Nothing,
dterei's avatar
dterei committed
892
        safeHaskell = Sf_SafeInfered,
893 894
        thOnLoc = noSrcSpan,
        newDerivOnLoc = noSrcSpan,
895 896
        extensions = [],
        extensionFlags = flattenExtensionFlags Nothing [],
897 898
        log_action = defaultLogAction,
        profAuto = NoProfAuto
899 900
      }

901 902 903 904 905 906 907 908 909 910 911 912 913 914
type LogAction = Severity -> SrcSpan -> PprStyle -> Message -> IO ()

defaultLogAction :: LogAction
defaultLogAction severity srcSpan style msg
 = case severity of
   SevOutput -> printSDoc msg style
   SevInfo   -> printErrs msg style
   SevFatal  -> printErrs msg style
   _         -> do hPutChar stderr '\n'
                   printErrs (mkLocMessage srcSpan msg) style
                   -- careful (#2302): printErrs prints in UTF-8, whereas
                   -- converting to string first and using hPutStr would
                   -- just emit the low 8 bits of each unicode char.

Ian Lynagh's avatar
Ian Lynagh committed
915
{-
916 917
Note [Verbosity levels]
~~~~~~~~~~~~~~~~~~~~~~~
Ian Lynagh's avatar
Ian Lynagh committed
918
    0   |   print errors & warnings only
919 920 921 922 923 924 925
    1   |   minimal verbosity: print "compiling M ... done." for each module.
    2   |   equivalent to -dshow-passes
    3   |   equivalent to existing "ghc -v"
    4   |   "ghc -v -ddump-most"
    5   |   "ghc -v -ddump-all"
-}

926 927 928 929 930
data OnOff a = On a
             | <