DynFlags.hs 107 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
        RtsOptsEnabled(..),
Ian Lynagh's avatar
Ian Lynagh committed
33
34
35
36
        HscTarget(..), isObjectTarget, defaultObjectTarget,
        GhcMode(..), isOneShot,
        GhcLink(..), isNoLink,
        PackageFlag(..),
Ian Lynagh's avatar
Ian Lynagh committed
37
        Option(..), showOpt,
Ian Lynagh's avatar
Ian Lynagh committed
38
        DynLibLoader(..),
39
        fFlags, fWarningFlags, fLangFlags, xFlags,
40
        wayNames, dynFlagDependencies,
41

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

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


59
        -- ** Manipulating DynFlags
60
        defaultDynFlags,                -- Settings -> DynFlags
Ian Lynagh's avatar
Ian Lynagh committed
61
        initDynFlags,                   -- DynFlags -> IO DynFlags
62
        defaultLogAction,
Ian Lynagh's avatar
Ian Lynagh committed
63

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

71
        -- ** Parsing DynFlags
72
73
        parseDynamicFlagsCmdLine,
        parseDynamicFilePragma,
74
        allFlags,
75

76
        supportedLanguagesAndExtensions,
77
78

        -- ** DynFlag C compiler options
79
        picCCOpts,
80
81
82
83
84
85

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

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

#include "HsVersions.h"

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

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

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

132
133
134
import Data.IntSet (IntSet)
import qualified Data.IntSet as IntSet

135
136
137
-- -----------------------------------------------------------------------------
-- DynFlags

138
-- | Enumerates the simple on-or-off dynamic flags
139
140
141
142
data DynFlag

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

Ian Lynagh's avatar
Ian Lynagh committed
228
   | Opt_WarnIsError                    -- -Werror; makes warnings fatal
229

230
231
   | Opt_PrintExplicitForalls

232
233
234
   -- optimisation opts
   | Opt_Strictness
   | Opt_FullLaziness
235
236
   | Opt_FloatIn
   | Opt_Specialise
237
   | Opt_StaticArgumentTransformation
238
   | Opt_CSE
239
240
   | Opt_LiberateCase
   | Opt_SpecConstr
241
242
243
244
245
   | Opt_DoLambdaEtaExpansion
   | Opt_IgnoreAsserts
   | Opt_DoEtaReduction
   | Opt_CaseMerge
   | Opt_UnboxStrictFields
246
   | Opt_DictsCheap
247
   | Opt_EnableRewriteRules             -- Apply rewrite rules during simplification
rl@cse.unsw.edu.au's avatar
rl@cse.unsw.edu.au committed
248
   | Opt_Vectorise
Ian Lynagh's avatar
Ian Lynagh committed
249
250
   | Opt_RegsGraph                      -- do graph coloring register allocation
   | Opt_RegsIterative                  -- do iterative coalescing graph coloring register allocation
251
   | Opt_PedanticBottoms                -- Be picky about how we treat bottom
252

253
254
255
256
257
   -- Interface files
   | Opt_IgnoreInterfacePragmas
   | Opt_OmitInterfacePragmas
   | Opt_ExposeAllUnfoldings

Ian Lynagh's avatar
Ian Lynagh committed
258
259
   -- profiling opts
   | Opt_AutoSccsOnIndividualCafs
260
   | Opt_ProfCountEntries
Ian Lynagh's avatar
Ian Lynagh committed
261

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

291
   -- temporary flags
292
   | Opt_RunCPS
293
   | Opt_RunCPSZ
294
   | Opt_AutoLinkPackages
295
   | Opt_ImplicitImportQualified
296
   | Opt_TryNewCodeGen
297
298
299
300
301
302

   -- keeping stuff
   | Opt_KeepHiDiffs
   | Opt_KeepHcFiles
   | Opt_KeepSFiles
   | Opt_KeepTmpFiles
Jedai's avatar
Jedai committed
303
   | Opt_KeepRawTokenStream
304
   | Opt_KeepLlvmFiles
305

306
   -- safe haskell flags
dterei's avatar
dterei committed
307
   | Opt_DistrustAllPackages
308
309
   | Opt_PackageTrust

310
   deriving (Eq, Show, Enum)
Ian Lynagh's avatar
Ian Lynagh committed
311

312
313
314
315
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
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
345
346
   | Opt_WarnUnsafe
   | Opt_WarnSafe
347
   deriving (Eq, Show, Enum)
348

349
data Language = Haskell98 | Haskell2010
350
   deriving Enum
351

352
-- | The various Safe Haskell modes
353
354
data SafeHaskellMode
   = Sf_None
dterei's avatar
dterei committed
355
   | Sf_Unsafe
356
357
   | Sf_Trustworthy
   | Sf_Safe
dterei's avatar
dterei committed
358
   | Sf_SafeInfered
359
360
   deriving (Eq)

361
instance Outputable SafeHaskellMode where
dterei's avatar
dterei committed
362
363
    ppr Sf_None        = ptext $ sLit "None"
    ppr Sf_Unsafe      = ptext $ sLit "Unsafe"
364
    ppr Sf_Trustworthy = ptext $ sLit "Trustworthy"
dterei's avatar
dterei committed
365
366
    ppr Sf_Safe        = ptext $ sLit "Safe"
    ppr Sf_SafeInfered = ptext $ sLit "Safe-Infered"
367

368
data ExtensionFlag
369
370
371
372
373
374
375
   = Opt_Cpp
   | Opt_OverlappingInstances
   | Opt_UndecidableInstances
   | Opt_IncoherentInstances
   | Opt_MonomorphismRestriction
   | Opt_MonoPatBinds
   | Opt_MonoLocalBinds
376
377
   | Opt_RelaxedPolyRec           -- Deprecated
   | Opt_ExtendedDefaultRules     -- Use GHC's extended rules for defaulting
378
379
   | Opt_ForeignFunctionInterface
   | Opt_UnliftedFFITypes
380
   | Opt_InterruptibleFFI
381
   | Opt_GHCForeignImportPrim
382
383
   | Opt_ParallelArrays           -- Syntactic support for parallel arrays
   | Opt_Arrows                   -- Arrow-notation syntax
384
385
386
387
388
389
390
391
392
393
394
395
396
397
   | 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
398
   | Opt_GADTSyntax
399
   | Opt_NPlusKPatterns
Ian Lynagh's avatar
Ian Lynagh committed
400
   | Opt_DoAndIfThenElse
401
   | Opt_RebindableSyntax
402
   | Opt_ConstraintKinds
dreixel's avatar
dreixel committed
403
   | Opt_PolyKinds                -- Kind polymorphism
dterei's avatar
dterei committed
404

405
406
407
408
409
   | Opt_StandaloneDeriving
   | Opt_DeriveDataTypeable
   | Opt_DeriveFunctor
   | Opt_DeriveTraversable
   | Opt_DeriveFoldable
410
   | Opt_DeriveGeneric            -- Allow deriving Generic/1
dreixel's avatar
dreixel committed
411
   | Opt_DefaultSignatures        -- Allow extra signatures for defmeths
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426

   | 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
427
   | Opt_MonadComprehensions
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
   | 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
444
   | Opt_NondecreasingIndentation
445
   | Opt_RelaxedLayout
446
   | Opt_TraditionalRecordSyntax
447
   deriving (Eq, Enum, Show)
448

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

466
  simplTickFactor       :: Int,         -- ^ Multiplier for simplifier ticks
467
468
469
  specConstrThreshold   :: Maybe Int,   -- ^ Threshold for SpecConstr
  specConstrCount       :: Maybe Int,   -- ^ Max number of specialisations for any one function
  liberateCaseThreshold :: Maybe Int,   -- ^ Threshold for LiberateCase
470
  floatLamArgs          :: Maybe Int,   -- ^ Arg count for lambda floating
471
                                        --   See CoreMonad.FloatOutSwitches
472

473
  cmdlineHcIncludes     :: [String],    -- ^ @\-\#includes@
Ian Lynagh's avatar
Ian Lynagh committed
474
475
476
  importPaths           :: [FilePath],
  mainModIs             :: Module,
  mainFunIs             :: Maybe String,
477
  ctxtStkDepth          :: Int,         -- ^ Typechecker context stack depth
478

479
  thisPackage           :: PackageId,   -- ^ name of package currently being compiled
480
481

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

486
487
488
  -- For object splitting
  splitInfo             :: Maybe (String,Int),

489
  -- paths etc.
Ian Lynagh's avatar
Ian Lynagh committed
490
  objectDir             :: Maybe String,
491
  dylibInstallName      :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
492
493
  hiDir                 :: Maybe String,
  stubDir               :: Maybe String,
494
  dumpDir               :: Maybe String,
495

Ian Lynagh's avatar
Ian Lynagh committed
496
497
498
  objectSuf             :: String,
  hcSuf                 :: String,
  hiSuf                 :: String,
499

Ian Lynagh's avatar
Ian Lynagh committed
500
501
502
  outputFile            :: Maybe String,
  outputHi              :: Maybe String,
  dynLibLoader          :: DynLibLoader,
503

504
  -- | This is set by 'DriverPipeline.runPipeline' based on where
Ian Lynagh's avatar
Ian Lynagh committed
505
506
  --    its output is going.
  dumpPrefix            :: Maybe FilePath,
507

508
509
  -- | Override the 'dumpPrefix' set by 'DriverPipeline.runPipeline'.
  --    Set by @-ddump-file-prefix@
Ian Lynagh's avatar
Ian Lynagh committed
510
511
512
513
514
515
516
  dumpPrefixForce       :: Maybe FilePath,

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

517
  rtsOpts               :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
518
  rtsOptsEnabled        :: RtsOptsEnabled,
519

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

522
523
524
525
  -- Plugins
  pluginModNames        :: [ModuleName],
  pluginModNameOpts     :: [(ModuleName,String)],

526
527
528
529
530
531
  --  For ghc -M
  depMakefile           :: FilePath,
  depIncludePkgDeps     :: Bool,
  depExcludeMods        :: [ModuleName],
  depSuffixes           :: [String],

532
  --  Package flags
Ian Lynagh's avatar
Ian Lynagh committed
533
  extraPkgConfs         :: [FilePath],
534
        -- ^ The @-package-conf@ flags given on the command line, in the order
Ian Lynagh's avatar
Ian Lynagh committed
535
        -- they appeared.
536

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

540
  -- Package state
Ian Lynagh's avatar
Ian Lynagh committed
541
  -- NB. do not modify this field, it is calculated by
542
  -- Packages.initPackages and Packages.updatePackages.
543
  pkgDatabase           :: Maybe [PackageConfig],
Ian Lynagh's avatar
Ian Lynagh committed
544
  pkgState              :: PackageState,
545

546
547
548
549
  -- Temporary files
  -- These have to be IORefs, because the defaultCleanupHandler needs to
  -- know what to clean when an exception happens
  filesToClean          :: IORef [FilePath],
550
  dirsToClean           :: IORef (Map FilePath FilePath),
551

552
553
554
555
556
  -- 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),

557
  -- hsc dynamic flags
558
559
  flags                 :: IntSet,
  warningFlags          :: IntSet,
560
  -- Don't change this without updating extensionFlags:
561
  language              :: Maybe Language,
562
563
  -- | Safe Haskell mode
  safeHaskell           :: SafeHaskellMode,
564
565
566
567
568
  -- We store the location of where template haskell and newtype deriving were
  -- turned on so we can produce accurate error messages when Safe Haskell turns
  -- them off.
  thOnLoc               :: SrcSpan,
  newDerivOnLoc         :: SrcSpan,
569
570
  warnSafeOnLoc         :: SrcSpan,
  warnUnsafeOnLoc       :: SrcSpan,
571
572
573
574
  -- Don't change this without updating extensionFlags:
  extensions            :: [OnOff ExtensionFlag],
  -- extensionFlags should always be equal to
  --     flattenExtensionFlags language extensions
575
  extensionFlags        :: IntSet,
Ian Lynagh's avatar
Ian Lynagh committed
576

577
  -- | Message output action: use "ErrUtils" instead of this if you can
578
  log_action            :: LogAction,
David Waern's avatar
David Waern committed
579

580
581
582
583
  haddockOptions        :: Maybe String,

  -- | what kind of {-# SCC #-} to add automatically
  profAuto              :: ProfAuto
584
585
 }

586
587
588
589
590
591
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

592
data Settings = Settings {
593
  sTargetPlatform        :: Platform,    -- Filled in by SysTools
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
  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
616
617
618
619
620
621
622
623
624
625
626
627
  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

628
629
 }

630
631
632
targetPlatform :: DynFlags -> Platform
targetPlatform dflags = sTargetPlatform (settings dflags)

633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
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)
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
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)
691

692
693
694
wayNames :: DynFlags -> [WayName]
wayNames = map wayName . ways

695
696
-- | The target code type of the compilation (if any).
--
697
698
699
-- Whenever you change the target, also make sure to set 'ghcLink' to
-- something sensible.
--
700
701
702
703
-- 'HscNothing' can be used to avoid generating any output, however, note
-- that:
--
--  * This will not run the desugaring step, thus no warnings generated in
704
705
706
--    this step will be output.  In particular, this includes warnings related
--    to pattern matching.  You can run the desugarer manually using
--    'GHC.desugarModule'.
707
--
708
709
710
711
712
713
--  * 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
--    different target or avoid typechecking such modules.  (The latter may
--    preferable for security reasons.)
714
--
715
data HscTarget
716
717
  = HscC           -- ^ Generate C code.
  | HscAsm         -- ^ Generate assembly using the native code generator.
718
  | HscLlvm        -- ^ Generate assembly using the llvm code generator.
719
720
  | HscInterpreted -- ^ Generate bytecode.  (Requires 'LinkInMemory')
  | HscNothing     -- ^ Don't generate any code.  See notes above.
721
722
  deriving (Eq, Show)

Ian Lynagh's avatar
Ian Lynagh committed
723
724
725
726
727
728
729
showHscTargetFlag :: HscTarget -> String
showHscTargetFlag HscC           = "-fvia-c"
showHscTargetFlag HscAsm         = "-fasm"
showHscTargetFlag HscLlvm        = "-fllvm"
showHscTargetFlag HscInterpreted = "-fbyte-code"
showHscTargetFlag HscNothing     = "-fno-code"

730
-- | Will this target result in an object file on the disk?
731
732
733
isObjectTarget :: HscTarget -> Bool
isObjectTarget HscC     = True
isObjectTarget HscAsm   = True
734
isObjectTarget HscLlvm  = True
735
736
737
738
739
740
741
742
isObjectTarget _        = False

-- | 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.
743
data GhcMode
744
745
746
  = CompManager         -- ^ @\-\-make@, GHCi, etc.
  | OneShot             -- ^ @ghc -c Foo.hs@
  | MkDepend            -- ^ @ghc -M@, see "Finder" for why we need this
747
748
  deriving Eq

749
750
751
752
753
instance Outputable GhcMode where
  ppr CompManager = ptext (sLit "CompManager")
  ppr OneShot     = ptext (sLit "OneShot")
  ppr MkDepend    = ptext (sLit "MkDepend")

754
755
756
757
isOneShot :: GhcMode -> Bool
isOneShot OneShot = True
isOneShot _other  = False

758
759
760
761
-- | 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
762
763
  | LinkInMemory        -- ^ Use the in-memory dynamic linker (works for both
                        --   bytecode and object code).
764
  | LinkDynLib          -- ^ Link objects into a dynamic lib (DLL on Windows, DSO on ELF platforms)
765
  deriving (Eq, Show)
766
767
768

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

771
772
773
-- Is it worth evaluating this Bool and caching it in the DynFlags value
-- during initDynFlags?
doingTickyProfiling :: DynFlags -> Bool
774
775
776
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.
777

778
data PackageFlag
779
  = ExposePackage   String
780
  | ExposePackageId String
781
782
783
784
  | HidePackage     String
  | IgnorePackage   String
  | TrustPackage    String
  | DistrustPackage String
785
  deriving Eq
786

twanvl's avatar
twanvl committed
787
defaultHscTarget :: HscTarget
788
789
defaultHscTarget = defaultObjectTarget

790
-- | The 'HscTarget' value corresponding to the default way to create
791
-- object files on the current platform.
twanvl's avatar
twanvl committed
792
defaultObjectTarget :: HscTarget
793
defaultObjectTarget
794
  | cGhcUnregisterised    == "YES"      =  HscC
Ian Lynagh's avatar
Ian Lynagh committed
795
  | cGhcWithNativeCodeGen == "YES"      =  HscAsm
796
  | otherwise                           =  HscLlvm
797

798
799
800
801
802
data DynLibLoader
  = Deployable
  | SystemDependent
  deriving Eq

Ian Lynagh's avatar
Ian Lynagh committed
803
data RtsOptsEnabled = RtsOptsNone | RtsOptsSafeOnly | RtsOptsAll
804
  deriving (Show)
Ian Lynagh's avatar
Ian Lynagh committed
805

806
-- | Used by 'GHC.newSession' to partially initialize a new 'DynFlags' value
twanvl's avatar
twanvl committed
807
initDynFlags :: DynFlags -> IO DynFlags
808
809
810
initDynFlags dflags = do
 -- someday these will be dynamic flags
 ways <- readIORef v_Ways
811
 refFilesToClean <- newIORef []
812
 refDirsToClean <- newIORef Map.empty
813
 refGeneratedDumps <- newIORef Set.empty
814
 return dflags{
815
816
817
        ways            = ways,
        buildTag        = mkBuildTag (filter (not . wayRTSOnly) ways),
        rtsBuildTag     = mkBuildTag ways,
818
        filesToClean    = refFilesToClean,
819
820
        dirsToClean     = refDirsToClean,
        generatedDumps   = refGeneratedDumps
Ian Lynagh's avatar
Ian Lynagh committed
821
        }
822

823
824
-- | The normal 'DynFlags'. Note that they is not suitable for use in this form
-- and must be fully initialized by 'GHC.newSession' first.
825
826
defaultDynFlags :: Settings -> DynFlags
defaultDynFlags mySettings =
827
     DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
828
829
830
831
832
833
834
        ghcMode                 = CompManager,
        ghcLink                 = LinkBinary,
        hscTarget               = defaultHscTarget,
        hscOutName              = "",
        extCoreName             = "",
        verbosity               = 0,
        optLevel                = 0,
835
        simplPhases             = 2,
Ian Lynagh's avatar
Ian Lynagh committed
836
        maxSimplIterations      = 4,
837
        shouldDumpSimplPhase    = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
838
        ruleCheck               = Nothing,
dterei's avatar
dterei committed
839
        simplTickFactor         = 100,
840
        specConstrThreshold     = Just 2000,
Ian Lynagh's avatar
Ian Lynagh committed
841
        specConstrCount         = Just 3,
842
        liberateCaseThreshold   = Just 2000,
843
        floatLamArgs            = Just 0, -- Default: float only if no fvs
844
845
        strictnessBefore        = [],

Ian Lynagh's avatar
Ian Lynagh committed
846
847
848
849
850
851
852
853
854
        cmdlineHcIncludes       = [],
        importPaths             = ["."],
        mainModIs               = mAIN,
        mainFunIs               = Nothing,
        ctxtStkDepth            = mAX_CONTEXT_REDUCTION_DEPTH,

        thisPackage             = mainPackageId,

        objectDir               = Nothing,
855
        dylibInstallName        = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
856
857
        hiDir                   = Nothing,
        stubDir                 = Nothing,
858
        dumpDir                 = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
859
860
861
862
863

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

864
865
866
        pluginModNames          = [],
        pluginModNameOpts       = [],

Ian Lynagh's avatar
Ian Lynagh committed
867
868
        outputFile              = Nothing,
        outputHi                = Nothing,
869
        dynLibLoader            = SystemDependent,
Ian Lynagh's avatar
Ian Lynagh committed
870
871
872
873
874
875
        dumpPrefix              = Nothing,
        dumpPrefixForce         = Nothing,
        includePaths            = [],
        libraryPaths            = [],
        frameworkPaths          = [],
        cmdlineFrameworks       = [],
876
        rtsOpts                 = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
877
        rtsOptsEnabled          = RtsOptsSafeOnly,
Ian Lynagh's avatar
Ian Lynagh committed
878
879
880
881
882

        hpcDir                  = ".hpc",

        extraPkgConfs           = [],
        packageFlags            = [],
883
884
        pkgDatabase             = Nothing,
        pkgState                = panic "no package state yet: call GHC.setSessionDynFlags",
885
        ways                    = panic "defaultDynFlags: No ways",
Ian Lynagh's avatar
Ian Lynagh committed
886
887
        buildTag                = panic "defaultDynFlags: No buildTag",
        rtsBuildTag             = panic "defaultDynFlags: No rtsBuildTag",
888
        splitInfo               = Nothing,
889
        settings                = mySettings,
890
891
892
893
894
895
        -- ghc -M values
        depMakefile       = "Makefile",
        depIncludePkgDeps = False,
        depExcludeMods    = [],
        depSuffixes       = [],
        -- end of ghc -M values
896
897
        filesToClean   = panic "defaultDynFlags: No filesToClean",
        dirsToClean    = panic "defaultDynFlags: No dirsToClean",
898
        generatedDumps = panic "defaultDynFlags: No generatedDumps",
Ian Lynagh's avatar
Ian Lynagh committed
899
        haddockOptions = Nothing,
900
901
        flags = IntSet.fromList (map fromEnum defaultFlags),
        warningFlags = IntSet.fromList (map fromEnum standardWarnings),
902
        language = Nothing,
dterei's avatar
dterei committed
903
        safeHaskell = Sf_SafeInfered,
904
905
        thOnLoc = noSrcSpan,
        newDerivOnLoc = noSrcSpan,
906
907
        warnSafeOnLoc = noSrcSpan,
        warnUnsafeOnLoc = noSrcSpan,
908
909
        extensions = [],
        extensionFlags = flattenExtensionFlags Nothing [],
910
911
        log_action = defaultLogAction,
        profAuto = NoProfAuto
912
913
      }

914
915
916
917
918
919
920
921
922
923
924
925
926
927
type LogAction = Severity -> SrcSpan -> PprStyle -> Message -> IO ()

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'
                   printErrs (mkLocMessage srcSpan msg) style
                   -- 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
928
{-
929
930
Note [Verbosity levels]
~~~~~~~~~~~~~~~~~~~~~~~
Ian Lynagh's avatar
Ian Lynagh committed
931
    0   |   print errors & warnings only
932
933
934
935
936
937
938
    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"
-}

939
940
941
942
943
data OnOff a = On a
             | Off a

-- OnOffs accumulate in reverse order, so we use foldr in order to
-- process them in the right order
944
flattenExtensionFlags :: Maybe Language -> [OnOff ExtensionFlag] -> IntSet
945
flattenExtensionFlags ml = foldr f defaultExtensionFlags
946
947
948
    where f (On f)  flags = IntSet.insert (fromEnum f) flags
          f (Off f) flags = IntSet.delete (fromEnum f) flags
          defaultExtensionFlags = IntSet.fromList (map fromEnum (languageExtensions ml))
949
950

languageExtensions :: Maybe Language -> [ExtensionFlag]
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
951

952
languageExtensions Nothing
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
953
    -- Nothing => the default case
954
    = Opt_NondecreasingIndentation -- This has been on by default for some time
955
956
957
958
959
    : delete Opt_DatatypeContexts  -- The Haskell' committee decided to
                                   -- remove datatype contexts from the
                                   -- language:
   -- http://www.haskell.org/pipermail/haskell-prime/2011-January/003335.html
      (languageExtensions (Just Haskell2010))
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
960

961
962
   -- NB: MonoPatBinds is no longer the default

963
964
965
966
languageExtensions (Just Haskell98)
    = [Opt_ImplicitPrelude,
       Opt_MonomorphismRestriction,
       Opt_NPlusKPatterns,
967
       Opt_DatatypeContexts,
968
       Opt_TraditionalRecordSyntax,
969
970
971
972
973
974
975
       Opt_NondecreasingIndentation
           -- strictly speaking non-standard, but we always had this
           -- on implicitly before the option was added in 7.1, and
           -- turning it off breaks code, so we're keeping it on for
           -- backwards compatibility.  Cabal uses -XHaskell98 by
           -- default unless you specify another language.
      ]
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
976

977
978
979
980
languageExtensions (Just Haskell2010)
    = [Opt_ImplicitPrelude,
       Opt_MonomorphismRestriction,
       Opt_DatatypeContexts,
981
       Opt_TraditionalRecordSyntax,
982
983
984
       Opt_EmptyDataDecls,
       Opt_ForeignFunctionInterface,
       Opt_PatternGuards,
Ian Lynagh's avatar
Ian Lynagh committed
985
       Opt_DoAndIfThenElse,
986
       Opt_RelaxedPolyRec]