DynFlags.hs 216 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
import {-# SOURCE #-} ErrUtils ( Severity(..), MsgDoc, mkLocMessageAnn
180
181
                               , getCaretDiagnostic, dumpSDoc )
import Json
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

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

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

233
234
235
236
237
238
239
240
241
242
243
244
-- 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.

245
246
247
248
249
250
251
-- Note [Adding a language extension]
-- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
--
-- There are a few steps to adding (or removing) a language extension,
--
--  * Adding the extension to GHC.LanguageExtensions
--
252
253
--    The Extension type in libraries/ghc-boot-th/GHC/LanguageExtensions/Type.hs
--    is the canonical list of language extensions known by GHC.
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
297
--
--  * 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.

298
299
300
-- -----------------------------------------------------------------------------
-- DynFlags

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

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

   deriving (Eq, Show, Enum)

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

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

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

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

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

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

Ian Lynagh's avatar
Ian Lynagh committed
465
466
   -- profiling opts
   | Opt_AutoSccsOnIndividualCafs
467
   | Opt_ProfCountEntries
Ian Lynagh's avatar
Ian Lynagh committed
468

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

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

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

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

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

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

558
559
   | Opt_BuildDynamicToo

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

565
566
567
568
-- | 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
569
570
571
572
  deriving Show

instance Outputable WarnReason where
  ppr = text . show
573

574
575
576
577
instance ToJson WarnReason where
  json NoReason = JSNull
  json (Reason wf) = JSString (show wf)

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

648
data Language = Haskell98 | Haskell2010
Oleg Grenrus's avatar
Oleg Grenrus committed
649
650
651
652
   deriving (Eq, Enum, Show)

instance Outputable Language where
    ppr = text . show
653

654
-- | The various Safe Haskell modes
655
656
data SafeHaskellMode
   = Sf_None
dterei's avatar
dterei committed
657
   | Sf_Unsafe
658
659
660
661
   | Sf_Trustworthy
   | Sf_Safe
   deriving (Eq)

Ian Lynagh's avatar
Ian Lynagh committed
662
instance Show SafeHaskellMode where
Ian Lynagh's avatar
Ian Lynagh committed
663
664
665
666
    show Sf_None         = "None"
    show Sf_Unsafe       = "Unsafe"
    show Sf_Trustworthy  = "Trustworthy"
    show Sf_Safe         = "Safe"
Ian Lynagh's avatar
Ian Lynagh committed
667

668
instance Outputable SafeHaskellMode where
Ian Lynagh's avatar
Ian Lynagh committed
669
    ppr = text . show
670

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

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

691
692
693
  enableTimeStats       :: Bool,        -- ^ Enable RTS timing statistics?
  ghcHeapSize           :: Maybe Int,   -- ^ The heap size to set.

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

707
  historySize           :: Int,         -- ^ Simplification history size
708

Ian Lynagh's avatar
Ian Lynagh committed
709
710
711
  importPaths           :: [FilePath],
  mainModIs             :: Module,
  mainFunIs             :: Maybe String,
712
  reductionDepth        :: IntWithInf,   -- ^ Typechecker maximum stack depth
713
714
  solverIterations      :: IntWithInf,   -- ^ Number of iterations in the constraints solver
                                         --   Typically only 1 is needed
715

716
717
718
  thisInstalledUnitId   :: InstalledUnitId,
  thisComponentId_      :: Maybe ComponentId,
  thisUnitIdInsts_      :: Maybe [(ModuleName, Module)],
719
720

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

725
726
727
  -- For object splitting
  splitInfo             :: Maybe (String,Int),

728
  -- paths etc.
Ian Lynagh's avatar
Ian Lynagh committed
729
  objectDir             :: Maybe String,
730
  dylibInstallName      :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
731
732
  hiDir                 :: Maybe String,
  stubDir               :: Maybe String,
733
  dumpDir               :: Maybe String,
734

Ian Lynagh's avatar
Ian Lynagh committed
735
736
737
  objectSuf             :: String,
  hcSuf                 :: String,
  hiSuf                 :: String,
738

739
740
741
742
  canGenerateDynamicToo :: IORef Bool,
  dynObjectSuf          :: String,
  dynHiSuf              :: String,

743
744
745
746
747
748
749
750
  -- 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
751
  outputFile            :: Maybe String,
ian@well-typed.com's avatar
ian@well-typed.com committed
752
  dynOutputFile         :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
753
754
  outputHi              :: Maybe String,
  dynLibLoader          :: DynLibLoader,
755

756
  -- | This is set by 'DriverPipeline.runPipeline' based on where
Ian Lynagh's avatar
Ian Lynagh committed
757
758
  --    its output is going.
  dumpPrefix            :: Maybe FilePath,
759

760
761
  -- | Override the 'dumpPrefix' set by 'DriverPipeline.runPipeline'.
  --    Set by @-ddump-file-prefix@
Ian Lynagh's avatar
Ian Lynagh committed
762
763
  dumpPrefixForce       :: Maybe FilePath,

764
  ldInputs              :: [Option],
765

Ian Lynagh's avatar
Ian Lynagh committed
766
767
768
769
770
  includePaths          :: [String],
  libraryPaths          :: [String],
  frameworkPaths        :: [String],    -- used on darwin only
  cmdlineFrameworks     :: [String],    -- ditto

771
  rtsOpts               :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
772
  rtsOptsEnabled        :: RtsOptsEnabled,
773
  rtsOptsSuggestions    :: Bool,
774

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

777
778
779
  -- Plugins
  pluginModNames        :: [ModuleName],
  pluginModNameOpts     :: [(ModuleName,String)],
Edward Z. Yang's avatar
Edward Z. Yang committed
780
  frontendPluginOpts    :: [String],
781

782
783
784
  -- GHC API hooks
  hooks                 :: Hooks,

785
786
787
788
789
790
  --  For ghc -M
  depMakefile           :: FilePath,
  depIncludePkgDeps     :: Bool,
  depExcludeMods        :: [ModuleName],
  depSuffixes           :: [String],

791
  --  Package flags
792
  extraPkgConfs         :: [PkgConfRef] -> [PkgConfRef],
793
        -- ^ The @-package-db@ flags given on the command line, in the order
Ian Lynagh's avatar
Ian Lynagh committed
794
        -- they appeared.
795

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

807
  -- Package state
Ian Lynagh's avatar
Ian Lynagh committed
808
  -- NB. do not modify this field, it is calculated by
Edward Z. Yang's avatar
Edward Z. Yang committed
809
  -- Packages.initPackages
810
  pkgDatabase           :: Maybe [(FilePath, [PackageConfig])],
Ian Lynagh's avatar
Ian Lynagh committed
811
  pkgState              :: PackageState,
812

813
814
815
816
  -- Temporary files
  -- These have to be IORefs, because the defaultCleanupHandler needs to
  -- know what to clean when an exception happens
  filesToClean          :: IORef [FilePath],
817
  dirsToClean           :: IORef (Map FilePath FilePath),
818
  filesToNotIntermediateClean :: IORef [FilePath],
819
820
  -- The next available suffix to uniquely name a temp file, updated atomically
  nextTempSuffix        :: IORef Int,
821

822
823
824
  -- 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
825
  generatedDumps        :: IORef (Set FilePath),