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

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

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

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

326 327
   -- output style opts
   | Opt_PprCaseAsLet
328

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

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

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

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

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
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
383 384
   | Opt_WarnUnsafe
   | Opt_WarnSafe
Ian Lynagh's avatar
Ian Lynagh committed
385
   | Opt_WarnPointlessPragmas
386
   | Opt_WarnUnsupportedCallingConventions
387
   | Opt_WarnInlineRuleShadowing
388
   deriving (Eq, Show, Enum)
389

390
data Language = Haskell98 | Haskell2010
391
   deriving Enum
392

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

Ian Lynagh's avatar
Ian Lynagh committed
402
instance Show SafeHaskellMode where
Ian Lynagh's avatar
Ian Lynagh committed
403 404 405 406 407
    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
408

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

606
  -- hsc dynamic flags
607 608
  flags                 :: IntSet,
  warningFlags          :: IntSet,
609
  -- Don't change this without updating extensionFlags:
610
  language              :: Maybe Language,
611 612
  -- | Safe Haskell mode
  safeHaskell           :: SafeHaskellMode,
613 614 615
  -- 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.
616 617
  thOnLoc               :: SrcSpan,
  newDerivOnLoc         :: SrcSpan,
618
  pkgTrustOnLoc         :: SrcSpan,
619 620
  warnSafeOnLoc         :: SrcSpan,
  warnUnsafeOnLoc       :: SrcSpan,
621 622 623 624
  -- Don't change this without updating extensionFlags:
  extensions            :: [OnOff ExtensionFlag],
  -- extensionFlags should always be equal to
  --     flattenExtensionFlags language extensions
625
  extensionFlags        :: IntSet,
Ian Lynagh's avatar
Ian Lynagh committed
626

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

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

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

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

643
  interactivePrint      :: Maybe String,
644

645
  llvmVersion           :: IORef (Int)
646 647
 }

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

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

654 655 656 657 658
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
659
  | ProfAutoCalls      -- ^ annotate call-sites
Simon Marlow's avatar
Simon Marlow committed
660
  deriving (Enum)
661

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

698 699
 }

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

703 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
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)
743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760
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)
761

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

765 766
-- | The target code type of the compilation (if any).
--
767 768 769
-- Whenever you change the target, also make sure to set 'ghcLink' to
-- something sensible.
--
770 771 772 773
-- 'HscNothing' can be used to avoid generating any output, however, note
-- that:
--
--  * This will not run the desugaring step, thus no warnings generated in
774 775 776
--    this step will be output.  In particular, this includes warnings related
--    to pattern matching.  You can run the desugarer manually using
--    'GHC.desugarModule'.
777
--
778 779 780 781
--  * 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
782
--    different target or avoid typechecking such modules.  (The latter may be
783
--    preferable for security reasons.)
784
--
785
data HscTarget
786 787
  = HscC           -- ^ Generate C code.
  | HscAsm         -- ^ Generate assembly using the native code generator.
788
  | HscLlvm        -- ^ Generate assembly using the llvm code generator.
789 790
  | HscInterpreted -- ^ Generate bytecode.  (Requires 'LinkInMemory')
  | HscNothing     -- ^ Don't generate any code.  See notes above.
791 792
  deriving (Eq, Show)

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

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

807 808 809 810 811 812 813 814 815 816 817
-- | 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

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

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

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

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

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

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

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

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

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

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

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