DynFlags.hs 141 KB
Newer Older
dterei's avatar
dterei committed
1
-------------------------------------------------------------------------------
2
--
dterei's avatar
dterei committed
3 4 5 6 7 8
-- | Dynamic flags
--
-- Most flags are dynamic flags, which means they can change from compilation
-- to compilation using @OPTIONS_GHC@ pragmas, and in a multi-session GHC each
-- session can be using different dynamic flags. Dynamic flags can also be set
-- at the prompt in GHCi.
9 10 11
--
-- (c) The University of Glasgow 2005
--
dterei's avatar
dterei committed
12
-------------------------------------------------------------------------------
13 14

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

48 49
        printOutputForUser, printInfoForUser,

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

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

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


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

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

86
        -- ** Parsing DynFlags
87 88
        parseDynamicFlagsCmdLine,
        parseDynamicFilePragma,
89 90 91
        parseDynamicFlagsFull,

        -- ** Available DynFlags
92
        allFlags,
93 94 95
        flagsAll,
        flagsDynamic,
        flagsPackage,
96

97
        supportedLanguagesAndExtensions,
98

99
        -- ** DynFlags C compiler options
Ian Lynagh's avatar
Ian Lynagh committed
100
        picCCOpts, picPOpts,
101 102 103 104 105 106

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

        -- * Compiler configuration suitable for display to the user
107 108
        compilerInfo,

109
#ifdef GHCI
dterei's avatar
dterei committed
110
-- Only in stage 2 can we be sure that the RTS
111
-- exposes the appropriate runtime boolean
112
        rtsIsProfiled,
113
#endif
114 115

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

        -- * SSE
        isSse2Enabled,
        isSse4_2Enabled,
125 126 127 128
  ) where

#include "HsVersions.h"

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

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

158
import Data.Bits
159
import Data.Char
160
import Data.Int
161
import Data.List
162 163
import Data.Map (Map)
import qualified Data.Map as Map
164 165
import Data.Set (Set)
import qualified Data.Set as Set
166
import Data.Word
Ian Lynagh's avatar
Ian Lynagh committed
167
import System.FilePath
168
import System.IO
169

170 171 172
import Data.IntSet (IntSet)
import qualified Data.IntSet as IntSet

173 174 175
-- -----------------------------------------------------------------------------
-- DynFlags

176
data DumpFlag
177 178 179

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

Ian Lynagh's avatar
Ian Lynagh committed
261
   | Opt_WarnIsError                    -- -Werror; makes warnings fatal
262

263 264
   | Opt_PrintExplicitForalls

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

294 295 296 297 298
   -- Interface files
   | Opt_IgnoreInterfacePragmas
   | Opt_OmitInterfacePragmas
   | Opt_ExposeAllUnfoldings

Ian Lynagh's avatar
Ian Lynagh committed
299 300
   -- profiling opts
   | Opt_AutoSccsOnIndividualCafs
301
   | Opt_ProfCountEntries
Ian Lynagh's avatar
Ian Lynagh committed
302

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

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

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

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

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

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

382 383
   | Opt_BuildDynamicToo

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

388
   deriving (Eq, Show, Enum)
Ian Lynagh's avatar
Ian Lynagh committed
389

390 391
data WarningFlag =
     Opt_WarnDuplicateExports
392
   | Opt_WarnDuplicateConstraints
393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423
   | 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
424 425
   | Opt_WarnUnsafe
   | Opt_WarnSafe
Ian Lynagh's avatar
Ian Lynagh committed
426
   | Opt_WarnPointlessPragmas
427
   | Opt_WarnUnsupportedCallingConventions
428
   | Opt_WarnInlineRuleShadowing
429
   deriving (Eq, Show, Enum)
430

431
data Language = Haskell98 | Haskell2010
432
   deriving Enum
433

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

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

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

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

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

540
-- | Contains not only a collection of 'GeneralFlag's but also a plethora of
541
-- information relating to the compilation of a single file or GHC session
542
data DynFlags = DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
543 544 545
  ghcMode               :: GhcMode,
  ghcLink               :: GhcLink,
  hscTarget             :: HscTarget,
546
  settings              :: Settings,
547
  hscOutName            :: String,      -- ^ Name of the output file
548
  extCoreName           :: String,      -- ^ Name of the .hcr output file
549
  verbosity             :: Int,         -- ^ Verbosity level: see Note [Verbosity levels]
550 551 552
  optLevel              :: Int,         -- ^ Optimisation level
  simplPhases           :: Int,         -- ^ Number of simplifier phases
  maxSimplIterations    :: Int,         -- ^ Max simplifier iterations
553
  shouldDumpSimplPhase  :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
554
  ruleCheck             :: Maybe String,
555
  strictnessBefore      :: [Int],       -- ^ Additional demand analysis
556

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

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

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

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

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

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

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

592 593 594 595
  canGenerateDynamicToo :: IORef Bool,
  dynObjectSuf          :: String,
  dynHiSuf              :: String,

Ian Lynagh's avatar
Ian Lynagh committed
596
  outputFile            :: Maybe String,
ian@well-typed.com's avatar
ian@well-typed.com committed
597
  dynOutputFile         :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
598 599
  outputHi              :: Maybe String,
  dynLibLoader          :: DynLibLoader,
600

601
  -- | This is set by 'DriverPipeline.runPipeline' based on where
Ian Lynagh's avatar
Ian Lynagh committed
602 603
  --    its output is going.
  dumpPrefix            :: Maybe FilePath,
604

605 606
  -- | Override the 'dumpPrefix' set by 'DriverPipeline.runPipeline'.
  --    Set by @-ddump-file-prefix@
Ian Lynagh's avatar
Ian Lynagh committed
607 608
  dumpPrefixForce       :: Maybe FilePath,

609 610
  ldInputs              :: [String],

Ian Lynagh's avatar
Ian Lynagh committed
611 612 613 614 615
  includePaths          :: [String],
  libraryPaths          :: [String],
  frameworkPaths        :: [String],    -- used on darwin only
  cmdlineFrameworks     :: [String],    -- ditto

616
  rtsOpts               :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
617
  rtsOptsEnabled        :: RtsOptsEnabled,
618

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

621 622 623 624
  -- Plugins
  pluginModNames        :: [ModuleName],
  pluginModNameOpts     :: [(ModuleName,String)],

625 626 627 628 629 630
  --  For ghc -M
  depMakefile           :: FilePath,
  depIncludePkgDeps     :: Bool,
  depExcludeMods        :: [ModuleName],
  depSuffixes           :: [String],

631
  --  Package flags
632
  extraPkgConfs         :: [PkgConfRef] -> [PkgConfRef],
633
        -- ^ The @-package-db@ flags given on the command line, in the order
Ian Lynagh's avatar
Ian Lynagh committed
634
        -- they appeared.
635

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

639
  -- Package state
Ian Lynagh's avatar
Ian Lynagh committed
640
  -- NB. do not modify this field, it is calculated by
641
  -- Packages.initPackages and Packages.updatePackages.
642
  pkgDatabase           :: Maybe [PackageConfig],
Ian Lynagh's avatar
Ian Lynagh committed
643
  pkgState              :: PackageState,
644

645 646 647 648
  -- Temporary files
  -- These have to be IORefs, because the defaultCleanupHandler needs to
  -- know what to clean when an exception happens
  filesToClean          :: IORef [FilePath],
649
  dirsToClean           :: IORef (Map FilePath FilePath),
650 651
  filesToNotIntermediateClean :: IORef [FilePath],

652

653 654 655 656 657
  -- 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),

658
  -- hsc dynamic flags
659 660
  dumpFlags             :: IntSet,
  generalFlags          :: IntSet,
661
  warningFlags          :: IntSet,
662
  -- Don't change this without updating extensionFlags:
663
  language              :: Maybe Language,
664 665
  -- | Safe Haskell mode
  safeHaskell           :: SafeHaskellMode,
666 667 668
  -- 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.
669 670
  thOnLoc               :: SrcSpan,
  newDerivOnLoc         :: SrcSpan,
671
  pkgTrustOnLoc         :: SrcSpan,
672 673
  warnSafeOnLoc         :: SrcSpan,
  warnUnsafeOnLoc       :: SrcSpan,
674 675 676 677
  -- Don't change this without updating extensionFlags:
  extensions            :: [OnOff ExtensionFlag],
  -- extensionFlags should always be equal to
  --     flattenExtensionFlags language extensions
678
  extensionFlags        :: IntSet,
Ian Lynagh's avatar
Ian Lynagh committed
679

680 681 682 683 684 685 686 687 688
  -- Unfolding control
  -- See Note [Discounts and thresholds] in CoreUnfold
  ufCreationThreshold   :: Int,
  ufUseThreshold        :: Int,
  ufFunAppDiscount      :: Int,
  ufDictDiscount        :: Int,
  ufKeenessFactor       :: Float,
  ufDearOp              :: Int,

689 690
  maxWorkerArgs         :: Int,

691 692
  ghciHistSize          :: Int,

693
  -- | MsgDoc output action: use "ErrUtils" instead of this if you can
694
  log_action            :: LogAction,
695 696
  flushOut              :: FlushOut,
  flushErr              :: FlushErr,
David Waern's avatar
David Waern committed
697

698
  haddockOptions        :: Maybe String,
699
  ghciScripts           :: [String],
700

701 702
  -- Output style options
  pprUserLength         :: Int,
Ian Lynagh's avatar
Ian Lynagh committed
703
  pprCols               :: Int,
Ian Lynagh's avatar
Ian Lynagh committed
704
  traceLevel            :: Int, -- Standard level is 1. Less verbose is 0.
705 706

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

709
  interactivePrint      :: Maybe String,
710

711
  llvmVersion           :: IORef Int,
712 713

  nextWrapperNum        :: IORef Int
714 715
 }

716 717 718
class HasDynFlags m where
    getDynFlags :: m DynFlags

Ian Lynagh's avatar
Ian Lynagh committed
719 720
class ContainsDynFlags t where
    extractDynFlags :: t -> DynFlags
721
    replaceDynFlags :: t -> DynFlags -> t
Ian Lynagh's avatar
Ian Lynagh committed
722

723 724 725 726 727
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
728
  | ProfAutoCalls      -- ^ annotate call-sites
Simon Marlow's avatar
Simon Marlow committed
729
  deriving (Enum)
730

731
data Settings = Settings {
732
  sTargetPlatform        :: Platform,    -- Filled in by SysTools
733 734 735 736 737 738 739 740 741
  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,
742 743 744
  sLdSupportsCompactUnwind :: Bool,
  sLdSupportsBuildId       :: Bool,
  sLdIsGnuLd               :: Bool,
745 746 747 748 749 750 751 752 753 754 755 756 757
  -- 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
758 759 760 761 762 763 764 765 766 767
  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
768
  sOpt_lc                :: [String], -- LLVM: llc static compiler
769

770
  sPlatformConstants     :: PlatformConstants
771 772
 }

773 774 775
targetPlatform :: DynFlags -> Platform
targetPlatform dflags = sTargetPlatform (settings dflags)

776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815
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)
816 817 818
opt_L                 :: DynFlags -> [String]
opt_L dflags = sOpt_L (settings dflags)
opt_P                 :: DynFlags -> [String]
819 820
opt_P dflags = concatMap (wayOptP (targetPlatform dflags)) (ways dflags)
            ++ sOpt_P (settings dflags)
821 822 823
opt_F                 :: DynFlags -> [String]
opt_F dflags = sOpt_F (settings dflags)
opt_c                 :: DynFlags -> [String]
824 825
opt_c dflags = concatMap (wayOptc (targetPlatform dflags)) (ways dflags)
            ++ sOpt_c (settings dflags)
826 827 828
opt_a                 :: DynFlags -> [String]
opt_a dflags = sOpt_a (settings dflags)
opt_l                 :: DynFlags -> [String]
829 830
opt_l dflags = concatMap (wayOptl (targetPlatform dflags)) (ways dflags)
            ++ sOpt_l (settings dflags)
831 832 833 834 835 836
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)
837

838 839
-- | The target code type of the compilation (if any).
--
840 841 842
-- Whenever you change the target, also make sure to set 'ghcLink' to
-- something sensible.
--
843 844 845 846
-- 'HscNothing' can be used to avoid generating any output, however, note
-- that:
--
--  * This will not run the desugaring step, thus no warnings generated in
847 848 849
--    this step will be output.  In particular, this includes warnings related
--    to pattern matching.  You can run the desugarer manually using
--    'GHC.desugarModule'.
850
--
851 852 853 854
--  * If a program uses Template Haskell the typechecker may try to run code
--    from an imported module.  This will fail if no code has been generated
--    for this module.  You can use 'GHC.needsTemplateHaskell' to detect
--    whether this might be the case and choose to either switch to a
SimonHengel's avatar
SimonHengel committed
855
--    different target or avoid typechecking such modules.  (The latter may be
856
--    preferable for security reasons.)
857
--
858
data HscTarget
859 860
  = HscC           -- ^ Generate C code.
  | HscAsm         -- ^ Generate assembly using the native code generator.
861
  | HscLlvm        -- ^ Generate assembly using the llvm code generator.
862 863
  | HscInterpreted -- ^ Generate bytecode.  (Requires 'LinkInMemory')
  | HscNothing     -- ^ Don't generate any code.  See notes above.
864 865
  deriving (Eq, Show)