DynFlags.hs 106 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
        glasgowExtsFlags,
21 22 23
        dopt,
        dopt_set,
        dopt_unset,
24 25 26
        wopt,
        wopt_set,
        wopt_unset,
27 28 29
        xopt,
        xopt_set,
        xopt_unset,
Ian Lynagh's avatar
Ian Lynagh committed
30
        DynFlags(..),
Ian Lynagh's avatar
Ian Lynagh committed
31
        RtsOptsEnabled(..),
Ian Lynagh's avatar
Ian Lynagh committed
32 33 34 35
        HscTarget(..), isObjectTarget, defaultObjectTarget,
        GhcMode(..), isOneShot,
        GhcLink(..), isNoLink,
        PackageFlag(..),
Ian Lynagh's avatar
Ian Lynagh committed
36
        Option(..), showOpt,
Ian Lynagh's avatar
Ian Lynagh committed
37
        DynLibLoader(..),
38
        fFlags, fWarningFlags, fLangFlags, xFlags,
39
        DPHBackend(..), dphPackageMaybe,
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
andy@galois.com's avatar
andy@galois.com committed
206
   | Opt_D_dump_hpc
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 255 256 257
   -- profiling opts
   | Opt_AutoSccsOnAllToplevs
   | Opt_AutoSccsOnExportedToplevs
   | Opt_AutoSccsOnIndividualCafs

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

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

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

303 304 305
   -- safe haskell flags
   | Opt_PackageTrust

306
   deriving (Eq, Show)
Ian Lynagh's avatar
Ian Lynagh committed
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 342
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)

343 344
data Language = Haskell98 | Haskell2010

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 440
   deriving (Eq, Show)

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 471
  dphBackend            :: DPHBackend,

472
  thisPackage           :: PackageId,   -- ^ name of package currently being compiled
473 474

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

479 480 481
  -- For object splitting
  splitInfo             :: Maybe (String,Int),

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

Ian Lynagh's avatar
Ian Lynagh committed
488 489 490
  objectSuf             :: String,
  hcSuf                 :: String,
  hiSuf                 :: String,
491

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

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

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

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

509
  rtsOpts               :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
510
  rtsOptsEnabled        :: RtsOptsEnabled,
511

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

514 515 516 517
  -- Plugins
  pluginModNames        :: [ModuleName],
  pluginModNameOpts     :: [(ModuleName,String)],

518
  settings              :: Settings,
519

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

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

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

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

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

546 547 548 549 550
  -- 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),

551
  -- hsc dynamic flags
Ian Lynagh's avatar
Ian Lynagh committed
552
  flags                 :: [DynFlag],
553
  warningFlags          :: [WarningFlag],
554
  -- Don't change this without updating extensionFlags:
555
  language              :: Maybe Language,
556 557
  -- | Safe Haskell mode
  safeHaskell           :: SafeHaskellMode,
558 559 560 561 562
  -- 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,
563 564 565 566 567
  -- 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
568

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

  haddockOptions :: Maybe String
573 574
 }

575
data Settings = Settings {
576
  sTargetPlatform        :: Platform,    -- Filled in by SysTools
577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598
  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
599 600 601 602 603 604 605 606 607 608 609 610
  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

611 612
 }

613 614 615
targetPlatform :: DynFlags -> Platform
targetPlatform dflags = sTargetPlatform (settings dflags)

616 617 618 619 620 621 622 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
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)
656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673
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)
674

675 676 677
wayNames :: DynFlags -> [WayName]
wayNames = map wayName . ways

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

Ian Lynagh's avatar
Ian Lynagh committed
706 707 708 709 710 711 712
showHscTargetFlag :: HscTarget -> String
showHscTargetFlag HscC           = "-fvia-c"
showHscTargetFlag HscAsm         = "-fasm"
showHscTargetFlag HscLlvm        = "-fllvm"
showHscTargetFlag HscInterpreted = "-fbyte-code"
showHscTargetFlag HscNothing     = "-fno-code"

713
-- | Will this target result in an object file on the disk?
714 715 716
isObjectTarget :: HscTarget -> Bool
isObjectTarget HscC     = True
isObjectTarget HscAsm   = True
717
isObjectTarget HscLlvm  = True
718 719 720 721 722 723 724 725
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.
726
data GhcMode
727 728 729
  = CompManager         -- ^ @\-\-make@, GHCi, etc.
  | OneShot             -- ^ @ghc -c Foo.hs@
  | MkDepend            -- ^ @ghc -M@, see "Finder" for why we need this
730 731
  deriving Eq

732 733 734 735 736
instance Outputable GhcMode where
  ppr CompManager = ptext (sLit "CompManager")
  ppr OneShot     = ptext (sLit "OneShot")
  ppr MkDepend    = ptext (sLit "MkDepend")

737 738 739 740
isOneShot :: GhcMode -> Bool
isOneShot OneShot = True
isOneShot _other  = False

741 742 743 744
-- | 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
745 746
  | LinkInMemory        -- ^ Use the in-memory dynamic linker (works for both
                        --   bytecode and object code).
747
  | LinkDynLib          -- ^ Link objects into a dynamic lib (DLL on Windows, DSO on ELF platforms)
748
  deriving (Eq, Show)
749 750 751

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

754 755 756
-- Is it worth evaluating this Bool and caching it in the DynFlags value
-- during initDynFlags?
doingTickyProfiling :: DynFlags -> Bool
757 758 759
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.
760

761
data PackageFlag
762
  = ExposePackage   String
763
  | ExposePackageId String
764 765 766 767
  | HidePackage     String
  | IgnorePackage   String
  | TrustPackage    String
  | DistrustPackage String
768
  deriving Eq
769

twanvl's avatar
twanvl committed
770
defaultHscTarget :: HscTarget
771 772
defaultHscTarget = defaultObjectTarget

773
-- | The 'HscTarget' value corresponding to the default way to create
774
-- object files on the current platform.
twanvl's avatar
twanvl committed
775
defaultObjectTarget :: HscTarget
776
defaultObjectTarget
777
  | cGhcUnregisterised    == "YES"      =  HscC
Ian Lynagh's avatar
Ian Lynagh committed
778
  | cGhcWithNativeCodeGen == "YES"      =  HscAsm
779
  | otherwise                           =  HscLlvm
780

781 782 783 784 785
data DynLibLoader
  = Deployable
  | SystemDependent
  deriving Eq

Ian Lynagh's avatar
Ian Lynagh committed
786
data RtsOptsEnabled = RtsOptsNone | RtsOptsSafeOnly | RtsOptsAll
787
  deriving (Show)
Ian Lynagh's avatar
Ian Lynagh committed
788

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

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

Ian Lynagh's avatar
Ian Lynagh committed
829 830 831 832 833 834
        cmdlineHcIncludes       = [],
        importPaths             = ["."],
        mainModIs               = mAIN,
        mainFunIs               = Nothing,
        ctxtStkDepth            = mAX_CONTEXT_REDUCTION_DEPTH,

chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
835
        dphBackend              = DPHNone,
836

Ian Lynagh's avatar
Ian Lynagh committed
837 838 839
        thisPackage             = mainPackageId,

        objectDir               = Nothing,
840
        dylibInstallName        = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
841 842 843 844 845 846 847
        hiDir                   = Nothing,
        stubDir                 = Nothing,

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

848 849 850
        pluginModNames          = [],
        pluginModNameOpts       = [],

Ian Lynagh's avatar
Ian Lynagh committed
851 852
        outputFile              = Nothing,
        outputHi                = Nothing,
853
        dynLibLoader            = SystemDependent,
Ian Lynagh's avatar
Ian Lynagh committed
854 855 856 857 858 859
        dumpPrefix              = Nothing,
        dumpPrefixForce         = Nothing,
        includePaths            = [],
        libraryPaths            = [],
        frameworkPaths          = [],
        cmdlineFrameworks       = [],
860
        rtsOpts                 = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
861
        rtsOptsEnabled          = RtsOptsSafeOnly,
Ian Lynagh's avatar
Ian Lynagh committed
862 863 864 865 866

        hpcDir                  = ".hpc",

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

895 896 897 898 899 900 901 902 903 904 905 906 907 908
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
909
{-
910 911
Note [Verbosity levels]
~~~~~~~~~~~~~~~~~~~~~~~
Ian Lynagh's avatar
Ian Lynagh committed
912
    0   |   print errors & warnings only
913 914 915 916 917 918 919
    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"
-}

920 921 922 923 924
data OnOff a = On a
             | Off a

-- OnOffs accumulate in reverse order, so we use foldr in order to
-- process them in the right order
925 926 927
flattenExtensionFlags :: Maybe Language -> [OnOff ExtensionFlag]
                      -> [ExtensionFlag]
flattenExtensionFlags ml = foldr f defaultExtensionFlags
928 929
    where f (On f)  flags = f : delete f flags
          f (Off f) flags =     delete f flags
930 931 932
          defaultExtensionFlags = languageExtensions ml