DynFlags.hs 105 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
-- -----------------------------------------------------------------------------
-- DynFlags

135
-- | Enumerates the simple on-or-off dynamic flags
136
137
138
139
data DynFlag

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

Ian Lynagh's avatar
Ian Lynagh committed
224
   | Opt_WarnIsError                    -- -Werror; makes warnings fatal
225

226
227
   | Opt_PrintExplicitForalls

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

249
250
251
252
253
   -- Interface files
   | Opt_IgnoreInterfacePragmas
   | Opt_OmitInterfacePragmas
   | Opt_ExposeAllUnfoldings

Ian Lynagh's avatar
Ian Lynagh committed
254
255
   -- profiling opts
   | Opt_AutoSccsOnIndividualCafs
256
   | Opt_ProfCountEntries
Ian Lynagh's avatar
Ian Lynagh committed
257

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

288
   -- temporary flags
289
   | Opt_RunCPS
290
   | Opt_RunCPSZ
291
   | Opt_AutoLinkPackages
292
   | Opt_ImplicitImportQualified
293
   | Opt_TryNewCodeGen
294
295
296
297
298
299

   -- keeping stuff
   | Opt_KeepHiDiffs
   | Opt_KeepHcFiles
   | Opt_KeepSFiles
   | Opt_KeepTmpFiles
Jedai's avatar
Jedai committed
300
   | Opt_KeepRawTokenStream
301
   | Opt_KeepLlvmFiles
302

303
304
305
   -- safe haskell flags
   | Opt_PackageTrust

306
   deriving (Eq, Show)
Ian Lynagh's avatar
Ian Lynagh committed
307

308
309
310
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
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
   deriving (Eq, Show)

343
data Language = Haskell98 | Haskell2010
344
   deriving Enum
345

346
-- | The various Safe Haskell modes
347
348
data SafeHaskellMode
   = Sf_None
dterei's avatar
dterei committed
349
   | Sf_Unsafe
350
351
   | Sf_Trustworthy
   | Sf_Safe
dterei's avatar
dterei committed
352
   | Sf_SafeInfered
353
354
   deriving (Eq)

355
instance Outputable SafeHaskellMode where
dterei's avatar
dterei committed
356
357
    ppr Sf_None        = ptext $ sLit "None"
    ppr Sf_Unsafe      = ptext $ sLit "Unsafe"
358
    ppr Sf_Trustworthy = ptext $ sLit "Trustworthy"
dterei's avatar
dterei committed
359
360
    ppr Sf_Safe        = ptext $ sLit "Safe"
    ppr Sf_SafeInfered = ptext $ sLit "Safe-Infered"
361

362
data ExtensionFlag
363
364
365
366
367
368
369
   = Opt_Cpp
   | Opt_OverlappingInstances
   | Opt_UndecidableInstances
   | Opt_IncoherentInstances
   | Opt_MonomorphismRestriction
   | Opt_MonoPatBinds
   | Opt_MonoLocalBinds
370
371
   | Opt_RelaxedPolyRec           -- Deprecated
   | Opt_ExtendedDefaultRules     -- Use GHC's extended rules for defaulting
372
373
   | Opt_ForeignFunctionInterface
   | Opt_UnliftedFFITypes
374
   | Opt_InterruptibleFFI
375
   | Opt_GHCForeignImportPrim
376
377
   | Opt_ParallelArrays           -- Syntactic support for parallel arrays
   | Opt_Arrows                   -- Arrow-notation syntax
378
379
380
381
382
383
384
385
386
387
388
389
390
391
   | 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
392
   | Opt_GADTSyntax
393
   | Opt_NPlusKPatterns
Ian Lynagh's avatar
Ian Lynagh committed
394
   | Opt_DoAndIfThenElse
395
   | Opt_RebindableSyntax
396
   | Opt_ConstraintKinds
dreixel's avatar
dreixel committed
397
398
   | Opt_PolyKinds                -- Kind polymorphism
   
399
400
401
402
403
   | Opt_StandaloneDeriving
   | Opt_DeriveDataTypeable
   | Opt_DeriveFunctor
   | Opt_DeriveTraversable
   | Opt_DeriveFoldable
404
   | Opt_DeriveGeneric            -- Allow deriving Generic/1
dreixel's avatar
dreixel committed
405
   | Opt_DefaultSignatures        -- Allow extra signatures for defmeths
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420

   | 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
421
   | Opt_MonadComprehensions
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
   | 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
438
   | Opt_NondecreasingIndentation
439
   | Opt_RelaxedLayout
440
   | Opt_TraditionalRecordSyntax
441
   deriving (Eq, Enum, Show)
442

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

459
  simplTickFactor       :: Int,         -- ^ Multiplier for simplifier ticks
460
461
462
  specConstrThreshold   :: Maybe Int,   -- ^ Threshold for SpecConstr
  specConstrCount       :: Maybe Int,   -- ^ Max number of specialisations for any one function
  liberateCaseThreshold :: Maybe Int,   -- ^ Threshold for LiberateCase
463
  floatLamArgs          :: Maybe Int,   -- ^ Arg count for lambda floating
464
                                        --   See CoreMonad.FloatOutSwitches
465

466
  cmdlineHcIncludes     :: [String],    -- ^ @\-\#includes@
Ian Lynagh's avatar
Ian Lynagh committed
467
468
469
  importPaths           :: [FilePath],
  mainModIs             :: Module,
  mainFunIs             :: Maybe String,
470
  ctxtStkDepth          :: Int,         -- ^ Typechecker context stack depth
471

472
  thisPackage           :: PackageId,   -- ^ name of package currently being compiled
473
474

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

479
480
481
  -- For object splitting
  splitInfo             :: Maybe (String,Int),

482
  -- paths etc.
Ian Lynagh's avatar
Ian Lynagh committed
483
  objectDir             :: Maybe String,
484
  dylibInstallName      :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
485
486
  hiDir                 :: Maybe String,
  stubDir               :: Maybe String,
487

Ian Lynagh's avatar
Ian Lynagh committed
488
489
490
  objectSuf             :: String,
  hcSuf                 :: String,
  hiSuf                 :: String,
491

Ian Lynagh's avatar
Ian Lynagh committed
492
493
494
  outputFile            :: Maybe String,
  outputHi              :: Maybe String,
  dynLibLoader          :: DynLibLoader,
495

496
  -- | This is set by 'DriverPipeline.runPipeline' based on where
Ian Lynagh's avatar
Ian Lynagh committed
497
498
  --    its output is going.
  dumpPrefix            :: Maybe FilePath,
499

500
501
  -- | Override the 'dumpPrefix' set by 'DriverPipeline.runPipeline'.
  --    Set by @-ddump-file-prefix@
Ian Lynagh's avatar
Ian Lynagh committed
502
503
504
505
506
507
508
  dumpPrefixForce       :: Maybe FilePath,

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

509
  rtsOpts               :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
510
  rtsOptsEnabled        :: RtsOptsEnabled,
511

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

514
515
516
517
  -- Plugins
  pluginModNames        :: [ModuleName],
  pluginModNameOpts     :: [(ModuleName,String)],

518
  settings              :: Settings,
519

520
521
522
523
524
525
  --  For ghc -M
  depMakefile           :: FilePath,
  depIncludePkgDeps     :: Bool,
  depExcludeMods        :: [ModuleName],
  depSuffixes           :: [String],

526
  --  Package flags
Ian Lynagh's avatar
Ian Lynagh committed
527
  extraPkgConfs         :: [FilePath],
528
        -- ^ The @-package-conf@ flags given on the command line, in the order
Ian Lynagh's avatar
Ian Lynagh committed
529
        -- they appeared.
530

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

534
  -- Package state
Ian Lynagh's avatar
Ian Lynagh committed
535
  -- NB. do not modify this field, it is calculated by
536
  -- Packages.initPackages and Packages.updatePackages.
537
  pkgDatabase           :: Maybe [PackageConfig],
Ian Lynagh's avatar
Ian Lynagh committed
538
  pkgState              :: PackageState,
539

540
541
542
543
  -- Temporary files
  -- These have to be IORefs, because the defaultCleanupHandler needs to
  -- know what to clean when an exception happens
  filesToClean          :: IORef [FilePath],
544
  dirsToClean           :: IORef (Map FilePath FilePath),
545

546
547
548
549
550
  -- 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),

551
  -- hsc dynamic flags
Ian Lynagh's avatar
Ian Lynagh committed
552
  flags                 :: [DynFlag],
553
  warningFlags          :: [WarningFlag],
554
  -- Don't change this without updating extensionFlags:
555
  language              :: Maybe Language,
556
557
  -- | Safe Haskell mode
  safeHaskell           :: SafeHaskellMode,
558
559
560
561
562
  -- 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,
563
564
565
566
567
  -- Don't change this without updating extensionFlags:
  extensions            :: [OnOff ExtensionFlag],
  -- extensionFlags should always be equal to
  --     flattenExtensionFlags language extensions
  extensionFlags        :: [ExtensionFlag],
Ian Lynagh's avatar
Ian Lynagh committed
568

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

572
573
574
575
  haddockOptions        :: Maybe String,

  -- | what kind of {-# SCC #-} to add automatically
  profAuto              :: ProfAuto
576
577
 }

578
579
580
581
582
583
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

584
data Settings = Settings {
585
  sTargetPlatform        :: Platform,    -- Filled in by SysTools
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
  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
608
609
610
611
612
613
614
615
616
617
618
619
  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

620
621
 }

622
623
624
targetPlatform :: DynFlags -> Platform
targetPlatform dflags = sTargetPlatform (settings dflags)

625
626
627
628
629
630
631
632
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
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)
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
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)
683

684
685
686
wayNames :: DynFlags -> [WayName]
wayNames = map wayName . ways

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

Ian Lynagh's avatar
Ian Lynagh committed
715
716
717
718
719
720
721
showHscTargetFlag :: HscTarget -> String
showHscTargetFlag HscC           = "-fvia-c"
showHscTargetFlag HscAsm         = "-fasm"
showHscTargetFlag HscLlvm        = "-fllvm"
showHscTargetFlag HscInterpreted = "-fbyte-code"
showHscTargetFlag HscNothing     = "-fno-code"

722
-- | Will this target result in an object file on the disk?
723
724
725
isObjectTarget :: HscTarget -> Bool
isObjectTarget HscC     = True
isObjectTarget HscAsm   = True
726
isObjectTarget HscLlvm  = True
727
728
729
730
731
732
733
734
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.
735
data GhcMode
736
737
738
  = CompManager         -- ^ @\-\-make@, GHCi, etc.
  | OneShot             -- ^ @ghc -c Foo.hs@
  | MkDepend            -- ^ @ghc -M@, see "Finder" for why we need this
739
740
  deriving Eq

741
742
743
744
745
instance Outputable GhcMode where
  ppr CompManager = ptext (sLit "CompManager")
  ppr OneShot     = ptext (sLit "OneShot")
  ppr MkDepend    = ptext (sLit "MkDepend")

746
747
748
749
isOneShot :: GhcMode -> Bool
isOneShot OneShot = True
isOneShot _other  = False

750
751
752
753
-- | 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
754
755
  | LinkInMemory        -- ^ Use the in-memory dynamic linker (works for both
                        --   bytecode and object code).
756
  | LinkDynLib          -- ^ Link objects into a dynamic lib (DLL on Windows, DSO on ELF platforms)
757
  deriving (Eq, Show)
758
759
760

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

763
764
765
-- Is it worth evaluating this Bool and caching it in the DynFlags value
-- during initDynFlags?
doingTickyProfiling :: DynFlags -> Bool
766
767
768
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.
769

770
data PackageFlag
771
  = ExposePackage   String
772
  | ExposePackageId String
773
774
775
776
  | HidePackage     String
  | IgnorePackage   String
  | TrustPackage    String
  | DistrustPackage String
777
  deriving Eq
778

twanvl's avatar
twanvl committed
779
defaultHscTarget :: HscTarget
780
781
defaultHscTarget = defaultObjectTarget

782
-- | The 'HscTarget' value corresponding to the default way to create
783
-- object files on the current platform.
twanvl's avatar
twanvl committed
784
defaultObjectTarget :: HscTarget
785
defaultObjectTarget
786
  | cGhcUnregisterised    == "YES"      =  HscC
Ian Lynagh's avatar
Ian Lynagh committed
787
  | cGhcWithNativeCodeGen == "YES"      =  HscAsm
788
  | otherwise                           =  HscLlvm
789

790
791
792
793
794
data DynLibLoader
  = Deployable
  | SystemDependent
  deriving Eq

Ian Lynagh's avatar
Ian Lynagh committed
795
data RtsOptsEnabled = RtsOptsNone | RtsOptsSafeOnly | RtsOptsAll
796
  deriving (Show)
Ian Lynagh's avatar
Ian Lynagh committed
797

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

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

Ian Lynagh's avatar
Ian Lynagh committed
838
839
840
841
842
843
844
845
846
        cmdlineHcIncludes       = [],
        importPaths             = ["."],
        mainModIs               = mAIN,
        mainFunIs               = Nothing,
        ctxtStkDepth            = mAX_CONTEXT_REDUCTION_DEPTH,

        thisPackage             = mainPackageId,

        objectDir               = Nothing,
847
        dylibInstallName        = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
848
849
850
851
852
853
854
        hiDir                   = Nothing,
        stubDir                 = Nothing,

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

855
856
857
        pluginModNames          = [],
        pluginModNameOpts       = [],

Ian Lynagh's avatar
Ian Lynagh committed
858
859
        outputFile              = Nothing,
        outputHi                = Nothing,
860
        dynLibLoader            = SystemDependent,
Ian Lynagh's avatar
Ian Lynagh committed
861
862
863
864
865
866
        dumpPrefix              = Nothing,
        dumpPrefixForce         = Nothing,
        includePaths            = [],
        libraryPaths            = [],
        frameworkPaths          = [],
        cmdlineFrameworks       = [],
867
        rtsOpts                 = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
868
        rtsOptsEnabled          = RtsOptsSafeOnly,
Ian Lynagh's avatar
Ian Lynagh committed
869
870
871
872
873

        hpcDir                  = ".hpc",

        extraPkgConfs           = [],
        packageFlags            = [],
874
875
        pkgDatabase             = Nothing,
        pkgState                = panic "no package state yet: call GHC.setSessionDynFlags",
876
        ways                    = panic "defaultDynFlags: No ways",
Ian Lynagh's avatar
Ian Lynagh committed
877
878
        buildTag                = panic "defaultDynFlags: No buildTag",
        rtsBuildTag             = panic "defaultDynFlags: No rtsBuildTag",
879
        splitInfo               = Nothing,
880
        settings                = mySettings,
881
882
883
884
885
886
        -- ghc -M values
        depMakefile       = "Makefile",
        depIncludePkgDeps = False,
        depExcludeMods    = [],
        depSuffixes       = [],
        -- end of ghc -M values
887
888
        filesToClean   = panic "defaultDynFlags: No filesToClean",
        dirsToClean    = panic "defaultDynFlags: No dirsToClean",
889
        generatedDumps = panic "defaultDynFlags: No generatedDumps",
Ian Lynagh's avatar
Ian Lynagh committed
890
        haddockOptions = Nothing,
891
        flags = defaultFlags,
892
        warningFlags = standardWarnings,
893
        language = Nothing,
dterei's avatar
dterei committed
894
        safeHaskell = Sf_SafeInfered,
895
896
        thOnLoc = noSrcSpan,
        newDerivOnLoc = noSrcSpan,
897
898
        extensions = [],
        extensionFlags = flattenExtensionFlags Nothing [],
899
900
        log_action = defaultLogAction,
        profAuto = NoProfAuto
901
902
      }

903
904
905
906
907
908
909
910
911
912
913
914
915
916
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
917
{-
918
919
Note [Verbosity levels]
~~~~~~~~~~~~~~~~~~~~~~~
Ian Lynagh's avatar
Ian Lynagh committed
920
    0   |   print errors & warnings only
921
922
923
924
925
926
927
    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"
-}

928
929
930
931
932
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
933
934
935
flattenExtensionFlags :: Maybe Language -> [OnOff ExtensionFlag]
                      -> [ExtensionFlag]
flattenExtensionFlags ml = foldr f defaultExtensionFlags
936
937
    where f (On f)  flags = f : delete f flags
          f (Off f) flags =     delete f flags
938
939
940
          defaultExtensionFlags = languageExtensions ml

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

942
languageExtensions Nothing
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
943
    -- Nothing => the default case
944
    = Opt_NondecreasingIndentation -- This has been on by default for some time
945
946
947
948
949
    : 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
950

951
952
   -- NB: MonoPatBinds is no longer the default

953
954
955
956
languageExtensions (Just Haskell98)
    = [Opt_ImplicitPrelude,
       Opt_MonomorphismRestriction,
       Opt_NPlusKPatterns,
957
       Opt_DatatypeContexts,
958
       Opt_TraditionalRecordSyntax,
959
960
961
962
963
964
965
       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
966

967
968
969
970
languageExtensions (Just Haskell2010)
    = [Opt_ImplicitPrelude,
       Opt_MonomorphismRestriction,
       Opt_DatatypeContexts,
971
       Opt_TraditionalRecordSyntax,
972
973
974
       Opt_EmptyDataDecls,
       Opt_ForeignFunctionInterface,
       Opt_PatternGuards,
Ian Lynagh's avatar
Ian Lynagh committed
975
       Opt_DoAndIfThenElse,
976
       Opt_RelaxedPolyRec]
977

978
-- | Test whether a 'DynFlag' is set
979
980
dopt :: DynFlag -> DynFlags -> Bool
dopt f dflags  = f `elem` (flags dflags)
981

982
-- | Set a 'DynFlag'
983
984
dopt_set :: DynFlags -> DynFlag -> DynFlags
dopt_set dfs f = dfs{ flags = f : flags dfs }
985

986
-- | Unset a 'DynFlag'
987
988
dopt_unset :: DynFlags -> DynFlag -> DynFlags
dopt_unset dfs f = dfs{ flags = filter (/= f) (flags dfs) }
989

990
991
992
993
994