DynFlags.hs 213 KB
Newer Older
1
{-# LANGUAGE CPP #-}
2
{-# LANGUAGE FlexibleInstances #-}
3

dterei's avatar
dterei committed
4
-------------------------------------------------------------------------------
5
--
dterei's avatar
dterei committed
6
7
8
9
10
11
-- | 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.
12
13
14
--
-- (c) The University of Glasgow 2005
--
dterei's avatar
dterei committed
15
-------------------------------------------------------------------------------
16

17
{-# OPTIONS_GHC -fno-cse #-}
18
19
-- -fno-cse is needed for GLOBAL_VAR's to behave properly

20
module DynFlags (
21
        -- * Dynamic flags and associated configuration types
22
        DumpFlag(..),
23
        GeneralFlag(..),
24
        WarningFlag(..), WarnReason(..),
25
        Language(..),
26
        PlatformConstants(..),
Ian Lynagh's avatar
Ian Lynagh committed
27
        FatalMessager, LogAction, FlushOut(..), FlushErr(..),
28
        ProfAuto(..),
29
        glasgowExtsFlags,
30
        warningGroups, warningHierarchies,
31
        dopt, dopt_set, dopt_unset,
triple's avatar
triple committed
32
        gopt, gopt_set, gopt_unset, setGeneralFlag', unSetGeneralFlag',
33
        wopt, wopt_set, wopt_unset,
34
        wopt_fatal,
35
        xopt, xopt_set, xopt_unset,
36
        lang_set,
37
        useUnicodeSyntax,
38
39
        whenGeneratingDynamicToo, ifGeneratingDynamicToo,
        whenCannotGenerateDynamicToo,
40
        dynamicTooMkDynamicDynFlags,
Ian Lynagh's avatar
Ian Lynagh committed
41
        DynFlags(..),
42
        FlagSpec(..),
Ian Lynagh's avatar
Ian Lynagh committed
43
        HasDynFlags(..), ContainsDynFlags(..),
44
        OverridingBool(..), overrideWith,
Ian Lynagh's avatar
Ian Lynagh committed
45
        RtsOptsEnabled(..),
Ian Lynagh's avatar
Ian Lynagh committed
46
        HscTarget(..), isObjectTarget, defaultObjectTarget,
47
        targetRetainsAllBindings,
Ian Lynagh's avatar
Ian Lynagh committed
48
49
        GhcMode(..), isOneShot,
        GhcLink(..), isNoLink,
50
        PackageFlag(..), PackageArg(..), ModRenaming(..),
51
        IgnorePackageFlag(..), TrustFlag(..),
52
        PkgConfRef(..),
Ian Lynagh's avatar
Ian Lynagh committed
53
        Option(..), showOpt,
Ian Lynagh's avatar
Ian Lynagh committed
54
        DynLibLoader(..),
55
56
        fFlags, fLangFlags, xFlags,
        wWarningFlags,
57
        dynFlagDependencies,
58
        tablesNextToCode, mkTablesNextToCode,
Ben Gamari's avatar
Ben Gamari committed
59
        makeDynFlagsConsistent,
60

61
        Way(..), mkBuildTag, wayRTSOnly, addWay', updateWays,
62
        wayGeneralFlags, wayUnsetGeneralFlags,
ian@well-typed.com's avatar
ian@well-typed.com committed
63

64
65
        thisPackage, thisComponentId, thisUnitIdInsts,

66
        -- ** Safe Haskell
67
        SafeHaskellMode(..),
68
        safeHaskellOn, safeImportsOn, safeLanguageOn, safeInferOn,
69
        packageTrustOn,
70
        safeDirectImpsReq, safeImplicitImpsReq,
71
        unsafeFlags, unsafeFlagsForInfer,
72

73
        -- ** System tool settings and locations
74
        Settings(..),
75
        targetPlatform, programName, projectVersion,
76
        ghcUsagePath, ghciUsagePath, topDir, tmpDir, rawSettings,
Edsko de Vries's avatar
Edsko de Vries committed
77
        versionedAppDir,
78
79
        extraGccViaCFlags, systemPackageConfig,
        pgm_L, pgm_P, pgm_F, pgm_c, pgm_s, pgm_a, pgm_l, pgm_dll, pgm_T,
80
81
        pgm_windres, pgm_libtool, pgm_lo, pgm_lc, pgm_i,
        opt_L, opt_P, opt_F, opt_c, opt_a, opt_l, opt_i,
82
        opt_windres, opt_lo, opt_lc,
83
84


85
        -- ** Manipulating DynFlags
86
        defaultDynFlags,                -- Settings -> DynFlags
87
        defaultWays,
ian@well-typed.com's avatar
ian@well-typed.com committed
88
        interpWays,
89
        interpreterProfiled, interpreterDynamic,
Ian Lynagh's avatar
Ian Lynagh committed
90
        initDynFlags,                   -- DynFlags -> IO DynFlags
Ian Lynagh's avatar
Ian Lynagh committed
91
        defaultFatalMessager,
92
        defaultLogAction,
93
        defaultLogActionHPrintDoc,
94
        defaultLogActionHPutStrDoc,
95
96
        defaultFlushOut,
        defaultFlushErr,
Ian Lynagh's avatar
Ian Lynagh committed
97

98
        getOpts,                        -- DynFlags -> (DynFlags -> [a]) -> [a]
99
        getVerbFlags,
Ian Lynagh's avatar
Ian Lynagh committed
100
101
        updOptLevel,
        setTmpDir,
102
        setUnitId,
Edsko de Vries's avatar
Edsko de Vries committed
103
        interpretPackageEnv,
Edward Z. Yang's avatar
Edward Z. Yang committed
104
        canonicalizeHomeModule,
Ian Lynagh's avatar
Ian Lynagh committed
105

106
        -- ** Parsing DynFlags
107
108
        parseDynamicFlagsCmdLine,
        parseDynamicFilePragma,
109
110
111
        parseDynamicFlagsFull,

        -- ** Available DynFlags
112
        allNonDeprecatedFlags,
113
114
115
        flagsAll,
        flagsDynamic,
        flagsPackage,
116
        flagsForCompletion,
117

118
        supportedLanguagesAndExtensions,
119
        languageExtensions,
120

121
        -- ** DynFlags C compiler options
Ian Lynagh's avatar
Ian Lynagh committed
122
        picCCOpts, picPOpts,
123
124

        -- * Compiler configuration suitable for display to the user
125
126
127
        compilerInfo,

        rtsIsProfiled,
128
        dynamicGhc,
129

130
#include "GHCConstantsHaskellExports.hs"
131
        bLOCK_SIZE_W,
132
        wORD_SIZE_IN_BITS,
133
134
        tAG_MASK,
        mAX_PTR_TAG,
135
        tARGET_MIN_INT, tARGET_MAX_INT, tARGET_MAX_WORD,
136

137
138
        unsafeGlobalDynFlags, setUnsafeGlobalDynFlags,

139
        -- * SSE and AVX
140
        isSseEnabled,
141
142
        isSse2Enabled,
        isSse4_2Enabled,
143
144
        isAvxEnabled,
        isAvx2Enabled,
145
146
147
148
        isAvx512cdEnabled,
        isAvx512erEnabled,
        isAvx512fEnabled,
        isAvx512pfEnabled,
149

Austin Seipp's avatar
Austin Seipp committed
150
        -- * Linker/compiler information
151
        LinkerInfo(..),
Austin Seipp's avatar
Austin Seipp committed
152
        CompilerInfo(..),
153
154
155
156
  ) where

#include "HsVersions.h"

157
import Platform
158
import PlatformConstants
159
import Module
Simon Marlow's avatar
Simon Marlow committed
160
import PackageConfig
161
import {-# SOURCE #-} Hooks
162
import {-# SOURCE #-} PrelNames ( mAIN )
163
import {-# SOURCE #-} Packages (PackageState, emptyPackageState)
Ian Lynagh's avatar
Ian Lynagh committed
164
import DriverPhases     ( Phase(..), phaseInputExt )
165
166
import Config
import CmdLineParser
167
import Constants
168
import Panic
169
import Util
Edsko de Vries's avatar
Edsko de Vries committed
170
import Maybes
171
import MonadUtils
172
import qualified Pretty
173
import SrcLoc
174
import BasicTypes       ( IntWithInf, treatZeroAsInf )
175
import FastString
Simon Marlow's avatar
Simon Marlow committed
176
import Outputable
Ian Lynagh's avatar
Ian Lynagh committed
177
import Foreign.C        ( CInt(..) )
178
import System.IO.Unsafe ( unsafeDupablePerformIO )
Rufflewind's avatar
Rufflewind committed
179
180
import {-# SOURCE #-} ErrUtils ( Severity(..), MsgDoc, mkLocMessageAnn
                               , getCaretDiagnostic )
181
import SysTools.Terminal ( stderrSupportsAnsiColors )
182

183
import System.IO.Unsafe ( unsafePerformIO )
184
import Data.IORef
185
import Control.Arrow ((&&&))
ian@well-typed.com's avatar
ian@well-typed.com committed
186
import Control.Monad
187
188
189
190
import Control.Monad.Trans.Class
import Control.Monad.Trans.Writer
import Control.Monad.Trans.Reader
import Control.Monad.Trans.Except
191
import Control.Exception (throwIO)
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
192

193
import Data.Ord
194
import Data.Bits
195
import Data.Char
196
import Data.Int
197
import Data.List
198
199
import Data.Map (Map)
import qualified Data.Map as Map
200
201
import Data.Set (Set)
import qualified Data.Set as Set
202
import Data.Word
Ian Lynagh's avatar
Ian Lynagh committed
203
import System.FilePath
Edsko de Vries's avatar
Edsko de Vries committed
204
205
import System.Directory
import System.Environment (getEnv)
206
import System.IO
207
import System.IO.Error
208
209
import Text.ParserCombinators.ReadP hiding (char)
import Text.ParserCombinators.ReadP as R
210

211
212
213
import Data.IntSet (IntSet)
import qualified Data.IntSet as IntSet

214
import GHC.Foreign (withCString, peekCString)
215
import qualified GHC.LanguageExtensions as LangExt
216

217
import Foreign (Ptr) -- needed for 2nd stage
Moritz Angermann's avatar
Moritz Angermann committed
218

219
220
221
222
223
224
225
-- Note [Updating flag description in the User's Guide]
-- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
--
-- If you modify anything in this file please make sure that your changes are
-- described in the User's Guide. Usually at least two sections need to be
-- updated:
--
226
227
--  * Flag Reference section generated from the modules in
--    utils/mkUserGuidePart/Options
228
--
229
--  * Flag description in docs/users_guide/using.rst provides a detailed
230
231
--    explanation of flags' usage.

232
233
234
235
236
237
238
239
240
241
242
243
-- Note [Supporting CLI completion]
-- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
--
-- The command line interface completion (in for example bash) is an easy way
-- for the developer to learn what flags are available from GHC.
-- GHC helps by separating which flags are available when compiling with GHC,
-- and which flags are available when using GHCi.
-- A flag is assumed to either work in both these modes, or only in one of them.
-- When adding or changing a flag, please consider for which mode the flag will
-- have effect, and annotate it accordingly. For Flags use defFlag, defGhcFlag,
-- defGhciFlag, and for FlagSpec use flagSpec or flagGhciSpec.

244
245
246
247
248
249
250
-- Note [Adding a language extension]
-- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
--
-- There are a few steps to adding (or removing) a language extension,
--
--  * Adding the extension to GHC.LanguageExtensions
--
251
252
--    The Extension type in libraries/ghc-boot-th/GHC/LanguageExtensions/Type.hs
--    is the canonical list of language extensions known by GHC.
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
--
--  * Adding a flag to DynFlags.xFlags
--
--    This is fairly self-explanatory. The name should be concise, memorable,
--    and consistent with any previous implementations of the similar idea in
--    other Haskell compilers.
--
--  * Adding the flag to the documentation
--
--    This is the same as any other flag. See
--    Note [Updating flag description in the User's Guide]
--
--  * Adding the flag to Cabal
--
--    The Cabal library has its own list of all language extensions supported
--    by all major compilers. This is the list that user code being uploaded
--    to Hackage is checked against to ensure language extension validity.
--    Consequently, it is very important that this list remains up-to-date.
--
--    To this end, there is a testsuite test (testsuite/tests/driver/T4437.hs)
--    whose job it is to ensure these GHC's extensions are consistent with
--    Cabal.
--
--    The recommended workflow is,
--
--     1. Temporarily add your new language extension to the
--        expectedGhcOnlyExtensions list in T4437 to ensure the test doesn't
--        break while Cabal is updated.
--
--     2. After your GHC change is accepted, submit a Cabal pull request adding
--        your new extension to Cabal's list (found in
--        Cabal/Language/Haskell/Extension.hs).
--
--     3. After your Cabal change is accepted, let the GHC developers know so
--        they can update the Cabal submodule and remove the extensions from
--        expectedGhcOnlyExtensions.
--
--  * Adding the flag to the GHC Wiki
--
--    There is a change log tracking language extension additions and removals
--    on the GHC wiki:  https://ghc.haskell.org/trac/ghc/wiki/LanguagePragmaHistory
--
--  See Trac #4437 and #8176.

297
298
299
-- -----------------------------------------------------------------------------
-- DynFlags

300
data DumpFlag
301
-- See Note [Updating flag description in the User's Guide]
302
303
304

   -- debugging flags
   = Opt_D_dump_cmm
305
   | Opt_D_dump_cmm_from_stg
306
   | Opt_D_dump_cmm_raw
307
308
309
310
   | Opt_D_dump_cmm_verbose
   -- All of the cmm subflags (there are a lot!) automatically
   -- enabled if you run -ddump-cmm-verbose
   -- Each flag corresponds to exact stage of Cmm pipeline.
311
312
   | Opt_D_dump_cmm_cfg
   | Opt_D_dump_cmm_cbe
313
   | Opt_D_dump_cmm_switch
314
315
   | Opt_D_dump_cmm_proc
   | Opt_D_dump_cmm_sp
316
317
   | Opt_D_dump_cmm_sink
   | Opt_D_dump_cmm_caf
318
319
320
321
322
   | Opt_D_dump_cmm_procmap
   | Opt_D_dump_cmm_split
   | Opt_D_dump_cmm_info
   | Opt_D_dump_cmm_cps
   -- end cmm subflags
323
   | Opt_D_dump_asm
324
325
326
327
328
   | Opt_D_dump_asm_native
   | Opt_D_dump_asm_liveness
   | Opt_D_dump_asm_regalloc
   | Opt_D_dump_asm_regalloc_stages
   | Opt_D_dump_asm_conflicts
329
   | Opt_D_dump_asm_stats
330
   | Opt_D_dump_asm_expanded
331
   | Opt_D_dump_llvm
332
   | Opt_D_dump_core_stats
333
334
335
336
   | Opt_D_dump_deriv
   | Opt_D_dump_ds
   | Opt_D_dump_foreign
   | Opt_D_dump_inlinings
337
   | Opt_D_dump_rule_firings
338
   | Opt_D_dump_rule_rewrites
339
   | Opt_D_dump_simpl_trace
340
341
   | Opt_D_dump_occur_anal
   | Opt_D_dump_parsed
342
   | Opt_D_dump_parsed_ast
343
   | Opt_D_dump_rn
Edward Z. Yang's avatar
Edward Z. Yang committed
344
   | Opt_D_dump_shape
345
346
347
348
349
   | Opt_D_dump_simpl
   | Opt_D_dump_simpl_iterations
   | Opt_D_dump_spec
   | Opt_D_dump_prep
   | Opt_D_dump_stg
350
   | Opt_D_dump_call_arity
351
   | Opt_D_dump_stranal
manav's avatar
manav committed
352
   | Opt_D_dump_str_signatures
353
354
355
356
357
358
359
360
361
   | 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
362
   | Opt_D_dump_cs_trace -- Constraint solver in type checker
363
   | Opt_D_dump_tc_trace
364
   | Opt_D_dump_ec_trace -- Pattern match exhaustiveness checker
365
   | Opt_D_dump_if_trace
366
   | Opt_D_dump_vt_trace
367
   | Opt_D_dump_splices
368
   | Opt_D_th_dec_file
369
370
   | Opt_D_dump_BCOs
   | Opt_D_dump_vect
371
   | Opt_D_dump_ticked
pepe's avatar
pepe committed
372
   | Opt_D_dump_rtti
373
374
375
376
   | Opt_D_source_stats
   | Opt_D_verbose_stg2stg
   | Opt_D_dump_hi
   | Opt_D_dump_hi_diffs
377
   | Opt_D_dump_mod_cycles
378
   | Opt_D_dump_mod_map
379
   | Opt_D_dump_view_pattern_commoning
380
   | Opt_D_verbose_core2core
381
   | Opt_D_dump_debug
382
383
384
385
386

   deriving (Eq, Show, Enum)

-- | Enumerates the simple on-or-off dynamic flags
data GeneralFlag
387
-- See Note [Updating flag description in the User's Guide]
388
389

   = Opt_DumpToFile                     -- ^ Append dump output to files instead of stdout.
390
   | Opt_D_faststring_stats
391
   | Opt_D_dump_minimal_imports
392
393
394
   | Opt_DoCoreLinting
   | Opt_DoStgLinting
   | Opt_DoCmmLinting
Ben.Lippmeier@anu.edu.au's avatar
Ben.Lippmeier@anu.edu.au committed
395
   | Opt_DoAsmLinting
Peter Wortmann's avatar
Peter Wortmann committed
396
   | Opt_DoAnnotationLinting
397
   | Opt_NoLlvmMangler                 -- hidden flag
398

Ian Lynagh's avatar
Ian Lynagh committed
399
   | Opt_WarnIsError                    -- -Werror; makes warnings fatal
400
   | Opt_ShowWarnGroups                 -- Show the group a warning belongs to
401
   | Opt_HideSourcePaths                -- Hide module source/object paths
402

403
   | Opt_PrintExplicitForalls
unknown's avatar
unknown committed
404
   | Opt_PrintExplicitKinds
405
   | Opt_PrintExplicitCoercions
406
   | Opt_PrintExplicitRuntimeReps
407
   | Opt_PrintEqualityRelations
408
   | Opt_PrintUnicodeSyntax
409
   | Opt_PrintExpandedSynonyms
410
   | Opt_PrintPotentialInstances
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
411
   | Opt_PrintTypecheckerElaboration
412

413
   -- optimisation opts
414
   | Opt_CallArity
415
   | Opt_Strictness
416
   | Opt_LateDmdAnal
417
418
   | Opt_KillAbsence
   | Opt_KillOneShot
419
   | Opt_FullLaziness
420
421
   | Opt_FloatIn
   | Opt_Specialise
422
   | Opt_SpecialiseAggressively
423
   | Opt_CrossModuleSpecialise
424
   | Opt_StaticArgumentTransformation
425
   | Opt_CSE
426
   | Opt_StgCSE
427
428
   | Opt_LiberateCase
   | Opt_SpecConstr
429
430
431
432
   | Opt_DoLambdaEtaExpansion
   | Opt_IgnoreAsserts
   | Opt_DoEtaReduction
   | Opt_CaseMerge
Sylvain Henry's avatar
Sylvain Henry committed
433
   | Opt_CaseFolding                    -- Constant folding through case-expressions
434
   | Opt_UnboxStrictFields
435
   | Opt_UnboxSmallStrictFields
436
   | Opt_DictsCheap
437
   | Opt_EnableRewriteRules             -- Apply rewrite rules during simplification
rl@cse.unsw.edu.au's avatar
rl@cse.unsw.edu.au committed
438
   | Opt_Vectorise
439
   | Opt_VectorisationAvoidance
Ian Lynagh's avatar
Ian Lynagh committed
440
441
   | Opt_RegsGraph                      -- do graph coloring register allocation
   | Opt_RegsIterative                  -- do iterative coalescing graph coloring register allocation
442
   | Opt_PedanticBottoms                -- Be picky about how we treat bottom
443
   | Opt_LlvmTBAA                       -- Use LLVM TBAA infastructure for improving AA (hidden flag)
444
   | Opt_LlvmPassVectorsInRegisters     -- Pass SIMD vectors in registers (requires a patched LLVM) (hidden flag)
445
   | Opt_LlvmFillUndefWithGarbage       -- Testing for undef bugs (hidden flag)
446
   | Opt_IrrefutableTuples
447
   | Opt_CmmSink
448
   | Opt_CmmElimCommonBlocks
449
   | Opt_OmitYields
450
   | Opt_FunToThunk               -- allow WwLib.mkWorkerArgs to remove all value lambdas
451
452
   | Opt_DictsStrict                     -- be strict in argument dictionaries
   | Opt_DmdTxDictSel              -- use a special demand transformer for dictionary selectors
453
   | Opt_Loopification                  -- See Note [Self-recursive tail calls]
454
   | Opt_CprAnal
455
   | Opt_WorkerWrapper
456

457
458
459
460
   -- Interface files
   | Opt_IgnoreInterfacePragmas
   | Opt_OmitInterfacePragmas
   | Opt_ExposeAllUnfoldings
461
   | Opt_WriteInterface -- forces .hi files to be written even with -fno-code
462

Ian Lynagh's avatar
Ian Lynagh committed
463
464
   -- profiling opts
   | Opt_AutoSccsOnIndividualCafs
465
   | Opt_ProfCountEntries
Ian Lynagh's avatar
Ian Lynagh committed
466

467
468
   -- misc opts
   | Opt_Pp
469
   | Opt_ForceRecomp
470
   | Opt_ExcessPrecision
471
   | Opt_EagerBlackHoling
472
473
   | Opt_NoHsMain
   | Opt_SplitObjs
474
   | Opt_SplitSections
475
   | Opt_StgStats
476
   | Opt_HideAllPackages
477
   | Opt_HideAllPluginPackages
478
   | Opt_PrintBindResult
479
   | Opt_Haddock
David Waern's avatar
David Waern committed
480
   | Opt_HaddockOptions
481
   | Opt_BreakOnException
482
   | Opt_BreakOnError
483
   | Opt_PrintEvldWithShow
484
   | Opt_PrintBindContents
485
486
   | Opt_GenManifest
   | Opt_EmbedManifest
Ian Lynagh's avatar
Ian Lynagh committed
487
   | Opt_SharedImplib
488
   | Opt_BuildingCabalPackage
489
   | Opt_IgnoreDotGhci
490
   | Opt_GhciSandbox
Ian Lynagh's avatar
Ian Lynagh committed
491
   | Opt_GhciHistory
492
   | Opt_LocalGhciHistory
493
   | Opt_HelpfulErrors
494
   | Opt_DeferTypeErrors
495
   | Opt_DeferTypedHoles
496
   | Opt_DeferOutOfScopeVariables
Ian Lynagh's avatar
Ian Lynagh committed
497
   | Opt_PIC
498
   | Opt_SccProfilingOn
ian@well-typed.com's avatar
ian@well-typed.com committed
499
   | Opt_Ticky
nfrisby's avatar
nfrisby committed
500
501
502
   | Opt_Ticky_Allocd
   | Opt_Ticky_LNE
   | Opt_Ticky_Dyn_Thunk
503
   | Opt_RPath
504
   | Opt_RelativeDynlibPaths
ian@well-typed.com's avatar
ian@well-typed.com committed
505
   | Opt_Hpc
506
   | Opt_FlatCache
507
   | Opt_ExternalInterpreter
Simon Marlow's avatar
Simon Marlow committed
508
   | Opt_OptimalApplicativeDo
509
   | Opt_VersionMacros
510

511
512
513
514
   -- PreInlining is on by default. The option is there just to see how
   -- bad things get if you turn it off!
   | Opt_SimplPreInlining

515
   -- output style opts
516
517
   | Opt_ErrorSpans -- Include full span info in error messages,
                    -- instead of just the start position.
Rufflewind's avatar
Rufflewind committed
518
   | Opt_DiagnosticsShowCaret -- Show snippets of offending code
519
   | Opt_PprCaseAsLet
Peter Wortmann's avatar
Peter Wortmann committed
520
   | Opt_PprShowTicks
521
   | Opt_ShowHoleConstraints
522

523
524
525
526
527
528
529
530
531
532
533
   -- Suppress all coercions, them replacing with '...'
   | Opt_SuppressCoercions
   | Opt_SuppressVarKinds
   -- Suppress module id prefixes on variables.
   | Opt_SuppressModulePrefixes
   -- Suppress type applications.
   | Opt_SuppressTypeApplications
   -- Suppress info such as arity and unfoldings on identifiers.
   | Opt_SuppressIdInfo
   -- Suppress separate type signatures in core, but leave types on
   -- lambda bound vars
534
535
   | Opt_SuppressUnfoldings
   -- Suppress the details of even stable unfoldings
536
537
538
539
540
541
   | Opt_SuppressTypeSignatures
   -- Suppress unique ids on variables.
   -- Except for uniques, as some simplifier phases introduce new
   -- variables that have otherwise identical names.
   | Opt_SuppressUniques

542
   -- temporary flags
543
   | Opt_AutoLinkPackages
544
   | Opt_ImplicitImportQualified
545
546
547
548
549
550

   -- keeping stuff
   | Opt_KeepHiDiffs
   | Opt_KeepHcFiles
   | Opt_KeepSFiles
   | Opt_KeepTmpFiles
Jedai's avatar
Jedai committed
551
   | Opt_KeepRawTokenStream
552
   | Opt_KeepLlvmFiles
553
554
   | Opt_KeepHiFiles
   | Opt_KeepOFiles
555

556
557
   | Opt_BuildDynamicToo

558
   -- safe haskell flags
dterei's avatar
dterei committed
559
   | Opt_DistrustAllPackages
560
   | Opt_PackageTrust
561
   deriving (Eq, Show, Enum)
Ian Lynagh's avatar
Ian Lynagh committed
562

563
564
565
566
-- | Used when outputting warnings: if a reason is given, it is
-- displayed. If a warning isn't controlled by a flag, this is made
-- explicit at the point of use.
data WarnReason = NoReason | Reason !WarningFlag
Richard Eisenberg's avatar
Richard Eisenberg committed
567
568
569
570
  deriving Show

instance Outputable WarnReason where
  ppr = text . show
571

572
data WarningFlag =
573
-- See Note [Updating flag description in the User's Guide]
574
     Opt_WarnDuplicateExports
575
   | Opt_WarnDuplicateConstraints
576
   | Opt_WarnRedundantConstraints
577
578
579
580
581
   | Opt_WarnHiShadows
   | Opt_WarnImplicitPrelude
   | Opt_WarnIncompletePatterns
   | Opt_WarnIncompleteUniPatterns
   | Opt_WarnIncompletePatternsRecUpd
582
   | Opt_WarnOverflowedLiterals
583
   | Opt_WarnEmptyEnumerations
584
585
586
   | Opt_WarnMissingFields
   | Opt_WarnMissingImportList
   | Opt_WarnMissingMethods
manav's avatar
manav committed
587
588
   | Opt_WarnMissingSignatures
   | Opt_WarnMissingLocalSignatures
589
590
591
592
   | Opt_WarnNameShadowing
   | Opt_WarnOverlappingPatterns
   | Opt_WarnTypeDefaults
   | Opt_WarnMonomorphism
593
594
595
   | Opt_WarnUnusedTopBinds
   | Opt_WarnUnusedLocalBinds
   | Opt_WarnUnusedPatternBinds
596
597
   | Opt_WarnUnusedImports
   | Opt_WarnUnusedMatches
598
599
   | Opt_WarnUnusedTypePatterns
   | Opt_WarnUnusedForalls
600
601
   | Opt_WarnWarningsDeprecations
   | Opt_WarnDeprecatedFlags
602
   | Opt_WarnAMP -- Introduced in GHC 7.8, obsolete since 7.10
603
   | Opt_WarnMissingMonadFailInstances -- since 8.0
604
   | Opt_WarnSemigroup -- since 8.0
605
606
607
608
609
610
611
612
613
614
615
   | Opt_WarnDodgyExports
   | Opt_WarnDodgyImports
   | Opt_WarnOrphans
   | Opt_WarnAutoOrphans
   | Opt_WarnIdentities
   | Opt_WarnTabs
   | Opt_WarnUnrecognisedPragmas
   | Opt_WarnDodgyForeignImports
   | Opt_WarnUnusedDoBind
   | Opt_WarnWrongDoBind
   | Opt_WarnAlternativeLayoutRuleTransitional
616
617
   | Opt_WarnUnsafe
   | Opt_WarnSafe
618
   | Opt_WarnTrustworthySafe
619
620
   | Opt_WarnMissedSpecs
   | Opt_WarnAllMissedSpecs
621
   | Opt_WarnUnsupportedCallingConventions
622
   | Opt_WarnUnsupportedLlvmVersion
623
   | Opt_WarnInlineRuleShadowing
624
   | Opt_WarnTypedHoles
thomasw's avatar
thomasw committed
625
   | Opt_WarnPartialTypeSignatures
manav's avatar
manav committed
626
   | Opt_WarnMissingExportedSignatures
carlostome's avatar
carlostome committed
627
   | Opt_WarnUntickedPromotedConstructors
628
   | Opt_WarnDerivingTypeable
629
   | Opt_WarnDeferredTypeErrors
630
   | Opt_WarnDeferredOutOfScopeVariables
631
   | Opt_WarnNonCanonicalMonadInstances   -- since 8.0
632
   | Opt_WarnNonCanonicalMonadFailInstances -- since 8.0
633
   | Opt_WarnNonCanonicalMonoidInstances  -- since 8.0
manav's avatar
manav committed
634
   | Opt_WarnMissingPatternSynonymSignatures -- since 8.0
635
   | Opt_WarnUnrecognisedWarningFlags     -- since 8.0
636
   | Opt_WarnSimplifiableClassConstraints -- Since 8.2
637
   | Opt_WarnCPPUndef                     -- Since 8.2
Richard Eisenberg's avatar
Richard Eisenberg committed
638
   | Opt_WarnUnbangedStrictPatterns       -- Since 8.2
Yuras's avatar
Yuras committed
639
   | Opt_WarnMissingHomeModules           -- Since 8.2
640
   deriving (Eq, Show, Enum)
641

642
data Language = Haskell98 | Haskell2010
Oleg Grenrus's avatar
Oleg Grenrus committed
643
644
645
646
   deriving (Eq, Enum, Show)

instance Outputable Language where
    ppr = text . show
647

648
-- | The various Safe Haskell modes
649
650
data SafeHaskellMode
   = Sf_None
dterei's avatar
dterei committed
651
   | Sf_Unsafe
652
653
654
655
   | Sf_Trustworthy
   | Sf_Safe
   deriving (Eq)

Ian Lynagh's avatar
Ian Lynagh committed
656
instance Show SafeHaskellMode where
Ian Lynagh's avatar
Ian Lynagh committed
657
658
659
660
    show Sf_None         = "None"
    show Sf_Unsafe       = "Unsafe"
    show Sf_Trustworthy  = "Trustworthy"
    show Sf_Safe         = "Safe"
Ian Lynagh's avatar
Ian Lynagh committed
661

662
instance Outputable SafeHaskellMode where
Ian Lynagh's avatar
Ian Lynagh committed
663
    ppr = text . show
664

665
-- | Contains not only a collection of 'GeneralFlag's but also a plethora of
666
-- information relating to the compilation of a single file or GHC session
667
data DynFlags = DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
668
669
670
  ghcMode               :: GhcMode,
  ghcLink               :: GhcLink,
  hscTarget             :: HscTarget,
671
  settings              :: Settings,
672
  verbosity             :: Int,         -- ^ Verbosity level: see Note [Verbosity levels]
673
  optLevel              :: Int,         -- ^ Optimisation level
674
  debugLevel            :: Int,         -- ^ How much debug information to produce
675
676
  simplPhases           :: Int,         -- ^ Number of simplifier phases
  maxSimplIterations    :: Int,         -- ^ Max simplifier iterations
677
  maxPmCheckIterations  :: Int,         -- ^ Max no iterations for pm checking
Ian Lynagh's avatar
Ian Lynagh committed
678
  ruleCheck             :: Maybe String,
679
  strictnessBefore      :: [Int],       -- ^ Additional demand analysis
680

681
682
  parMakeCount          :: Maybe Int,   -- ^ The number of modules to compile in parallel
                                        --   in --make mode, where Nothing ==> compile as
parcs's avatar
parcs committed
683
684
                                        --   many in parallel as there are CPUs.

685
686
687
  enableTimeStats       :: Bool,        -- ^ Enable RTS timing statistics?
  ghcHeapSize           :: Maybe Int,   -- ^ The heap size to set.

688
689
  maxRelevantBinds      :: Maybe Int,   -- ^ Maximum number of bindings from the type envt
                                        --   to show in type error messages
690
691
  maxUncoveredPatterns  :: Int,         -- ^ Maximum number of unmatched patterns to show
                                        --   in non-exhaustiveness warnings
692
  simplTickFactor       :: Int,         -- ^ Multiplier for simplifier ticks
693
694
  specConstrThreshold   :: Maybe Int,   -- ^ Threshold for SpecConstr
  specConstrCount       :: Maybe Int,   -- ^ Max number of specialisations for any one function
695
696
  specConstrRecursive   :: Int,         -- ^ Max number of specialisations for recursive types
                                        --   Not optional; otherwise ForceSpecConstr can diverge.
697
  liberateCaseThreshold :: Maybe Int,   -- ^ Threshold for LiberateCase
698
  floatLamArgs          :: Maybe Int,   -- ^ Arg count for lambda floating
699
                                        --   See CoreMonad.FloatOutSwitches
700

701
  historySize           :: Int,         -- ^ Simplification history size
702

Ian Lynagh's avatar
Ian Lynagh committed
703
704
705
  importPaths           :: [FilePath],
  mainModIs             :: Module,
  mainFunIs             :: Maybe String,
706
  reductionDepth        :: IntWithInf,   -- ^ Typechecker maximum stack depth
707
708
  solverIterations      :: IntWithInf,   -- ^ Number of iterations in the constraints solver
                                         --   Typically only 1 is needed
709

710
711
712
  thisInstalledUnitId   :: InstalledUnitId,
  thisComponentId_      :: Maybe ComponentId,
  thisUnitIdInsts_      :: Maybe [(ModuleName, Module)],
713
714

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

719
720
721
  -- For object splitting
  splitInfo             :: Maybe (String,Int),

722
  -- paths etc.
Ian Lynagh's avatar
Ian Lynagh committed
723
  objectDir             :: Maybe String,
724
  dylibInstallName      :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
725
726
  hiDir                 :: Maybe String,
  stubDir               :: Maybe String,
727
  dumpDir               :: Maybe String,
728

Ian Lynagh's avatar
Ian Lynagh committed
729
730
731
  objectSuf             :: String,
  hcSuf                 :: String,
  hiSuf                 :: String,
732

733
734
735
736
  canGenerateDynamicToo :: IORef Bool,
  dynObjectSuf          :: String,
  dynHiSuf              :: String,

737
738
739
740
741
742
743
744
  -- Packages.isDllName needs to know whether a call is within a
  -- single DLL or not. Normally it does this by seeing if the call
  -- is to the same package, but for the ghc package, we split the
  -- package between 2 DLLs. The dllSplit tells us which sets of
  -- modules are in which package.
  dllSplitFile          :: Maybe FilePath,
  dllSplit              :: Maybe [Set String],

Ian Lynagh's avatar
Ian Lynagh committed
745
  outputFile            :: Maybe String,
ian@well-typed.com's avatar
ian@well-typed.com committed
746
  dynOutputFile         :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
747
748
  outputHi              :: Maybe String,
  dynLibLoader          :: DynLibLoader,
749

750
  -- | This is set by 'DriverPipeline.runPipeline' based on where
Ian Lynagh's avatar
Ian Lynagh committed
751
752
  --    its output is going.
  dumpPrefix            :: Maybe FilePath,
753

754
755
  -- | Override the 'dumpPrefix' set by 'DriverPipeline.runPipeline'.
  --    Set by @-ddump-file-prefix@
Ian Lynagh's avatar
Ian Lynagh committed
756
757
  dumpPrefixForce       :: Maybe FilePath,

758
  ldInputs              :: [Option],
759

Ian Lynagh's avatar
Ian Lynagh committed
760
761
762
763
764
  includePaths          :: [String],
  libraryPaths          :: [String],
  frameworkPaths        :: [String],    -- used on darwin only
  cmdlineFrameworks     :: [String],    -- ditto

765
  rtsOpts               :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
766
  rtsOptsEnabled        :: RtsOptsEnabled,
767
  rtsOptsSuggestions    :: Bool,
768

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

771
772
773
  -- Plugins
  pluginModNames        :: [ModuleName],
  pluginModNameOpts     :: [(ModuleName,String)],
Edward Z. Yang's avatar
Edward Z. Yang committed
774
  frontendPluginOpts    :: [String],
775

776
777
778
  -- GHC API hooks
  hooks                 :: Hooks,

779
780
781
782
783
784
  --  For ghc -M
  depMakefile           :: FilePath,
  depIncludePkgDeps     :: Bool,
  depExcludeMods        :: [ModuleName],
  depSuffixes           :: [String],

785
  --  Package flags
786
  extraPkgConfs         :: [PkgConfRef] -> [PkgConfRef],
787
        -- ^ The @-package-db@ flags given on the command line, in the order
Ian Lynagh's avatar
Ian Lynagh committed
788
        -- they appeared.
789

790
791
  ignorePackageFlags    :: [IgnorePackageFlag],
        -- ^ The @-ignore-package@ flags from the command line
Ian Lynagh's avatar
Ian Lynagh committed
792
  packageFlags          :: [PackageFlag],
793
        -- ^ The @-package@ and @-hide-package@ flags from the command-line
794
795
  pluginPackageFlags    :: [PackageFlag],
        -- ^ The @-plugin-package-id@ flags from command line
796
797
  trustFlags            :: [TrustFlag],
        -- ^ The @-trust@ and @-distrust@ flags
Edsko de Vries's avatar
Edsko de Vries committed
798
799
  packageEnv            :: Maybe FilePath,
        -- ^ Filepath to the package environment file (if overriding default)
800

801
  -- Package state
Ian Lynagh's avatar
Ian Lynagh committed
802
  -- NB. do not modify this field, it is calculated by
Edward Z. Yang's avatar
Edward Z. Yang committed
803
  -- Packages.initPackages
804
  pkgDatabase           :: Maybe [(FilePath, [PackageConfig])],
Ian Lynagh's avatar
Ian Lynagh committed
805
  pkgState              :: PackageState,
806

807
808
809
810
  -- Temporary files
  -- These have to be IORefs, because the defaultCleanupHandler needs to
  -- know what to clean when an exception happens
  filesToClean          :: IORef [FilePath],
811
  dirsToClean           :: IORef (Map FilePath FilePath),
812
  filesToNotIntermediateClean :: IORef [FilePath],
813
814
  -- The next available suffix to uniquely name a temp file, updated atomically
  nextTempSuffix        :: IORef Int,
815

816
817
818
  -- 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
819
  generatedDumps        :: IORef (Set FilePath),
820

821
  -- hsc dynamic flags
822
823
  dumpFlags             :: IntSet,
  generalFlags          :: IntSet,
824
  warningFlags          :: IntSet,