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 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, 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 416 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
   | 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
442 443
   | Opt_WarnUnsafe
   | Opt_WarnSafe
Ian Lynagh's avatar
Ian Lynagh committed
444
   | Opt_WarnPointlessPragmas
445
   | Opt_WarnUnsupportedCallingConventions
446
   | Opt_WarnUnsupportedLlvmVersion
447
   | Opt_WarnInlineRuleShadowing
448
   | Opt_WarnTypeableInstances
449
   deriving (Eq, Show, Enum)
450

451
data Language = Haskell98 | Haskell2010
452
   deriving Enum
453

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

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

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

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

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

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

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

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

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

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

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

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

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

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

619 620 621 622 623 624 625 626
  -- 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
627
  outputFile            :: Maybe String,
ian@well-typed.com's avatar
ian@well-typed.com committed
628
  dynOutputFile         :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
629 630
  outputHi              :: Maybe String,
  dynLibLoader          :: DynLibLoader,
631

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

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

640
  ldInputs              :: [Option],
641

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

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

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

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

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

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

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

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

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

683

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

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

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

720 721
  maxWorkerArgs         :: Int,

722 723
  ghciHistSize          :: Int,

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

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

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

737 738
  useUnicodeQuotes      :: Bool,

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

742
  interactivePrint      :: Maybe String,
743

744
  llvmVersion           :: IORef Int,
745

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

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

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

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

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

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

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

810
  sPlatformConstants     :: PlatformConstants
811 812
 }

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

816 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
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<