DynFlags.hs 128 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(..),
23
        PlatformConstants(..),
Ian Lynagh's avatar
Ian Lynagh committed
24
        FatalMessager, LogAction, FlushOut(..), FlushErr(..),
25
        ProfAuto(..),
26
        glasgowExtsFlags,
27 28 29
        dopt,
        dopt_set,
        dopt_unset,
30 31 32
        wopt,
        wopt_set,
        wopt_unset,
33 34 35
        xopt,
        xopt_set,
        xopt_unset,
36
        lang_set,
Ian Lynagh's avatar
Ian Lynagh committed
37
        DynFlags(..),
Ian Lynagh's avatar
Ian Lynagh committed
38
        HasDynFlags(..), ContainsDynFlags(..),
Ian Lynagh's avatar
Ian Lynagh committed
39
        RtsOptsEnabled(..),
Ian Lynagh's avatar
Ian Lynagh committed
40
        HscTarget(..), isObjectTarget, defaultObjectTarget,
41
        targetRetainsAllBindings,
Ian Lynagh's avatar
Ian Lynagh committed
42 43 44
        GhcMode(..), isOneShot,
        GhcLink(..), isNoLink,
        PackageFlag(..),
45
        PkgConfRef(..),
Ian Lynagh's avatar
Ian Lynagh committed
46
        Option(..), showOpt,
Ian Lynagh's avatar
Ian Lynagh committed
47
        DynLibLoader(..),
48
        fFlags, fWarningFlags, fLangFlags, xFlags,
49
        dynFlagDependencies,
50
        tablesNextToCode, mkTablesNextToCode,
51

52 53
        printOutputForUser, printInfoForUser,

ian@well-typed.com's avatar
ian@well-typed.com committed
54 55
        Way(..), mkBuildTag, wayRTSOnly,

56
        -- ** Safe Haskell
57
        SafeHaskellMode(..),
58
        safeHaskellOn, safeImportsOn, safeLanguageOn, safeInferOn,
59
        packageTrustOn,
60
        safeDirectImpsReq, safeImplicitImpsReq,
61
        unsafeFlags,
62

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


74
        -- ** Manipulating DynFlags
75
        defaultDynFlags,                -- Settings -> DynFlags
Ian Lynagh's avatar
Ian Lynagh committed
76
        initDynFlags,                   -- DynFlags -> IO DynFlags
Ian Lynagh's avatar
Ian Lynagh committed
77
        defaultFatalMessager,
78
        defaultLogAction,
79
        defaultLogActionHPrintDoc,
80 81
        defaultFlushOut,
        defaultFlushErr,
Ian Lynagh's avatar
Ian Lynagh committed
82

83
        getOpts,                        -- DynFlags -> (DynFlags -> [a]) -> [a]
84
        getVerbFlags,
Ian Lynagh's avatar
Ian Lynagh committed
85 86 87 88
        updOptLevel,
        setTmpDir,
        setPackageName,

89
        -- ** Parsing DynFlags
90 91
        parseDynamicFlagsCmdLine,
        parseDynamicFilePragma,
92 93 94
        parseDynamicFlagsFull,

        -- ** Available DynFlags
95
        allFlags,
96 97 98
        flagsAll,
        flagsDynamic,
        flagsPackage,
99

100
        supportedLanguagesAndExtensions,
101 102

        -- ** DynFlag C compiler options
Ian Lynagh's avatar
Ian Lynagh committed
103
        picCCOpts, picPOpts,
104 105 106 107 108 109

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

        -- * Compiler configuration suitable for display to the user
110 111
        compilerInfo,

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

#include "../includes/dist-derivedconstants/header/GHCConstantsHaskellExports.hs"
121
        bLOCK_SIZE_W,
122 123 124 125
  ) where

#include "HsVersions.h"

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

Ian Lynagh's avatar
Ian Lynagh committed
147
#ifdef GHCI
148
import System.IO.Unsafe ( unsafePerformIO )
Ian Lynagh's avatar
Ian Lynagh committed
149
#endif
150
import Data.IORef
ian@well-typed.com's avatar
ian@well-typed.com committed
151
import Control.Monad
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
152

153
import Data.Char
154
import Data.List
155 156
import Data.Map (Map)
import qualified Data.Map as Map
157 158
import Data.Set (Set)
import qualified Data.Set as Set
Ian Lynagh's avatar
Ian Lynagh committed
159
import System.FilePath
160
import System.IO
161

162 163 164
import Data.IntSet (IntSet)
import qualified Data.IntSet as IntSet

165 166 167
-- -----------------------------------------------------------------------------
-- DynFlags

168
-- | Enumerates the simple on-or-off dynamic flags
169 170 171 172
data DynFlag

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

Ian Lynagh's avatar
Ian Lynagh committed
259
   | Opt_WarnIsError                    -- -Werror; makes warnings fatal
260

261 262
   | Opt_PrintExplicitForalls

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

290 291 292 293 294
   -- Interface files
   | Opt_IgnoreInterfacePragmas
   | Opt_OmitInterfacePragmas
   | Opt_ExposeAllUnfoldings

Ian Lynagh's avatar
Ian Lynagh committed
295 296
   -- profiling opts
   | Opt_AutoSccsOnIndividualCafs
297
   | Opt_ProfCountEntries
Ian Lynagh's avatar
Ian Lynagh committed
298

299 300
   -- misc opts
   | Opt_Pp
301
   | Opt_ForceRecomp
302
   | Opt_ExcessPrecision
303
   | Opt_EagerBlackHoling
304 305 306
   | Opt_NoHsMain
   | Opt_SplitObjs
   | Opt_StgStats
307
   | Opt_HideAllPackages
308
   | Opt_PrintBindResult
309
   | Opt_Haddock
David Waern's avatar
David Waern committed
310
   | Opt_HaddockOptions
311
   | Opt_Hpc_No_Auto
312
   | Opt_BreakOnException
313
   | Opt_BreakOnError
314
   | Opt_PrintEvldWithShow
315
   | Opt_PrintBindContents
316 317
   | Opt_GenManifest
   | Opt_EmbedManifest
318
   | Opt_EmitExternalCore
Ian Lynagh's avatar
Ian Lynagh committed
319
   | Opt_SharedImplib
320
   | Opt_BuildingCabalPackage
321
   | Opt_SSE2
tibbe's avatar
tibbe committed
322
   | Opt_SSE4_2
323
   | Opt_IgnoreDotGhci
324
   | Opt_GhciSandbox
Ian Lynagh's avatar
Ian Lynagh committed
325
   | Opt_GhciHistory
326
   | Opt_HelpfulErrors
327
   | Opt_DeferTypeErrors
Ian Lynagh's avatar
Ian Lynagh committed
328
   | Opt_Parallel
Ian Lynagh's avatar
Ian Lynagh committed
329
   | Opt_GranMacros
Ian Lynagh's avatar
Ian Lynagh committed
330
   | Opt_PIC
331
   | Opt_SccProfilingOn
ian@well-typed.com's avatar
ian@well-typed.com committed
332 333
   | Opt_Ticky
   | Opt_Static
ian@well-typed.com's avatar
ian@well-typed.com committed
334
   | Opt_Hpc
335

336 337
   -- output style opts
   | Opt_PprCaseAsLet
338

339
   -- temporary flags
340
   | Opt_RunCPS
341
   | Opt_RunCPSZ
342
   | Opt_AutoLinkPackages
343
   | Opt_ImplicitImportQualified
344
   | Opt_TryNewCodeGen
345 346 347 348 349 350

   -- keeping stuff
   | Opt_KeepHiDiffs
   | Opt_KeepHcFiles
   | Opt_KeepSFiles
   | Opt_KeepTmpFiles
Jedai's avatar
Jedai committed
351
   | Opt_KeepRawTokenStream
352
   | Opt_KeepLlvmFiles
353

354
   -- safe haskell flags
dterei's avatar
dterei committed
355
   | Opt_DistrustAllPackages
356 357
   | Opt_PackageTrust

358
   deriving (Eq, Show, Enum)
Ian Lynagh's avatar
Ian Lynagh committed
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 384 385 386 387 388 389 390 391 392
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
393 394
   | Opt_WarnUnsafe
   | Opt_WarnSafe
Ian Lynagh's avatar
Ian Lynagh committed
395
   | Opt_WarnPointlessPragmas
396
   | Opt_WarnUnsupportedCallingConventions
397
   | Opt_WarnInlineRuleShadowing
398
   deriving (Eq, Show, Enum)
399

400
data Language = Haskell98 | Haskell2010
401
   deriving Enum
402

403
-- | The various Safe Haskell modes
404 405
data SafeHaskellMode
   = Sf_None
dterei's avatar
dterei committed
406
   | Sf_Unsafe
407 408
   | Sf_Trustworthy
   | Sf_Safe
409
   | Sf_SafeInferred
410 411
   deriving (Eq)

Ian Lynagh's avatar
Ian Lynagh committed
412
instance Show SafeHaskellMode where
Ian Lynagh's avatar
Ian Lynagh committed
413 414 415 416 417
    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
418

419
instance Outputable SafeHaskellMode where
Ian Lynagh's avatar
Ian Lynagh committed
420
    ppr = text . show
421

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

   | 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
484
   | Opt_MonadComprehensions
485 486 487 488 489 490 491 492 493 494
   | Opt_GeneralizedNewtypeDeriving
   | Opt_RecursiveDo
   | Opt_PostfixOperators
   | Opt_TupleSections
   | Opt_PatternGuards
   | Opt_LiberalTypeSynonyms
   | Opt_Rank2Types
   | Opt_RankNTypes
   | Opt_ImpredicativeTypes
   | Opt_TypeOperators
495
   | Opt_ExplicitNamespaces
496 497 498 499 500
   | Opt_PackageImports
   | Opt_ExplicitForAll
   | Opt_AlternativeLayoutRule
   | Opt_AlternativeLayoutRuleTransitional
   | Opt_DatatypeContexts
501
   | Opt_NondecreasingIndentation
502
   | Opt_RelaxedLayout
503
   | Opt_TraditionalRecordSyntax
504
   | Opt_LambdaCase
505
   | Opt_MultiWayIf
506
   deriving (Eq, Enum, Show)
507

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

525
  simplTickFactor       :: Int,         -- ^ Multiplier for simplifier ticks
526 527 528
  specConstrThreshold   :: Maybe Int,   -- ^ Threshold for SpecConstr
  specConstrCount       :: Maybe Int,   -- ^ Max number of specialisations for any one function
  liberateCaseThreshold :: Maybe Int,   -- ^ Threshold for LiberateCase
529
  floatLamArgs          :: Maybe Int,   -- ^ Arg count for lambda floating
530
                                        --   See CoreMonad.FloatOutSwitches
531
  historySize           :: Int,
532

533
  cmdlineHcIncludes     :: [String],    -- ^ @\-\#includes@
Ian Lynagh's avatar
Ian Lynagh committed
534 535 536
  importPaths           :: [FilePath],
  mainModIs             :: Module,
  mainFunIs             :: Maybe String,
537
  ctxtStkDepth          :: Int,         -- ^ Typechecker context stack depth
538

539
  thisPackage           :: PackageId,   -- ^ name of package currently being compiled
540 541

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

546 547 548
  -- For object splitting
  splitInfo             :: Maybe (String,Int),

549
  -- paths etc.
Ian Lynagh's avatar
Ian Lynagh committed
550
  objectDir             :: Maybe String,
551
  dylibInstallName      :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
552 553
  hiDir                 :: Maybe String,
  stubDir               :: Maybe String,
554
  dumpDir               :: Maybe String,
555

Ian Lynagh's avatar
Ian Lynagh committed
556 557 558
  objectSuf             :: String,
  hcSuf                 :: String,
  hiSuf                 :: String,
559

Ian Lynagh's avatar
Ian Lynagh committed
560 561 562
  outputFile            :: Maybe String,
  outputHi              :: Maybe String,
  dynLibLoader          :: DynLibLoader,
563

564
  -- | This is set by 'DriverPipeline.runPipeline' based on where
Ian Lynagh's avatar
Ian Lynagh committed
565 566
  --    its output is going.
  dumpPrefix            :: Maybe FilePath,
567

568 569
  -- | Override the 'dumpPrefix' set by 'DriverPipeline.runPipeline'.
  --    Set by @-ddump-file-prefix@
Ian Lynagh's avatar
Ian Lynagh committed
570 571
  dumpPrefixForce       :: Maybe FilePath,

572 573
  ldInputs              :: [String],

Ian Lynagh's avatar
Ian Lynagh committed
574 575 576 577 578
  includePaths          :: [String],
  libraryPaths          :: [String],
  frameworkPaths        :: [String],    -- used on darwin only
  cmdlineFrameworks     :: [String],    -- ditto

579
  rtsOpts               :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
580
  rtsOptsEnabled        :: RtsOptsEnabled,
581

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

584 585 586 587
  -- Plugins
  pluginModNames        :: [ModuleName],
  pluginModNameOpts     :: [(ModuleName,String)],

588 589 590 591 592 593
  --  For ghc -M
  depMakefile           :: FilePath,
  depIncludePkgDeps     :: Bool,
  depExcludeMods        :: [ModuleName],
  depSuffixes           :: [String],

594
  --  Package flags
595
  extraPkgConfs         :: [PkgConfRef] -> [PkgConfRef],
596
        -- ^ The @-package-db@ flags given on the command line, in the order
Ian Lynagh's avatar
Ian Lynagh committed
597
        -- they appeared.
598

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

602
  -- Package state
Ian Lynagh's avatar
Ian Lynagh committed
603
  -- NB. do not modify this field, it is calculated by
604
  -- Packages.initPackages and Packages.updatePackages.
605
  pkgDatabase           :: Maybe [PackageConfig],
Ian Lynagh's avatar
Ian Lynagh committed
606
  pkgState              :: PackageState,
607

608 609 610 611
  -- Temporary files
  -- These have to be IORefs, because the defaultCleanupHandler needs to
  -- know what to clean when an exception happens
  filesToClean          :: IORef [FilePath],
612
  dirsToClean           :: IORef (Map FilePath FilePath),
613

614 615 616 617 618
  -- 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),

619
  -- hsc dynamic flags
620 621
  flags                 :: IntSet,
  warningFlags          :: IntSet,
622
  -- Don't change this without updating extensionFlags:
623
  language              :: Maybe Language,
624 625
  -- | Safe Haskell mode
  safeHaskell           :: SafeHaskellMode,
626 627 628
  -- 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.
629 630
  thOnLoc               :: SrcSpan,
  newDerivOnLoc         :: SrcSpan,
631
  pkgTrustOnLoc         :: SrcSpan,
632 633
  warnSafeOnLoc         :: SrcSpan,
  warnUnsafeOnLoc       :: SrcSpan,
634 635 636 637
  -- Don't change this without updating extensionFlags:
  extensions            :: [OnOff ExtensionFlag],
  -- extensionFlags should always be equal to
  --     flattenExtensionFlags language extensions
638
  extensionFlags        :: IntSet,
Ian Lynagh's avatar
Ian Lynagh committed
639

640
  -- | MsgDoc output action: use "ErrUtils" instead of this if you can
641
  log_action            :: LogAction,
642 643
  flushOut              :: FlushOut,
  flushErr              :: FlushErr,
David Waern's avatar
David Waern committed
644

645
  haddockOptions        :: Maybe String,
646
  ghciScripts           :: [String],
647

648 649
  -- Output style options
  pprUserLength         :: Int,
Ian Lynagh's avatar
Ian Lynagh committed
650
  pprCols               :: Int,
Ian Lynagh's avatar
Ian Lynagh committed
651
  traceLevel            :: Int, -- Standard level is 1. Less verbose is 0.
652 653

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

656
  interactivePrint      :: Maybe String,
657

658
  llvmVersion           :: IORef (Int)
659 660
 }

661 662 663
class HasDynFlags m where
    getDynFlags :: m DynFlags

Ian Lynagh's avatar
Ian Lynagh committed
664 665 666
class ContainsDynFlags t where
    extractDynFlags :: t -> DynFlags

667 668 669 670 671
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
672
  | ProfAutoCalls      -- ^ annotate call-sites
Simon Marlow's avatar
Simon Marlow committed
673
  deriving (Enum)
674

675
data Settings = Settings {
676
  sTargetPlatform        :: Platform,    -- Filled in by SysTools
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,
686 687 688
  sLdSupportsCompactUnwind :: Bool,
  sLdSupportsBuildId       :: Bool,
  sLdIsGnuLd               :: Bool,
689 690 691 692 693 694 695 696 697 698 699 700 701
  -- 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
702 703 704 705 706 707 708 709 710 711
  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
712
  sOpt_lc                :: [String], -- LLVM: llc static compiler
713

714
  sPlatformConstants     :: PlatformConstants
715 716
 }

717 718 719
targetPlatform :: DynFlags -> Platform
targetPlatform dflags = sTargetPlatform (settings dflags)

720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759
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)
760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777
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)
778

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

Ian Lynagh's avatar
Ian Lynagh committed
807 808 809 810 811 812 813
showHscTargetFlag :: HscTarget -> String
showHscTargetFlag HscC           = "-fvia-c"
showHscTargetFlag HscAsm         = "-fasm"
showHscTargetFlag HscLlvm        = "-fllvm"
showHscTargetFlag HscInterpreted = "-fbyte-code"
showHscTargetFlag HscNothing     = "-fno-code"

814
-- | Will this target result in an object file on the disk?
815 816 817
isObjectTarget :: HscTarget -> Bool
isObjectTarget HscC     = True
isObjectTarget HscAsm   = True
818
isObjectTarget HscLlvm  = True
819 820
isObjectTarget _        = False

821 822 823 824 825 826 827 828 829 830 831
-- | 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

832 833 834 835 836 837
-- | 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.
838
data GhcMode
839 840 841
  = CompManager         -- ^ @\-\-make@, GHCi, etc.
  | OneShot             -- ^ @ghc -c Foo.hs@
  | MkDepend            -- ^ @ghc -M@, see "Finder" for why we need this
842 843
  deriving Eq

844 845 846 847 848
instance Outputable GhcMode where
  ppr CompManager = ptext (sLit "CompManager")
  ppr OneShot     = ptext (sLit "OneShot")
  ppr MkDepend    = ptext (sLit "MkDepend")

849 850 851 852
isOneShot :: GhcMode -> Bool
isOneShot OneShot = True
isOneShot _other  = False

853 854 855 856
-- | 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
857 858
  | LinkInMemory        -- ^ Use the in-memory dynamic linker (works for both
                        --   bytecode and object code).
859
  | LinkDynLib          -- ^ Link objects into a dynamic lib (DLL on Windows, DSO on ELF platforms)
860
  deriving (Eq, Show)
861 862 863

isNoLink :: GhcLink -> Bool
isNoLink NoLink = True
twanvl's avatar
twanvl committed
864
isNoLink _      = False
865 866

data PackageFlag
867
  = ExposePackage   String
868
  | ExposePackageId String
869 870 871 872
  | HidePackage     String
  | IgnorePackage   String
  | TrustPackage    String
  | DistrustPackage String
873
  deriving Eq
874

875
defaultHscTarget :: Platform -> HscTarget
876 877
defaultHscTarget = defaultObjectTarget

878
-- | The 'HscTarget' value corresponding to the default way to create
879
-- object files on the current platform.
880 881 882
defaultObjectTarget :: Platform -> HscTarget
defaultObjectTarget platform
  | platformUnregisterised platform     =  HscC
Ian Lynagh's avatar
Ian Lynagh committed
883
  | cGhcWithNativeCodeGen == "YES"      =  HscAsm