DynFlags.hs 146 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 -fno-cse #-}
-- -fno-cse is needed for GLOBAL_VAR's to behave properly

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

51 52
        printOutputForUser, printInfoForUser,

53
        Way(..), mkBuildTag, wayRTSOnly, addWay', updateWays,
54
        wayGeneralFlags, wayUnsetGeneralFlags,
ian@well-typed.com's avatar
ian@well-typed.com committed
55

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
76
        defaultWays,
ian@well-typed.com's avatar
ian@well-typed.com committed
77
        interpWays,
Ian Lynagh's avatar
Ian Lynagh committed
78
        initDynFlags,                   -- DynFlags -> IO DynFlags
Ian Lynagh's avatar
Ian Lynagh committed
79
        defaultFatalMessager,
80
        defaultLogAction,
81
        defaultLogActionHPrintDoc,
82
        defaultLogActionHPutStrDoc,
83 84
        defaultFlushOut,
        defaultFlushErr,
Ian Lynagh's avatar
Ian Lynagh committed
85

86
        getOpts,                        -- DynFlags -> (DynFlags -> [a]) -> [a]
87
        getVerbFlags,
Ian Lynagh's avatar
Ian Lynagh committed
88 89 90 91
        updOptLevel,
        setTmpDir,
        setPackageName,

92
        -- ** Parsing DynFlags
93 94
        parseDynamicFlagsCmdLine,
        parseDynamicFilePragma,
95 96 97
        parseDynamicFlagsFull,

        -- ** Available DynFlags
98
        allFlags,
99 100 101
        flagsAll,
        flagsDynamic,
        flagsPackage,
102

103
        supportedLanguagesAndExtensions,
104

105
        -- ** DynFlags C compiler options
Ian Lynagh's avatar
Ian Lynagh committed
106
        picCCOpts, picPOpts,
107 108 109 110 111 112

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

        -- * Compiler configuration suitable for display to the user
113 114
        compilerInfo,

115
#ifdef GHCI
dterei's avatar
dterei committed
116
-- Only in stage 2 can we be sure that the RTS
117
-- exposes the appropriate runtime boolean
118
        rtsIsProfiled,
119
#endif
120 121

#include "../includes/dist-derivedconstants/header/GHCConstantsHaskellExports.hs"
122
        bLOCK_SIZE_W,
123
        wORD_SIZE_IN_BITS,
124 125
        tAG_MASK,
        mAX_PTR_TAG,
126
        tARGET_MIN_INT, tARGET_MAX_INT, tARGET_MAX_WORD,
127

128 129
        unsafeGlobalDynFlags, setUnsafeGlobalDynFlags,

130 131 132
        -- * SSE
        isSse2Enabled,
        isSse4_2Enabled,
133 134 135

        -- * Linker information
        LinkerInfo(..),
136 137 138 139
  ) where

#include "HsVersions.h"

140
import Platform
141
import PlatformConstants
142
import Module
Simon Marlow's avatar
Simon Marlow committed
143
import PackageConfig
144
import {-# SOURCE #-} PrelNames ( mAIN )
145
import {-# SOURCE #-} Packages (PackageState)
Ian Lynagh's avatar
Ian Lynagh committed
146
import DriverPhases     ( Phase(..), phaseInputExt )
147 148
import Config
import CmdLineParser
149
import Constants
150
import Panic
151
import Util
152
import Maybes           ( orElse )
153
import MonadUtils
154
import qualified Pretty
155
import SrcLoc
156
import FastString
Simon Marlow's avatar
Simon Marlow committed
157
import Outputable
Ian Lynagh's avatar
Ian Lynagh committed
158
#ifdef GHCI
Ian Lynagh's avatar
Ian Lynagh committed
159
import Foreign.C        ( CInt(..) )
Ian Lynagh's avatar
Ian Lynagh committed
160
#endif
161
import {-# SOURCE #-} ErrUtils ( Severity(..), MsgDoc, mkLocMessage )
162

163
import System.IO.Unsafe ( unsafePerformIO )
164
import Data.IORef
ian@well-typed.com's avatar
ian@well-typed.com committed
165
import Control.Monad
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
166

167
import Data.Bits
168
import Data.Char
169
import Data.Int
170
import Data.List
171 172
import Data.Map (Map)
import qualified Data.Map as Map
173
import Data.Maybe
174 175
import Data.Set (Set)
import qualified Data.Set as Set
176
import Data.Word
Ian Lynagh's avatar
Ian Lynagh committed
177
import System.FilePath
178
import System.IO
179
import System.IO.Error
180

181 182 183
import Data.IntSet (IntSet)
import qualified Data.IntSet as IntSet

184 185
import GHC.Foreign (withCString, peekCString)

186 187 188
-- -----------------------------------------------------------------------------
-- DynFlags

189
data DumpFlag
190 191 192

   -- debugging flags
   = Opt_D_dump_cmm
193 194 195 196 197 198 199 200 201 202 203 204 205
   | Opt_D_dump_cmm_raw
   -- All of the cmm subflags (there are a lot!)  Automatically
   -- enabled if you run -ddump-cmm
   | Opt_D_dump_cmm_cfg
   | Opt_D_dump_cmm_cbe
   | Opt_D_dump_cmm_proc
   | Opt_D_dump_cmm_rewrite
   | Opt_D_dump_cmm_sp
   | Opt_D_dump_cmm_procmap
   | Opt_D_dump_cmm_split
   | Opt_D_dump_cmm_info
   | Opt_D_dump_cmm_cps
   -- end cmm subflags
206
   | Opt_D_dump_asm
207 208 209 210 211
   | 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
212
   | Opt_D_dump_asm_stats
213
   | Opt_D_dump_asm_expanded
214
   | Opt_D_dump_llvm
215
   | Opt_D_dump_core_stats
216 217 218 219
   | Opt_D_dump_deriv
   | Opt_D_dump_ds
   | Opt_D_dump_foreign
   | Opt_D_dump_inlinings
220
   | Opt_D_dump_rule_firings
221
   | Opt_D_dump_rule_rewrites
222
   | Opt_D_dump_simpl_trace
223 224 225
   | Opt_D_dump_occur_anal
   | Opt_D_dump_parsed
   | Opt_D_dump_rn
226
   | Opt_D_dump_core_pipeline -- TODO FIXME: dump after simplifier stats
227 228
   | Opt_D_dump_simpl
   | Opt_D_dump_simpl_iterations
229
   | Opt_D_dump_simpl_phases
230 231 232 233 234 235 236 237 238 239 240 241 242
   | 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
243
   | Opt_D_dump_cs_trace -- Constraint solver in type checker
244 245
   | Opt_D_dump_tc_trace
   | Opt_D_dump_if_trace
246
   | Opt_D_dump_vt_trace
247 248 249
   | Opt_D_dump_splices
   | Opt_D_dump_BCOs
   | Opt_D_dump_vect
250
   | Opt_D_dump_ticked
pepe's avatar
pepe committed
251
   | Opt_D_dump_rtti
252 253 254 255
   | Opt_D_source_stats
   | Opt_D_verbose_stg2stg
   | Opt_D_dump_hi
   | Opt_D_dump_hi_diffs
256
   | Opt_D_dump_mod_cycles
257
   | Opt_D_dump_view_pattern_commoning
258 259 260 261 262 263 264 265
   | 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.
266
   | Opt_D_faststring_stats
267
   | Opt_D_dump_minimal_imports
268 269 270
   | Opt_DoCoreLinting
   | Opt_DoStgLinting
   | Opt_DoCmmLinting
Ben.Lippmeier@anu.edu.au's avatar
Ben.Lippmeier@anu.edu.au committed
271
   | Opt_DoAsmLinting
272
   | Opt_NoLlvmMangler                 -- hidden flag
273

Ian Lynagh's avatar
Ian Lynagh committed
274
   | Opt_WarnIsError                    -- -Werror; makes warnings fatal
275

276 277
   | Opt_PrintExplicitForalls

278 279
   -- optimisation opts
   | Opt_Strictness
280 281
   | Opt_KillAbsence
   | Opt_KillOneShot
282
   | Opt_FullLaziness
283 284
   | Opt_FloatIn
   | Opt_Specialise
285
   | Opt_StaticArgumentTransformation
286
   | Opt_CSE
287 288
   | Opt_LiberateCase
   | Opt_SpecConstr
289 290 291 292 293
   | Opt_DoLambdaEtaExpansion
   | Opt_IgnoreAsserts
   | Opt_DoEtaReduction
   | Opt_CaseMerge
   | Opt_UnboxStrictFields
294
   | Opt_UnboxSmallStrictFields
295
   | Opt_DictsCheap
296
   | Opt_EnableRewriteRules             -- Apply rewrite rules during simplification
rl@cse.unsw.edu.au's avatar
rl@cse.unsw.edu.au committed
297
   | Opt_Vectorise
298
   | Opt_VectorisationAvoidance
Ian Lynagh's avatar
Ian Lynagh committed
299 300
   | Opt_RegsGraph                      -- do graph coloring register allocation
   | Opt_RegsIterative                  -- do iterative coalescing graph coloring register allocation
301
   | Opt_PedanticBottoms                -- Be picky about how we treat bottom
302
   | Opt_LlvmTBAA                       -- Use LLVM TBAA infastructure for improving AA (hidden flag)
303
   | Opt_IrrefutableTuples
304
   | Opt_CmmSink
305
   | Opt_CmmElimCommonBlocks
306
   | Opt_OmitYields
307
   | Opt_SimpleListLiterals
308
   | Opt_FunToThunk               -- allow WwLib.mkWorkerArgs to remove all value lambdas
309

310 311 312 313 314
   -- Interface files
   | Opt_IgnoreInterfacePragmas
   | Opt_OmitInterfacePragmas
   | Opt_ExposeAllUnfoldings

Ian Lynagh's avatar
Ian Lynagh committed
315 316
   -- profiling opts
   | Opt_AutoSccsOnIndividualCafs
317
   | Opt_ProfCountEntries
Ian Lynagh's avatar
Ian Lynagh committed
318

319 320
   -- misc opts
   | Opt_Pp
321
   | Opt_ForceRecomp
322
   | Opt_ExcessPrecision
323
   | Opt_EagerBlackHoling
324 325 326
   | Opt_NoHsMain
   | Opt_SplitObjs
   | Opt_StgStats
327
   | Opt_HideAllPackages
328
   | Opt_PrintBindResult
329
   | Opt_Haddock
David Waern's avatar
David Waern committed
330
   | Opt_HaddockOptions
331
   | Opt_Hpc_No_Auto
332
   | Opt_BreakOnException
333
   | Opt_BreakOnError
334
   | Opt_PrintEvldWithShow
335
   | Opt_PrintBindContents
336 337
   | Opt_GenManifest
   | Opt_EmbedManifest
338
   | Opt_EmitExternalCore
Ian Lynagh's avatar
Ian Lynagh committed
339
   | Opt_SharedImplib
340
   | Opt_BuildingCabalPackage
341
   | Opt_IgnoreDotGhci
342
   | Opt_GhciSandbox
Ian Lynagh's avatar
Ian Lynagh committed
343
   | Opt_GhciHistory
344
   | Opt_HelpfulErrors
345
   | Opt_DeferTypeErrors
Ian Lynagh's avatar
Ian Lynagh committed
346
   | Opt_Parallel
Ian Lynagh's avatar
Ian Lynagh committed
347
   | Opt_GranMacros
Ian Lynagh's avatar
Ian Lynagh committed
348
   | Opt_PIC
349
   | Opt_SccProfilingOn
ian@well-typed.com's avatar
ian@well-typed.com committed
350
   | Opt_Ticky
nfrisby's avatar
nfrisby committed
351 352 353
   | Opt_Ticky_Allocd
   | Opt_Ticky_LNE
   | Opt_Ticky_Dyn_Thunk
ian@well-typed.com's avatar
ian@well-typed.com committed
354
   | Opt_Static
355
   | Opt_RPath
356
   | Opt_RelativeDynlibPaths
ian@well-typed.com's avatar
ian@well-typed.com committed
357
   | Opt_Hpc
358
   | Opt_FlatCache
359

360 361 362 363
   -- PreInlining is on by default. The option is there just to see how
   -- bad things get if you turn it off!
   | Opt_SimplPreInlining

364
   -- output style opts
365 366
   | Opt_ErrorSpans -- Include full span info in error messages,
                    -- instead of just the start position.
367
   | Opt_PprCaseAsLet
368

369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385
   -- 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

386
   -- temporary flags
387
   | Opt_RunCPS
388
   | Opt_RunCPSZ
389
   | Opt_AutoLinkPackages
390
   | Opt_ImplicitImportQualified
391 392 393 394 395 396

   -- keeping stuff
   | Opt_KeepHiDiffs
   | Opt_KeepHcFiles
   | Opt_KeepSFiles
   | Opt_KeepTmpFiles
Jedai's avatar
Jedai committed
397
   | Opt_KeepRawTokenStream
398
   | Opt_KeepLlvmFiles
399

400 401
   | Opt_BuildDynamicToo

402
   -- safe haskell flags
dterei's avatar
dterei committed
403
   | Opt_DistrustAllPackages
404 405
   | Opt_PackageTrust

406
   deriving (Eq, Show, Enum)
Ian Lynagh's avatar
Ian Lynagh committed
407

408 409
data WarningFlag =
     Opt_WarnDuplicateExports
410
   | Opt_WarnDuplicateConstraints
411 412 413 414 415
   | Opt_WarnHiShadows
   | Opt_WarnImplicitPrelude
   | Opt_WarnIncompletePatterns
   | Opt_WarnIncompleteUniPatterns
   | Opt_WarnIncompletePatternsRecUpd
416
   | Opt_WarnOverflowedLiterals
417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442
   | 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
443 444
   | Opt_WarnUnsafe
   | Opt_WarnSafe
Ian Lynagh's avatar
Ian Lynagh committed
445
   | Opt_WarnPointlessPragmas
446
   | Opt_WarnUnsupportedCallingConventions
447
   | Opt_WarnUnsupportedLlvmVersion
448
   | Opt_WarnInlineRuleShadowing
449
   | Opt_WarnTypeableInstances
450
   deriving (Eq, Show, Enum)
451

452
data Language = Haskell98 | Haskell2010
453
   deriving Enum
454

455
-- | The various Safe Haskell modes
456 457
data SafeHaskellMode
   = Sf_None
dterei's avatar
dterei committed
458
   | Sf_Unsafe
459 460
   | Sf_Trustworthy
   | Sf_Safe
461
   | Sf_SafeInferred
462 463
   deriving (Eq)

Ian Lynagh's avatar
Ian Lynagh committed
464
instance Show SafeHaskellMode where
Ian Lynagh's avatar
Ian Lynagh committed
465 466 467 468 469
    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
470

471
instance Outputable SafeHaskellMode where
Ian Lynagh's avatar
Ian Lynagh committed
472
    ppr = text . show
473

474
data ExtensionFlag
475 476 477 478 479 480 481
   = Opt_Cpp
   | Opt_OverlappingInstances
   | Opt_UndecidableInstances
   | Opt_IncoherentInstances
   | Opt_MonomorphismRestriction
   | Opt_MonoPatBinds
   | Opt_MonoLocalBinds
482 483
   | Opt_RelaxedPolyRec           -- Deprecated
   | Opt_ExtendedDefaultRules     -- Use GHC's extended rules for defaulting
484 485
   | Opt_ForeignFunctionInterface
   | Opt_UnliftedFFITypes
486
   | Opt_InterruptibleFFI
487
   | Opt_CApiFFI
488
   | Opt_GHCForeignImportPrim
489 490
   | Opt_ParallelArrays           -- Syntactic support for parallel arrays
   | Opt_Arrows                   -- Arrow-notation syntax
491 492 493 494 495
   | Opt_TemplateHaskell
   | Opt_QuasiQuotes
   | Opt_ImplicitParams
   | Opt_ImplicitPrelude
   | Opt_ScopedTypeVariables
496
   | Opt_AllowAmbiguousTypes
497 498 499 500
   | Opt_UnboxedTuples
   | Opt_BangPatterns
   | Opt_TypeFamilies
   | Opt_OverloadedStrings
501
   | Opt_OverloadedLists
502 503 504 505 506
   | Opt_DisambiguateRecordFields
   | Opt_RecordWildCards
   | Opt_RecordPuns
   | Opt_ViewPatterns
   | Opt_GADTs
Ian Lynagh's avatar
Ian Lynagh committed
507
   | Opt_GADTSyntax
508
   | Opt_NPlusKPatterns
Ian Lynagh's avatar
Ian Lynagh committed
509
   | Opt_DoAndIfThenElse
510
   | Opt_RebindableSyntax
511
   | Opt_ConstraintKinds
dreixel's avatar
dreixel committed
512
   | Opt_PolyKinds                -- Kind polymorphism
dreixel's avatar
dreixel committed
513
   | Opt_DataKinds                -- Datatype promotion
514 515
   | Opt_InstanceSigs
 
516 517
   | Opt_StandaloneDeriving
   | Opt_DeriveDataTypeable
518
   | Opt_AutoDeriveTypeable       -- Automatic derivation of Typeable
519 520 521
   | Opt_DeriveFunctor
   | Opt_DeriveTraversable
   | Opt_DeriveFoldable
522
   | Opt_DeriveGeneric            -- Allow deriving Generic/1
dreixel's avatar
dreixel committed
523
   | Opt_DefaultSignatures        -- Allow extra signatures for defmeths
524 525 526 527 528 529

   | Opt_TypeSynonymInstances
   | Opt_FlexibleContexts
   | Opt_FlexibleInstances
   | Opt_ConstrainedClassMethods
   | Opt_MultiParamTypeClasses
530
   | Opt_NullaryTypeClasses
531 532 533 534 535 536 537 538
   | Opt_FunctionalDependencies
   | Opt_UnicodeSyntax
   | Opt_ExistentialQuantification
   | Opt_MagicHash
   | Opt_EmptyDataDecls
   | Opt_KindSignatures
   | Opt_ParallelListComp
   | Opt_TransformListComp
539
   | Opt_MonadComprehensions
540 541 542 543 544 545 546 547 548
   | Opt_GeneralizedNewtypeDeriving
   | Opt_RecursiveDo
   | Opt_PostfixOperators
   | Opt_TupleSections
   | Opt_PatternGuards
   | Opt_LiberalTypeSynonyms
   | Opt_RankNTypes
   | Opt_ImpredicativeTypes
   | Opt_TypeOperators
549
   | Opt_ExplicitNamespaces
550 551 552 553 554
   | Opt_PackageImports
   | Opt_ExplicitForAll
   | Opt_AlternativeLayoutRule
   | Opt_AlternativeLayoutRuleTransitional
   | Opt_DatatypeContexts
555
   | Opt_NondecreasingIndentation
556
   | Opt_RelaxedLayout
557
   | Opt_TraditionalRecordSyntax
558
   | Opt_LambdaCase
559
   | Opt_MultiWayIf
560
   | Opt_TypeHoles
561
   | Opt_EmptyCase
562
   deriving (Eq, Enum, Show)
563

564
-- | Contains not only a collection of 'GeneralFlag's but also a plethora of
565
-- information relating to the compilation of a single file or GHC session
566
data DynFlags = DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
567 568 569
  ghcMode               :: GhcMode,
  ghcLink               :: GhcLink,
  hscTarget             :: HscTarget,
570
  settings              :: Settings,
571
  verbosity             :: Int,         -- ^ Verbosity level: see Note [Verbosity levels]
572 573 574
  optLevel              :: Int,         -- ^ Optimisation level
  simplPhases           :: Int,         -- ^ Number of simplifier phases
  maxSimplIterations    :: Int,         -- ^ Max simplifier iterations
575
  shouldDumpSimplPhase  :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
576
  ruleCheck             :: Maybe String,
577
  strictnessBefore      :: [Int],       -- ^ Additional demand analysis
578

579
  simplTickFactor       :: Int,         -- ^ Multiplier for simplifier ticks
580 581
  specConstrThreshold   :: Maybe Int,   -- ^ Threshold for SpecConstr
  specConstrCount       :: Maybe Int,   -- ^ Max number of specialisations for any one function
582 583
  specConstrRecursive   :: Int,         -- ^ Max number of specialisations for recursive types
                                        --   Not optional; otherwise ForceSpecConstr can diverge.
584
  liberateCaseThreshold :: Maybe Int,   -- ^ Threshold for LiberateCase
585
  floatLamArgs          :: Maybe Int,   -- ^ Arg count for lambda floating
586
                                        --   See CoreMonad.FloatOutSwitches
587
  historySize           :: Int,
588

589
  cmdlineHcIncludes     :: [String],    -- ^ @\-\#includes@
Ian Lynagh's avatar
Ian Lynagh committed
590 591 592
  importPaths           :: [FilePath],
  mainModIs             :: Module,
  mainFunIs             :: Maybe String,
593
  ctxtStkDepth          :: Int,         -- ^ Typechecker context stack depth
594

595
  thisPackage           :: PackageId,   -- ^ name of package currently being compiled
596 597

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

602 603 604
  -- For object splitting
  splitInfo             :: Maybe (String,Int),

605
  -- paths etc.
Ian Lynagh's avatar
Ian Lynagh committed
606
  objectDir             :: Maybe String,
607
  dylibInstallName      :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
608 609
  hiDir                 :: Maybe String,
  stubDir               :: Maybe String,
610
  dumpDir               :: Maybe String,
611

Ian Lynagh's avatar
Ian Lynagh committed
612 613 614
  objectSuf             :: String,
  hcSuf                 :: String,
  hiSuf                 :: String,
615

616 617 618 619
  canGenerateDynamicToo :: IORef Bool,
  dynObjectSuf          :: String,
  dynHiSuf              :: String,

620 621 622 623 624 625 626 627
  -- Packages.isDllName needs to know whether a call is within a
  -- single DLL or not. Normally it does this by seeing if the call
  -- is to the same package, but for the ghc package, we split the
  -- package between 2 DLLs. The dllSplit tells us which sets of
  -- modules are in which package.
  dllSplitFile          :: Maybe FilePath,
  dllSplit              :: Maybe [Set String],

Ian Lynagh's avatar
Ian Lynagh committed
628
  outputFile            :: Maybe String,
ian@well-typed.com's avatar
ian@well-typed.com committed
629
  dynOutputFile         :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
630 631
  outputHi              :: Maybe String,
  dynLibLoader          :: DynLibLoader,
632

633
  -- | This is set by 'DriverPipeline.runPipeline' based on where
Ian Lynagh's avatar
Ian Lynagh committed
634 635
  --    its output is going.
  dumpPrefix            :: Maybe FilePath,
636

637 638
  -- | Override the 'dumpPrefix' set by 'DriverPipeline.runPipeline'.
  --    Set by @-ddump-file-prefix@
Ian Lynagh's avatar
Ian Lynagh committed
639 640
  dumpPrefixForce       :: Maybe FilePath,

641
  ldInputs              :: [Option],
642

Ian Lynagh's avatar
Ian Lynagh committed
643 644 645 646 647
  includePaths          :: [String],
  libraryPaths          :: [String],
  frameworkPaths        :: [String],    -- used on darwin only
  cmdlineFrameworks     :: [String],    -- ditto

648
  rtsOpts               :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
649
  rtsOptsEnabled        :: RtsOptsEnabled,
650

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

653 654 655 656
  -- Plugins
  pluginModNames        :: [ModuleName],
  pluginModNameOpts     :: [(ModuleName,String)],

657 658 659 660 661 662
  --  For ghc -M
  depMakefile           :: FilePath,
  depIncludePkgDeps     :: Bool,
  depExcludeMods        :: [ModuleName],
  depSuffixes           :: [String],

663
  --  Package flags
664
  extraPkgConfs         :: [PkgConfRef] -> [PkgConfRef],
665
        -- ^ The @-package-db@ flags given on the command line, in the order
Ian Lynagh's avatar
Ian Lynagh committed
666
        -- they appeared.
667

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

671
  -- Package state
Ian Lynagh's avatar
Ian Lynagh committed
672
  -- NB. do not modify this field, it is calculated by
673
  -- Packages.initPackages and Packages.updatePackages.
674
  pkgDatabase           :: Maybe [PackageConfig],
Ian Lynagh's avatar
Ian Lynagh committed
675
  pkgState              :: PackageState,
676

677 678 679 680
  -- Temporary files
  -- These have to be IORefs, because the defaultCleanupHandler needs to
  -- know what to clean when an exception happens
  filesToClean          :: IORef [FilePath],
681
  dirsToClean           :: IORef (Map FilePath FilePath),
682 683
  filesToNotIntermediateClean :: IORef [FilePath],

684

685 686 687 688 689
  -- 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),

690
  -- hsc dynamic flags
691 692
  dumpFlags             :: IntSet,
  generalFlags          :: IntSet,
693
  warningFlags          :: IntSet,
694
  -- Don't change this without updating extensionFlags:
695
  language              :: Maybe Language,
696 697
  -- | Safe Haskell mode
  safeHaskell           :: SafeHaskellMode,
698 699 700
  -- 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.
701 702
  thOnLoc               :: SrcSpan,
  newDerivOnLoc         :: SrcSpan,
703
  pkgTrustOnLoc         :: SrcSpan,
704 705
  warnSafeOnLoc         :: SrcSpan,
  warnUnsafeOnLoc       :: SrcSpan,
706 707 708 709
  -- Don't change this without updating extensionFlags:
  extensions            :: [OnOff ExtensionFlag],
  -- extensionFlags should always be equal to
  --     flattenExtensionFlags language extensions
710
  extensionFlags        :: IntSet,
Ian Lynagh's avatar
Ian Lynagh committed
711

712 713 714 715 716 717 718 719 720
  -- Unfolding control
  -- See Note [Discounts and thresholds] in CoreUnfold
  ufCreationThreshold   :: Int,
  ufUseThreshold        :: Int,
  ufFunAppDiscount      :: Int,
  ufDictDiscount        :: Int,
  ufKeenessFactor       :: Float,
  ufDearOp              :: Int,

721 722
  maxWorkerArgs         :: Int,

723 724
  ghciHistSize          :: Int,

725
  -- | MsgDoc output action: use "ErrUtils" instead of this if you can
726
  log_action            :: LogAction,
727 728
  flushOut              :: FlushOut,
  flushErr              :: FlushErr,
David Waern's avatar
David Waern committed
729

730
  haddockOptions        :: Maybe String,
731
  ghciScripts           :: [String],
732

733 734
  -- Output style options
  pprUserLength         :: Int,
Ian Lynagh's avatar
Ian Lynagh committed
735
  pprCols               :: Int,
Ian Lynagh's avatar
Ian Lynagh committed
736
  traceLevel            :: Int, -- Standard level is 1. Less verbose is 0.
737

738 739
  useUnicodeQuotes      :: Bool,

740
  -- | what kind of {-# SCC #-} to add automatically
741 742
  profAuto              :: ProfAuto,

743
  interactivePrint      :: Maybe String,
744

745
  llvmVersion           :: IORef Int,
746

tibbe's avatar
tibbe committed
747 748 749
  nextWrapperNum        :: IORef Int,

  -- | Machine dependant flags (-m<blah> stuff)
750 751 752 753
  sseVersion            :: Maybe (Int, Int),  -- (major, minor)

  -- | Run-time linker information (what options we need, etc.)
  rtldFlags             :: IORef (Maybe LinkerInfo)
754 755
 }

756 757 758
class HasDynFlags m where
    getDynFlags :: m DynFlags

Ian Lynagh's avatar
Ian Lynagh committed
759 760
class ContainsDynFlags t where
    extractDynFlags :: t -> DynFlags
761
    replaceDynFlags :: t -> DynFlags -> t
Ian Lynagh's avatar
Ian Lynagh committed
762

763 764 765 766 767
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
768
  | ProfAutoCalls      -- ^ annotate call-sites
Simon Marlow's avatar
Simon Marlow committed
769
  deriving (Enum)
770

771
data Settings = Settings {
772
  sTargetPlatform        :: Platform,    -- Filled in by SysTools
773 774 775 776 777 778 779 780 781
  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,
782 783
  sLdSupportsCompactUnwind :: Bool,
  sLdSupportsBuildId       :: Bool,
784
  sLdSupportsFilelist      :: Bool,
785
  sLdIsGnuLd               :: Bool,
786 787 788 789 790 791 792 793 794 795 796 797 798
  -- 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
799 800 801 802 803 804 805 806 807 808
  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
809
  sOpt_lc                :: [String], -- LLVM: llc static compiler
810

811
  sPlatformConstants     :: PlatformConstants
812 813
 }

814 815 816
targetPlatform :: DynFlags -> Platform
targetPlatform dflags = sTargetPlatform (settings dflags)

817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856
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           ::