DynFlags.hs 109 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,
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,
Ian Lynagh's avatar
Ian Lynagh committed
65

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

73
        -- ** Parsing DynFlags
74
75
        parseDynamicFlagsCmdLine,
        parseDynamicFilePragma,
76
        allFlags,
77

78
        supportedLanguagesAndExtensions,
79
80

        -- ** DynFlag C compiler options
81
        picCCOpts,
82
83
84
85
86
87

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

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

#include "HsVersions.h"

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

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

125
import Data.Char
126
import Data.List
127
128
import Data.Map (Map)
import qualified Data.Map as Map
129
130
import Data.Set (Set)
import qualified Data.Set as Set
Ian Lynagh's avatar
Ian Lynagh committed
131
import System.FilePath
132
import System.IO        ( stderr, hPutChar )
133

134
135
136
import Data.IntSet (IntSet)
import qualified Data.IntSet as IntSet

137
138
139
-- -----------------------------------------------------------------------------
-- DynFlags

140
-- | Enumerates the simple on-or-off dynamic flags
141
142
143
144
data DynFlag

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

Ian Lynagh's avatar
Ian Lynagh committed
230
   | Opt_WarnIsError                    -- -Werror; makes warnings fatal
231

232
233
   | Opt_PrintExplicitForalls

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

257
258
259
260
261
   -- Interface files
   | Opt_IgnoreInterfacePragmas
   | Opt_OmitInterfacePragmas
   | Opt_ExposeAllUnfoldings

Ian Lynagh's avatar
Ian Lynagh committed
262
263
   -- profiling opts
   | Opt_AutoSccsOnIndividualCafs
264
   | Opt_ProfCountEntries
Ian Lynagh's avatar
Ian Lynagh committed
265

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

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

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

311
   -- safe haskell flags
dterei's avatar
dterei committed
312
   | Opt_DistrustAllPackages
313
314
   | Opt_PackageTrust

315
   deriving (Eq, Show, Enum)
Ian Lynagh's avatar
Ian Lynagh committed
316

317
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
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
350
351
   | Opt_WarnUnsafe
   | Opt_WarnSafe
Ian Lynagh's avatar
Ian Lynagh committed
352
   | Opt_WarnPointlessPragmas
353
   deriving (Eq, Show, Enum)
354

355
data Language = Haskell98 | Haskell2010
356
   deriving Enum
357

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

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

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

   | 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
436
   | Opt_MonadComprehensions
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
   | 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
453
   | Opt_NondecreasingIndentation
454
   | Opt_RelaxedLayout
455
   | Opt_TraditionalRecordSyntax
456
   deriving (Eq, Enum, Show)
457

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

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

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

488
  thisPackage           :: PackageId,   -- ^ name of package currently being compiled
489
490

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

495
496
497
  -- For object splitting
  splitInfo             :: Maybe (String,Int),

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

Ian Lynagh's avatar
Ian Lynagh committed
505
506
507
  objectSuf             :: String,
  hcSuf                 :: String,
  hiSuf                 :: String,
508

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

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

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

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

526
  rtsOpts               :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
527
  rtsOptsEnabled        :: RtsOptsEnabled,
528

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

531
532
533
534
  -- Plugins
  pluginModNames        :: [ModuleName],
  pluginModNameOpts     :: [(ModuleName,String)],

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

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

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

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

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

561
562
563
564
565
  -- 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),

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

587
  -- | MsgDoc output action: use "ErrUtils" instead of this if you can
588
  log_action            :: LogAction,
David Waern's avatar
David Waern committed
589

590
591
592
  haddockOptions        :: Maybe String,

  -- | what kind of {-# SCC #-} to add automatically
593
594
595
  profAuto              :: ProfAuto,

  llvmVersion           :: IORef (Int)
596
597
 }

598
599
600
class HasDynFlags m where
    getDynFlags :: m DynFlags

Ian Lynagh's avatar
Ian Lynagh committed
601
602
603
class ContainsDynFlags t where
    extractDynFlags :: t -> DynFlags

604
605
606
607
608
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
609
  | ProfAutoCalls      -- ^ annotate call-sites
Simon Marlow's avatar
Simon Marlow committed
610
  deriving (Enum)
611

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

648
649
 }

650
651
652
targetPlatform :: DynFlags -> Platform
targetPlatform dflags = sTargetPlatform (settings dflags)

653
654
655
656
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
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)
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
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)
711

712
713
714
wayNames :: DynFlags -> [WayName]
wayNames = map wayName . ways

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

Ian Lynagh's avatar
Ian Lynagh committed
743
744
745
746
747
748
749
showHscTargetFlag :: HscTarget -> String
showHscTargetFlag HscC           = "-fvia-c"
showHscTargetFlag HscAsm         = "-fasm"
showHscTargetFlag HscLlvm        = "-fllvm"
showHscTargetFlag HscInterpreted = "-fbyte-code"
showHscTargetFlag HscNothing     = "-fno-code"

750
-- | Will this target result in an object file on the disk?
751
752
753
isObjectTarget :: HscTarget -> Bool
isObjectTarget HscC     = True
isObjectTarget HscAsm   = True
754
isObjectTarget HscLlvm  = True
755
756
isObjectTarget _        = False

757
758
759
760
761
762
763
764
765
766
767
-- | 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

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

780
781
782
783
784
instance Outputable GhcMode where
  ppr CompManager = ptext (sLit "CompManager")
  ppr OneShot     = ptext (sLit "OneShot")
  ppr MkDepend    = ptext (sLit "MkDepend")

785
786
787
788
isOneShot :: GhcMode -> Bool
isOneShot OneShot = True
isOneShot _other  = False

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

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

802
803
804
-- Is it worth evaluating this Bool and caching it in the DynFlags value
-- during initDynFlags?
doingTickyProfiling :: DynFlags -> Bool
805
806
807
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.
808

809
data PackageFlag
810
  = ExposePackage   String
811
  | ExposePackageId String
812
813
814
815
  | HidePackage     String
  | IgnorePackage   String
  | TrustPackage    String
  | DistrustPackage String
816
  deriving Eq
817

twanvl's avatar
twanvl committed
818
defaultHscTarget :: HscTarget
819
820
defaultHscTarget = defaultObjectTarget

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

829
830
831
832
833
data DynLibLoader
  = Deployable
  | SystemDependent
  deriving Eq

Ian Lynagh's avatar
Ian Lynagh committed
834
data RtsOptsEnabled = RtsOptsNone | RtsOptsSafeOnly | RtsOptsAll
835
  deriving (Show)
Ian Lynagh's avatar
Ian Lynagh committed
836

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

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

Ian Lynagh's avatar
Ian Lynagh committed
879
880
881
882
883
884
885
886
887
        cmdlineHcIncludes       = [],
        importPaths             = ["."],
        mainModIs               = mAIN,
        mainFunIs               = Nothing,
        ctxtStkDepth            = mAX_CONTEXT_REDUCTION_DEPTH,

        thisPackage             = mainPackageId,

        objectDir               = Nothing,
888
        dylibInstallName        = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
889
890
        hiDir                   = Nothing,
        stubDir                 = Nothing,
891
        dumpDir                 = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
892
893
894
895
896

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

897
898
899
        pluginModNames          = [],
        pluginModNameOpts       = [],

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

        hpcDir                  = ".hpc",

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

949
type LogAction = Severity -> SrcSpan -> PprStyle -> MsgDoc -> IO ()
950
951
952
953
954
955
956
957

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'
958
                   printErrs (mkLocMessage severity srcSpan msg) style
959
960
961
962
                   -- 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.

Ian Lynagh's avatar
Ian Lynagh committed
963
{-
964
965
Note [Verbosity levels]
~~~~~~~~~~~~~~~~~~~~~~~
Ian Lynagh's avatar
Ian Lynagh committed
966
    0   |   print errors & warnings only
967
968
969
970
971
972
973
    1   |   minimal verbosity: print "compiling M ... done." for each module.
    2   |   equivalent to -dshow-passes
    3   |   equivalent to existing "ghc -v"
    4   |   "ghc -v -ddump-most"
    5   |   "ghc -v -ddump-all"
-}