DynFlags.hs 111 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(..),
20
        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(..),
Ian Lynagh's avatar
Ian Lynagh committed
41
        Option(..), showOpt,
Ian Lynagh's avatar
Ian Lynagh committed
42
        DynLibLoader(..),
43
        fFlags, fWarningFlags, fLangFlags, xFlags,
44
        wayNames, dynFlagDependencies,
45

46
        -- ** Safe Haskell
47
        SafeHaskellMode(..),
48
        safeHaskellOn, safeImportsOn, safeLanguageOn, safeInferOn,
49
        packageTrustOn,
50
        safeDirectImpsReq, safeImplicitImpsReq,
51
        unsafeFlags,
52

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


64
        -- ** Manipulating DynFlags
65
        defaultDynFlags,                -- Settings -> DynFlags
Ian Lynagh's avatar
Ian Lynagh committed
66
        initDynFlags,                   -- DynFlags -> IO DynFlags
67
        defaultLogAction,
68
69
        defaultFlushOut,
        defaultFlushErr,
Ian Lynagh's avatar
Ian Lynagh committed
70

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

78
        -- ** Parsing DynFlags
79
80
        parseDynamicFlagsCmdLine,
        parseDynamicFilePragma,
81
        allFlags,
82

83
        supportedLanguagesAndExtensions,
84
85

        -- ** DynFlag C compiler options
86
        picCCOpts,
87
88
89
90
91
92

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

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

#include "HsVersions.h"

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

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

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

139
140
141
import Data.IntSet (IntSet)
import qualified Data.IntSet as IntSet

142
143
144
-- -----------------------------------------------------------------------------
-- DynFlags

145
-- | Enumerates the simple on-or-off dynamic flags
146
147
148
149
data DynFlag

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

Ian Lynagh's avatar
Ian Lynagh committed
236
   | Opt_WarnIsError                    -- -Werror; makes warnings fatal
237

238
239
   | Opt_PrintExplicitForalls

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

264
265
266
267
268
   -- Interface files
   | Opt_IgnoreInterfacePragmas
   | Opt_OmitInterfacePragmas
   | Opt_ExposeAllUnfoldings

Ian Lynagh's avatar
Ian Lynagh committed
269
270
   -- profiling opts
   | Opt_AutoSccsOnIndividualCafs
271
   | Opt_ProfCountEntries
Ian Lynagh's avatar
Ian Lynagh committed
272

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

303
   -- temporary flags
304
   | Opt_RunCPS
305
   | Opt_RunCPSZ
306
   | Opt_AutoLinkPackages
307
   | Opt_ImplicitImportQualified
308
   | Opt_TryNewCodeGen
309
310
311
312
313
314

   -- keeping stuff
   | Opt_KeepHiDiffs
   | Opt_KeepHcFiles
   | Opt_KeepSFiles
   | Opt_KeepTmpFiles
Jedai's avatar
Jedai committed
315
   | Opt_KeepRawTokenStream
316
   | Opt_KeepLlvmFiles
317

318
   -- safe haskell flags
dterei's avatar
dterei committed
319
   | Opt_DistrustAllPackages
320
321
   | Opt_PackageTrust

322
   deriving (Eq, Show, Enum)
Ian Lynagh's avatar
Ian Lynagh committed
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
352
353
354
355
356
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
357
358
   | Opt_WarnUnsafe
   | Opt_WarnSafe
Ian Lynagh's avatar
Ian Lynagh committed
359
   | Opt_WarnPointlessPragmas
360
   deriving (Eq, Show, Enum)
361

362
data Language = Haskell98 | Haskell2010
363
   deriving Enum
364

365
-- | The various Safe Haskell modes
366
367
data SafeHaskellMode
   = Sf_None
dterei's avatar
dterei committed
368
   | Sf_Unsafe
369
370
   | Sf_Trustworthy
   | Sf_Safe
dterei's avatar
dterei committed
371
   | Sf_SafeInfered
372
373
   deriving (Eq)

374
instance Outputable SafeHaskellMode where
dterei's avatar
dterei committed
375
376
    ppr Sf_None        = ptext $ sLit "None"
    ppr Sf_Unsafe      = ptext $ sLit "Unsafe"
377
    ppr Sf_Trustworthy = ptext $ sLit "Trustworthy"
dterei's avatar
dterei committed
378
379
    ppr Sf_Safe        = ptext $ sLit "Safe"
    ppr Sf_SafeInfered = ptext $ sLit "Safe-Infered"
380

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

   | 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
443
   | Opt_MonadComprehensions
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
455
   | Opt_ExplicitNamespaces
456
457
458
459
460
   | Opt_PackageImports
   | Opt_ExplicitForAll
   | Opt_AlternativeLayoutRule
   | Opt_AlternativeLayoutRuleTransitional
   | Opt_DatatypeContexts
461
   | Opt_NondecreasingIndentation
462
   | Opt_RelaxedLayout
463
   | Opt_TraditionalRecordSyntax
464
   deriving (Eq, Enum, Show)
465

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

483
  simplTickFactor       :: Int,         -- ^ Multiplier for simplifier ticks
484
485
486
  specConstrThreshold   :: Maybe Int,   -- ^ Threshold for SpecConstr
  specConstrCount       :: Maybe Int,   -- ^ Max number of specialisations for any one function
  liberateCaseThreshold :: Maybe Int,   -- ^ Threshold for LiberateCase
487
  floatLamArgs          :: Maybe Int,   -- ^ Arg count for lambda floating
488
                                        --   See CoreMonad.FloatOutSwitches
489

490
  cmdlineHcIncludes     :: [String],    -- ^ @\-\#includes@
Ian Lynagh's avatar
Ian Lynagh committed
491
492
493
  importPaths           :: [FilePath],
  mainModIs             :: Module,
  mainFunIs             :: Maybe String,
494
  ctxtStkDepth          :: Int,         -- ^ Typechecker context stack depth
495

496
  thisPackage           :: PackageId,   -- ^ name of package currently being compiled
497
498

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

503
504
505
  -- For object splitting
  splitInfo             :: Maybe (String,Int),

506
  -- paths etc.
Ian Lynagh's avatar
Ian Lynagh committed
507
  objectDir             :: Maybe String,
508
  dylibInstallName      :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
509
510
  hiDir                 :: Maybe String,
  stubDir               :: Maybe String,
511
  dumpDir               :: Maybe String,
512

Ian Lynagh's avatar
Ian Lynagh committed
513
514
515
  objectSuf             :: String,
  hcSuf                 :: String,
  hiSuf                 :: String,
516

Ian Lynagh's avatar
Ian Lynagh committed
517
518
519
  outputFile            :: Maybe String,
  outputHi              :: Maybe String,
  dynLibLoader          :: DynLibLoader,
520

521
  -- | This is set by 'DriverPipeline.runPipeline' based on where
Ian Lynagh's avatar
Ian Lynagh committed
522
523
  --    its output is going.
  dumpPrefix            :: Maybe FilePath,
524

525
526
  -- | Override the 'dumpPrefix' set by 'DriverPipeline.runPipeline'.
  --    Set by @-ddump-file-prefix@
Ian Lynagh's avatar
Ian Lynagh committed
527
528
529
530
531
532
533
  dumpPrefixForce       :: Maybe FilePath,

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

534
  rtsOpts               :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
535
  rtsOptsEnabled        :: RtsOptsEnabled,
536

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

539
540
541
542
  -- Plugins
  pluginModNames        :: [ModuleName],
  pluginModNameOpts     :: [(ModuleName,String)],

543
544
545
546
547
548
  --  For ghc -M
  depMakefile           :: FilePath,
  depIncludePkgDeps     :: Bool,
  depExcludeMods        :: [ModuleName],
  depSuffixes           :: [String],

549
  --  Package flags
Ian Lynagh's avatar
Ian Lynagh committed
550
  extraPkgConfs         :: [FilePath],
551
        -- ^ The @-package-conf@ flags given on the command line, in the order
Ian Lynagh's avatar
Ian Lynagh committed
552
        -- they appeared.
553

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

557
  -- Package state
Ian Lynagh's avatar
Ian Lynagh committed
558
  -- NB. do not modify this field, it is calculated by
559
  -- Packages.initPackages and Packages.updatePackages.
560
  pkgDatabase           :: Maybe [PackageConfig],
Ian Lynagh's avatar
Ian Lynagh committed
561
  pkgState              :: PackageState,
562

563
564
565
566
  -- Temporary files
  -- These have to be IORefs, because the defaultCleanupHandler needs to
  -- know what to clean when an exception happens
  filesToClean          :: IORef [FilePath],
567
  dirsToClean           :: IORef (Map FilePath FilePath),
568

569
570
571
572
573
  -- 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),

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

595
  -- | MsgDoc output action: use "ErrUtils" instead of this if you can
596
  log_action            :: LogAction,
597
598
  flushOut              :: FlushOut,
  flushErr              :: FlushErr,
David Waern's avatar
David Waern committed
599

600
  haddockOptions        :: Maybe String,
601
  ghciScripts           :: [String],
602
603

  -- | what kind of {-# SCC #-} to add automatically
604
605
606
  profAuto              :: ProfAuto,

  llvmVersion           :: IORef (Int)
607
608
 }

609
610
611
class HasDynFlags m where
    getDynFlags :: m DynFlags

Ian Lynagh's avatar
Ian Lynagh committed
612
613
614
class ContainsDynFlags t where
    extractDynFlags :: t -> DynFlags

615
616
617
618
619
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
620
  | ProfAutoCalls      -- ^ annotate call-sites
Simon Marlow's avatar
Simon Marlow committed
621
  deriving (Enum)
622

623
data Settings = Settings {
624
  sTargetPlatform        :: Platform,    -- Filled in by SysTools
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
  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
647
648
649
650
651
652
653
654
655
656
657
658
  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

659
660
 }

661
662
663
targetPlatform :: DynFlags -> Platform
targetPlatform dflags = sTargetPlatform (settings dflags)

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
697
698
699
700
701
702
703
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)
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
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)
722

723
724
725
wayNames :: DynFlags -> [WayName]
wayNames = map wayName . ways

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

Ian Lynagh's avatar
Ian Lynagh committed
754
755
756
757
758
759
760
showHscTargetFlag :: HscTarget -> String
showHscTargetFlag HscC           = "-fvia-c"
showHscTargetFlag HscAsm         = "-fasm"
showHscTargetFlag HscLlvm        = "-fllvm"
showHscTargetFlag HscInterpreted = "-fbyte-code"
showHscTargetFlag HscNothing     = "-fno-code"

761
-- | Will this target result in an object file on the disk?
762
763
764
isObjectTarget :: HscTarget -> Bool
isObjectTarget HscC     = True
isObjectTarget HscAsm   = True
765
isObjectTarget HscLlvm  = True
766
767
isObjectTarget _        = False

768
769
770
771
772
773
774
775
776
777
778
-- | 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

779
780
781
782
783
784
-- | 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.
785
data GhcMode
786
787
788
  = CompManager         -- ^ @\-\-make@, GHCi, etc.
  | OneShot             -- ^ @ghc -c Foo.hs@
  | MkDepend            -- ^ @ghc -M@, see "Finder" for why we need this
789
790
  deriving Eq

791
792
793
794
795
instance Outputable GhcMode where
  ppr CompManager = ptext (sLit "CompManager")
  ppr OneShot     = ptext (sLit "OneShot")
  ppr MkDepend    = ptext (sLit "MkDepend")

796
797
798
799
isOneShot :: GhcMode -> Bool
isOneShot OneShot = True
isOneShot _other  = False

800
801
802
803
-- | 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
804
805
  | LinkInMemory        -- ^ Use the in-memory dynamic linker (works for both
                        --   bytecode and object code).
806
  | LinkDynLib          -- ^ Link objects into a dynamic lib (DLL on Windows, DSO on ELF platforms)
807
  deriving (Eq, Show)
808
809
810

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

813
814
815
-- Is it worth evaluating this Bool and caching it in the DynFlags value
-- during initDynFlags?
doingTickyProfiling :: DynFlags -> Bool
816
817
818
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.
819

820
data PackageFlag
821
  = ExposePackage   String
822
  | ExposePackageId String
823
824
825
826
  | HidePackage     String
  | IgnorePackage   String
  | TrustPackage    String
  | DistrustPackage String
827
  deriving Eq
828

twanvl's avatar
twanvl committed
829
defaultHscTarget :: HscTarget
830
831
defaultHscTarget = defaultObjectTarget

832
-- | The 'HscTarget' value corresponding to the default way to create
833
-- object files on the current platform.
twanvl's avatar
twanvl committed
834
defaultObjectTarget :: HscTarget
835
defaultObjectTarget
836
  | cGhcUnregisterised    == "YES"      =  HscC
Ian Lynagh's avatar
Ian Lynagh committed
837
  | cGhcWithNativeCodeGen == "YES"      =  HscAsm
838
  | otherwise                           =  HscLlvm
839

840
841
842
843
844
data DynLibLoader
  = Deployable
  | SystemDependent
  deriving Eq

Ian Lynagh's avatar
Ian Lynagh committed
845
data RtsOptsEnabled = RtsOptsNone | RtsOptsSafeOnly | RtsOptsAll
846
  deriving (Show)
Ian Lynagh's avatar
Ian Lynagh committed
847

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

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

Ian Lynagh's avatar
Ian Lynagh committed
890
891
892
893
894
895
896
897
898
        cmdlineHcIncludes       = [],
        importPaths             = ["."],
        mainModIs               = mAIN,
        mainFunIs               = Nothing,
        ctxtStkDepth            = mAX_CONTEXT_REDUCTION_DEPTH,

        thisPackage             = mainPackageId,

        objectDir               = Nothing,
899
        dylibInstallName        = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
900
901
        hiDir                   = Nothing,
        stubDir                 = Nothing,
902
        dumpDir                 = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
903
904
905
906
907

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

908
909
910
        pluginModNames          = [],
        pluginModNameOpts       = [],

Ian Lynagh's avatar
Ian Lynagh committed
911
912
        outputFile              = Nothing,
        outputHi                = Nothing,
913
        dynLibLoader            = SystemDependent,
Ian Lynagh's avatar
Ian Lynagh committed
914
915
916
917
918
919
        dumpPrefix              = Nothing,
        dumpPrefixForce         = Nothing,
        includePaths            = [],
        libraryPaths            = [],
        frameworkPaths          = [],
        cmdlineFrameworks       = [],
920
        rtsOpts                 = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
921
        rtsOptsEnabled          = RtsOptsSafeOnly,
Ian Lynagh's avatar
Ian Lynagh committed
922
923
924
925
926

        hpcDir                  = ".hpc",

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