DynFlags.hs 108 KB
Newer Older
dterei's avatar
dterei committed
1
-------------------------------------------------------------------------------
2
--
dterei's avatar
dterei committed
3
4
5
6
7
8
-- | Dynamic flags
--
-- Most flags are dynamic flags, which means they can change from compilation
-- to compilation using @OPTIONS_GHC@ pragmas, and in a multi-session GHC each
-- session can be using different dynamic flags. Dynamic flags can also be set
-- at the prompt in GHCi.
9
10
11
--
-- (c) The University of Glasgow 2005
--
dterei's avatar
dterei committed
12
-------------------------------------------------------------------------------
13
14

module DynFlags (
15
        -- * Dynamic flags and associated configuration types
Ian Lynagh's avatar
Ian Lynagh committed
16
        DynFlag(..),
17
        WarningFlag(..),
18
        ExtensionFlag(..),
19
        LogAction,
20
        ProfAuto(..),
21
        glasgowExtsFlags,
22
23
24
        dopt,
        dopt_set,
        dopt_unset,
25
26
27
        wopt,
        wopt_set,
        wopt_unset,
28
29
30
        xopt,
        xopt_set,
        xopt_unset,
Ian Lynagh's avatar
Ian Lynagh committed
31
        DynFlags(..),
32
        HasDynFlags(..),
Ian Lynagh's avatar
Ian Lynagh committed
33
        RtsOptsEnabled(..),
Ian Lynagh's avatar
Ian Lynagh committed
34
35
36
37
        HscTarget(..), isObjectTarget, defaultObjectTarget,
        GhcMode(..), isOneShot,
        GhcLink(..), isNoLink,
        PackageFlag(..),
Ian Lynagh's avatar
Ian Lynagh committed
38
        Option(..), showOpt,
Ian Lynagh's avatar
Ian Lynagh committed
39
        DynLibLoader(..),
40
        fFlags, fWarningFlags, fLangFlags, xFlags,
41
        wayNames, dynFlagDependencies,
42

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

49
        -- ** System tool settings and locations
50
        Settings(..),
51
        targetPlatform,
52
53
54
55
        ghcUsagePath, ghciUsagePath, topDir, tmpDir, rawSettings,
        extraGccViaCFlags, systemPackageConfig,
        pgm_L, pgm_P, pgm_F, pgm_c, pgm_s, pgm_a, pgm_l, pgm_dll, pgm_T,
        pgm_sysman, pgm_windres, pgm_lo, pgm_lc,
Ian Lynagh's avatar
Ian Lynagh committed
56
        opt_L, opt_P, opt_F, opt_c, opt_a, opt_l,
57
        opt_windres, opt_lo, opt_lc,
58
59


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

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

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

77
        supportedLanguagesAndExtensions,
78
79

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

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

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

#include "HsVersions.h"

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

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

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

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

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

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

   -- debugging flags
   = Opt_D_dump_cmm
144
   | Opt_D_dump_raw_cmm
145
   | Opt_D_dump_cmmz
146
   | Opt_D_dump_cmmz_pretty
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
   -- All of the cmmz subflags (there are a lot!)  Automatically
   -- enabled if you run -ddump-cmmz
   | Opt_D_dump_cmmz_cbe
   | Opt_D_dump_cmmz_proc
   | Opt_D_dump_cmmz_spills
   | Opt_D_dump_cmmz_rewrite
   | Opt_D_dump_cmmz_dead
   | Opt_D_dump_cmmz_stub
   | Opt_D_dump_cmmz_sp
   | Opt_D_dump_cmmz_procmap
   | Opt_D_dump_cmmz_split
   | Opt_D_dump_cmmz_lower
   | Opt_D_dump_cmmz_info
   | Opt_D_dump_cmmz_cafs
   -- end cmmz subflags
162
   | Opt_D_dump_cps_cmm
163
   | Opt_D_dump_cvt_cmm
164
   | Opt_D_dump_asm
165
166
   | Opt_D_dump_asm_native
   | Opt_D_dump_asm_liveness
167
   | Opt_D_dump_asm_coalesce
168
169
170
   | Opt_D_dump_asm_regalloc
   | Opt_D_dump_asm_regalloc_stages
   | Opt_D_dump_asm_conflicts
171
   | Opt_D_dump_asm_stats
172
   | Opt_D_dump_asm_expanded
173
   | Opt_D_dump_llvm
174
   | Opt_D_dump_core_stats
175
176
177
178
179
180
   | Opt_D_dump_cpranal
   | Opt_D_dump_deriv
   | Opt_D_dump_ds
   | Opt_D_dump_flatC
   | Opt_D_dump_foreign
   | Opt_D_dump_inlinings
181
   | Opt_D_dump_rule_firings
182
   | Opt_D_dump_rule_rewrites
183
184
185
   | Opt_D_dump_occur_anal
   | Opt_D_dump_parsed
   | Opt_D_dump_rn
186
   | Opt_D_dump_core_pipeline -- TODO FIXME: dump after simplifier stats
187
188
   | Opt_D_dump_simpl
   | Opt_D_dump_simpl_iterations
189
   | Opt_D_dump_simpl_phases
190
191
192
193
194
195
196
197
198
199
200
201
202
   | Opt_D_dump_spec
   | Opt_D_dump_prep
   | Opt_D_dump_stg
   | Opt_D_dump_stranal
   | Opt_D_dump_tc
   | Opt_D_dump_types
   | Opt_D_dump_rules
   | Opt_D_dump_cse
   | Opt_D_dump_worker_wrapper
   | Opt_D_dump_rn_trace
   | Opt_D_dump_rn_stats
   | Opt_D_dump_opt_cmm
   | Opt_D_dump_simpl_stats
203
   | Opt_D_dump_cs_trace -- Constraint solver in type checker
204
205
   | Opt_D_dump_tc_trace
   | Opt_D_dump_if_trace
206
   | Opt_D_dump_vt_trace
207
208
209
   | Opt_D_dump_splices
   | Opt_D_dump_BCOs
   | Opt_D_dump_vect
210
   | Opt_D_dump_ticked
pepe's avatar
pepe committed
211
   | Opt_D_dump_rtti
212
213
214
215
216
217
   | Opt_D_source_stats
   | Opt_D_verbose_core2core
   | Opt_D_verbose_stg2stg
   | Opt_D_dump_hi
   | Opt_D_dump_hi_diffs
   | Opt_D_dump_minimal_imports
218
   | Opt_D_dump_mod_cycles
219
   | Opt_D_dump_view_pattern_commoning
220
   | Opt_D_faststring_stats
Ian Lynagh's avatar
Ian Lynagh committed
221
   | Opt_DumpToFile                     -- ^ Append dump output to files instead of stdout.
Simon Marlow's avatar
Simon Marlow committed
222
   | Opt_D_no_debug_output
223
224
225
   | Opt_DoCoreLinting
   | Opt_DoStgLinting
   | Opt_DoCmmLinting
Ben.Lippmeier@anu.edu.au's avatar
Ben.Lippmeier@anu.edu.au committed
226
   | Opt_DoAsmLinting
227
   | Opt_NoLlvmMangler
228

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

231
232
   | Opt_PrintExplicitForalls

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

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

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

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

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

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

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

314
   deriving (Eq, Show, Enum)
Ian Lynagh's avatar
Ian Lynagh committed
315

316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
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
349
350
   | Opt_WarnUnsafe
   | Opt_WarnSafe
351
   deriving (Eq, Show, Enum)
352

353
data Language = Haskell98 | Haskell2010
354
   deriving Enum
355

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

563
  -- hsc dynamic flags
564
565
  flags                 :: IntSet,
  warningFlags          :: IntSet,
566
  -- Don't change this without updating extensionFlags:
567
  language              :: Maybe Language,
568
569
  -- | Safe Haskell mode
  safeHaskell           :: SafeHaskellMode,
570
571
572
  -- We store the location of where some extension and flags were turned on so
  -- we can produce accurate error messages when Safe Haskell fails due to
  -- them.
573
574
  thOnLoc               :: SrcSpan,
  newDerivOnLoc         :: SrcSpan,
575
  pkgTrustOnLoc         :: SrcSpan,
576
577
  warnSafeOnLoc         :: SrcSpan,
  warnUnsafeOnLoc       :: SrcSpan,
578
579
580
581
  -- Don't change this without updating extensionFlags:
  extensions            :: [OnOff ExtensionFlag],
  -- extensionFlags should always be equal to
  --     flattenExtensionFlags language extensions
582
  extensionFlags        :: IntSet,
Ian Lynagh's avatar
Ian Lynagh committed
583

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

587
588
589
590
  haddockOptions        :: Maybe String,

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

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

596
597
598
599
600
data ProfAuto
  = NoProfAuto         -- ^ no SCC annotations added
  | ProfAutoAll        -- ^ top-level and nested functions are annotated
  | ProfAutoTop        -- ^ top-level functions annotated only
  | ProfAutoExports    -- ^ exported functions annotated only
601
  | ProfAutoCalls      -- ^ annotate call-sites
Simon Marlow's avatar
Simon Marlow committed
602
  deriving (Enum)
603

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

640
641
 }

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

645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
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)
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
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)
703

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

        thisPackage             = mainPackageId,

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

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

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

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

        hpcDir                  = ".hpc",

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

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

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

952
953
954
955
956
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
957
flattenExtensionFlags :: Maybe Language -> [OnOff ExtensionFlag] -> IntSet
958
flattenExtensionFlags ml = foldr f defaultExtensionFlags
959
960
961
    where f (On f)  flags = IntSet.insert (fromEnum f) flags
          f (Off f) flags = IntSet.delete (fromEnum f) flags
          defaultExtensionFlags = IntSet.fromList (map fromEnum (languageExtensions ml))
962
963

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

965
languageExtensions Nothing
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
966
    -- Nothing => the default case
967
    = Opt_NondecreasingIndentation -- This has been on by default for some time
968
969
970
971
972
    : delete Opt_DatatypeContexts  -- The Haskell' committee decided to