DynFlags.hs 105 KB
Newer Older
1
-- |
2
3
4
5
6
7
-- Dynamic flags
--
--
-- (c) The University of Glasgow 2005
--

8
-- Most flags are dynamic flags, which means they can change from
9
10
11
-- 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.
12
module DynFlags (
13
        -- * Dynamic flags and associated configuration types
Ian Lynagh's avatar
Ian Lynagh committed
14
        DynFlag(..),
15
        WarningFlag(..),
16
        ExtensionFlag(..),
17
        LogAction,
18
        glasgowExtsFlags,
19
20
21
        dopt,
        dopt_set,
        dopt_unset,
22
23
24
        wopt,
        wopt_set,
        wopt_unset,
25
26
27
        xopt,
        xopt_set,
        xopt_unset,
Ian Lynagh's avatar
Ian Lynagh committed
28
        DynFlags(..),
Ian Lynagh's avatar
Ian Lynagh committed
29
        RtsOptsEnabled(..),
Ian Lynagh's avatar
Ian Lynagh committed
30
31
32
33
        HscTarget(..), isObjectTarget, defaultObjectTarget,
        GhcMode(..), isOneShot,
        GhcLink(..), isNoLink,
        PackageFlag(..),
Ian Lynagh's avatar
Ian Lynagh committed
34
        Option(..), showOpt,
Ian Lynagh's avatar
Ian Lynagh committed
35
        DynLibLoader(..),
36
        fFlags, fWarningFlags, fLangFlags, xFlags,
37
        DPHBackend(..), dphPackageMaybe,
38
        wayNames, dynFlagDependencies,
39

40
        -- ** Safe Haskell
41
        SafeHaskellMode(..),
42
43
        safeHaskellOn, safeLanguageOn,
        safeDirectImpsReq, safeImplicitImpsReq,
44
        packageTrustOn,
45

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


56
        -- ** Manipulating DynFlags
57
        defaultDynFlags,                -- Settings -> DynFlags
Ian Lynagh's avatar
Ian Lynagh committed
58
        initDynFlags,                   -- DynFlags -> IO DynFlags
59
        defaultLogAction,
Ian Lynagh's avatar
Ian Lynagh committed
60

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

68
        -- ** Parsing DynFlags
69
70
        parseDynamicFlagsCmdLine,
        parseDynamicFilePragma,
71
        allFlags,
72

73
        supportedLanguagesAndExtensions,
74
75

        -- ** DynFlag C compiler options
76
        picCCOpts,
77
78
79
80
81
82

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

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

#include "HsVersions.h"

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

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

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

129
130
131
-- -----------------------------------------------------------------------------
-- DynFlags

132
-- | Enumerates the simple on-or-off dynamic flags
133
134
135
136
data DynFlag

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

Ian Lynagh's avatar
Ian Lynagh committed
221
   | Opt_WarnIsError                    -- -Werror; makes warnings fatal
222

223
224
   | Opt_PrintExplicitForalls

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

245
246
247
248
249
   -- Interface files
   | Opt_IgnoreInterfacePragmas
   | Opt_OmitInterfacePragmas
   | Opt_ExposeAllUnfoldings

Ian Lynagh's avatar
Ian Lynagh committed
250
251
252
253
254
   -- profiling opts
   | Opt_AutoSccsOnAllToplevs
   | Opt_AutoSccsOnExportedToplevs
   | Opt_AutoSccsOnIndividualCafs

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

285
   -- temporary flags
286
   | Opt_RunCPS
287
   | Opt_RunCPSZ
288
   | Opt_AutoLinkPackages
289
   | Opt_ImplicitImportQualified
290
   | Opt_TryNewCodeGen
291
292
293
294
295
296

   -- keeping stuff
   | Opt_KeepHiDiffs
   | Opt_KeepHcFiles
   | Opt_KeepSFiles
   | Opt_KeepTmpFiles
Jedai's avatar
Jedai committed
297
   | Opt_KeepRawTokenStream
298
   | Opt_KeepLlvmFiles
299

300
301
302
   -- safe haskell flags
   | Opt_PackageTrust

303
   deriving (Eq, Show)
Ian Lynagh's avatar
Ian Lynagh committed
304

305
306
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
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)

340
341
data Language = Haskell98 | Haskell2010

342
-- | The various Safe Haskell modes
343
344
345
346
347
348
349
data SafeHaskellMode
   = Sf_None
   | Sf_SafeImports
   | Sf_Trustworthy
   | Sf_Safe
   deriving (Eq)

350
351
352
353
354
instance Outputable SafeHaskellMode where
    ppr Sf_None = ptext $ sLit "None"
    ppr Sf_SafeImports = ptext $ sLit "SafeImports"
    ppr Sf_Trustworthy = ptext $ sLit "Trustworthy"
    ppr Sf_Safe = ptext $ sLit "Safe"
355

356
data ExtensionFlag
357
358
359
360
361
362
363
   = Opt_Cpp
   | Opt_OverlappingInstances
   | Opt_UndecidableInstances
   | Opt_IncoherentInstances
   | Opt_MonomorphismRestriction
   | Opt_MonoPatBinds
   | Opt_MonoLocalBinds
364
365
   | Opt_RelaxedPolyRec           -- Deprecated
   | Opt_ExtendedDefaultRules     -- Use GHC's extended rules for defaulting
366
367
   | Opt_ForeignFunctionInterface
   | Opt_UnliftedFFITypes
368
   | Opt_InterruptibleFFI
369
   | Opt_GHCForeignImportPrim
370
371
   | Opt_ParallelArrays           -- Syntactic support for parallel arrays
   | Opt_Arrows                   -- Arrow-notation syntax
372
373
374
375
376
377
378
379
380
381
382
383
384
385
   | 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
386
   | Opt_GADTSyntax
387
   | Opt_NPlusKPatterns
Ian Lynagh's avatar
Ian Lynagh committed
388
   | Opt_DoAndIfThenElse
389
   | Opt_RebindableSyntax
390
   | Opt_ConstraintKinds
dterei's avatar
dterei committed
391

392
393
394
395
396
   | Opt_StandaloneDeriving
   | Opt_DeriveDataTypeable
   | Opt_DeriveFunctor
   | Opt_DeriveTraversable
   | Opt_DeriveFoldable
397
   | Opt_DeriveGeneric            -- Allow deriving Generic/1
dreixel's avatar
dreixel committed
398
   | Opt_DefaultSignatures        -- Allow extra signatures for defmeths
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413

   | 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
414
   | Opt_MonadComprehensions
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
   | 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
431
   | Opt_NondecreasingIndentation
432
   | Opt_RelaxedLayout
433
   | Opt_TraditionalRecordSyntax
434
435
   deriving (Eq, Show)

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

452
  simplTickFactor       :: Int,         -- ^ Multiplier for simplifier ticks
453
454
455
  specConstrThreshold   :: Maybe Int,   -- ^ Threshold for SpecConstr
  specConstrCount       :: Maybe Int,   -- ^ Max number of specialisations for any one function
  liberateCaseThreshold :: Maybe Int,   -- ^ Threshold for LiberateCase
456
  floatLamArgs          :: Maybe Int,   -- ^ Arg count for lambda floating
457
                                        --   See CoreMonad.FloatOutSwitches
458

Ian Lynagh's avatar
Ian Lynagh committed
459
  targetPlatform        :: Platform.Platform, -- ^ The platform we're compiling for. Used by the NCG.
460
  cmdlineHcIncludes     :: [String],    -- ^ @\-\#includes@
Ian Lynagh's avatar
Ian Lynagh committed
461
462
463
  importPaths           :: [FilePath],
  mainModIs             :: Module,
  mainFunIs             :: Maybe String,
464
  ctxtStkDepth          :: Int,         -- ^ Typechecker context stack depth
465

466
467
  dphBackend            :: DPHBackend,

468
  thisPackage           :: PackageId,   -- ^ name of package currently being compiled
469
470

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

475
476
477
  -- For object splitting
  splitInfo             :: Maybe (String,Int),

478
  -- paths etc.
Ian Lynagh's avatar
Ian Lynagh committed
479
  objectDir             :: Maybe String,
480
  dylibInstallName      :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
481
482
  hiDir                 :: Maybe String,
  stubDir               :: Maybe String,
483

Ian Lynagh's avatar
Ian Lynagh committed
484
485
486
  objectSuf             :: String,
  hcSuf                 :: String,
  hiSuf                 :: String,
487

Ian Lynagh's avatar
Ian Lynagh committed
488
489
490
  outputFile            :: Maybe String,
  outputHi              :: Maybe String,
  dynLibLoader          :: DynLibLoader,
491

492
  -- | This is set by 'DriverPipeline.runPipeline' based on where
Ian Lynagh's avatar
Ian Lynagh committed
493
494
  --    its output is going.
  dumpPrefix            :: Maybe FilePath,
495

496
497
  -- | Override the 'dumpPrefix' set by 'DriverPipeline.runPipeline'.
  --    Set by @-ddump-file-prefix@
Ian Lynagh's avatar
Ian Lynagh committed
498
499
500
501
502
503
504
  dumpPrefixForce       :: Maybe FilePath,

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

505
  rtsOpts               :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
506
  rtsOptsEnabled        :: RtsOptsEnabled,
507

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

510
511
512
513
  -- Plugins
  pluginModNames        :: [ModuleName],
  pluginModNameOpts     :: [(ModuleName,String)],

514
  settings              :: Settings,
515

516
517
518
519
520
521
  --  For ghc -M
  depMakefile           :: FilePath,
  depIncludePkgDeps     :: Bool,
  depExcludeMods        :: [ModuleName],
  depSuffixes           :: [String],

522
  --  Package flags
Ian Lynagh's avatar
Ian Lynagh committed
523
  extraPkgConfs         :: [FilePath],
524
        -- ^ The @-package-conf@ flags given on the command line, in the order
Ian Lynagh's avatar
Ian Lynagh committed
525
        -- they appeared.
526

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

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

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

542
543
544
545
546
  -- 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),

547
  -- hsc dynamic flags
Ian Lynagh's avatar
Ian Lynagh committed
548
  flags                 :: [DynFlag],
549
  warningFlags          :: [WarningFlag],
550
  -- Don't change this without updating extensionFlags:
551
  language              :: Maybe Language,
552
553
  -- | Safe Haskell mode
  safeHaskell           :: SafeHaskellMode,
554
555
556
557
558
  -- 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,
559
560
561
562
563
  -- 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
564

565
  -- | Message output action: use "ErrUtils" instead of this if you can
566
  log_action            :: LogAction,
David Waern's avatar
David Waern committed
567
568

  haddockOptions :: Maybe String
569
570
 }

571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
data Settings = Settings {
  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
594
595
596
597
598
599
600
601
602
603
604
605
  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

606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
 }

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)
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
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)
666

667
668
669
wayNames :: DynFlags -> [WayName]
wayNames = map wayName . ways

670
671
-- | The target code type of the compilation (if any).
--
672
673
674
-- Whenever you change the target, also make sure to set 'ghcLink' to
-- something sensible.
--
675
676
677
678
-- 'HscNothing' can be used to avoid generating any output, however, note
-- that:
--
--  * This will not run the desugaring step, thus no warnings generated in
679
680
681
--    this step will be output.  In particular, this includes warnings related
--    to pattern matching.  You can run the desugarer manually using
--    'GHC.desugarModule'.
682
--
683
684
685
686
687
688
--  * 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.)
689
--
690
data HscTarget
691
692
  = HscC           -- ^ Generate C code.
  | HscAsm         -- ^ Generate assembly using the native code generator.
693
  | HscLlvm        -- ^ Generate assembly using the llvm code generator.
694
695
  | HscInterpreted -- ^ Generate bytecode.  (Requires 'LinkInMemory')
  | HscNothing     -- ^ Don't generate any code.  See notes above.
696
697
  deriving (Eq, Show)

Ian Lynagh's avatar
Ian Lynagh committed
698
699
700
701
702
703
704
showHscTargetFlag :: HscTarget -> String
showHscTargetFlag HscC           = "-fvia-c"
showHscTargetFlag HscAsm         = "-fasm"
showHscTargetFlag HscLlvm        = "-fllvm"
showHscTargetFlag HscInterpreted = "-fbyte-code"
showHscTargetFlag HscNothing     = "-fno-code"

705
-- | Will this target result in an object file on the disk?
706
707
708
isObjectTarget :: HscTarget -> Bool
isObjectTarget HscC     = True
isObjectTarget HscAsm   = True
709
isObjectTarget HscLlvm  = True
710
711
712
713
714
715
716
717
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.
718
data GhcMode
719
720
721
  = CompManager         -- ^ @\-\-make@, GHCi, etc.
  | OneShot             -- ^ @ghc -c Foo.hs@
  | MkDepend            -- ^ @ghc -M@, see "Finder" for why we need this
722
723
  deriving Eq

724
725
726
727
728
instance Outputable GhcMode where
  ppr CompManager = ptext (sLit "CompManager")
  ppr OneShot     = ptext (sLit "OneShot")
  ppr MkDepend    = ptext (sLit "MkDepend")

729
730
731
732
isOneShot :: GhcMode -> Bool
isOneShot OneShot = True
isOneShot _other  = False

733
734
735
736
-- | 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
737
738
  | LinkInMemory        -- ^ Use the in-memory dynamic linker (works for both
                        --   bytecode and object code).
739
  | LinkDynLib          -- ^ Link objects into a dynamic lib (DLL on Windows, DSO on ELF platforms)
740
  deriving (Eq, Show)
741
742
743

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

746
747
748
-- Is it worth evaluating this Bool and caching it in the DynFlags value
-- during initDynFlags?
doingTickyProfiling :: DynFlags -> Bool
749
750
751
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.
752

753
data PackageFlag
754
  = ExposePackage   String
755
  | ExposePackageId String
756
757
758
759
  | HidePackage     String
  | IgnorePackage   String
  | TrustPackage    String
  | DistrustPackage String
760
  deriving Eq
761

twanvl's avatar
twanvl committed
762
defaultHscTarget :: HscTarget
763
764
defaultHscTarget = defaultObjectTarget

765
-- | The 'HscTarget' value corresponding to the default way to create
766
-- object files on the current platform.
twanvl's avatar
twanvl committed
767
defaultObjectTarget :: HscTarget
768
defaultObjectTarget
769
  | cGhcUnregisterised    == "YES"      =  HscC
Ian Lynagh's avatar
Ian Lynagh committed
770
  | cGhcWithNativeCodeGen == "YES"      =  HscAsm
771
  | otherwise                           =  HscLlvm
772

773
774
775
776
777
data DynLibLoader
  = Deployable
  | SystemDependent
  deriving Eq

Ian Lynagh's avatar
Ian Lynagh committed
778
data RtsOptsEnabled = RtsOptsNone | RtsOptsSafeOnly | RtsOptsAll
779
  deriving (Show)
Ian Lynagh's avatar
Ian Lynagh committed
780

781
-- | Used by 'GHC.newSession' to partially initialize a new 'DynFlags' value
twanvl's avatar
twanvl committed
782
initDynFlags :: DynFlags -> IO DynFlags
783
784
785
initDynFlags dflags = do
 -- someday these will be dynamic flags
 ways <- readIORef v_Ways
786
 refFilesToClean <- newIORef []
787
 refDirsToClean <- newIORef Map.empty
788
 refGeneratedDumps <- newIORef Set.empty
789
 return dflags{
790
791
792
        ways            = ways,
        buildTag        = mkBuildTag (filter (not . wayRTSOnly) ways),
        rtsBuildTag     = mkBuildTag ways,
793
        filesToClean    = refFilesToClean,
794
795
        dirsToClean     = refDirsToClean,
        generatedDumps   = refGeneratedDumps
Ian Lynagh's avatar
Ian Lynagh committed
796
        }
797

798
799
-- | The normal 'DynFlags'. Note that they is not suitable for use in this form
-- and must be fully initialized by 'GHC.newSession' first.
800
801
defaultDynFlags :: Settings -> DynFlags
defaultDynFlags mySettings =
802
     DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
803
804
805
806
807
808
809
        ghcMode                 = CompManager,
        ghcLink                 = LinkBinary,
        hscTarget               = defaultHscTarget,
        hscOutName              = "",
        extCoreName             = "",
        verbosity               = 0,
        optLevel                = 0,
810
        simplPhases             = 2,
Ian Lynagh's avatar
Ian Lynagh committed
811
        maxSimplIterations      = 4,
812
        shouldDumpSimplPhase    = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
813
        ruleCheck               = Nothing,
dterei's avatar
dterei committed
814
        simplTickFactor         = 100,
815
        specConstrThreshold     = Just 2000,
Ian Lynagh's avatar
Ian Lynagh committed
816
        specConstrCount         = Just 3,
817
        liberateCaseThreshold   = Just 2000,
818
        floatLamArgs            = Just 0, -- Default: float only if no fvs
819
820
        strictnessBefore        = [],

821
        targetPlatform          = defaultTargetPlatform,
Ian Lynagh's avatar
Ian Lynagh committed
822
823
824
825
826
827
        cmdlineHcIncludes       = [],
        importPaths             = ["."],
        mainModIs               = mAIN,
        mainFunIs               = Nothing,
        ctxtStkDepth            = mAX_CONTEXT_REDUCTION_DEPTH,

chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
828
        dphBackend              = DPHNone,
829

Ian Lynagh's avatar
Ian Lynagh committed
830
831
832
        thisPackage             = mainPackageId,

        objectDir               = Nothing,
833
        dylibInstallName        = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
834
835
836
837
838
839
840
        hiDir                   = Nothing,
        stubDir                 = Nothing,

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

841
842
843
        pluginModNames          = [],
        pluginModNameOpts       = [],

Ian Lynagh's avatar
Ian Lynagh committed
844
845
        outputFile              = Nothing,
        outputHi                = Nothing,
846
        dynLibLoader            = SystemDependent,
Ian Lynagh's avatar
Ian Lynagh committed
847
848
849
850
851
852
        dumpPrefix              = Nothing,
        dumpPrefixForce         = Nothing,
        includePaths            = [],
        libraryPaths            = [],
        frameworkPaths          = [],
        cmdlineFrameworks       = [],
853
        rtsOpts                 = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
854
        rtsOptsEnabled          = RtsOptsSafeOnly,
Ian Lynagh's avatar
Ian Lynagh committed
855
856
857
858
859

        hpcDir                  = ".hpc",

        extraPkgConfs           = [],
        packageFlags            = [],
860
861
        pkgDatabase             = Nothing,
        pkgState                = panic "no package state yet: call GHC.setSessionDynFlags",
862
        ways                    = panic "defaultDynFlags: No ways",
Ian Lynagh's avatar
Ian Lynagh committed
863
864
        buildTag                = panic "defaultDynFlags: No buildTag",
        rtsBuildTag             = panic "defaultDynFlags: No rtsBuildTag",
865
        splitInfo               = Nothing,
866
        settings                = mySettings,
867
868
869
870
871
872
        -- ghc -M values
        depMakefile       = "Makefile",
        depIncludePkgDeps = False,
        depExcludeMods    = [],
        depSuffixes       = [],
        -- end of ghc -M values
873
874
        filesToClean   = panic "defaultDynFlags: No filesToClean",
        dirsToClean    = panic "defaultDynFlags: No dirsToClean",
875
        generatedDumps = panic "defaultDynFlags: No generatedDumps",
Ian Lynagh's avatar
Ian Lynagh committed
876
        haddockOptions = Nothing,
877
        flags = defaultFlags,
878
        warningFlags = standardWarnings,
879
        language = Nothing,
880
        safeHaskell = Sf_None,
881
882
        thOnLoc = noSrcSpan,
        newDerivOnLoc = noSrcSpan,
883
884
        extensions = [],
        extensionFlags = flattenExtensionFlags Nothing [],
885
        log_action = defaultLogAction
886
887
      }

888
889
890
891
892
893
894
895
896
897
898
899
900
901
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
902
{-
903
904
Note [Verbosity levels]
~~~~~~~~~~~~~~~~~~~~~~~
Ian Lynagh's avatar
Ian Lynagh committed
905
    0   |   print errors & warnings only
906
907
908
909
910
911
912
    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"
-}

913
914
915
916
917
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
918
919
920
flattenExtensionFlags :: Maybe Language -> [OnOff ExtensionFlag]
                      -> [ExtensionFlag]
flattenExtensionFlags ml = foldr f defaultExtensionFlags
921
922
    where f (On f)  flags = f : delete f flags
          f (Off f) flags =     delete f flags
923
924
925
          defaultExtensionFlags = languageExtensions ml

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

927
languageExtensions Nothing
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
928
    -- Nothing => the default case
929
    = Opt_NondecreasingIndentation -- This has been on by default for some time
930
931
932
933
934
    : 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
935

936
937
   -- NB: MonoPatBinds is no longer the default

938
939
940
941
languageExtensions (Just Haskell98)
    = [Opt_ImplicitPrelude,
       Opt_MonomorphismRestriction,
       Opt_NPlusKPatterns,
942
       Opt_DatatypeContexts,
943
       Opt_TraditionalRecordSyntax,
944
945
946
947
948
949
950
       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
951

952
953
954
955
languageExtensions (Just Haskell2010)
    = [Opt_ImplicitPrelude,
       Opt_MonomorphismRestriction,
       Opt_DatatypeContexts,
956
       Opt_TraditionalRecordSyntax,
957
958
959
       Opt_EmptyDataDecls,
       Opt_ForeignFunctionInterface,
       Opt_PatternGuards,
Ian Lynagh's avatar
Ian Lynagh committed
960
       Opt_DoAndIfThenElse,
961
       Opt_RelaxedPolyRec]
962

963
-- | Test whether a 'DynFlag' is set
964
965
dopt :: DynFlag -> DynFlags -> Bool
dopt f dflags  = f `elem` (flags dflags)
966

967
-- | Set a 'DynFlag'
968
969
dopt_set :: DynFlags -> DynFlag -> DynFlags
dopt_set dfs f = dfs{ flags = f : flags dfs }
970

971
-- | Unset a 'DynFlag'
972
973
dopt_unset :: DynFlags -> DynFlag -> DynFlags
dopt_unset dfs f = dfs{ flags = filter (/= f) (flags dfs) }
974

975
976
977
978
979
980
981
982
983
984
985
986
-- | Test whether a 'WarningFlag' is set
wopt :: WarningFlag -> DynFlags -> Bool
wopt f dflags  = f `elem` (warningFlags dflags)

-- | Set a 'WarningFlag'
wopt_set :: DynFlags -> WarningFlag -> DynFlags
wopt_set dfs f = dfs{ warningFlags = f : warningFlags dfs }

-- | Unset a 'WarningFlag'
wopt_unset :: DynFlags -> WarningFlag -> DynFlags
wopt_unset dfs f = dfs{ warningFlags = filter (/= f) (warningFlags dfs) }

987
-- | Test whether a 'ExtensionFlag' is set
988
xopt :: ExtensionFlag -> DynFlags -> Bool
989
xopt f dflags = f `elem` extensionFlags dflags
990

991
-- | Set a 'ExtensionFlag'
992
xopt_set :: DynFlags -> ExtensionFlag -> DynFlags
993
994
995
996
xopt_set dfs f
    = let onoffs = On f : extensions dfs
      in dfs { extensions = onoffs,
               extensionFlags = flattenExtensionFlags (language dfs) onoffs }
997

998
-- | Unset a 'ExtensionFlag'
999
xopt_unset :: DynFlags -> ExtensionFlag -> DynFlags
1000
1001
1002
1003
xopt_unset dfs f
    = let onoffs = Off f : extensions dfs
      in dfs { extensions = onoffs,
               extensionFlags = flattenExtensionFlags (language dfs) onoffs }
1004

1005
-- | Set the Haskell language standard to use
1006
1007
1008
1009
1010
1011
1012
1013
setLanguage :: Language -> DynP ()
setLanguage l = upd f
    where f dfs = let mLang = Just l
                      oneoffs = extensions dfs
                  in dfs {
                         language = mLang,
                         extensionFlags = flattenExtensionFlags mLang oneoffs
                     }
1014

1015
1016
1017
1018
-- | Some modules have dependencies on others through the DynFlags rather than textual imports
dynFlagDependencies :: DynFlags -> [ModuleName]
dynFlagDependencies = pluginModNames

1019
1020
1021
1022
-- | Is the -fpackage-trust mode on
packageTrustOn :: DynFlags -> Bool
packageTrustOn = dopt Opt_PackageTrust

1023
-- | Is the Safe Haskell safe language in use
1024
safeLanguageOn :: DynFlags -> Bool
dterei's avatar
dterei committed
1025