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

40
        -- ** Safe Haskell
41
        SafeHaskellMode(..),
42 43
        safeHaskellOn, safeLanguageOn,
        safeDirectImpsReq, safeImplicitImpsReq,
44

45
        -- ** System tool settings and locations
46 47 48 49 50
        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,
Ian Lynagh's avatar
Ian Lynagh committed
51
        opt_L, opt_P, opt_F, opt_c, opt_a, opt_l,
52
        opt_windres, opt_lo, opt_lc,
53 54


55
        -- ** Manipulating DynFlags
56
        defaultDynFlags,                -- Settings -> DynFlags
Ian Lynagh's avatar
Ian Lynagh committed
57
        initDynFlags,                   -- DynFlags -> IO DynFlags
58
        defaultLogAction,
Ian Lynagh's avatar
Ian Lynagh committed
59

60
        getOpts,                        -- DynFlags -> (DynFlags -> [a]) -> [a]
61
        getVerbFlags,
Ian Lynagh's avatar
Ian Lynagh committed
62 63 64
        updOptLevel,
        setTmpDir,
        setPackageName,
65
        doingTickyProfiling,
Ian Lynagh's avatar
Ian Lynagh committed
66

67
        -- ** Parsing DynFlags
68 69
        parseDynamicFlagsCmdLine,
        parseDynamicFilePragma,
70
        allFlags,
71

72
        supportedLanguagesAndExtensions,
73 74

        -- ** DynFlag C compiler options
75
        picCCOpts,
76 77 78 79 80 81

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

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

#include "HsVersions.h"

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

Ian Lynagh's avatar
Ian Lynagh committed
113
#ifdef GHCI
114
import System.IO.Unsafe ( unsafePerformIO )
Ian Lynagh's avatar
Ian Lynagh committed
115
#endif
116
import Data.IORef
Ian Lynagh's avatar
Ian Lynagh committed
117
import Control.Monad    ( when )
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
118

119
import Data.Char
120
import Data.List
121 122
import Data.Map (Map)
import qualified Data.Map as Map
123 124
import Data.Set (Set)
import qualified Data.Set as Set
Ian Lynagh's avatar
Ian Lynagh committed
125
import System.FilePath
126
import System.IO        ( stderr, hPutChar )
127

128 129 130
-- -----------------------------------------------------------------------------
-- DynFlags

131
-- | Enumerates the simple on-or-off dynamic flags
132 133 134 135
data DynFlag

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

Ian Lynagh's avatar
Ian Lynagh committed
220
   | Opt_WarnIsError                    -- -Werror; makes warnings fatal
221

222 223
   | Opt_PrintExplicitForalls

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

244 245 246 247 248
   -- Interface files
   | Opt_IgnoreInterfacePragmas
   | Opt_OmitInterfacePragmas
   | Opt_ExposeAllUnfoldings

Ian Lynagh's avatar
Ian Lynagh committed
249 250 251 252 253
   -- profiling opts
   | Opt_AutoSccsOnAllToplevs
   | Opt_AutoSccsOnExportedToplevs
   | Opt_AutoSccsOnIndividualCafs

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

284
   -- temporary flags
285
   | Opt_RunCPS
286
   | Opt_RunCPSZ
287
   | Opt_AutoLinkPackages
288
   | Opt_ImplicitImportQualified
289
   | Opt_TryNewCodeGen
290 291 292 293 294 295

   -- keeping stuff
   | Opt_KeepHiDiffs
   | Opt_KeepHcFiles
   | Opt_KeepSFiles
   | Opt_KeepTmpFiles
Jedai's avatar
Jedai committed
296
   | Opt_KeepRawTokenStream
297
   | Opt_KeepLlvmFiles
298

299
   deriving (Eq, Show)
Ian Lynagh's avatar
Ian Lynagh committed
300

301 302 303 304 305 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
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)

336 337
data Language = Haskell98 | Haskell2010

338
-- | The various Safe Haskell modes
339 340 341 342 343 344 345
data SafeHaskellMode
   = Sf_None
   | Sf_SafeImports
   | Sf_Trustworthy
   | Sf_Safe
   deriving (Eq)

346 347 348 349 350
instance Outputable SafeHaskellMode where
    ppr Sf_None = ptext $ sLit "None"
    ppr Sf_SafeImports = ptext $ sLit "SafeImports"
    ppr Sf_Trustworthy = ptext $ sLit "Trustworthy"
    ppr Sf_Safe = ptext $ sLit "Safe"
351

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

388 389 390 391 392
   | Opt_StandaloneDeriving
   | Opt_DeriveDataTypeable
   | Opt_DeriveFunctor
   | Opt_DeriveTraversable
   | Opt_DeriveFoldable
393
   | Opt_DeriveGeneric            -- Allow deriving Generic/1
dreixel's avatar
dreixel committed
394
   | Opt_DefaultSignatures        -- Allow extra signatures for defmeths
395 396 397 398 399 400 401 402 403 404 405 406 407 408 409

   | 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
410
   | Opt_MonadComprehensions
411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426
   | 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
427
   | Opt_NondecreasingIndentation
428
   | Opt_RelaxedLayout
429
   | Opt_TraditionalRecordSyntax
430 431
   deriving (Eq, Show)

432 433
-- | 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
434
data DynFlags = DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
435 436 437
  ghcMode               :: GhcMode,
  ghcLink               :: GhcLink,
  hscTarget             :: HscTarget,
438
  hscOutName            :: String,      -- ^ Name of the output file
439
  extCoreName           :: String,      -- ^ Name of the .hcr output file
440
  verbosity             :: Int,         -- ^ Verbosity level: see Note [Verbosity levels]
441 442 443
  optLevel              :: Int,         -- ^ Optimisation level
  simplPhases           :: Int,         -- ^ Number of simplifier phases
  maxSimplIterations    :: Int,         -- ^ Max simplifier iterations
444
  shouldDumpSimplPhase  :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
445
  ruleCheck             :: Maybe String,
446
  strictnessBefore      :: [Int],       -- ^ Additional demand analysis
447

448
  simplTickFactor       :: Int,         -- ^ Multiplier for simplifier ticks
449 450 451
  specConstrThreshold   :: Maybe Int,   -- ^ Threshold for SpecConstr
  specConstrCount       :: Maybe Int,   -- ^ Max number of specialisations for any one function
  liberateCaseThreshold :: Maybe Int,   -- ^ Threshold for LiberateCase
452
  floatLamArgs          :: Maybe Int,   -- ^ Arg count for lambda floating
453
                                        --   See CoreMonad.FloatOutSwitches
454

Ian Lynagh's avatar
Ian Lynagh committed
455
  targetPlatform        :: Platform.Platform, -- ^ The platform we're compiling for. Used by the NCG.
456
  cmdlineHcIncludes     :: [String],    -- ^ @\-\#includes@
Ian Lynagh's avatar
Ian Lynagh committed
457 458 459
  importPaths           :: [FilePath],
  mainModIs             :: Module,
  mainFunIs             :: Maybe String,
460
  ctxtStkDepth          :: Int,         -- ^ Typechecker context stack depth
461

462 463
  dphBackend            :: DPHBackend,

464
  thisPackage           :: PackageId,   -- ^ name of package currently being compiled
465 466

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

471 472 473
  -- For object splitting
  splitInfo             :: Maybe (String,Int),

474
  -- paths etc.
Ian Lynagh's avatar
Ian Lynagh committed
475
  objectDir             :: Maybe String,
476
  dylibInstallName      :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
477 478
  hiDir                 :: Maybe String,
  stubDir               :: Maybe String,
479

Ian Lynagh's avatar
Ian Lynagh committed
480 481 482
  objectSuf             :: String,
  hcSuf                 :: String,
  hiSuf                 :: String,
483

Ian Lynagh's avatar
Ian Lynagh committed
484 485 486
  outputFile            :: Maybe String,
  outputHi              :: Maybe String,
  dynLibLoader          :: DynLibLoader,
487

488
  -- | This is set by 'DriverPipeline.runPipeline' based on where
Ian Lynagh's avatar
Ian Lynagh committed
489 490
  --    its output is going.
  dumpPrefix            :: Maybe FilePath,
491

492 493
  -- | Override the 'dumpPrefix' set by 'DriverPipeline.runPipeline'.
  --    Set by @-ddump-file-prefix@
Ian Lynagh's avatar
Ian Lynagh committed
494 495 496 497 498 499 500
  dumpPrefixForce       :: Maybe FilePath,

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

501
  rtsOpts               :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
502
  rtsOptsEnabled        :: RtsOptsEnabled,
503

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

506 507 508 509
  -- Plugins
  pluginModNames        :: [ModuleName],
  pluginModNameOpts     :: [(ModuleName,String)],

510
  settings              :: Settings,
511

512 513 514 515 516 517
  --  For ghc -M
  depMakefile           :: FilePath,
  depIncludePkgDeps     :: Bool,
  depExcludeMods        :: [ModuleName],
  depSuffixes           :: [String],

518
  --  Package flags
Ian Lynagh's avatar
Ian Lynagh committed
519
  extraPkgConfs         :: [FilePath],
520
        -- ^ The @-package-conf@ flags given on the command line, in the order
Ian Lynagh's avatar
Ian Lynagh committed
521
        -- they appeared.
522

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

526
  -- Package state
Ian Lynagh's avatar
Ian Lynagh committed
527
  -- NB. do not modify this field, it is calculated by
528
  -- Packages.initPackages and Packages.updatePackages.
529
  pkgDatabase           :: Maybe [PackageConfig],
Ian Lynagh's avatar
Ian Lynagh committed
530
  pkgState              :: PackageState,
531

532 533 534 535
  -- Temporary files
  -- These have to be IORefs, because the defaultCleanupHandler needs to
  -- know what to clean when an exception happens
  filesToClean          :: IORef [FilePath],
536
  dirsToClean           :: IORef (Map FilePath FilePath),
537

538 539 540 541 542
  -- 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),

543
  -- hsc dynamic flags
Ian Lynagh's avatar
Ian Lynagh committed
544
  flags                 :: [DynFlag],
545
  warningFlags          :: [WarningFlag],
546
  -- Don't change this without updating extensionFlags:
547
  language              :: Maybe Language,
548 549
  -- | Safe Haskell mode
  safeHaskell           :: SafeHaskellMode,
550 551 552 553 554
  -- 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,
555 556 557 558 559
  -- 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
560

561
  -- | Message output action: use "ErrUtils" instead of this if you can
562
  log_action            :: LogAction,
David Waern's avatar
David Waern committed
563 564

  haddockOptions :: Maybe String
565 566
 }

567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589
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
590 591 592 593 594 595 596 597 598 599 600 601
  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

602 603 604 605 606 607 608 609 610 611 612 613 614 615 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
 }

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)
644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661
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)
662

663 664 665
wayNames :: DynFlags -> [WayName]
wayNames = map wayName . ways

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

Ian Lynagh's avatar
Ian Lynagh committed
694 695 696 697 698 699 700
showHscTargetFlag :: HscTarget -> String
showHscTargetFlag HscC           = "-fvia-c"
showHscTargetFlag HscAsm         = "-fasm"
showHscTargetFlag HscLlvm        = "-fllvm"
showHscTargetFlag HscInterpreted = "-fbyte-code"
showHscTargetFlag HscNothing     = "-fno-code"

701
-- | Will this target result in an object file on the disk?
702 703 704
isObjectTarget :: HscTarget -> Bool
isObjectTarget HscC     = True
isObjectTarget HscAsm   = True
705
isObjectTarget HscLlvm  = True
706 707 708 709 710 711 712 713
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.
714
data GhcMode
715 716 717
  = CompManager         -- ^ @\-\-make@, GHCi, etc.
  | OneShot             -- ^ @ghc -c Foo.hs@
  | MkDepend            -- ^ @ghc -M@, see "Finder" for why we need this
718 719
  deriving Eq

720 721 722 723 724
instance Outputable GhcMode where
  ppr CompManager = ptext (sLit "CompManager")
  ppr OneShot     = ptext (sLit "OneShot")
  ppr MkDepend    = ptext (sLit "MkDepend")

725 726 727 728
isOneShot :: GhcMode -> Bool
isOneShot OneShot = True
isOneShot _other  = False

729 730 731 732
-- | 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
733 734
  | LinkInMemory        -- ^ Use the in-memory dynamic linker (works for both
                        --   bytecode and object code).
735
  | LinkDynLib          -- ^ Link objects into a dynamic lib (DLL on Windows, DSO on ELF platforms)
736
  deriving (Eq, Show)
737 738 739

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

742 743 744
-- Is it worth evaluating this Bool and caching it in the DynFlags value
-- during initDynFlags?
doingTickyProfiling :: DynFlags -> Bool
745 746 747
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.
748

749
data PackageFlag
750
  = ExposePackage   String
751
  | ExposePackageId String
752 753 754 755
  | HidePackage     String
  | IgnorePackage   String
  | TrustPackage    String
  | DistrustPackage String
756
  deriving Eq
757

twanvl's avatar
twanvl committed
758
defaultHscTarget :: HscTarget
759 760
defaultHscTarget = defaultObjectTarget

761
-- | The 'HscTarget' value corresponding to the default way to create
762
-- object files on the current platform.
twanvl's avatar
twanvl committed
763
defaultObjectTarget :: HscTarget
764
defaultObjectTarget
765
  | cGhcUnregisterised    == "YES"      =  HscC
Ian Lynagh's avatar
Ian Lynagh committed
766
  | cGhcWithNativeCodeGen == "YES"      =  HscAsm
767
  | otherwise                           =  HscLlvm
768

769 770 771 772 773
data DynLibLoader
  = Deployable
  | SystemDependent
  deriving Eq

Ian Lynagh's avatar
Ian Lynagh committed
774
data RtsOptsEnabled = RtsOptsNone | RtsOptsSafeOnly | RtsOptsAll
775
  deriving (Show)
Ian Lynagh's avatar
Ian Lynagh committed
776

777
-- | Used by 'GHC.newSession' to partially initialize a new 'DynFlags' value
twanvl's avatar
twanvl committed
778
initDynFlags :: DynFlags -> IO DynFlags
779 780 781
initDynFlags dflags = do
 -- someday these will be dynamic flags
 ways <- readIORef v_Ways
782
 refFilesToClean <- newIORef []
783
 refDirsToClean <- newIORef Map.empty
784
 refGeneratedDumps <- newIORef Set.empty
785
 return dflags{
786 787 788
        ways            = ways,
        buildTag        = mkBuildTag (filter (not . wayRTSOnly) ways),
        rtsBuildTag     = mkBuildTag ways,
789
        filesToClean    = refFilesToClean,
790 791
        dirsToClean     = refDirsToClean,
        generatedDumps   = refGeneratedDumps
Ian Lynagh's avatar
Ian Lynagh committed
792
        }
793

794 795
-- | The normal 'DynFlags'. Note that they is not suitable for use in this form
-- and must be fully initialized by 'GHC.newSession' first.
796 797
defaultDynFlags :: Settings -> DynFlags
defaultDynFlags mySettings =
798
     DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
799 800 801 802 803 804 805
        ghcMode                 = CompManager,
        ghcLink                 = LinkBinary,
        hscTarget               = defaultHscTarget,
        hscOutName              = "",
        extCoreName             = "",
        verbosity               = 0,
        optLevel                = 0,
806
        simplPhases             = 2,
Ian Lynagh's avatar
Ian Lynagh committed
807
        maxSimplIterations      = 4,
808
        shouldDumpSimplPhase    = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
809
        ruleCheck               = Nothing,
dterei's avatar
dterei committed
810
        simplTickFactor         = 100,
811
        specConstrThreshold     = Just 2000,
Ian Lynagh's avatar
Ian Lynagh committed
812
        specConstrCount         = Just 3,
813
        liberateCaseThreshold   = Just 2000,
814
        floatLamArgs            = Just 0, -- Default: float only if no fvs
815 816
        strictnessBefore        = [],

817
        targetPlatform          = defaultTargetPlatform,
Ian Lynagh's avatar
Ian Lynagh committed
818 819 820 821 822 823
        cmdlineHcIncludes       = [],
        importPaths             = ["."],
        mainModIs               = mAIN,
        mainFunIs               = Nothing,
        ctxtStkDepth            = mAX_CONTEXT_REDUCTION_DEPTH,

chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
824
        dphBackend              = DPHNone,
825

Ian Lynagh's avatar
Ian Lynagh committed
826 827 828
        thisPackage             = mainPackageId,

        objectDir               = Nothing,
829
        dylibInstallName        = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
830 831 832 833 834 835 836
        hiDir                   = Nothing,
        stubDir                 = Nothing,

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

837 838 839
        pluginModNames          = [],
        pluginModNameOpts       = [],

Ian Lynagh's avatar
Ian Lynagh committed
840 841
        outputFile              = Nothing,
        outputHi                = Nothing,
842
        dynLibLoader            = SystemDependent,
Ian Lynagh's avatar
Ian Lynagh committed
843 844 845 846 847 848
        dumpPrefix              = Nothing,
        dumpPrefixForce         = Nothing,
        includePaths            = [],
        libraryPaths            = [],
        frameworkPaths          = [],
        cmdlineFrameworks       = [],
849
        rtsOpts                 = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
850
        rtsOptsEnabled          = RtsOptsSafeOnly,
Ian Lynagh's avatar
Ian Lynagh committed
851 852 853 854 855

        hpcDir                  = ".hpc",

        extraPkgConfs           = [],
        packageFlags            = [],
856 857
        pkgDatabase             = Nothing,
        pkgState                = panic "no package state yet: call GHC.setSessionDynFlags",
858
        ways                    = panic "defaultDynFlags: No ways",
Ian Lynagh's avatar
Ian Lynagh committed
859 860
        buildTag                = panic "defaultDynFlags: No buildTag",
        rtsBuildTag             = panic "defaultDynFlags: No rtsBuildTag",
861
        splitInfo               = Nothing,
862
        settings                = mySettings,
863 864 865 866 867 868
        -- ghc -M values
        depMakefile       = "Makefile",
        depIncludePkgDeps = False,
        depExcludeMods    = [],
        depSuffixes       = [],
        -- end of ghc -M values
869 870
        filesToClean   = panic "defaultDynFlags: No filesToClean",
        dirsToClean    = panic "defaultDynFlags: No dirsToClean",
871
        generatedDumps = panic "defaultDynFlags: No generatedDumps",
Ian Lynagh's avatar
Ian Lynagh committed
872
        haddockOptions = Nothing,
873
        flags = defaultFlags,
874
        warningFlags = standardWarnings,
875
        language = Nothing,
876
        safeHaskell = Sf_None,
877 878
        thOnLoc = noSrcSpan,
        newDerivOnLoc = noSrcSpan,
879 880
        extensions = [],
        extensionFlags = flattenExtensionFlags Nothing [],
881
        log_action = defaultLogAction
882 883
      }

884 885 886 887 888 889 890 891 892 893 894 895 896 897
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
898
{-
899 900
Note [Verbosity levels]
~~~~~~~~~~~~~~~~~~~~~~~
Ian Lynagh's avatar
Ian Lynagh committed
901
    0   |   print errors & warnings only
902 903 904 905 906 907 908
    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"
-}

909 910 911 912 913
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
914 915 916
flattenExtensionFlags :: Maybe Language -> [OnOff ExtensionFlag]
                      -> [ExtensionFlag]
flattenExtensionFlags ml = foldr f defaultExtensionFlags
917 918
    where f (On f)  flags = f : delete f flags
          f (Off f) flags =     delete f flags
919 920 921
          defaultExtensionFlags = languageExtensions ml

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

923
languageExtensions Nothing
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
924
    -- Nothing => the default case
925
    = Opt_NondecreasingIndentation -- This has been on by default for some time
926 927 928 929 930
    : 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
931

932 933
   -- NB: MonoPatBinds is no longer the default

934 935 936 937
languageExtensions (Just Haskell98)
    = [Opt_ImplicitPrelude,
       Opt_MonomorphismRestriction,
       Opt_NPlusKPatterns,
938
       Opt_DatatypeContexts,
939
       Opt_TraditionalRecordSyntax,
940 941 942 943 944 945 946
       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
947