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

49 50
        printOutputForUser, printInfoForUser,

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

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

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


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

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

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

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

#include "HsVersions.h"

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

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

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

166 167 168
import Data.IntSet (IntSet)
import qualified Data.IntSet as IntSet

169 170 171
-- -----------------------------------------------------------------------------
-- DynFlags

172
-- | Enumerates the simple on-or-off dynamic flags
173 174 175 176
data DynFlag

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

Ian Lynagh's avatar
Ian Lynagh committed
263
   | Opt_WarnIsError                    -- -Werror; makes warnings fatal
264

265 266
   | Opt_PrintExplicitForalls

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

296 297 298 299 300
   -- Interface files
   | Opt_IgnoreInterfacePragmas
   | Opt_OmitInterfacePragmas
   | Opt_ExposeAllUnfoldings

Ian Lynagh's avatar
Ian Lynagh committed
301 302
   -- profiling opts
   | Opt_AutoSccsOnIndividualCafs
303
   | Opt_ProfCountEntries
Ian Lynagh's avatar
Ian Lynagh committed
304

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

344 345 346 347
   -- PreInlining is on by default. The option is there just to see how
   -- bad things get if you turn it off!
   | Opt_SimplPreInlining

348
   -- output style opts
349 350
   | Opt_ErrorSpans -- Include full span info in error messages,
                    -- instead of just the start position.
351
   | Opt_PprCaseAsLet
352

353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369
   -- 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

370
   -- temporary flags
371
   | Opt_RunCPS
372
   | Opt_RunCPSZ
373
   | Opt_AutoLinkPackages
374
   | Opt_ImplicitImportQualified
375 376 377 378 379 380

   -- keeping stuff
   | Opt_KeepHiDiffs
   | Opt_KeepHcFiles
   | Opt_KeepSFiles
   | Opt_KeepTmpFiles
Jedai's avatar
Jedai committed
381
   | Opt_KeepRawTokenStream
382
   | Opt_KeepLlvmFiles
383

384
   -- safe haskell flags
dterei's avatar
dterei committed
385
   | Opt_DistrustAllPackages
386 387
   | Opt_PackageTrust

388
   deriving (Eq, Show, Enum)
Ian Lynagh's avatar
Ian Lynagh committed
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 417 418 419 420 421 422
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
423 424
   | Opt_WarnUnsafe
   | Opt_WarnSafe
Ian Lynagh's avatar
Ian Lynagh committed
425
   | Opt_WarnPointlessPragmas
426
   | Opt_WarnUnsupportedCallingConventions
427
   | Opt_WarnInlineRuleShadowing
428
   deriving (Eq, Show, Enum)
429

430
data Language = Haskell98 | Haskell2010
431
   deriving Enum
432

433
-- | The various Safe Haskell modes
434 435
data SafeHaskellMode
   = Sf_None
dterei's avatar
dterei committed
436
   | Sf_Unsafe
437 438
   | Sf_Trustworthy
   | Sf_Safe
439
   | Sf_SafeInferred
440 441
   deriving (Eq)

Ian Lynagh's avatar
Ian Lynagh committed
442
instance Show SafeHaskellMode where
Ian Lynagh's avatar
Ian Lynagh committed
443 444 445 446 447
    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
448

449
instance Outputable SafeHaskellMode where
Ian Lynagh's avatar
Ian Lynagh committed
450
    ppr = text . show
451

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

   | 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
514
   | Opt_MonadComprehensions
515 516 517 518 519 520 521 522 523 524
   | Opt_GeneralizedNewtypeDeriving
   | Opt_RecursiveDo
   | Opt_PostfixOperators
   | Opt_TupleSections
   | Opt_PatternGuards
   | Opt_LiberalTypeSynonyms
   | Opt_Rank2Types
   | Opt_RankNTypes
   | Opt_ImpredicativeTypes
   | Opt_TypeOperators
525
   | Opt_ExplicitNamespaces
526 527 528 529 530
   | Opt_PackageImports
   | Opt_ExplicitForAll
   | Opt_AlternativeLayoutRule
   | Opt_AlternativeLayoutRuleTransitional
   | Opt_DatatypeContexts
531
   | Opt_NondecreasingIndentation
532
   | Opt_RelaxedLayout
533
   | Opt_TraditionalRecordSyntax
534
   | Opt_LambdaCase
535
   | Opt_MultiWayIf
536
   | Opt_TypeHoles
537
   deriving (Eq, Enum, Show)
538

539 540
-- | 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
541
data DynFlags = DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
542 543 544
  ghcMode               :: GhcMode,
  ghcLink               :: GhcLink,
  hscTarget             :: HscTarget,
545
  settings              :: Settings,
546
  hscOutName            :: String,      -- ^ Name of the output file
547
  extCoreName           :: String,      -- ^ Name of the .hcr output file
548
  verbosity             :: Int,         -- ^ Verbosity level: see Note [Verbosity levels]
549 550 551
  optLevel              :: Int,         -- ^ Optimisation level
  simplPhases           :: Int,         -- ^ Number of simplifier phases
  maxSimplIterations    :: Int,         -- ^ Max simplifier iterations
552
  shouldDumpSimplPhase  :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
553
  ruleCheck             :: Maybe String,
554
  strictnessBefore      :: [Int],       -- ^ Additional demand analysis
555

556
  simplTickFactor       :: Int,         -- ^ Multiplier for simplifier ticks
557 558 559
  specConstrThreshold   :: Maybe Int,   -- ^ Threshold for SpecConstr
  specConstrCount       :: Maybe Int,   -- ^ Max number of specialisations for any one function
  liberateCaseThreshold :: Maybe Int,   -- ^ Threshold for LiberateCase
560
  floatLamArgs          :: Maybe Int,   -- ^ Arg count for lambda floating
561
                                        --   See CoreMonad.FloatOutSwitches
562
  historySize           :: Int,
563

564
  cmdlineHcIncludes     :: [String],    -- ^ @\-\#includes@
Ian Lynagh's avatar
Ian Lynagh committed
565 566 567
  importPaths           :: [FilePath],
  mainModIs             :: Module,
  mainFunIs             :: Maybe String,
568
  ctxtStkDepth          :: Int,         -- ^ Typechecker context stack depth
569

570
  thisPackage           :: PackageId,   -- ^ name of package currently being compiled
571 572

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

577 578 579
  -- For object splitting
  splitInfo             :: Maybe (String,Int),

580
  -- paths etc.
Ian Lynagh's avatar
Ian Lynagh committed
581
  objectDir             :: Maybe String,
582
  dylibInstallName      :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
583 584
  hiDir                 :: Maybe String,
  stubDir               :: Maybe String,
585
  dumpDir               :: Maybe String,
586

Ian Lynagh's avatar
Ian Lynagh committed
587 588 589
  objectSuf             :: String,
  hcSuf                 :: String,
  hiSuf                 :: String,
590

Ian Lynagh's avatar
Ian Lynagh committed
591 592 593
  outputFile            :: Maybe String,
  outputHi              :: Maybe String,
  dynLibLoader          :: DynLibLoader,
594

595
  -- | This is set by 'DriverPipeline.runPipeline' based on where
Ian Lynagh's avatar
Ian Lynagh committed
596 597
  --    its output is going.
  dumpPrefix            :: Maybe FilePath,
598

599 600
  -- | Override the 'dumpPrefix' set by 'DriverPipeline.runPipeline'.
  --    Set by @-ddump-file-prefix@
Ian Lynagh's avatar
Ian Lynagh committed
601 602
  dumpPrefixForce       :: Maybe FilePath,

603 604
  ldInputs              :: [String],

Ian Lynagh's avatar
Ian Lynagh committed
605 606 607 608 609
  includePaths          :: [String],
  libraryPaths          :: [String],
  frameworkPaths        :: [String],    -- used on darwin only
  cmdlineFrameworks     :: [String],    -- ditto

610
  rtsOpts               :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
611
  rtsOptsEnabled        :: RtsOptsEnabled,
612

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

615 616 617 618
  -- Plugins
  pluginModNames        :: [ModuleName],
  pluginModNameOpts     :: [(ModuleName,String)],

619 620 621 622 623 624
  --  For ghc -M
  depMakefile           :: FilePath,
  depIncludePkgDeps     :: Bool,
  depExcludeMods        :: [ModuleName],
  depSuffixes           :: [String],

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

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

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

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

645 646 647 648 649
  -- 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),

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

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

680 681
  maxWorkerArgs         :: Int,

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

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

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

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

698
  interactivePrint      :: Maybe String,
699

700
  llvmVersion           :: IORef (Int)
701 702
 }

703 704 705
class HasDynFlags m where
    getDynFlags :: m DynFlags

Ian Lynagh's avatar
Ian Lynagh committed
706 707 708
class ContainsDynFlags t where
    extractDynFlags :: t -> DynFlags

709 710 711 712 713
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
714
  | ProfAutoCalls      -- ^ annotate call-sites
Simon Marlow's avatar
Simon Marlow committed
715
  deriving (Enum)
716

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

756
  sPlatformConstants     :: PlatformConstants
757 758
 }

759 760 761
targetPlatform :: DynFlags -> Platform
targetPlatform dflags = sTargetPlatform (settings dflags)

762 763 764 765 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
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)
802 803 804
opt_L                 :: DynFlags -> [String]
opt_L dflags = sOpt_L (settings dflags)
opt_P                 :: DynFlags -> [String]
805 806
opt_P dflags = concatMap (wayOptP (targetPlatform dflags)) (ways dflags)
            ++ sOpt_P (settings dflags)
807 808 809
opt_F                 :: DynFlags -> [String]
opt_F dflags = sOpt_F (settings dflags)
opt_c                 :: DynFlags -> [String]
810 811
opt_c dflags = concatMap (wayOptc (targetPlatform dflags)) (ways dflags)
            ++ sOpt_c (settings dflags)
812 813 814
opt_a                 :: DynFlags -> [String]
opt_a dflags = sOpt_a (settings dflags)
opt_l                 :: DynFlags -> [String]
815 816
opt_l dflags = concatMap (wayOptl (targetPlatform dflags)) (ways dflags)
            ++ sOpt_l (settings dflags)
817 818 819 820 821 822
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)
823

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

852
-- | Will this target result in an object file on the disk?
853 854 855
isObjectTarget :: HscTarget -> Bool
isObjectTarget HscC     = True
isObjectTarget HscAsm   = True
856
isObjectTarget HscLlvm  = True
857 858
isObjectTarget _        = False

859 860 861 862 863 864 865 866 867 868 869
-- | 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

870 871 872 873 874 875
-- | 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.
876
data GhcMode
877 878 879
  = CompManager         -- ^ @\-\-make@, GHCi, etc.
  | OneShot             -- ^ @ghc -c Foo.hs@
  | MkDepend            -- ^ @ghc -M@, see "Finder" for why we need this
880 881
  deriving Eq

simonpj@microsoft.com's avatar