DynFlags.hs 144 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
        Way(..), mkBuildTag, wayRTSOnly, 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 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
   | Opt_FunToThunk               -- allow WwLib.mkWorkerArgs to remove all value lambdas
303

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

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

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

353 354 355 356
   -- PreInlining is on by default. The option is there just to see how
   -- bad things get if you turn it off!
   | Opt_SimplPreInlining

357
   -- output style opts
358 359
   | Opt_ErrorSpans -- Include full span info in error messages,
                    -- instead of just the start position.
360
   | Opt_PprCaseAsLet
361

362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378
   -- 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

379
   -- temporary flags
380
   | Opt_RunCPS
381
   | Opt_RunCPSZ
382
   | Opt_AutoLinkPackages
383
   | Opt_ImplicitImportQualified
384 385 386 387 388 389

   -- keeping stuff
   | Opt_KeepHiDiffs
   | Opt_KeepHcFiles
   | Opt_KeepSFiles
   | Opt_KeepTmpFiles
Jedai's avatar
Jedai committed
390
   | Opt_KeepRawTokenStream
391
   | Opt_KeepLlvmFiles
392

393 394
   | Opt_BuildDynamicToo

395
   -- safe haskell flags
dterei's avatar
dterei committed
396
   | Opt_DistrustAllPackages
397 398
   | Opt_PackageTrust

399
   deriving (Eq, Show, Enum)
Ian Lynagh's avatar
Ian Lynagh committed
400

401 402
data WarningFlag =
     Opt_WarnDuplicateExports
403
   | Opt_WarnDuplicateConstraints
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 431 432 433 434
   | 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
435 436
   | Opt_WarnUnsafe
   | Opt_WarnSafe
Ian Lynagh's avatar
Ian Lynagh committed
437
   | Opt_WarnPointlessPragmas
438
   | Opt_WarnUnsupportedCallingConventions
439
   | Opt_WarnUnsupportedLlvmVersion
440
   | Opt_WarnInlineRuleShadowing
441
   | Opt_WarnTypeableInstances
442
   deriving (Eq, Show, Enum)
443

444
data Language = Haskell98 | Haskell2010
445
   deriving Enum
446

447
-- | The various Safe Haskell modes
448 449
data SafeHaskellMode
   = Sf_None
dterei's avatar
dterei committed
450
   | Sf_Unsafe
451 452
   | Sf_Trustworthy
   | Sf_Safe
453
   | Sf_SafeInferred
454 455
   deriving (Eq)

Ian Lynagh's avatar
Ian Lynagh committed
456
instance Show SafeHaskellMode where
Ian Lynagh's avatar
Ian Lynagh committed
457 458 459 460 461
    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
462

463
instance Outputable SafeHaskellMode where
Ian Lynagh's avatar
Ian Lynagh committed
464
    ppr = text . show
465

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

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

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

571
  simplTickFactor       :: Int,         -- ^ Multiplier for simplifier ticks
572 573
  specConstrThreshold   :: Maybe Int,   -- ^ Threshold for SpecConstr
  specConstrCount       :: Maybe Int,   -- ^ Max number of specialisations for any one function
574 575
  specConstrRecursive   :: Int,         -- ^ Max number of specialisations for recursive types
                                        --   Not optional; otherwise ForceSpecConstr can diverge.
576
  liberateCaseThreshold :: Maybe Int,   -- ^ Threshold for LiberateCase
577
  floatLamArgs          :: Maybe Int,   -- ^ Arg count for lambda floating
578
                                        --   See CoreMonad.FloatOutSwitches
579
  historySize           :: Int,
580

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

587
  thisPackage           :: PackageId,   -- ^ name of package currently being compiled
588 589

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

594 595 596
  -- For object splitting
  splitInfo             :: Maybe (String,Int),

597
  -- paths etc.
Ian Lynagh's avatar
Ian Lynagh committed
598
  objectDir             :: Maybe String,
599
  dylibInstallName      :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
600 601
  hiDir                 :: Maybe String,
  stubDir               :: Maybe String,
602
  dumpDir               :: Maybe String,
603

Ian Lynagh's avatar
Ian Lynagh committed
604 605 606
  objectSuf             :: String,
  hcSuf                 :: String,
  hiSuf                 :: String,
607

608 609 610 611
  canGenerateDynamicToo :: IORef Bool,
  dynObjectSuf          :: String,
  dynHiSuf              :: String,

Ian Lynagh's avatar
Ian Lynagh committed
612
  outputFile            :: Maybe String,
ian@well-typed.com's avatar
ian@well-typed.com committed
613
  dynOutputFile         :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
614 615
  outputHi              :: Maybe String,
  dynLibLoader          :: DynLibLoader,
616

617
  -- | This is set by 'DriverPipeline.runPipeline' based on where
Ian Lynagh's avatar
Ian Lynagh committed
618 619
  --    its output is going.
  dumpPrefix            :: Maybe FilePath,
620

621 622
  -- | Override the 'dumpPrefix' set by 'DriverPipeline.runPipeline'.
  --    Set by @-ddump-file-prefix@
Ian Lynagh's avatar
Ian Lynagh committed
623 624
  dumpPrefixForce       :: Maybe FilePath,

625 626
  ldInputs              :: [String],

Ian Lynagh's avatar
Ian Lynagh committed
627 628 629 630 631
  includePaths          :: [String],
  libraryPaths          :: [String],
  frameworkPaths        :: [String],    -- used on darwin only
  cmdlineFrameworks     :: [String],    -- ditto

632
  rtsOpts               :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
633
  rtsOptsEnabled        :: RtsOptsEnabled,
634

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

637 638 639 640
  -- Plugins
  pluginModNames        :: [ModuleName],
  pluginModNameOpts     :: [(ModuleName,String)],

641 642 643 644 645 646
  --  For ghc -M
  depMakefile           :: FilePath,
  depIncludePkgDeps     :: Bool,
  depExcludeMods        :: [ModuleName],
  depSuffixes           :: [String],

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

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

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

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

668

669 670 671 672 673
  -- 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),

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

696 697 698 699 700 701 702 703 704
  -- Unfolding control
  -- See Note [Discounts and thresholds] in CoreUnfold
  ufCreationThreshold   :: Int,
  ufUseThreshold        :: Int,
  ufFunAppDiscount      :: Int,
  ufDictDiscount        :: Int,
  ufKeenessFactor       :: Float,
  ufDearOp              :: Int,

705 706
  maxWorkerArgs         :: Int,

707 708
  ghciHistSize          :: Int,

709
  -- | MsgDoc output action: use "ErrUtils" instead of this if you can
710
  log_action            :: LogAction,
711 712
  flushOut              :: FlushOut,
  flushErr              :: FlushErr,
David Waern's avatar
David Waern committed
713

714
  haddockOptions        :: Maybe String,
715
  ghciScripts           :: [String],
716

717 718
  -- Output style options
  pprUserLength         :: Int,
Ian Lynagh's avatar
Ian Lynagh committed
719
  pprCols               :: Int,
Ian Lynagh's avatar
Ian Lynagh committed
720
  traceLevel            :: Int, -- Standard level is 1. Less verbose is 0.
721

722 723
  useUnicodeQuotes      :: Bool,

724
  -- | what kind of {-# SCC #-} to add automatically
725 726
  profAuto              :: ProfAuto,

727
  interactivePrint      :: Maybe String,
728

729
  llvmVersion           :: IORef Int,
730

tibbe's avatar
tibbe committed
731 732 733 734
  nextWrapperNum        :: IORef Int,

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

737 738 739
class HasDynFlags m where
    getDynFlags :: m DynFlags

Ian Lynagh's avatar
Ian Lynagh committed
740 741
class ContainsDynFlags t where
    extractDynFlags :: t -> DynFlags
742
    replaceDynFlags :: t -> DynFlags -> t
Ian Lynagh's avatar
Ian Lynagh committed
743

744 745 746 747 748
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
749
  | ProfAutoCalls      -- ^ annotate call-sites
Simon Marlow's avatar
Simon Marlow committed
750
  deriving (Enum)
751

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

792
  sPlatformConstants     :: PlatformConstants
793 794
 }

795 796 797
targetPlatform :: DynFlags -> Platform
targetPlatform dflags = sTargetPlatform (settings dflags)

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 833 834 835 836 837
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)
838 839 840
opt_L                 :: DynFlags -> [String]
opt_L dflags = sOpt_L (settings dflags)
opt_P                 :: DynFlags -> [String]
841 842
opt_P dflags = concatMap (wayOptP (targetPlatform dflags)) (ways dflags)
            ++ sOpt_P (settings dflags)
843 844 845
opt_F                 :: DynFlags -> [String]
opt_F dflags = sOpt_F (settings dflags)
opt_c                 :: DynFlags -> [String]
846 847
opt_c dflags = concatMap (wayOptc (targetPlatform dflags)) (ways dflags)
            ++ sOpt_c (settings dflags)
848 849 850
opt_a                 :: DynFlags -> [String]
opt_a dflags = sOpt_a (settings dflags)
opt_l                 :: DynFlags -> [String]
ian@well-typed.com's avatar