DynFlags.hs 120 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 15 16
{-# OPTIONS_GHC -fno-warn-missing-fields #-}
-- So that tracingSettings works properly

17
module DynFlags (
18
        -- * Dynamic flags and associated configuration types
Ian Lynagh's avatar
Ian Lynagh committed
19
        DynFlag(..),
20
        WarningFlag(..),
21
        ExtensionFlag(..),
22
        Language(..),
Ian Lynagh's avatar
Ian Lynagh committed
23
        FatalMessager, LogAction, FlushOut(..), FlushErr(..),
24
        ProfAuto(..),
25
        glasgowExtsFlags,
26 27 28
        dopt,
        dopt_set,
        dopt_unset,
29 30 31
        wopt,
        wopt_set,
        wopt_unset,
32 33 34
        xopt,
        xopt_set,
        xopt_unset,
35
        lang_set,
Ian Lynagh's avatar
Ian Lynagh committed
36
        DynFlags(..),
Ian Lynagh's avatar
Ian Lynagh committed
37
        HasDynFlags(..), ContainsDynFlags(..),
Ian Lynagh's avatar
Ian Lynagh committed
38
        RtsOptsEnabled(..),
Ian Lynagh's avatar
Ian Lynagh committed
39
        HscTarget(..), isObjectTarget, defaultObjectTarget,
40
        targetRetainsAllBindings,
Ian Lynagh's avatar
Ian Lynagh committed
41 42 43
        GhcMode(..), isOneShot,
        GhcLink(..), isNoLink,
        PackageFlag(..),
44
        PkgConfRef(..),
Ian Lynagh's avatar
Ian Lynagh committed
45
        Option(..), showOpt,
Ian Lynagh's avatar
Ian Lynagh committed
46
        DynLibLoader(..),
47
        fFlags, fWarningFlags, fLangFlags, xFlags,
48
        wayNames, dynFlagDependencies,
49

50 51
        printOutputForUser, printInfoForUser,

52
        -- ** Safe Haskell
53
        SafeHaskellMode(..),
54
        safeHaskellOn, safeImportsOn, safeLanguageOn, safeInferOn,
55
        packageTrustOn,
56
        safeDirectImpsReq, safeImplicitImpsReq,
57
        unsafeFlags,
58

59
        -- ** System tool settings and locations
60
        Settings(..),
61
        targetPlatform,
62 63 64 65
        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
66
        opt_L, opt_P, opt_F, opt_c, opt_a, opt_l,
67
        opt_windres, opt_lo, opt_lc,
68 69


70
        -- ** Manipulating DynFlags
71
        defaultDynFlags,                -- Settings -> DynFlags
Ian Lynagh's avatar
Ian Lynagh committed
72
        initDynFlags,                   -- DynFlags -> IO DynFlags
Ian Lynagh's avatar
Ian Lynagh committed
73
        defaultFatalMessager,
74
        defaultLogAction,
75
        defaultLogActionHPrintDoc,
76 77
        defaultFlushOut,
        defaultFlushErr,
Ian Lynagh's avatar
Ian Lynagh committed
78

79
        getOpts,                        -- DynFlags -> (DynFlags -> [a]) -> [a]
80
        getVerbFlags,
Ian Lynagh's avatar
Ian Lynagh committed
81 82 83
        updOptLevel,
        setTmpDir,
        setPackageName,
84
        doingTickyProfiling,
Ian Lynagh's avatar
Ian Lynagh committed
85

86
        -- ** Parsing DynFlags
87 88
        parseDynamicFlagsCmdLine,
        parseDynamicFilePragma,
89 90 91
        parseDynamicFlagsFull,

        -- ** Available DynFlags
92
        allFlags,
93 94 95
        flagsAll,
        flagsDynamic,
        flagsPackage,
96

97
        supportedLanguagesAndExtensions,
98 99

        -- ** DynFlag C compiler options
Ian Lynagh's avatar
Ian Lynagh committed
100
        picCCOpts, picPOpts,
101 102 103 104 105 106

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

        -- * Compiler configuration suitable for display to the user
107 108
        compilerInfo,

109
#ifdef GHCI
dterei's avatar
dterei committed
110
-- Only in stage 2 can we be sure that the RTS
111
-- exposes the appropriate runtime boolean
112
        rtsIsProfiled,
113
#endif
114 115
        -- ** Only for use in the tracing functions in Outputable
        tracingDynFlags,
116 117 118 119
  ) where

#include "HsVersions.h"

120
import Platform
121
import Module
Simon Marlow's avatar
Simon Marlow committed
122
import PackageConfig
123
import PrelNames        ( mAIN )
124
import StaticFlags
125
import {-# SOURCE #-} Packages (PackageState)
Ian Lynagh's avatar
Ian Lynagh committed
126
import DriverPhases     ( Phase(..), phaseInputExt )
127 128
import Config
import CmdLineParser
Ian Lynagh's avatar
Ian Lynagh committed
129
import Constants        ( mAX_CONTEXT_REDUCTION_DEPTH )
130
import Panic
131
import Util
132
import Maybes           ( orElse )
133
import qualified Pretty
134
import SrcLoc
135
import FastString
Simon Marlow's avatar
Simon Marlow committed
136
import Outputable
Ian Lynagh's avatar
Ian Lynagh committed
137
#ifdef GHCI
Ian Lynagh's avatar
Ian Lynagh committed
138
import Foreign.C        ( CInt(..) )
Ian Lynagh's avatar
Ian Lynagh committed
139
#endif
140
import {-# SOURCE #-} ErrUtils ( Severity(..), MsgDoc, mkLocMessage )
141

Ian Lynagh's avatar
Ian Lynagh committed
142
#ifdef GHCI
143
import System.IO.Unsafe ( unsafePerformIO )
Ian Lynagh's avatar
Ian Lynagh committed
144
#endif
145
import Data.IORef
Ian Lynagh's avatar
Ian Lynagh committed
146
import Control.Monad    ( when )
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
147

148
import Data.Char
149
import Data.List
150 151
import Data.Map (Map)
import qualified Data.Map as Map
152 153
import Data.Set (Set)
import qualified Data.Set as Set
Ian Lynagh's avatar
Ian Lynagh committed
154
import System.FilePath
155
import System.IO
156

157 158 159
import Data.IntSet (IntSet)
import qualified Data.IntSet as IntSet

160 161 162
-- -----------------------------------------------------------------------------
-- DynFlags

163
-- | Enumerates the simple on-or-off dynamic flags
164 165 166 167
data DynFlag

   -- debugging flags
   = Opt_D_dump_cmm
168
   | Opt_D_dump_raw_cmm
169
   | Opt_D_dump_cmmz
170 171
   -- All of the cmmz subflags (there are a lot!)  Automatically
   -- enabled if you run -ddump-cmmz
Simon Marlow's avatar
Simon Marlow committed
172
   | Opt_D_dump_cmmz_cfg
173 174 175 176 177 178 179 180 181 182 183 184 185
   | 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
186
   | Opt_D_dump_cps_cmm
187
   | Opt_D_dump_cvt_cmm
188
   | Opt_D_dump_asm
189 190
   | Opt_D_dump_asm_native
   | Opt_D_dump_asm_liveness
191
   | Opt_D_dump_asm_coalesce
192 193 194
   | Opt_D_dump_asm_regalloc
   | Opt_D_dump_asm_regalloc_stages
   | Opt_D_dump_asm_conflicts
195
   | Opt_D_dump_asm_stats
196
   | Opt_D_dump_asm_expanded
197
   | Opt_D_dump_llvm
198
   | Opt_D_dump_core_stats
199 200 201 202 203 204
   | Opt_D_dump_cpranal
   | Opt_D_dump_deriv
   | Opt_D_dump_ds
   | Opt_D_dump_flatC
   | Opt_D_dump_foreign
   | Opt_D_dump_inlinings
205
   | Opt_D_dump_rule_firings
206
   | Opt_D_dump_rule_rewrites
207 208 209
   | Opt_D_dump_occur_anal
   | Opt_D_dump_parsed
   | Opt_D_dump_rn
210
   | Opt_D_dump_core_pipeline -- TODO FIXME: dump after simplifier stats
211 212
   | Opt_D_dump_simpl
   | Opt_D_dump_simpl_iterations
213
   | Opt_D_dump_simpl_phases
214 215 216 217 218 219 220 221 222 223 224 225 226
   | 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
227
   | Opt_D_dump_cs_trace -- Constraint solver in type checker
228 229
   | Opt_D_dump_tc_trace
   | Opt_D_dump_if_trace
230
   | Opt_D_dump_vt_trace
231 232 233
   | Opt_D_dump_splices
   | Opt_D_dump_BCOs
   | Opt_D_dump_vect
234
   | Opt_D_dump_avoid_vect
235
   | Opt_D_dump_ticked
pepe's avatar
pepe committed
236
   | Opt_D_dump_rtti
237 238 239 240 241 242
   | 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
243
   | Opt_D_dump_mod_cycles
244
   | Opt_D_dump_view_pattern_commoning
245
   | Opt_D_faststring_stats
Ian Lynagh's avatar
Ian Lynagh committed
246
   | Opt_DumpToFile                     -- ^ Append dump output to files instead of stdout.
Simon Marlow's avatar
Simon Marlow committed
247
   | Opt_D_no_debug_output
248 249 250
   | Opt_DoCoreLinting
   | Opt_DoStgLinting
   | Opt_DoCmmLinting
Ben.Lippmeier@anu.edu.au's avatar
Ben.Lippmeier@anu.edu.au committed
251
   | Opt_DoAsmLinting
252
   | Opt_NoLlvmMangler                 -- hidden flag
253

Ian Lynagh's avatar
Ian Lynagh committed
254
   | Opt_WarnIsError                    -- -Werror; makes warnings fatal
255

256 257
   | Opt_PrintExplicitForalls

258 259 260
   -- optimisation opts
   | Opt_Strictness
   | Opt_FullLaziness
261 262
   | Opt_FloatIn
   | Opt_Specialise
263
   | Opt_StaticArgumentTransformation
264
   | Opt_CSE
265 266
   | Opt_LiberateCase
   | Opt_SpecConstr
267 268 269 270 271
   | Opt_DoLambdaEtaExpansion
   | Opt_IgnoreAsserts
   | Opt_DoEtaReduction
   | Opt_CaseMerge
   | Opt_UnboxStrictFields
272
   | Opt_DictsCheap
273
   | Opt_EnableRewriteRules             -- Apply rewrite rules during simplification
rl@cse.unsw.edu.au's avatar
rl@cse.unsw.edu.au committed
274
   | Opt_Vectorise
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
275
   | Opt_AvoidVect
Ian Lynagh's avatar
Ian Lynagh committed
276 277
   | Opt_RegsGraph                      -- do graph coloring register allocation
   | Opt_RegsIterative                  -- do iterative coalescing graph coloring register allocation
278
   | Opt_PedanticBottoms                -- Be picky about how we treat bottom
279 280
   | Opt_LlvmTBAA                       -- Use LLVM TBAA infastructure for improving AA (hidden flag)
   | Opt_RegLiveness                    -- Use the STG Reg liveness information (hidden flag)
281
   | Opt_IrrefutableTuples
282
   | Opt_CmmSink
283

284 285 286 287 288
   -- Interface files
   | Opt_IgnoreInterfacePragmas
   | Opt_OmitInterfacePragmas
   | Opt_ExposeAllUnfoldings

Ian Lynagh's avatar
Ian Lynagh committed
289 290
   -- profiling opts
   | Opt_AutoSccsOnIndividualCafs
291
   | Opt_ProfCountEntries
Ian Lynagh's avatar
Ian Lynagh committed
292

293 294
   -- misc opts
   | Opt_Pp
295
   | Opt_ForceRecomp
296
   | Opt_ExcessPrecision
297
   | Opt_EagerBlackHoling
298 299 300
   | Opt_NoHsMain
   | Opt_SplitObjs
   | Opt_StgStats
301
   | Opt_HideAllPackages
302
   | Opt_PrintBindResult
303
   | Opt_Haddock
David Waern's avatar
David Waern committed
304
   | Opt_HaddockOptions
305
   | Opt_Hpc_No_Auto
306
   | Opt_BreakOnException
307
   | Opt_BreakOnError
308
   | Opt_PrintEvldWithShow
309
   | Opt_PrintBindContents
310 311
   | Opt_GenManifest
   | Opt_EmbedManifest
312
   | Opt_EmitExternalCore
Ian Lynagh's avatar
Ian Lynagh committed
313
   | Opt_SharedImplib
314
   | Opt_BuildingCabalPackage
315
   | Opt_SSE2
tibbe's avatar
tibbe committed
316
   | Opt_SSE4_2
317
   | Opt_IgnoreDotGhci
318
   | Opt_GhciSandbox
Ian Lynagh's avatar
Ian Lynagh committed
319
   | Opt_GhciHistory
320
   | Opt_HelpfulErrors
321
   | Opt_DeferTypeErrors
Ian Lynagh's avatar
Ian Lynagh committed
322
   | Opt_Parallel
Ian Lynagh's avatar
Ian Lynagh committed
323
   | Opt_GranMacros
Ian Lynagh's avatar
Ian Lynagh committed
324
   | Opt_PIC
325
   | Opt_SccProfilingOn
326

327 328
   -- output style opts
   | Opt_PprCaseAsLet
329

330
   -- temporary flags
331
   | Opt_RunCPS
332
   | Opt_RunCPSZ
333
   | Opt_AutoLinkPackages
334
   | Opt_ImplicitImportQualified
335
   | Opt_TryNewCodeGen
336 337 338 339 340 341

   -- keeping stuff
   | Opt_KeepHiDiffs
   | Opt_KeepHcFiles
   | Opt_KeepSFiles
   | Opt_KeepTmpFiles
Jedai's avatar
Jedai committed
342
   | Opt_KeepRawTokenStream
343
   | Opt_KeepLlvmFiles
344

345
   -- safe haskell flags
dterei's avatar
dterei committed
346
   | Opt_DistrustAllPackages
347 348
   | Opt_PackageTrust

349
   deriving (Eq, Show, Enum)
Ian Lynagh's avatar
Ian Lynagh committed
350

351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383
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
384 385
   | Opt_WarnUnsafe
   | Opt_WarnSafe
Ian Lynagh's avatar
Ian Lynagh committed
386
   | Opt_WarnPointlessPragmas
387
   | Opt_WarnUnsupportedCallingConventions
388
   | Opt_WarnInlineRuleShadowing
389
   deriving (Eq, Show, Enum)
390

391
data Language = Haskell98 | Haskell2010
392
   deriving Enum
393

394
-- | The various Safe Haskell modes
395 396
data SafeHaskellMode
   = Sf_None
dterei's avatar
dterei committed
397
   | Sf_Unsafe
398 399
   | Sf_Trustworthy
   | Sf_Safe
400
   | Sf_SafeInferred
401 402
   deriving (Eq)

Ian Lynagh's avatar
Ian Lynagh committed
403
instance Show SafeHaskellMode where
Ian Lynagh's avatar
Ian Lynagh committed
404 405 406 407 408
    show Sf_None         = "None"
    show Sf_Unsafe       = "Unsafe"
    show Sf_Trustworthy  = "Trustworthy"
    show Sf_Safe         = "Safe"
    show Sf_SafeInferred = "Safe-Inferred"
Ian Lynagh's avatar
Ian Lynagh committed
409

410
instance Outputable SafeHaskellMode where
Ian Lynagh's avatar
Ian Lynagh committed
411
    ppr = text . show
412

413
data ExtensionFlag
414 415 416 417 418 419 420
   = Opt_Cpp
   | Opt_OverlappingInstances
   | Opt_UndecidableInstances
   | Opt_IncoherentInstances
   | Opt_MonomorphismRestriction
   | Opt_MonoPatBinds
   | Opt_MonoLocalBinds
421 422
   | Opt_RelaxedPolyRec           -- Deprecated
   | Opt_ExtendedDefaultRules     -- Use GHC's extended rules for defaulting
423 424
   | Opt_ForeignFunctionInterface
   | Opt_UnliftedFFITypes
425
   | Opt_InterruptibleFFI
426
   | Opt_CApiFFI
427
   | Opt_GHCForeignImportPrim
428 429
   | Opt_ParallelArrays           -- Syntactic support for parallel arrays
   | Opt_Arrows                   -- Arrow-notation syntax
430 431 432 433 434 435 436 437 438 439 440 441 442 443
   | 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
444
   | Opt_GADTSyntax
445
   | Opt_NPlusKPatterns
Ian Lynagh's avatar
Ian Lynagh committed
446
   | Opt_DoAndIfThenElse
447
   | Opt_RebindableSyntax
448
   | Opt_ConstraintKinds
dreixel's avatar
dreixel committed
449
   | Opt_PolyKinds                -- Kind polymorphism
dreixel's avatar
dreixel committed
450
   | Opt_DataKinds                -- Datatype promotion
451 452
   | Opt_InstanceSigs
 
453 454 455 456 457
   | Opt_StandaloneDeriving
   | Opt_DeriveDataTypeable
   | Opt_DeriveFunctor
   | Opt_DeriveTraversable
   | Opt_DeriveFoldable
458
   | Opt_DeriveGeneric            -- Allow deriving Generic/1
dreixel's avatar
dreixel committed
459
   | Opt_DefaultSignatures        -- Allow extra signatures for defmeths
460 461 462 463 464 465 466 467 468 469 470 471 472 473 474

   | 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
475
   | Opt_MonadComprehensions
476 477 478 479 480 481 482 483 484 485
   | Opt_GeneralizedNewtypeDeriving
   | Opt_RecursiveDo
   | Opt_PostfixOperators
   | Opt_TupleSections
   | Opt_PatternGuards
   | Opt_LiberalTypeSynonyms
   | Opt_Rank2Types
   | Opt_RankNTypes
   | Opt_ImpredicativeTypes
   | Opt_TypeOperators
486
   | Opt_ExplicitNamespaces
487 488 489 490 491
   | Opt_PackageImports
   | Opt_ExplicitForAll
   | Opt_AlternativeLayoutRule
   | Opt_AlternativeLayoutRuleTransitional
   | Opt_DatatypeContexts
492
   | Opt_NondecreasingIndentation
493
   | Opt_RelaxedLayout
494
   | Opt_TraditionalRecordSyntax
495
   | Opt_LambdaCase
496
   | Opt_MultiWayIf
497
   deriving (Eq, Enum, Show)
498

499 500
-- | 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
501
data DynFlags = DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
502 503 504
  ghcMode               :: GhcMode,
  ghcLink               :: GhcLink,
  hscTarget             :: HscTarget,
505
  settings              :: Settings,
506
  hscOutName            :: String,      -- ^ Name of the output file
507
  extCoreName           :: String,      -- ^ Name of the .hcr output file
508
  verbosity             :: Int,         -- ^ Verbosity level: see Note [Verbosity levels]
509 510 511
  optLevel              :: Int,         -- ^ Optimisation level
  simplPhases           :: Int,         -- ^ Number of simplifier phases
  maxSimplIterations    :: Int,         -- ^ Max simplifier iterations
512
  shouldDumpSimplPhase  :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
513
  ruleCheck             :: Maybe String,
514
  strictnessBefore      :: [Int],       -- ^ Additional demand analysis
515

516
  simplTickFactor       :: Int,         -- ^ Multiplier for simplifier ticks
517 518 519
  specConstrThreshold   :: Maybe Int,   -- ^ Threshold for SpecConstr
  specConstrCount       :: Maybe Int,   -- ^ Max number of specialisations for any one function
  liberateCaseThreshold :: Maybe Int,   -- ^ Threshold for LiberateCase
520
  floatLamArgs          :: Maybe Int,   -- ^ Arg count for lambda floating
521
                                        --   See CoreMonad.FloatOutSwitches
522

523
  cmdlineHcIncludes     :: [String],    -- ^ @\-\#includes@
Ian Lynagh's avatar
Ian Lynagh committed
524 525 526
  importPaths           :: [FilePath],
  mainModIs             :: Module,
  mainFunIs             :: Maybe String,
527
  ctxtStkDepth          :: Int,         -- ^ Typechecker context stack depth
528

529
  thisPackage           :: PackageId,   -- ^ name of package currently being compiled
530 531

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

536 537 538
  -- For object splitting
  splitInfo             :: Maybe (String,Int),

539
  -- paths etc.
Ian Lynagh's avatar
Ian Lynagh committed
540
  objectDir             :: Maybe String,
541
  dylibInstallName      :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
542 543
  hiDir                 :: Maybe String,
  stubDir               :: Maybe String,
544
  dumpDir               :: Maybe String,
545

Ian Lynagh's avatar
Ian Lynagh committed
546 547 548
  objectSuf             :: String,
  hcSuf                 :: String,
  hiSuf                 :: String,
549

Ian Lynagh's avatar
Ian Lynagh committed
550 551 552
  outputFile            :: Maybe String,
  outputHi              :: Maybe String,
  dynLibLoader          :: DynLibLoader,
553

554
  -- | This is set by 'DriverPipeline.runPipeline' based on where
Ian Lynagh's avatar
Ian Lynagh committed
555 556
  --    its output is going.
  dumpPrefix            :: Maybe FilePath,
557

558 559
  -- | Override the 'dumpPrefix' set by 'DriverPipeline.runPipeline'.
  --    Set by @-ddump-file-prefix@
Ian Lynagh's avatar
Ian Lynagh committed
560 561 562 563 564 565 566
  dumpPrefixForce       :: Maybe FilePath,

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

567
  rtsOpts               :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
568
  rtsOptsEnabled        :: RtsOptsEnabled,
569

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

572 573 574 575
  -- Plugins
  pluginModNames        :: [ModuleName],
  pluginModNameOpts     :: [(ModuleName,String)],

576 577 578 579 580 581
  --  For ghc -M
  depMakefile           :: FilePath,
  depIncludePkgDeps     :: Bool,
  depExcludeMods        :: [ModuleName],
  depSuffixes           :: [String],

582
  --  Package flags
583
  extraPkgConfs         :: [PkgConfRef] -> [PkgConfRef],
584
        -- ^ The @-package-db@ flags given on the command line, in the order
Ian Lynagh's avatar
Ian Lynagh committed
585
        -- they appeared.
586

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

590
  -- Package state
Ian Lynagh's avatar
Ian Lynagh committed
591
  -- NB. do not modify this field, it is calculated by
592
  -- Packages.initPackages and Packages.updatePackages.
593
  pkgDatabase           :: Maybe [PackageConfig],
Ian Lynagh's avatar
Ian Lynagh committed
594
  pkgState              :: PackageState,
595

596 597 598 599
  -- Temporary files
  -- These have to be IORefs, because the defaultCleanupHandler needs to
  -- know what to clean when an exception happens
  filesToClean          :: IORef [FilePath],
600
  dirsToClean           :: IORef (Map FilePath FilePath),
601

602 603 604 605 606
  -- 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),

607
  -- hsc dynamic flags
608 609
  flags                 :: IntSet,
  warningFlags          :: IntSet,
610
  -- Don't change this without updating extensionFlags:
611
  language              :: Maybe Language,
612 613
  -- | Safe Haskell mode
  safeHaskell           :: SafeHaskellMode,
614 615 616
  -- We store the location of where some extension and flags were turned on so
  -- we can produce accurate error messages when Safe Haskell fails due to
  -- them.
617 618
  thOnLoc               :: SrcSpan,
  newDerivOnLoc         :: SrcSpan,
619
  pkgTrustOnLoc         :: SrcSpan,
620 621
  warnSafeOnLoc         :: SrcSpan,
  warnUnsafeOnLoc       :: SrcSpan,
622 623 624 625
  -- Don't change this without updating extensionFlags:
  extensions            :: [OnOff ExtensionFlag],
  -- extensionFlags should always be equal to
  --     flattenExtensionFlags language extensions
626
  extensionFlags        :: IntSet,
Ian Lynagh's avatar
Ian Lynagh committed
627

628
  -- | MsgDoc output action: use "ErrUtils" instead of this if you can
629
  log_action            :: LogAction,
630 631
  flushOut              :: FlushOut,
  flushErr              :: FlushErr,
David Waern's avatar
David Waern committed
632

633
  haddockOptions        :: Maybe String,
634
  ghciScripts           :: [String],
635

636 637
  -- Output style options
  pprUserLength         :: Int,
Ian Lynagh's avatar
Ian Lynagh committed
638
  pprCols               :: Int,
Ian Lynagh's avatar
Ian Lynagh committed
639
  traceLevel            :: Int, -- Standard level is 1. Less verbose is 0.
640 641

  -- | what kind of {-# SCC #-} to add automatically
642 643
  profAuto              :: ProfAuto,

644
  interactivePrint      :: Maybe String,
645

646
  llvmVersion           :: IORef (Int)
647 648
 }

649 650 651
class HasDynFlags m where
    getDynFlags :: m DynFlags

Ian Lynagh's avatar
Ian Lynagh committed
652 653 654
class ContainsDynFlags t where
    extractDynFlags :: t -> DynFlags

655 656 657 658 659
data ProfAuto
  = NoProfAuto         -- ^ no SCC annotations added
  | ProfAutoAll        -- ^ top-level and nested functions are annotated
  | ProfAutoTop        -- ^ top-level functions annotated only
  | ProfAutoExports    -- ^ exported functions annotated only
660
  | ProfAutoCalls      -- ^ annotate call-sites
Simon Marlow's avatar
Simon Marlow committed
661
  deriving (Enum)
662

663
data Settings = Settings {
664
  sTargetPlatform        :: Platform,    -- Filled in by SysTools
665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686
  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
687 688 689 690 691 692 693 694 695 696 697 698
  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

699 700
 }

701 702 703
targetPlatform :: DynFlags -> Platform
targetPlatform dflags = sTargetPlatform (settings dflags)

704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743
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)
744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761
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)
762

763 764 765
wayNames :: DynFlags -> [WayName]
wayNames = map wayName . ways

766 767
-- | The target code type of the compilation (if any).
--
768 769 770
-- Whenever you change the target, also make sure to set 'ghcLink' to
-- something sensible.
--
771 772 773 774
-- 'HscNothing' can be used to avoid generating any output, however, note
-- that:
--
--  * This will not run the desugaring step, thus no warnings generated in
775 776 777
--    this step will be output.  In particular, this includes warnings related
--    to pattern matching.  You can run the desugarer manually using
--    'GHC.desugarModule'.
778
--
779 780 781 782
--  * If a program uses Template Haskell the typechecker may try to run code
--    from an imported module.  This will fail if no code has been generated
--    for this module.  You can use 'GHC.needsTemplateHaskell' to detect
--    whether this might be the case and choose to either switch to a
SimonHengel's avatar
SimonHengel committed
783
--    different target or avoid typechecking such modules.  (The latter may be
784
--    preferable for security reasons.)
785
--
786
data HscTarget
787 788
  = HscC           -- ^ Generate C code.
  | HscAsm         -- ^ Generate assembly using the native code generator.
789
  | HscLlvm        -- ^ Generate assembly using the llvm code generator.
790 791
  | HscInterpreted -- ^ Generate bytecode.  (Requires 'LinkInMemory')
  | HscNothing     -- ^ Don't generate any code.  See notes above.
792 793
  deriving (Eq, Show)

Ian Lynagh's avatar
Ian Lynagh committed
794 795 796 797 798 799 800
showHscTargetFlag :: HscTarget -> String
showHscTargetFlag HscC           = "-fvia-c"
showHscTargetFlag HscAsm         = "-fasm"
showHscTargetFlag HscLlvm        = "-fllvm"
showHscTargetFlag HscInterpreted = "-fbyte-code"
showHscTargetFlag HscNothing     = "-fno-code"

801
-- | Will this target result in an object file on the disk?
802 803 804
isObjectTarget :: HscTarget -> Bool
isObjectTarget HscC     = True
isObjectTarget HscAsm   = True
805
isObjectTarget HscLlvm  = True
806 807
isObjectTarget _        = False

808 809 810 811 812 813 814 815 816 817 818
-- | Does this target retain *all* top-level bindings for a module,
-- rather than just the exported bindings, in the TypeEnv and compiled
-- code (if any)?  In interpreted mode we do this, so that GHCi can
-- call functions inside a module.  In HscNothing mode we also do it,
-- so that Haddock can get access to the GlobalRdrEnv for a module
-- after typechecking it.
targetRetainsAllBindings :: HscTarget -> Bool
targetRetainsAllBindings HscInterpreted = True
targetRetainsAllBindings HscNothing     = True
targetRetainsAllBindings _              = False

819 820 821 822 823 824
-- | 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.
825
data GhcMode
826 827 828
  = CompManager         -- ^ @\-\-make@, GHCi, etc.
  | OneShot             -- ^ @ghc -c Foo.hs@
  | MkDepend            -- ^ @ghc -M@, see "Finder" for why we need this
829 830
  deriving Eq

831 832 833 834 835
instance Outputable GhcMode where
  ppr CompManager = ptext (sLit "CompManager")
  ppr OneShot     = ptext (sLit "OneShot")
  ppr MkDepend    = ptext (sLit "MkDepend")

836 837 838 839
isOneShot :: GhcMode -> Bool
isOneShot OneShot = True
isOneShot _other  = False

840 841 842 843
-- | 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
844 845
  | LinkInMemory        -- ^ Use the in-memory dynamic linker (works for both
                        --   bytecode and object code).
846
  | LinkDynLib          -- ^ Link objects into a dynamic lib (DLL on Windows, DSO on ELF platforms)
847
  deriving (Eq, Show)
848 849 850

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

853 854 855
-- Is it worth evaluating this Bool and caching it in the DynFlags value
-- during initDynFlags?
doingTickyProfiling :: DynFlags -> Bool
856 857 858
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.
859

860
data PackageFlag
861
  = ExposePackage   String
862
  | ExposePackageId String
863 864 865 866
  | HidePackage     String
  | IgnorePackage   String
  | TrustPackage    String
  | DistrustPackage String
867
  deriving Eq
868

twanvl's avatar
twanvl committed
869
defaultHscTarget :: HscTarget
870 871
defaultHscTarget = defaultObjectTarget

872
-- | The 'HscTarget' value corresponding to the default way to create
873
-- object files on the current platform.
twanvl's avatar
twanvl committed
874
defaultObjectTarget :: HscTarget
875
defaultObjectTarget
876
  | cGhcUnregisterised    == "YES"      =  HscC
Ian Lynagh's avatar
Ian Lynagh committed
877
  | cGhcWithNativeCodeGen == "YES"      =  HscAsm
878
  | otherwise                           =  HscLlvm
879

880 881 882 883 884
data DynLibLoader
  = Deployable
  | SystemDependent
  deriving Eq

Ian Lynagh's avatar
Ian Lynagh committed
885
data RtsOptsEnabled = RtsOptsNone | RtsOptsSafeOnly | RtsOptsAll
886
  deriving (Show)
Ian Lynagh's avatar
Ian Lynagh committed