DynFlags.hs 116 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
Ian Lynagh's avatar
Ian Lynagh committed
16
        DynFlag(..),
17
        WarningFlag(..),
18
        ExtensionFlag(..),
19
        Language(..),
Ian Lynagh's avatar
Ian Lynagh committed
20
        FatalMessager, LogAction, FlushOut(..), FlushErr(..),
21
        ProfAuto(..),
22
        glasgowExtsFlags,
23
24
25
        dopt,
        dopt_set,
        dopt_unset,
26
27
28
        wopt,
        wopt_set,
        wopt_unset,
29
30
31
        xopt,
        xopt_set,
        xopt_unset,
32
        lang_set,
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
        wayNames, dynFlagDependencies,
46

47
48
        printOutputForUser, printInfoForUser,

49
        -- ** Safe Haskell
50
        SafeHaskellMode(..),
51
        safeHaskellOn, safeImportsOn, safeLanguageOn, safeInferOn,
52
        packageTrustOn,
53
        safeDirectImpsReq, safeImplicitImpsReq,
54
        unsafeFlags,
55

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


67
        -- ** Manipulating DynFlags
68
        defaultDynFlags,                -- Settings -> DynFlags
Ian Lynagh's avatar
Ian Lynagh committed
69
        initDynFlags,                   -- DynFlags -> IO DynFlags
Ian Lynagh's avatar
Ian Lynagh committed
70
        defaultFatalMessager,
71
        defaultLogAction,
72
        defaultLogActionHPrintDoc,
73
74
        defaultFlushOut,
        defaultFlushErr,
Ian Lynagh's avatar
Ian Lynagh committed
75

76
        getOpts,                        -- DynFlags -> (DynFlags -> [a]) -> [a]
77
        getVerbFlags,
Ian Lynagh's avatar
Ian Lynagh committed
78
79
80
        updOptLevel,
        setTmpDir,
        setPackageName,
81
        doingTickyProfiling,
Ian Lynagh's avatar
Ian Lynagh committed
82

83
84
        setInteractivePrintName,        -- Name -> DynFlags -> DynFlags

85
        -- ** Parsing DynFlags
86
87
        parseDynamicFlagsCmdLine,
        parseDynamicFilePragma,
88
        allFlags,
89

90
        supportedLanguagesAndExtensions,
91
92

        -- ** DynFlag C compiler options
93
        picCCOpts,
94
95
96
97
98
99

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

        -- * Compiler configuration suitable for display to the user
100
101
        compilerInfo,

102
#ifdef GHCI
dterei's avatar
dterei committed
103
-- Only in stage 2 can we be sure that the RTS
104
-- exposes the appropriate runtime boolean
105
        rtsIsProfiled,
106
#endif
107
108
        -- ** Only for use in the tracing functions in Outputable
        tracingDynFlags,
109
110
111
112
  ) where

#include "HsVersions.h"

113
import Platform
114
import Name
115
import Module
Simon Marlow's avatar
Simon Marlow committed
116
import PackageConfig
117
import PrelNames        ( mAIN )
118
import StaticFlags
119
import {-# SOURCE #-} Packages (PackageState)
Ian Lynagh's avatar
Ian Lynagh committed
120
import DriverPhases     ( Phase(..), phaseInputExt )
121
122
import Config
import CmdLineParser
Ian Lynagh's avatar
Ian Lynagh committed
123
import Constants        ( mAX_CONTEXT_REDUCTION_DEPTH )
124
import Panic
125
import Util
126
import Maybes           ( orElse )
127
import qualified Pretty
128
import SrcLoc
129
import FastString
Simon Marlow's avatar
Simon Marlow committed
130
import Outputable
Ian Lynagh's avatar
Ian Lynagh committed
131
#ifdef GHCI
Ian Lynagh's avatar
Ian Lynagh committed
132
import Foreign.C        ( CInt(..) )
Ian Lynagh's avatar
Ian Lynagh committed
133
#endif
134
import {-# SOURCE #-} ErrUtils ( Severity(..), MsgDoc, mkLocMessage )
135

Ian Lynagh's avatar
Ian Lynagh committed
136
#ifdef GHCI
137
import System.IO.Unsafe ( unsafePerformIO )
Ian Lynagh's avatar
Ian Lynagh committed
138
#endif
139
import Data.IORef
Ian Lynagh's avatar
Ian Lynagh committed
140
import Control.Monad    ( when )
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
141

142
import Data.Char
143
import Data.List
144
145
import Data.Map (Map)
import qualified Data.Map as Map
146
147
import Data.Set (Set)
import qualified Data.Set as Set
Ian Lynagh's avatar
Ian Lynagh committed
148
import System.FilePath
149
import System.IO
150

151
152
153
import Data.IntSet (IntSet)
import qualified Data.IntSet as IntSet

154
155
156
-- -----------------------------------------------------------------------------
-- DynFlags

157
-- | Enumerates the simple on-or-off dynamic flags
158
159
160
161
data DynFlag

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

Ian Lynagh's avatar
Ian Lynagh committed
248
   | Opt_WarnIsError                    -- -Werror; makes warnings fatal
249

250
251
   | Opt_PrintExplicitForalls

252
253
254
   -- optimisation opts
   | Opt_Strictness
   | Opt_FullLaziness
255
256
   | Opt_FloatIn
   | Opt_Specialise
257
   | Opt_StaticArgumentTransformation
258
   | Opt_CSE
259
260
   | Opt_LiberateCase
   | Opt_SpecConstr
261
262
263
264
265
   | Opt_DoLambdaEtaExpansion
   | Opt_IgnoreAsserts
   | Opt_DoEtaReduction
   | Opt_CaseMerge
   | Opt_UnboxStrictFields
266
   | Opt_DictsCheap
267
   | Opt_EnableRewriteRules             -- Apply rewrite rules during simplification
rl@cse.unsw.edu.au's avatar
rl@cse.unsw.edu.au committed
268
   | Opt_Vectorise
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
269
   | Opt_AvoidVect
Ian Lynagh's avatar
Ian Lynagh committed
270
271
   | Opt_RegsGraph                      -- do graph coloring register allocation
   | Opt_RegsIterative                  -- do iterative coalescing graph coloring register allocation
272
   | Opt_PedanticBottoms                -- Be picky about how we treat bottom
273
274
   | Opt_LlvmTBAA                       -- Use LLVM TBAA infastructure for improving AA (hidden flag)
   | Opt_RegLiveness                    -- Use the STG Reg liveness information (hidden flag)
275
   | Opt_IrrefutableTuples
276

277
278
279
280
281
   -- Interface files
   | Opt_IgnoreInterfacePragmas
   | Opt_OmitInterfacePragmas
   | Opt_ExposeAllUnfoldings

Ian Lynagh's avatar
Ian Lynagh committed
282
283
   -- profiling opts
   | Opt_AutoSccsOnIndividualCafs
284
   | Opt_ProfCountEntries
Ian Lynagh's avatar
Ian Lynagh committed
285

286
287
   -- misc opts
   | Opt_Pp
288
   | Opt_ForceRecomp
289
   | Opt_ExcessPrecision
290
   | Opt_EagerBlackHoling
291
292
293
   | Opt_NoHsMain
   | Opt_SplitObjs
   | Opt_StgStats
294
   | Opt_HideAllPackages
295
   | Opt_PrintBindResult
296
   | Opt_Haddock
David Waern's avatar
David Waern committed
297
   | Opt_HaddockOptions
298
   | Opt_Hpc_No_Auto
299
   | Opt_BreakOnException
300
   | Opt_BreakOnError
301
   | Opt_PrintEvldWithShow
302
   | Opt_PrintBindContents
303
304
   | Opt_GenManifest
   | Opt_EmbedManifest
305
   | Opt_EmitExternalCore
Ian Lynagh's avatar
Ian Lynagh committed
306
   | Opt_SharedImplib
307
   | Opt_BuildingCabalPackage
308
   | Opt_SSE2
tibbe's avatar
tibbe committed
309
   | Opt_SSE4_2
310
   | Opt_IgnoreDotGhci
311
   | Opt_GhciSandbox
Ian Lynagh's avatar
Ian Lynagh committed
312
   | Opt_GhciHistory
313
   | Opt_HelpfulErrors
314
   | Opt_DeferTypeErrors
Ian Lynagh's avatar
Ian Lynagh committed
315
   | Opt_Parallel
Ian Lynagh's avatar
Ian Lynagh committed
316
   | Opt_GranMacros
317

318
319
320
   -- output style opts
   | Opt_PprCaseAsLet

321
   -- temporary flags
322
   | Opt_RunCPS
323
   | Opt_RunCPSZ
324
   | Opt_AutoLinkPackages
325
   | Opt_ImplicitImportQualified
326
   | Opt_TryNewCodeGen
327
328
329
330
331
332

   -- keeping stuff
   | Opt_KeepHiDiffs
   | Opt_KeepHcFiles
   | Opt_KeepSFiles
   | Opt_KeepTmpFiles
Jedai's avatar
Jedai committed
333
   | Opt_KeepRawTokenStream
334
   | Opt_KeepLlvmFiles
335

336
   -- safe haskell flags
dterei's avatar
dterei committed
337
   | Opt_DistrustAllPackages
338
339
   | Opt_PackageTrust

340
   deriving (Eq, Show, Enum)
Ian Lynagh's avatar
Ian Lynagh committed
341

342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
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
375
376
   | Opt_WarnUnsafe
   | Opt_WarnSafe
Ian Lynagh's avatar
Ian Lynagh committed
377
   | Opt_WarnPointlessPragmas
378
   | Opt_WarnUnsupportedCallingConventions
379
   deriving (Eq, Show, Enum)
380

381
data Language = Haskell98 | Haskell2010
382
   deriving Enum
383

384
-- | The various Safe Haskell modes
385
386
data SafeHaskellMode
   = Sf_None
dterei's avatar
dterei committed
387
   | Sf_Unsafe
388
389
   | Sf_Trustworthy
   | Sf_Safe
390
   | Sf_SafeInferred
391
392
   deriving (Eq)

Ian Lynagh's avatar
Ian Lynagh committed
393
instance Show SafeHaskellMode where
Ian Lynagh's avatar
Ian Lynagh committed
394
395
396
397
398
    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
399

400
instance Outputable SafeHaskellMode where
Ian Lynagh's avatar
Ian Lynagh committed
401
    ppr = text . show
402

403
data ExtensionFlag
404
405
406
407
408
409
410
   = Opt_Cpp
   | Opt_OverlappingInstances
   | Opt_UndecidableInstances
   | Opt_IncoherentInstances
   | Opt_MonomorphismRestriction
   | Opt_MonoPatBinds
   | Opt_MonoLocalBinds
411
412
   | Opt_RelaxedPolyRec           -- Deprecated
   | Opt_ExtendedDefaultRules     -- Use GHC's extended rules for defaulting
413
414
   | Opt_ForeignFunctionInterface
   | Opt_UnliftedFFITypes
415
   | Opt_InterruptibleFFI
416
   | Opt_CApiFFI
417
   | Opt_GHCForeignImportPrim
418
419
   | Opt_ParallelArrays           -- Syntactic support for parallel arrays
   | Opt_Arrows                   -- Arrow-notation syntax
420
421
422
423
424
425
426
427
428
429
430
431
432
433
   | 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
434
   | Opt_GADTSyntax
435
   | Opt_NPlusKPatterns
Ian Lynagh's avatar
Ian Lynagh committed
436
   | Opt_DoAndIfThenElse
437
   | Opt_RebindableSyntax
438
   | Opt_ConstraintKinds
dreixel's avatar
dreixel committed
439
   | Opt_PolyKinds                -- Kind polymorphism
dreixel's avatar
dreixel committed
440
   | Opt_DataKinds                -- Datatype promotion
441
442
   | Opt_InstanceSigs
 
443
444
445
446
447
   | Opt_StandaloneDeriving
   | Opt_DeriveDataTypeable
   | Opt_DeriveFunctor
   | Opt_DeriveTraversable
   | Opt_DeriveFoldable
448
   | Opt_DeriveGeneric            -- Allow deriving Generic/1
dreixel's avatar
dreixel committed
449
   | Opt_DefaultSignatures        -- Allow extra signatures for defmeths
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464

   | 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
465
   | Opt_MonadComprehensions
466
467
468
469
470
471
472
473
474
475
   | Opt_GeneralizedNewtypeDeriving
   | Opt_RecursiveDo
   | Opt_PostfixOperators
   | Opt_TupleSections
   | Opt_PatternGuards
   | Opt_LiberalTypeSynonyms
   | Opt_Rank2Types
   | Opt_RankNTypes
   | Opt_ImpredicativeTypes
   | Opt_TypeOperators
476
   | Opt_ExplicitNamespaces
477
478
479
480
481
   | Opt_PackageImports
   | Opt_ExplicitForAll
   | Opt_AlternativeLayoutRule
   | Opt_AlternativeLayoutRuleTransitional
   | Opt_DatatypeContexts
482
   | Opt_NondecreasingIndentation
483
   | Opt_RelaxedLayout
484
   | Opt_TraditionalRecordSyntax
485
   deriving (Eq, Enum, Show)
486

487
488
-- | 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
489
data DynFlags = DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
490
491
492
  ghcMode               :: GhcMode,
  ghcLink               :: GhcLink,
  hscTarget             :: HscTarget,
493
  settings              :: Settings,
494
  hscOutName            :: String,      -- ^ Name of the output file
495
  extCoreName           :: String,      -- ^ Name of the .hcr output file
496
  verbosity             :: Int,         -- ^ Verbosity level: see Note [Verbosity levels]
497
498
499
  optLevel              :: Int,         -- ^ Optimisation level
  simplPhases           :: Int,         -- ^ Number of simplifier phases
  maxSimplIterations    :: Int,         -- ^ Max simplifier iterations
500
  shouldDumpSimplPhase  :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
501
  ruleCheck             :: Maybe String,
502
  strictnessBefore      :: [Int],       -- ^ Additional demand analysis
503

504
  simplTickFactor       :: Int,         -- ^ Multiplier for simplifier ticks
505
506
507
  specConstrThreshold   :: Maybe Int,   -- ^ Threshold for SpecConstr
  specConstrCount       :: Maybe Int,   -- ^ Max number of specialisations for any one function
  liberateCaseThreshold :: Maybe Int,   -- ^ Threshold for LiberateCase
508
  floatLamArgs          :: Maybe Int,   -- ^ Arg count for lambda floating
509
                                        --   See CoreMonad.FloatOutSwitches
510

511
  cmdlineHcIncludes     :: [String],    -- ^ @\-\#includes@
Ian Lynagh's avatar
Ian Lynagh committed
512
513
514
  importPaths           :: [FilePath],
  mainModIs             :: Module,
  mainFunIs             :: Maybe String,
515
  ctxtStkDepth          :: Int,         -- ^ Typechecker context stack depth
516

517
  thisPackage           :: PackageId,   -- ^ name of package currently being compiled
518
519

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

524
525
526
  -- For object splitting
  splitInfo             :: Maybe (String,Int),

527
  -- paths etc.
Ian Lynagh's avatar
Ian Lynagh committed
528
  objectDir             :: Maybe String,
529
  dylibInstallName      :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
530
531
  hiDir                 :: Maybe String,
  stubDir               :: Maybe String,
532
  dumpDir               :: Maybe String,
533

Ian Lynagh's avatar
Ian Lynagh committed
534
535
536
  objectSuf             :: String,
  hcSuf                 :: String,
  hiSuf                 :: String,
537

Ian Lynagh's avatar
Ian Lynagh committed
538
539
540
  outputFile            :: Maybe String,
  outputHi              :: Maybe String,
  dynLibLoader          :: DynLibLoader,
541

542
  -- | This is set by 'DriverPipeline.runPipeline' based on where
Ian Lynagh's avatar
Ian Lynagh committed
543
544
  --    its output is going.
  dumpPrefix            :: Maybe FilePath,
545

546
547
  -- | Override the 'dumpPrefix' set by 'DriverPipeline.runPipeline'.
  --    Set by @-ddump-file-prefix@
Ian Lynagh's avatar
Ian Lynagh committed
548
549
550
551
552
553
554
  dumpPrefixForce       :: Maybe FilePath,

  includePaths          :: [String],
  libraryPaths          :: [String],
  frameworkPaths        :: [String],    -- used on darwin only
  cmdlineFrameworks     :: [String],    -- ditto

555
  rtsOpts               :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
556
  rtsOptsEnabled        :: RtsOptsEnabled,
557

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

560
561
562
563
  -- Plugins
  pluginModNames        :: [ModuleName],
  pluginModNameOpts     :: [(ModuleName,String)],

564
565
566
567
568
569
  --  For ghc -M
  depMakefile           :: FilePath,
  depIncludePkgDeps     :: Bool,
  depExcludeMods        :: [ModuleName],
  depSuffixes           :: [String],

570
  --  Package flags
571
  extraPkgConfs         :: [PkgConfRef] -> [PkgConfRef],
572
        -- ^ The @-package-db@ flags given on the command line, in the order
Ian Lynagh's avatar
Ian Lynagh committed
573
        -- they appeared.
574

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

578
  -- Package state
Ian Lynagh's avatar
Ian Lynagh committed
579
  -- NB. do not modify this field, it is calculated by
580
  -- Packages.initPackages and Packages.updatePackages.
581
  pkgDatabase           :: Maybe [PackageConfig],
Ian Lynagh's avatar
Ian Lynagh committed
582
  pkgState              :: PackageState,
583

584
585
586
587
  -- Temporary files
  -- These have to be IORefs, because the defaultCleanupHandler needs to
  -- know what to clean when an exception happens
  filesToClean          :: IORef [FilePath],
588
  dirsToClean           :: IORef (Map FilePath FilePath),
589

590
591
592
593
594
  -- 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),

595
  -- hsc dynamic flags
596
597
  flags                 :: IntSet,
  warningFlags          :: IntSet,
598
  -- Don't change this without updating extensionFlags:
599
  language              :: Maybe Language,
600
601
  -- | Safe Haskell mode
  safeHaskell           :: SafeHaskellMode,
602
603
604
  -- 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.
605
606
  thOnLoc               :: SrcSpan,
  newDerivOnLoc         :: SrcSpan,
607
  pkgTrustOnLoc         :: SrcSpan,
608
609
  warnSafeOnLoc         :: SrcSpan,
  warnUnsafeOnLoc       :: SrcSpan,
610
611
612
613
  -- Don't change this without updating extensionFlags:
  extensions            :: [OnOff ExtensionFlag],
  -- extensionFlags should always be equal to
  --     flattenExtensionFlags language extensions
614
  extensionFlags        :: IntSet,
Ian Lynagh's avatar
Ian Lynagh committed
615

616
  -- | MsgDoc output action: use "ErrUtils" instead of this if you can
617
  log_action            :: LogAction,
618
619
  flushOut              :: FlushOut,
  flushErr              :: FlushErr,
David Waern's avatar
David Waern committed
620

621
  haddockOptions        :: Maybe String,
622
  ghciScripts           :: [String],
623

624
625
  -- Output style options
  pprUserLength         :: Int,
Ian Lynagh's avatar
Ian Lynagh committed
626
  pprCols               :: Int,
Ian Lynagh's avatar
Ian Lynagh committed
627
  traceLevel            :: Int, -- Standard level is 1. Less verbose is 0.
628

629
  -- | what kind of {-# SCC #-} to add automatically
630
631
  profAuto              :: ProfAuto,

632
633
634
635
  llvmVersion           :: IORef (Int),

  interactivePrint      :: Maybe String,
  interactivePrintName  :: Maybe Name
636
637
 }

638
639
640
class HasDynFlags m where
    getDynFlags :: m DynFlags

Ian Lynagh's avatar
Ian Lynagh committed
641
642
643
class ContainsDynFlags t where
    extractDynFlags :: t -> DynFlags

644
645
646
647
648
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
649
  | ProfAutoCalls      -- ^ annotate call-sites
Simon Marlow's avatar
Simon Marlow committed
650
  deriving (Enum)
651

652
data Settings = Settings {
653
  sTargetPlatform        :: Platform,    -- Filled in by SysTools
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
  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,
  -- 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
676
677
678
679
680
681
682
683
684
685
686
687
  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
  sOpt_lc                :: [String]  -- LLVM: llc static compiler

688
689
 }

690
691
692
targetPlatform :: DynFlags -> Platform
targetPlatform dflags = sTargetPlatform (settings dflags)

693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
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)
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
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)
751

752
753
754
wayNames :: DynFlags -> [WayName]
wayNames = map wayName . ways

755
756
-- | The target code type of the compilation (if any).
--
757
758
759
-- Whenever you change the target, also make sure to set 'ghcLink' to
-- something sensible.
--
760
761
762
763
-- 'HscNothing' can be used to avoid generating any output, however, note
-- that:
--
--  * This will not run the desugaring step, thus no warnings generated in
764
765
766
--    this step will be output.  In particular, this includes warnings related
--    to pattern matching.  You can run the desugarer manually using
--    'GHC.desugarModule'.
767
--
768
769
770
771
--  * 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
Simon Hengel's avatar
Simon Hengel committed
772
--    different target or avoid typechecking such modules.  (The latter may be
773
--    preferable for security reasons.)
774
--
775
data HscTarget
776
777
  = HscC           -- ^ Generate C code.
  | HscAsm         -- ^ Generate assembly using the native code generator.
778
  | HscLlvm        -- ^ Generate assembly using the llvm code generator.
779
780
  | HscInterpreted -- ^ Generate bytecode.  (Requires 'LinkInMemory')
  | HscNothing     -- ^ Don't generate any code.  See notes above.
781
782
  deriving (Eq, Show)

Ian Lynagh's avatar
Ian Lynagh committed
783
784
785
786
787
788
789
showHscTargetFlag :: HscTarget -> String
showHscTargetFlag HscC           = "-fvia-c"
showHscTargetFlag HscAsm         = "-fasm"
showHscTargetFlag HscLlvm        = "-fllvm"
showHscTargetFlag HscInterpreted = "-fbyte-code"
showHscTargetFlag HscNothing     = "-fno-code"

790
-- | Will this target result in an object file on the disk?
791
792
793
isObjectTarget :: HscTarget -> Bool
isObjectTarget HscC     = True
isObjectTarget HscAsm   = True
794
isObjectTarget HscLlvm  = True
795
796
isObjectTarget _        = False

797
798
799
800
801
802
803
804
805
806
807
-- | 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

808
809
810
811
812
813
-- | 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.
814
data GhcMode
815
816
817
  = CompManager         -- ^ @\-\-make@, GHCi, etc.
  | OneShot             -- ^ @ghc -c Foo.hs@
  | MkDepend            -- ^ @ghc -M@, see "Finder" for why we need this
818
819
  deriving Eq

820
821
822
823
824
instance Outputable GhcMode where
  ppr CompManager = ptext (sLit "CompManager")
  ppr OneShot     = ptext (sLit "OneShot")
  ppr MkDepend    = ptext (sLit "MkDepend")

825
826
827
828
isOneShot :: GhcMode -> Bool
isOneShot OneShot = True
isOneShot _other  = False

829
830
831
832
-- | 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
833
834
  | LinkInMemory        -- ^ Use the in-memory dynamic linker (works for both
                        --   bytecode and object code).
835
  | LinkDynLib          -- ^ Link objects into a dynamic lib (DLL on Windows, DSO on ELF platforms)
836
  deriving (Eq, Show)
837
838
839

isNoLink :: GhcLink -> Bool
isNoLink NoLink = True
twanvl's avatar
twanvl committed
840
isNoLink _      = False
841

842
843
844
-- Is it worth evaluating this Bool and caching it in the DynFlags value
-- during initDynFlags?
doingTickyProfiling :: DynFlags -> Bool
845
846
847
doingTickyProfiling _ = opt_Ticky
  -- XXX -ticky is a static flag, because it implies -debug which is also
  -- static.  If the way flags were made dynamic, we could fix this.
848

849
data PackageFlag
850
  = ExposePackage   String
851
  | ExposePackageId String
852
853
854
855
  | HidePackage     String
  | IgnorePackage   String
  | TrustPackage    String
  | DistrustPackage String
856
  deriving Eq
857

twanvl's avatar
twanvl committed
858
defaultHscTarget :: HscTarget
859
860
defaultHscTarget = defaultObjectTarget

861
-- | The 'HscTarget' value corresponding to the default way to create
862
-- object files on the current platform.
twanvl's avatar
twanvl committed
863
defaultObjectTarget :: HscTarget
864
defaultObjectTarget
865
  | cGhcUnregisterised    == "YES"      =  HscC
Ian Lynagh's avatar
Ian Lynagh committed
866
  | cGhcWithNativeCodeGen == "YES"      =  HscAsm
867
  | otherwise                           =  HscLlvm
868

869
870
871
872
873
data DynLibLoader
  = Deployable
  | SystemDependent
  deriving Eq

Ian Lynagh's avatar
Ian Lynagh committed
874
data RtsOptsEnabled = RtsOptsNone | RtsOptsSafeOnly | RtsOptsAll
875
  deriving (Show)
Ian Lynagh's avatar
Ian Lynagh committed
876

877
-- | Used by 'GHC.newSession' to partially initialize a new 'DynFlags' value
twanvl's avatar
twanvl committed
878
initDynFlags :: DynFlags -> IO DynFlags
879
880
881
initDynFlags dflags = do
 -- someday these will be dynamic flags
 ways <- readIORef v_Ways
882
 refFilesToClean <- newIORef []
883
 refDirsToClean <- newIORef Map.empty
884
 refGeneratedDumps <- newIORef Set.empty
885
 refLlvmVersion <- newIORef 28
886
 return dflags{
887
888
889
890
891
892
893
        ways           = ways,
        buildTag       = mkBuildTag (filter (not . wayRTSOnly) ways),
        rtsBuildTag    = mkBuildTag ways,
        filesToClean   = refFilesToClean,
        dirsToClean    = refDirsToClean,
        generatedDumps = refGeneratedDumps,
        llvmVersion    = refLlvmVersion
Ian Lynagh's avatar
Ian Lynagh committed
894
        }
895

896
897
-- | The normal 'DynFlags'. Note that they is not suitable for use in this form
-- and must be fully initialized by 'GHC.newSession' first.
898
899
defaultDynFlags :: Settings -> DynFlags
defaultDynFlags mySettings =
900
     DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
901
902
903
904
905
906
907
        ghcMode                 = CompManager,
        ghcLink                 = LinkBinary,
        hscTarget               = defaultHscTarget,
        hscOutName              = "",
        extCoreName             = "",
        verbosity               = 0,
        optLevel                = 0,
908
        simplPhases             = 2,
Ian Lynagh's avatar
Ian Lynagh committed
909
        maxSimplIterations      = 4,
910
        shouldDumpSimplPhase    = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
911
        ruleCheck               = Nothing,
dterei's avatar
dterei committed
912
        simplTickFactor         = 100,
913
        specConstrThreshold     = Just 2000,
Ian Lynagh's avatar
Ian Lynagh committed
914
        specConstrCount         = Just 3,
915
        liberateCaseThreshold   = Just 2000,
916
        floatLamArgs            = Just 0, -- Default: float only if no fvs
917
918
        strictnessBefore        = [],

Ian Lynagh's avatar
Ian Lynagh committed
919
920
921
922
923
924
925
926
927
        cmdlineHcIncludes       = [],
        importPaths             = ["."],
        mainModIs               = mAIN,
        mainFunIs               = Nothing,
        ctxtStkDepth            = mAX_CONTEXT_REDUCTION_DEPTH,

        thisPackage             = mainPackageId,

        objectDir               = Nothing,
928
        dylibInstallName        = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
929
930
        hiDir                   = Nothing,
        stubDir                 = Nothing,
931
        dumpDir                 = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
932
933
934
935
936

        objectSuf               = phaseInputExt StopLn,
        hcSuf                   = phaseInputExt HCc,
        hiSuf                   = "hi",

937
938
939
        pluginModNames          = [],
        pluginModNameOpts       = [],

Ian Lynagh's avatar
Ian Lynagh committed
940
941
        outputFile              = Nothing,
        outputHi                = Nothing,
942
        dynLibLoader            = SystemDependent,
Ian Lynagh's avatar
Ian Lynagh committed
943
944
945
946
947
948
        dumpPrefix              = Nothing,
        dumpPrefixForce         = Nothing,
        includePaths            = [],
        libraryPaths            = [],
        frameworkPaths          = [],
        cmdlineFrameworks       = [],
949
        rtsOpts                 = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
950
        rtsOptsEnabled          = RtsOptsSafeOnly,
Ian Lynagh's avatar
Ian Lynagh committed
951
952
953

        hpcDir                  = ".hpc",

pcapriotti's avatar