DynFlags.hs 128 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_GHC -fno-warn-missing-fields #-}
-- So that tracingSettings works properly

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

52 53
        printOutputForUser, printInfoForUser,

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

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
Ian Lynagh's avatar
Ian Lynagh committed
76
        initDynFlags,                   -- DynFlags -> IO DynFlags
Ian Lynagh's avatar
Ian Lynagh committed
77
        defaultFatalMessager,
78
        defaultLogAction,
79
        defaultLogActionHPrintDoc,
80 81
        defaultFlushOut,
        defaultFlushErr,
Ian Lynagh's avatar
Ian Lynagh committed
82

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

89
        -- ** Parsing DynFlags
90 91
        parseDynamicFlagsCmdLine,
        parseDynamicFilePragma,
92 93 94
        parseDynamicFlagsFull,

        -- ** Available DynFlags
95
        allFlags,
96 97 98
        flagsAll,
        flagsDynamic,
        flagsPackage,
99

100
        supportedLanguagesAndExtensions,
101 102

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

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

        -- * Compiler configuration suitable for display to the user
110 111
        compilerInfo,

112
#ifdef GHCI
dterei's avatar
dterei committed
113
-- Only in stage 2 can we be sure that the RTS
114
-- exposes the appropriate runtime boolean
115
        rtsIsProfiled,
116
#endif
117 118
        -- ** Only for use in the tracing functions in Outputable
        tracingDynFlags,
119 120

#include "../includes/dist-derivedconstants/header/GHCConstantsHaskellExports.hs"
121
        bLOCK_SIZE_W,
122
        wORD_SIZE_IN_BITS,
123 124 125 126
  ) where

#include "HsVersions.h"

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

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

154
import Data.Char
155
import Data.List
156 157
import Data.Map (Map)
import qualified Data.Map as Map
158 159
import Data.Set (Set)
import qualified Data.Set as Set
Ian Lynagh's avatar
Ian Lynagh committed
160
import System.FilePath
161
import System.IO
162

163 164 165
import Data.IntSet (IntSet)
import qualified Data.IntSet as IntSet

166 167 168
-- -----------------------------------------------------------------------------
-- DynFlags

169
-- | Enumerates the simple on-or-off dynamic flags
170 171 172 173
data DynFlag

   -- debugging flags
   = Opt_D_dump_cmm
174
   | Opt_D_dump_raw_cmm
175
   | Opt_D_dump_cmmz
176 177
   -- All of the cmmz subflags (there are a lot!)  Automatically
   -- enabled if you run -ddump-cmmz
Simon Marlow's avatar
Simon Marlow committed
178
   | Opt_D_dump_cmmz_cfg
179 180 181 182 183 184 185 186 187 188 189 190 191
   | Opt_D_dump_cmmz_cbe
   | Opt_D_dump_cmmz_proc
   | Opt_D_dump_cmmz_spills
   | Opt_D_dump_cmmz_rewrite
   | Opt_D_dump_cmmz_dead
   | Opt_D_dump_cmmz_stub
   | Opt_D_dump_cmmz_sp
   | Opt_D_dump_cmmz_procmap
   | Opt_D_dump_cmmz_split
   | Opt_D_dump_cmmz_lower
   | Opt_D_dump_cmmz_info
   | Opt_D_dump_cmmz_cafs
   -- end cmmz subflags
192
   | Opt_D_dump_cps_cmm
193
   | Opt_D_dump_cvt_cmm
194
   | Opt_D_dump_asm
195 196
   | Opt_D_dump_asm_native
   | Opt_D_dump_asm_liveness
197
   | Opt_D_dump_asm_coalesce
198 199 200
   | Opt_D_dump_asm_regalloc
   | Opt_D_dump_asm_regalloc_stages
   | Opt_D_dump_asm_conflicts
201
   | Opt_D_dump_asm_stats
202
   | Opt_D_dump_asm_expanded
203
   | Opt_D_dump_llvm
204
   | Opt_D_dump_core_stats
205 206 207 208 209 210
   | Opt_D_dump_cpranal
   | Opt_D_dump_deriv
   | Opt_D_dump_ds
   | Opt_D_dump_flatC
   | Opt_D_dump_foreign
   | Opt_D_dump_inlinings
211
   | Opt_D_dump_rule_firings
212
   | Opt_D_dump_rule_rewrites
213 214 215
   | Opt_D_dump_occur_anal
   | Opt_D_dump_parsed
   | Opt_D_dump_rn
216
   | Opt_D_dump_core_pipeline -- TODO FIXME: dump after simplifier stats
217 218
   | Opt_D_dump_simpl
   | Opt_D_dump_simpl_iterations
219
   | Opt_D_dump_simpl_phases
220 221 222 223 224 225 226 227 228 229 230 231 232
   | 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
233
   | Opt_D_dump_cs_trace -- Constraint solver in type checker
234 235
   | Opt_D_dump_tc_trace
   | Opt_D_dump_if_trace
236
   | Opt_D_dump_vt_trace
237 238 239
   | Opt_D_dump_splices
   | Opt_D_dump_BCOs
   | Opt_D_dump_vect
240
   | Opt_D_dump_avoid_vect
241
   | Opt_D_dump_ticked
pepe's avatar
pepe committed
242
   | Opt_D_dump_rtti
243 244 245 246 247 248
   | Opt_D_source_stats
   | Opt_D_verbose_core2core
   | Opt_D_verbose_stg2stg
   | Opt_D_dump_hi
   | Opt_D_dump_hi_diffs
   | Opt_D_dump_minimal_imports
249
   | Opt_D_dump_mod_cycles
250
   | Opt_D_dump_view_pattern_commoning
251
   | Opt_D_faststring_stats
Ian Lynagh's avatar
Ian Lynagh committed
252
   | Opt_DumpToFile                     -- ^ Append dump output to files instead of stdout.
Simon Marlow's avatar
Simon Marlow committed
253
   | Opt_D_no_debug_output
254 255 256
   | Opt_DoCoreLinting
   | Opt_DoStgLinting
   | Opt_DoCmmLinting
Ben.Lippmeier@anu.edu.au's avatar
Ben.Lippmeier@anu.edu.au committed
257
   | Opt_DoAsmLinting
258
   | Opt_NoLlvmMangler                 -- hidden flag
259

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

262 263
   | Opt_PrintExplicitForalls

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

291 292 293 294 295
   -- Interface files
   | Opt_IgnoreInterfacePragmas
   | Opt_OmitInterfacePragmas
   | Opt_ExposeAllUnfoldings

Ian Lynagh's avatar
Ian Lynagh committed
296 297
   -- profiling opts
   | Opt_AutoSccsOnIndividualCafs
298
   | Opt_ProfCountEntries
Ian Lynagh's avatar
Ian Lynagh committed
299

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

337 338
   -- output style opts
   | Opt_PprCaseAsLet
339

340
   -- temporary flags
341
   | Opt_RunCPS
342
   | Opt_RunCPSZ
343
   | Opt_AutoLinkPackages
344
   | Opt_ImplicitImportQualified
345
   | Opt_TryNewCodeGen
346 347 348 349 350 351

   -- keeping stuff
   | Opt_KeepHiDiffs
   | Opt_KeepHcFiles
   | Opt_KeepSFiles
   | Opt_KeepTmpFiles
Jedai's avatar
Jedai committed
352
   | Opt_KeepRawTokenStream
353
   | Opt_KeepLlvmFiles
354

355
   -- safe haskell flags
dterei's avatar
dterei committed
356
   | Opt_DistrustAllPackages
357 358
   | Opt_PackageTrust

359
   deriving (Eq, Show, Enum)
Ian Lynagh's avatar
Ian Lynagh committed
360

361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393
data WarningFlag =
     Opt_WarnDuplicateExports
   | 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
394 395
   | Opt_WarnUnsafe
   | Opt_WarnSafe
Ian Lynagh's avatar
Ian Lynagh committed
396
   | Opt_WarnPointlessPragmas
397
   | Opt_WarnUnsupportedCallingConventions
398
   | Opt_WarnInlineRuleShadowing
399
   deriving (Eq, Show, Enum)
400

401
data Language = Haskell98 | Haskell2010
402
   deriving Enum
403

404
-- | The various Safe Haskell modes
405 406
data SafeHaskellMode
   = Sf_None
dterei's avatar
dterei committed
407
   | Sf_Unsafe
408 409
   | Sf_Trustworthy
   | Sf_Safe
410
   | Sf_SafeInferred
411 412
   deriving (Eq)

Ian Lynagh's avatar
Ian Lynagh committed
413
instance Show SafeHaskellMode where
Ian Lynagh's avatar
Ian Lynagh committed
414 415 416 417 418
    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
419

420
instance Outputable SafeHaskellMode where
Ian Lynagh's avatar
Ian Lynagh committed
421
    ppr = text . show
422

423
data ExtensionFlag
424 425 426 427 428 429 430
   = Opt_Cpp
   | Opt_OverlappingInstances
   | Opt_UndecidableInstances
   | Opt_IncoherentInstances
   | Opt_MonomorphismRestriction
   | Opt_MonoPatBinds
   | Opt_MonoLocalBinds
431 432
   | Opt_RelaxedPolyRec           -- Deprecated
   | Opt_ExtendedDefaultRules     -- Use GHC's extended rules for defaulting
433 434
   | Opt_ForeignFunctionInterface
   | Opt_UnliftedFFITypes
435
   | Opt_InterruptibleFFI
436
   | Opt_CApiFFI
437
   | Opt_GHCForeignImportPrim
438 439
   | Opt_ParallelArrays           -- Syntactic support for parallel arrays
   | Opt_Arrows                   -- Arrow-notation syntax
440 441 442 443 444 445 446 447 448 449 450 451 452 453
   | Opt_TemplateHaskell
   | Opt_QuasiQuotes
   | Opt_ImplicitParams
   | Opt_ImplicitPrelude
   | Opt_ScopedTypeVariables
   | 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
454
   | Opt_GADTSyntax
455
   | Opt_NPlusKPatterns
Ian Lynagh's avatar
Ian Lynagh committed
456
   | Opt_DoAndIfThenElse
457
   | Opt_RebindableSyntax
458
   | Opt_ConstraintKinds
dreixel's avatar
dreixel committed
459
   | Opt_PolyKinds                -- Kind polymorphism
dreixel's avatar
dreixel committed
460
   | Opt_DataKinds                -- Datatype promotion
461 462
   | Opt_InstanceSigs
 
463 464 465 466 467
   | Opt_StandaloneDeriving
   | Opt_DeriveDataTypeable
   | Opt_DeriveFunctor
   | Opt_DeriveTraversable
   | Opt_DeriveFoldable
468
   | Opt_DeriveGeneric            -- Allow deriving Generic/1
dreixel's avatar
dreixel committed
469
   | Opt_DefaultSignatures        -- Allow extra signatures for defmeths
470 471 472 473 474 475 476 477 478 479 480 481 482 483 484

   | Opt_TypeSynonymInstances
   | Opt_FlexibleContexts
   | Opt_FlexibleInstances
   | Opt_ConstrainedClassMethods
   | Opt_MultiParamTypeClasses
   | Opt_FunctionalDependencies
   | Opt_UnicodeSyntax
   | Opt_PolymorphicComponents
   | Opt_ExistentialQuantification
   | Opt_MagicHash
   | Opt_EmptyDataDecls
   | Opt_KindSignatures
   | Opt_ParallelListComp
   | Opt_TransformListComp
485
   | Opt_MonadComprehensions
486 487 488 489 490 491 492 493 494 495
   | Opt_GeneralizedNewtypeDeriving
   | Opt_RecursiveDo
   | Opt_PostfixOperators
   | Opt_TupleSections
   | Opt_PatternGuards
   | Opt_LiberalTypeSynonyms
   | Opt_Rank2Types
   | Opt_RankNTypes
   | Opt_ImpredicativeTypes
   | Opt_TypeOperators
496
   | Opt_ExplicitNamespaces
497 498 499 500 501
   | Opt_PackageImports
   | Opt_ExplicitForAll
   | Opt_AlternativeLayoutRule
   | Opt_AlternativeLayoutRuleTransitional
   | Opt_DatatypeContexts
502
   | Opt_NondecreasingIndentation
503
   | Opt_RelaxedLayout
504
   | Opt_TraditionalRecordSyntax
505
   | Opt_LambdaCase
506
   | Opt_MultiWayIf
507
   deriving (Eq, Enum, Show)
508

509 510
-- | Contains not only a collection of 'DynFlag's but also a plethora of
-- information relating to the compilation of a single file or GHC session
511
data DynFlags = DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
512 513 514
  ghcMode               :: GhcMode,
  ghcLink               :: GhcLink,
  hscTarget             :: HscTarget,
515
  settings              :: Settings,
516
  hscOutName            :: String,      -- ^ Name of the output file
517
  extCoreName           :: String,      -- ^ Name of the .hcr output file
518
  verbosity             :: Int,         -- ^ Verbosity level: see Note [Verbosity levels]
519 520 521
  optLevel              :: Int,         -- ^ Optimisation level
  simplPhases           :: Int,         -- ^ Number of simplifier phases
  maxSimplIterations    :: Int,         -- ^ Max simplifier iterations
522
  shouldDumpSimplPhase  :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
523
  ruleCheck             :: Maybe String,
524
  strictnessBefore      :: [Int],       -- ^ Additional demand analysis
525

526
  simplTickFactor       :: Int,         -- ^ Multiplier for simplifier ticks
527 528 529
  specConstrThreshold   :: Maybe Int,   -- ^ Threshold for SpecConstr
  specConstrCount       :: Maybe Int,   -- ^ Max number of specialisations for any one function
  liberateCaseThreshold :: Maybe Int,   -- ^ Threshold for LiberateCase
530
  floatLamArgs          :: Maybe Int,   -- ^ Arg count for lambda floating
531
                                        --   See CoreMonad.FloatOutSwitches
532
  historySize           :: Int,
533

534
  cmdlineHcIncludes     :: [String],    -- ^ @\-\#includes@
Ian Lynagh's avatar
Ian Lynagh committed
535 536 537
  importPaths           :: [FilePath],
  mainModIs             :: Module,
  mainFunIs             :: Maybe String,
538
  ctxtStkDepth          :: Int,         -- ^ Typechecker context stack depth
539

540
  thisPackage           :: PackageId,   -- ^ name of package currently being compiled
541 542

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

547 548 549
  -- For object splitting
  splitInfo             :: Maybe (String,Int),

550
  -- paths etc.
Ian Lynagh's avatar
Ian Lynagh committed
551
  objectDir             :: Maybe String,
552
  dylibInstallName      :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
553 554
  hiDir                 :: Maybe String,
  stubDir               :: Maybe String,
555
  dumpDir               :: Maybe String,
556

Ian Lynagh's avatar
Ian Lynagh committed
557 558 559
  objectSuf             :: String,
  hcSuf                 :: String,
  hiSuf                 :: String,
560

Ian Lynagh's avatar
Ian Lynagh committed
561 562 563
  outputFile            :: Maybe String,
  outputHi              :: Maybe String,
  dynLibLoader          :: DynLibLoader,
564

565
  -- | This is set by 'DriverPipeline.runPipeline' based on where
Ian Lynagh's avatar
Ian Lynagh committed
566 567
  --    its output is going.
  dumpPrefix            :: Maybe FilePath,
568

569 570
  -- | Override the 'dumpPrefix' set by 'DriverPipeline.runPipeline'.
  --    Set by @-ddump-file-prefix@
Ian Lynagh's avatar
Ian Lynagh committed
571 572
  dumpPrefixForce       :: Maybe FilePath,

573 574
  ldInputs              :: [String],

Ian Lynagh's avatar
Ian Lynagh committed
575 576 577 578 579
  includePaths          :: [String],
  libraryPaths          :: [String],
  frameworkPaths        :: [String],    -- used on darwin only
  cmdlineFrameworks     :: [String],    -- ditto

580
  rtsOpts               :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
581
  rtsOptsEnabled        :: RtsOptsEnabled,
582

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

585 586 587 588
  -- Plugins
  pluginModNames        :: [ModuleName],
  pluginModNameOpts     :: [(ModuleName,String)],

589 590 591 592 593 594
  --  For ghc -M
  depMakefile           :: FilePath,
  depIncludePkgDeps     :: Bool,
  depExcludeMods        :: [ModuleName],
  depSuffixes           :: [String],

595
  --  Package flags
596
  extraPkgConfs         :: [PkgConfRef] -> [PkgConfRef],
597
        -- ^ The @-package-db@ flags given on the command line, in the order
Ian Lynagh's avatar
Ian Lynagh committed
598
        -- they appeared.
599

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

603
  -- Package state
Ian Lynagh's avatar
Ian Lynagh committed
604
  -- NB. do not modify this field, it is calculated by
605
  -- Packages.initPackages and Packages.updatePackages.
606
  pkgDatabase           :: Maybe [PackageConfig],
Ian Lynagh's avatar
Ian Lynagh committed
607
  pkgState              :: PackageState,
608

609 610 611 612
  -- Temporary files
  -- These have to be IORefs, because the defaultCleanupHandler needs to
  -- know what to clean when an exception happens
  filesToClean          :: IORef [FilePath],
613
  dirsToClean           :: IORef (Map FilePath FilePath),
614

615 616 617 618 619
  -- 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),

620
  -- hsc dynamic flags
621 622
  flags                 :: IntSet,
  warningFlags          :: IntSet,
623
  -- Don't change this without updating extensionFlags:
624
  language              :: Maybe Language,
625 626
  -- | Safe Haskell mode
  safeHaskell           :: SafeHaskellMode,
627 628 629
  -- 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.
630 631
  thOnLoc               :: SrcSpan,
  newDerivOnLoc         :: SrcSpan,
632
  pkgTrustOnLoc         :: SrcSpan,
633 634
  warnSafeOnLoc         :: SrcSpan,
  warnUnsafeOnLoc       :: SrcSpan,
635 636 637 638
  -- Don't change this without updating extensionFlags:
  extensions            :: [OnOff ExtensionFlag],
  -- extensionFlags should always be equal to
  --     flattenExtensionFlags language extensions
639
  extensionFlags        :: IntSet,
Ian Lynagh's avatar
Ian Lynagh committed
640

641
  -- | MsgDoc output action: use "ErrUtils" instead of this if you can
642
  log_action            :: LogAction,
643 644
  flushOut              :: FlushOut,
  flushErr              :: FlushErr,
David Waern's avatar
David Waern committed
645

646
  haddockOptions        :: Maybe String,
647
  ghciScripts           :: [String],
648

649 650
  -- Output style options
  pprUserLength         :: Int,
Ian Lynagh's avatar
Ian Lynagh committed
651
  pprCols               :: Int,
Ian Lynagh's avatar
Ian Lynagh committed
652
  traceLevel            :: Int, -- Standard level is 1. Less verbose is 0.
653 654

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

657
  interactivePrint      :: Maybe String,
658

659
  llvmVersion           :: IORef (Int)
660 661
 }

662 663 664
class HasDynFlags m where
    getDynFlags :: m DynFlags

Ian Lynagh's avatar
Ian Lynagh committed
665 666 667
class ContainsDynFlags t where
    extractDynFlags :: t -> DynFlags

668 669 670 671 672
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
673
  | ProfAutoCalls      -- ^ annotate call-sites
Simon Marlow's avatar
Simon Marlow committed
674
  deriving (Enum)
675

676
data Settings = Settings {
677
  sTargetPlatform        :: Platform,    -- Filled in by SysTools
678 679 680 681 682 683 684 685 686
  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,
687 688 689
  sLdSupportsCompactUnwind :: Bool,
  sLdSupportsBuildId       :: Bool,
  sLdIsGnuLd               :: Bool,
690 691 692 693 694 695 696 697 698 699 700 701 702
  -- 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
703 704 705 706 707 708 709 710 711 712
  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
713
  sOpt_lc                :: [String], -- LLVM: llc static compiler
714

715
  sPlatformConstants     :: PlatformConstants
716 717
 }

718 719 720
targetPlatform :: DynFlags -> Platform
targetPlatform dflags = sTargetPlatform (settings dflags)

721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760
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)
761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778
opt_L                 :: DynFlags -> [String]
opt_L dflags = sOpt_L (settings dflags)
opt_P                 :: DynFlags -> [String]
opt_P dflags = sOpt_P (settings dflags)
opt_F                 :: DynFlags -> [String]
opt_F dflags = sOpt_F (settings dflags)
opt_c                 :: DynFlags -> [String]
opt_c dflags = sOpt_c (settings dflags)
opt_a                 :: DynFlags -> [String]
opt_a dflags = sOpt_a (settings dflags)
opt_l                 :: DynFlags -> [String]
opt_l dflags = sOpt_l (settings dflags)
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)
779

780 781
-- | The target code type of the compilation (if any).
--
782 783 784
-- Whenever you change the target, also make sure to set 'ghcLink' to
-- something sensible.
--
785 786 787 788
-- 'HscNothing' can be used to avoid generating any output, however, note
-- that:
--
--  * This will not run the desugaring step, thus no warnings generated in
789 790 791
--    this step will be output.  In particular, this includes warnings related
--    to pattern matching.  You can run the desugarer manually using
--    'GHC.desugarModule'.
792
--
793 794 795 796
--  * 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
797
--    different target or avoid typechecking such modules.  (The latter may be
798
--    preferable for security reasons.)
799
--
800
data HscTarget
801 802
  = HscC           -- ^ Generate C code.
  | HscAsm         -- ^ Generate assembly using the native code generator.
803
  | HscLlvm        -- ^ Generate assembly using the llvm code generator.
804 805
  | HscInterpreted -- ^ Generate bytecode.  (Requires 'LinkInMemory')
  | HscNothing     -- ^ Don't generate any code.  See notes above.
806 807
  deriving (Eq, Show)

Ian Lynagh's avatar
Ian Lynagh committed
808 809 810 811 812 813 814
showHscTargetFlag :: HscTarget -> String
showHscTargetFlag HscC           = "-fvia-c"
showHscTargetFlag HscAsm         = "-fasm"
showHscTargetFlag HscLlvm        = "-fllvm"
showHscTargetFlag HscInterpreted = "-fbyte-code"
showHscTargetFlag HscNothing     = "-fno-code"

815
-- | Will this target result in an object file on the disk?
816 817 818
isObjectTarget :: HscTarget -> Bool
isObjectTarget HscC     = True
isObjectTarget HscAsm   = True
819
isObjectTarget HscLlvm  = True
820 821
isObjectTarget _        = False

822 823 824 825 826 827 828 829 830 831 832
-- | Does this target retain *all* top-level bindings for a module,
-- rather than just the exported bindings, in the TypeEnv and compiled
-- code (if any)?  In interpreted mode we do this, so that GHCi can
-- call functions inside a module.  In HscNothing mode we also do it,
-- so that Haddock can get access to the GlobalRdrEnv for a module
-- after typechecking it.
targetRetainsAllBindings :: HscTarget -> Bool
targetRetainsAllBindings HscInterpreted = True
targetRetainsAllBindings HscNothing     = True
targetRetainsAllBindings _              = False

833 834 835 836 837 838
-- | The 'GhcMode' tells us whether we're doing multi-module
-- compilation (controlled via the "GHC" API) or one-shot
-- (single-module) compilation.  This makes a difference primarily to
-- the "Finder": in one-shot mode we look for interface files for
-- imported modules, but in multi-module mode we look for source files
-- in order to check whether they need to be recompiled.
839
data GhcMode
840 841 842
  = CompManager         -- ^ @\-\-make@, GHCi, etc.
  | OneShot             -- ^ @ghc -c Foo.hs@
  | MkDepend            -- ^ @ghc -M@, see "Finder" for why we need this
843 844
  deriving Eq

845 846 847 848 849
instance Outputable GhcMode where
  ppr CompManager = ptext (sLit "CompManager")
  ppr OneShot     = ptext (sLit "OneShot")
  ppr MkDepend    = ptext (sLit "MkDepend")

850 851 852 853
isOneShot :: GhcMode -> Bool
isOneShot OneShot = True
isOneShot _other  = False

854 855 856 857
-- | What to do in the link step, if there is one.
data GhcLink
  = NoLink              -- ^ Don't link at all
  | LinkBinary          -- ^ Link object code into a binary
858 859
  | LinkInMemory        -- ^ Use the in-memory dynamic linker (works for both
                        --   bytecode and object code).
860
  | LinkDynLib          -- ^ Link objects into a dynamic lib (DLL on Windows, DSO on ELF platforms)
861
  deriving (Eq, Show)
862 863 864

isNoLink :: GhcLink -> Bool
isNoLink NoLink = True
twanvl's avatar
twanvl committed
865
isNoLink _      = False
866 867

data PackageFlag
868
  = ExposePackage   String
869
  | ExposePackageId String
870 871 872 873
  | HidePackage     String
  | IgnorePackage   String
  | TrustPackage    String
  | DistrustPackage String
874
  deriving Eq
875

876
defaultHscTarget :: Platform -> HscTarget
877 878
defaultHscTarget = defaultObjectTarget

879
-- | The 'HscTarget' value corresponding to the default way to create
880
-- object files on the current platform.
881 882 883
defaultObjectTarget :: Platform -> HscTarget
defaultObjectTarget platform
  | platformUnregisterised platform     =  HscC