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

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

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


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

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

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

77
        supportedLanguagesAndExtensions,
78
79

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

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

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

#include "HsVersions.h"

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

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

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

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

136
137
138
-- -----------------------------------------------------------------------------
-- DynFlags

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

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

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

231
232
   | Opt_PrintExplicitForalls

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

255
256
257
258
259
   -- Interface files
   | Opt_IgnoreInterfacePragmas
   | Opt_OmitInterfacePragmas
   | Opt_ExposeAllUnfoldings

Ian Lynagh's avatar
Ian Lynagh committed
260
261
   -- profiling opts
   | Opt_AutoSccsOnIndividualCafs
262
   | Opt_ProfCountEntries
Ian Lynagh's avatar
Ian Lynagh committed
263

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

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

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

309
   -- safe haskell flags
dterei's avatar
dterei committed
310
   | Opt_DistrustAllPackages
311
312
   | Opt_PackageTrust

313
   deriving (Eq, Show, Enum)
Ian Lynagh's avatar
Ian Lynagh committed
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
345
346
347
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
348
349
   | Opt_WarnUnsafe
   | Opt_WarnSafe
350
   deriving (Eq, Show, Enum)
351

352
data Language = Haskell98 | Haskell2010
353
   deriving Enum
354

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

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

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

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

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

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

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

484
  thisPackage           :: PackageId,   -- ^ name of package currently being compiled
485
486

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

491
492
493
  -- For object splitting
  splitInfo             :: Maybe (String,Int),

494
  -- paths etc.
Ian Lynagh's avatar
Ian Lynagh committed
495
  objectDir             :: Maybe String,
496
  dylibInstallName      :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
497
498
  hiDir                 :: Maybe String,
  stubDir               :: Maybe String,
499
  dumpDir               :: Maybe String,
500

Ian Lynagh's avatar
Ian Lynagh committed
501
502
503
  objectSuf             :: String,
  hcSuf                 :: String,
  hiSuf                 :: String,
504

Ian Lynagh's avatar
Ian Lynagh committed
505
506
507
  outputFile            :: Maybe String,
  outputHi              :: Maybe String,
  dynLibLoader          :: DynLibLoader,
508

509
  -- | This is set by 'DriverPipeline.runPipeline' based on where
Ian Lynagh's avatar
Ian Lynagh committed
510
511
  --    its output is going.
  dumpPrefix            :: Maybe FilePath,
512

513
514
  -- | Override the 'dumpPrefix' set by 'DriverPipeline.runPipeline'.
  --    Set by @-ddump-file-prefix@
Ian Lynagh's avatar
Ian Lynagh committed
515
516
517
518
519
520
521
  dumpPrefixForce       :: Maybe FilePath,

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

522
  rtsOpts               :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
523
  rtsOptsEnabled        :: RtsOptsEnabled,
524

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

527
528
529
530
  -- Plugins
  pluginModNames        :: [ModuleName],
  pluginModNameOpts     :: [(ModuleName,String)],

531
532
533
534
535
536
  --  For ghc -M
  depMakefile           :: FilePath,
  depIncludePkgDeps     :: Bool,
  depExcludeMods        :: [ModuleName],
  depSuffixes           :: [String],

537
  --  Package flags
Ian Lynagh's avatar
Ian Lynagh committed
538
  extraPkgConfs         :: [FilePath],
539
        -- ^ The @-package-conf@ flags given on the command line, in the order
Ian Lynagh's avatar
Ian Lynagh committed
540
        -- they appeared.
541

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

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

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

557
558
559
560
561
  -- 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),

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

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

586
587
588
589
  haddockOptions        :: Maybe String,

  -- | what kind of {-# SCC #-} to add automatically
  profAuto              :: ProfAuto
590
591
 }

592
593
594
class HasDynFlags m where
    getDynFlags :: m DynFlags

595
596
597
598
599
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
600
  | ProfAutoCalls      -- ^ annotate call-sites
Simon Marlow's avatar
Simon Marlow committed
601
  deriving (Enum)
602

603
data Settings = Settings {
604
  sTargetPlatform        :: Platform,    -- Filled in by SysTools
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
  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
627
628
629
630
631
632
633
634
635
636
637
638
  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

639
640
 }

641
642
643
targetPlatform :: DynFlags -> Platform
targetPlatform dflags = sTargetPlatform (settings dflags)

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
673
674
675
676
677
678
679
680
681
682
683
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)
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
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)
702

703
704
705
wayNames :: DynFlags -> [WayName]
wayNames = map wayName . ways

706
707
-- | The target code type of the compilation (if any).
--
708
709
710
-- Whenever you change the target, also make sure to set 'ghcLink' to
-- something sensible.
--
711
712
713
714
-- 'HscNothing' can be used to avoid generating any output, however, note
-- that:
--
--  * This will not run the desugaring step, thus no warnings generated in
715
716
717
--    this step will be output.  In particular, this includes warnings related
--    to pattern matching.  You can run the desugarer manually using
--    'GHC.desugarModule'.
718
--
719
720
721
722
723
724
--  * 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.)
725
--
726
data HscTarget
727
728
  = HscC           -- ^ Generate C code.
  | HscAsm         -- ^ Generate assembly using the native code generator.
729
  | HscLlvm        -- ^ Generate assembly using the llvm code generator.
730
731
  | HscInterpreted -- ^ Generate bytecode.  (Requires 'LinkInMemory')
  | HscNothing     -- ^ Don't generate any code.  See notes above.
732
733
  deriving (Eq, Show)

Ian Lynagh's avatar
Ian Lynagh committed
734
735
736
737
738
739
740
showHscTargetFlag :: HscTarget -> String
showHscTargetFlag HscC           = "-fvia-c"
showHscTargetFlag HscAsm         = "-fasm"
showHscTargetFlag HscLlvm        = "-fllvm"
showHscTargetFlag HscInterpreted = "-fbyte-code"
showHscTargetFlag HscNothing     = "-fno-code"

741
-- | Will this target result in an object file on the disk?
742
743
744
isObjectTarget :: HscTarget -> Bool
isObjectTarget HscC     = True
isObjectTarget HscAsm   = True
745
isObjectTarget HscLlvm  = True
746
747
748
749
750
751
752
753
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.
754
data GhcMode
755
756
757
  = CompManager         -- ^ @\-\-make@, GHCi, etc.
  | OneShot             -- ^ @ghc -c Foo.hs@
  | MkDepend            -- ^ @ghc -M@, see "Finder" for why we need this
758
759
  deriving Eq

760
761
762
763
764
instance Outputable GhcMode where
  ppr CompManager = ptext (sLit "CompManager")
  ppr OneShot     = ptext (sLit "OneShot")
  ppr MkDepend    = ptext (sLit "MkDepend")

765
766
767
768
isOneShot :: GhcMode -> Bool
isOneShot OneShot = True
isOneShot _other  = False

769
770
771
772
-- | 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
773
774
  | LinkInMemory        -- ^ Use the in-memory dynamic linker (works for both
                        --   bytecode and object code).
775
  | LinkDynLib          -- ^ Link objects into a dynamic lib (DLL on Windows, DSO on ELF platforms)
776
  deriving (Eq, Show)
777
778
779

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

782
783
784
-- Is it worth evaluating this Bool and caching it in the DynFlags value
-- during initDynFlags?
doingTickyProfiling :: DynFlags -> Bool
785
786
787
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.
788

789
data PackageFlag
790
  = ExposePackage   String
791
  | ExposePackageId String
792
793
794
795
  | HidePackage     String
  | IgnorePackage   String
  | TrustPackage    String
  | DistrustPackage String
796
  deriving Eq
797

twanvl's avatar
twanvl committed
798
defaultHscTarget :: HscTarget
799
800
defaultHscTarget = defaultObjectTarget

801
-- | The 'HscTarget' value corresponding to the default way to create
802
-- object files on the current platform.
twanvl's avatar
twanvl committed
803
defaultObjectTarget :: HscTarget
804
defaultObjectTarget
805
  | cGhcUnregisterised    == "YES"      =  HscC
Ian Lynagh's avatar
Ian Lynagh committed
806
  | cGhcWithNativeCodeGen == "YES"      =  HscAsm
807
  | otherwise                           =  HscLlvm
808

809
810
811
812
813
data DynLibLoader
  = Deployable
  | SystemDependent
  deriving Eq

Ian Lynagh's avatar
Ian Lynagh committed
814
data RtsOptsEnabled = RtsOptsNone | RtsOptsSafeOnly | RtsOptsAll
815
  deriving (Show)
Ian Lynagh's avatar
Ian Lynagh committed
816

817
-- | Used by 'GHC.newSession' to partially initialize a new 'DynFlags' value
twanvl's avatar
twanvl committed
818
initDynFlags :: DynFlags -> IO DynFlags
819
820
821
initDynFlags dflags = do
 -- someday these will be dynamic flags
 ways <- readIORef v_Ways
822
 refFilesToClean <- newIORef []
823
 refDirsToClean <- newIORef Map.empty
824
 refGeneratedDumps <- newIORef Set.empty
825
 return dflags{
826
827
828
        ways            = ways,
        buildTag        = mkBuildTag (filter (not . wayRTSOnly) ways),
        rtsBuildTag     = mkBuildTag ways,
829
        filesToClean    = refFilesToClean,
830
831
        dirsToClean     = refDirsToClean,
        generatedDumps   = refGeneratedDumps
Ian Lynagh's avatar
Ian Lynagh committed
832
        }
833

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

Ian Lynagh's avatar
Ian Lynagh committed
857
858
859
860
861
862
863
864
865
        cmdlineHcIncludes       = [],
        importPaths             = ["."],
        mainModIs               = mAIN,
        mainFunIs               = Nothing,
        ctxtStkDepth            = mAX_CONTEXT_REDUCTION_DEPTH,

        thisPackage             = mainPackageId,

        objectDir               = Nothing,
866
        dylibInstallName        = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
867
868
        hiDir                   = Nothing,
        stubDir                 = Nothing,
869
        dumpDir                 = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
870
871
872
873
874

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

875
876
877
        pluginModNames          = [],
        pluginModNameOpts       = [],

Ian Lynagh's avatar
Ian Lynagh committed
878
879
        outputFile              = Nothing,
        outputHi                = Nothing,
880
        dynLibLoader            = SystemDependent,
Ian Lynagh's avatar
Ian Lynagh committed
881
882
883
884
885
886
        dumpPrefix              = Nothing,
        dumpPrefixForce         = Nothing,
        includePaths            = [],
        libraryPaths            = [],
        frameworkPaths          = [],
        cmdlineFrameworks       = [],
887
        rtsOpts                 = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
888
        rtsOptsEnabled          = RtsOptsSafeOnly,
Ian Lynagh's avatar
Ian Lynagh committed
889
890
891
892
893

        hpcDir                  = ".hpc",

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

926
type LogAction = Severity -> SrcSpan -> PprStyle -> MsgDoc -> IO ()
927
928
929
930
931
932
933
934

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'
935
                   printErrs (mkLocMessage severity srcSpan msg) style
936
937
938
939
                   -- 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
940
{-
941
942
Note [Verbosity levels]
~~~~~~~~~~~~~~~~~~~~~~~
Ian Lynagh's avatar
Ian Lynagh committed
943
    0   |   print errors & warnings only
944
945
946
947
948
949
950
    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"
-}

951
952
953
954
955
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
956
flattenExtensionFlags :: Maybe Language -> [OnOff ExtensionFlag] -> IntSet
957
flattenExtensionFlags ml = foldr f defaultExtensionFlags
958
959
960
    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))
961
962

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

964
languageExtensions Nothing
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
965
    -- Nothing => the default case
966
    = Opt_NondecreasingIndentation -- This has been on by default for some time
967
968
969
970
971
    : 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))