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
        compilerInfo,

127
#ifdef GHCI
128
        rtsIsProfiled,
129
#endif
130
        dynamicGhc,
131

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

139
140
        unsafeGlobalDynFlags, setUnsafeGlobalDynFlags,

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

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

#include "HsVersions.h"

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

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

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

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

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

Moritz Angermann's avatar
Moritz Angermann committed
218
219
220
221
222
223
224
#if __GLASGOW_HASKELL__ >= 709
import Foreign
#else
import Foreign.Safe
#endif


225
226
227
228
229
230
231
-- 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:
--
232
233
--  * Flag Reference section generated from the modules in
--    utils/mkUserGuidePart/Options
234
--
235
--  * Flag description in docs/users_guide/using.rst provides a detailed
236
237
--    explanation of flags' usage.

238
239
240
241
242
243
244
245
246
247
248
249
-- 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.

250
251
252
253
254
255
256
-- Note [Adding a language extension]
-- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
--
-- There are a few steps to adding (or removing) a language extension,
--
--  * Adding the extension to GHC.LanguageExtensions
--
257
258
--    The Extension type in libraries/ghc-boot-th/GHC/LanguageExtensions/Type.hs
--    is the canonical list of language extensions known by GHC.
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
297
298
299
300
301
302
--
--  * 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.

303
304
305
-- -----------------------------------------------------------------------------
-- DynFlags

306
data DumpFlag
307
-- See Note [Updating flag description in the User's Guide]
308
309
310

   -- debugging flags
   = Opt_D_dump_cmm
311
   | Opt_D_dump_cmm_from_stg
312
   | Opt_D_dump_cmm_raw
313
314
315
316
   | 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.
317
318
   | Opt_D_dump_cmm_cfg
   | Opt_D_dump_cmm_cbe
319
   | Opt_D_dump_cmm_switch
320
321
   | Opt_D_dump_cmm_proc
   | Opt_D_dump_cmm_sp
322
323
   | Opt_D_dump_cmm_sink
   | Opt_D_dump_cmm_caf
324
325
326
327
328
   | Opt_D_dump_cmm_procmap
   | Opt_D_dump_cmm_split
   | Opt_D_dump_cmm_info
   | Opt_D_dump_cmm_cps
   -- end cmm subflags
329
   | Opt_D_dump_asm
330
331
332
333
334
   | 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
335
   | Opt_D_dump_asm_stats
336
   | Opt_D_dump_asm_expanded
337
   | Opt_D_dump_llvm
338
   | Opt_D_dump_core_stats
339
340
341
342
   | Opt_D_dump_deriv
   | Opt_D_dump_ds
   | Opt_D_dump_foreign
   | Opt_D_dump_inlinings
343
   | Opt_D_dump_rule_firings
344
   | Opt_D_dump_rule_rewrites
345
   | Opt_D_dump_simpl_trace
346
347
348
   | Opt_D_dump_occur_anal
   | Opt_D_dump_parsed
   | Opt_D_dump_rn
Edward Z. Yang's avatar
Edward Z. Yang committed
349
   | Opt_D_dump_shape
350
351
352
353
354
   | Opt_D_dump_simpl
   | Opt_D_dump_simpl_iterations
   | Opt_D_dump_spec
   | Opt_D_dump_prep
   | Opt_D_dump_stg
355
   | Opt_D_dump_call_arity
356
   | Opt_D_dump_stranal
manav's avatar
manav committed
357
   | Opt_D_dump_str_signatures
358
359
360
361
362
363
364
365
366
   | 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
367
   | Opt_D_dump_cs_trace -- Constraint solver in type checker
368
   | Opt_D_dump_tc_trace
369
   | Opt_D_dump_ec_trace -- Pattern match exhaustiveness checker
370
   | Opt_D_dump_if_trace
371
   | Opt_D_dump_vt_trace
372
   | Opt_D_dump_splices
373
   | Opt_D_th_dec_file
374
375
   | Opt_D_dump_BCOs
   | Opt_D_dump_vect
376
   | Opt_D_dump_ticked
pepe's avatar
pepe committed
377
   | Opt_D_dump_rtti
378
379
380
381
   | Opt_D_source_stats
   | Opt_D_verbose_stg2stg
   | Opt_D_dump_hi
   | Opt_D_dump_hi_diffs
382
   | Opt_D_dump_mod_cycles
383
   | Opt_D_dump_mod_map
384
   | Opt_D_dump_view_pattern_commoning
385
   | Opt_D_verbose_core2core
386
   | Opt_D_dump_debug
387
388
389
390
391

   deriving (Eq, Show, Enum)

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

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

Ian Lynagh's avatar
Ian Lynagh committed
404
   | Opt_WarnIsError                    -- -Werror; makes warnings fatal
405
   | Opt_ShowWarnGroups                 -- Show the group a warning belongs to
406
   | Opt_HideSourcePaths                -- Hide module source/object paths
407

408
   | Opt_PrintExplicitForalls
unknown's avatar
unknown committed
409
   | Opt_PrintExplicitKinds
410
   | Opt_PrintExplicitCoercions
411
   | Opt_PrintExplicitRuntimeReps
412
   | Opt_PrintEqualityRelations
413
   | Opt_PrintUnicodeSyntax
414
   | Opt_PrintExpandedSynonyms
415
   | Opt_PrintPotentialInstances
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
416
   | Opt_PrintTypecheckerElaboration
417

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

461
462
463
464
   -- Interface files
   | Opt_IgnoreInterfacePragmas
   | Opt_OmitInterfacePragmas
   | Opt_ExposeAllUnfoldings
465
   | Opt_WriteInterface -- forces .hi files to be written even with -fno-code
466

Ian Lynagh's avatar
Ian Lynagh committed
467
468
   -- profiling opts
   | Opt_AutoSccsOnIndividualCafs
469
   | Opt_ProfCountEntries
Ian Lynagh's avatar
Ian Lynagh committed
470

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

515
516
517
518
   -- PreInlining is on by default. The option is there just to see how
   -- bad things get if you turn it off!
   | Opt_SimplPreInlining

519
   -- output style opts
520
521
   | Opt_ErrorSpans -- Include full span info in error messages,
                    -- instead of just the start position.
522
   | Opt_PprCaseAsLet
Peter Wortmann's avatar
Peter Wortmann committed
523
   | Opt_PprShowTicks
524
   | Opt_ShowHoleConstraints
525

526
527
528
529
530
531
532
533
534
535
536
   -- 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
537
538
   | Opt_SuppressUnfoldings
   -- Suppress the details of even stable unfoldings
539
540
541
542
543
544
   | Opt_SuppressTypeSignatures
   -- Suppress unique ids on variables.
   -- Except for uniques, as some simplifier phases introduce new
   -- variables that have otherwise identical names.
   | Opt_SuppressUniques

545
   -- temporary flags
546
   | Opt_AutoLinkPackages
547
   | Opt_ImplicitImportQualified
548
549
550
551
552
553

   -- keeping stuff
   | Opt_KeepHiDiffs
   | Opt_KeepHcFiles
   | Opt_KeepSFiles
   | Opt_KeepTmpFiles
Jedai's avatar
Jedai committed
554
   | Opt_KeepRawTokenStream
555
   | Opt_KeepLlvmFiles
556
557
   | Opt_KeepHiFiles
   | Opt_KeepOFiles
558

559
560
   | Opt_BuildDynamicToo

561
   -- safe haskell flags
dterei's avatar
dterei committed
562
   | Opt_DistrustAllPackages
563
   | Opt_PackageTrust
564
   deriving (Eq, Show, Enum)
Ian Lynagh's avatar
Ian Lynagh committed
565

566
567
568
569
570
-- | 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

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

639
data Language = Haskell98 | Haskell2010
Oleg Grenrus's avatar
Oleg Grenrus committed
640
641
642
643
   deriving (Eq, Enum, Show)

instance Outputable Language where
    ppr = text . show
644

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

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

659
instance Outputable SafeHaskellMode where
Ian Lynagh's avatar
Ian Lynagh committed
660
    ppr = text . show
661

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

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

682
683
684
  enableTimeStats       :: Bool,        -- ^ Enable RTS timing statistics?
  ghcHeapSize           :: Maybe Int,   -- ^ The heap size to set.

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

698
  historySize           :: Int,         -- ^ Simplification history size
699

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

707
708
709
  thisInstalledUnitId   :: InstalledUnitId,
  thisComponentId_      :: Maybe ComponentId,
  thisUnitIdInsts_      :: Maybe [(ModuleName, Module)],
710
711

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

716
717
718
  -- For object splitting
  splitInfo             :: Maybe (String,Int),

719
  -- paths etc.
Ian Lynagh's avatar
Ian Lynagh committed
720
  objectDir             :: Maybe String,
721
  dylibInstallName      :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
722
723
  hiDir                 :: Maybe String,
  stubDir               :: Maybe String,
724
  dumpDir               :: Maybe String,
725

Ian Lynagh's avatar
Ian Lynagh committed
726
727
728
  objectSuf             :: String,
  hcSuf                 :: String,
  hiSuf                 :: String,
729

730
731
732
733
  canGenerateDynamicToo :: IORef Bool,
  dynObjectSuf          :: String,
  dynHiSuf              :: String,

734
735
736
737
738
739
740
741
  -- 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
742
  outputFile            :: Maybe String,
ian@well-typed.com's avatar
ian@well-typed.com committed
743
  dynOutputFile         :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
744
745
  outputHi              :: Maybe String,
  dynLibLoader          :: DynLibLoader,
746

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

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

755
  ldInputs              :: [Option],
756

Ian Lynagh's avatar
Ian Lynagh committed
757
758
759
760
761
  includePaths          :: [String],
  libraryPaths          :: [String],
  frameworkPaths        :: [String],    -- used on darwin only
  cmdlineFrameworks     :: [String],    -- ditto

762
  rtsOpts               :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
763
  rtsOptsEnabled        :: RtsOptsEnabled,
764
  rtsOptsSuggestions    :: Bool,
765

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

768
769
770
  -- Plugins
  pluginModNames        :: [ModuleName],
  pluginModNameOpts     :: [(ModuleName,String)],
Edward Z. Yang's avatar
Edward Z. Yang committed
771
  frontendPluginOpts    :: [String],
772

773
774
775
  -- GHC API hooks
  hooks                 :: Hooks,

776
777
778
779
780
781
  --  For ghc -M
  depMakefile           :: FilePath,
  depIncludePkgDeps     :: Bool,
  depExcludeMods        :: [ModuleName],
  depSuffixes           :: [String],

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

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

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

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

813
814
815
  -- 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
816
  generatedDumps        :: IORef (Set FilePath),
817

818
  -- hsc dynamic flags
819
820
  dumpFlags             :: IntSet,
  generalFlags          :: IntSet,
821
  warningFlags          :: IntSet,
822
  fatalWarningFlags     :: IntSet,
823
  -- Don't change this without updating extensionFlags:
824
  language              :: Maybe Language,
825
826
  -- | Safe Haskell mode
  safeHaskell           :: SafeHaskellMode,
827
828
  safeInfer             :: Bool,
  safeInferred          :: Bool,