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

        -- ** SafeHaskell
36
        SafeHaskellMode(..),
37
38
        safeHaskellOn, safeLanguageOn,
        safeDirectImpsReq, safeImplicitImpsReq,
39

40
41
42
43
44
        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,
45
46
        opt_L, opt_P, opt_F, opt_c, opt_m, opt_a, opt_l,
        opt_windres, opt_lo, opt_lc,
47
48


49
        -- ** Manipulating DynFlags
50
        defaultDynFlags,                -- Settings -> DynFlags
Ian Lynagh's avatar
Ian Lynagh committed
51
52
        initDynFlags,                   -- DynFlags -> IO DynFlags

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

60
        -- ** Parsing DynFlags
61
62
        parseDynamicFlagsCmdLine,
        parseDynamicFilePragma,
63
        allFlags,
64

65
        supportedLanguagesAndExtensions,
66
67

        -- ** DynFlag C compiler options
68
        picCCOpts,
69
70
71
72
73
74

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

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

#include "HsVersions.h"

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

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

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

121
122
123
-- -----------------------------------------------------------------------------
-- DynFlags

124
-- | Enumerates the simple on-or-off dynamic flags
125
126
127
128
data DynFlag

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

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

247
248
   | Opt_PrintExplicitForalls

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

270
271
272
273
274
   -- Interface files
   | Opt_IgnoreInterfacePragmas
   | Opt_OmitInterfacePragmas
   | Opt_ExposeAllUnfoldings

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

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

	-- temporary flags
   | Opt_RunCPS
309
310
   | Opt_RunCPSZ
   | Opt_ConvertToZipCfgAndBack
311
   | Opt_AutoLinkPackages
312
   | Opt_ImplicitImportQualified
313
   | Opt_TryNewCodeGen
314
315
316
317
318
319

   -- keeping stuff
   | Opt_KeepHiDiffs
   | Opt_KeepHcFiles
   | Opt_KeepSFiles
   | Opt_KeepTmpFiles
Jedai's avatar
Jedai committed
320
   | Opt_KeepRawTokenStream
321
   | Opt_KeepLlvmFiles
322

323
   deriving (Eq, Show)
Ian Lynagh's avatar
Ian Lynagh committed
324

325
326
data Language = Haskell98 | Haskell2010

327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
-- | The various SafeHaskell modes
data SafeHaskellMode
   = Sf_None
   | Sf_SafeImports
   | Sf_SafeLanguage
   | Sf_Trustworthy
   | Sf_TrustworthyWithSafeLanguage
   | Sf_Safe
   deriving (Eq)

instance Show SafeHaskellMode where
    show Sf_None = "None"
    show Sf_SafeImports = "SafeImports"
    show Sf_SafeLanguage = "SafeLanguage"
    show Sf_Trustworthy = "Trustworthy"
    show Sf_TrustworthyWithSafeLanguage = "Trustworthy + SafeLanguage"
    show Sf_Safe = "Safe"

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

   | Opt_StandaloneDeriving
   | Opt_DeriveDataTypeable
   | Opt_DeriveFunctor
   | Opt_DeriveTraversable
   | Opt_DeriveFoldable
384
   | Opt_DeriveGeneric            -- Allow deriving Generic/1
dreixel's avatar
dreixel committed
385
386
   | Opt_DefaultSignatures        -- Allow extra signatures for defmeths
   | Opt_Generics                 -- Old generic classes, now deprecated
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401

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

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

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

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

452
453
  dphBackend            :: DPHBackend,

454
  thisPackage           :: PackageId,   -- ^ name of package currently being compiled
455
456

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

461
462
463
  -- For object splitting
  splitInfo             :: Maybe (String,Int),

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

Ian Lynagh's avatar
Ian Lynagh committed
470
471
472
  objectSuf             :: String,
  hcSuf                 :: String,
  hiSuf                 :: String,
473

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

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

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

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

491
  rtsOpts               :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
492
  rtsOptsEnabled        :: RtsOptsEnabled,
493

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

496
497
498
499
  -- Plugins
  pluginModNames        :: [ModuleName],
  pluginModNameOpts     :: [(ModuleName,String)],

500
  settings              :: Settings,
501

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

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

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

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

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

528
529
530
531
532
  -- 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),

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

545
  -- | Message output action: use "ErrUtils" instead of this if you can
David Waern's avatar
David Waern committed
546
547
548
  log_action            :: Severity -> SrcSpan -> PprStyle -> Message -> IO (),

  haddockOptions :: Maybe String
549
550
 }

551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
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
574
575
576
577
578
579
580
581
582
583
584
585
586
  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_m                 :: [String],
  sOpt_a                 :: [String],
  sOpt_l                 :: [String],
  sOpt_windres           :: [String],
  sOpt_lo                :: [String], -- LLVM: llvm optimiser
  sOpt_lc                :: [String]  -- LLVM: llc static compiler

587
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
 }

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)
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
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_m                 :: DynFlags -> [String]
opt_m dflags = sOpt_m (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)
649

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

        hpcDir                  = ".hpc",

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

Ian Lynagh's avatar
Ian Lynagh committed
863
        log_action = \severity srcSpan style msg ->
864
                        case severity of
865
866
867
                          SevOutput -> printSDoc msg style
                          SevInfo   -> printErrs msg style
                          SevFatal  -> printErrs msg style
868
                          _         -> do 
869
                                hPutChar stderr '\n'
870
                                printErrs (mkLocMessage srcSpan msg) style
871
872
873
                     -- 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.
874
875
      }

Ian Lynagh's avatar
Ian Lynagh committed
876
{-
877
878
Note [Verbosity levels]
~~~~~~~~~~~~~~~~~~~~~~~
Ian Lynagh's avatar
Ian Lynagh committed
879
    0   |   print errors & warnings only
880
881
882
883
884
885
886
    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"
-}

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

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

901
languageExtensions Nothing
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
902
    -- Nothing => the default case
903
904
905
    = 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
906
      -- In due course I'd like Opt_MonoLocalBinds to be on by default
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
907
      -- But NB it's implied by GADTs etc
Ian Lynagh's avatar
Ian Lynagh committed
908
      -- SLPJ September 2010
909
    : Opt_NondecreasingIndentation -- This has been on by default for some time
910
911
912
913
914
    : 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
915

916
917
918
919
languageExtensions (Just Haskell98)
    = [Opt_ImplicitPrelude,
       Opt_MonomorphismRestriction,
       Opt_NPlusKPatterns,
920
921
922
923
924
925
926
927
       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
928

929
930
931
932
933
934
935
languageExtensions (Just Haskell2010)
    = [Opt_ImplicitPrelude,
       Opt_MonomorphismRestriction,
       Opt_DatatypeContexts,
       Opt_EmptyDataDecls,
       Opt_ForeignFunctionInterface,
       Opt_PatternGuards,
Ian Lynagh's avatar
Ian Lynagh committed
936
       Opt_DoAndIfThenElse,
937
       Opt_RelaxedPolyRec]
938

939
-- | Test whether a 'DynFlag' is set
940
941
dopt :: DynFlag -> DynFlags -> Bool
dopt f dflags  = f `elem` (flags dflags)
942

943
-- | Set a 'DynFlag'
944
945
dopt_set :: DynFlags -> DynFlag -> DynFlags
dopt_set dfs f = dfs{ flags = f : flags dfs }
946

947
-- | Unset a 'DynFlag'
948
949
dopt_unset :: DynFlags -> DynFlag -> DynFlags
dopt_unset dfs f = dfs{ flags = filter (/= f) (flags dfs) }
950

951
-- | Test whether a 'ExtensionFlag' is set
952
xopt :: ExtensionFlag -> DynFlags -> Bool
953
xopt f dflags = f `elem` extensionFlags dflags
954

955
-- | Set a 'ExtensionFlag'
956
xopt_set :: DynFlags -> ExtensionFlag -> DynFlags
957
958
959
960
xopt_set dfs f
    = let onoffs = On f : extensions dfs
      in dfs { extensions = onoffs,
               extensionFlags = flattenExtensionFlags (language dfs) onoffs }
961

962
-- | Unset a 'ExtensionFlag'
963
xopt_unset :: DynFlags -> ExtensionFlag -> DynFlags
964
965
966
967
xopt_unset dfs f
    = let onoffs = Off f : extensions dfs
      in dfs { extensions = onoffs,
               extensionFlags = flattenExtensionFlags (language dfs) onoffs }
968

969
-- | Set the Haskell language standard to use
970
971
972
973
974
975
976
977
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
                     }
978

979
980
981
982
safeLanguageOn :: DynFlags -> Bool
safeLanguageOn dflags = s == Sf_SafeLanguage || s == Sf_Safe
                          where s = safeHaskell dflags

983
984
985
986
-- | Test if SafeHaskell is on in some form
safeHaskellOn :: DynFlags -> Bool
safeHaskellOn dflags = safeHaskell dflags /= Sf_None

987
988
989
990
991
992
993
994
-- | Set a 'SafeHaskell' flag
setSafeHaskell :: SafeHaskellMode -> DynP ()
setSafeHaskell s = upd f
    where f dfs = let sf = safeHaskell dfs
                  in dfs {
                         safeHaskell = combineSafeFlags sf s
                     }

995
996
997
998
999
1000
1001
1002
1003
-- | Are all direct imports required to be safe for this SafeHaskell mode?
-- Direct imports are when the code explicitly imports a module
safeDirectImpsReq :: DynFlags -> Bool
safeDirectImpsReq = safeLanguageOn

-- | Are all implicit imports required to be safe for this SafeHaskell mode?
-- Implicit imports are things in the prelude. e.g System.IO when print is used.
safeImplicitImpsReq :: DynFlags -> Bool
safeImplicitImpsReq _ = False
1004

1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034