DynFlags.hs 110 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
        LogAction, FlushOut(..), FlushErr(..),
20
        ProfAuto(..),
21
        glasgowExtsFlags,
22
23
24
        dopt,
        dopt_set,
        dopt_unset,
25
26
27
        wopt,
        wopt_set,
        wopt_unset,
28
29
30
        xopt,
        xopt_set,
        xopt_unset,
Ian Lynagh's avatar
Ian Lynagh committed
31
        DynFlags(..),
Ian Lynagh's avatar
Ian Lynagh committed
32
        HasDynFlags(..), ContainsDynFlags(..),
Ian Lynagh's avatar
Ian Lynagh committed
33
        RtsOptsEnabled(..),
Ian Lynagh's avatar
Ian Lynagh committed
34
        HscTarget(..), isObjectTarget, defaultObjectTarget,
35
        targetRetainsAllBindings,
Ian Lynagh's avatar
Ian Lynagh committed
36
37
38
        GhcMode(..), isOneShot,
        GhcLink(..), isNoLink,
        PackageFlag(..),
Ian Lynagh's avatar
Ian Lynagh committed
39
        Option(..), showOpt,
Ian Lynagh's avatar
Ian Lynagh committed
40
        DynLibLoader(..),
41
        fFlags, fWarningFlags, fLangFlags, xFlags,
42
        wayNames, dynFlagDependencies,
43

44
        -- ** Safe Haskell
45
        SafeHaskellMode(..),
46
        safeHaskellOn, safeImportsOn, safeLanguageOn, safeInferOn,
47
        packageTrustOn,
48
        safeDirectImpsReq, safeImplicitImpsReq,
49

50
        -- ** System tool settings and locations
51
        Settings(..),
52
        targetPlatform,
53
54
55
56
        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
57
        opt_L, opt_P, opt_F, opt_c, opt_a, opt_l,
58
        opt_windres, opt_lo, opt_lc,
59
60


61
        -- ** Manipulating DynFlags
62
        defaultDynFlags,                -- Settings -> DynFlags
Ian Lynagh's avatar
Ian Lynagh committed
63
        initDynFlags,                   -- DynFlags -> IO DynFlags
64
        defaultLogAction,
65
66
        defaultFlushOut,
        defaultFlushErr,
Ian Lynagh's avatar
Ian Lynagh committed
67

68
        getOpts,                        -- DynFlags -> (DynFlags -> [a]) -> [a]
69
        getVerbFlags,
Ian Lynagh's avatar
Ian Lynagh committed
70
71
72
        updOptLevel,
        setTmpDir,
        setPackageName,
73
        doingTickyProfiling,
Ian Lynagh's avatar
Ian Lynagh committed
74

75
        -- ** Parsing DynFlags
76
77
        parseDynamicFlagsCmdLine,
        parseDynamicFilePragma,
78
        allFlags,
79

80
        supportedLanguagesAndExtensions,
81
82

        -- ** DynFlag C compiler options
83
        picCCOpts,
84
85
86
87
88
89

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

        -- * Compiler configuration suitable for display to the user
90
91
        compilerInfo
#ifdef GHCI
dterei's avatar
dterei committed
92
-- Only in stage 2 can we be sure that the RTS
93
-- exposes the appropriate runtime boolean
dterei's avatar
dterei committed
94
      , rtsIsProfiled
95
#endif
96
97
98
99
  ) where

#include "HsVersions.h"

100
import Platform
101
import Module
Simon Marlow's avatar
Simon Marlow committed
102
import PackageConfig
103
import PrelNames        ( mAIN )
104
import StaticFlags
105
import {-# SOURCE #-} Packages (PackageState)
Ian Lynagh's avatar
Ian Lynagh committed
106
import DriverPhases     ( Phase(..), phaseInputExt )
107
108
import Config
import CmdLineParser
Ian Lynagh's avatar
Ian Lynagh committed
109
import Constants        ( mAX_CONTEXT_REDUCTION_DEPTH )
110
import Panic
111
import Util
112
import Maybes           ( orElse )
113
import SrcLoc
114
import FastString
Simon Marlow's avatar
Simon Marlow committed
115
import Outputable
Ian Lynagh's avatar
Ian Lynagh committed
116
#ifdef GHCI
Ian Lynagh's avatar
Ian Lynagh committed
117
import Foreign.C        ( CInt(..) )
Ian Lynagh's avatar
Ian Lynagh committed
118
#endif
119
import {-# SOURCE #-} ErrUtils ( Severity(..), MsgDoc, mkLocMessage )
120

Ian Lynagh's avatar
Ian Lynagh committed
121
#ifdef GHCI
122
import System.IO.Unsafe ( unsafePerformIO )
Ian Lynagh's avatar
Ian Lynagh committed
123
#endif
124
import Data.IORef
Ian Lynagh's avatar
Ian Lynagh committed
125
import Control.Monad    ( when )
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
126

127
import Data.Char
128
import Data.List
129
130
import Data.Map (Map)
import qualified Data.Map as Map
131
132
import Data.Set (Set)
import qualified Data.Set as Set
Ian Lynagh's avatar
Ian Lynagh committed
133
import System.FilePath
134
import System.IO
135

136
137
138
import Data.IntSet (IntSet)
import qualified Data.IntSet as IntSet

139
140
141
-- -----------------------------------------------------------------------------
-- DynFlags

142
-- | Enumerates the simple on-or-off dynamic flags
143
144
145
146
data DynFlag

   -- debugging flags
   = Opt_D_dump_cmm
147
   | Opt_D_dump_raw_cmm
148
   | Opt_D_dump_cmmz
149
   | Opt_D_dump_cmmz_pretty
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
   -- 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
165
   | Opt_D_dump_cps_cmm
166
   | Opt_D_dump_cvt_cmm
167
   | Opt_D_dump_asm
168
169
   | Opt_D_dump_asm_native
   | Opt_D_dump_asm_liveness
170
   | Opt_D_dump_asm_coalesce
171
172
173
   | Opt_D_dump_asm_regalloc
   | Opt_D_dump_asm_regalloc_stages
   | Opt_D_dump_asm_conflicts
174
   | Opt_D_dump_asm_stats
175
   | Opt_D_dump_asm_expanded
176
   | Opt_D_dump_llvm
177
   | Opt_D_dump_core_stats
178
179
180
181
182
183
   | Opt_D_dump_cpranal
   | Opt_D_dump_deriv
   | Opt_D_dump_ds
   | Opt_D_dump_flatC
   | Opt_D_dump_foreign
   | Opt_D_dump_inlinings
184
   | Opt_D_dump_rule_firings
185
   | Opt_D_dump_rule_rewrites
186
187
188
   | Opt_D_dump_occur_anal
   | Opt_D_dump_parsed
   | Opt_D_dump_rn
189
   | Opt_D_dump_core_pipeline -- TODO FIXME: dump after simplifier stats
190
191
   | Opt_D_dump_simpl
   | Opt_D_dump_simpl_iterations
192
   | Opt_D_dump_simpl_phases
193
194
195
196
197
198
199
200
201
202
203
204
205
   | 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
206
   | Opt_D_dump_cs_trace -- Constraint solver in type checker
207
208
   | Opt_D_dump_tc_trace
   | Opt_D_dump_if_trace
209
   | Opt_D_dump_vt_trace
210
211
212
   | Opt_D_dump_splices
   | Opt_D_dump_BCOs
   | Opt_D_dump_vect
213
   | Opt_D_dump_ticked
pepe's avatar
pepe committed
214
   | Opt_D_dump_rtti
215
216
217
218
219
220
   | 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
221
   | Opt_D_dump_mod_cycles
222
   | Opt_D_dump_view_pattern_commoning
223
   | Opt_D_faststring_stats
Ian Lynagh's avatar
Ian Lynagh committed
224
   | Opt_DumpToFile                     -- ^ Append dump output to files instead of stdout.
Simon Marlow's avatar
Simon Marlow committed
225
   | Opt_D_no_debug_output
226
227
228
   | Opt_DoCoreLinting
   | Opt_DoStgLinting
   | Opt_DoCmmLinting
Ben.Lippmeier@anu.edu.au's avatar
Ben.Lippmeier@anu.edu.au committed
229
   | Opt_DoAsmLinting
230
   | Opt_NoLlvmMangler
231

Ian Lynagh's avatar
Ian Lynagh committed
232
   | Opt_WarnIsError                    -- -Werror; makes warnings fatal
233

234
235
   | Opt_PrintExplicitForalls

236
237
238
   -- optimisation opts
   | Opt_Strictness
   | Opt_FullLaziness
239
240
   | Opt_FloatIn
   | Opt_Specialise
241
   | Opt_StaticArgumentTransformation
242
   | Opt_CSE
243
244
   | Opt_LiberateCase
   | Opt_SpecConstr
245
246
247
248
249
   | Opt_DoLambdaEtaExpansion
   | Opt_IgnoreAsserts
   | Opt_DoEtaReduction
   | Opt_CaseMerge
   | Opt_UnboxStrictFields
250
   | Opt_DictsCheap
251
   | Opt_EnableRewriteRules             -- Apply rewrite rules during simplification
rl@cse.unsw.edu.au's avatar
rl@cse.unsw.edu.au committed
252
   | Opt_Vectorise
Ian Lynagh's avatar
Ian Lynagh committed
253
254
   | Opt_RegsGraph                      -- do graph coloring register allocation
   | Opt_RegsIterative                  -- do iterative coalescing graph coloring register allocation
255
   | Opt_PedanticBottoms                -- Be picky about how we treat bottom
256
   | Opt_LlvmTBAA                       -- Use LLVM TBAA infastructure for improving AA
257
   | Opt_RegLiveness                    -- Use the STG Reg liveness information
258

259
260
261
262
263
   -- Interface files
   | Opt_IgnoreInterfacePragmas
   | Opt_OmitInterfacePragmas
   | Opt_ExposeAllUnfoldings

Ian Lynagh's avatar
Ian Lynagh committed
264
265
   -- profiling opts
   | Opt_AutoSccsOnIndividualCafs
266
   | Opt_ProfCountEntries
Ian Lynagh's avatar
Ian Lynagh committed
267

268
269
   -- misc opts
   | Opt_Pp
270
   | Opt_ForceRecomp
271
   | Opt_ExcessPrecision
272
   | Opt_EagerBlackHoling
273
274
275
276
   | Opt_ReadUserPackageConf
   | Opt_NoHsMain
   | Opt_SplitObjs
   | Opt_StgStats
277
   | Opt_HideAllPackages
278
   | Opt_PrintBindResult
279
   | Opt_Haddock
David Waern's avatar
David Waern committed
280
   | Opt_HaddockOptions
281
   | Opt_Hpc_No_Auto
282
   | Opt_BreakOnException
283
   | Opt_BreakOnError
284
   | Opt_PrintEvldWithShow
285
   | Opt_PrintBindContents
286
287
   | Opt_GenManifest
   | Opt_EmbedManifest
288
   | Opt_EmitExternalCore
Ian Lynagh's avatar
Ian Lynagh committed
289
   | Opt_SharedImplib
290
   | Opt_BuildingCabalPackage
291
   | Opt_SSE2
tibbe's avatar
tibbe committed
292
   | Opt_SSE4_2
293
   | Opt_GhciSandbox
Ian Lynagh's avatar
Ian Lynagh committed
294
   | Opt_GhciHistory
295
   | Opt_HelpfulErrors
296
   | Opt_DeferTypeErrors
297

298
   -- temporary flags
299
   | Opt_RunCPS
300
   | Opt_RunCPSZ
301
   | Opt_AutoLinkPackages
302
   | Opt_ImplicitImportQualified
303
   | Opt_TryNewCodeGen
304
305
306
307
308
309

   -- keeping stuff
   | Opt_KeepHiDiffs
   | Opt_KeepHcFiles
   | Opt_KeepSFiles
   | Opt_KeepTmpFiles
Jedai's avatar
Jedai committed
310
   | Opt_KeepRawTokenStream
311
   | Opt_KeepLlvmFiles
312

313
   -- safe haskell flags
dterei's avatar
dterei committed
314
   | Opt_DistrustAllPackages
315
316
   | Opt_PackageTrust

317
   deriving (Eq, Show, Enum)
Ian Lynagh's avatar
Ian Lynagh committed
318

319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
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
352
353
   | Opt_WarnUnsafe
   | Opt_WarnSafe
Ian Lynagh's avatar
Ian Lynagh committed
354
   | Opt_WarnPointlessPragmas
355
   deriving (Eq, Show, Enum)
356

357
data Language = Haskell98 | Haskell2010
358
   deriving Enum
359

360
-- | The various Safe Haskell modes
361
362
data SafeHaskellMode
   = Sf_None
dterei's avatar
dterei committed
363
   | Sf_Unsafe
364
365
   | Sf_Trustworthy
   | Sf_Safe
dterei's avatar
dterei committed
366
   | Sf_SafeInfered
367
368
   deriving (Eq)

369
instance Outputable SafeHaskellMode where
dterei's avatar
dterei committed
370
371
    ppr Sf_None        = ptext $ sLit "None"
    ppr Sf_Unsafe      = ptext $ sLit "Unsafe"
372
    ppr Sf_Trustworthy = ptext $ sLit "Trustworthy"
dterei's avatar
dterei committed
373
374
    ppr Sf_Safe        = ptext $ sLit "Safe"
    ppr Sf_SafeInfered = ptext $ sLit "Safe-Infered"
375

376
data ExtensionFlag
377
378
379
380
381
382
383
   = Opt_Cpp
   | Opt_OverlappingInstances
   | Opt_UndecidableInstances
   | Opt_IncoherentInstances
   | Opt_MonomorphismRestriction
   | Opt_MonoPatBinds
   | Opt_MonoLocalBinds
384
385
   | Opt_RelaxedPolyRec           -- Deprecated
   | Opt_ExtendedDefaultRules     -- Use GHC's extended rules for defaulting
386
387
   | Opt_ForeignFunctionInterface
   | Opt_UnliftedFFITypes
388
   | Opt_InterruptibleFFI
389
   | Opt_CApiFFI
390
   | Opt_GHCForeignImportPrim
391
392
   | Opt_ParallelArrays           -- Syntactic support for parallel arrays
   | Opt_Arrows                   -- Arrow-notation syntax
393
394
395
396
397
398
399
400
401
402
403
404
405
406
   | 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
407
   | Opt_GADTSyntax
408
   | Opt_NPlusKPatterns
Ian Lynagh's avatar
Ian Lynagh committed
409
   | Opt_DoAndIfThenElse
410
   | Opt_RebindableSyntax
411
   | Opt_ConstraintKinds
dreixel's avatar
dreixel committed
412
   | Opt_PolyKinds                -- Kind polymorphism
dreixel's avatar
dreixel committed
413
   | Opt_DataKinds                -- Datatype promotion
414
415
   | Opt_InstanceSigs
 
416
417
418
419
420
   | Opt_StandaloneDeriving
   | Opt_DeriveDataTypeable
   | Opt_DeriveFunctor
   | Opt_DeriveTraversable
   | Opt_DeriveFoldable
421
   | Opt_DeriveGeneric            -- Allow deriving Generic/1
dreixel's avatar
dreixel committed
422
   | Opt_DefaultSignatures        -- Allow extra signatures for defmeths
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437

   | 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
438
   | Opt_MonadComprehensions
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
   | Opt_GeneralizedNewtypeDeriving
   | Opt_RecursiveDo
   | Opt_DoRec
   | Opt_PostfixOperators
   | Opt_TupleSections
   | Opt_PatternGuards
   | Opt_LiberalTypeSynonyms
   | Opt_Rank2Types
   | Opt_RankNTypes
   | Opt_ImpredicativeTypes
   | Opt_TypeOperators
   | Opt_PackageImports
   | Opt_ExplicitForAll
   | Opt_AlternativeLayoutRule
   | Opt_AlternativeLayoutRuleTransitional
   | Opt_DatatypeContexts
455
   | Opt_NondecreasingIndentation
456
   | Opt_RelaxedLayout
457
   | Opt_TraditionalRecordSyntax
458
   deriving (Eq, Enum, Show)
459

460
461
-- | 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
462
data DynFlags = DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
463
464
465
  ghcMode               :: GhcMode,
  ghcLink               :: GhcLink,
  hscTarget             :: HscTarget,
466
  settings              :: Settings,
467
  hscOutName            :: String,      -- ^ Name of the output file
468
  extCoreName           :: String,      -- ^ Name of the .hcr output file
469
  verbosity             :: Int,         -- ^ Verbosity level: see Note [Verbosity levels]
470
471
472
  optLevel              :: Int,         -- ^ Optimisation level
  simplPhases           :: Int,         -- ^ Number of simplifier phases
  maxSimplIterations    :: Int,         -- ^ Max simplifier iterations
473
  shouldDumpSimplPhase  :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
474
  ruleCheck             :: Maybe String,
475
  strictnessBefore      :: [Int],       -- ^ Additional demand analysis
476

477
  simplTickFactor       :: Int,         -- ^ Multiplier for simplifier ticks
478
479
480
  specConstrThreshold   :: Maybe Int,   -- ^ Threshold for SpecConstr
  specConstrCount       :: Maybe Int,   -- ^ Max number of specialisations for any one function
  liberateCaseThreshold :: Maybe Int,   -- ^ Threshold for LiberateCase
481
  floatLamArgs          :: Maybe Int,   -- ^ Arg count for lambda floating
482
                                        --   See CoreMonad.FloatOutSwitches
483

484
  cmdlineHcIncludes     :: [String],    -- ^ @\-\#includes@
Ian Lynagh's avatar
Ian Lynagh committed
485
486
487
  importPaths           :: [FilePath],
  mainModIs             :: Module,
  mainFunIs             :: Maybe String,
488
  ctxtStkDepth          :: Int,         -- ^ Typechecker context stack depth
489

490
  thisPackage           :: PackageId,   -- ^ name of package currently being compiled
491
492

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

497
498
499
  -- For object splitting
  splitInfo             :: Maybe (String,Int),

500
  -- paths etc.
Ian Lynagh's avatar
Ian Lynagh committed
501
  objectDir             :: Maybe String,
502
  dylibInstallName      :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
503
504
  hiDir                 :: Maybe String,
  stubDir               :: Maybe String,
505
  dumpDir               :: Maybe String,
506

Ian Lynagh's avatar
Ian Lynagh committed
507
508
509
  objectSuf             :: String,
  hcSuf                 :: String,
  hiSuf                 :: String,
510

Ian Lynagh's avatar
Ian Lynagh committed
511
512
513
  outputFile            :: Maybe String,
  outputHi              :: Maybe String,
  dynLibLoader          :: DynLibLoader,
514

515
  -- | This is set by 'DriverPipeline.runPipeline' based on where
Ian Lynagh's avatar
Ian Lynagh committed
516
517
  --    its output is going.
  dumpPrefix            :: Maybe FilePath,
518

519
520
  -- | Override the 'dumpPrefix' set by 'DriverPipeline.runPipeline'.
  --    Set by @-ddump-file-prefix@
Ian Lynagh's avatar
Ian Lynagh committed
521
522
523
524
525
526
527
  dumpPrefixForce       :: Maybe FilePath,

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

528
  rtsOpts               :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
529
  rtsOptsEnabled        :: RtsOptsEnabled,
530

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

533
534
535
536
  -- Plugins
  pluginModNames        :: [ModuleName],
  pluginModNameOpts     :: [(ModuleName,String)],

537
538
539
540
541
542
  --  For ghc -M
  depMakefile           :: FilePath,
  depIncludePkgDeps     :: Bool,
  depExcludeMods        :: [ModuleName],
  depSuffixes           :: [String],

543
  --  Package flags
Ian Lynagh's avatar
Ian Lynagh committed
544
  extraPkgConfs         :: [FilePath],
545
        -- ^ The @-package-conf@ flags given on the command line, in the order
Ian Lynagh's avatar
Ian Lynagh committed
546
        -- they appeared.
547

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

551
  -- Package state
Ian Lynagh's avatar
Ian Lynagh committed
552
  -- NB. do not modify this field, it is calculated by
553
  -- Packages.initPackages and Packages.updatePackages.
554
  pkgDatabase           :: Maybe [PackageConfig],
Ian Lynagh's avatar
Ian Lynagh committed
555
  pkgState              :: PackageState,
556

557
558
559
560
  -- Temporary files
  -- These have to be IORefs, because the defaultCleanupHandler needs to
  -- know what to clean when an exception happens
  filesToClean          :: IORef [FilePath],
561
  dirsToClean           :: IORef (Map FilePath FilePath),
562

563
564
565
566
567
  -- 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),

568
  -- hsc dynamic flags
569
570
  flags                 :: IntSet,
  warningFlags          :: IntSet,
571
  -- Don't change this without updating extensionFlags:
572
  language              :: Maybe Language,
573
574
  -- | Safe Haskell mode
  safeHaskell           :: SafeHaskellMode,
575
576
577
  -- 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.
578
579
  thOnLoc               :: SrcSpan,
  newDerivOnLoc         :: SrcSpan,
580
  pkgTrustOnLoc         :: SrcSpan,
581
582
  warnSafeOnLoc         :: SrcSpan,
  warnUnsafeOnLoc       :: SrcSpan,
583
584
585
586
  -- Don't change this without updating extensionFlags:
  extensions            :: [OnOff ExtensionFlag],
  -- extensionFlags should always be equal to
  --     flattenExtensionFlags language extensions
587
  extensionFlags        :: IntSet,
Ian Lynagh's avatar
Ian Lynagh committed
588

589
  -- | MsgDoc output action: use "ErrUtils" instead of this if you can
590
  log_action            :: LogAction,
591
592
  flushOut              :: FlushOut,
  flushErr              :: FlushErr,
David Waern's avatar
David Waern committed
593

594
595
596
  haddockOptions        :: Maybe String,

  -- | what kind of {-# SCC #-} to add automatically
597
598
599
  profAuto              :: ProfAuto,

  llvmVersion           :: IORef (Int)
600
601
 }

602
603
604
class HasDynFlags m where
    getDynFlags :: m DynFlags

Ian Lynagh's avatar
Ian Lynagh committed
605
606
607
class ContainsDynFlags t where
    extractDynFlags :: t -> DynFlags

608
609
610
611
612
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
613
  | ProfAutoCalls      -- ^ annotate call-sites
Simon Marlow's avatar
Simon Marlow committed
614
  deriving (Enum)
615

616
data Settings = Settings {
617
  sTargetPlatform        :: Platform,    -- Filled in by SysTools
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
  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
640
641
642
643
644
645
646
647
648
649
650
651
  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

652
653
 }

654
655
656
targetPlatform :: DynFlags -> Platform
targetPlatform dflags = sTargetPlatform (settings dflags)

657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
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)
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
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)
715

716
717
718
wayNames :: DynFlags -> [WayName]
wayNames = map wayName . ways

719
720
-- | The target code type of the compilation (if any).
--
721
722
723
-- Whenever you change the target, also make sure to set 'ghcLink' to
-- something sensible.
--
724
725
726
727
-- 'HscNothing' can be used to avoid generating any output, however, note
-- that:
--
--  * This will not run the desugaring step, thus no warnings generated in
728
729
730
--    this step will be output.  In particular, this includes warnings related
--    to pattern matching.  You can run the desugarer manually using
--    'GHC.desugarModule'.
731
--
732
733
734
735
--  * 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
736
--    different target or avoid typechecking such modules.  (The latter may be
737
--    preferable for security reasons.)
738
--
739
data HscTarget
740
741
  = HscC           -- ^ Generate C code.
  | HscAsm         -- ^ Generate assembly using the native code generator.
742
  | HscLlvm        -- ^ Generate assembly using the llvm code generator.
743
744
  | HscInterpreted -- ^ Generate bytecode.  (Requires 'LinkInMemory')
  | HscNothing     -- ^ Don't generate any code.  See notes above.
745
746
  deriving (Eq, Show)

Ian Lynagh's avatar
Ian Lynagh committed
747
748
749
750
751
752
753
showHscTargetFlag :: HscTarget -> String
showHscTargetFlag HscC           = "-fvia-c"
showHscTargetFlag HscAsm         = "-fasm"
showHscTargetFlag HscLlvm        = "-fllvm"
showHscTargetFlag HscInterpreted = "-fbyte-code"
showHscTargetFlag HscNothing     = "-fno-code"

754
-- | Will this target result in an object file on the disk?
755
756
757
isObjectTarget :: HscTarget -> Bool
isObjectTarget HscC     = True
isObjectTarget HscAsm   = True
758
isObjectTarget HscLlvm  = True
759
760
isObjectTarget _        = False

761
762
763
764
765
766
767
768
769
770
771
-- | 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

772
773
774
775
776
777
-- | 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.
778
data GhcMode
779
780
781
  = CompManager         -- ^ @\-\-make@, GHCi, etc.
  | OneShot             -- ^ @ghc -c Foo.hs@
  | MkDepend            -- ^ @ghc -M@, see "Finder" for why we need this
782
783
  deriving Eq

784
785
786
787
788
instance Outputable GhcMode where
  ppr CompManager = ptext (sLit "CompManager")
  ppr OneShot     = ptext (sLit "OneShot")
  ppr MkDepend    = ptext (sLit "MkDepend")

789
790
791
792
isOneShot :: GhcMode -> Bool
isOneShot OneShot = True
isOneShot _other  = False

793
794
795
796
-- | 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
797
798
  | LinkInMemory        -- ^ Use the in-memory dynamic linker (works for both
                        --   bytecode and object code).
799
  | LinkDynLib          -- ^ Link objects into a dynamic lib (DLL on Windows, DSO on ELF platforms)
800
  deriving (Eq, Show)
801
802
803

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

806
807
808
-- Is it worth evaluating this Bool and caching it in the DynFlags value
-- during initDynFlags?
doingTickyProfiling :: DynFlags -> Bool
809
810
811
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.
812

813
data PackageFlag
814
  = ExposePackage   String
815
  | ExposePackageId String
816
817
818
819
  | HidePackage     String
  | IgnorePackage   String
  | TrustPackage    String
  | DistrustPackage String
820
  deriving Eq
821

twanvl's avatar
twanvl committed
822
defaultHscTarget :: HscTarget
823
824
defaultHscTarget = defaultObjectTarget

825
-- | The 'HscTarget' value corresponding to the default way to create
826
-- object files on the current platform.
twanvl's avatar
twanvl committed
827
defaultObjectTarget :: HscTarget
828
defaultObjectTarget
829
  | cGhcUnregisterised    == "YES"      =  HscC
Ian Lynagh's avatar
Ian Lynagh committed
830
  | cGhcWithNativeCodeGen == "YES"      =  HscAsm
831
  | otherwise                           =  HscLlvm
832

833
834
835
836
837
data DynLibLoader
  = Deployable
  | SystemDependent
  deriving Eq

Ian Lynagh's avatar
Ian Lynagh committed
838
data RtsOptsEnabled = RtsOptsNone | RtsOptsSafeOnly | RtsOptsAll
839
  deriving (Show)
Ian Lynagh's avatar
Ian Lynagh committed
840

841
-- | Used by 'GHC.newSession' to partially initialize a new 'DynFlags' value
twanvl's avatar
twanvl committed
842
initDynFlags :: DynFlags -> IO DynFlags
843
844
845
initDynFlags dflags = do
 -- someday these will be dynamic flags
 ways <- readIORef v_Ways
846
 refFilesToClean <- newIORef []
847
 refDirsToClean <- newIORef Map.empty
848
 refGeneratedDumps <- newIORef Set.empty
849
 refLlvmVersion <- newIORef 28
850
 return dflags{
851
852
853
854
855
856
857
        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
858
        }
859

860
861
-- | The normal 'DynFlags'. Note that they is not suitable for use in this form
-- and must be fully initialized by 'GHC.newSession' first.
862
863
defaultDynFlags :: Settings -> DynFlags
defaultDynFlags mySettings =
864
     DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
865
866
867
868
869
870
871
        ghcMode                 = CompManager,
        ghcLink                 = LinkBinary,
        hscTarget               = defaultHscTarget,
        hscOutName              = "",
        extCoreName             = "",
        verbosity               = 0,
        optLevel                = 0,
872
        simplPhases             = 2,
Ian Lynagh's avatar
Ian Lynagh committed
873
        maxSimplIterations      = 4,
874
        shouldDumpSimplPhase    = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
875
        ruleCheck               = Nothing,
dterei's avatar
dterei committed
876
        simplTickFactor         = 100,
877
        specConstrThreshold     = Just 2000,
Ian Lynagh's avatar
Ian Lynagh committed
878
        specConstrCount         = Just 3,
879
        liberateCaseThreshold   = Just 2000,
880
        floatLamArgs            = Just 0, -- Default: float only if no fvs
881
882
        strictnessBefore        = [],

Ian Lynagh's avatar
Ian Lynagh committed
883
884
885
886
887
888
889
890
891
        cmdlineHcIncludes       = [],
        importPaths             = ["."],
        mainModIs               = mAIN,
        mainFunIs               = Nothing,
        ctxtStkDepth            = mAX_CONTEXT_REDUCTION_DEPTH,

        thisPackage             = mainPackageId,

        objectDir               = Nothing,
892
        dylibInstallName        = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
893
894
        hiDir                   = Nothing,
        stubDir                 = Nothing,
895
        dumpDir                 = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
896
897
898
899
900

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

901
902
903
        pluginModNames          = [],
        pluginModNameOpts       = [],

Ian Lynagh's avatar
Ian Lynagh committed
904
905
        outputFile              = Nothing,
        outputHi                = Nothing,
906
        dynLibLoader            = SystemDependent,
Ian Lynagh's avatar
Ian Lynagh committed
907
908
909
910
911
912
        dumpPrefix              = Nothing,
        dumpPrefixForce         = Nothing,
        includePaths            = [],
        libraryPaths            = [],
        frameworkPaths          = [],
        cmdlineFrameworks       = [],
913
        rtsOpts                 = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
914
        rtsOptsEnabled          = RtsOptsSafeOnly,
Ian Lynagh's avatar
Ian Lynagh committed
915
916
917
918
919

        hpcDir                  = ".hpc",

        extraPkgConfs           = [],
        packageFlags            = [],
920
921
        pkgDatabase             = Nothing,
        pkgState                = panic "no package state yet: call GHC.setSessionDynFlags",
922
        ways                    = panic "defaultDynFlags: No ways",
Ian Lynagh's avatar
Ian Lynagh committed
923
924
        buildTag                = panic "defaultDynFlags: No buildTag",
        rtsBuildTag             = panic "defaultDynFlags: No rtsBuildTag",
925
        splitInfo               = Nothing,
926
        settings                = mySettings,
927
928
929
930
931
932
        -- ghc -M values
        depMakefile       = "Makefile",
        depIncludePkgDeps = False,
        depExcludeMods    = [],
        depSuffixes       = [],
        -- end of ghc -M values
933
934
        filesToClean   = panic "defaultDynFlags: No filesToClean",
        dirsToClean    = panic "defaultDynFlags: No dirsToClean",
935
        generatedDumps = panic "defaultDynFlags: No generatedDumps",
Ian Lynagh's avatar
Ian Lynagh committed
936
        haddockOptions = Nothing,
937
938
        flags = IntSet.fromList (map fromEnum defaultFlags),
        warningFlags = IntSet.fromList (map fromEnum standardWarnings),
939
        language = Nothing,
dterei's avatar
dterei committed
940
        safeHaskell = Sf_SafeInfered,
941
942
        thOnLoc = noSrcSpan,
        newDerivOnLoc = noSrcSpan,
943
        pkgTrustOnLoc = noSrcSpan,
944
945
        warnSafeOnLoc = noSrcSpan,
        warnUnsafeOnLoc = noSrcSpan,
946
947
        extensions = [],
        extensionFlags = flattenExtensionFlags Nothing [],
948
        log_action = defaultLogAction,
949
950
        flushOut = defaultFlushOut,
        flushErr = defaultFlushErr,
951
952
        profAuto = NoProfAuto,
        llvmVersion = panic "defaultDynFlags: No llvmVersion"
953
954
      }

955
type LogAction = Severity -> SrcSpan -> PprStyle -> MsgDoc -> IO ()
956
957
958
959
960
961
962
963

defaultLogAction :: LogAction
defaultLogAction severity srcSpan style msg
 = case severity of
   SevOutput -> printSDoc msg style
   SevInfo   -> printErrs msg style
   SevFatal  -> printErrs msg style
   _         -> do hPutChar stderr '\n'
964
                   printErrs (mkLocMessage severity srcSpan msg) style
965
966
967
968
                   -- careful (#2302): printErrs prints in UTF-8, whereas
                   -- converting to string first and using hPutStr would
                   -- just emit the low 8 bits of each unicode char.

969
970
971
972
973
974