DynFlags.hs 138 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

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

46 47
        printOutputForUser, printInfoForUser,

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

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

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


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

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

84
        -- ** Parsing DynFlags
85 86
        parseDynamicFlagsCmdLine,
        parseDynamicFilePragma,
87 88 89
        parseDynamicFlagsFull,

        -- ** Available DynFlags
90
        allFlags,
91 92 93
        flagsAll,
        flagsDynamic,
        flagsPackage,
94

95
        supportedLanguagesAndExtensions,
96

97
        -- ** DynFlags C compiler options
Ian Lynagh's avatar
Ian Lynagh committed
98
        picCCOpts, picPOpts,
99 100 101 102 103 104

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

        -- * Compiler configuration suitable for display to the user
105 106
        compilerInfo,

107
#ifdef GHCI
dterei's avatar
dterei committed
108
-- Only in stage 2 can we be sure that the RTS
109
-- exposes the appropriate runtime boolean
110
        rtsIsProfiled,
111
#endif
112 113

#include "../includes/dist-derivedconstants/header/GHCConstantsHaskellExports.hs"
114
        bLOCK_SIZE_W,
115
        wORD_SIZE_IN_BITS,
116 117
        tAG_MASK,
        mAX_PTR_TAG,
118
        tARGET_MIN_INT, tARGET_MAX_INT, tARGET_MAX_WORD,
119 120 121 122
  ) where

#include "HsVersions.h"

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

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

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

164 165 166
import Data.IntSet (IntSet)
import qualified Data.IntSet as IntSet

167 168 169
-- -----------------------------------------------------------------------------
-- DynFlags

170
data DumpFlag
171 172 173

   -- debugging flags
   = Opt_D_dump_cmm
174
   | Opt_D_dump_raw_cmm
175
   | Opt_D_dump_cmmz
176 177
   -- All of the cmmz subflags (there are a lot!)  Automatically
   -- enabled if you run -ddump-cmmz
Simon Marlow's avatar
Simon Marlow committed
178
   | Opt_D_dump_cmmz_cfg
179 180 181 182 183 184 185 186
   | Opt_D_dump_cmmz_cbe
   | Opt_D_dump_cmmz_proc
   | Opt_D_dump_cmmz_rewrite
   | Opt_D_dump_cmmz_sp
   | Opt_D_dump_cmmz_procmap
   | Opt_D_dump_cmmz_split
   | Opt_D_dump_cmmz_info
   -- end cmmz subflags
187
   | Opt_D_dump_cps_cmm
188
   | Opt_D_dump_asm
189 190 191 192 193
   | Opt_D_dump_asm_native
   | Opt_D_dump_asm_liveness
   | Opt_D_dump_asm_regalloc
   | Opt_D_dump_asm_regalloc_stages
   | Opt_D_dump_asm_conflicts
194
   | Opt_D_dump_asm_stats
195
   | Opt_D_dump_asm_expanded
196
   | Opt_D_dump_llvm
197
   | Opt_D_dump_core_stats
198 199 200 201
   | Opt_D_dump_deriv
   | Opt_D_dump_ds
   | Opt_D_dump_foreign
   | Opt_D_dump_inlinings
202
   | Opt_D_dump_rule_firings
203
   | Opt_D_dump_rule_rewrites
204 205 206
   | Opt_D_dump_occur_anal
   | Opt_D_dump_parsed
   | Opt_D_dump_rn
207
   | Opt_D_dump_core_pipeline -- TODO FIXME: dump after simplifier stats
208 209
   | Opt_D_dump_simpl
   | Opt_D_dump_simpl_iterations
210
   | Opt_D_dump_simpl_phases
211 212 213 214 215 216 217 218 219 220 221 222 223
   | 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
224
   | Opt_D_dump_cs_trace -- Constraint solver in type checker
225 226
   | Opt_D_dump_tc_trace
   | Opt_D_dump_if_trace
227
   | Opt_D_dump_vt_trace
228 229 230
   | Opt_D_dump_splices
   | Opt_D_dump_BCOs
   | Opt_D_dump_vect
231
   | Opt_D_dump_ticked
pepe's avatar
pepe committed
232
   | Opt_D_dump_rtti
233 234 235 236
   | Opt_D_source_stats
   | Opt_D_verbose_stg2stg
   | Opt_D_dump_hi
   | Opt_D_dump_hi_diffs
237
   | Opt_D_dump_mod_cycles
238
   | Opt_D_dump_view_pattern_commoning
239 240 241 242 243 244 245 246
   | Opt_D_verbose_core2core

   deriving (Eq, Show, Enum)

-- | Enumerates the simple on-or-off dynamic flags
data GeneralFlag

   = Opt_DumpToFile                     -- ^ Append dump output to files instead of stdout.
247
   | Opt_D_faststring_stats
248
   | Opt_D_dump_minimal_imports
249 250 251
   | Opt_DoCoreLinting
   | Opt_DoStgLinting
   | Opt_DoCmmLinting
Ben.Lippmeier@anu.edu.au's avatar
Ben.Lippmeier@anu.edu.au committed
252
   | Opt_DoAsmLinting
253
   | Opt_NoLlvmMangler                 -- hidden flag
254

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

257 258
   | Opt_PrintExplicitForalls

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

288 289 290 291 292
   -- Interface files
   | Opt_IgnoreInterfacePragmas
   | Opt_OmitInterfacePragmas
   | Opt_ExposeAllUnfoldings

Ian Lynagh's avatar
Ian Lynagh committed
293 294
   -- profiling opts
   | Opt_AutoSccsOnIndividualCafs
295
   | Opt_ProfCountEntries
Ian Lynagh's avatar
Ian Lynagh committed
296

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

336 337 338 339
   -- PreInlining is on by default. The option is there just to see how
   -- bad things get if you turn it off!
   | Opt_SimplPreInlining

340
   -- output style opts
341 342
   | Opt_ErrorSpans -- Include full span info in error messages,
                    -- instead of just the start position.
343
   | Opt_PprCaseAsLet
344

345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361
   -- Suppress all coercions, them replacing with '...'
   | Opt_SuppressCoercions
   | Opt_SuppressVarKinds
   -- Suppress module id prefixes on variables.
   | Opt_SuppressModulePrefixes
   -- Suppress type applications.
   | Opt_SuppressTypeApplications
   -- Suppress info such as arity and unfoldings on identifiers.
   | Opt_SuppressIdInfo
   -- Suppress separate type signatures in core, but leave types on
   -- lambda bound vars
   | Opt_SuppressTypeSignatures
   -- Suppress unique ids on variables.
   -- Except for uniques, as some simplifier phases introduce new
   -- variables that have otherwise identical names.
   | Opt_SuppressUniques

362
   -- temporary flags
363
   | Opt_RunCPS
364
   | Opt_RunCPSZ
365
   | Opt_AutoLinkPackages
366
   | Opt_ImplicitImportQualified
367 368 369 370 371 372

   -- keeping stuff
   | Opt_KeepHiDiffs
   | Opt_KeepHcFiles
   | Opt_KeepSFiles
   | Opt_KeepTmpFiles
Jedai's avatar
Jedai committed
373
   | Opt_KeepRawTokenStream
374
   | Opt_KeepLlvmFiles
375

376 377
   | Opt_BuildDynamicToo

378
   -- safe haskell flags
dterei's avatar
dterei committed
379
   | Opt_DistrustAllPackages
380 381
   | Opt_PackageTrust

382
   deriving (Eq, Show, Enum)
Ian Lynagh's avatar
Ian Lynagh committed
383

384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416
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
417 418
   | Opt_WarnUnsafe
   | Opt_WarnSafe
Ian Lynagh's avatar
Ian Lynagh committed
419
   | Opt_WarnPointlessPragmas
420
   | Opt_WarnUnsupportedCallingConventions
421
   | Opt_WarnInlineRuleShadowing
422
   deriving (Eq, Show, Enum)
423

424
data Language = Haskell98 | Haskell2010
425
   deriving Enum
426

427
-- | The various Safe Haskell modes
428 429
data SafeHaskellMode
   = Sf_None
dterei's avatar
dterei committed
430
   | Sf_Unsafe
431 432
   | Sf_Trustworthy
   | Sf_Safe
433
   | Sf_SafeInferred
434 435
   deriving (Eq)

Ian Lynagh's avatar
Ian Lynagh committed
436
instance Show SafeHaskellMode where
Ian Lynagh's avatar
Ian Lynagh committed
437 438 439 440 441
    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
442

443
instance Outputable SafeHaskellMode where
Ian Lynagh's avatar
Ian Lynagh committed
444
    ppr = text . show
445

446
data ExtensionFlag
447 448 449 450 451 452 453
   = Opt_Cpp
   | Opt_OverlappingInstances
   | Opt_UndecidableInstances
   | Opt_IncoherentInstances
   | Opt_MonomorphismRestriction
   | Opt_MonoPatBinds
   | Opt_MonoLocalBinds
454 455
   | Opt_RelaxedPolyRec           -- Deprecated
   | Opt_ExtendedDefaultRules     -- Use GHC's extended rules for defaulting
456 457
   | Opt_ForeignFunctionInterface
   | Opt_UnliftedFFITypes
458
   | Opt_InterruptibleFFI
459
   | Opt_CApiFFI
460
   | Opt_GHCForeignImportPrim
461 462
   | Opt_ParallelArrays           -- Syntactic support for parallel arrays
   | Opt_Arrows                   -- Arrow-notation syntax
463 464 465 466 467 468 469 470 471 472 473 474 475 476
   | 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
477
   | Opt_GADTSyntax
478
   | Opt_NPlusKPatterns
Ian Lynagh's avatar
Ian Lynagh committed
479
   | Opt_DoAndIfThenElse
480
   | Opt_RebindableSyntax
481
   | Opt_ConstraintKinds
dreixel's avatar
dreixel committed
482
   | Opt_PolyKinds                -- Kind polymorphism
dreixel's avatar
dreixel committed
483
   | Opt_DataKinds                -- Datatype promotion
484 485
   | Opt_InstanceSigs
 
486 487 488 489 490
   | Opt_StandaloneDeriving
   | Opt_DeriveDataTypeable
   | Opt_DeriveFunctor
   | Opt_DeriveTraversable
   | Opt_DeriveFoldable
491
   | Opt_DeriveGeneric            -- Allow deriving Generic/1
dreixel's avatar
dreixel committed
492
   | Opt_DefaultSignatures        -- Allow extra signatures for defmeths
493 494 495 496 497 498 499 500 501 502 503 504 505 506

   | Opt_TypeSynonymInstances
   | Opt_FlexibleContexts
   | Opt_FlexibleInstances
   | Opt_ConstrainedClassMethods
   | Opt_MultiParamTypeClasses
   | Opt_FunctionalDependencies
   | Opt_UnicodeSyntax
   | Opt_ExistentialQuantification
   | Opt_MagicHash
   | Opt_EmptyDataDecls
   | Opt_KindSignatures
   | Opt_ParallelListComp
   | Opt_TransformListComp
507
   | Opt_MonadComprehensions
508 509 510 511 512 513 514 515 516
   | Opt_GeneralizedNewtypeDeriving
   | Opt_RecursiveDo
   | Opt_PostfixOperators
   | Opt_TupleSections
   | Opt_PatternGuards
   | Opt_LiberalTypeSynonyms
   | Opt_RankNTypes
   | Opt_ImpredicativeTypes
   | Opt_TypeOperators
517
   | Opt_ExplicitNamespaces
518 519 520 521 522
   | Opt_PackageImports
   | Opt_ExplicitForAll
   | Opt_AlternativeLayoutRule
   | Opt_AlternativeLayoutRuleTransitional
   | Opt_DatatypeContexts
523
   | Opt_NondecreasingIndentation
524
   | Opt_RelaxedLayout
525
   | Opt_TraditionalRecordSyntax
526
   | Opt_LambdaCase
527
   | Opt_MultiWayIf
528
   | Opt_TypeHoles
529
   deriving (Eq, Enum, Show)
530

531
-- | Contains not only a collection of 'GeneralFlag's but also a plethora of
532
-- information relating to the compilation of a single file or GHC session
533
data DynFlags = DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
534 535 536
  ghcMode               :: GhcMode,
  ghcLink               :: GhcLink,
  hscTarget             :: HscTarget,
537
  settings              :: Settings,
538
  hscOutName            :: String,      -- ^ Name of the output file
539
  extCoreName           :: String,      -- ^ Name of the .hcr output file
540
  verbosity             :: Int,         -- ^ Verbosity level: see Note [Verbosity levels]
541 542 543
  optLevel              :: Int,         -- ^ Optimisation level
  simplPhases           :: Int,         -- ^ Number of simplifier phases
  maxSimplIterations    :: Int,         -- ^ Max simplifier iterations
544
  shouldDumpSimplPhase  :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
545
  ruleCheck             :: Maybe String,
546
  strictnessBefore      :: [Int],       -- ^ Additional demand analysis
547

548
  simplTickFactor       :: Int,         -- ^ Multiplier for simplifier ticks
549 550 551
  specConstrThreshold   :: Maybe Int,   -- ^ Threshold for SpecConstr
  specConstrCount       :: Maybe Int,   -- ^ Max number of specialisations for any one function
  liberateCaseThreshold :: Maybe Int,   -- ^ Threshold for LiberateCase
552
  floatLamArgs          :: Maybe Int,   -- ^ Arg count for lambda floating
553
                                        --   See CoreMonad.FloatOutSwitches
554
  historySize           :: Int,
555

556
  cmdlineHcIncludes     :: [String],    -- ^ @\-\#includes@
Ian Lynagh's avatar
Ian Lynagh committed
557 558 559
  importPaths           :: [FilePath],
  mainModIs             :: Module,
  mainFunIs             :: Maybe String,
560
  ctxtStkDepth          :: Int,         -- ^ Typechecker context stack depth
561

562
  thisPackage           :: PackageId,   -- ^ name of package currently being compiled
563 564

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

569 570 571
  -- For object splitting
  splitInfo             :: Maybe (String,Int),

572
  -- paths etc.
Ian Lynagh's avatar
Ian Lynagh committed
573
  objectDir             :: Maybe String,
574
  dylibInstallName      :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
575 576
  hiDir                 :: Maybe String,
  stubDir               :: Maybe String,
577
  dumpDir               :: Maybe String,
578

Ian Lynagh's avatar
Ian Lynagh committed
579 580 581
  objectSuf             :: String,
  hcSuf                 :: String,
  hiSuf                 :: String,
582

583 584 585 586
  canGenerateDynamicToo :: IORef Bool,
  dynObjectSuf          :: String,
  dynHiSuf              :: String,

Ian Lynagh's avatar
Ian Lynagh committed
587 588 589
  outputFile            :: Maybe String,
  outputHi              :: Maybe String,
  dynLibLoader          :: DynLibLoader,
590

591
  -- | This is set by 'DriverPipeline.runPipeline' based on where
Ian Lynagh's avatar
Ian Lynagh committed
592 593
  --    its output is going.
  dumpPrefix            :: Maybe FilePath,
594

595 596
  -- | Override the 'dumpPrefix' set by 'DriverPipeline.runPipeline'.
  --    Set by @-ddump-file-prefix@
Ian Lynagh's avatar
Ian Lynagh committed
597 598
  dumpPrefixForce       :: Maybe FilePath,

599 600
  ldInputs              :: [String],

Ian Lynagh's avatar
Ian Lynagh committed
601 602 603 604 605
  includePaths          :: [String],
  libraryPaths          :: [String],
  frameworkPaths        :: [String],    -- used on darwin only
  cmdlineFrameworks     :: [String],    -- ditto

606
  rtsOpts               :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
607
  rtsOptsEnabled        :: RtsOptsEnabled,
608

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

611 612 613 614
  -- Plugins
  pluginModNames        :: [ModuleName],
  pluginModNameOpts     :: [(ModuleName,String)],

615 616 617 618 619 620
  --  For ghc -M
  depMakefile           :: FilePath,
  depIncludePkgDeps     :: Bool,
  depExcludeMods        :: [ModuleName],
  depSuffixes           :: [String],

621
  --  Package flags
622
  extraPkgConfs         :: [PkgConfRef] -> [PkgConfRef],
623
        -- ^ The @-package-db@ flags given on the command line, in the order
Ian Lynagh's avatar
Ian Lynagh committed
624
        -- they appeared.
625

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

629
  -- Package state
Ian Lynagh's avatar
Ian Lynagh committed
630
  -- NB. do not modify this field, it is calculated by
631
  -- Packages.initPackages and Packages.updatePackages.
632
  pkgDatabase           :: Maybe [PackageConfig],
Ian Lynagh's avatar
Ian Lynagh committed
633
  pkgState              :: PackageState,
634

635 636 637 638
  -- Temporary files
  -- These have to be IORefs, because the defaultCleanupHandler needs to
  -- know what to clean when an exception happens
  filesToClean          :: IORef [FilePath],
639
  dirsToClean           :: IORef (Map FilePath FilePath),
640 641
  filesToNotIntermediateClean :: IORef [FilePath],

642

643 644 645 646 647
  -- 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),

648
  -- hsc dynamic flags
649 650
  dumpFlags             :: IntSet,
  generalFlags          :: IntSet,
651
  warningFlags          :: IntSet,
652
  -- Don't change this without updating extensionFlags:
653
  language              :: Maybe Language,
654 655
  -- | Safe Haskell mode
  safeHaskell           :: SafeHaskellMode,
656 657 658
  -- 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.
659 660
  thOnLoc               :: SrcSpan,
  newDerivOnLoc         :: SrcSpan,
661
  pkgTrustOnLoc         :: SrcSpan,
662 663
  warnSafeOnLoc         :: SrcSpan,
  warnUnsafeOnLoc       :: SrcSpan,
664 665 666 667
  -- Don't change this without updating extensionFlags:
  extensions            :: [OnOff ExtensionFlag],
  -- extensionFlags should always be equal to
  --     flattenExtensionFlags language extensions
668
  extensionFlags        :: IntSet,
Ian Lynagh's avatar
Ian Lynagh committed
669

670 671 672 673 674 675 676 677 678
  -- Unfolding control
  -- See Note [Discounts and thresholds] in CoreUnfold
  ufCreationThreshold   :: Int,
  ufUseThreshold        :: Int,
  ufFunAppDiscount      :: Int,
  ufDictDiscount        :: Int,
  ufKeenessFactor       :: Float,
  ufDearOp              :: Int,

679 680
  maxWorkerArgs         :: Int,

681 682
  ghciHistSize          :: Int,

683
  -- | MsgDoc output action: use "ErrUtils" instead of this if you can
684
  log_action            :: LogAction,
685 686
  flushOut              :: FlushOut,
  flushErr              :: FlushErr,
David Waern's avatar
David Waern committed
687

688
  haddockOptions        :: Maybe String,
689
  ghciScripts           :: [String],
690

691 692
  -- Output style options
  pprUserLength         :: Int,
Ian Lynagh's avatar
Ian Lynagh committed
693
  pprCols               :: Int,
Ian Lynagh's avatar
Ian Lynagh committed
694
  traceLevel            :: Int, -- Standard level is 1. Less verbose is 0.
695 696

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

699
  interactivePrint      :: Maybe String,
700

701 702 703
  llvmVersion           :: IORef (Int),

  nextWrapperNum        :: IORef Int
704 705
 }

706 707 708
class HasDynFlags m where
    getDynFlags :: m DynFlags

Ian Lynagh's avatar
Ian Lynagh committed
709 710
class ContainsDynFlags t where
    extractDynFlags :: t -> DynFlags
711
    replaceDynFlags :: t -> DynFlags -> t
Ian Lynagh's avatar
Ian Lynagh committed
712

713 714 715 716 717
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
718
  | ProfAutoCalls      -- ^ annotate call-sites
Simon Marlow's avatar
Simon Marlow committed
719
  deriving (Enum)
720

721
data Settings = Settings {
722
  sTargetPlatform        :: Platform,    -- Filled in by SysTools
723 724 725 726 727 728 729 730 731
  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,
732 733 734
  sLdSupportsCompactUnwind :: Bool,
  sLdSupportsBuildId       :: Bool,
  sLdIsGnuLd               :: Bool,
735 736 737 738 739 740 741 742 743 744 745 746 747
  -- 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
748 749 750 751 752 753 754 755 756 757
  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
758
  sOpt_lc                :: [String], -- LLVM: llc static compiler
759

760
  sPlatformConstants     :: PlatformConstants
761 762
 }

763 764 765
targetPlatform :: DynFlags -> Platform
targetPlatform dflags = sTargetPlatform (settings dflags)

766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805
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)
806 807 808
opt_L                 :: DynFlags -> [String]
opt_L dflags = sOpt_L (settings dflags)
opt_P                 :: DynFlags -> [String]
809 810
opt_P dflags = concatMap (wayOptP (targetPlatform dflags)) (ways dflags)
            ++ sOpt_P (settings dflags)
811 812 813
opt_F                 :: DynFlags -> [String]
opt_F dflags = sOpt_F (settings dflags)
opt_c                 :: DynFlags -> [String]
814 815
opt_c dflags = concatMap (wayOptc (targetPlatform dflags)) (ways dflags)
            ++ sOpt_c (settings dflags)
816 817 818
opt_a                 :: DynFlags -> [String]
opt_a dflags = sOpt_a (settings dflags)
opt_l                 :: DynFlags -> [String]
819 820
opt_l dflags = concatMap (wayOptl (targetPlatform dflags)) (ways dflags)
            ++ sOpt_l (settings dflags)
821 822 823 824 825 826
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)
827

828 829
-- | The target code type of the compilation (if any).
--
830 831 832
-- Whenever you change the target, also make sure to set 'ghcLink' to
-- something sensible.
--
833 834 835 836
-- 'HscNothing' can be used to avoid generating any output, however, note
-- that:
--
--  * This will not run the desugaring step, thus no warnings generated in
837 838 839
--    this step will be output.  In particular, this includes warnings related
--    to pattern matching.  You can run the desugarer manually using
--    'GHC.desugarModule'.
840
--
841 842 843 844
--  * 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
845
--    different target or avoid typechecking such modules.  (The latter may be
846
--    preferable for security reasons.)
847
--
848
data HscTarget
849 850
  = HscC           -- ^ Generate C code.
  | HscAsm         -- ^ Generate assembly using the native code generator.
851
  | HscLlvm        -- ^ Generate assembly using the llvm code generator.
852 853
  | HscInterpreted -- ^ Generate bytecode.  (Requires 'LinkInMemory')
  | HscNothing     -- ^ Don't generate any code.  See notes above.
854 855
  deriving (Eq, Show)

856
-- | Will this target result in an object file on the disk?
857 858 859
isObjectTarget :: HscTarget -> Bool
isObjectTarget HscC     = True
isObjectTarget HscAsm   = True
860
isObjectTarget HscLlvm  = True
861 862
isObjectTarget _        = False

863 864 865 866 867 868 869 870 871