DynFlags.hs 143 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 35
        whenGeneratingDynamicToo, ifGeneratingDynamicToo,
        whenCannotGenerateDynamicToo,
        doDynamicToo,
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 54
        Way(..), mkBuildTag, wayRTSOnly, updateWays,
        wayGeneralFlags,
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 83
        defaultFlushOut,
        defaultFlushErr,
Ian Lynagh's avatar
Ian Lynagh committed
84

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

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

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

102
        supportedLanguagesAndExtensions,
103

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

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

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

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

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

127 128
        unsafeGlobalDynFlags, setUnsafeGlobalDynFlags,

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

#include "HsVersions.h"

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

159
import System.IO.Unsafe ( unsafePerformIO )
160
import Data.IORef
ian@well-typed.com's avatar
ian@well-typed.com committed
161
import Control.Monad
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
162

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

177 178 179
import Data.IntSet (IntSet)
import qualified Data.IntSet as IntSet

180 181
import GHC.Foreign (withCString, peekCString)

182 183 184
-- -----------------------------------------------------------------------------
-- DynFlags

185
data DumpFlag
186 187 188

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

Ian Lynagh's avatar
Ian Lynagh committed
270
   | Opt_WarnIsError                    -- -Werror; makes warnings fatal
271

272 273
   | Opt_PrintExplicitForalls

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

303 304 305 306 307
   -- Interface files
   | Opt_IgnoreInterfacePragmas
   | Opt_OmitInterfacePragmas
   | Opt_ExposeAllUnfoldings

Ian Lynagh's avatar
Ian Lynagh committed
308 309
   -- profiling opts
   | Opt_AutoSccsOnIndividualCafs
310
   | Opt_ProfCountEntries
Ian Lynagh's avatar
Ian Lynagh committed
311

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

349 350 351 352
   -- PreInlining is on by default. The option is there just to see how
   -- bad things get if you turn it off!
   | Opt_SimplPreInlining

353
   -- output style opts
354 355
   | Opt_ErrorSpans -- Include full span info in error messages,
                    -- instead of just the start position.
356
   | Opt_PprCaseAsLet
357

358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374
   -- 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

375
   -- temporary flags
376
   | Opt_RunCPS
377
   | Opt_RunCPSZ
378
   | Opt_AutoLinkPackages
379
   | Opt_ImplicitImportQualified
380 381 382 383 384 385

   -- keeping stuff
   | Opt_KeepHiDiffs
   | Opt_KeepHcFiles
   | Opt_KeepSFiles
   | Opt_KeepTmpFiles
Jedai's avatar
Jedai committed
386
   | Opt_KeepRawTokenStream
387
   | Opt_KeepLlvmFiles
388

389 390
   | Opt_BuildDynamicToo

391
   -- safe haskell flags
dterei's avatar
dterei committed
392
   | Opt_DistrustAllPackages
393 394
   | Opt_PackageTrust

395
   deriving (Eq, Show, Enum)
Ian Lynagh's avatar
Ian Lynagh committed
396

397 398
data WarningFlag =
     Opt_WarnDuplicateExports
399
   | Opt_WarnDuplicateConstraints
400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430
   | 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
431 432
   | Opt_WarnUnsafe
   | Opt_WarnSafe
Ian Lynagh's avatar
Ian Lynagh committed
433
   | Opt_WarnPointlessPragmas
434
   | Opt_WarnUnsupportedCallingConventions
435
   | Opt_WarnUnsupportedLlvmVersion
436
   | Opt_WarnInlineRuleShadowing
437
   | Opt_WarnTypeableInstances
438
   deriving (Eq, Show, Enum)
439

440
data Language = Haskell98 | Haskell2010
441
   deriving Enum
442

443
-- | The various Safe Haskell modes
444 445
data SafeHaskellMode
   = Sf_None
dterei's avatar
dterei committed
446
   | Sf_Unsafe
447 448
   | Sf_Trustworthy
   | Sf_Safe
449
   | Sf_SafeInferred
450 451
   deriving (Eq)

Ian Lynagh's avatar
Ian Lynagh committed
452
instance Show SafeHaskellMode where
Ian Lynagh's avatar
Ian Lynagh committed
453 454 455 456 457
    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
458

459
instance Outputable SafeHaskellMode where
Ian Lynagh's avatar
Ian Lynagh committed
460
    ppr = text . show
461

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

   | Opt_TypeSynonymInstances
   | Opt_FlexibleContexts
   | Opt_FlexibleInstances
   | Opt_ConstrainedClassMethods
   | Opt_MultiParamTypeClasses
518
   | Opt_NullaryTypeClasses
519 520 521 522 523 524 525 526
   | Opt_FunctionalDependencies
   | Opt_UnicodeSyntax
   | Opt_ExistentialQuantification
   | Opt_MagicHash
   | Opt_EmptyDataDecls
   | Opt_KindSignatures
   | Opt_ParallelListComp
   | Opt_TransformListComp
527
   | Opt_MonadComprehensions
528 529 530 531 532 533 534 535 536
   | Opt_GeneralizedNewtypeDeriving
   | Opt_RecursiveDo
   | Opt_PostfixOperators
   | Opt_TupleSections
   | Opt_PatternGuards
   | Opt_LiberalTypeSynonyms
   | Opt_RankNTypes
   | Opt_ImpredicativeTypes
   | Opt_TypeOperators
537
   | Opt_ExplicitNamespaces
538 539 540 541 542
   | Opt_PackageImports
   | Opt_ExplicitForAll
   | Opt_AlternativeLayoutRule
   | Opt_AlternativeLayoutRuleTransitional
   | Opt_DatatypeContexts
543
   | Opt_NondecreasingIndentation
544
   | Opt_RelaxedLayout
545
   | Opt_TraditionalRecordSyntax
546
   | Opt_LambdaCase
547
   | Opt_MultiWayIf
548
   | Opt_TypeHoles
549
   | Opt_EmptyCase
550
   deriving (Eq, Enum, Show)
551

552
-- | Contains not only a collection of 'GeneralFlag's but also a plethora of
553
-- information relating to the compilation of a single file or GHC session
554
data DynFlags = DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
555 556 557
  ghcMode               :: GhcMode,
  ghcLink               :: GhcLink,
  hscTarget             :: HscTarget,
558
  settings              :: Settings,
559
  hscOutName            :: String,      -- ^ Name of the output file
560
  extCoreName           :: String,      -- ^ Name of the .hcr output file
561
  verbosity             :: Int,         -- ^ Verbosity level: see Note [Verbosity levels]
562 563 564
  optLevel              :: Int,         -- ^ Optimisation level
  simplPhases           :: Int,         -- ^ Number of simplifier phases
  maxSimplIterations    :: Int,         -- ^ Max simplifier iterations
565
  shouldDumpSimplPhase  :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
566
  ruleCheck             :: Maybe String,
567
  strictnessBefore      :: [Int],       -- ^ Additional demand analysis
568

569
  simplTickFactor       :: Int,         -- ^ Multiplier for simplifier ticks
570 571 572
  specConstrThreshold   :: Maybe Int,   -- ^ Threshold for SpecConstr
  specConstrCount       :: Maybe Int,   -- ^ Max number of specialisations for any one function
  liberateCaseThreshold :: Maybe Int,   -- ^ Threshold for LiberateCase
573
  floatLamArgs          :: Maybe Int,   -- ^ Arg count for lambda floating
574
                                        --   See CoreMonad.FloatOutSwitches
575
  historySize           :: Int,
576

577
  cmdlineHcIncludes     :: [String],    -- ^ @\-\#includes@
Ian Lynagh's avatar
Ian Lynagh committed
578 579 580
  importPaths           :: [FilePath],
  mainModIs             :: Module,
  mainFunIs             :: Maybe String,
581
  ctxtStkDepth          :: Int,         -- ^ Typechecker context stack depth
582

583
  thisPackage           :: PackageId,   -- ^ name of package currently being compiled
584 585

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

590 591 592
  -- For object splitting
  splitInfo             :: Maybe (String,Int),

593
  -- paths etc.
Ian Lynagh's avatar
Ian Lynagh committed
594
  objectDir             :: Maybe String,
595
  dylibInstallName      :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
596 597
  hiDir                 :: Maybe String,
  stubDir               :: Maybe String,
598
  dumpDir               :: Maybe String,
599

Ian Lynagh's avatar
Ian Lynagh committed
600 601 602
  objectSuf             :: String,
  hcSuf                 :: String,
  hiSuf                 :: String,
603

604 605 606 607
  canGenerateDynamicToo :: IORef Bool,
  dynObjectSuf          :: String,
  dynHiSuf              :: String,

Ian Lynagh's avatar
Ian Lynagh committed
608
  outputFile            :: Maybe String,
ian@well-typed.com's avatar
ian@well-typed.com committed
609
  dynOutputFile         :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
610 611
  outputHi              :: Maybe String,
  dynLibLoader          :: DynLibLoader,
612

613
  -- | This is set by 'DriverPipeline.runPipeline' based on where
Ian Lynagh's avatar
Ian Lynagh committed
614 615
  --    its output is going.
  dumpPrefix            :: Maybe FilePath,
616

617 618
  -- | Override the 'dumpPrefix' set by 'DriverPipeline.runPipeline'.
  --    Set by @-ddump-file-prefix@
Ian Lynagh's avatar
Ian Lynagh committed
619 620
  dumpPrefixForce       :: Maybe FilePath,

621 622
  ldInputs              :: [String],

Ian Lynagh's avatar
Ian Lynagh committed
623 624 625 626 627
  includePaths          :: [String],
  libraryPaths          :: [String],
  frameworkPaths        :: [String],    -- used on darwin only
  cmdlineFrameworks     :: [String],    -- ditto

628
  rtsOpts               :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
629
  rtsOptsEnabled        :: RtsOptsEnabled,
630

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

633 634 635 636
  -- Plugins
  pluginModNames        :: [ModuleName],
  pluginModNameOpts     :: [(ModuleName,String)],

637 638 639 640 641 642
  --  For ghc -M
  depMakefile           :: FilePath,
  depIncludePkgDeps     :: Bool,
  depExcludeMods        :: [ModuleName],
  depSuffixes           :: [String],

643
  --  Package flags
644
  extraPkgConfs         :: [PkgConfRef] -> [PkgConfRef],
645
        -- ^ The @-package-db@ flags given on the command line, in the order
Ian Lynagh's avatar
Ian Lynagh committed
646
        -- they appeared.
647

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

651
  -- Package state
Ian Lynagh's avatar
Ian Lynagh committed
652
  -- NB. do not modify this field, it is calculated by
653
  -- Packages.initPackages and Packages.updatePackages.
654
  pkgDatabase           :: Maybe [PackageConfig],
Ian Lynagh's avatar
Ian Lynagh committed
655
  pkgState              :: PackageState,
656

657 658 659 660
  -- Temporary files
  -- These have to be IORefs, because the defaultCleanupHandler needs to
  -- know what to clean when an exception happens
  filesToClean          :: IORef [FilePath],
661
  dirsToClean           :: IORef (Map FilePath FilePath),
662 663
  filesToNotIntermediateClean :: IORef [FilePath],

664

665 666 667 668 669
  -- 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),

670
  -- hsc dynamic flags
671 672
  dumpFlags             :: IntSet,
  generalFlags          :: IntSet,
673
  warningFlags          :: IntSet,
674
  -- Don't change this without updating extensionFlags:
675
  language              :: Maybe Language,
676 677
  -- | Safe Haskell mode
  safeHaskell           :: SafeHaskellMode,
678 679 680
  -- 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.
681 682
  thOnLoc               :: SrcSpan,
  newDerivOnLoc         :: SrcSpan,
683
  pkgTrustOnLoc         :: SrcSpan,
684 685
  warnSafeOnLoc         :: SrcSpan,
  warnUnsafeOnLoc       :: SrcSpan,
686 687 688 689
  -- Don't change this without updating extensionFlags:
  extensions            :: [OnOff ExtensionFlag],
  -- extensionFlags should always be equal to
  --     flattenExtensionFlags language extensions
690
  extensionFlags        :: IntSet,
Ian Lynagh's avatar
Ian Lynagh committed
691

692 693 694 695 696 697 698 699 700
  -- Unfolding control
  -- See Note [Discounts and thresholds] in CoreUnfold
  ufCreationThreshold   :: Int,
  ufUseThreshold        :: Int,
  ufFunAppDiscount      :: Int,
  ufDictDiscount        :: Int,
  ufKeenessFactor       :: Float,
  ufDearOp              :: Int,

701 702
  maxWorkerArgs         :: Int,

703 704
  ghciHistSize          :: Int,

705
  -- | MsgDoc output action: use "ErrUtils" instead of this if you can
706
  log_action            :: LogAction,
707 708
  flushOut              :: FlushOut,
  flushErr              :: FlushErr,
David Waern's avatar
David Waern committed
709

710
  haddockOptions        :: Maybe String,
711
  ghciScripts           :: [String],
712

713 714
  -- Output style options
  pprUserLength         :: Int,
Ian Lynagh's avatar
Ian Lynagh committed
715
  pprCols               :: Int,
Ian Lynagh's avatar
Ian Lynagh committed
716
  traceLevel            :: Int, -- Standard level is 1. Less verbose is 0.
717

718 719
  useUnicodeQuotes      :: Bool,

720
  -- | what kind of {-# SCC #-} to add automatically
721 722
  profAuto              :: ProfAuto,

723
  interactivePrint      :: Maybe String,
724

725
  llvmVersion           :: IORef Int,
726

tibbe's avatar
tibbe committed
727 728 729 730
  nextWrapperNum        :: IORef Int,

  -- | Machine dependant flags (-m<blah> stuff)
  sseVersion            :: Maybe (Int, Int)  -- (major, minor)
731 732
 }

733 734 735
class HasDynFlags m where
    getDynFlags :: m DynFlags

Ian Lynagh's avatar
Ian Lynagh committed
736 737
class ContainsDynFlags t where
    extractDynFlags :: t -> DynFlags
738
    replaceDynFlags :: t -> DynFlags -> t
Ian Lynagh's avatar
Ian Lynagh committed
739

740 741 742 743 744
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
745
  | ProfAutoCalls      -- ^ annotate call-sites
Simon Marlow's avatar
Simon Marlow committed
746
  deriving (Enum)
747

748
data Settings = Settings {
749
  sTargetPlatform        :: Platform,    -- Filled in by SysTools
750 751 752 753 754 755 756 757 758
  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,
759 760 761
  sLdSupportsCompactUnwind :: Bool,
  sLdSupportsBuildId       :: Bool,
  sLdIsGnuLd               :: Bool,
762 763 764 765 766 767 768 769 770 771 772 773 774
  -- 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
775 776 777 778 779 780 781 782 783 784
  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
785
  sOpt_lc                :: [String], -- LLVM: llc static compiler
786

787
  sPlatformConstants     :: PlatformConstants
788 789
 }

790 791 792
targetPlatform :: DynFlags -> Platform
targetPlatform dflags = sTargetPlatform (settings dflags)

793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832
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)
833 834 835
opt_L                 :: DynFlags -> [String]
opt_L dflags = sOpt_L (settings dflags)
opt_P                 :: DynFlags -> [String]
836 837
opt_P dflags = concatMap (wayOptP (targetPlatform dflags)) (ways dflags)
            ++ sOpt_P (settings dflags)
838 839 840
opt_F                 :: DynFlags -> [String]
opt_F dflags = sOpt_F (settings dflags)
opt_c                 :: DynFlags -> [String]
841 842
opt_c dflags = concatMap (wayOptc (targetPlatform dflags)) (ways dflags)
            ++ sOpt_c (settings dflags)
843 844 845
opt_a                 :: DynFlags -> [String]
opt_a dflags = sOpt_a (settings dflags)
opt_l                 :: DynFlags -> [String]
846 847
opt_l dflags = concatMap (wayOptl (targetPlatform dflags)) (ways dflags)
            ++ sOpt_l (settings dflags)
848 849 850 851 852 853
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)
854

855 856
-- | The target code type of the compilation (if any).
--