DynFlags.hs 101 KB
Newer Older
1
-- |
2 3 4 5 6 7
-- Dynamic flags
--
--
-- (c) The University of Glasgow 2005
--

8
-- Most flags are dynamic flags, which means they can change from
9 10 11
-- 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.
12
module DynFlags (
13
        -- * Dynamic flags and associated configuration types
Ian Lynagh's avatar
Ian Lynagh committed
14
        DynFlag(..),
15
        ExtensionFlag(..),
16
        glasgowExtsFlags,
17 18 19 20 21 22
        dopt,
        dopt_set,
        dopt_unset,
        xopt,
        xopt_set,
        xopt_unset,
Ian Lynagh's avatar
Ian Lynagh committed
23
        DynFlags(..),
Ian Lynagh's avatar
Ian Lynagh committed
24
        RtsOptsEnabled(..),
Ian Lynagh's avatar
Ian Lynagh committed
25 26 27 28
        HscTarget(..), isObjectTarget, defaultObjectTarget,
        GhcMode(..), isOneShot,
        GhcLink(..), isNoLink,
        PackageFlag(..),
Ian Lynagh's avatar
Ian Lynagh committed
29
        Option(..), showOpt,
Ian Lynagh's avatar
Ian Lynagh committed
30
        DynLibLoader(..),
31
        fFlags, fLangFlags, xFlags,
32
        DPHBackend(..), dphPackageMaybe,
33
        wayNames,
34
        SafeHaskellMode(..),
35
        safeHaskellOn,
36

37 38 39 40 41
        Settings(..),
        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,
42 43
        opt_L, opt_P, opt_F, opt_c, opt_m, opt_a, opt_l,
        opt_windres, opt_lo, opt_lc,
44 45


46
        -- ** Manipulating DynFlags
47
        defaultDynFlags,                -- Settings -> DynFlags
Ian Lynagh's avatar
Ian Lynagh committed
48 49
        initDynFlags,                   -- DynFlags -> IO DynFlags

50
        getOpts,                        -- DynFlags -> (DynFlags -> [a]) -> [a]
51
        getVerbFlags,
Ian Lynagh's avatar
Ian Lynagh committed
52 53 54
        updOptLevel,
        setTmpDir,
        setPackageName,
55
        doingTickyProfiling,
Ian Lynagh's avatar
Ian Lynagh committed
56

57
        -- ** Parsing DynFlags
Ian Lynagh's avatar
Ian Lynagh committed
58
        parseDynamicFlags,
59
        parseDynamicNoPackageFlags,
60
        allFlags,
61

62
        supportedLanguagesAndExtensions,
63 64

        -- ** DynFlag C compiler options
65
        picCCOpts,
66 67 68 69 70 71

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

        -- * Compiler configuration suitable for display to the user
72 73 74 75 76 77
        compilerInfo
#ifdef GHCI
-- Only in stage 2 can we be sure that the RTS 
-- exposes the appropriate runtime boolean
        , rtsIsProfiled
#endif
78 79 80 81
  ) where

#include "HsVersions.h"

82
import Platform
83
import Module
Simon Marlow's avatar
Simon Marlow committed
84
import PackageConfig
85
import PrelNames        ( mAIN )
86
import StaticFlags
87
import {-# SOURCE #-} Packages (PackageState)
Ian Lynagh's avatar
Ian Lynagh committed
88
import DriverPhases     ( Phase(..), phaseInputExt )
89 90
import Config
import CmdLineParser
Ian Lynagh's avatar
Ian Lynagh committed
91
import Constants        ( mAX_CONTEXT_REDUCTION_DEPTH )
92
import Panic
93
import Util
94
import Maybes           ( orElse )
95
import SrcLoc
96
import FastString
Simon Marlow's avatar
Simon Marlow committed
97
import Outputable
Ian Lynagh's avatar
Ian Lynagh committed
98
#ifdef GHCI
99
import Foreign.C	( CInt )
Ian Lynagh's avatar
Ian Lynagh committed
100
#endif
Simon Marlow's avatar
Simon Marlow committed
101
import {-# SOURCE #-} ErrUtils ( Severity(..), Message, mkLocMessage )
102

Ian Lynagh's avatar
Ian Lynagh committed
103
#ifdef GHCI
104
import System.IO.Unsafe	( unsafePerformIO )
Ian Lynagh's avatar
Ian Lynagh committed
105
#endif
106
import Data.IORef
Ian Lynagh's avatar
Ian Lynagh committed
107
import Control.Monad    ( when )
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
108

109
import Data.Char
110
import Data.List
111 112
import Data.Map (Map)
import qualified Data.Map as Map
113 114
import Data.Set (Set)
import qualified Data.Set as Set
Ian Lynagh's avatar
Ian Lynagh committed
115
import System.FilePath
116
import System.IO        ( stderr, hPutChar )
117

118 119 120
-- -----------------------------------------------------------------------------
-- DynFlags

121
-- | Enumerates the simple on-or-off dynamic flags
122 123 124 125
data DynFlag

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

Ian Lynagh's avatar
Ian Lynagh committed
210
   | Opt_WarnIsError                    -- -Werror; makes warnings fatal
211 212
   | Opt_WarnDuplicateExports
   | Opt_WarnHiShadows
213
   | Opt_WarnImplicitPrelude
214
   | Opt_WarnIncompletePatterns
215
   | Opt_WarnIncompleteUniPatterns
216 217
   | Opt_WarnIncompletePatternsRecUpd
   | Opt_WarnMissingFields
218
   | Opt_WarnMissingImportList
219 220
   | Opt_WarnMissingMethods
   | Opt_WarnMissingSigs
221
   | Opt_WarnMissingLocalSigs
222 223 224
   | Opt_WarnNameShadowing
   | Opt_WarnOverlappingPatterns
   | Opt_WarnTypeDefaults
225
   | Opt_WarnMonomorphism
226 227 228
   | Opt_WarnUnusedBinds
   | Opt_WarnUnusedImports
   | Opt_WarnUnusedMatches
Ian Lynagh's avatar
Ian Lynagh committed
229
   | Opt_WarnWarningsDeprecations
230
   | Opt_WarnDeprecatedFlags
231
   | Opt_WarnDodgyExports
232 233
   | Opt_WarnDodgyImports
   | Opt_WarnOrphans
234
   | Opt_WarnAutoOrphans
235
   | Opt_WarnIdentities
236
   | Opt_WarnTabs
237
   | Opt_WarnUnrecognisedPragmas
238
   | Opt_WarnDodgyForeignImports
239
   | Opt_WarnLazyUnliftedBindings
240 241
   | Opt_WarnUnusedDoBind
   | Opt_WarnWrongDoBind
242
   | Opt_WarnAlternativeLayoutRuleTransitional
243

244 245
   | Opt_PrintExplicitForalls

246 247 248
   -- optimisation opts
   | Opt_Strictness
   | Opt_FullLaziness
249 250
   | Opt_FloatIn
   | Opt_Specialise
251
   | Opt_StaticArgumentTransformation
252
   | Opt_CSE
253 254
   | Opt_LiberateCase
   | Opt_SpecConstr
255 256 257 258 259
   | Opt_DoLambdaEtaExpansion
   | Opt_IgnoreAsserts
   | Opt_DoEtaReduction
   | Opt_CaseMerge
   | Opt_UnboxStrictFields
260
   | Opt_MethodSharing	-- Now a no-op; remove in GHC 7.2
261
   | Opt_DictsCheap
262
   | Opt_EnableRewriteRules		-- Apply rewrite rules during simplification
rl@cse.unsw.edu.au's avatar
rl@cse.unsw.edu.au committed
263
   | Opt_Vectorise
Ian Lynagh's avatar
Ian Lynagh committed
264 265
   | Opt_RegsGraph                      -- do graph coloring register allocation
   | Opt_RegsIterative                  -- do iterative coalescing graph coloring register allocation
266

267 268 269 270 271
   -- Interface files
   | Opt_IgnoreInterfacePragmas
   | Opt_OmitInterfacePragmas
   | Opt_ExposeAllUnfoldings

Ian Lynagh's avatar
Ian Lynagh committed
272 273 274 275 276
   -- profiling opts
   | Opt_AutoSccsOnAllToplevs
   | Opt_AutoSccsOnExportedToplevs
   | Opt_AutoSccsOnIndividualCafs

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

	-- temporary flags
   | Opt_RunCPS
306 307
   | Opt_RunCPSZ
   | Opt_ConvertToZipCfgAndBack
308
   | Opt_AutoLinkPackages
309
   | Opt_ImplicitImportQualified
310
   | Opt_TryNewCodeGen
311 312 313 314 315 316

   -- keeping stuff
   | Opt_KeepHiDiffs
   | Opt_KeepHcFiles
   | Opt_KeepSFiles
   | Opt_KeepTmpFiles
Jedai's avatar
Jedai committed
317
   | Opt_KeepRawTokenStream
318
   | Opt_KeepLlvmFiles
319

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

322 323
data Language = Haskell98 | Haskell2010

324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341
-- | The various SafeHaskell modes
data SafeHaskellMode
   = Sf_None
   | Sf_SafeImports
   | Sf_SafeLanguage
   | Sf_Trustworthy
   | Sf_TrustworthyWithSafeLanguage
   | Sf_Safe
   deriving (Eq)

instance Show SafeHaskellMode where
    show Sf_None = "None"
    show Sf_SafeImports = "SafeImports"
    show Sf_SafeLanguage = "SafeLanguage"
    show Sf_Trustworthy = "Trustworthy"
    show Sf_TrustworthyWithSafeLanguage = "Trustworthy + SafeLanguage"
    show Sf_Safe = "Safe"

342
data ExtensionFlag
343 344 345 346 347 348 349
   = Opt_Cpp
   | Opt_OverlappingInstances
   | Opt_UndecidableInstances
   | Opt_IncoherentInstances
   | Opt_MonomorphismRestriction
   | Opt_MonoPatBinds
   | Opt_MonoLocalBinds
350
   | Opt_RelaxedPolyRec		-- Deprecated
351 352 353 354
   | Opt_ExtendedDefaultRules           -- Use GHC's extended rules for defaulting
   | Opt_ForeignFunctionInterface
   | Opt_UnliftedFFITypes
   | Opt_GHCForeignImportPrim
benl's avatar
benl committed
355
   | Opt_ParallelArrays                 -- Syntactic support for parallel arrays
356 357 358 359 360 361 362 363 364 365 366 367 368 369 370
   | Opt_Arrows                         -- Arrow-notation syntax
   | 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
371
   | Opt_GADTSyntax
372
   | Opt_NPlusKPatterns
Ian Lynagh's avatar
Ian Lynagh committed
373
   | Opt_DoAndIfThenElse
374
   | Opt_RebindableSyntax
375 376 377 378 379 380

   | Opt_StandaloneDeriving
   | Opt_DeriveDataTypeable
   | Opt_DeriveFunctor
   | Opt_DeriveTraversable
   | Opt_DeriveFoldable
381
   | Opt_DeriveGeneric            -- Allow deriving Generic/1
dreixel's avatar
dreixel committed
382 383
   | Opt_DefaultSignatures        -- Allow extra signatures for defmeths
   | Opt_Generics                 -- Old generic classes, now deprecated
384 385 386 387 388 389 390 391 392 393 394 395 396 397 398

   | 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
399
   | Opt_MonadComprehensions
400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415
   | 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
416
   | Opt_NondecreasingIndentation
417
   | Opt_RelaxedLayout
418 419
   deriving (Eq, Show)

420 421
-- | 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
422
data DynFlags = DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
423 424 425
  ghcMode               :: GhcMode,
  ghcLink               :: GhcLink,
  hscTarget             :: HscTarget,
426
  hscOutName            :: String,      -- ^ Name of the output file
427
  extCoreName           :: String,      -- ^ Name of the .hcr output file
428
  verbosity             :: Int,         -- ^ Verbosity level: see Note [Verbosity levels]
429 430 431
  optLevel              :: Int,         -- ^ Optimisation level
  simplPhases           :: Int,         -- ^ Number of simplifier phases
  maxSimplIterations    :: Int,         -- ^ Max simplifier iterations
432
  shouldDumpSimplPhase  :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
433
  ruleCheck             :: Maybe String,
434
  strictnessBefore      :: [Int],       -- ^ Additional demand analysis
435

436 437 438
  specConstrThreshold   :: Maybe Int,   -- ^ Threshold for SpecConstr
  specConstrCount       :: Maybe Int,   -- ^ Max number of specialisations for any one function
  liberateCaseThreshold :: Maybe Int,   -- ^ Threshold for LiberateCase
439 440
  floatLamArgs          :: Maybe Int,   -- ^ Arg count for lambda floating
  			   	 	--   See CoreMonad.FloatOutSwitches
441

Ian Lynagh's avatar
Ian Lynagh committed
442
  targetPlatform        :: Platform.Platform, -- ^ The platform we're compiling for. Used by the NCG.
443
  cmdlineHcIncludes     :: [String],    -- ^ @\-\#includes@
Ian Lynagh's avatar
Ian Lynagh committed
444 445 446
  importPaths           :: [FilePath],
  mainModIs             :: Module,
  mainFunIs             :: Maybe String,
447
  ctxtStkDepth          :: Int,         -- ^ Typechecker context stack depth
448

449 450
  dphBackend            :: DPHBackend,

451
  thisPackage           :: PackageId,   -- ^ name of package currently being compiled
452 453

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

458 459 460
  -- For object splitting
  splitInfo             :: Maybe (String,Int),

461
  -- paths etc.
Ian Lynagh's avatar
Ian Lynagh committed
462
  objectDir             :: Maybe String,
463
  dylibInstallName      :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
464 465
  hiDir                 :: Maybe String,
  stubDir               :: Maybe String,
466

Ian Lynagh's avatar
Ian Lynagh committed
467 468 469
  objectSuf             :: String,
  hcSuf                 :: String,
  hiSuf                 :: String,
470

Ian Lynagh's avatar
Ian Lynagh committed
471 472 473
  outputFile            :: Maybe String,
  outputHi              :: Maybe String,
  dynLibLoader          :: DynLibLoader,
474

475
  -- | This is set by 'DriverPipeline.runPipeline' based on where
Ian Lynagh's avatar
Ian Lynagh committed
476 477
  --    its output is going.
  dumpPrefix            :: Maybe FilePath,
478

479 480
  -- | Override the 'dumpPrefix' set by 'DriverPipeline.runPipeline'.
  --    Set by @-ddump-file-prefix@
Ian Lynagh's avatar
Ian Lynagh committed
481 482 483 484 485 486 487
  dumpPrefixForce       :: Maybe FilePath,

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

488
  rtsOpts               :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
489
  rtsOptsEnabled        :: RtsOptsEnabled,
490

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

493 494 495 496
  -- Plugins
  pluginModNames        :: [ModuleName],
  pluginModNameOpts     :: [(ModuleName,String)],

497
  settings              :: Settings,
498

499 500 501 502 503 504
  --  For ghc -M
  depMakefile           :: FilePath,
  depIncludePkgDeps     :: Bool,
  depExcludeMods        :: [ModuleName],
  depSuffixes           :: [String],

505
  --  Package flags
Ian Lynagh's avatar
Ian Lynagh committed
506
  extraPkgConfs         :: [FilePath],
507
        -- ^ The @-package-conf@ flags given on the command line, in the order
Ian Lynagh's avatar
Ian Lynagh committed
508
        -- they appeared.
509

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

513
  -- Package state
Ian Lynagh's avatar
Ian Lynagh committed
514
  -- NB. do not modify this field, it is calculated by
515
  -- Packages.initPackages and Packages.updatePackages.
516
  pkgDatabase           :: Maybe [PackageConfig],
Ian Lynagh's avatar
Ian Lynagh committed
517
  pkgState              :: PackageState,
518

519 520 521 522
  -- Temporary files
  -- These have to be IORefs, because the defaultCleanupHandler needs to
  -- know what to clean when an exception happens
  filesToClean          :: IORef [FilePath],
523
  dirsToClean           :: IORef (Map FilePath FilePath),
524

525 526 527 528 529
  -- 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),

530
  -- hsc dynamic flags
Ian Lynagh's avatar
Ian Lynagh committed
531
  flags                 :: [DynFlag],
532
  -- Don't change this without updating extensionFlags:
533
  language              :: Maybe Language,
534 535
  -- | Safe Haskell mode
  safeHaskell           :: SafeHaskellMode,
536 537 538 539 540
  -- 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
541

542
  -- | Message output action: use "ErrUtils" instead of this if you can
David Waern's avatar
David Waern committed
543 544 545
  log_action            :: Severity -> SrcSpan -> PprStyle -> Message -> IO (),

  haddockOptions :: Maybe String
546 547
 }

548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570
data Settings = Settings {
  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
571 572 573 574 575 576 577 578 579 580 581 582 583
  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_m                 :: [String],
  sOpt_a                 :: [String],
  sOpt_l                 :: [String],
  sOpt_windres           :: [String],
  sOpt_lo                :: [String], -- LLVM: llvm optimiser
  sOpt_lc                :: [String]  -- LLVM: llc static compiler

584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625
 }

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)
626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645
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_m                 :: DynFlags -> [String]
opt_m dflags = sOpt_m (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)
646

647 648 649
wayNames :: DynFlags -> [WayName]
wayNames = map wayName . ways

650 651
-- | The target code type of the compilation (if any).
--
652 653 654
-- Whenever you change the target, also make sure to set 'ghcLink' to
-- something sensible.
--
655 656 657 658
-- 'HscNothing' can be used to avoid generating any output, however, note
-- that:
--
--  * This will not run the desugaring step, thus no warnings generated in
659 660 661
--    this step will be output.  In particular, this includes warnings related
--    to pattern matching.  You can run the desugarer manually using
--    'GHC.desugarModule'.
662
--
663 664 665 666 667 668
--  * 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.)
669
--
670
data HscTarget
671 672
  = HscC           -- ^ Generate C code.
  | HscAsm         -- ^ Generate assembly using the native code generator.
673
  | HscLlvm        -- ^ Generate assembly using the llvm code generator.
674 675
  | HscInterpreted -- ^ Generate bytecode.  (Requires 'LinkInMemory')
  | HscNothing     -- ^ Don't generate any code.  See notes above.
676 677
  deriving (Eq, Show)

Ian Lynagh's avatar
Ian Lynagh committed
678 679 680 681 682 683 684
showHscTargetFlag :: HscTarget -> String
showHscTargetFlag HscC           = "-fvia-c"
showHscTargetFlag HscAsm         = "-fasm"
showHscTargetFlag HscLlvm        = "-fllvm"
showHscTargetFlag HscInterpreted = "-fbyte-code"
showHscTargetFlag HscNothing     = "-fno-code"

685
-- | Will this target result in an object file on the disk?
686 687 688
isObjectTarget :: HscTarget -> Bool
isObjectTarget HscC     = True
isObjectTarget HscAsm   = True
689
isObjectTarget HscLlvm  = True
690 691 692 693 694 695 696 697
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.
698
data GhcMode
699 700 701
  = CompManager         -- ^ @\-\-make@, GHCi, etc.
  | OneShot             -- ^ @ghc -c Foo.hs@
  | MkDepend            -- ^ @ghc -M@, see "Finder" for why we need this
702 703
  deriving Eq

704 705 706 707 708
instance Outputable GhcMode where
  ppr CompManager = ptext (sLit "CompManager")
  ppr OneShot     = ptext (sLit "OneShot")
  ppr MkDepend    = ptext (sLit "MkDepend")

709 710 711 712
isOneShot :: GhcMode -> Bool
isOneShot OneShot = True
isOneShot _other  = False

713 714 715 716
-- | 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
717 718
  | LinkInMemory        -- ^ Use the in-memory dynamic linker (works for both
                        --   bytecode and object code).
719
  | LinkDynLib          -- ^ Link objects into a dynamic lib (DLL on Windows, DSO on ELF platforms)
720
  deriving (Eq, Show)
721 722 723

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

726 727 728
-- Is it worth evaluating this Bool and caching it in the DynFlags value
-- during initDynFlags?
doingTickyProfiling :: DynFlags -> Bool
729 730 731
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.
732

733 734
data PackageFlag
  = ExposePackage  String
735
  | ExposePackageId String
736 737
  | HidePackage    String
  | IgnorePackage  String
738
  deriving Eq
739

twanvl's avatar
twanvl committed
740
defaultHscTarget :: HscTarget
741 742
defaultHscTarget = defaultObjectTarget

743
-- | The 'HscTarget' value corresponding to the default way to create
744
-- object files on the current platform.
twanvl's avatar
twanvl committed
745
defaultObjectTarget :: HscTarget
746
defaultObjectTarget
747
  | cGhcUnregisterised    == "YES"      =  HscC
Ian Lynagh's avatar
Ian Lynagh committed
748
  | cGhcWithNativeCodeGen == "YES"      =  HscAsm
749
  | otherwise                           =  HscLlvm
750

751 752 753 754 755
data DynLibLoader
  = Deployable
  | SystemDependent
  deriving Eq

Ian Lynagh's avatar
Ian Lynagh committed
756
data RtsOptsEnabled = RtsOptsNone | RtsOptsSafeOnly | RtsOptsAll
757
  deriving (Show)
Ian Lynagh's avatar
Ian Lynagh committed
758

759
-- | Used by 'GHC.newSession' to partially initialize a new 'DynFlags' value
twanvl's avatar
twanvl committed
760
initDynFlags :: DynFlags -> IO DynFlags
761 762 763
initDynFlags dflags = do
 -- someday these will be dynamic flags
 ways <- readIORef v_Ways
764
 refFilesToClean <- newIORef []
765
 refDirsToClean <- newIORef Map.empty
766
 refGeneratedDumps <- newIORef Set.empty
767
 return dflags{
768 769 770
        ways            = ways,
        buildTag        = mkBuildTag (filter (not . wayRTSOnly) ways),
        rtsBuildTag     = mkBuildTag ways,
771
        filesToClean    = refFilesToClean,
772 773
        dirsToClean     = refDirsToClean,
        generatedDumps   = refGeneratedDumps
Ian Lynagh's avatar
Ian Lynagh committed
774
        }
775

776 777
-- | The normal 'DynFlags'. Note that they is not suitable for use in this form
-- and must be fully initialized by 'GHC.newSession' first.
778 779
defaultDynFlags :: Settings -> DynFlags
defaultDynFlags mySettings =
780
     DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
781 782 783 784 785 786 787
        ghcMode                 = CompManager,
        ghcLink                 = LinkBinary,
        hscTarget               = defaultHscTarget,
        hscOutName              = "",
        extCoreName             = "",
        verbosity               = 0,
        optLevel                = 0,
788
        simplPhases             = 2,
Ian Lynagh's avatar
Ian Lynagh committed
789
        maxSimplIterations      = 4,
790
        shouldDumpSimplPhase    = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
791
        ruleCheck               = Nothing,
792
        specConstrThreshold     = Just 2000,
Ian Lynagh's avatar
Ian Lynagh committed
793
        specConstrCount         = Just 3,
794
        liberateCaseThreshold   = Just 2000,
795
        floatLamArgs            = Just 0,	-- Default: float only if no fvs
796 797
        strictnessBefore        = [],

798
        targetPlatform          = defaultTargetPlatform,
Ian Lynagh's avatar
Ian Lynagh committed
799 800 801 802 803 804
        cmdlineHcIncludes       = [],
        importPaths             = ["."],
        mainModIs               = mAIN,
        mainFunIs               = Nothing,
        ctxtStkDepth            = mAX_CONTEXT_REDUCTION_DEPTH,

chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
805
        dphBackend              = DPHNone,
806

Ian Lynagh's avatar
Ian Lynagh committed
807 808 809
        thisPackage             = mainPackageId,

        objectDir               = Nothing,
810
        dylibInstallName        = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
811 812 813 814 815 816 817
        hiDir                   = Nothing,
        stubDir                 = Nothing,

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

818 819 820
        pluginModNames          = [],
        pluginModNameOpts       = [],

Ian Lynagh's avatar
Ian Lynagh committed
821 822
        outputFile              = Nothing,
        outputHi                = Nothing,
823
        dynLibLoader            = SystemDependent,
Ian Lynagh's avatar
Ian Lynagh committed
824 825 826 827 828 829
        dumpPrefix              = Nothing,
        dumpPrefixForce         = Nothing,
        includePaths            = [],
        libraryPaths            = [],
        frameworkPaths          = [],
        cmdlineFrameworks       = [],
830
        rtsOpts                 = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
831
        rtsOptsEnabled          = RtsOptsSafeOnly,
Ian Lynagh's avatar
Ian Lynagh committed
832 833 834 835 836

        hpcDir                  = ".hpc",

        extraPkgConfs           = [],
        packageFlags            = [],
837 838
        pkgDatabase             = Nothing,
        pkgState                = panic "no package state yet: call GHC.setSessionDynFlags",
839
        ways                    = panic "defaultDynFlags: No ways",
Ian Lynagh's avatar
Ian Lynagh committed
840 841
        buildTag                = panic "defaultDynFlags: No buildTag",
        rtsBuildTag             = panic "defaultDynFlags: No rtsBuildTag",
842
        splitInfo               = Nothing,
843
        settings                = mySettings,
844 845 846 847 848 849
        -- ghc -M values
        depMakefile       = "Makefile",
        depIncludePkgDeps = False,
        depExcludeMods    = [],
        depSuffixes       = [],
        -- end of ghc -M values
850 851
        filesToClean   = panic "defaultDynFlags: No filesToClean",
        dirsToClean    = panic "defaultDynFlags: No dirsToClean",
852
        generatedDumps = panic "defaultDynFlags: No generatedDumps",
Ian Lynagh's avatar
Ian Lynagh committed
853
        haddockOptions = Nothing,
854
        flags = defaultFlags,
855
        language = Nothing,
856
        safeHaskell = Sf_None,
857 858
        extensions = [],
        extensionFlags = flattenExtensionFlags Nothing [],
859

Ian Lynagh's avatar
Ian Lynagh committed
860
        log_action = \severity srcSpan style msg ->
861
                        case severity of
862 863 864
                          SevOutput -> printSDoc msg style
                          SevInfo   -> printErrs msg style
                          SevFatal  -> printErrs msg style
865
                          _         -> do 
866
                                hPutChar stderr '\n'
867
                                printErrs (mkLocMessage srcSpan msg) style
868 869 870
                     -- 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.
871 872
      }

Ian Lynagh's avatar
Ian Lynagh committed
873
{-
874 875
Note [Verbosity levels]
~~~~~~~~~~~~~~~~~~~~~~~
Ian Lynagh's avatar
Ian Lynagh committed
876
    0   |   print errors & warnings only
877 878 879 880 881 882 883
    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"
-}

884 885 886 887 888
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
889 890 891
flattenExtensionFlags :: Maybe Language -> [OnOff ExtensionFlag]
                      -> [ExtensionFlag]
flattenExtensionFlags ml = foldr f defaultExtensionFlags
892 893
    where f (On f)  flags = f : delete f flags
          f (Off f) flags =     delete f flags
894 895 896
          defaultExtensionFlags = languageExtensions ml

languageExtensions :: Maybe Language -> [ExtensionFlag]
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
897

898
languageExtensions Nothing
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
899
    -- Nothing => the default case
900 901 902
    = Opt_MonoPatBinds   -- Experimentally, I'm making this non-standard
                         -- behaviour the default, to see if anyone notices
                         -- SLPJ July 06
Ian Lynagh's avatar
Ian Lynagh committed
903
      -- In due course I'd like Opt_MonoLocalBinds to be on by default
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
904
      -- But NB it's implied by GADTs etc
Ian Lynagh's avatar
Ian Lynagh committed
905
      -- SLPJ September 2010
906
    : Opt_NondecreasingIndentation -- This has been on by default for some time
907 908 909 910 911
    : delete Opt_DatatypeContexts  -- The Haskell' committee decided to
                                   -- remove datatype contexts from the
                                   -- language:
   -- http://www.haskell.org/pipermail/haskell-prime/2011-January/003335.html
      (languageExtensions (Just Haskell2010))
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
912

913 914 915 916
languageExtensions (Just Haskell98)
    = [Opt_ImplicitPrelude,
       Opt_MonomorphismRestriction,
       Opt_NPlusKPatterns,
917 918 919 920 921 922 923 924
       Opt_DatatypeContexts,
       Opt_NondecreasingIndentation
           -- strictly speaking non-standard, but we always had this
           -- on implicitly before the option was added in 7.1, and
           -- turning it off breaks code, so we're keeping it on for
           -- backwards compatibility.  Cabal uses -XHaskell98 by
           -- default unless you specify another language.
      ]
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
925

926 927 928 929 930 931 932
languageExtensions (Just Haskell2010)
    = [Opt_ImplicitPrelude,
       Opt_MonomorphismRestriction,
       Opt_DatatypeContexts,
       Opt_EmptyDataDecls,
       Opt_ForeignFunctionInterface,
       Opt_PatternGuards,
Ian Lynagh's avatar
Ian Lynagh committed
933
       Opt_DoAndIfThenElse,
934
       Opt_RelaxedPolyRec]
935

936
-- | Test whether a 'DynFlag' is set
937 938
dopt :: DynFlag -> DynFlags -> Bool
dopt f dflags  = f `elem`