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

47
48
        printOutputForUser, printInfoForUser,

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

56
        -- ** System tool settings and locations
57
        Settings(..),
58
        targetPlatform,
59
60
61
62
        ghcUsagePath, ghciUsagePath, topDir, tmpDir, rawSettings,
        extraGccViaCFlags, systemPackageConfig,
        pgm_L, pgm_P, pgm_F, pgm_c, pgm_s, pgm_a, pgm_l, pgm_dll, pgm_T,
        pgm_sysman, pgm_windres, pgm_lo, pgm_lc,
Ian Lynagh's avatar
Ian Lynagh committed
63
        opt_L, opt_P, opt_F, opt_c, opt_a, opt_l,
64
        opt_windres, opt_lo, opt_lc,
65
66


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

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

82
        -- ** Parsing DynFlags
83
84
        parseDynamicFlagsCmdLine,
        parseDynamicFilePragma,
85
        allFlags,
86

87
        supportedLanguagesAndExtensions,
88
89

        -- ** DynFlag C compiler options
90
        picCCOpts,
91
92
93
94
95
96

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

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

#include "HsVersions.h"

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

Ian Lynagh's avatar
Ian Lynagh committed
129
#ifdef GHCI
130
import System.IO.Unsafe ( unsafePerformIO )
Ian Lynagh's avatar
Ian Lynagh committed
131
#endif
132
import Data.IORef
Ian Lynagh's avatar
Ian Lynagh committed
133
import Control.Monad    ( when )
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
134

135
import Data.Char
136
import Data.List
137
138
import Data.Map (Map)
import qualified Data.Map as Map
139
140
import Data.Set (Set)
import qualified Data.Set as Set
Ian Lynagh's avatar
Ian Lynagh committed
141
import System.FilePath
142
import System.IO
143

144
145
146
import Data.IntSet (IntSet)
import qualified Data.IntSet as IntSet

147
148
149
-- -----------------------------------------------------------------------------
-- DynFlags

150
-- | Enumerates the simple on-or-off dynamic flags
151
152
153
154
data DynFlag

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

Ian Lynagh's avatar
Ian Lynagh committed
241
   | Opt_WarnIsError                    -- -Werror; makes warnings fatal
242

243
244
   | Opt_PrintExplicitForalls

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

269
270
271
272
273
   -- Interface files
   | Opt_IgnoreInterfacePragmas
   | Opt_OmitInterfacePragmas
   | Opt_ExposeAllUnfoldings

Ian Lynagh's avatar
Ian Lynagh committed
274
275
   -- profiling opts
   | Opt_AutoSccsOnIndividualCafs
276
   | Opt_ProfCountEntries
Ian Lynagh's avatar
Ian Lynagh committed
277

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

307
   -- temporary flags
308
   | Opt_RunCPS
309
   | Opt_RunCPSZ
310
   | Opt_AutoLinkPackages
311
   | Opt_ImplicitImportQualified
312
   | Opt_TryNewCodeGen
313
314
315
316
317
318

   -- keeping stuff
   | Opt_KeepHiDiffs
   | Opt_KeepHcFiles
   | Opt_KeepSFiles
   | Opt_KeepTmpFiles
Jedai's avatar
Jedai committed
319
   | Opt_KeepRawTokenStream
320
   | Opt_KeepLlvmFiles
321

322
   -- safe haskell flags
dterei's avatar
dterei committed
323
   | Opt_DistrustAllPackages
324
325
   | Opt_PackageTrust

326
   deriving (Eq, Show, Enum)
Ian Lynagh's avatar
Ian Lynagh committed
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
357
358
359
360
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
361
362
   | Opt_WarnUnsafe
   | Opt_WarnSafe
Ian Lynagh's avatar
Ian Lynagh committed
363
   | Opt_WarnPointlessPragmas
364
   | Opt_WarnUnsupportedCallingConventions
365
   deriving (Eq, Show, Enum)
366

367
data Language = Haskell98 | Haskell2010
368
   deriving Enum
369

370
-- | The various Safe Haskell modes
371
372
data SafeHaskellMode
   = Sf_None
dterei's avatar
dterei committed
373
   | Sf_Unsafe
374
375
   | Sf_Trustworthy
   | Sf_Safe
dterei's avatar
dterei committed
376
   | Sf_SafeInfered
377
378
   deriving (Eq)

379
instance Outputable SafeHaskellMode where
dterei's avatar
dterei committed
380
381
    ppr Sf_None        = ptext $ sLit "None"
    ppr Sf_Unsafe      = ptext $ sLit "Unsafe"
382
    ppr Sf_Trustworthy = ptext $ sLit "Trustworthy"
dterei's avatar
dterei committed
383
384
    ppr Sf_Safe        = ptext $ sLit "Safe"
    ppr Sf_SafeInfered = ptext $ sLit "Safe-Infered"
385

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

   | 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
448
   | Opt_MonadComprehensions
449
450
451
452
453
454
455
456
457
458
459
   | Opt_GeneralizedNewtypeDeriving
   | Opt_RecursiveDo
   | Opt_DoRec
   | Opt_PostfixOperators
   | Opt_TupleSections
   | Opt_PatternGuards
   | Opt_LiberalTypeSynonyms
   | Opt_Rank2Types
   | Opt_RankNTypes
   | Opt_ImpredicativeTypes
   | Opt_TypeOperators
460
   | Opt_ExplicitNamespaces
461
462
463
464
465
   | Opt_PackageImports
   | Opt_ExplicitForAll
   | Opt_AlternativeLayoutRule
   | Opt_AlternativeLayoutRuleTransitional
   | Opt_DatatypeContexts
466
   | Opt_NondecreasingIndentation
467
   | Opt_RelaxedLayout
468
   | Opt_TraditionalRecordSyntax
469
   deriving (Eq, Enum, Show)
470

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

488
  simplTickFactor       :: Int,         -- ^ Multiplier for simplifier ticks
489
490
491
  specConstrThreshold   :: Maybe Int,   -- ^ Threshold for SpecConstr
  specConstrCount       :: Maybe Int,   -- ^ Max number of specialisations for any one function
  liberateCaseThreshold :: Maybe Int,   -- ^ Threshold for LiberateCase
492
  floatLamArgs          :: Maybe Int,   -- ^ Arg count for lambda floating
493
                                        --   See CoreMonad.FloatOutSwitches
494

495
  cmdlineHcIncludes     :: [String],    -- ^ @\-\#includes@
Ian Lynagh's avatar
Ian Lynagh committed
496
497
498
  importPaths           :: [FilePath],
  mainModIs             :: Module,
  mainFunIs             :: Maybe String,
499
  ctxtStkDepth          :: Int,         -- ^ Typechecker context stack depth
500

501
  thisPackage           :: PackageId,   -- ^ name of package currently being compiled
502
503

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

508
509
510
  -- For object splitting
  splitInfo             :: Maybe (String,Int),

511
  -- paths etc.
Ian Lynagh's avatar
Ian Lynagh committed
512
  objectDir             :: Maybe String,
513
  dylibInstallName      :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
514
515
  hiDir                 :: Maybe String,
  stubDir               :: Maybe String,
516
  dumpDir               :: Maybe String,
517

Ian Lynagh's avatar
Ian Lynagh committed
518
519
520
  objectSuf             :: String,
  hcSuf                 :: String,
  hiSuf                 :: String,
521

Ian Lynagh's avatar
Ian Lynagh committed
522
523
524
  outputFile            :: Maybe String,
  outputHi              :: Maybe String,
  dynLibLoader          :: DynLibLoader,
525

526
  -- | This is set by 'DriverPipeline.runPipeline' based on where
Ian Lynagh's avatar
Ian Lynagh committed
527
528
  --    its output is going.
  dumpPrefix            :: Maybe FilePath,
529

530
531
  -- | Override the 'dumpPrefix' set by 'DriverPipeline.runPipeline'.
  --    Set by @-ddump-file-prefix@
Ian Lynagh's avatar
Ian Lynagh committed
532
533
534
535
536
537
538
  dumpPrefixForce       :: Maybe FilePath,

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

539
  rtsOpts               :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
540
  rtsOptsEnabled        :: RtsOptsEnabled,
541

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

544
545
546
547
  -- Plugins
  pluginModNames        :: [ModuleName],
  pluginModNameOpts     :: [(ModuleName,String)],

548
549
550
551
552
553
  --  For ghc -M
  depMakefile           :: FilePath,
  depIncludePkgDeps     :: Bool,
  depExcludeMods        :: [ModuleName],
  depSuffixes           :: [String],

554
  --  Package flags
555
  extraPkgConfs         :: [PkgConfRef] -> [PkgConfRef],
556
        -- ^ The @-package-db@ flags given on the command line, in the order
Ian Lynagh's avatar
Ian Lynagh committed
557
        -- they appeared.
558

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

562
  -- Package state
Ian Lynagh's avatar
Ian Lynagh committed
563
  -- NB. do not modify this field, it is calculated by
564
  -- Packages.initPackages and Packages.updatePackages.
565
  pkgDatabase           :: Maybe [PackageConfig],
Ian Lynagh's avatar
Ian Lynagh committed
566
  pkgState              :: PackageState,
567

568
569
570
571
  -- Temporary files
  -- These have to be IORefs, because the defaultCleanupHandler needs to
  -- know what to clean when an exception happens
  filesToClean          :: IORef [FilePath],
572
  dirsToClean           :: IORef (Map FilePath FilePath),
573

574
575
576
577
578
  -- 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),

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

600
  -- | MsgDoc output action: use "ErrUtils" instead of this if you can
601
  log_action            :: LogAction,
602
603
  flushOut              :: FlushOut,
  flushErr              :: FlushErr,
David Waern's avatar
David Waern committed
604

605
  haddockOptions        :: Maybe String,
606
  ghciScripts           :: [String],
607
608

  -- | what kind of {-# SCC #-} to add automatically
609
610
611
  profAuto              :: ProfAuto,

  llvmVersion           :: IORef (Int)
612
613
 }

614
615
616
class HasDynFlags m where
    getDynFlags :: m DynFlags

Ian Lynagh's avatar
Ian Lynagh committed
617
618
619
class ContainsDynFlags t where
    extractDynFlags :: t -> DynFlags

620
621
622
623
624
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
625
  | ProfAutoCalls      -- ^ annotate call-sites
Simon Marlow's avatar
Simon Marlow committed
626
  deriving (Enum)
627

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

664
665
 }

666
667
668
targetPlatform :: DynFlags -> Platform
targetPlatform dflags = sTargetPlatform (settings dflags)

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
704
705
706
707
708
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)
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
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)
727

728
729
730
wayNames :: DynFlags -> [WayName]
wayNames = map wayName . ways

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

Ian Lynagh's avatar
Ian Lynagh committed
759
760
761
762
763
764
765
showHscTargetFlag :: HscTarget -> String
showHscTargetFlag HscC           = "-fvia-c"
showHscTargetFlag HscAsm         = "-fasm"
showHscTargetFlag HscLlvm        = "-fllvm"
showHscTargetFlag HscInterpreted = "-fbyte-code"
showHscTargetFlag HscNothing     = "-fno-code"

766
-- | Will this target result in an object file on the disk?
767
768
769
isObjectTarget :: HscTarget -> Bool
isObjectTarget HscC     = True
isObjectTarget HscAsm   = True
770
isObjectTarget HscLlvm  = True
771
772
isObjectTarget _        = False

773
774
775
776
777
778
779
780
781
782
783
-- | 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

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

796
797
798
799
800
instance Outputable GhcMode where
  ppr CompManager = ptext (sLit "CompManager")
  ppr OneShot     = ptext (sLit "OneShot")
  ppr MkDepend    = ptext (sLit "MkDepend")

801
802
803
804
isOneShot :: GhcMode -> Bool
isOneShot OneShot = True
isOneShot _other  = False

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

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

818
819
820
-- Is it worth evaluating this Bool and caching it in the DynFlags value
-- during initDynFlags?
doingTickyProfiling :: DynFlags -> Bool
821
822
823
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.
824

825
data PackageFlag
826
  = ExposePackage   String
827
  | ExposePackageId String
828
829
830
831
  | HidePackage     String
  | IgnorePackage   String
  | TrustPackage    String
  | DistrustPackage String
832
  deriving Eq
833

twanvl's avatar
twanvl committed
834
defaultHscTarget :: HscTarget
835
836
defaultHscTarget = defaultObjectTarget

837
-- | The 'HscTarget' value corresponding to the default way to create
838
-- object files on the current platform.
twanvl's avatar
twanvl committed
839
defaultObjectTarget :: HscTarget
840
defaultObjectTarget
841
  | cGhcUnregisterised    == "YES"      =  HscC
Ian Lynagh's avatar
Ian Lynagh committed
842
  | cGhcWithNativeCodeGen == "YES"      =  HscAsm
843
  | otherwise                           =  HscLlvm
844

845
846
847
848
849
data DynLibLoader
  = Deployable
  | SystemDependent
  deriving Eq

Ian Lynagh's avatar
Ian Lynagh committed
850
data RtsOptsEnabled = RtsOptsNone | RtsOptsSafeOnly | RtsOptsAll
851
  deriving (Show)
Ian Lynagh's avatar
Ian Lynagh committed
852

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

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

Ian Lynagh's avatar
Ian Lynagh committed
895
896
897
898
899
900
901
902
903
        cmdlineHcIncludes       = [],
        importPaths             = ["."],
        mainModIs               = mAIN,
        mainFunIs               = Nothing,
        ctxtStkDepth            = mAX_CONTEXT_REDUCTION_DEPTH,

        thisPackage             = mainPackageId,

        objectDir               = Nothing,
904
        dylibInstallName        = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
905
906
        hiDir                   = Nothing,
        stubDir                 = Nothing,
907
        dumpDir                 = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
908
909
910
911
912

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

913
914
915
        pluginModNames          = [],
        pluginModNameOpts       = [],

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

        hpcDir                  = ".hpc",

930
        extraPkgConfs           = id,
Ian Lynagh's avatar
Ian Lynagh committed
931
        packageFlags            = [],
932
933
        pkgDatabase             = Nothing,
        pkgState                = panic "no package state yet: call GHC.setSessionDynFlags",
934
        ways                    = panic "defaultDynFlags: No ways",
Ian Lynagh's avatar
Ian Lynagh committed
935
936
        buildTag                = panic "defaultDynFlags: No buildTag",
        rtsBuildTag             = panic "defaultDynFlags: No rtsBuildTag",
937
        splitInfo               = Nothing,
938
        settings                = mySettings,
939
940
941
942
943
944
        -- ghc -M values
        depMakefile       = "Makefile",
        depIncludePkgDeps = False,
        depExcludeMods    = [],
        depSuffixes       = [],
        -- end of ghc -M values
945
946
        filesToClean   = panic "defaultDynFlags: No filesToClean",
        dirsToClean    = panic "defaultDynFlags: No dirsToClean",
947
        generatedDumps = panic "defaultDynFlags: No generatedDumps",
Ian Lynagh's avatar
Ian Lynagh committed
948
        haddockOptions = Nothing,
949
950
        flags = IntSet.fromList (map fromEnum defaultFlags),
        warningFlags = IntSet.fromList (map fromEnum standardWarnings),
951
        ghciScripts = [],
952
        language = Nothing,
dterei's avatar
dterei committed
953
        safeHaskell = Sf_SafeInfered,