DynFlags.hs 107 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
        ExtensionFlag(..),
16
        LogAction,
17
        glasgowExtsFlags,
18
19
20
21
22
23
        dopt,
        dopt_set,
        dopt_unset,
        xopt,
        xopt_set,
        xopt_unset,
Ian Lynagh's avatar
Ian Lynagh committed
24
        DynFlags(..),
Ian Lynagh's avatar
Ian Lynagh committed
25
        RtsOptsEnabled(..),
Ian Lynagh's avatar
Ian Lynagh committed
26
27
28
29
        HscTarget(..), isObjectTarget, defaultObjectTarget,
        GhcMode(..), isOneShot,
        GhcLink(..), isNoLink,
        PackageFlag(..),
Ian Lynagh's avatar
Ian Lynagh committed
30
        Option(..), showOpt,
Ian Lynagh's avatar
Ian Lynagh committed
31
        DynLibLoader(..),
32
        fFlags, fLangFlags, xFlags,
33
        DPHBackend(..), dphPackageMaybe,
34
        wayNames, dynFlagDependencies,
35

36
        -- ** Safe Haskell
37
        SafeHaskellMode(..),
38
39
        safeHaskellOn, safeLanguageOn,
        safeDirectImpsReq, safeImplicitImpsReq,
40

41
        -- ** System tool settings and locations
42
43
44
45
46
        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
47
        opt_L, opt_P, opt_F, opt_c, opt_a, opt_l,
48
        opt_windres, opt_lo, opt_lc,
49
50


51
        -- ** Manipulating DynFlags
52
        defaultDynFlags,                -- Settings -> DynFlags
Ian Lynagh's avatar
Ian Lynagh committed
53
        initDynFlags,                   -- DynFlags -> IO DynFlags
54
        defaultLogAction,
Ian Lynagh's avatar
Ian Lynagh committed
55

56
        getOpts,                        -- DynFlags -> (DynFlags -> [a]) -> [a]
57
        getVerbFlags,
Ian Lynagh's avatar
Ian Lynagh committed
58
59
60
        updOptLevel,
        setTmpDir,
        setPackageName,
61
        doingTickyProfiling,
Ian Lynagh's avatar
Ian Lynagh committed
62

63
        -- ** Parsing DynFlags
64
65
        parseDynamicFlagsCmdLine,
        parseDynamicFilePragma,
66
        allFlags,
67

68
        supportedLanguagesAndExtensions,
69
70

        -- ** DynFlag C compiler options
71
        picCCOpts,
72
73
74
75
76
77

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

        -- * Compiler configuration suitable for display to the user
78
79
80
81
82
83
        compilerInfo
#ifdef GHCI
-- Only in stage 2 can we be sure that the RTS 
-- exposes the appropriate runtime boolean
        , rtsIsProfiled
#endif
84
85
86
87
  ) where

#include "HsVersions.h"

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

Ian Lynagh's avatar
Ian Lynagh committed
109
#ifdef GHCI
110
import System.IO.Unsafe	( unsafePerformIO )
Ian Lynagh's avatar
Ian Lynagh committed
111
#endif
112
import Data.IORef
Ian Lynagh's avatar
Ian Lynagh committed
113
import Control.Monad    ( when )
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
114

115
import Data.Char
116
import Data.List
117
118
import Data.Map (Map)
import qualified Data.Map as Map
119
120
import Data.Set (Set)
import qualified Data.Set as Set
Ian Lynagh's avatar
Ian Lynagh committed
121
import System.FilePath
122
import System.IO        ( stderr, hPutChar )
123

124
125
126
-- -----------------------------------------------------------------------------
-- DynFlags

127
-- | Enumerates the simple on-or-off dynamic flags
128
129
130
131
data DynFlag

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

Ian Lynagh's avatar
Ian Lynagh committed
216
   | Opt_WarnIsError                    -- -Werror; makes warnings fatal
217
218
   | Opt_WarnDuplicateExports
   | Opt_WarnHiShadows
219
   | Opt_WarnImplicitPrelude
220
   | Opt_WarnIncompletePatterns
221
   | Opt_WarnIncompleteUniPatterns
222
223
   | Opt_WarnIncompletePatternsRecUpd
   | Opt_WarnMissingFields
224
   | Opt_WarnMissingImportList
225
226
   | Opt_WarnMissingMethods
   | Opt_WarnMissingSigs
227
   | Opt_WarnMissingLocalSigs
228
229
230
   | Opt_WarnNameShadowing
   | Opt_WarnOverlappingPatterns
   | Opt_WarnTypeDefaults
231
   | Opt_WarnMonomorphism
232
233
234
   | Opt_WarnUnusedBinds
   | Opt_WarnUnusedImports
   | Opt_WarnUnusedMatches
Ian Lynagh's avatar
Ian Lynagh committed
235
   | Opt_WarnWarningsDeprecations
236
   | Opt_WarnDeprecatedFlags
237
   | Opt_WarnDodgyExports
238
239
   | Opt_WarnDodgyImports
   | Opt_WarnOrphans
240
   | Opt_WarnAutoOrphans
241
   | Opt_WarnIdentities
242
   | Opt_WarnTabs
243
   | Opt_WarnUnrecognisedPragmas
244
   | Opt_WarnDodgyForeignImports
245
   | Opt_WarnLazyUnliftedBindings
246
247
   | Opt_WarnUnusedDoBind
   | Opt_WarnWrongDoBind
248
   | Opt_WarnAlternativeLayoutRuleTransitional
249

250
251
   | Opt_PrintExplicitForalls

252
253
254
   -- optimisation opts
   | Opt_Strictness
   | Opt_FullLaziness
255
256
   | Opt_FloatIn
   | Opt_Specialise
257
   | Opt_StaticArgumentTransformation
258
   | Opt_CSE
259
260
   | Opt_LiberateCase
   | Opt_SpecConstr
261
262
263
264
265
   | Opt_DoLambdaEtaExpansion
   | Opt_IgnoreAsserts
   | Opt_DoEtaReduction
   | Opt_CaseMerge
   | Opt_UnboxStrictFields
266
   | Opt_DictsCheap
267
   | Opt_EnableRewriteRules		-- Apply rewrite rules during simplification
rl@cse.unsw.edu.au's avatar
rl@cse.unsw.edu.au committed
268
   | Opt_Vectorise
Ian Lynagh's avatar
Ian Lynagh committed
269
270
   | Opt_RegsGraph                      -- do graph coloring register allocation
   | Opt_RegsIterative                  -- do iterative coalescing graph coloring register allocation
271

272
273
274
275
276
   -- Interface files
   | Opt_IgnoreInterfacePragmas
   | Opt_OmitInterfacePragmas
   | Opt_ExposeAllUnfoldings

Ian Lynagh's avatar
Ian Lynagh committed
277
278
279
280
281
   -- profiling opts
   | Opt_AutoSccsOnAllToplevs
   | Opt_AutoSccsOnExportedToplevs
   | Opt_AutoSccsOnIndividualCafs

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

	-- temporary flags
   | Opt_RunCPS
312
313
   | Opt_RunCPSZ
   | Opt_ConvertToZipCfgAndBack
314
   | Opt_AutoLinkPackages
315
   | Opt_ImplicitImportQualified
316
   | Opt_TryNewCodeGen
317
318
319
320
321
322

   -- keeping stuff
   | Opt_KeepHiDiffs
   | Opt_KeepHcFiles
   | Opt_KeepSFiles
   | Opt_KeepTmpFiles
Jedai's avatar
Jedai committed
323
   | Opt_KeepRawTokenStream
324
   | Opt_KeepLlvmFiles
325

326
   deriving (Eq, Show)
Ian Lynagh's avatar
Ian Lynagh committed
327

328
329
data Language = Haskell98 | Haskell2010

330
-- | The various Safe Haskell modes
331
332
333
334
335
336
337
338
339
data SafeHaskellMode
   = Sf_None
   | Sf_SafeImports
   | Sf_SafeLanguage
   | Sf_Trustworthy
   | Sf_TrustworthyWithSafeLanguage
   | Sf_Safe
   deriving (Eq)

340
341
342
343
344
345
346
instance Outputable SafeHaskellMode where
    ppr Sf_None = ptext $ sLit "None"
    ppr Sf_SafeImports = ptext $ sLit "SafeImports"
    ppr Sf_SafeLanguage = ptext $ sLit "SafeLanguage"
    ppr Sf_Trustworthy = ptext $ sLit "Trustworthy"
    ppr Sf_TrustworthyWithSafeLanguage = ptext $ sLit "Trustworthy + SafeLanguage"
    ppr Sf_Safe = ptext $ sLit "Safe"
347

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

   | Opt_StandaloneDeriving
   | Opt_DeriveDataTypeable
   | Opt_DeriveFunctor
   | Opt_DeriveTraversable
   | Opt_DeriveFoldable
387
   | Opt_DeriveGeneric            -- Allow deriving Generic/1
dreixel's avatar
dreixel committed
388
   | Opt_DefaultSignatures        -- Allow extra signatures for defmeths
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403

   | 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
404
   | Opt_MonadComprehensions
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
   | 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
421
   | Opt_NondecreasingIndentation
422
   | Opt_RelaxedLayout
423
424
   deriving (Eq, Show)

425
426
-- | 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
427
data DynFlags = DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
428
429
430
  ghcMode               :: GhcMode,
  ghcLink               :: GhcLink,
  hscTarget             :: HscTarget,
431
  hscOutName            :: String,      -- ^ Name of the output file
432
  extCoreName           :: String,      -- ^ Name of the .hcr output file
433
  verbosity             :: Int,         -- ^ Verbosity level: see Note [Verbosity levels]
434
435
436
  optLevel              :: Int,         -- ^ Optimisation level
  simplPhases           :: Int,         -- ^ Number of simplifier phases
  maxSimplIterations    :: Int,         -- ^ Max simplifier iterations
437
  shouldDumpSimplPhase  :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
438
  ruleCheck             :: Maybe String,
439
  strictnessBefore      :: [Int],       -- ^ Additional demand analysis
440

441
442
443
  specConstrThreshold   :: Maybe Int,   -- ^ Threshold for SpecConstr
  specConstrCount       :: Maybe Int,   -- ^ Max number of specialisations for any one function
  liberateCaseThreshold :: Maybe Int,   -- ^ Threshold for LiberateCase
444
445
  floatLamArgs          :: Maybe Int,   -- ^ Arg count for lambda floating
  			   	 	--   See CoreMonad.FloatOutSwitches
446

Ian Lynagh's avatar
Ian Lynagh committed
447
  targetPlatform        :: Platform.Platform, -- ^ The platform we're compiling for. Used by the NCG.
448
  cmdlineHcIncludes     :: [String],    -- ^ @\-\#includes@
Ian Lynagh's avatar
Ian Lynagh committed
449
450
451
  importPaths           :: [FilePath],
  mainModIs             :: Module,
  mainFunIs             :: Maybe String,
452
  ctxtStkDepth          :: Int,         -- ^ Typechecker context stack depth
453

454
455
  dphBackend            :: DPHBackend,

456
  thisPackage           :: PackageId,   -- ^ name of package currently being compiled
457
458

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

463
464
465
  -- For object splitting
  splitInfo             :: Maybe (String,Int),

466
  -- paths etc.
Ian Lynagh's avatar
Ian Lynagh committed
467
  objectDir             :: Maybe String,
468
  dylibInstallName      :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
469
470
  hiDir                 :: Maybe String,
  stubDir               :: Maybe String,
471

Ian Lynagh's avatar
Ian Lynagh committed
472
473
474
  objectSuf             :: String,
  hcSuf                 :: String,
  hiSuf                 :: String,
475

Ian Lynagh's avatar
Ian Lynagh committed
476
477
478
  outputFile            :: Maybe String,
  outputHi              :: Maybe String,
  dynLibLoader          :: DynLibLoader,
479

480
  -- | This is set by 'DriverPipeline.runPipeline' based on where
Ian Lynagh's avatar
Ian Lynagh committed
481
482
  --    its output is going.
  dumpPrefix            :: Maybe FilePath,
483

484
485
  -- | Override the 'dumpPrefix' set by 'DriverPipeline.runPipeline'.
  --    Set by @-ddump-file-prefix@
Ian Lynagh's avatar
Ian Lynagh committed
486
487
488
489
490
491
492
  dumpPrefixForce       :: Maybe FilePath,

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

493
  rtsOpts               :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
494
  rtsOptsEnabled        :: RtsOptsEnabled,
495

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

498
499
500
501
  -- Plugins
  pluginModNames        :: [ModuleName],
  pluginModNameOpts     :: [(ModuleName,String)],

502
  settings              :: Settings,
503

504
505
506
507
508
509
  --  For ghc -M
  depMakefile           :: FilePath,
  depIncludePkgDeps     :: Bool,
  depExcludeMods        :: [ModuleName],
  depSuffixes           :: [String],

510
  --  Package flags
Ian Lynagh's avatar
Ian Lynagh committed
511
  extraPkgConfs         :: [FilePath],
512
        -- ^ The @-package-conf@ flags given on the command line, in the order
Ian Lynagh's avatar
Ian Lynagh committed
513
        -- they appeared.
514

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

518
  -- Package state
Ian Lynagh's avatar
Ian Lynagh committed
519
  -- NB. do not modify this field, it is calculated by
520
  -- Packages.initPackages and Packages.updatePackages.
521
  pkgDatabase           :: Maybe [PackageConfig],
Ian Lynagh's avatar
Ian Lynagh committed
522
  pkgState              :: PackageState,
523

524
525
526
527
  -- Temporary files
  -- These have to be IORefs, because the defaultCleanupHandler needs to
  -- know what to clean when an exception happens
  filesToClean          :: IORef [FilePath],
528
  dirsToClean           :: IORef (Map FilePath FilePath),
529

530
531
532
533
534
  -- 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),

535
  -- hsc dynamic flags
Ian Lynagh's avatar
Ian Lynagh committed
536
  flags                 :: [DynFlag],
537
  -- Don't change this without updating extensionFlags:
538
  language              :: Maybe Language,
539
540
  -- | Safe Haskell mode
  safeHaskell           :: SafeHaskellMode,
541
542
543
544
545
  -- 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
546

547
  -- | Message output action: use "ErrUtils" instead of this if you can
548
  log_action            :: LogAction,
David Waern's avatar
David Waern committed
549
550

  haddockOptions :: Maybe String
551
552
 }

553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
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
576
577
578
579
580
581
582
583
584
585
586
587
  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

588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
 }

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)
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
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)
648

649
650
651
wayNames :: DynFlags -> [WayName]
wayNames = map wayName . ways

652
653
-- | The target code type of the compilation (if any).
--
654
655
656
-- Whenever you change the target, also make sure to set 'ghcLink' to
-- something sensible.
--
657
658
659
660
-- 'HscNothing' can be used to avoid generating any output, however, note
-- that:
--
--  * This will not run the desugaring step, thus no warnings generated in
661
662
663
--    this step will be output.  In particular, this includes warnings related
--    to pattern matching.  You can run the desugarer manually using
--    'GHC.desugarModule'.
664
--
665
666
667
668
669
670
--  * 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.)
671
--
672
data HscTarget
673
674
  = HscC           -- ^ Generate C code.
  | HscAsm         -- ^ Generate assembly using the native code generator.
675
  | HscLlvm        -- ^ Generate assembly using the llvm code generator.
676
677
  | HscInterpreted -- ^ Generate bytecode.  (Requires 'LinkInMemory')
  | HscNothing     -- ^ Don't generate any code.  See notes above.
678
679
  deriving (Eq, Show)

Ian Lynagh's avatar
Ian Lynagh committed
680
681
682
683
684
685
686
showHscTargetFlag :: HscTarget -> String
showHscTargetFlag HscC           = "-fvia-c"
showHscTargetFlag HscAsm         = "-fasm"
showHscTargetFlag HscLlvm        = "-fllvm"
showHscTargetFlag HscInterpreted = "-fbyte-code"
showHscTargetFlag HscNothing     = "-fno-code"

687
-- | Will this target result in an object file on the disk?
688
689
690
isObjectTarget :: HscTarget -> Bool
isObjectTarget HscC     = True
isObjectTarget HscAsm   = True
691
isObjectTarget HscLlvm  = True
692
693
694
695
696
697
698
699
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.
700
data GhcMode
701
702
703
  = CompManager         -- ^ @\-\-make@, GHCi, etc.
  | OneShot             -- ^ @ghc -c Foo.hs@
  | MkDepend            -- ^ @ghc -M@, see "Finder" for why we need this
704
705
  deriving Eq

706
707
708
709
710
instance Outputable GhcMode where
  ppr CompManager = ptext (sLit "CompManager")
  ppr OneShot     = ptext (sLit "OneShot")
  ppr MkDepend    = ptext (sLit "MkDepend")

711
712
713
714
isOneShot :: GhcMode -> Bool
isOneShot OneShot = True
isOneShot _other  = False

715
716
717
718
-- | 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
719
720
  | LinkInMemory        -- ^ Use the in-memory dynamic linker (works for both
                        --   bytecode and object code).
721
  | LinkDynLib          -- ^ Link objects into a dynamic lib (DLL on Windows, DSO on ELF platforms)
722
  deriving (Eq, Show)
723
724
725

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

728
729
730
-- Is it worth evaluating this Bool and caching it in the DynFlags value
-- during initDynFlags?
doingTickyProfiling :: DynFlags -> Bool
731
732
733
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.
734

735
data PackageFlag
736
  = ExposePackage   String
737
  | ExposePackageId String
738
739
740
741
  | HidePackage     String
  | IgnorePackage   String
  | TrustPackage    String
  | DistrustPackage String
742
  deriving Eq
743

twanvl's avatar
twanvl committed
744
defaultHscTarget :: HscTarget
745
746
defaultHscTarget = defaultObjectTarget

747
-- | The 'HscTarget' value corresponding to the default way to create
748
-- object files on the current platform.
twanvl's avatar
twanvl committed
749
defaultObjectTarget :: HscTarget
750
defaultObjectTarget
751
  | cGhcUnregisterised    == "YES"      =  HscC
Ian Lynagh's avatar
Ian Lynagh committed
752
  | cGhcWithNativeCodeGen == "YES"      =  HscAsm
753
  | otherwise                           =  HscLlvm
754

755
756
757
758
759
data DynLibLoader
  = Deployable
  | SystemDependent
  deriving Eq

Ian Lynagh's avatar
Ian Lynagh committed
760
data RtsOptsEnabled = RtsOptsNone | RtsOptsSafeOnly | RtsOptsAll
761
  deriving (Show)
Ian Lynagh's avatar
Ian Lynagh committed
762

763
-- | Used by 'GHC.newSession' to partially initialize a new 'DynFlags' value
twanvl's avatar
twanvl committed
764
initDynFlags :: DynFlags -> IO DynFlags
765
766
767
initDynFlags dflags = do
 -- someday these will be dynamic flags
 ways <- readIORef v_Ways
768
 refFilesToClean <- newIORef []
769
 refDirsToClean <- newIORef Map.empty
770
 refGeneratedDumps <- newIORef Set.empty
771
 return dflags{
772
773
774
        ways            = ways,
        buildTag        = mkBuildTag (filter (not . wayRTSOnly) ways),
        rtsBuildTag     = mkBuildTag ways,
775
        filesToClean    = refFilesToClean,
776
777
        dirsToClean     = refDirsToClean,
        generatedDumps   = refGeneratedDumps
Ian Lynagh's avatar
Ian Lynagh committed
778
        }
779

780
781
-- | The normal 'DynFlags'. Note that they is not suitable for use in this form
-- and must be fully initialized by 'GHC.newSession' first.
782
783
defaultDynFlags :: Settings -> DynFlags
defaultDynFlags mySettings =
784
     DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
785
786
787
788
789
790
791
        ghcMode                 = CompManager,
        ghcLink                 = LinkBinary,
        hscTarget               = defaultHscTarget,
        hscOutName              = "",
        extCoreName             = "",
        verbosity               = 0,
        optLevel                = 0,
792
        simplPhases             = 2,
Ian Lynagh's avatar
Ian Lynagh committed
793
        maxSimplIterations      = 4,
794
        shouldDumpSimplPhase    = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
795
        ruleCheck               = Nothing,
796
        specConstrThreshold     = Just 2000,
Ian Lynagh's avatar
Ian Lynagh committed
797
        specConstrCount         = Just 3,
798
        liberateCaseThreshold   = Just 2000,
799
        floatLamArgs            = Just 0,	-- Default: float only if no fvs
800
801
        strictnessBefore        = [],

802
        targetPlatform          = defaultTargetPlatform,
Ian Lynagh's avatar
Ian Lynagh committed
803
804
805
806
807
808
        cmdlineHcIncludes       = [],
        importPaths             = ["."],
        mainModIs               = mAIN,
        mainFunIs               = Nothing,
        ctxtStkDepth            = mAX_CONTEXT_REDUCTION_DEPTH,

chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
809
        dphBackend              = DPHNone,
810

Ian Lynagh's avatar
Ian Lynagh committed
811
812
813
        thisPackage             = mainPackageId,

        objectDir               = Nothing,
814
        dylibInstallName        = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
815
816
817
818
819
820
821
        hiDir                   = Nothing,
        stubDir                 = Nothing,

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

822
823
824
        pluginModNames          = [],
        pluginModNameOpts       = [],

Ian Lynagh's avatar
Ian Lynagh committed
825
826
        outputFile              = Nothing,
        outputHi                = Nothing,
827
        dynLibLoader            = SystemDependent,
Ian Lynagh's avatar
Ian Lynagh committed
828
829
830
831
832
833
        dumpPrefix              = Nothing,
        dumpPrefixForce         = Nothing,
        includePaths            = [],
        libraryPaths            = [],
        frameworkPaths          = [],
        cmdlineFrameworks       = [],
834
        rtsOpts                 = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
835
        rtsOptsEnabled          = RtsOptsSafeOnly,
Ian Lynagh's avatar
Ian Lynagh committed
836
837
838
839
840

        hpcDir                  = ".hpc",

        extraPkgConfs           = [],
        packageFlags            = [],
841
842
        pkgDatabase             = Nothing,
        pkgState                = panic "no package state yet: call GHC.setSessionDynFlags",
843
        ways                    = panic "defaultDynFlags: No ways",
Ian Lynagh's avatar
Ian Lynagh committed
844
845
        buildTag                = panic "defaultDynFlags: No buildTag",
        rtsBuildTag             = panic "defaultDynFlags: No rtsBuildTag",
846
        splitInfo               = Nothing,
847
        settings                = mySettings,
848
849
850
851
852
853
        -- ghc -M values
        depMakefile       = "Makefile",
        depIncludePkgDeps = False,
        depExcludeMods    = [],
        depSuffixes       = [],
        -- end of ghc -M values
854
855
        filesToClean   = panic "defaultDynFlags: No filesToClean",
        dirsToClean    = panic "defaultDynFlags: No dirsToClean",
856
        generatedDumps = panic "defaultDynFlags: No generatedDumps",
Ian Lynagh's avatar
Ian Lynagh committed
857
        haddockOptions = Nothing,
858
        flags = defaultFlags,
859
        language = Nothing,
860
        safeHaskell = Sf_None,
861
862
        extensions = [],
        extensionFlags = flattenExtensionFlags Nothing [],
863
        log_action = defaultLogAction
864
865
      }

866
867
868
869
870
871
872
873
874
875
876
877
878
879
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
880
{-
881
882
Note [Verbosity levels]
~~~~~~~~~~~~~~~~~~~~~~~
Ian Lynagh's avatar
Ian Lynagh committed
883
    0   |   print errors & warnings only
884
885
886
887
888
889
890
    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"
-}

891
892
893
894
895
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
896
897
898
flattenExtensionFlags :: Maybe Language -> [OnOff ExtensionFlag]
                      -> [ExtensionFlag]
flattenExtensionFlags ml = foldr f defaultExtensionFlags
899
900
    where f (On f)  flags = f : delete f flags
          f (Off f) flags =     delete f flags
901
902
903
          defaultExtensionFlags = languageExtensions ml

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

905
languageExtensions Nothing
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
906
    -- Nothing => the default case
907
908
909
    = Opt_MonoPatBinds   -- Experimentally, I'm making this non-standard
                         -- behaviour the default, to see if anyone notices
                         -- SLPJ July 06
Ian Lynagh's avatar
Ian Lynagh committed
910
      -- In due course I'd like Opt_MonoLocalBinds to be on by default
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
911
      -- But NB it's implied by GADTs etc
Ian Lynagh's avatar
Ian Lynagh committed
912
      -- SLPJ September 2010
913
    : Opt_NondecreasingIndentation -- This has been on by default for some time
914
915
916
917
918
    : 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
919

920
921
922
923
languageExtensions (Just Haskell98)
    = [Opt_ImplicitPrelude,
       Opt_MonomorphismRestriction,
       Opt_NPlusKPatterns,
924
925
926
927
928
929
930
931
       Opt_DatatypeContexts,
       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
932

933
934
935
936
937
938
939
languageExtensions (Just Haskell2010)
    = [Opt_ImplicitPrelude,
       Opt_MonomorphismRestriction,
       Opt_DatatypeContexts,
       Opt_EmptyDataDecls,
       Opt_ForeignFunctionInterface,
       Opt_PatternGuards,
Ian Lynagh's avatar
Ian Lynagh committed
940
       Opt_DoAndIfThenElse,
941
       Opt_RelaxedPolyRec]
942

943
-- | Test whether a 'DynFlag' is set
944
945
dopt :: DynFlag -> DynFlags -> Bool
dopt f dflags  = f `elem` (flags dflags)
946

947
-- | Set a 'DynFlag'
948
949
dopt_set :: DynFlags -> DynFlag -> DynFlags
dopt_set dfs f = dfs{ flags = f : flags dfs }
950

951
-- | Unset a 'DynFlag'
952
953
dopt_unset :: DynFlags -> DynFlag -> DynFlags
dopt_unset dfs f = dfs{ flags = filter (/= f) (flags dfs) }
954

955
-- | Test whether a 'ExtensionFlag' is set
956
xopt :: ExtensionFlag -> DynFlags -> Bool
957
xopt f dflags = f `elem` extensionFlags dflags
958

959
-- | Set a 'ExtensionFlag'
960
xopt_set :: DynFlags -> ExtensionFlag -> DynFlags
961
962
963
964
xopt_set dfs f
    = let onoffs = On f : extensions dfs
      in dfs { extensions = onoffs,
               extensionFlags = flattenExtensionFlags (language dfs) onoffs }
965

966
-- | Unset a 'ExtensionFlag'
967
xopt_unset :: DynFlags -> ExtensionFlag -> DynFlags
968
969
970
971
xopt_unset dfs f
    = let onoffs = Off f : extensions dfs
      in dfs { extensions = onoffs,
               extensionFlags = flattenExtensionFlags (language dfs) onoffs }
972

973
-- | Set the Haskell language standard to use
974
975
976
977
978
979
980
981
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
                     }
982

983
984
985
986
-- | Some modules have dependencies on others through the DynFlags rather than textual imports
dynFlagDependencies :: DynFlags -> [ModuleName]
dynFlagDependencies = pluginModNames

987
-- | Is the Safe Haskell safe language in use
988
safeLanguageOn :: DynFlags -> Bool
989
990
991
safeLanguageOn dflags = s == Sf_SafeLanguage
                     || s == Sf_TrustworthyWithSafeLanguage
                     || s == Sf_Safe
992
993
                          where s = safeHaskell dflags

994
-- | Test if Safe Haskell is on in some form