Remove -Wredundant-superclasses from standard warnings
[ghc.git] / compiler / main / DynFlags.hs
1 {-# LANGUAGE CPP #-}
2 {-# LANGUAGE FlexibleInstances #-}
3
4 -------------------------------------------------------------------------------
5 --
6 -- | Dynamic flags
7 --
8 -- Most flags are dynamic flags, which means they can change from compilation
9 -- to compilation using @OPTIONS_GHC@ pragmas, and in a multi-session GHC each
10 -- session can be using different dynamic flags. Dynamic flags can also be set
11 -- at the prompt in GHCi.
12 --
13 -- (c) The University of Glasgow 2005
14 --
15 -------------------------------------------------------------------------------
16
17 {-# OPTIONS_GHC -fno-cse #-}
18 -- -fno-cse is needed for GLOBAL_VAR's to behave properly
19
20 module DynFlags (
21 -- * Dynamic flags and associated configuration types
22 DumpFlag(..),
23 GeneralFlag(..),
24 WarningFlag(..),
25 Language(..),
26 PlatformConstants(..),
27 FatalMessager, LogAction, FlushOut(..), FlushErr(..),
28 ProfAuto(..),
29 glasgowExtsFlags,
30 dopt, dopt_set, dopt_unset,
31 gopt, gopt_set, gopt_unset,
32 wopt, wopt_set, wopt_unset,
33 xopt, xopt_set, xopt_unset,
34 lang_set,
35 useUnicodeSyntax,
36 whenGeneratingDynamicToo, ifGeneratingDynamicToo,
37 whenCannotGenerateDynamicToo,
38 dynamicTooMkDynamicDynFlags,
39 DynFlags(..),
40 FlagSpec(..),
41 HasDynFlags(..), ContainsDynFlags(..),
42 RtsOptsEnabled(..),
43 HscTarget(..), isObjectTarget, defaultObjectTarget,
44 targetRetainsAllBindings,
45 GhcMode(..), isOneShot,
46 GhcLink(..), isNoLink,
47 PackageFlag(..), PackageArg(..), ModRenaming(..),
48 IgnorePackageFlag(..), TrustFlag(..),
49 PkgConfRef(..),
50 Option(..), showOpt,
51 DynLibLoader(..),
52 fFlags, fLangFlags, xFlags,
53 wWarningFlags,
54 dynFlagDependencies,
55 tablesNextToCode, mkTablesNextToCode,
56 SigOf, getSigOf,
57 makeDynFlagsConsistent,
58
59 Way(..), mkBuildTag, wayRTSOnly, addWay', updateWays,
60 wayGeneralFlags, wayUnsetGeneralFlags,
61
62 -- ** Safe Haskell
63 SafeHaskellMode(..),
64 safeHaskellOn, safeImportsOn, safeLanguageOn, safeInferOn,
65 packageTrustOn,
66 safeDirectImpsReq, safeImplicitImpsReq,
67 unsafeFlags, unsafeFlagsForInfer,
68
69 -- ** System tool settings and locations
70 Settings(..),
71 targetPlatform, programName, projectVersion,
72 ghcUsagePath, ghciUsagePath, topDir, tmpDir, rawSettings,
73 versionedAppDir,
74 extraGccViaCFlags, systemPackageConfig,
75 pgm_L, pgm_P, pgm_F, pgm_c, pgm_s, pgm_a, pgm_l, pgm_dll, pgm_T,
76 pgm_windres, pgm_libtool, pgm_lo, pgm_lc, pgm_i,
77 opt_L, opt_P, opt_F, opt_c, opt_a, opt_l, opt_i,
78 opt_windres, opt_lo, opt_lc,
79
80
81 -- ** Manipulating DynFlags
82 defaultDynFlags, -- Settings -> DynFlags
83 defaultWays,
84 interpWays,
85 interpreterProfiled, interpreterDynamic,
86 initDynFlags, -- DynFlags -> IO DynFlags
87 defaultFatalMessager,
88 defaultLogAction,
89 defaultLogActionHPrintDoc,
90 defaultLogActionHPutStrDoc,
91 defaultFlushOut,
92 defaultFlushErr,
93
94 getOpts, -- DynFlags -> (DynFlags -> [a]) -> [a]
95 getVerbFlags,
96 updOptLevel,
97 setTmpDir,
98 setUnitId,
99 interpretPackageEnv,
100
101 -- ** Parsing DynFlags
102 parseDynamicFlagsCmdLine,
103 parseDynamicFilePragma,
104 parseDynamicFlagsFull,
105
106 -- ** Available DynFlags
107 allFlags,
108 flagsAll,
109 flagsDynamic,
110 flagsPackage,
111 flagsForCompletion,
112
113 supportedLanguagesAndExtensions,
114 languageExtensions,
115
116 -- ** DynFlags C compiler options
117 picCCOpts, picPOpts,
118
119 -- * Compiler configuration suitable for display to the user
120 compilerInfo,
121
122 #ifdef GHCI
123 rtsIsProfiled,
124 #endif
125 dynamicGhc,
126
127 #include "../includes/dist-derivedconstants/header/GHCConstantsHaskellExports.hs"
128 bLOCK_SIZE_W,
129 wORD_SIZE_IN_BITS,
130 tAG_MASK,
131 mAX_PTR_TAG,
132 tARGET_MIN_INT, tARGET_MAX_INT, tARGET_MAX_WORD,
133
134 unsafeGlobalDynFlags, setUnsafeGlobalDynFlags,
135
136 -- * SSE and AVX
137 isSseEnabled,
138 isSse2Enabled,
139 isSse4_2Enabled,
140 isAvxEnabled,
141 isAvx2Enabled,
142 isAvx512cdEnabled,
143 isAvx512erEnabled,
144 isAvx512fEnabled,
145 isAvx512pfEnabled,
146
147 -- * Linker/compiler information
148 LinkerInfo(..),
149 CompilerInfo(..),
150 ) where
151
152 #include "HsVersions.h"
153
154 import Platform
155 import PlatformConstants
156 import Module
157 import PackageConfig
158 import {-# SOURCE #-} Hooks
159 import {-# SOURCE #-} PrelNames ( mAIN )
160 import {-# SOURCE #-} Packages (PackageState, emptyPackageState)
161 import DriverPhases ( Phase(..), phaseInputExt )
162 import Config
163 import CmdLineParser
164 import Constants
165 import Panic
166 import Util
167 import Maybes
168 import MonadUtils
169 import qualified Pretty
170 import SrcLoc
171 import BasicTypes ( IntWithInf, treatZeroAsInf )
172 import FastString
173 import Outputable
174 import Foreign.C ( CInt(..) )
175 import System.IO.Unsafe ( unsafeDupablePerformIO )
176 import {-# SOURCE #-} ErrUtils ( Severity(..), MsgDoc, mkLocMessage )
177
178 import System.IO.Unsafe ( unsafePerformIO )
179 import Data.IORef
180 import Control.Arrow ((&&&))
181 import Control.Monad
182 import Control.Monad.Trans.Class
183 import Control.Monad.Trans.Writer
184 import Control.Monad.Trans.Reader
185 import Control.Monad.Trans.Except
186 import Control.Exception (throwIO)
187
188 import Data.Bits
189 import Data.Char
190 import Data.Int
191 import Data.List
192 import Data.Map (Map)
193 import qualified Data.Map as Map
194 import Data.Set (Set)
195 import qualified Data.Set as Set
196 import Data.Word
197 import System.FilePath
198 import System.Directory
199 import System.Environment (getEnv)
200 import System.IO
201 import System.IO.Error
202 import Text.ParserCombinators.ReadP hiding (char)
203 import Text.ParserCombinators.ReadP as R
204
205 import Data.IntSet (IntSet)
206 import qualified Data.IntSet as IntSet
207
208 import GHC.Foreign (withCString, peekCString)
209 import qualified GHC.LanguageExtensions as LangExt
210
211 -- Note [Updating flag description in the User's Guide]
212 -- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
213 --
214 -- If you modify anything in this file please make sure that your changes are
215 -- described in the User's Guide. Usually at least two sections need to be
216 -- updated:
217 --
218 -- * Flag Reference section generated from the modules in
219 -- utils/mkUserGuidePart/Options
220 --
221 -- * Flag description in docs/users_guide/using.rst provides a detailed
222 -- explanation of flags' usage.
223
224 -- Note [Supporting CLI completion]
225 -- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
226 --
227 -- The command line interface completion (in for example bash) is an easy way
228 -- for the developer to learn what flags are available from GHC.
229 -- GHC helps by separating which flags are available when compiling with GHC,
230 -- and which flags are available when using GHCi.
231 -- A flag is assumed to either work in both these modes, or only in one of them.
232 -- When adding or changing a flag, please consider for which mode the flag will
233 -- have effect, and annotate it accordingly. For Flags use defFlag, defGhcFlag,
234 -- defGhciFlag, and for FlagSpec use flagSpec or flagGhciSpec.
235
236 -- Note [Adding a language extension]
237 -- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
238 --
239 -- There are a few steps to adding (or removing) a language extension,
240 --
241 -- * Adding the extension to GHC.LanguageExtensions
242 --
243 -- The Extension type in libraries/ghc-boot/GHC/LanguageExtensions.hs is
244 -- the canonical list of language extensions known by GHC.
245 --
246 -- * Adding a flag to DynFlags.xFlags
247 --
248 -- This is fairly self-explanatory. The name should be concise, memorable,
249 -- and consistent with any previous implementations of the similar idea in
250 -- other Haskell compilers.
251 --
252 -- * Adding the flag to the documentation
253 --
254 -- This is the same as any other flag. See
255 -- Note [Updating flag description in the User's Guide]
256 --
257 -- * Adding the flag to Cabal
258 --
259 -- The Cabal library has its own list of all language extensions supported
260 -- by all major compilers. This is the list that user code being uploaded
261 -- to Hackage is checked against to ensure language extension validity.
262 -- Consequently, it is very important that this list remains up-to-date.
263 --
264 -- To this end, there is a testsuite test (testsuite/tests/driver/T4437.hs)
265 -- whose job it is to ensure these GHC's extensions are consistent with
266 -- Cabal.
267 --
268 -- The recommended workflow is,
269 --
270 -- 1. Temporarily add your new language extension to the
271 -- expectedGhcOnlyExtensions list in T4437 to ensure the test doesn't
272 -- break while Cabal is updated.
273 --
274 -- 2. After your GHC change is accepted, submit a Cabal pull request adding
275 -- your new extension to Cabal's list (found in
276 -- Cabal/Language/Haskell/Extension.hs).
277 --
278 -- 3. After your Cabal change is accepted, let the GHC developers know so
279 -- they can update the Cabal submodule and remove the extensions from
280 -- expectedGhcOnlyExtensions.
281 --
282 -- * Adding the flag to the GHC Wiki
283 --
284 -- There is a change log tracking language extension additions and removals
285 -- on the GHC wiki: https://ghc.haskell.org/trac/ghc/wiki/LanguagePragmaHistory
286 --
287 -- See Trac #4437 and #8176.
288
289 -- -----------------------------------------------------------------------------
290 -- DynFlags
291
292 data DumpFlag
293 -- See Note [Updating flag description in the User's Guide]
294
295 -- debugging flags
296 = Opt_D_dump_cmm
297 | Opt_D_dump_cmm_raw
298 -- All of the cmm subflags (there are a lot!) Automatically
299 -- enabled if you run -ddump-cmm
300 | Opt_D_dump_cmm_cfg
301 | Opt_D_dump_cmm_cbe
302 | Opt_D_dump_cmm_switch
303 | Opt_D_dump_cmm_proc
304 | Opt_D_dump_cmm_sink
305 | Opt_D_dump_cmm_sp
306 | Opt_D_dump_cmm_procmap
307 | Opt_D_dump_cmm_split
308 | Opt_D_dump_cmm_info
309 | Opt_D_dump_cmm_cps
310 -- end cmm subflags
311 | Opt_D_dump_asm
312 | Opt_D_dump_asm_native
313 | Opt_D_dump_asm_liveness
314 | Opt_D_dump_asm_regalloc
315 | Opt_D_dump_asm_regalloc_stages
316 | Opt_D_dump_asm_conflicts
317 | Opt_D_dump_asm_stats
318 | Opt_D_dump_asm_expanded
319 | Opt_D_dump_llvm
320 | Opt_D_dump_core_stats
321 | Opt_D_dump_deriv
322 | Opt_D_dump_ds
323 | Opt_D_dump_foreign
324 | Opt_D_dump_inlinings
325 | Opt_D_dump_rule_firings
326 | Opt_D_dump_rule_rewrites
327 | Opt_D_dump_simpl_trace
328 | Opt_D_dump_occur_anal
329 | Opt_D_dump_parsed
330 | Opt_D_dump_rn
331 | Opt_D_dump_simpl
332 | Opt_D_dump_simpl_iterations
333 | Opt_D_dump_spec
334 | Opt_D_dump_prep
335 | Opt_D_dump_stg
336 | Opt_D_dump_call_arity
337 | Opt_D_dump_stranal
338 | Opt_D_dump_strsigs
339 | Opt_D_dump_tc
340 | Opt_D_dump_types
341 | Opt_D_dump_rules
342 | Opt_D_dump_cse
343 | Opt_D_dump_worker_wrapper
344 | Opt_D_dump_rn_trace
345 | Opt_D_dump_rn_stats
346 | Opt_D_dump_opt_cmm
347 | Opt_D_dump_simpl_stats
348 | Opt_D_dump_cs_trace -- Constraint solver in type checker
349 | Opt_D_dump_tc_trace
350 | Opt_D_dump_if_trace
351 | Opt_D_dump_vt_trace
352 | Opt_D_dump_splices
353 | Opt_D_th_dec_file
354 | Opt_D_dump_BCOs
355 | Opt_D_dump_vect
356 | Opt_D_dump_ticked
357 | Opt_D_dump_rtti
358 | Opt_D_source_stats
359 | Opt_D_verbose_stg2stg
360 | Opt_D_dump_hi
361 | Opt_D_dump_hi_diffs
362 | Opt_D_dump_mod_cycles
363 | Opt_D_dump_mod_map
364 | Opt_D_dump_view_pattern_commoning
365 | Opt_D_verbose_core2core
366 | Opt_D_dump_debug
367
368 deriving (Eq, Show, Enum)
369
370 -- | Enumerates the simple on-or-off dynamic flags
371 data GeneralFlag
372 -- See Note [Updating flag description in the User's Guide]
373
374 = Opt_DumpToFile -- ^ Append dump output to files instead of stdout.
375 | Opt_D_faststring_stats
376 | Opt_D_dump_minimal_imports
377 | Opt_DoCoreLinting
378 | Opt_DoStgLinting
379 | Opt_DoCmmLinting
380 | Opt_DoAsmLinting
381 | Opt_DoAnnotationLinting
382 | Opt_NoLlvmMangler -- hidden flag
383
384 | Opt_WarnIsError -- -Werror; makes warnings fatal
385
386 | Opt_PrintExplicitForalls
387 | Opt_PrintExplicitKinds
388 | Opt_PrintExplicitCoercions
389 | Opt_PrintEqualityRelations
390 | Opt_PrintUnicodeSyntax
391 | Opt_PrintExpandedSynonyms
392 | Opt_PrintPotentialInstances
393 | Opt_PrintTypecheckerElaboration
394
395 -- optimisation opts
396 | Opt_CallArity
397 | Opt_Strictness
398 | Opt_LateDmdAnal
399 | Opt_KillAbsence
400 | Opt_KillOneShot
401 | Opt_FullLaziness
402 | Opt_FloatIn
403 | Opt_Specialise
404 | Opt_SpecialiseAggressively
405 | Opt_CrossModuleSpecialise
406 | Opt_StaticArgumentTransformation
407 | Opt_CSE
408 | Opt_LiberateCase
409 | Opt_SpecConstr
410 | Opt_DoLambdaEtaExpansion
411 | Opt_IgnoreAsserts
412 | Opt_DoEtaReduction
413 | Opt_CaseMerge
414 | Opt_UnboxStrictFields
415 | Opt_UnboxSmallStrictFields
416 | Opt_DictsCheap
417 | Opt_EnableRewriteRules -- Apply rewrite rules during simplification
418 | Opt_Vectorise
419 | Opt_VectorisationAvoidance
420 | Opt_RegsGraph -- do graph coloring register allocation
421 | Opt_RegsIterative -- do iterative coalescing graph coloring register allocation
422 | Opt_PedanticBottoms -- Be picky about how we treat bottom
423 | Opt_LlvmTBAA -- Use LLVM TBAA infastructure for improving AA (hidden flag)
424 | Opt_LlvmPassVectorsInRegisters -- Pass SIMD vectors in registers (requires a patched LLVM) (hidden flag)
425 | Opt_IrrefutableTuples
426 | Opt_CmmSink
427 | Opt_CmmElimCommonBlocks
428 | Opt_OmitYields
429 | Opt_SimpleListLiterals
430 | Opt_FunToThunk -- allow WwLib.mkWorkerArgs to remove all value lambdas
431 | Opt_DictsStrict -- be strict in argument dictionaries
432 | Opt_DmdTxDictSel -- use a special demand transformer for dictionary selectors
433 | Opt_Loopification -- See Note [Self-recursive tail calls]
434 | Opt_CprAnal
435 | Opt_WorkerWrapper
436
437 -- Interface files
438 | Opt_IgnoreInterfacePragmas
439 | Opt_OmitInterfacePragmas
440 | Opt_ExposeAllUnfoldings
441 | Opt_WriteInterface -- forces .hi files to be written even with -fno-code
442
443 -- profiling opts
444 | Opt_AutoSccsOnIndividualCafs
445 | Opt_ProfCountEntries
446
447 -- misc opts
448 | Opt_Pp
449 | Opt_ForceRecomp
450 | Opt_ExcessPrecision
451 | Opt_EagerBlackHoling
452 | Opt_NoHsMain
453 | Opt_SplitObjs
454 | Opt_SplitSections
455 | Opt_StgStats
456 | Opt_HideAllPackages
457 | Opt_HideAllPluginPackages
458 | Opt_PrintBindResult
459 | Opt_Haddock
460 | Opt_HaddockOptions
461 | Opt_BreakOnException
462 | Opt_BreakOnError
463 | Opt_PrintEvldWithShow
464 | Opt_PrintBindContents
465 | Opt_GenManifest
466 | Opt_EmbedManifest
467 | Opt_SharedImplib
468 | Opt_BuildingCabalPackage
469 | Opt_IgnoreDotGhci
470 | Opt_GhciSandbox
471 | Opt_GhciHistory
472 | Opt_HelpfulErrors
473 | Opt_DeferTypeErrors
474 | Opt_DeferTypedHoles
475 | Opt_PIC
476 | Opt_SccProfilingOn
477 | Opt_Ticky
478 | Opt_Ticky_Allocd
479 | Opt_Ticky_LNE
480 | Opt_Ticky_Dyn_Thunk
481 | Opt_RPath
482 | Opt_RelativeDynlibPaths
483 | Opt_Hpc
484 | Opt_FlatCache
485 | Opt_ExternalInterpreter
486
487 -- PreInlining is on by default. The option is there just to see how
488 -- bad things get if you turn it off!
489 | Opt_SimplPreInlining
490
491 -- output style opts
492 | Opt_ErrorSpans -- Include full span info in error messages,
493 -- instead of just the start position.
494 | Opt_PprCaseAsLet
495 | Opt_PprShowTicks
496
497 -- Suppress all coercions, them replacing with '...'
498 | Opt_SuppressCoercions
499 | Opt_SuppressVarKinds
500 -- Suppress module id prefixes on variables.
501 | Opt_SuppressModulePrefixes
502 -- Suppress type applications.
503 | Opt_SuppressTypeApplications
504 -- Suppress info such as arity and unfoldings on identifiers.
505 | Opt_SuppressIdInfo
506 -- Suppress separate type signatures in core, but leave types on
507 -- lambda bound vars
508 | Opt_SuppressUnfoldings
509 -- Suppress the details of even stable unfoldings
510 | Opt_SuppressTypeSignatures
511 -- Suppress unique ids on variables.
512 -- Except for uniques, as some simplifier phases introduce new
513 -- variables that have otherwise identical names.
514 | Opt_SuppressUniques
515
516 -- temporary flags
517 | Opt_AutoLinkPackages
518 | Opt_ImplicitImportQualified
519
520 -- keeping stuff
521 | Opt_KeepHiDiffs
522 | Opt_KeepHcFiles
523 | Opt_KeepSFiles
524 | Opt_KeepTmpFiles
525 | Opt_KeepRawTokenStream
526 | Opt_KeepLlvmFiles
527
528 | Opt_BuildDynamicToo
529
530 -- safe haskell flags
531 | Opt_DistrustAllPackages
532 | Opt_PackageTrust
533
534 -- pm checking with guards
535 | Opt_FullGuardReasoning
536 deriving (Eq, Show, Enum)
537
538 data WarningFlag =
539 -- See Note [Updating flag description in the User's Guide]
540 Opt_WarnDuplicateExports
541 | Opt_WarnDuplicateConstraints
542 | Opt_WarnRedundantConstraints
543 | Opt_WarnHiShadows
544 | Opt_WarnImplicitPrelude
545 | Opt_WarnIncompletePatterns
546 | Opt_WarnIncompleteUniPatterns
547 | Opt_WarnIncompletePatternsRecUpd
548 | Opt_WarnOverflowedLiterals
549 | Opt_WarnEmptyEnumerations
550 | Opt_WarnMissingFields
551 | Opt_WarnMissingImportList
552 | Opt_WarnMissingMethods
553 | Opt_WarnMissingSigs
554 | Opt_WarnMissingLocalSigs
555 | Opt_WarnNameShadowing
556 | Opt_WarnOverlappingPatterns
557 | Opt_WarnTooManyGuards
558 | Opt_WarnTypeDefaults
559 | Opt_WarnMonomorphism
560 | Opt_WarnUnusedTopBinds
561 | Opt_WarnUnusedLocalBinds
562 | Opt_WarnUnusedPatternBinds
563 | Opt_WarnUnusedImports
564 | Opt_WarnUnusedMatches
565 | Opt_WarnContextQuantification -- remove in 8.2
566 | Opt_WarnWarningsDeprecations
567 | Opt_WarnDeprecatedFlags
568 | Opt_WarnAMP -- Introduced in GHC 7.8, obsolete since 7.10
569 | Opt_WarnMissingMonadFailInstance -- since 8.0
570 | Opt_WarnSemigroup -- since 8.0
571 | Opt_WarnDodgyExports
572 | Opt_WarnDodgyImports
573 | Opt_WarnOrphans
574 | Opt_WarnAutoOrphans
575 | Opt_WarnIdentities
576 | Opt_WarnTabs
577 | Opt_WarnUnrecognisedPragmas
578 | Opt_WarnDodgyForeignImports
579 | Opt_WarnUnusedDoBind
580 | Opt_WarnWrongDoBind
581 | Opt_WarnAlternativeLayoutRuleTransitional
582 | Opt_WarnUnsafe
583 | Opt_WarnSafe
584 | Opt_WarnTrustworthySafe
585 | Opt_WarnMissedSpecs
586 | Opt_WarnAllMissedSpecs
587 | Opt_WarnUnsupportedCallingConventions
588 | Opt_WarnUnsupportedLlvmVersion
589 | Opt_WarnInlineRuleShadowing
590 | Opt_WarnTypedHoles
591 | Opt_WarnPartialTypeSignatures
592 | Opt_WarnMissingExportedSigs
593 | Opt_WarnUntickedPromotedConstructors
594 | Opt_WarnDerivingTypeable
595 | Opt_WarnDeferredTypeErrors
596 | Opt_WarnNonCanonicalMonadInstances -- since 8.0
597 | Opt_WarnNonCanonicalMonoidInstances -- since 8.0
598 | Opt_WarnMissingPatSynSigs -- since 8.0
599 deriving (Eq, Show, Enum)
600
601 data Language = Haskell98 | Haskell2010
602 deriving Enum
603
604 -- | The various Safe Haskell modes
605 data SafeHaskellMode
606 = Sf_None
607 | Sf_Unsafe
608 | Sf_Trustworthy
609 | Sf_Safe
610 deriving (Eq)
611
612 instance Show SafeHaskellMode where
613 show Sf_None = "None"
614 show Sf_Unsafe = "Unsafe"
615 show Sf_Trustworthy = "Trustworthy"
616 show Sf_Safe = "Safe"
617
618 instance Outputable SafeHaskellMode where
619 ppr = text . show
620
621 type SigOf = Map ModuleName Module
622
623 getSigOf :: DynFlags -> ModuleName -> Maybe Module
624 getSigOf dflags n = Map.lookup n (sigOf dflags)
625
626 -- | Contains not only a collection of 'GeneralFlag's but also a plethora of
627 -- information relating to the compilation of a single file or GHC session
628 data DynFlags = DynFlags {
629 ghcMode :: GhcMode,
630 ghcLink :: GhcLink,
631 hscTarget :: HscTarget,
632 settings :: Settings,
633 -- See Note [Signature parameters in TcGblEnv and DynFlags]
634 sigOf :: SigOf, -- ^ Compiling an hs-boot against impl.
635 verbosity :: Int, -- ^ Verbosity level: see Note [Verbosity levels]
636 optLevel :: Int, -- ^ Optimisation level
637 debugLevel :: Int, -- ^ How much debug information to produce
638 simplPhases :: Int, -- ^ Number of simplifier phases
639 maxSimplIterations :: Int, -- ^ Max simplifier iterations
640 ruleCheck :: Maybe String,
641 strictnessBefore :: [Int], -- ^ Additional demand analysis
642
643 parMakeCount :: Maybe Int, -- ^ The number of modules to compile in parallel
644 -- in --make mode, where Nothing ==> compile as
645 -- many in parallel as there are CPUs.
646
647 enableTimeStats :: Bool, -- ^ Enable RTS timing statistics?
648 ghcHeapSize :: Maybe Int, -- ^ The heap size to set.
649
650 maxRelevantBinds :: Maybe Int, -- ^ Maximum number of bindings from the type envt
651 -- to show in type error messages
652 simplTickFactor :: Int, -- ^ Multiplier for simplifier ticks
653 specConstrThreshold :: Maybe Int, -- ^ Threshold for SpecConstr
654 specConstrCount :: Maybe Int, -- ^ Max number of specialisations for any one function
655 specConstrRecursive :: Int, -- ^ Max number of specialisations for recursive types
656 -- Not optional; otherwise ForceSpecConstr can diverge.
657 liberateCaseThreshold :: Maybe Int, -- ^ Threshold for LiberateCase
658 floatLamArgs :: Maybe Int, -- ^ Arg count for lambda floating
659 -- See CoreMonad.FloatOutSwitches
660
661 historySize :: Int,
662
663 cmdlineHcIncludes :: [String], -- ^ @\-\#includes@
664 importPaths :: [FilePath],
665 mainModIs :: Module,
666 mainFunIs :: Maybe String,
667 reductionDepth :: IntWithInf, -- ^ Typechecker maximum stack depth
668 solverIterations :: IntWithInf, -- ^ Number of iterations in the constraints solver
669 -- Typically only 1 is needed
670
671 thisPackage :: UnitId, -- ^ key of package currently being compiled
672
673 -- ways
674 ways :: [Way], -- ^ Way flags from the command line
675 buildTag :: String, -- ^ The global \"way\" (e.g. \"p\" for prof)
676 rtsBuildTag :: String, -- ^ The RTS \"way\"
677
678 -- For object splitting
679 splitInfo :: Maybe (String,Int),
680
681 -- paths etc.
682 objectDir :: Maybe String,
683 dylibInstallName :: Maybe String,
684 hiDir :: Maybe String,
685 stubDir :: Maybe String,
686 dumpDir :: Maybe String,
687
688 objectSuf :: String,
689 hcSuf :: String,
690 hiSuf :: String,
691
692 canGenerateDynamicToo :: IORef Bool,
693 dynObjectSuf :: String,
694 dynHiSuf :: String,
695
696 -- Packages.isDllName needs to know whether a call is within a
697 -- single DLL or not. Normally it does this by seeing if the call
698 -- is to the same package, but for the ghc package, we split the
699 -- package between 2 DLLs. The dllSplit tells us which sets of
700 -- modules are in which package.
701 dllSplitFile :: Maybe FilePath,
702 dllSplit :: Maybe [Set String],
703
704 outputFile :: Maybe String,
705 dynOutputFile :: Maybe String,
706 outputHi :: Maybe String,
707 dynLibLoader :: DynLibLoader,
708
709 -- | This is set by 'DriverPipeline.runPipeline' based on where
710 -- its output is going.
711 dumpPrefix :: Maybe FilePath,
712
713 -- | Override the 'dumpPrefix' set by 'DriverPipeline.runPipeline'.
714 -- Set by @-ddump-file-prefix@
715 dumpPrefixForce :: Maybe FilePath,
716
717 ldInputs :: [Option],
718
719 includePaths :: [String],
720 libraryPaths :: [String],
721 frameworkPaths :: [String], -- used on darwin only
722 cmdlineFrameworks :: [String], -- ditto
723
724 rtsOpts :: Maybe String,
725 rtsOptsEnabled :: RtsOptsEnabled,
726 rtsOptsSuggestions :: Bool,
727
728 hpcDir :: String, -- ^ Path to store the .mix files
729
730 -- Plugins
731 pluginModNames :: [ModuleName],
732 pluginModNameOpts :: [(ModuleName,String)],
733 frontendPluginOpts :: [String],
734
735 -- GHC API hooks
736 hooks :: Hooks,
737
738 -- For ghc -M
739 depMakefile :: FilePath,
740 depIncludePkgDeps :: Bool,
741 depExcludeMods :: [ModuleName],
742 depSuffixes :: [String],
743
744 -- Package flags
745 extraPkgConfs :: [PkgConfRef] -> [PkgConfRef],
746 -- ^ The @-package-db@ flags given on the command line, in the order
747 -- they appeared.
748
749 ignorePackageFlags :: [IgnorePackageFlag],
750 -- ^ The @-ignore-package@ flags from the command line
751 packageFlags :: [PackageFlag],
752 -- ^ The @-package@ and @-hide-package@ flags from the command-line
753 pluginPackageFlags :: [PackageFlag],
754 -- ^ The @-plugin-package-id@ flags from command line
755 trustFlags :: [TrustFlag],
756 -- ^ The @-trust@ and @-distrust@ flags
757 packageEnv :: Maybe FilePath,
758 -- ^ Filepath to the package environment file (if overriding default)
759
760 -- Package state
761 -- NB. do not modify this field, it is calculated by
762 -- Packages.initPackages
763 pkgDatabase :: Maybe [(FilePath, [PackageConfig])],
764 pkgState :: PackageState,
765
766 -- Temporary files
767 -- These have to be IORefs, because the defaultCleanupHandler needs to
768 -- know what to clean when an exception happens
769 filesToClean :: IORef [FilePath],
770 dirsToClean :: IORef (Map FilePath FilePath),
771 filesToNotIntermediateClean :: IORef [FilePath],
772 -- The next available suffix to uniquely name a temp file, updated atomically
773 nextTempSuffix :: IORef Int,
774
775 -- Names of files which were generated from -ddump-to-file; used to
776 -- track which ones we need to truncate because it's our first run
777 -- through
778 generatedDumps :: IORef (Set FilePath),
779
780 -- hsc dynamic flags
781 dumpFlags :: IntSet,
782 generalFlags :: IntSet,
783 warningFlags :: IntSet,
784 -- Don't change this without updating extensionFlags:
785 language :: Maybe Language,
786 -- | Safe Haskell mode
787 safeHaskell :: SafeHaskellMode,
788 safeInfer :: Bool,
789 safeInferred :: Bool,
790 -- We store the location of where some extension and flags were turned on so
791 -- we can produce accurate error messages when Safe Haskell fails due to
792 -- them.
793 thOnLoc :: SrcSpan,
794 newDerivOnLoc :: SrcSpan,
795 overlapInstLoc :: SrcSpan,
796 incoherentOnLoc :: SrcSpan,
797 pkgTrustOnLoc :: SrcSpan,
798 warnSafeOnLoc :: SrcSpan,
799 warnUnsafeOnLoc :: SrcSpan,
800 trustworthyOnLoc :: SrcSpan,
801 -- Don't change this without updating extensionFlags:
802 extensions :: [OnOff LangExt.Extension],
803 -- extensionFlags should always be equal to
804 -- flattenExtensionFlags language extensions
805 -- LangExt.Extension is defined in libraries/ghc-boot so that it can be used
806 -- by template-haskell
807 extensionFlags :: IntSet,
808
809 -- Unfolding control
810 -- See Note [Discounts and thresholds] in CoreUnfold
811 ufCreationThreshold :: Int,
812 ufUseThreshold :: Int,
813 ufFunAppDiscount :: Int,
814 ufDictDiscount :: Int,
815 ufKeenessFactor :: Float,
816 ufDearOp :: Int,
817
818 maxWorkerArgs :: Int,
819
820 ghciHistSize :: Int,
821
822 -- | MsgDoc output action: use "ErrUtils" instead of this if you can
823 log_action :: LogAction,
824 flushOut :: FlushOut,
825 flushErr :: FlushErr,
826
827 haddockOptions :: Maybe String,
828
829 -- | GHCi scripts specified by -ghci-script, in reverse order
830 ghciScripts :: [String],
831
832 -- Output style options
833 pprUserLength :: Int,
834 pprCols :: Int,
835 traceLevel :: Int, -- Standard level is 1. Less verbose is 0.
836
837 useUnicode :: Bool,
838
839 -- | what kind of {-# SCC #-} to add automatically
840 profAuto :: ProfAuto,
841
842 interactivePrint :: Maybe String,
843
844 nextWrapperNum :: IORef (ModuleEnv Int),
845
846 -- | Machine dependant flags (-m<blah> stuff)
847 sseVersion :: Maybe SseVersion,
848 avx :: Bool,
849 avx2 :: Bool,
850 avx512cd :: Bool, -- Enable AVX-512 Conflict Detection Instructions.
851 avx512er :: Bool, -- Enable AVX-512 Exponential and Reciprocal Instructions.
852 avx512f :: Bool, -- Enable AVX-512 instructions.
853 avx512pf :: Bool, -- Enable AVX-512 PreFetch Instructions.
854
855 -- | Run-time linker information (what options we need, etc.)
856 rtldInfo :: IORef (Maybe LinkerInfo),
857
858 -- | Run-time compiler information
859 rtccInfo :: IORef (Maybe CompilerInfo),
860
861 -- Constants used to control the amount of optimization done.
862
863 -- | Max size, in bytes, of inline array allocations.
864 maxInlineAllocSize :: Int,
865
866 -- | Only inline memcpy if it generates no more than this many
867 -- pseudo (roughly: Cmm) instructions.
868 maxInlineMemcpyInsns :: Int,
869
870 -- | Only inline memset if it generates no more than this many
871 -- pseudo (roughly: Cmm) instructions.
872 maxInlineMemsetInsns :: Int,
873
874 -- | Reverse the order of error messages in GHC/GHCi
875 reverseErrors :: Bool,
876
877 -- | Unique supply configuration for testing build determinism
878 initialUnique :: Int,
879 uniqueIncrement :: Int
880 }
881
882 class HasDynFlags m where
883 getDynFlags :: m DynFlags
884
885 {- It would be desirable to have the more generalised
886
887 instance (MonadTrans t, Monad m, HasDynFlags m) => HasDynFlags (t m) where
888 getDynFlags = lift getDynFlags
889
890 instance definition. However, that definition would overlap with the
891 `HasDynFlags (GhcT m)` instance. Instead we define instances for a
892 couple of common Monad transformers explicitly. -}
893
894 instance (Monoid a, Monad m, HasDynFlags m) => HasDynFlags (WriterT a m) where
895 getDynFlags = lift getDynFlags
896
897 instance (Monad m, HasDynFlags m) => HasDynFlags (ReaderT a m) where
898 getDynFlags = lift getDynFlags
899
900 instance (Monad m, HasDynFlags m) => HasDynFlags (MaybeT m) where
901 getDynFlags = lift getDynFlags
902
903 instance (Monad m, HasDynFlags m) => HasDynFlags (ExceptT e m) where
904 getDynFlags = lift getDynFlags
905
906 class ContainsDynFlags t where
907 extractDynFlags :: t -> DynFlags
908 replaceDynFlags :: t -> DynFlags -> t
909
910 data ProfAuto
911 = NoProfAuto -- ^ no SCC annotations added
912 | ProfAutoAll -- ^ top-level and nested functions are annotated
913 | ProfAutoTop -- ^ top-level functions annotated only
914 | ProfAutoExports -- ^ exported functions annotated only
915 | ProfAutoCalls -- ^ annotate call-sites
916 deriving (Eq,Enum)
917
918 data Settings = Settings {
919 sTargetPlatform :: Platform, -- Filled in by SysTools
920 sGhcUsagePath :: FilePath, -- Filled in by SysTools
921 sGhciUsagePath :: FilePath, -- ditto
922 sTopDir :: FilePath,
923 sTmpDir :: String, -- no trailing '/'
924 sProgramName :: String,
925 sProjectVersion :: String,
926 -- You shouldn't need to look things up in rawSettings directly.
927 -- They should have their own fields instead.
928 sRawSettings :: [(String, String)],
929 sExtraGccViaCFlags :: [String],
930 sSystemPackageConfig :: FilePath,
931 sLdSupportsCompactUnwind :: Bool,
932 sLdSupportsBuildId :: Bool,
933 sLdSupportsFilelist :: Bool,
934 sLdIsGnuLd :: Bool,
935 -- commands for particular phases
936 sPgm_L :: String,
937 sPgm_P :: (String,[Option]),
938 sPgm_F :: String,
939 sPgm_c :: (String,[Option]),
940 sPgm_s :: (String,[Option]),
941 sPgm_a :: (String,[Option]),
942 sPgm_l :: (String,[Option]),
943 sPgm_dll :: (String,[Option]),
944 sPgm_T :: String,
945 sPgm_windres :: String,
946 sPgm_libtool :: String,
947 sPgm_lo :: (String,[Option]), -- LLVM: opt llvm optimiser
948 sPgm_lc :: (String,[Option]), -- LLVM: llc static compiler
949 sPgm_i :: String,
950 -- options for particular phases
951 sOpt_L :: [String],
952 sOpt_P :: [String],
953 sOpt_F :: [String],
954 sOpt_c :: [String],
955 sOpt_a :: [String],
956 sOpt_l :: [String],
957 sOpt_windres :: [String],
958 sOpt_lo :: [String], -- LLVM: llvm optimiser
959 sOpt_lc :: [String], -- LLVM: llc static compiler
960 sOpt_i :: [String], -- iserv options
961
962 sPlatformConstants :: PlatformConstants
963 }
964
965 targetPlatform :: DynFlags -> Platform
966 targetPlatform dflags = sTargetPlatform (settings dflags)
967 programName :: DynFlags -> String
968 programName dflags = sProgramName (settings dflags)
969 projectVersion :: DynFlags -> String
970 projectVersion dflags = sProjectVersion (settings dflags)
971 ghcUsagePath :: DynFlags -> FilePath
972 ghcUsagePath dflags = sGhcUsagePath (settings dflags)
973 ghciUsagePath :: DynFlags -> FilePath
974 ghciUsagePath dflags = sGhciUsagePath (settings dflags)
975 topDir :: DynFlags -> FilePath
976 topDir dflags = sTopDir (settings dflags)
977 tmpDir :: DynFlags -> String
978 tmpDir dflags = sTmpDir (settings dflags)
979 rawSettings :: DynFlags -> [(String, String)]
980 rawSettings dflags = sRawSettings (settings dflags)
981 extraGccViaCFlags :: DynFlags -> [String]
982 extraGccViaCFlags dflags = sExtraGccViaCFlags (settings dflags)
983 systemPackageConfig :: DynFlags -> FilePath
984 systemPackageConfig dflags = sSystemPackageConfig (settings dflags)
985 pgm_L :: DynFlags -> String
986 pgm_L dflags = sPgm_L (settings dflags)
987 pgm_P :: DynFlags -> (String,[Option])
988 pgm_P dflags = sPgm_P (settings dflags)
989 pgm_F :: DynFlags -> String
990 pgm_F dflags = sPgm_F (settings dflags)
991 pgm_c :: DynFlags -> (String,[Option])
992 pgm_c dflags = sPgm_c (settings dflags)
993 pgm_s :: DynFlags -> (String,[Option])
994 pgm_s dflags = sPgm_s (settings dflags)
995 pgm_a :: DynFlags -> (String,[Option])
996 pgm_a dflags = sPgm_a (settings dflags)
997 pgm_l :: DynFlags -> (String,[Option])
998 pgm_l dflags = sPgm_l (settings dflags)
999 pgm_dll :: DynFlags -> (String,[Option])
1000 pgm_dll dflags = sPgm_dll (settings dflags)
1001 pgm_T :: DynFlags -> String
1002 pgm_T dflags = sPgm_T (settings dflags)
1003 pgm_windres :: DynFlags -> String
1004 pgm_windres dflags = sPgm_windres (settings dflags)
1005 pgm_libtool :: DynFlags -> String
1006 pgm_libtool dflags = sPgm_libtool (settings dflags)
1007 pgm_lo :: DynFlags -> (String,[Option])
1008 pgm_lo dflags = sPgm_lo (settings dflags)
1009 pgm_lc :: DynFlags -> (String,[Option])
1010 pgm_lc dflags = sPgm_lc (settings dflags)
1011 pgm_i :: DynFlags -> String
1012 pgm_i dflags = sPgm_i (settings dflags)
1013 opt_L :: DynFlags -> [String]
1014 opt_L dflags = sOpt_L (settings dflags)
1015 opt_P :: DynFlags -> [String]
1016 opt_P dflags = concatMap (wayOptP (targetPlatform dflags)) (ways dflags)
1017 ++ sOpt_P (settings dflags)
1018 opt_F :: DynFlags -> [String]
1019 opt_F dflags = sOpt_F (settings dflags)
1020 opt_c :: DynFlags -> [String]
1021 opt_c dflags = concatMap (wayOptc (targetPlatform dflags)) (ways dflags)
1022 ++ sOpt_c (settings dflags)
1023 opt_a :: DynFlags -> [String]
1024 opt_a dflags = sOpt_a (settings dflags)
1025 opt_l :: DynFlags -> [String]
1026 opt_l dflags = concatMap (wayOptl (targetPlatform dflags)) (ways dflags)
1027 ++ sOpt_l (settings dflags)
1028 opt_windres :: DynFlags -> [String]
1029 opt_windres dflags = sOpt_windres (settings dflags)
1030 opt_lo :: DynFlags -> [String]
1031 opt_lo dflags = sOpt_lo (settings dflags)
1032 opt_lc :: DynFlags -> [String]
1033 opt_lc dflags = sOpt_lc (settings dflags)
1034 opt_i :: DynFlags -> [String]
1035 opt_i dflags = sOpt_i (settings dflags)
1036
1037 -- | The directory for this version of ghc in the user's app directory
1038 -- (typically something like @~/.ghc/x86_64-linux-7.6.3@)
1039 --
1040 versionedAppDir :: DynFlags -> IO FilePath
1041 versionedAppDir dflags = do
1042 appdir <- getAppUserDataDirectory (programName dflags)
1043 return $ appdir </> versionedFilePath dflags
1044
1045 -- | A filepath like @x86_64-linux-7.6.3@ with the platform string to use when
1046 -- constructing platform-version-dependent files that need to co-exist.
1047 --
1048 versionedFilePath :: DynFlags -> FilePath
1049 versionedFilePath dflags = TARGET_ARCH
1050 ++ '-':TARGET_OS
1051 ++ '-':projectVersion dflags
1052 -- NB: This functionality is reimplemented in Cabal, so if you
1053 -- change it, be sure to update Cabal.
1054
1055 -- | The target code type of the compilation (if any).
1056 --
1057 -- Whenever you change the target, also make sure to set 'ghcLink' to
1058 -- something sensible.
1059 --
1060 -- 'HscNothing' can be used to avoid generating any output, however, note
1061 -- that:
1062 --
1063 -- * If a program uses Template Haskell the typechecker may try to run code
1064 -- from an imported module. This will fail if no code has been generated
1065 -- for this module. You can use 'GHC.needsTemplateHaskell' to detect
1066 -- whether this might be the case and choose to either switch to a
1067 -- different target or avoid typechecking such modules. (The latter may be
1068 -- preferable for security reasons.)
1069 --
1070 data HscTarget
1071 = HscC -- ^ Generate C code.
1072 | HscAsm -- ^ Generate assembly using the native code generator.
1073 | HscLlvm -- ^ Generate assembly using the llvm code generator.
1074 | HscInterpreted -- ^ Generate bytecode. (Requires 'LinkInMemory')
1075 | HscNothing -- ^ Don't generate any code. See notes above.
1076 deriving (Eq, Show)
1077
1078 -- | Will this target result in an object file on the disk?
1079 isObjectTarget :: HscTarget -> Bool
1080 isObjectTarget HscC = True
1081 isObjectTarget HscAsm = True
1082 isObjectTarget HscLlvm = True
1083 isObjectTarget _ = False
1084
1085 -- | Does this target retain *all* top-level bindings for a module,
1086 -- rather than just the exported bindings, in the TypeEnv and compiled
1087 -- code (if any)? In interpreted mode we do this, so that GHCi can
1088 -- call functions inside a module. In HscNothing mode we also do it,
1089 -- so that Haddock can get access to the GlobalRdrEnv for a module
1090 -- after typechecking it.
1091 targetRetainsAllBindings :: HscTarget -> Bool
1092 targetRetainsAllBindings HscInterpreted = True
1093 targetRetainsAllBindings HscNothing = True
1094 targetRetainsAllBindings _ = False
1095
1096 -- | The 'GhcMode' tells us whether we're doing multi-module
1097 -- compilation (controlled via the "GHC" API) or one-shot
1098 -- (single-module) compilation. This makes a difference primarily to
1099 -- the "Finder": in one-shot mode we look for interface files for
1100 -- imported modules, but in multi-module mode we look for source files
1101 -- in order to check whether they need to be recompiled.
1102 data GhcMode
1103 = CompManager -- ^ @\-\-make@, GHCi, etc.
1104 | OneShot -- ^ @ghc -c Foo.hs@
1105 | MkDepend -- ^ @ghc -M@, see "Finder" for why we need this
1106 deriving Eq
1107
1108 instance Outputable GhcMode where
1109 ppr CompManager = text "CompManager"
1110 ppr OneShot = text "OneShot"
1111 ppr MkDepend = text "MkDepend"
1112
1113 isOneShot :: GhcMode -> Bool
1114 isOneShot OneShot = True
1115 isOneShot _other = False
1116
1117 -- | What to do in the link step, if there is one.
1118 data GhcLink
1119 = NoLink -- ^ Don't link at all
1120 | LinkBinary -- ^ Link object code into a binary
1121 | LinkInMemory -- ^ Use the in-memory dynamic linker (works for both
1122 -- bytecode and object code).
1123 | LinkDynLib -- ^ Link objects into a dynamic lib (DLL on Windows, DSO on ELF platforms)
1124 | LinkStaticLib -- ^ Link objects into a static lib
1125 deriving (Eq, Show)
1126
1127 isNoLink :: GhcLink -> Bool
1128 isNoLink NoLink = True
1129 isNoLink _ = False
1130
1131 -- | We accept flags which make packages visible, but how they select
1132 -- the package varies; this data type reflects what selection criterion
1133 -- is used.
1134 data PackageArg =
1135 PackageArg String -- ^ @-package@, by 'PackageName'
1136 | UnitIdArg String -- ^ @-package-id@, by 'UnitId'
1137 deriving (Eq, Show)
1138
1139 -- | Represents the renaming that may be associated with an exposed
1140 -- package, e.g. the @rns@ part of @-package "foo (rns)"@.
1141 --
1142 -- Here are some example parsings of the package flags (where
1143 -- a string literal is punned to be a 'ModuleName':
1144 --
1145 -- * @-package foo@ is @ModRenaming True []@
1146 -- * @-package foo ()@ is @ModRenaming False []@
1147 -- * @-package foo (A)@ is @ModRenaming False [("A", "A")]@
1148 -- * @-package foo (A as B)@ is @ModRenaming False [("A", "B")]@
1149 -- * @-package foo with (A as B)@ is @ModRenaming True [("A", "B")]@
1150 data ModRenaming = ModRenaming {
1151 modRenamingWithImplicit :: Bool, -- ^ Bring all exposed modules into scope?
1152 modRenamings :: [(ModuleName, ModuleName)] -- ^ Bring module @m@ into scope
1153 -- under name @n@.
1154 } deriving (Eq)
1155
1156 -- | Flags for manipulating the set of non-broken packages.
1157 newtype IgnorePackageFlag = IgnorePackage String -- ^ @-ignore-package@
1158 deriving (Eq)
1159
1160 -- | Flags for manipulating package trust.
1161 data TrustFlag
1162 = TrustPackage String -- ^ @-trust@
1163 | DistrustPackage String -- ^ @-distrust@
1164 deriving (Eq)
1165
1166 -- | Flags for manipulating packages visibility.
1167 data PackageFlag
1168 = ExposePackage String PackageArg ModRenaming -- ^ @-package@, @-package-id@
1169 | HidePackage String -- ^ @-hide-package@
1170 deriving (Eq)
1171 -- NB: equality instance is used by InteractiveUI to test if
1172 -- package flags have changed.
1173
1174 defaultHscTarget :: Platform -> HscTarget
1175 defaultHscTarget = defaultObjectTarget
1176
1177 -- | The 'HscTarget' value corresponding to the default way to create
1178 -- object files on the current platform.
1179 defaultObjectTarget :: Platform -> HscTarget
1180 defaultObjectTarget platform
1181 | platformUnregisterised platform = HscC
1182 | cGhcWithNativeCodeGen == "YES" = HscAsm
1183 | otherwise = HscLlvm
1184
1185 tablesNextToCode :: DynFlags -> Bool
1186 tablesNextToCode dflags
1187 = mkTablesNextToCode (platformUnregisterised (targetPlatform dflags))
1188
1189 -- Determines whether we will be compiling
1190 -- info tables that reside just before the entry code, or with an
1191 -- indirection to the entry code. See TABLES_NEXT_TO_CODE in
1192 -- includes/rts/storage/InfoTables.h.
1193 mkTablesNextToCode :: Bool -> Bool
1194 mkTablesNextToCode unregisterised
1195 = not unregisterised && cGhcEnableTablesNextToCode == "YES"
1196
1197 data DynLibLoader
1198 = Deployable
1199 | SystemDependent
1200 deriving Eq
1201
1202 data RtsOptsEnabled = RtsOptsNone | RtsOptsSafeOnly | RtsOptsAll
1203 deriving (Show)
1204
1205 -----------------------------------------------------------------------------
1206 -- Ways
1207
1208 -- The central concept of a "way" is that all objects in a given
1209 -- program must be compiled in the same "way". Certain options change
1210 -- parameters of the virtual machine, eg. profiling adds an extra word
1211 -- to the object header, so profiling objects cannot be linked with
1212 -- non-profiling objects.
1213
1214 -- After parsing the command-line options, we determine which "way" we
1215 -- are building - this might be a combination way, eg. profiling+threaded.
1216
1217 -- We then find the "build-tag" associated with this way, and this
1218 -- becomes the suffix used to find .hi files and libraries used in
1219 -- this compilation.
1220
1221 data Way
1222 = WayCustom String -- for GHC API clients building custom variants
1223 | WayThreaded
1224 | WayDebug
1225 | WayProf
1226 | WayEventLog
1227 | WayDyn
1228 deriving (Eq, Ord, Show)
1229
1230 allowed_combination :: [Way] -> Bool
1231 allowed_combination way = and [ x `allowedWith` y
1232 | x <- way, y <- way, x < y ]
1233 where
1234 -- Note ordering in these tests: the left argument is
1235 -- <= the right argument, according to the Ord instance
1236 -- on Way above.
1237
1238 -- dyn is allowed with everything
1239 _ `allowedWith` WayDyn = True
1240 WayDyn `allowedWith` _ = True
1241
1242 -- debug is allowed with everything
1243 _ `allowedWith` WayDebug = True
1244 WayDebug `allowedWith` _ = True
1245
1246 (WayCustom {}) `allowedWith` _ = True
1247 WayThreaded `allowedWith` WayProf = True
1248 WayThreaded `allowedWith` WayEventLog = True
1249 _ `allowedWith` _ = False
1250
1251 mkBuildTag :: [Way] -> String
1252 mkBuildTag ways = concat (intersperse "_" (map wayTag ways))
1253
1254 wayTag :: Way -> String
1255 wayTag (WayCustom xs) = xs
1256 wayTag WayThreaded = "thr"
1257 wayTag WayDebug = "debug"
1258 wayTag WayDyn = "dyn"
1259 wayTag WayProf = "p"
1260 wayTag WayEventLog = "l"
1261
1262 wayRTSOnly :: Way -> Bool
1263 wayRTSOnly (WayCustom {}) = False
1264 wayRTSOnly WayThreaded = True
1265 wayRTSOnly WayDebug = True
1266 wayRTSOnly WayDyn = False
1267 wayRTSOnly WayProf = False
1268 wayRTSOnly WayEventLog = True
1269
1270 wayDesc :: Way -> String
1271 wayDesc (WayCustom xs) = xs
1272 wayDesc WayThreaded = "Threaded"
1273 wayDesc WayDebug = "Debug"
1274 wayDesc WayDyn = "Dynamic"
1275 wayDesc WayProf = "Profiling"
1276 wayDesc WayEventLog = "RTS Event Logging"
1277
1278 -- Turn these flags on when enabling this way
1279 wayGeneralFlags :: Platform -> Way -> [GeneralFlag]
1280 wayGeneralFlags _ (WayCustom {}) = []
1281 wayGeneralFlags _ WayThreaded = []
1282 wayGeneralFlags _ WayDebug = []
1283 wayGeneralFlags _ WayDyn = [Opt_PIC]
1284 -- We could get away without adding -fPIC when compiling the
1285 -- modules of a program that is to be linked with -dynamic; the
1286 -- program itself does not need to be position-independent, only
1287 -- the libraries need to be. HOWEVER, GHCi links objects into a
1288 -- .so before loading the .so using the system linker. Since only
1289 -- PIC objects can be linked into a .so, we have to compile even
1290 -- modules of the main program with -fPIC when using -dynamic.
1291 wayGeneralFlags _ WayProf = [Opt_SccProfilingOn]
1292 wayGeneralFlags _ WayEventLog = []
1293
1294 -- Turn these flags off when enabling this way
1295 wayUnsetGeneralFlags :: Platform -> Way -> [GeneralFlag]
1296 wayUnsetGeneralFlags _ (WayCustom {}) = []
1297 wayUnsetGeneralFlags _ WayThreaded = []
1298 wayUnsetGeneralFlags _ WayDebug = []
1299 wayUnsetGeneralFlags _ WayDyn = [-- There's no point splitting objects
1300 -- when we're going to be dynamically
1301 -- linking. Plus it breaks compilation
1302 -- on OSX x86.
1303 Opt_SplitObjs,
1304 -- If splitobjs wasn't useful for this,
1305 -- assume sections aren't either.
1306 Opt_SplitSections]
1307 wayUnsetGeneralFlags _ WayProf = []
1308 wayUnsetGeneralFlags _ WayEventLog = []
1309
1310 wayOptc :: Platform -> Way -> [String]
1311 wayOptc _ (WayCustom {}) = []
1312 wayOptc platform WayThreaded = case platformOS platform of
1313 OSOpenBSD -> ["-pthread"]
1314 OSNetBSD -> ["-pthread"]
1315 _ -> []
1316 wayOptc _ WayDebug = []
1317 wayOptc _ WayDyn = []
1318 wayOptc _ WayProf = ["-DPROFILING"]
1319 wayOptc _ WayEventLog = ["-DTRACING"]
1320
1321 wayOptl :: Platform -> Way -> [String]
1322 wayOptl _ (WayCustom {}) = []
1323 wayOptl platform WayThreaded =
1324 case platformOS platform of
1325 -- FreeBSD's default threading library is the KSE-based M:N libpthread,
1326 -- which GHC has some problems with. It's currently not clear whether
1327 -- the problems are our fault or theirs, but it seems that using the
1328 -- alternative 1:1 threading library libthr works around it:
1329 OSFreeBSD -> ["-lthr"]
1330 OSOpenBSD -> ["-pthread"]
1331 OSNetBSD -> ["-pthread"]
1332 _ -> []
1333 wayOptl _ WayDebug = []
1334 wayOptl _ WayDyn = []
1335 wayOptl _ WayProf = []
1336 wayOptl _ WayEventLog = []
1337
1338 wayOptP :: Platform -> Way -> [String]
1339 wayOptP _ (WayCustom {}) = []
1340 wayOptP _ WayThreaded = []
1341 wayOptP _ WayDebug = []
1342 wayOptP _ WayDyn = []
1343 wayOptP _ WayProf = ["-DPROFILING"]
1344 wayOptP _ WayEventLog = ["-DTRACING"]
1345
1346 whenGeneratingDynamicToo :: MonadIO m => DynFlags -> m () -> m ()
1347 whenGeneratingDynamicToo dflags f = ifGeneratingDynamicToo dflags f (return ())
1348
1349 ifGeneratingDynamicToo :: MonadIO m => DynFlags -> m a -> m a -> m a
1350 ifGeneratingDynamicToo dflags f g = generateDynamicTooConditional dflags f g g
1351
1352 whenCannotGenerateDynamicToo :: MonadIO m => DynFlags -> m () -> m ()
1353 whenCannotGenerateDynamicToo dflags f
1354 = ifCannotGenerateDynamicToo dflags f (return ())
1355
1356 ifCannotGenerateDynamicToo :: MonadIO m => DynFlags -> m a -> m a -> m a
1357 ifCannotGenerateDynamicToo dflags f g
1358 = generateDynamicTooConditional dflags g f g
1359
1360 generateDynamicTooConditional :: MonadIO m
1361 => DynFlags -> m a -> m a -> m a -> m a
1362 generateDynamicTooConditional dflags canGen cannotGen notTryingToGen
1363 = if gopt Opt_BuildDynamicToo dflags
1364 then do let ref = canGenerateDynamicToo dflags
1365 b <- liftIO $ readIORef ref
1366 if b then canGen else cannotGen
1367 else notTryingToGen
1368
1369 dynamicTooMkDynamicDynFlags :: DynFlags -> DynFlags
1370 dynamicTooMkDynamicDynFlags dflags0
1371 = let dflags1 = addWay' WayDyn dflags0
1372 dflags2 = dflags1 {
1373 outputFile = dynOutputFile dflags1,
1374 hiSuf = dynHiSuf dflags1,
1375 objectSuf = dynObjectSuf dflags1
1376 }
1377 dflags3 = updateWays dflags2
1378 dflags4 = gopt_unset dflags3 Opt_BuildDynamicToo
1379 in dflags4
1380
1381 -----------------------------------------------------------------------------
1382
1383 -- | Used by 'GHC.runGhc' to partially initialize a new 'DynFlags' value
1384 initDynFlags :: DynFlags -> IO DynFlags
1385 initDynFlags dflags = do
1386 let -- We can't build with dynamic-too on Windows, as labels before
1387 -- the fork point are different depending on whether we are
1388 -- building dynamically or not.
1389 platformCanGenerateDynamicToo
1390 = platformOS (targetPlatform dflags) /= OSMinGW32
1391 refCanGenerateDynamicToo <- newIORef platformCanGenerateDynamicToo
1392 refNextTempSuffix <- newIORef 0
1393 refFilesToClean <- newIORef []
1394 refDirsToClean <- newIORef Map.empty
1395 refFilesToNotIntermediateClean <- newIORef []
1396 refGeneratedDumps <- newIORef Set.empty
1397 refRtldInfo <- newIORef Nothing
1398 refRtccInfo <- newIORef Nothing
1399 wrapperNum <- newIORef emptyModuleEnv
1400 canUseUnicode <- do let enc = localeEncoding
1401 str = "‘’"
1402 (withCString enc str $ \cstr ->
1403 do str' <- peekCString enc cstr
1404 return (str == str'))
1405 `catchIOError` \_ -> return False
1406 return dflags{
1407 canGenerateDynamicToo = refCanGenerateDynamicToo,
1408 nextTempSuffix = refNextTempSuffix,
1409 filesToClean = refFilesToClean,
1410 dirsToClean = refDirsToClean,
1411 filesToNotIntermediateClean = refFilesToNotIntermediateClean,
1412 generatedDumps = refGeneratedDumps,
1413 nextWrapperNum = wrapperNum,
1414 useUnicode = canUseUnicode,
1415 rtldInfo = refRtldInfo,
1416 rtccInfo = refRtccInfo
1417 }
1418
1419 -- | The normal 'DynFlags'. Note that they are not suitable for use in this form
1420 -- and must be fully initialized by 'GHC.runGhc' first.
1421 defaultDynFlags :: Settings -> DynFlags
1422 defaultDynFlags mySettings =
1423 -- See Note [Updating flag description in the User's Guide]
1424 DynFlags {
1425 ghcMode = CompManager,
1426 ghcLink = LinkBinary,
1427 hscTarget = defaultHscTarget (sTargetPlatform mySettings),
1428 sigOf = Map.empty,
1429 verbosity = 0,
1430 optLevel = 0,
1431 debugLevel = 0,
1432 simplPhases = 2,
1433 maxSimplIterations = 4,
1434 ruleCheck = Nothing,
1435 maxRelevantBinds = Just 6,
1436 simplTickFactor = 100,
1437 specConstrThreshold = Just 2000,
1438 specConstrCount = Just 3,
1439 specConstrRecursive = 3,
1440 liberateCaseThreshold = Just 2000,
1441 floatLamArgs = Just 0, -- Default: float only if no fvs
1442
1443 historySize = 20,
1444 strictnessBefore = [],
1445
1446 parMakeCount = Just 1,
1447
1448 enableTimeStats = False,
1449 ghcHeapSize = Nothing,
1450
1451 cmdlineHcIncludes = [],
1452 importPaths = ["."],
1453 mainModIs = mAIN,
1454 mainFunIs = Nothing,
1455 reductionDepth = treatZeroAsInf mAX_REDUCTION_DEPTH,
1456 solverIterations = treatZeroAsInf mAX_SOLVER_ITERATIONS,
1457
1458 thisPackage = mainUnitId,
1459
1460 objectDir = Nothing,
1461 dylibInstallName = Nothing,
1462 hiDir = Nothing,
1463 stubDir = Nothing,
1464 dumpDir = Nothing,
1465
1466 objectSuf = phaseInputExt StopLn,
1467 hcSuf = phaseInputExt HCc,
1468 hiSuf = "hi",
1469
1470 canGenerateDynamicToo = panic "defaultDynFlags: No canGenerateDynamicToo",
1471 dynObjectSuf = "dyn_" ++ phaseInputExt StopLn,
1472 dynHiSuf = "dyn_hi",
1473
1474 dllSplitFile = Nothing,
1475 dllSplit = Nothing,
1476
1477 pluginModNames = [],
1478 pluginModNameOpts = [],
1479 frontendPluginOpts = [],
1480 hooks = emptyHooks,
1481
1482 outputFile = Nothing,
1483 dynOutputFile = Nothing,
1484 outputHi = Nothing,
1485 dynLibLoader = SystemDependent,
1486 dumpPrefix = Nothing,
1487 dumpPrefixForce = Nothing,
1488 ldInputs = [],
1489 includePaths = [],
1490 libraryPaths = [],
1491 frameworkPaths = [],
1492 cmdlineFrameworks = [],
1493 rtsOpts = Nothing,
1494 rtsOptsEnabled = RtsOptsSafeOnly,
1495 rtsOptsSuggestions = True,
1496
1497 hpcDir = ".hpc",
1498
1499 extraPkgConfs = id,
1500 packageFlags = [],
1501 pluginPackageFlags = [],
1502 ignorePackageFlags = [],
1503 trustFlags = [],
1504 packageEnv = Nothing,
1505 pkgDatabase = Nothing,
1506 -- This gets filled in with GHC.setSessionDynFlags
1507 pkgState = emptyPackageState,
1508 ways = defaultWays mySettings,
1509 buildTag = mkBuildTag (defaultWays mySettings),
1510 rtsBuildTag = mkBuildTag (defaultWays mySettings),
1511 splitInfo = Nothing,
1512 settings = mySettings,
1513 -- ghc -M values
1514 depMakefile = "Makefile",
1515 depIncludePkgDeps = False,
1516 depExcludeMods = [],
1517 depSuffixes = [],
1518 -- end of ghc -M values
1519 nextTempSuffix = panic "defaultDynFlags: No nextTempSuffix",
1520 filesToClean = panic "defaultDynFlags: No filesToClean",
1521 dirsToClean = panic "defaultDynFlags: No dirsToClean",
1522 filesToNotIntermediateClean = panic "defaultDynFlags: No filesToNotIntermediateClean",
1523 generatedDumps = panic "defaultDynFlags: No generatedDumps",
1524 haddockOptions = Nothing,
1525 dumpFlags = IntSet.empty,
1526 generalFlags = IntSet.fromList (map fromEnum (defaultFlags mySettings)),
1527 warningFlags = IntSet.fromList (map fromEnum standardWarnings),
1528 ghciScripts = [],
1529 language = Nothing,
1530 safeHaskell = Sf_None,
1531 safeInfer = True,
1532 safeInferred = True,
1533 thOnLoc = noSrcSpan,
1534 newDerivOnLoc = noSrcSpan,
1535 overlapInstLoc = noSrcSpan,
1536 incoherentOnLoc = noSrcSpan,
1537 pkgTrustOnLoc = noSrcSpan,
1538 warnSafeOnLoc = noSrcSpan,
1539 warnUnsafeOnLoc = noSrcSpan,
1540 trustworthyOnLoc = noSrcSpan,
1541 extensions = [],
1542 extensionFlags = flattenExtensionFlags Nothing [],
1543
1544 -- The ufCreationThreshold threshold must be reasonably high to
1545 -- take account of possible discounts.
1546 -- E.g. 450 is not enough in 'fulsom' for Interval.sqr to inline
1547 -- into Csg.calc (The unfolding for sqr never makes it into the
1548 -- interface file.)
1549 ufCreationThreshold = 750,
1550 ufUseThreshold = 60,
1551 ufFunAppDiscount = 60,
1552 -- Be fairly keen to inline a function if that means
1553 -- we'll be able to pick the right method from a dictionary
1554 ufDictDiscount = 30,
1555 ufKeenessFactor = 1.5,
1556 ufDearOp = 40,
1557
1558 maxWorkerArgs = 10,
1559
1560 ghciHistSize = 50, -- keep a log of length 50 by default
1561
1562 log_action = defaultLogAction,
1563 flushOut = defaultFlushOut,
1564 flushErr = defaultFlushErr,
1565 pprUserLength = 5,
1566 pprCols = 100,
1567 useUnicode = False,
1568 traceLevel = 1,
1569 profAuto = NoProfAuto,
1570 interactivePrint = Nothing,
1571 nextWrapperNum = panic "defaultDynFlags: No nextWrapperNum",
1572 sseVersion = Nothing,
1573 avx = False,
1574 avx2 = False,
1575 avx512cd = False,
1576 avx512er = False,
1577 avx512f = False,
1578 avx512pf = False,
1579 rtldInfo = panic "defaultDynFlags: no rtldInfo",
1580 rtccInfo = panic "defaultDynFlags: no rtccInfo",
1581
1582 maxInlineAllocSize = 128,
1583 maxInlineMemcpyInsns = 32,
1584 maxInlineMemsetInsns = 32,
1585
1586 initialUnique = 0,
1587 uniqueIncrement = 1,
1588
1589 reverseErrors = False
1590 }
1591
1592 defaultWays :: Settings -> [Way]
1593 defaultWays settings = if pc_DYNAMIC_BY_DEFAULT (sPlatformConstants settings)
1594 then [WayDyn]
1595 else []
1596
1597 interpWays :: [Way]
1598 interpWays
1599 | dynamicGhc = [WayDyn]
1600 | rtsIsProfiled = [WayProf]
1601 | otherwise = []
1602
1603 interpreterProfiled :: DynFlags -> Bool
1604 interpreterProfiled dflags
1605 | gopt Opt_ExternalInterpreter dflags = gopt Opt_SccProfilingOn dflags
1606 | otherwise = rtsIsProfiled
1607
1608 interpreterDynamic :: DynFlags -> Bool
1609 interpreterDynamic dflags
1610 | gopt Opt_ExternalInterpreter dflags = WayDyn `elem` ways dflags
1611 | otherwise = dynamicGhc
1612
1613 --------------------------------------------------------------------------
1614
1615 type FatalMessager = String -> IO ()
1616 type LogAction = DynFlags -> Severity -> SrcSpan -> PprStyle -> MsgDoc -> IO ()
1617
1618 defaultFatalMessager :: FatalMessager
1619 defaultFatalMessager = hPutStrLn stderr
1620
1621 defaultLogAction :: LogAction
1622 defaultLogAction dflags severity srcSpan style msg
1623 = case severity of
1624 SevOutput -> printSDoc msg style
1625 SevDump -> printSDoc (msg $$ blankLine) style
1626 SevInteractive -> putStrSDoc msg style
1627 SevInfo -> printErrs msg style
1628 SevFatal -> printErrs msg style
1629 _ -> do hPutChar stderr '\n'
1630 printErrs (mkLocMessage severity srcSpan msg) style
1631 -- careful (#2302): printErrs prints in UTF-8,
1632 -- whereas converting to string first and using
1633 -- hPutStr would just emit the low 8 bits of
1634 -- each unicode char.
1635 where printSDoc = defaultLogActionHPrintDoc dflags stdout
1636 printErrs = defaultLogActionHPrintDoc dflags stderr
1637 putStrSDoc = defaultLogActionHPutStrDoc dflags stdout
1638
1639 defaultLogActionHPrintDoc :: DynFlags -> Handle -> SDoc -> PprStyle -> IO ()
1640 defaultLogActionHPrintDoc dflags h d sty
1641 = defaultLogActionHPutStrDoc dflags h (d $$ text "") sty
1642 -- Adds a newline
1643
1644 defaultLogActionHPutStrDoc :: DynFlags -> Handle -> SDoc -> PprStyle -> IO ()
1645 defaultLogActionHPutStrDoc dflags h d sty
1646 = Pretty.printDoc_ Pretty.PageMode (pprCols dflags) h doc
1647 where -- Don't add a newline at the end, so that successive
1648 -- calls to this log-action can output all on the same line
1649 doc = runSDoc d (initSDocContext dflags sty)
1650
1651 newtype FlushOut = FlushOut (IO ())
1652
1653 defaultFlushOut :: FlushOut
1654 defaultFlushOut = FlushOut $ hFlush stdout
1655
1656 newtype FlushErr = FlushErr (IO ())
1657
1658 defaultFlushErr :: FlushErr
1659 defaultFlushErr = FlushErr $ hFlush stderr
1660
1661 {-
1662 Note [Verbosity levels]
1663 ~~~~~~~~~~~~~~~~~~~~~~~
1664 0 | print errors & warnings only
1665 1 | minimal verbosity: print "compiling M ... done." for each module.
1666 2 | equivalent to -dshow-passes
1667 3 | equivalent to existing "ghc -v"
1668 4 | "ghc -v -ddump-most"
1669 5 | "ghc -v -ddump-all"
1670 -}
1671
1672 data OnOff a = On a
1673 | Off a
1674
1675 -- OnOffs accumulate in reverse order, so we use foldr in order to
1676 -- process them in the right order
1677 flattenExtensionFlags :: Maybe Language -> [OnOff LangExt.Extension] -> IntSet
1678 flattenExtensionFlags ml = foldr f defaultExtensionFlags
1679 where f (On f) flags = IntSet.insert (fromEnum f) flags
1680 f (Off f) flags = IntSet.delete (fromEnum f) flags
1681 defaultExtensionFlags = IntSet.fromList (map fromEnum (languageExtensions ml))
1682
1683 languageExtensions :: Maybe Language -> [LangExt.Extension]
1684
1685 languageExtensions Nothing
1686 -- Nothing => the default case
1687 = LangExt.NondecreasingIndentation -- This has been on by default for some time
1688 : delete LangExt.DatatypeContexts -- The Haskell' committee decided to
1689 -- remove datatype contexts from the
1690 -- language:
1691 -- http://www.haskell.org/pipermail/haskell-prime/2011-January/003335.html
1692 (languageExtensions (Just Haskell2010))
1693
1694 -- NB: MonoPatBinds is no longer the default
1695
1696 languageExtensions (Just Haskell98)
1697 = [LangExt.ImplicitPrelude,
1698 LangExt.MonomorphismRestriction,
1699 LangExt.NPlusKPatterns,
1700 LangExt.DatatypeContexts,
1701 LangExt.TraditionalRecordSyntax,
1702 LangExt.NondecreasingIndentation
1703 -- strictly speaking non-standard, but we always had this
1704 -- on implicitly before the option was added in 7.1, and
1705 -- turning it off breaks code, so we're keeping it on for
1706 -- backwards compatibility. Cabal uses -XHaskell98 by
1707 -- default unless you specify another language.
1708 ]
1709
1710 languageExtensions (Just Haskell2010)
1711 = [LangExt.ImplicitPrelude,
1712 LangExt.MonomorphismRestriction,
1713 LangExt.DatatypeContexts,
1714 LangExt.TraditionalRecordSyntax,
1715 LangExt.EmptyDataDecls,
1716 LangExt.ForeignFunctionInterface,
1717 LangExt.PatternGuards,
1718 LangExt.DoAndIfThenElse,
1719 LangExt.RelaxedPolyRec]
1720
1721 -- | Test whether a 'DumpFlag' is set
1722 dopt :: DumpFlag -> DynFlags -> Bool
1723 dopt f dflags = (fromEnum f `IntSet.member` dumpFlags dflags)
1724 || (verbosity dflags >= 4 && enableIfVerbose f)
1725 where enableIfVerbose Opt_D_dump_tc_trace = False
1726 enableIfVerbose Opt_D_dump_rn_trace = False
1727 enableIfVerbose Opt_D_dump_cs_trace = False
1728 enableIfVerbose Opt_D_dump_if_trace = False
1729 enableIfVerbose Opt_D_dump_vt_trace = False
1730 enableIfVerbose Opt_D_dump_tc = False
1731 enableIfVerbose Opt_D_dump_rn = False
1732 enableIfVerbose Opt_D_dump_rn_stats = False
1733 enableIfVerbose Opt_D_dump_hi_diffs = False
1734 enableIfVerbose Opt_D_verbose_core2core = False
1735 enableIfVerbose Opt_D_verbose_stg2stg = False
1736 enableIfVerbose Opt_D_dump_splices = False
1737 enableIfVerbose Opt_D_th_dec_file = False
1738 enableIfVerbose Opt_D_dump_rule_firings = False
1739 enableIfVerbose Opt_D_dump_rule_rewrites = False
1740 enableIfVerbose Opt_D_dump_simpl_trace = False
1741 enableIfVerbose Opt_D_dump_rtti = False
1742 enableIfVerbose Opt_D_dump_inlinings = False
1743 enableIfVerbose Opt_D_dump_core_stats = False
1744 enableIfVerbose Opt_D_dump_asm_stats = False
1745 enableIfVerbose Opt_D_dump_types = False
1746 enableIfVerbose Opt_D_dump_simpl_iterations = False
1747 enableIfVerbose Opt_D_dump_ticked = False
1748 enableIfVerbose Opt_D_dump_view_pattern_commoning = False
1749 enableIfVerbose Opt_D_dump_mod_cycles = False
1750 enableIfVerbose Opt_D_dump_mod_map = False
1751 enableIfVerbose _ = True
1752
1753 -- | Set a 'DumpFlag'
1754 dopt_set :: DynFlags -> DumpFlag -> DynFlags
1755 dopt_set dfs f = dfs{ dumpFlags = IntSet.insert (fromEnum f) (dumpFlags dfs) }
1756
1757 -- | Unset a 'DumpFlag'
1758 dopt_unset :: DynFlags -> DumpFlag -> DynFlags
1759 dopt_unset dfs f = dfs{ dumpFlags = IntSet.delete (fromEnum f) (dumpFlags dfs) }
1760
1761 -- | Test whether a 'GeneralFlag' is set
1762 gopt :: GeneralFlag -> DynFlags -> Bool
1763 gopt f dflags = fromEnum f `IntSet.member` generalFlags dflags
1764
1765 -- | Set a 'GeneralFlag'
1766 gopt_set :: DynFlags -> GeneralFlag -> DynFlags
1767 gopt_set dfs f = dfs{ generalFlags = IntSet.insert (fromEnum f) (generalFlags dfs) }
1768
1769 -- | Unset a 'GeneralFlag'
1770 gopt_unset :: DynFlags -> GeneralFlag -> DynFlags
1771 gopt_unset dfs f = dfs{ generalFlags = IntSet.delete (fromEnum f) (generalFlags dfs) }
1772
1773 -- | Test whether a 'WarningFlag' is set
1774 wopt :: WarningFlag -> DynFlags -> Bool
1775 wopt f dflags = fromEnum f `IntSet.member` warningFlags dflags
1776
1777 -- | Set a 'WarningFlag'
1778 wopt_set :: DynFlags -> WarningFlag -> DynFlags
1779 wopt_set dfs f = dfs{ warningFlags = IntSet.insert (fromEnum f) (warningFlags dfs) }
1780
1781 -- | Unset a 'WarningFlag'
1782 wopt_unset :: DynFlags -> WarningFlag -> DynFlags
1783 wopt_unset dfs f = dfs{ warningFlags = IntSet.delete (fromEnum f) (warningFlags dfs) }
1784
1785 -- | Test whether a 'LangExt.Extension' is set
1786 xopt :: LangExt.Extension -> DynFlags -> Bool
1787 xopt f dflags = fromEnum f `IntSet.member` extensionFlags dflags
1788
1789 -- | Set a 'LangExt.Extension'
1790 xopt_set :: DynFlags -> LangExt.Extension -> DynFlags
1791 xopt_set dfs f
1792 = let onoffs = On f : extensions dfs
1793 in dfs { extensions = onoffs,
1794 extensionFlags = flattenExtensionFlags (language dfs) onoffs }
1795
1796 -- | Unset a 'LangExt.Extension'
1797 xopt_unset :: DynFlags -> LangExt.Extension -> DynFlags
1798 xopt_unset dfs f
1799 = let onoffs = Off f : extensions dfs
1800 in dfs { extensions = onoffs,
1801 extensionFlags = flattenExtensionFlags (language dfs) onoffs }
1802
1803 lang_set :: DynFlags -> Maybe Language -> DynFlags
1804 lang_set dflags lang =
1805 dflags {
1806 language = lang,
1807 extensionFlags = flattenExtensionFlags lang (extensions dflags)
1808 }
1809
1810 -- | Check whether to use unicode syntax for output
1811 useUnicodeSyntax :: DynFlags -> Bool
1812 useUnicodeSyntax = gopt Opt_PrintUnicodeSyntax
1813
1814 -- | Set the Haskell language standard to use
1815 setLanguage :: Language -> DynP ()
1816 setLanguage l = upd (`lang_set` Just l)
1817
1818 -- | Some modules have dependencies on others through the DynFlags rather than textual imports
1819 dynFlagDependencies :: DynFlags -> [ModuleName]
1820 dynFlagDependencies = pluginModNames
1821
1822 -- | Is the -fpackage-trust mode on
1823 packageTrustOn :: DynFlags -> Bool
1824 packageTrustOn = gopt Opt_PackageTrust
1825
1826 -- | Is Safe Haskell on in some way (including inference mode)
1827 safeHaskellOn :: DynFlags -> Bool
1828 safeHaskellOn dflags = safeHaskell dflags /= Sf_None || safeInferOn dflags
1829
1830 -- | Is the Safe Haskell safe language in use
1831 safeLanguageOn :: DynFlags -> Bool
1832 safeLanguageOn dflags = safeHaskell dflags == Sf_Safe
1833
1834 -- | Is the Safe Haskell safe inference mode active
1835 safeInferOn :: DynFlags -> Bool
1836 safeInferOn = safeInfer
1837
1838 -- | Test if Safe Imports are on in some form
1839 safeImportsOn :: DynFlags -> Bool
1840 safeImportsOn dflags = safeHaskell dflags == Sf_Unsafe ||
1841 safeHaskell dflags == Sf_Trustworthy ||
1842 safeHaskell dflags == Sf_Safe
1843
1844 -- | Set a 'Safe Haskell' flag
1845 setSafeHaskell :: SafeHaskellMode -> DynP ()
1846 setSafeHaskell s = updM f
1847 where f dfs = do
1848 let sf = safeHaskell dfs
1849 safeM <- combineSafeFlags sf s
1850 case s of
1851 Sf_Safe -> return $ dfs { safeHaskell = safeM, safeInfer = False }
1852 -- leave safe inferrence on in Trustworthy mode so we can warn
1853 -- if it could have been inferred safe.
1854 Sf_Trustworthy -> do
1855 l <- getCurLoc
1856 return $ dfs { safeHaskell = safeM, trustworthyOnLoc = l }
1857 -- leave safe inference on in Unsafe mode as well.
1858 _ -> return $ dfs { safeHaskell = safeM }
1859
1860 -- | Are all direct imports required to be safe for this Safe Haskell mode?
1861 -- Direct imports are when the code explicitly imports a module
1862 safeDirectImpsReq :: DynFlags -> Bool
1863 safeDirectImpsReq d = safeLanguageOn d
1864
1865 -- | Are all implicit imports required to be safe for this Safe Haskell mode?
1866 -- Implicit imports are things in the prelude. e.g System.IO when print is used.
1867 safeImplicitImpsReq :: DynFlags -> Bool
1868 safeImplicitImpsReq d = safeLanguageOn d
1869
1870 -- | Combine two Safe Haskell modes correctly. Used for dealing with multiple flags.
1871 -- This makes Safe Haskell very much a monoid but for now I prefer this as I don't
1872 -- want to export this functionality from the module but do want to export the
1873 -- type constructors.
1874 combineSafeFlags :: SafeHaskellMode -> SafeHaskellMode -> DynP SafeHaskellMode
1875 combineSafeFlags a b | a == Sf_None = return b
1876 | b == Sf_None = return a
1877 | a == b = return a
1878 | otherwise = addErr errm >> return (panic errm)
1879 where errm = "Incompatible Safe Haskell flags! ("
1880 ++ show a ++ ", " ++ show b ++ ")"
1881
1882 -- | A list of unsafe flags under Safe Haskell. Tuple elements are:
1883 -- * name of the flag
1884 -- * function to get srcspan that enabled the flag
1885 -- * function to test if the flag is on
1886 -- * function to turn the flag off
1887 unsafeFlags, unsafeFlagsForInfer
1888 :: [(String, DynFlags -> SrcSpan, DynFlags -> Bool, DynFlags -> DynFlags)]
1889 unsafeFlags = [ ("-XGeneralizedNewtypeDeriving", newDerivOnLoc,
1890 xopt LangExt.GeneralizedNewtypeDeriving,
1891 flip xopt_unset LangExt.GeneralizedNewtypeDeriving)
1892 , ("-XTemplateHaskell", thOnLoc,
1893 xopt LangExt.TemplateHaskell,
1894 flip xopt_unset LangExt.TemplateHaskell)
1895 ]
1896 unsafeFlagsForInfer = unsafeFlags
1897
1898
1899 -- | Retrieve the options corresponding to a particular @opt_*@ field in the correct order
1900 getOpts :: DynFlags -- ^ 'DynFlags' to retrieve the options from
1901 -> (DynFlags -> [a]) -- ^ Relevant record accessor: one of the @opt_*@ accessors
1902 -> [a] -- ^ Correctly ordered extracted options
1903 getOpts dflags opts = reverse (opts dflags)
1904 -- We add to the options from the front, so we need to reverse the list
1905
1906 -- | Gets the verbosity flag for the current verbosity level. This is fed to
1907 -- other tools, so GHC-specific verbosity flags like @-ddump-most@ are not included
1908 getVerbFlags :: DynFlags -> [String]
1909 getVerbFlags dflags
1910 | verbosity dflags >= 4 = ["-v"]
1911 | otherwise = []
1912
1913 setObjectDir, setHiDir, setStubDir, setDumpDir, setOutputDir,
1914 setDynObjectSuf, setDynHiSuf,
1915 setDylibInstallName,
1916 setObjectSuf, setHiSuf, setHcSuf, parseDynLibLoaderMode,
1917 setPgmP, addOptl, addOptc, addOptP,
1918 addCmdlineFramework, addHaddockOpts, addGhciScript,
1919 setInteractivePrint
1920 :: String -> DynFlags -> DynFlags
1921 setOutputFile, setDynOutputFile, setOutputHi, setDumpPrefixForce
1922 :: Maybe String -> DynFlags -> DynFlags
1923
1924 setObjectDir f d = d{ objectDir = Just f}
1925 setHiDir f d = d{ hiDir = Just f}
1926 setStubDir f d = d{ stubDir = Just f, includePaths = f : includePaths d }
1927 -- -stubdir D adds an implicit -I D, so that gcc can find the _stub.h file
1928 -- \#included from the .hc file when compiling via C (i.e. unregisterised
1929 -- builds).
1930 setDumpDir f d = d{ dumpDir = Just f}
1931 setOutputDir f = setObjectDir f . setHiDir f . setStubDir f . setDumpDir f
1932 setDylibInstallName f d = d{ dylibInstallName = Just f}
1933
1934 setObjectSuf f d = d{ objectSuf = f}
1935 setDynObjectSuf f d = d{ dynObjectSuf = f}
1936 setHiSuf f d = d{ hiSuf = f}
1937 setDynHiSuf f d = d{ dynHiSuf = f}
1938 setHcSuf f d = d{ hcSuf = f}
1939
1940 setOutputFile f d = d{ outputFile = f}
1941 setDynOutputFile f d = d{ dynOutputFile = f}
1942 setOutputHi f d = d{ outputHi = f}
1943
1944 parseSigOf :: String -> SigOf
1945 parseSigOf str = case filter ((=="").snd) (readP_to_S parse str) of
1946 [(r, "")] -> r
1947 _ -> throwGhcException $ CmdLineError ("Can't parse -sig-of: " ++ str)
1948 where parse = Map.fromList <$> sepBy parseEntry (R.char ',')
1949 parseEntry = do
1950 n <- tok $ parseModuleName
1951 -- ToDo: deprecate this 'is' syntax?
1952 tok $ ((string "is" >> return ()) +++ (R.char '=' >> return ()))
1953 m <- tok $ parseModule
1954 return (n, m)
1955 parseModule = do
1956 pk <- munch1 (\c -> isAlphaNum c || c `elem` "-_.")
1957 _ <- R.char ':'
1958 m <- parseModuleName
1959 return (mkModule (stringToUnitId pk) m)
1960 tok m = skipSpaces >> m
1961
1962 setSigOf :: String -> DynFlags -> DynFlags
1963 setSigOf s d = d { sigOf = parseSigOf s }
1964
1965 addPluginModuleName :: String -> DynFlags -> DynFlags
1966 addPluginModuleName name d = d { pluginModNames = (mkModuleName name) : (pluginModNames d) }
1967
1968 addPluginModuleNameOption :: String -> DynFlags -> DynFlags
1969 addPluginModuleNameOption optflag d = d { pluginModNameOpts = (mkModuleName m, option) : (pluginModNameOpts d) }
1970 where (m, rest) = break (== ':') optflag
1971 option = case rest of
1972 [] -> "" -- should probably signal an error
1973 (_:plug_opt) -> plug_opt -- ignore the ':' from break
1974
1975 addFrontendPluginOption :: String -> DynFlags -> DynFlags
1976 addFrontendPluginOption s d = d { frontendPluginOpts = s : frontendPluginOpts d }
1977
1978 parseDynLibLoaderMode f d =
1979 case splitAt 8 f of
1980 ("deploy", "") -> d{ dynLibLoader = Deployable }
1981 ("sysdep", "") -> d{ dynLibLoader = SystemDependent }
1982 _ -> throwGhcException (CmdLineError ("Unknown dynlib loader: " ++ f))
1983
1984 setDumpPrefixForce f d = d { dumpPrefixForce = f}
1985
1986 -- XXX HACK: Prelude> words "'does not' work" ===> ["'does","not'","work"]
1987 -- Config.hs should really use Option.
1988 setPgmP f = let (pgm:args) = words f in alterSettings (\s -> s { sPgm_P = (pgm, map Option args)})
1989 addOptl f = alterSettings (\s -> s { sOpt_l = f : sOpt_l s})
1990 addOptc f = alterSettings (\s -> s { sOpt_c = f : sOpt_c s})
1991 addOptP f = alterSettings (\s -> s { sOpt_P = f : sOpt_P s})
1992
1993
1994 setDepMakefile :: FilePath -> DynFlags -> DynFlags
1995 setDepMakefile f d = d { depMakefile = f }
1996
1997 setDepIncludePkgDeps :: Bool -> DynFlags -> DynFlags
1998 setDepIncludePkgDeps b d = d { depIncludePkgDeps = b }
1999
2000 addDepExcludeMod :: String -> DynFlags -> DynFlags
2001 addDepExcludeMod m d
2002 = d { depExcludeMods = mkModuleName m : depExcludeMods d }
2003
2004 addDepSuffix :: FilePath -> DynFlags -> DynFlags
2005 addDepSuffix s d = d { depSuffixes = s : depSuffixes d }
2006
2007 addCmdlineFramework f d = d{ cmdlineFrameworks = f : cmdlineFrameworks d}
2008
2009 addHaddockOpts f d = d{ haddockOptions = Just f}
2010
2011 addGhciScript f d = d{ ghciScripts = f : ghciScripts d}
2012
2013 setInteractivePrint f d = d{ interactivePrint = Just f}
2014
2015 -- -----------------------------------------------------------------------------
2016 -- Command-line options
2017
2018 -- | When invoking external tools as part of the compilation pipeline, we
2019 -- pass these a sequence of options on the command-line. Rather than
2020 -- just using a list of Strings, we use a type that allows us to distinguish
2021 -- between filepaths and 'other stuff'. The reason for this is that
2022 -- this type gives us a handle on transforming filenames, and filenames only,
2023 -- to whatever format they're expected to be on a particular platform.
2024 data Option
2025 = FileOption -- an entry that _contains_ filename(s) / filepaths.
2026 String -- a non-filepath prefix that shouldn't be
2027 -- transformed (e.g., "/out=")
2028 String -- the filepath/filename portion
2029 | Option String
2030 deriving ( Eq )
2031
2032 showOpt :: Option -> String
2033 showOpt (FileOption pre f) = pre ++ f
2034 showOpt (Option s) = s
2035
2036 -----------------------------------------------------------------------------
2037 -- Setting the optimisation level
2038
2039 updOptLevel :: Int -> DynFlags -> DynFlags
2040 -- ^ Sets the 'DynFlags' to be appropriate to the optimisation level
2041 updOptLevel n dfs
2042 = dfs2{ optLevel = final_n }
2043 where
2044 final_n = max 0 (min 2 n) -- Clamp to 0 <= n <= 2
2045 dfs1 = foldr (flip gopt_unset) dfs remove_gopts
2046 dfs2 = foldr (flip gopt_set) dfs1 extra_gopts
2047
2048 extra_gopts = [ f | (ns,f) <- optLevelFlags, final_n `elem` ns ]
2049 remove_gopts = [ f | (ns,f) <- optLevelFlags, final_n `notElem` ns ]
2050
2051 {- **********************************************************************
2052 %* *
2053 DynFlags parser
2054 %* *
2055 %********************************************************************* -}
2056
2057 -- -----------------------------------------------------------------------------
2058 -- Parsing the dynamic flags.
2059
2060
2061 -- | Parse dynamic flags from a list of command line arguments. Returns the
2062 -- the parsed 'DynFlags', the left-over arguments, and a list of warnings.
2063 -- Throws a 'UsageError' if errors occurred during parsing (such as unknown
2064 -- flags or missing arguments).
2065 parseDynamicFlagsCmdLine :: MonadIO m => DynFlags -> [Located String]
2066 -> m (DynFlags, [Located String], [Located String])
2067 -- ^ Updated 'DynFlags', left-over arguments, and
2068 -- list of warnings.
2069 parseDynamicFlagsCmdLine = parseDynamicFlagsFull flagsAll True
2070
2071
2072 -- | Like 'parseDynamicFlagsCmdLine' but does not allow the package flags
2073 -- (-package, -hide-package, -ignore-package, -hide-all-packages, -package-db).
2074 -- Used to parse flags set in a modules pragma.
2075 parseDynamicFilePragma :: MonadIO m => DynFlags -> [Located String]
2076 -> m (DynFlags, [Located String], [Located String])
2077 -- ^ Updated 'DynFlags', left-over arguments, and
2078 -- list of warnings.
2079 parseDynamicFilePragma = parseDynamicFlagsFull flagsDynamic False
2080
2081
2082 -- | Parses the dynamically set flags for GHC. This is the most general form of
2083 -- the dynamic flag parser that the other methods simply wrap. It allows
2084 -- saying which flags are valid flags and indicating if we are parsing
2085 -- arguments from the command line or from a file pragma.
2086 parseDynamicFlagsFull :: MonadIO m
2087 => [Flag (CmdLineP DynFlags)] -- ^ valid flags to match against
2088 -> Bool -- ^ are the arguments from the command line?
2089 -> DynFlags -- ^ current dynamic flags
2090 -> [Located String] -- ^ arguments to parse
2091 -> m (DynFlags, [Located String], [Located String])
2092 parseDynamicFlagsFull activeFlags cmdline dflags0 args = do
2093 let ((leftover, errs, warns), dflags1)
2094 = runCmdLine (processArgs activeFlags args) dflags0
2095
2096 -- See Note [Handling errors when parsing commandline flags]
2097 unless (null errs) $ liftIO $ throwGhcExceptionIO $
2098 errorsToGhcException . map (showPpr dflags0 . getLoc &&& unLoc) $ errs
2099
2100 -- check for disabled flags in safe haskell
2101 let (dflags2, sh_warns) = safeFlagCheck cmdline dflags1
2102 dflags3 = updateWays dflags2
2103 theWays = ways dflags3
2104
2105 unless (allowed_combination theWays) $ liftIO $
2106 throwGhcExceptionIO (CmdLineError ("combination not supported: " ++
2107 intercalate "/" (map wayDesc theWays)))
2108
2109 let chooseOutput
2110 | isJust (outputFile dflags3) -- Only iff user specified -o ...
2111 , not (isJust (dynOutputFile dflags3)) -- but not -dyno
2112 = return $ dflags3 { dynOutputFile = Just $ dynOut (fromJust $ outputFile dflags3) }
2113 | otherwise
2114 = return dflags3
2115 where
2116 dynOut = flip addExtension (dynObjectSuf dflags3) . dropExtension
2117 dflags4 <- ifGeneratingDynamicToo dflags3 chooseOutput (return dflags3)
2118
2119 let (dflags5, consistency_warnings) = makeDynFlagsConsistent dflags4
2120
2121 dflags6 <- case dllSplitFile dflags5 of
2122 Nothing -> return (dflags5 { dllSplit = Nothing })
2123 Just f ->
2124 case dllSplit dflags5 of
2125 Just _ ->
2126 -- If dllSplit is out of date then it would have
2127 -- been set to Nothing. As it's a Just, it must be
2128 -- up-to-date.
2129 return dflags5
2130 Nothing ->
2131 do xs <- liftIO $ readFile f
2132 let ss = map (Set.fromList . words) (lines xs)
2133 return $ dflags5 { dllSplit = Just ss }
2134
2135 -- Set timer stats & heap size
2136 when (enableTimeStats dflags6) $ liftIO enableTimingStats
2137 case (ghcHeapSize dflags6) of
2138 Just x -> liftIO (setHeapSize x)
2139 _ -> return ()
2140
2141 liftIO $ setUnsafeGlobalDynFlags dflags6
2142
2143 return (dflags6, leftover, consistency_warnings ++ sh_warns ++ warns)
2144
2145 updateWays :: DynFlags -> DynFlags
2146 updateWays dflags
2147 = let theWays = sort $ nub $ ways dflags
2148 in dflags {
2149 ways = theWays,
2150 buildTag = mkBuildTag (filter (not . wayRTSOnly) theWays),
2151 rtsBuildTag = mkBuildTag theWays
2152 }
2153
2154 -- | Check (and potentially disable) any extensions that aren't allowed
2155 -- in safe mode.
2156 --
2157 -- The bool is to indicate if we are parsing command line flags (false means
2158 -- file pragma). This allows us to generate better warnings.
2159 safeFlagCheck :: Bool -> DynFlags -> (DynFlags, [Located String])
2160 safeFlagCheck _ dflags | safeLanguageOn dflags = (dflagsUnset, warns)
2161 where
2162 -- Handle illegal flags under safe language.
2163 (dflagsUnset, warns) = foldl check_method (dflags, []) unsafeFlags
2164
2165 check_method (df, warns) (str,loc,test,fix)
2166 | test df = (fix df, warns ++ safeFailure (loc df) str)
2167 | otherwise = (df, warns)
2168
2169 safeFailure loc str
2170 = [L loc $ str ++ " is not allowed in Safe Haskell; ignoring "
2171 ++ str]
2172
2173 safeFlagCheck cmdl dflags =
2174 case (safeInferOn dflags) of
2175 True | safeFlags -> (dflags', warn)
2176 True -> (dflags' { safeInferred = False }, warn)
2177 False -> (dflags', warn)
2178
2179 where
2180 -- dynflags and warn for when -fpackage-trust by itself with no safe
2181 -- haskell flag
2182 (dflags', warn)
2183 | safeHaskell dflags == Sf_None && not cmdl && packageTrustOn dflags
2184 = (gopt_unset dflags Opt_PackageTrust, pkgWarnMsg)
2185 | otherwise = (dflags, [])
2186
2187 pkgWarnMsg = [L (pkgTrustOnLoc dflags') $
2188 "-fpackage-trust ignored;" ++
2189 " must be specified with a Safe Haskell flag"]
2190
2191 -- Have we inferred Unsafe? See Note [HscMain . Safe Haskell Inference]
2192 safeFlags = all (\(_,_,t,_) -> not $ t dflags) unsafeFlagsForInfer
2193
2194
2195 {- **********************************************************************
2196 %* *
2197 DynFlags specifications
2198 %* *
2199 %********************************************************************* -}
2200
2201 -- | All dynamic flags option strings. These are the user facing strings for
2202 -- enabling and disabling options.
2203 allFlags :: [String]
2204 allFlags = [ '-':flagName flag
2205 | flag <- flagsAll
2206 , ok (flagOptKind flag) ]
2207 where ok (PrefixPred _ _) = False
2208 ok _ = True
2209
2210 {-
2211 - Below we export user facing symbols for GHC dynamic flags for use with the
2212 - GHC API.
2213 -}
2214
2215 -- All dynamic flags present in GHC.
2216 flagsAll :: [Flag (CmdLineP DynFlags)]
2217 flagsAll = package_flags ++ dynamic_flags
2218
2219 -- All dynamic flags, minus package flags, present in GHC.
2220 flagsDynamic :: [Flag (CmdLineP DynFlags)]
2221 flagsDynamic = dynamic_flags
2222
2223 -- ALl package flags present in GHC.
2224 flagsPackage :: [Flag (CmdLineP DynFlags)]
2225 flagsPackage = package_flags
2226
2227 --------------- The main flags themselves ------------------
2228 -- See Note [Updating flag description in the User's Guide]
2229 -- See Note [Supporting CLI completion]
2230 dynamic_flags :: [Flag (CmdLineP DynFlags)]
2231 dynamic_flags = [
2232 defFlag "n"
2233 (NoArg (addWarn "The -n flag is deprecated and no longer has any effect"))
2234 , defFlag "cpp" (NoArg (setExtensionFlag LangExt.Cpp))
2235 , defFlag "F" (NoArg (setGeneralFlag Opt_Pp))
2236 , defFlag "#include"
2237 (HasArg (\s -> do
2238 addCmdlineHCInclude s
2239 addWarn ("-#include and INCLUDE pragmas are " ++
2240 "deprecated: They no longer have any effect")))
2241 , defFlag "v" (OptIntSuffix setVerbosity)
2242
2243 , defGhcFlag "j" (OptIntSuffix (\n -> upd (\d -> d {parMakeCount = n})))
2244 , defFlag "sig-of" (sepArg setSigOf)
2245
2246 -- RTS options -------------------------------------------------------------
2247 , defFlag "H" (HasArg (\s -> upd (\d ->
2248 d { ghcHeapSize = Just $ fromIntegral (decodeSize s)})))
2249
2250 , defFlag "Rghc-timing" (NoArg (upd (\d -> d { enableTimeStats = True })))
2251
2252 ------- ways ---------------------------------------------------------------
2253 , defGhcFlag "prof" (NoArg (addWay WayProf))
2254 , defGhcFlag "eventlog" (NoArg (addWay WayEventLog))
2255 , defGhcFlag "smp"
2256 (NoArg (addWay WayThreaded >> deprecate "Use -threaded instead"))
2257 , defGhcFlag "debug" (NoArg (addWay WayDebug))
2258 , defGhcFlag "threaded" (NoArg (addWay WayThreaded))
2259
2260 , defGhcFlag "ticky"
2261 (NoArg (setGeneralFlag Opt_Ticky >> addWay WayDebug))
2262
2263 -- -ticky enables ticky-ticky code generation, and also implies -debug which
2264 -- is required to get the RTS ticky support.
2265
2266 ----- Linker --------------------------------------------------------
2267 , defGhcFlag "static" (NoArg removeWayDyn)
2268 , defGhcFlag "dynamic" (NoArg (addWay WayDyn))
2269 , defGhcFlag "rdynamic" $ noArg $
2270 #ifdef linux_HOST_OS
2271 addOptl "-rdynamic"
2272 #elif defined (mingw32_HOST_OS)
2273 addOptl "-Wl,--export-all-symbols"
2274 #else
2275 -- ignored for compat w/ gcc:
2276 id
2277 #endif
2278 , defGhcFlag "relative-dynlib-paths"
2279 (NoArg (setGeneralFlag Opt_RelativeDynlibPaths))
2280
2281 ------- Specific phases --------------------------------------------
2282 -- need to appear before -pgmL to be parsed as LLVM flags.
2283 , defFlag "pgmlo"
2284 (hasArg (\f -> alterSettings (\s -> s { sPgm_lo = (f,[])})))
2285 , defFlag "pgmlc"
2286 (hasArg (\f -> alterSettings (\s -> s { sPgm_lc = (f,[])})))
2287 , defFlag "pgmi"
2288 (hasArg (\f -> alterSettings (\s -> s { sPgm_i = f})))
2289 , defFlag "pgmL"
2290 (hasArg (\f -> alterSettings (\s -> s { sPgm_L = f})))
2291 , defFlag "pgmP"
2292 (hasArg setPgmP)
2293 , defFlag "pgmF"
2294 (hasArg (\f -> alterSettings (\s -> s { sPgm_F = f})))
2295 , defFlag "pgmc"
2296 (hasArg (\f -> alterSettings (\s -> s { sPgm_c = (f,[])})))
2297 , defFlag "pgms"
2298 (hasArg (\f -> alterSettings (\s -> s { sPgm_s = (f,[])})))
2299 , defFlag "pgma"
2300 (hasArg (\f -> alterSettings (\s -> s { sPgm_a = (f,[])})))
2301 , defFlag "pgml"
2302 (hasArg (\f -> alterSettings (\s -> s { sPgm_l = (f,[])})))
2303 , defFlag "pgmdll"
2304 (hasArg (\f -> alterSettings (\s -> s { sPgm_dll = (f,[])})))
2305 , defFlag "pgmwindres"
2306 (hasArg (\f -> alterSettings (\s -> s { sPgm_windres = f})))
2307 , defFlag "pgmlibtool"
2308 (hasArg (\f -> alterSettings (\s -> s { sPgm_libtool = f})))
2309
2310 -- need to appear before -optl/-opta to be parsed as LLVM flags.
2311 , defFlag "optlo"
2312 (hasArg (\f -> alterSettings (\s -> s { sOpt_lo = f : sOpt_lo s})))
2313 , defFlag "optlc"
2314 (hasArg (\f -> alterSettings (\s -> s { sOpt_lc = f : sOpt_lc s})))
2315 , defFlag "opti"
2316 (hasArg (\f -> alterSettings (\s -> s { sOpt_i = f : sOpt_i s})))
2317 , defFlag "optL"
2318 (hasArg (\f -> alterSettings (\s -> s { sOpt_L = f : sOpt_L s})))
2319 , defFlag "optP"
2320 (hasArg addOptP)
2321 , defFlag "optF"
2322 (hasArg (\f -> alterSettings (\s -> s { sOpt_F = f : sOpt_F s})))
2323 , defFlag "optc"
2324 (hasArg addOptc)
2325 , defFlag "opta"
2326 (hasArg (\f -> alterSettings (\s -> s { sOpt_a = f : sOpt_a s})))
2327 , defFlag "optl"
2328 (hasArg addOptl)
2329 , defFlag "optwindres"
2330 (hasArg (\f ->
2331 alterSettings (\s -> s { sOpt_windres = f : sOpt_windres s})))
2332
2333 , defGhcFlag "split-objs"
2334 (NoArg (if can_split
2335 then setGeneralFlag Opt_SplitObjs
2336 else addWarn "ignoring -fsplit-objs"))
2337
2338 , defGhcFlag "split-sections"
2339 (noArgM (\dflags -> do
2340 if platformHasSubsectionsViaSymbols (targetPlatform dflags)
2341 then do addErr $
2342 "-split-sections is not useful on this platform " ++
2343 "since it always uses subsections via symbols."
2344 return dflags
2345 else return (gopt_set dflags Opt_SplitSections)))
2346
2347 -------- ghc -M -----------------------------------------------------
2348 , defGhcFlag "dep-suffix" (hasArg addDepSuffix)
2349 , defGhcFlag "dep-makefile" (hasArg setDepMakefile)
2350 , defGhcFlag "include-pkg-deps" (noArg (setDepIncludePkgDeps True))
2351 , defGhcFlag "exclude-module" (hasArg addDepExcludeMod)
2352
2353 -------- Linking ----------------------------------------------------
2354 , defGhcFlag "no-link" (noArg (\d -> d{ ghcLink=NoLink }))
2355 , defGhcFlag "shared" (noArg (\d -> d{ ghcLink=LinkDynLib }))
2356 , defGhcFlag "staticlib" (noArg (\d -> d{ ghcLink=LinkStaticLib }))
2357 , defGhcFlag "dynload" (hasArg parseDynLibLoaderMode)
2358 , defGhcFlag "dylib-install-name" (hasArg setDylibInstallName)
2359 -- -dll-split is an internal flag, used only during the GHC build
2360 , defHiddenFlag "dll-split"
2361 (hasArg (\f d -> d{ dllSplitFile = Just f, dllSplit = Nothing }))
2362
2363 ------- Libraries ---------------------------------------------------
2364 , defFlag "L" (Prefix addLibraryPath)
2365 , defFlag "l" (hasArg (addLdInputs . Option . ("-l" ++)))
2366
2367 ------- Frameworks --------------------------------------------------
2368 -- -framework-path should really be -F ...
2369 , defFlag "framework-path" (HasArg addFrameworkPath)
2370 , defFlag "framework" (hasArg addCmdlineFramework)
2371
2372 ------- Output Redirection ------------------------------------------
2373 , defGhcFlag "odir" (hasArg setObjectDir)
2374 , defGhcFlag "o" (sepArg (setOutputFile . Just))
2375 , defGhcFlag "dyno" (sepArg (setDynOutputFile . Just))
2376 , defGhcFlag "ohi" (hasArg (setOutputHi . Just ))
2377 , defGhcFlag "osuf" (hasArg setObjectSuf)
2378 , defGhcFlag "dynosuf" (hasArg setDynObjectSuf)
2379 , defGhcFlag "hcsuf" (hasArg setHcSuf)
2380 , defGhcFlag "hisuf" (hasArg setHiSuf)
2381 , defGhcFlag "dynhisuf" (hasArg setDynHiSuf)
2382 , defGhcFlag "hidir" (hasArg setHiDir)
2383 , defGhcFlag "tmpdir" (hasArg setTmpDir)
2384 , defGhcFlag "stubdir" (hasArg setStubDir)
2385 , defGhcFlag "dumpdir" (hasArg setDumpDir)
2386 , defGhcFlag "outputdir" (hasArg setOutputDir)
2387 , defGhcFlag "ddump-file-prefix" (hasArg (setDumpPrefixForce . Just))
2388
2389 , defGhcFlag "dynamic-too" (NoArg (setGeneralFlag Opt_BuildDynamicToo))
2390
2391 ------- Keeping temporary files -------------------------------------
2392 -- These can be singular (think ghc -c) or plural (think ghc --make)
2393 , defGhcFlag "keep-hc-file" (NoArg (setGeneralFlag Opt_KeepHcFiles))
2394 , defGhcFlag "keep-hc-files" (NoArg (setGeneralFlag Opt_KeepHcFiles))
2395 , defGhcFlag "keep-s-file" (NoArg (setGeneralFlag Opt_KeepSFiles))
2396 , defGhcFlag "keep-s-files" (NoArg (setGeneralFlag Opt_KeepSFiles))
2397 , defGhcFlag "keep-llvm-file" (NoArg (do setObjTarget HscLlvm
2398 setGeneralFlag Opt_KeepLlvmFiles))
2399 , defGhcFlag "keep-llvm-files" (NoArg (do setObjTarget HscLlvm
2400 setGeneralFlag Opt_KeepLlvmFiles))
2401 -- This only makes sense as plural
2402 , defGhcFlag "keep-tmp-files" (NoArg (setGeneralFlag Opt_KeepTmpFiles))
2403
2404 ------- Miscellaneous ----------------------------------------------
2405 , defGhcFlag "no-auto-link-packages"
2406 (NoArg (unSetGeneralFlag Opt_AutoLinkPackages))
2407 , defGhcFlag "no-hs-main" (NoArg (setGeneralFlag Opt_NoHsMain))
2408 , defGhcFlag "with-rtsopts" (HasArg setRtsOpts)
2409 , defGhcFlag "rtsopts" (NoArg (setRtsOptsEnabled RtsOptsAll))
2410 , defGhcFlag "rtsopts=all" (NoArg (setRtsOptsEnabled RtsOptsAll))
2411 , defGhcFlag "rtsopts=some" (NoArg (setRtsOptsEnabled RtsOptsSafeOnly))
2412 , defGhcFlag "rtsopts=none" (NoArg (setRtsOptsEnabled RtsOptsNone))
2413 , defGhcFlag "no-rtsopts" (NoArg (setRtsOptsEnabled RtsOptsNone))
2414 , defGhcFlag "no-rtsopts-suggestions"
2415 (noArg (\d -> d {rtsOptsSuggestions = False} ))
2416
2417 , defGhcFlag "main-is" (SepArg setMainIs)
2418 , defGhcFlag "haddock" (NoArg (setGeneralFlag Opt_Haddock))
2419 , defGhcFlag "haddock-opts" (hasArg addHaddockOpts)
2420 , defGhcFlag "hpcdir" (SepArg setOptHpcDir)
2421 , defGhciFlag "ghci-script" (hasArg addGhciScript)
2422 , defGhciFlag "interactive-print" (hasArg setInteractivePrint)
2423 , defGhcFlag "ticky-allocd" (NoArg (setGeneralFlag Opt_Ticky_Allocd))
2424 , defGhcFlag "ticky-LNE" (NoArg (setGeneralFlag Opt_Ticky_LNE))
2425 , defGhcFlag "ticky-dyn-thunk" (NoArg (setGeneralFlag Opt_Ticky_Dyn_Thunk))
2426 ------- recompilation checker --------------------------------------
2427 , defGhcFlag "recomp" (NoArg (do unSetGeneralFlag Opt_ForceRecomp
2428 deprecate "Use -fno-force-recomp instead"))
2429 , defGhcFlag "no-recomp" (NoArg (do setGeneralFlag Opt_ForceRecomp
2430 deprecate "Use -fforce-recomp instead"))
2431 , defFlag "freverse-errors"
2432 (noArg (\d -> d {reverseErrors = True} ))
2433 , defFlag "fno-reverse-errors"
2434 (noArg (\d -> d {reverseErrors = False} ))
2435
2436 ------ HsCpp opts ---------------------------------------------------
2437 , defFlag "D" (AnySuffix (upd . addOptP))
2438 , defFlag "U" (AnySuffix (upd . addOptP))
2439
2440 ------- Include/Import Paths ----------------------------------------
2441 , defFlag "I" (Prefix addIncludePath)
2442 , defFlag "i" (OptPrefix addImportPath)
2443
2444 ------ Output style options -----------------------------------------
2445 , defFlag "dppr-user-length" (intSuffix (\n d -> d{ pprUserLength = n }))
2446 , defFlag "dppr-cols" (intSuffix (\n d -> d{ pprCols = n }))
2447 , defGhcFlag "dtrace-level" (intSuffix (\n d -> d{ traceLevel = n }))
2448 -- Suppress all that is suppressable in core dumps.
2449 -- Except for uniques, as some simplifier phases introduce new variables that
2450 -- have otherwise identical names.
2451 , defGhcFlag "dsuppress-all"
2452 (NoArg $ do setGeneralFlag Opt_SuppressCoercions
2453 setGeneralFlag Opt_SuppressVarKinds
2454 setGeneralFlag Opt_SuppressModulePrefixes
2455 setGeneralFlag Opt_SuppressTypeApplications
2456 setGeneralFlag Opt_SuppressIdInfo
2457 setGeneralFlag Opt_SuppressTypeSignatures)
2458
2459 ------ Debugging ----------------------------------------------------
2460 , defGhcFlag "dstg-stats" (NoArg (setGeneralFlag Opt_StgStats))
2461
2462 , defGhcFlag "ddump-cmm" (setDumpFlag Opt_D_dump_cmm)
2463 , defGhcFlag "ddump-cmm-raw" (setDumpFlag Opt_D_dump_cmm_raw)
2464 , defGhcFlag "ddump-cmm-cfg" (setDumpFlag Opt_D_dump_cmm_cfg)
2465 , defGhcFlag "ddump-cmm-cbe" (setDumpFlag Opt_D_dump_cmm_cbe)
2466 , defGhcFlag "ddump-cmm-switch" (setDumpFlag Opt_D_dump_cmm_switch)
2467 , defGhcFlag "ddump-cmm-proc" (setDumpFlag Opt_D_dump_cmm_proc)
2468 , defGhcFlag "ddump-cmm-sink" (setDumpFlag Opt_D_dump_cmm_sink)
2469 , defGhcFlag "ddump-cmm-sp" (setDumpFlag Opt_D_dump_cmm_sp)
2470 , defGhcFlag "ddump-cmm-procmap" (setDumpFlag Opt_D_dump_cmm_procmap)
2471 , defGhcFlag "ddump-cmm-split" (setDumpFlag Opt_D_dump_cmm_split)
2472 , defGhcFlag "ddump-cmm-info" (setDumpFlag Opt_D_dump_cmm_info)
2473 , defGhcFlag "ddump-cmm-cps" (setDumpFlag Opt_D_dump_cmm_cps)
2474 , defGhcFlag "ddump-core-stats" (setDumpFlag Opt_D_dump_core_stats)
2475 , defGhcFlag "ddump-asm" (setDumpFlag Opt_D_dump_asm)
2476 , defGhcFlag "ddump-asm-native" (setDumpFlag Opt_D_dump_asm_native)
2477 , defGhcFlag "ddump-asm-liveness" (setDumpFlag Opt_D_dump_asm_liveness)
2478 , defGhcFlag "ddump-asm-regalloc" (setDumpFlag Opt_D_dump_asm_regalloc)
2479 , defGhcFlag "ddump-asm-conflicts" (setDumpFlag Opt_D_dump_asm_conflicts)
2480 , defGhcFlag "ddump-asm-regalloc-stages"
2481 (setDumpFlag Opt_D_dump_asm_regalloc_stages)
2482 , defGhcFlag "ddump-asm-stats" (setDumpFlag Opt_D_dump_asm_stats)
2483 , defGhcFlag "ddump-asm-expanded" (setDumpFlag Opt_D_dump_asm_expanded)
2484 , defGhcFlag "ddump-llvm" (NoArg (do setObjTarget HscLlvm
2485 setDumpFlag' Opt_D_dump_llvm))
2486 , defGhcFlag "ddump-deriv" (setDumpFlag Opt_D_dump_deriv)
2487 , defGhcFlag "ddump-ds" (setDumpFlag Opt_D_dump_ds)
2488 , defGhcFlag "ddump-foreign" (setDumpFlag Opt_D_dump_foreign)
2489 , defGhcFlag "ddump-inlinings" (setDumpFlag Opt_D_dump_inlinings)
2490 , defGhcFlag "ddump-rule-firings" (setDumpFlag Opt_D_dump_rule_firings)
2491 , defGhcFlag "ddump-rule-rewrites" (setDumpFlag Opt_D_dump_rule_rewrites)
2492 , defGhcFlag "ddump-simpl-trace" (setDumpFlag Opt_D_dump_simpl_trace)
2493 , defGhcFlag "ddump-occur-anal" (setDumpFlag Opt_D_dump_occur_anal)
2494 , defGhcFlag "ddump-parsed" (setDumpFlag Opt_D_dump_parsed)
2495 , defGhcFlag "ddump-rn" (setDumpFlag Opt_D_dump_rn)
2496 , defGhcFlag "ddump-simpl" (setDumpFlag Opt_D_dump_simpl)
2497 , defGhcFlag "ddump-simpl-iterations"
2498 (setDumpFlag Opt_D_dump_simpl_iterations)
2499 , defGhcFlag "ddump-spec" (setDumpFlag Opt_D_dump_spec)
2500 , defGhcFlag "ddump-prep" (setDumpFlag Opt_D_dump_prep)
2501 , defGhcFlag "ddump-stg" (setDumpFlag Opt_D_dump_stg)
2502 , defGhcFlag "ddump-call-arity" (setDumpFlag Opt_D_dump_call_arity)
2503 , defGhcFlag "ddump-stranal" (setDumpFlag Opt_D_dump_stranal)
2504 , defGhcFlag "ddump-strsigs" (setDumpFlag Opt_D_dump_strsigs)
2505 , defGhcFlag "ddump-tc" (setDumpFlag Opt_D_dump_tc)
2506 , defGhcFlag "ddump-types" (setDumpFlag Opt_D_dump_types)
2507 , defGhcFlag "ddump-rules" (setDumpFlag Opt_D_dump_rules)
2508 , defGhcFlag "ddump-cse" (setDumpFlag Opt_D_dump_cse)
2509 , defGhcFlag "ddump-worker-wrapper" (setDumpFlag Opt_D_dump_worker_wrapper)
2510 , defGhcFlag "ddump-rn-trace" (setDumpFlag Opt_D_dump_rn_trace)
2511 , defGhcFlag "ddump-if-trace" (setDumpFlag Opt_D_dump_if_trace)
2512 , defGhcFlag "ddump-cs-trace" (setDumpFlag Opt_D_dump_cs_trace)
2513 , defGhcFlag "ddump-tc-trace" (NoArg (do
2514 setDumpFlag' Opt_D_dump_tc_trace
2515 setDumpFlag' Opt_D_dump_cs_trace))
2516 , defGhcFlag "ddump-vt-trace" (setDumpFlag Opt_D_dump_vt_trace)
2517 , defGhcFlag "ddump-splices" (setDumpFlag Opt_D_dump_splices)
2518 , defGhcFlag "dth-dec-file" (setDumpFlag Opt_D_th_dec_file)
2519
2520 , defGhcFlag "ddump-rn-stats" (setDumpFlag Opt_D_dump_rn_stats)
2521 , defGhcFlag "ddump-opt-cmm" (setDumpFlag Opt_D_dump_opt_cmm)
2522 , defGhcFlag "ddump-simpl-stats" (setDumpFlag Opt_D_dump_simpl_stats)
2523 , defGhcFlag "ddump-bcos" (setDumpFlag Opt_D_dump_BCOs)
2524 , defGhcFlag "dsource-stats" (setDumpFlag Opt_D_source_stats)
2525 , defGhcFlag "dverbose-core2core" (NoArg (do setVerbosity (Just 2)
2526 setVerboseCore2Core))
2527 , defGhcFlag "dverbose-stg2stg" (setDumpFlag Opt_D_verbose_stg2stg)
2528 , defGhcFlag "ddump-hi" (setDumpFlag Opt_D_dump_hi)
2529 , defGhcFlag "ddump-minimal-imports"
2530 (NoArg (setGeneralFlag Opt_D_dump_minimal_imports))
2531 , defGhcFlag "ddump-vect" (setDumpFlag Opt_D_dump_vect)
2532 , defGhcFlag "ddump-hpc"
2533 (setDumpFlag Opt_D_dump_ticked) -- back compat
2534 , defGhcFlag "ddump-ticked" (setDumpFlag Opt_D_dump_ticked)
2535 , defGhcFlag "ddump-mod-cycles" (setDumpFlag Opt_D_dump_mod_cycles)
2536 , defGhcFlag "ddump-mod-map" (setDumpFlag Opt_D_dump_mod_map)
2537 , defGhcFlag "ddump-view-pattern-commoning"
2538 (setDumpFlag Opt_D_dump_view_pattern_commoning)
2539 , defGhcFlag "ddump-to-file" (NoArg (setGeneralFlag Opt_DumpToFile))
2540 , defGhcFlag "ddump-hi-diffs" (setDumpFlag Opt_D_dump_hi_diffs)
2541 , defGhcFlag "ddump-rtti" (setDumpFlag Opt_D_dump_rtti)
2542 , defGhcFlag "dcore-lint"
2543 (NoArg (setGeneralFlag Opt_DoCoreLinting))
2544 , defGhcFlag "dstg-lint"
2545 (NoArg (setGeneralFlag Opt_DoStgLinting))
2546 , defGhcFlag "dcmm-lint"
2547 (NoArg (setGeneralFlag Opt_DoCmmLinting))
2548 , defGhcFlag "dasm-lint"
2549 (NoArg (setGeneralFlag Opt_DoAsmLinting))
2550 , defGhcFlag "dannot-lint"
2551 (NoArg (setGeneralFlag Opt_DoAnnotationLinting))
2552 , defGhcFlag "dshow-passes" (NoArg (do forceRecompile
2553 setVerbosity $ Just 2))
2554 , defGhcFlag "dfaststring-stats"
2555 (NoArg (setGeneralFlag Opt_D_faststring_stats))
2556 , defGhcFlag "dno-llvm-mangler"
2557 (NoArg (setGeneralFlag Opt_NoLlvmMangler)) -- hidden flag
2558 , defGhcFlag "ddump-debug" (setDumpFlag Opt_D_dump_debug)
2559
2560 ------ Machine dependant (-m<blah>) stuff ---------------------------
2561
2562 , defGhcFlag "msse" (noArg (\d -> d{ sseVersion = Just SSE1 }))
2563 , defGhcFlag "msse2" (noArg (\d -> d{ sseVersion = Just SSE2 }))
2564 , defGhcFlag "msse3" (noArg (\d -> d{ sseVersion = Just SSE3 }))
2565 , defGhcFlag "msse4" (noArg (\d -> d{ sseVersion = Just SSE4 }))
2566 , defGhcFlag "msse4.2" (noArg (\d -> d{ sseVersion = Just SSE42 }))
2567 , defGhcFlag "mavx" (noArg (\d -> d{ avx = True }))
2568 , defGhcFlag "mavx2" (noArg (\d -> d{ avx2 = True }))
2569 , defGhcFlag "mavx512cd" (noArg (\d -> d{ avx512cd = True }))
2570 , defGhcFlag "mavx512er" (noArg (\d -> d{ avx512er = True }))
2571 , defGhcFlag "mavx512f" (noArg (\d -> d{ avx512f = True }))
2572 , defGhcFlag "mavx512pf" (noArg (\d -> d{ avx512pf = True }))
2573
2574 ------ Warning opts -------------------------------------------------
2575 , defFlag "W" (NoArg (mapM_ setWarningFlag minusWOpts))
2576 , defFlag "Werror" (NoArg (setGeneralFlag Opt_WarnIsError))
2577 , defFlag "Wwarn" (NoArg (unSetGeneralFlag Opt_WarnIsError))
2578 , defFlag "Wcompat" (NoArg (mapM_ setWarningFlag minusWcompatOpts))
2579 , defFlag "Wno-compat" (NoArg (mapM_ unSetWarningFlag minusWcompatOpts))
2580 , defFlag "Wall" (NoArg (mapM_ setWarningFlag minusWallOpts))
2581 , defFlag "Wnot" (NoArg (do upd (\dfs -> dfs {warningFlags = IntSet.empty})
2582 deprecate "Use -w instead"))
2583 , defFlag "w" (NoArg (upd (\dfs -> dfs {warningFlags = IntSet.empty})))
2584
2585 ------ Plugin flags ------------------------------------------------
2586 , defGhcFlag "fplugin-opt" (hasArg addPluginModuleNameOption)
2587 , defGhcFlag "fplugin" (hasArg addPluginModuleName)
2588 , defGhcFlag "ffrontend-opt" (hasArg addFrontendPluginOption)
2589
2590 ------ Optimisation flags ------------------------------------------
2591 , defGhcFlag "O" (noArgM (setOptLevel 1))
2592 , defGhcFlag "Onot" (noArgM (\dflags -> do deprecate "Use -O0 instead"
2593 setOptLevel 0 dflags))
2594 , defGhcFlag "Odph" (noArgM setDPHOpt)
2595 , defGhcFlag "O" (optIntSuffixM (\mb_n -> setOptLevel (mb_n `orElse` 1)))
2596 -- If the number is missing, use 1
2597
2598
2599 , defFlag "fmax-relevant-binds"
2600 (intSuffix (\n d -> d{ maxRelevantBinds = Just n }))
2601 , defFlag "fno-max-relevant-binds"
2602 (noArg (\d -> d{ maxRelevantBinds = Nothing }))
2603 , defFlag "fsimplifier-phases"
2604 (intSuffix (\n d -> d{ simplPhases = n }))
2605 , defFlag "fmax-simplifier-iterations"
2606 (intSuffix (\n d -> d{ maxSimplIterations = n }))
2607 , defFlag "fsimpl-tick-factor"
2608 (intSuffix (\n d -> d{ simplTickFactor = n }))
2609 , defFlag "fspec-constr-threshold"
2610 (intSuffix (\n d -> d{ specConstrThreshold = Just n }))
2611 , defFlag "fno-spec-constr-threshold"
2612 (noArg (\d -> d{ specConstrThreshold = Nothing }))
2613 , defFlag "fspec-constr-count"
2614 (intSuffix (\n d -> d{ specConstrCount = Just n }))
2615 , defFlag "fno-spec-constr-count"
2616 (noArg (\d -> d{ specConstrCount = Nothing }))
2617 , defFlag "fspec-constr-recursive"
2618 (intSuffix (\n d -> d{ specConstrRecursive = n }))
2619 , defFlag "fliberate-case-threshold"
2620 (intSuffix (\n d -> d{ liberateCaseThreshold = Just n }))
2621 , defFlag "fno-liberate-case-threshold"
2622 (noArg (\d -> d{ liberateCaseThreshold = Nothing }))
2623 , defFlag "frule-check"
2624 (sepArg (\s d -> d{ ruleCheck = Just s }))
2625 , defFlag "freduction-depth"
2626 (intSuffix (\n d -> d{ reductionDepth = treatZeroAsInf n }))
2627 , defFlag "fconstraint-solver-iterations"
2628 (intSuffix (\n d -> d{ solverIterations = treatZeroAsInf n }))
2629 , defFlag "fcontext-stack"
2630 (intSuffixM (\n d ->
2631 do { deprecate $ "use -freduction-depth=" ++ show n ++ " instead"
2632 ; return $ d{ reductionDepth = treatZeroAsInf n } }))
2633 , defFlag "ftype-function-depth"
2634 (intSuffixM (\n d ->
2635 do { deprecate $ "use -freduction-depth=" ++ show n ++ " instead"
2636 ; return $ d{ reductionDepth = treatZeroAsInf n } }))
2637 , defFlag "fstrictness-before"
2638 (intSuffix (\n d -> d{ strictnessBefore = n : strictnessBefore d }))
2639 , defFlag "ffloat-lam-args"
2640 (intSuffix (\n d -> d{ floatLamArgs = Just n }))
2641 , defFlag "ffloat-all-lams"
2642 (noArg (\d -> d{ floatLamArgs = Nothing }))
2643
2644 , defFlag "fhistory-size" (intSuffix (\n d -> d{ historySize = n }))
2645
2646 , defFlag "funfolding-creation-threshold"
2647 (intSuffix (\n d -> d {ufCreationThreshold = n}))
2648 , defFlag "funfolding-use-threshold"
2649 (intSuffix (\n d -> d {ufUseThreshold = n}))
2650 , defFlag "funfolding-fun-discount"
2651 (intSuffix (\n d -> d {ufFunAppDiscount = n}))
2652 , defFlag "funfolding-dict-discount"
2653 (intSuffix (\n d -> d {ufDictDiscount = n}))
2654 , defFlag "funfolding-keeness-factor"
2655 (floatSuffix (\n d -> d {ufKeenessFactor = n}))
2656
2657 , defFlag "fmax-worker-args" (intSuffix (\n d -> d {maxWorkerArgs = n}))
2658
2659 , defGhciFlag "fghci-hist-size" (intSuffix (\n d -> d {ghciHistSize = n}))
2660 , defGhcFlag "fmax-inline-alloc-size"
2661 (intSuffix (\n d -> d{ maxInlineAllocSize = n }))
2662 , defGhcFlag "fmax-inline-memcpy-insns"
2663 (intSuffix (\n d -> d{ maxInlineMemcpyInsns = n }))
2664 , defGhcFlag "fmax-inline-memset-insns"
2665 (intSuffix (\n d -> d{ maxInlineMemsetInsns = n }))
2666
2667 , defGhcFlag "dinitial-unique"
2668 (intSuffix (\n d -> d{ initialUnique = n }))
2669 , defGhcFlag "dunique-increment"
2670 (intSuffix (\n d -> d{ uniqueIncrement = n }))
2671
2672 ------ Profiling ----------------------------------------------------
2673
2674 -- OLD profiling flags
2675 , defGhcFlag "auto-all" (noArg (\d -> d { profAuto = ProfAutoAll } ))
2676 , defGhcFlag "no-auto-all" (noArg (\d -> d { profAuto = NoProfAuto } ))
2677 , defGhcFlag "auto" (noArg (\d -> d { profAuto = ProfAutoExports } ))
2678 , defGhcFlag "no-auto" (noArg (\d -> d { profAuto = NoProfAuto } ))
2679 , defGhcFlag "caf-all"
2680 (NoArg (setGeneralFlag Opt_AutoSccsOnIndividualCafs))
2681 , defGhcFlag "no-caf-all"
2682 (NoArg (unSetGeneralFlag Opt_AutoSccsOnIndividualCafs))
2683
2684 -- NEW profiling flags
2685 , defGhcFlag "fprof-auto"
2686 (noArg (\d -> d { profAuto = ProfAutoAll } ))
2687 , defGhcFlag "fprof-auto-top"
2688 (noArg (\d -> d { profAuto = ProfAutoTop } ))
2689 , defGhcFlag "fprof-auto-exported"
2690 (noArg (\d -> d { profAuto = ProfAutoExports } ))
2691 , defGhcFlag "fprof-auto-calls"
2692 (noArg (\d -> d { profAuto = ProfAutoCalls } ))
2693 , defGhcFlag "fno-prof-auto"
2694 (noArg (\d -> d { profAuto = NoProfAuto } ))
2695
2696 ------ Compiler flags -----------------------------------------------
2697
2698 , defGhcFlag "fasm" (NoArg (setObjTarget HscAsm))
2699 , defGhcFlag "fvia-c" (NoArg
2700 (addWarn $ "The -fvia-c flag does nothing; " ++
2701 "it will be removed in a future GHC release"))
2702 , defGhcFlag "fvia-C" (NoArg
2703 (addWarn $ "The -fvia-C flag does nothing; " ++
2704 "it will be removed in a future GHC release"))
2705 , defGhcFlag "fllvm" (NoArg (setObjTarget HscLlvm))
2706
2707 , defFlag "fno-code" (NoArg (do upd $ \d -> d{ ghcLink=NoLink }
2708 setTarget HscNothing))
2709 , defFlag "fbyte-code" (NoArg (setTarget HscInterpreted))
2710 , defFlag "fobject-code" (NoArg (setTargetWithPlatform defaultHscTarget))
2711 , defFlag "fglasgow-exts"
2712 (NoArg (do enableGlasgowExts
2713 deprecate "Use individual extensions instead"))
2714 , defFlag "fno-glasgow-exts"
2715 (NoArg (do disableGlasgowExts
2716 deprecate "Use individual extensions instead"))
2717 , defFlag "Wunused-binds" (NoArg enableUnusedBinds)
2718 , defFlag "Wno-unused-binds" (NoArg disableUnusedBinds)
2719 , defHiddenFlag "fwarn-unused-binds" (NoArg enableUnusedBinds)
2720 , defHiddenFlag "fno-warn-unused-binds" (NoArg disableUnusedBinds)
2721
2722 ------ Safe Haskell flags -------------------------------------------
2723 , defFlag "fpackage-trust" (NoArg setPackageTrust)
2724 , defFlag "fno-safe-infer" (noArg (\d -> d { safeInfer = False } ))
2725 , defGhcFlag "fPIC" (NoArg (setGeneralFlag Opt_PIC))
2726 , defGhcFlag "fno-PIC" (NoArg (unSetGeneralFlag Opt_PIC))
2727
2728 ------ Debugging flags ----------------------------------------------
2729 , defGhcFlag "g" (OptIntSuffix setDebugLevel)
2730 ]
2731 ++ map (mkFlag turnOn "" setGeneralFlag ) negatableFlags
2732 ++ map (mkFlag turnOff "no-" unSetGeneralFlag ) negatableFlags
2733 ++ map (mkFlag turnOn "d" setGeneralFlag ) dFlags
2734 ++ map (mkFlag turnOff "dno-" unSetGeneralFlag ) dFlags
2735 ++ map (mkFlag turnOn "f" setGeneralFlag ) fFlags
2736 ++ map (mkFlag turnOff "fno-" unSetGeneralFlag ) fFlags
2737 ++ map (mkFlag turnOn "W" setWarningFlag ) wWarningFlags
2738 ++ map (mkFlag turnOff "Wno-" unSetWarningFlag ) wWarningFlags
2739 ++ map (mkFlag turnOn "fwarn-" setWarningFlag . hideFlag) wWarningFlags
2740 ++ map (mkFlag turnOff "fno-warn-" unSetWarningFlag . hideFlag) wWarningFlags
2741 ++ map (mkFlag turnOn "f" setExtensionFlag ) fLangFlags
2742 ++ map (mkFlag turnOff "fno-" unSetExtensionFlag) fLangFlags
2743 ++ map (mkFlag turnOn "X" setExtensionFlag ) xFlags
2744 ++ map (mkFlag turnOff "XNo" unSetExtensionFlag) xFlags
2745 ++ map (mkFlag turnOn "X" setLanguage ) languageFlags
2746 ++ map (mkFlag turnOn "X" setSafeHaskell ) safeHaskellFlags
2747 ++ [ defFlag "XGenerics"
2748 (NoArg (deprecate $
2749 "it does nothing; look into -XDefaultSignatures " ++
2750 "and -XDeriveGeneric for generic programming support."))
2751 , defFlag "XNoGenerics"
2752 (NoArg (deprecate $
2753 "it does nothing; look into -XDefaultSignatures and " ++
2754 "-XDeriveGeneric for generic programming support.")) ]
2755
2756 -- See Note [Supporting CLI completion]
2757 package_flags :: [Flag (CmdLineP DynFlags)]
2758 package_flags = [
2759 ------- Packages ----------------------------------------------------
2760 defFlag "package-db" (HasArg (addPkgConfRef . PkgConfFile))
2761 , defFlag "clear-package-db" (NoArg clearPkgConf)
2762 , defFlag "no-global-package-db" (NoArg removeGlobalPkgConf)
2763 , defFlag "no-user-package-db" (NoArg removeUserPkgConf)
2764 , defFlag "global-package-db" (NoArg (addPkgConfRef GlobalPkgConf))
2765 , defFlag "user-package-db" (NoArg (addPkgConfRef UserPkgConf))
2766
2767 -- backwards compat with GHC<=7.4 :
2768 , defFlag "package-conf" (HasArg $ \path -> do
2769 addPkgConfRef (PkgConfFile path)
2770 deprecate "Use -package-db instead")
2771 , defFlag "no-user-package-conf"
2772 (NoArg $ do removeUserPkgConf
2773 deprecate "Use -no-user-package-db instead")
2774
2775 , defGhcFlag "package-name" (HasArg $ \name -> do
2776 upd (setUnitId name))
2777 -- TODO: Since we JUST deprecated
2778 -- -this-package-key, let's keep this
2779 -- undeprecated for another cycle.
2780 -- Deprecate this eventually.
2781 -- deprecate "Use -this-unit-id instead")
2782 , defGhcFlag "this-package-key" (HasArg $ \name -> do
2783 upd (setUnitId name)
2784 deprecate "Use -this-unit-id instead")
2785 , defGhcFlag "this-unit-id" (hasArg setUnitId)
2786 , defFlag "package" (HasArg exposePackage)
2787 , defFlag "plugin-package-id" (HasArg exposePluginPackageId)
2788 , defFlag "plugin-package" (HasArg exposePluginPackage)
2789 , defFlag "package-id" (HasArg exposePackageId)
2790 , defFlag "hide-package" (HasArg hidePackage)
2791 , defFlag "hide-all-packages" (NoArg (setGeneralFlag Opt_HideAllPackages))
2792 , defFlag "hide-all-plugin-packages" (NoArg (setGeneralFlag Opt_HideAllPluginPackages))
2793 , defFlag "package-env" (HasArg setPackageEnv)
2794 , defFlag "ignore-package" (HasArg ignorePackage)
2795 , defFlag "syslib"
2796 (HasArg (\s -> do exposePackage s
2797 deprecate "Use -package instead"))
2798 , defFlag "distrust-all-packages"
2799 (NoArg (setGeneralFlag Opt_DistrustAllPackages))
2800 , defFlag "trust" (HasArg trustPackage)
2801 , defFlag "distrust" (HasArg distrustPackage)
2802 ]
2803 where
2804 setPackageEnv env = upd $ \s -> s { packageEnv = Just env }
2805
2806 -- | Make a list of flags for shell completion.
2807 -- Filter all available flags into two groups, for interactive GHC vs all other.
2808 flagsForCompletion :: Bool -> [String]
2809 flagsForCompletion isInteractive
2810 = [ '-':flagName flag
2811 | flag <- flagsAll
2812 , modeFilter (flagGhcMode flag)
2813 ]
2814 where
2815 modeFilter AllModes = True
2816 modeFilter OnlyGhci = isInteractive
2817 modeFilter OnlyGhc = not isInteractive
2818 modeFilter HiddenFlag = False
2819
2820 type TurnOnFlag = Bool -- True <=> we are turning the flag on
2821 -- False <=> we are turning the flag off
2822 turnOn :: TurnOnFlag; turnOn = True
2823 turnOff :: TurnOnFlag; turnOff = False
2824
2825 data FlagSpec flag
2826 = FlagSpec
2827 { flagSpecName :: String -- ^ Flag in string form
2828 , flagSpecFlag :: flag -- ^ Flag in internal form
2829 , flagSpecAction :: (TurnOnFlag -> DynP ())
2830 -- ^ Extra action to run when the flag is found
2831 -- Typically, emit a warning or error
2832 , flagSpecGhcMode :: GhcFlagMode
2833 -- ^ In which ghc mode the flag has effect
2834 }
2835
2836 -- | Define a new flag.
2837 flagSpec :: String -> flag -> FlagSpec flag
2838 flagSpec name flag = flagSpec' name flag nop
2839
2840 -- | Define a new flag with an effect.
2841 flagSpec' :: String -> flag -> (TurnOnFlag -> DynP ()) -> FlagSpec flag
2842 flagSpec' name flag act = FlagSpec name flag act AllModes
2843
2844 -- | Define a new flag for GHCi.
2845 flagGhciSpec :: String -> flag -> FlagSpec flag
2846 flagGhciSpec name flag = flagGhciSpec' name flag nop
2847
2848 -- | Define a new flag for GHCi with an effect.
2849 flagGhciSpec' :: String -> flag -> (TurnOnFlag -> DynP ()) -> FlagSpec flag
2850 flagGhciSpec' name flag act = FlagSpec name flag act OnlyGhci
2851
2852 -- | Define a new flag invisible to CLI completion.
2853 flagHiddenSpec :: String -> flag -> FlagSpec flag
2854 flagHiddenSpec name flag = flagHiddenSpec' name flag nop
2855
2856 -- | Define a new flag invisible to CLI completion with an effect.
2857 flagHiddenSpec' :: String -> flag -> (TurnOnFlag -> DynP ()) -> FlagSpec flag
2858 flagHiddenSpec' name flag act = FlagSpec name flag act HiddenFlag
2859
2860 -- | Hide a 'FlagSpec' from being displayed in @--show-options@.
2861 --
2862 -- This is for example useful for flags that are obsolete, but should not
2863 -- (yet) be deprecated for compatibility reasons.
2864 hideFlag :: FlagSpec a -> FlagSpec a
2865 hideFlag fs = fs { flagSpecGhcMode = HiddenFlag }
2866
2867 mkFlag :: TurnOnFlag -- ^ True <=> it should be turned on
2868 -> String -- ^ The flag prefix
2869 -> (flag -> DynP ()) -- ^ What to do when the flag is found
2870 -> FlagSpec flag -- ^ Specification of this particular flag
2871 -> Flag (CmdLineP DynFlags)
2872 mkFlag turn_on flagPrefix f (FlagSpec name flag extra_action mode)
2873 = Flag (flagPrefix ++ name) (NoArg (f flag >> extra_action turn_on)) mode
2874
2875 deprecatedForExtension :: String -> TurnOnFlag -> DynP ()
2876 deprecatedForExtension lang turn_on
2877 = deprecate ("use -X" ++ flag ++
2878 " or pragma {-# LANGUAGE " ++ flag ++ " #-} instead")
2879 where
2880 flag | turn_on = lang
2881 | otherwise = "No"++lang
2882
2883 useInstead :: String -> TurnOnFlag -> DynP ()
2884 useInstead flag turn_on
2885 = deprecate ("Use -f" ++ no ++ flag ++ " instead")
2886 where
2887 no = if turn_on then "" else "no-"
2888
2889 nop :: TurnOnFlag -> DynP ()
2890 nop _ = return ()
2891
2892 -- | These @-W\<blah\>@ flags can all be reversed with @-Wno-\<blah\>@
2893 wWarningFlags :: [FlagSpec WarningFlag]
2894 wWarningFlags = [
2895 -- See Note [Updating flag description in the User's Guide]
2896 -- See Note [Supporting CLI completion]
2897 -- Please keep the list of flags below sorted alphabetically
2898 flagSpec "alternative-layout-rule-transitional"
2899 Opt_WarnAlternativeLayoutRuleTransitional,
2900 flagSpec' "amp" Opt_WarnAMP
2901 (\_ -> deprecate "it has no effect"),
2902 flagSpec' "auto-orphans" Opt_WarnAutoOrphans
2903 (\_ -> deprecate "it has no effect"),
2904 flagSpec "deferred-type-errors" Opt_WarnDeferredTypeErrors,
2905 flagSpec "deprecations" Opt_WarnWarningsDeprecations,
2906 flagSpec "deprecated-flags" Opt_WarnDeprecatedFlags,
2907 flagSpec "deriving-typeable" Opt_WarnDerivingTypeable,
2908 flagSpec "dodgy-exports" Opt_WarnDodgyExports,
2909 flagSpec "dodgy-foreign-imports" Opt_WarnDodgyForeignImports,
2910 flagSpec "dodgy-imports" Opt_WarnDodgyImports,
2911 flagSpec "empty-enumerations" Opt_WarnEmptyEnumerations,
2912 flagSpec' "context-quantification" Opt_WarnContextQuantification
2913 (\_ -> deprecate "it is subsumed by an error message that cannot be disabled"),
2914 flagSpec' "duplicate-constraints" Opt_WarnDuplicateConstraints
2915 (\_ -> deprecate "it is subsumed by -Wredundant-constraints"),
2916 flagSpec "redundant-constraints" Opt_WarnRedundantConstraints,
2917 flagSpec "duplicate-exports" Opt_WarnDuplicateExports,
2918 flagSpec "hi-shadowing" Opt_WarnHiShadows,
2919 flagSpec "implicit-prelude" Opt_WarnImplicitPrelude,
2920 flagSpec "incomplete-patterns" Opt_WarnIncompletePatterns,
2921 flagSpec "incomplete-record-updates" Opt_WarnIncompletePatternsRecUpd,
2922 flagSpec "incomplete-uni-patterns" Opt_WarnIncompleteUniPatterns,
2923 flagSpec "inline-rule-shadowing" Opt_WarnInlineRuleShadowing,
2924 flagSpec "identities" Opt_WarnIdentities,
2925 flagSpec "missing-fields" Opt_WarnMissingFields,
2926 flagSpec "missing-import-lists" Opt_WarnMissingImportList,
2927 flagSpec "missing-local-sigs" Opt_WarnMissingLocalSigs,
2928 flagSpec "missing-methods" Opt_WarnMissingMethods,
2929 flagSpec "missing-monadfail-instance" Opt_WarnMissingMonadFailInstance,
2930 flagSpec "semigroup" Opt_WarnSemigroup,
2931 flagSpec "missing-signatures" Opt_WarnMissingSigs,
2932 flagSpec "missing-exported-sigs" Opt_WarnMissingExportedSigs,
2933 flagSpec "monomorphism-restriction" Opt_WarnMonomorphism,
2934 flagSpec "name-shadowing" Opt_WarnNameShadowing,
2935 flagSpec "noncanonical-monad-instances"
2936 Opt_WarnNonCanonicalMonadInstances,
2937 flagSpec "noncanonical-monoid-instances"
2938 Opt_WarnNonCanonicalMonoidInstances,
2939 flagSpec "orphans" Opt_WarnOrphans,
2940 flagSpec "overflowed-literals" Opt_WarnOverflowedLiterals,
2941 flagSpec "overlapping-patterns" Opt_WarnOverlappingPatterns,
2942 flagSpec "too-many-guards" Opt_WarnTooManyGuards,
2943 flagSpec "missed-specialisations" Opt_WarnMissedSpecs,
2944 flagSpec "all-missed-specialisations" Opt_WarnAllMissedSpecs,
2945 flagSpec' "safe" Opt_WarnSafe setWarnSafe,
2946 flagSpec "trustworthy-safe" Opt_WarnTrustworthySafe,
2947 flagSpec "tabs" Opt_WarnTabs,
2948 flagSpec "type-defaults" Opt_WarnTypeDefaults,
2949 flagSpec "typed-holes" Opt_WarnTypedHoles,
2950 flagSpec "partial-type-signatures" Opt_WarnPartialTypeSignatures,
2951 flagSpec "unrecognised-pragmas" Opt_WarnUnrecognisedPragmas,
2952 flagSpec' "unsafe" Opt_WarnUnsafe setWarnUnsafe,
2953 flagSpec "unsupported-calling-conventions"
2954 Opt_WarnUnsupportedCallingConventions,
2955 flagSpec "unsupported-llvm-version" Opt_WarnUnsupportedLlvmVersion,
2956 flagSpec "unticked-promoted-constructors"
2957 Opt_WarnUntickedPromotedConstructors,
2958 flagSpec "unused-do-bind" Opt_WarnUnusedDoBind,
2959 flagSpec "unused-imports" Opt_WarnUnusedImports,
2960 flagSpec "unused-local-binds" Opt_WarnUnusedLocalBinds,
2961 flagSpec "unused-matches" Opt_WarnUnusedMatches,
2962 flagSpec "unused-pattern-binds" Opt_WarnUnusedPatternBinds,
2963 flagSpec "unused-top-binds" Opt_WarnUnusedTopBinds,
2964 flagSpec "warnings-deprecations" Opt_WarnWarningsDeprecations,
2965 flagSpec "wrong-do-bind" Opt_WarnWrongDoBind,
2966 flagSpec "missing-pat-syn-sigs" Opt_WarnMissingPatSynSigs]
2967
2968 -- | These @-\<blah\>@ flags can all be reversed with @-no-\<blah\>@
2969 negatableFlags :: [FlagSpec GeneralFlag]
2970 negatableFlags = [
2971 flagGhciSpec "ignore-dot-ghci" Opt_IgnoreDotGhci ]
2972
2973 -- | These @-d\<blah\>@ flags can all be reversed with @-dno-\<blah\>@
2974 dFlags :: [FlagSpec GeneralFlag]
2975 dFlags = [
2976 -- See Note [Updating flag description in the User's Guide]
2977 -- See Note [Supporting CLI completion]
2978 -- Please keep the list of flags below sorted alphabetically
2979 flagSpec "ppr-case-as-let" Opt_PprCaseAsLet,
2980 flagSpec "ppr-ticks" Opt_PprShowTicks,
2981 flagSpec "suppress-coercions" Opt_SuppressCoercions,
2982 flagSpec "suppress-idinfo" Opt_SuppressIdInfo,
2983 flagSpec "suppress-unfoldings" Opt_SuppressUnfoldings,
2984 flagSpec "suppress-module-prefixes" Opt_SuppressModulePrefixes,
2985 flagSpec "suppress-type-applications" Opt_SuppressTypeApplications,
2986 flagSpec "suppress-type-signatures" Opt_SuppressTypeSignatures,
2987 flagSpec "suppress-uniques" Opt_SuppressUniques,
2988 flagSpec "suppress-var-kinds" Opt_SuppressVarKinds]
2989
2990 -- | These @-f\<blah\>@ flags can all be reversed with @-fno-\<blah\>@
2991 fFlags :: [FlagSpec GeneralFlag]
2992 fFlags = [
2993 -- See Note [Updating flag description in the User's Guide]
2994 -- See Note [Supporting CLI completion]
2995 -- Please keep the list of flags below sorted alphabetically
2996 flagGhciSpec "break-on-error" Opt_BreakOnError,
2997 flagGhciSpec "break-on-exception" Opt_BreakOnException,
2998 flagSpec "building-cabal-package" Opt_BuildingCabalPackage,
2999 flagSpec "call-arity" Opt_CallArity,
3000 flagSpec "case-merge" Opt_CaseMerge,
3001 flagSpec "cmm-elim-common-blocks" Opt_CmmElimCommonBlocks,
3002 flagSpec "cmm-sink" Opt_CmmSink,
3003 flagSpec "cse" Opt_CSE,
3004 flagSpec "cpr-anal" Opt_CprAnal,
3005 flagSpec "defer-type-errors" Opt_DeferTypeErrors,
3006 flagSpec "defer-typed-holes" Opt_DeferTypedHoles,
3007 flagSpec "dicts-cheap" Opt_DictsCheap,
3008 flagSpec "dicts-strict" Opt_DictsStrict,
3009 flagSpec "dmd-tx-dict-sel" Opt_DmdTxDictSel,
3010 flagSpec "do-eta-reduction" Opt_DoEtaReduction,
3011 flagSpec "do-lambda-eta-expansion" Opt_DoLambdaEtaExpansion,
3012 flagSpec "eager-blackholing" Opt_EagerBlackHoling,
3013 flagSpec "embed-manifest" Opt_EmbedManifest,
3014 flagSpec "enable-rewrite-rules" Opt_EnableRewriteRules,
3015 flagSpec "error-spans" Opt_ErrorSpans,
3016 flagSpec "excess-precision" Opt_ExcessPrecision,
3017 flagSpec "expose-all-unfoldings" Opt_ExposeAllUnfoldings,
3018 flagSpec "external-interpreter" Opt_ExternalInterpreter,
3019 flagSpec "flat-cache" Opt_FlatCache,
3020 flagSpec "float-in" Opt_FloatIn,
3021 flagSpec "force-recomp" Opt_ForceRecomp,
3022 flagSpec "full-laziness" Opt_FullLaziness,
3023 flagSpec "fun-to-thunk" Opt_FunToThunk,
3024 flagSpec "gen-manifest" Opt_GenManifest,
3025 flagSpec "ghci-history" Opt_GhciHistory,
3026 flagSpec "ghci-sandbox" Opt_GhciSandbox,
3027 flagSpec "helpful-errors" Opt_HelpfulErrors,
3028 flagSpec "hpc" Opt_Hpc,
3029 flagSpec "ignore-asserts" Opt_IgnoreAsserts,
3030 flagSpec "ignore-interface-pragmas" Opt_IgnoreInterfacePragmas,
3031 flagGhciSpec "implicit-import-qualified" Opt_ImplicitImportQualified,
3032 flagSpec "irrefutable-tuples" Opt_IrrefutableTuples,
3033 flagSpec "kill-absence" Opt_KillAbsence,
3034 flagSpec "kill-one-shot" Opt_KillOneShot,
3035 flagSpec "late-dmd-anal" Opt_LateDmdAnal,
3036 flagSpec "liberate-case" Opt_LiberateCase,
3037 flagHiddenSpec "llvm-pass-vectors-in-regs" Opt_LlvmPassVectorsInRegisters,
3038 flagHiddenSpec "llvm-tbaa" Opt_LlvmTBAA,
3039 flagSpec "loopification" Opt_Loopification,
3040 flagSpec "omit-interface-pragmas" Opt_OmitInterfacePragmas,
3041 flagSpec "omit-yields" Opt_OmitYields,
3042 flagSpec "pedantic-bottoms" Opt_PedanticBottoms,
3043 flagSpec "pre-inlining" Opt_SimplPreInlining,
3044 flagGhciSpec "print-bind-contents" Opt_PrintBindContents,
3045 flagGhciSpec "print-bind-result" Opt_PrintBindResult,
3046 flagGhciSpec "print-evld-with-show" Opt_PrintEvldWithShow,
3047 flagSpec "print-explicit-foralls" Opt_PrintExplicitForalls,
3048 flagSpec "print-explicit-kinds" Opt_PrintExplicitKinds,
3049 flagSpec "print-explicit-coercions" Opt_PrintExplicitCoercions,
3050 flagSpec "print-equality-relations" Opt_PrintEqualityRelations,
3051 flagSpec "print-unicode-syntax" Opt_PrintUnicodeSyntax,
3052 flagSpec "print-expanded-synonyms" Opt_PrintExpandedSynonyms,
3053 flagSpec "print-potential-instances" Opt_PrintPotentialInstances,
3054 flagSpec "print-typechecker-elaboration" Opt_PrintTypecheckerElaboration,
3055 flagSpec "prof-cafs" Opt_AutoSccsOnIndividualCafs,
3056 flagSpec "prof-count-entries" Opt_ProfCountEntries,
3057 flagSpec "regs-graph" Opt_RegsGraph,
3058 flagSpec "regs-iterative" Opt_RegsIterative,
3059 flagSpec' "rewrite-rules" Opt_EnableRewriteRules
3060 (useInstead "enable-rewrite-rules"),
3061 flagSpec "shared-implib" Opt_SharedImplib,
3062 flagSpec "simple-list-literals" Opt_SimpleListLiterals,
3063 flagSpec "spec-constr" Opt_SpecConstr,
3064 flagSpec "specialise" Opt_Specialise,
3065 flagSpec "specialise-aggressively" Opt_SpecialiseAggressively,
3066 flagSpec "cross-module-specialise" Opt_CrossModuleSpecialise,
3067 flagSpec "static-argument-transformation" Opt_StaticArgumentTransformation,
3068 flagSpec "strictness" Opt_Strictness,
3069 flagSpec "use-rpaths" Opt_RPath,
3070 flagSpec "write-interface" Opt_WriteInterface,
3071 flagSpec "unbox-small-strict-fields" Opt_UnboxSmallStrictFields,
3072 flagSpec "unbox-strict-fields" Opt_UnboxStrictFields,
3073 flagSpec "vectorisation-avoidance" Opt_VectorisationAvoidance,
3074 flagSpec "vectorise" Opt_Vectorise,
3075 flagSpec "worker-wrapper" Opt_WorkerWrapper,
3076 flagSpec "full-guard-reasoning" Opt_FullGuardReasoning
3077 ]
3078
3079 -- | These @-f\<blah\>@ flags can all be reversed with @-fno-\<blah\>@
3080 fLangFlags :: [FlagSpec LangExt.Extension]
3081 fLangFlags = [
3082 -- See Note [Updating flag description in the User's Guide]
3083 -- See Note [Supporting CLI completion]
3084 flagSpec' "th" LangExt.TemplateHaskell
3085 (\on -> deprecatedForExtension "TemplateHaskell" on
3086 >> checkTemplateHaskellOk on),
3087 flagSpec' "fi" LangExt.ForeignFunctionInterface
3088 (deprecatedForExtension "ForeignFunctionInterface"),
3089 flagSpec' "ffi" LangExt.ForeignFunctionInterface
3090 (deprecatedForExtension "ForeignFunctionInterface"),
3091 flagSpec' "arrows" LangExt.Arrows
3092 (deprecatedForExtension "Arrows"),
3093 flagSpec' "implicit-prelude" LangExt.ImplicitPrelude
3094 (deprecatedForExtension "ImplicitPrelude"),
3095 flagSpec' "bang-patterns" LangExt.BangPatterns
3096 (deprecatedForExtension "BangPatterns"),
3097 flagSpec' "monomorphism-restriction" LangExt.MonomorphismRestriction
3098 (deprecatedForExtension "MonomorphismRestriction"),
3099 flagSpec' "mono-pat-binds" LangExt.MonoPatBinds
3100 (deprecatedForExtension "MonoPatBinds"),
3101 flagSpec' "extended-default-rules" LangExt.ExtendedDefaultRules
3102 (deprecatedForExtension "ExtendedDefaultRules"),
3103 flagSpec' "implicit-params" LangExt.ImplicitParams
3104 (deprecatedForExtension "ImplicitParams"),
3105 flagSpec' "scoped-type-variables" LangExt.ScopedTypeVariables
3106 (deprecatedForExtension "ScopedTypeVariables"),
3107 flagSpec' "parr" LangExt.ParallelArrays
3108 (deprecatedForExtension "ParallelArrays"),
3109 flagSpec' "PArr" LangExt.ParallelArrays
3110 (deprecatedForExtension "ParallelArrays"),
3111 flagSpec' "allow-overlapping-instances" LangExt.OverlappingInstances
3112 (deprecatedForExtension "OverlappingInstances"),
3113 flagSpec' "allow-undecidable-instances" LangExt.UndecidableInstances
3114 (deprecatedForExtension "UndecidableInstances"),
3115 flagSpec' "allow-incoherent-instances" LangExt.IncoherentInstances
3116 (deprecatedForExtension "IncoherentInstances")
3117 ]
3118
3119 supportedLanguages :: [String]
3120 supportedLanguages = map flagSpecName languageFlags
3121
3122 supportedLanguageOverlays :: [String]
3123 supportedLanguageOverlays = map flagSpecName safeHaskellFlags
3124
3125 supportedExtensions :: [String]
3126 supportedExtensions = concatMap toFlagSpecNamePair xFlags
3127 where
3128 toFlagSpecNamePair flg
3129 #ifndef GHCI
3130 -- make sure that `ghc --supported-extensions` omits
3131 -- "TemplateHaskell" when it's known to be unsupported. See also
3132 -- GHC #11102 for rationale
3133 | flagSpecFlag flg == LangExt.TemplateHaskell = [noName]
3134 #endif
3135 | otherwise = [name, noName]
3136 where
3137 noName = "No" ++ name
3138 name = flagSpecName flg
3139
3140 supportedLanguagesAndExtensions :: [String]
3141 supportedLanguagesAndExtensions =
3142 supportedLanguages ++ supportedLanguageOverlays ++ supportedExtensions
3143
3144 -- | These -X<blah> flags cannot be reversed with -XNo<blah>
3145 languageFlags :: [FlagSpec Language]
3146 languageFlags = [
3147 flagSpec "Haskell98" Haskell98,
3148 flagSpec "Haskell2010" Haskell2010
3149 ]
3150
3151 -- | These -X<blah> flags cannot be reversed with -XNo<blah>
3152 -- They are used to place hard requirements on what GHC Haskell language
3153 -- features can be used.
3154 safeHaskellFlags :: [FlagSpec SafeHaskellMode]
3155 safeHaskellFlags = [mkF Sf_Unsafe, mkF Sf_Trustworthy, mkF Sf_Safe]
3156 where mkF flag = flagSpec (show flag) flag
3157
3158 -- | These -X<blah> flags can all be reversed with -XNo<blah>
3159 xFlags :: [FlagSpec LangExt.Extension]
3160 xFlags = [
3161 -- See Note [Updating flag description in the User's Guide]
3162 -- See Note [Supporting CLI completion]
3163 -- See Note [Adding a language extension]
3164 -- Please keep the list of flags below sorted alphabetically
3165 flagSpec "AllowAmbiguousTypes" LangExt.AllowAmbiguousTypes,
3166 flagSpec "AlternativeLayoutRule" LangExt.AlternativeLayoutRule,
3167 flagSpec "AlternativeLayoutRuleTransitional"
3168 LangExt.AlternativeLayoutRuleTransitional,
3169 flagSpec "Arrows" LangExt.Arrows,
3170 flagSpec "AutoDeriveTypeable" LangExt.AutoDeriveTypeable,
3171 flagSpec "BangPatterns" LangExt.BangPatterns,
3172 flagSpec "BinaryLiterals" LangExt.BinaryLiterals,
3173 flagSpec "CApiFFI" LangExt.CApiFFI,
3174 flagSpec "CPP" LangExt.Cpp,
3175 flagSpec "ConstrainedClassMethods" LangExt.ConstrainedClassMethods,
3176 flagSpec "ConstraintKinds" LangExt.ConstraintKinds,
3177 flagSpec "DataKinds" LangExt.DataKinds,
3178 flagSpec' "DatatypeContexts" LangExt.DatatypeContexts
3179 (\ turn_on -> when turn_on $
3180 deprecate $ "It was widely considered a misfeature, " ++
3181 "and has been removed from the Haskell language."),
3182 flagSpec "DefaultSignatures" LangExt.DefaultSignatures,
3183 flagSpec "DeriveAnyClass" LangExt.DeriveAnyClass,
3184 flagSpec "DeriveDataTypeable" LangExt.DeriveDataTypeable,
3185 flagSpec "DeriveFoldable" LangExt.DeriveFoldable,
3186 flagSpec "DeriveFunctor" LangExt.DeriveFunctor,
3187 flagSpec "DeriveGeneric" LangExt.DeriveGeneric,
3188 flagSpec "DeriveLift" LangExt.DeriveLift,
3189 flagSpec "DeriveTraversable" LangExt.DeriveTraversable,
3190 flagSpec "DisambiguateRecordFields" LangExt.DisambiguateRecordFields,
3191 flagSpec "DoAndIfThenElse" LangExt.DoAndIfThenElse,
3192 flagSpec' "DoRec" LangExt.RecursiveDo
3193 (deprecatedForExtension "RecursiveDo"),
3194 flagSpec "DuplicateRecordFields" LangExt.DuplicateRecordFields,
3195 flagSpec "EmptyCase" LangExt.EmptyCase,
3196 flagSpec "EmptyDataDecls" LangExt.EmptyDataDecls,
3197 flagSpec "ExistentialQuantification" LangExt.ExistentialQuantification,
3198 flagSpec "ExplicitForAll" LangExt.ExplicitForAll,
3199 flagSpec "ExplicitNamespaces" LangExt.ExplicitNamespaces,
3200 flagSpec "ExtendedDefaultRules" LangExt.ExtendedDefaultRules,
3201 flagSpec "FlexibleContexts" LangExt.FlexibleContexts,
3202 flagSpec "FlexibleInstances" LangExt.FlexibleInstances,
3203 flagSpec "ForeignFunctionInterface" LangExt.ForeignFunctionInterface,
3204 flagSpec "FunctionalDependencies" LangExt.FunctionalDependencies,
3205 flagSpec "GADTSyntax" LangExt.GADTSyntax,
3206 flagSpec "GADTs" LangExt.GADTs,
3207 flagSpec "GHCForeignImportPrim" LangExt.GHCForeignImportPrim,
3208 flagSpec' "GeneralizedNewtypeDeriving" LangExt.GeneralizedNewtypeDeriving
3209 setGenDeriving,
3210 flagSpec "ImplicitParams" LangExt.ImplicitParams,
3211 flagSpec "ImplicitPrelude" LangExt.ImplicitPrelude,
3212 flagSpec "ImpredicativeTypes" LangExt.ImpredicativeTypes,
3213 flagSpec' "IncoherentInstances" LangExt.IncoherentInstances
3214 setIncoherentInsts,
3215 flagSpec "TypeFamilyDependencies" LangExt.TypeFamilyDependencies,
3216 flagSpec "InstanceSigs" LangExt.InstanceSigs,
3217 flagSpec "ApplicativeDo" LangExt.ApplicativeDo,
3218 flagSpec "InterruptibleFFI" LangExt.InterruptibleFFI,
3219 flagSpec "JavaScriptFFI" LangExt.JavaScriptFFI,
3220 flagSpec "KindSignatures" LangExt.KindSignatures,
3221 flagSpec "LambdaCase" LangExt.LambdaCase,
3222 flagSpec "LiberalTypeSynonyms" LangExt.LiberalTypeSynonyms,
3223 flagSpec "MagicHash" LangExt.MagicHash,
3224 flagSpec "MonadComprehensions" LangExt.MonadComprehensions,
3225 flagSpec "MonadFailDesugaring" LangExt.MonadFailDesugaring,
3226 flagSpec "MonoLocalBinds" LangExt.MonoLocalBinds,
3227 flagSpec' "MonoPatBinds" LangExt.MonoPatBinds
3228 (\ turn_on -> when turn_on $
3229 deprecate "Experimental feature now removed; has no effect"),
3230 flagSpec "MonomorphismRestriction" LangExt.MonomorphismRestriction,
3231 flagSpec "MultiParamTypeClasses" LangExt.MultiParamTypeClasses,
3232 flagSpec "MultiWayIf" LangExt.MultiWayIf,
3233 flagSpec "NPlusKPatterns" LangExt.NPlusKPatterns,
3234 flagSpec "NamedFieldPuns" LangExt.RecordPuns,
3235 flagSpec "NamedWildCards" LangExt.NamedWildCards,
3236 flagSpec "NegativeLiterals" LangExt.NegativeLiterals,
3237 flagSpec "NondecreasingIndentation" LangExt.NondecreasingIndentation,
3238 flagSpec' "NullaryTypeClasses" LangExt.NullaryTypeClasses
3239 (deprecatedForExtension "MultiParamTypeClasses"),
3240 flagSpec "NumDecimals" LangExt.NumDecimals,
3241 flagSpec' "OverlappingInstances" LangExt.OverlappingInstances
3242 setOverlappingInsts,
3243 flagSpec "OverloadedLabels" LangExt.OverloadedLabels,
3244 flagSpec "OverloadedLists" LangExt.OverloadedLists,
3245 flagSpec "OverloadedStrings" LangExt.OverloadedStrings,
3246 flagSpec "PackageImports" LangExt.PackageImports,
3247 flagSpec "ParallelArrays" LangExt.ParallelArrays,
3248 flagSpec "ParallelListComp" LangExt.ParallelListComp,
3249 flagSpec "PartialTypeSignatures" LangExt.PartialTypeSignatures,
3250 flagSpec "PatternGuards" LangExt.PatternGuards,
3251 flagSpec' "PatternSignatures" LangExt.ScopedTypeVariables
3252 (deprecatedForExtension "ScopedTypeVariables"),
3253 flagSpec "PatternSynonyms" LangExt.PatternSynonyms,
3254 flagSpec "PolyKinds" LangExt.PolyKinds,
3255 flagSpec "PolymorphicComponents" LangExt.RankNTypes,
3256 flagSpec "PostfixOperators" LangExt.PostfixOperators,
3257 flagSpec "QuasiQuotes" LangExt.QuasiQuotes,
3258 flagSpec "Rank2Types" LangExt.RankNTypes,
3259 flagSpec "RankNTypes" LangExt.RankNTypes,
3260 flagSpec "RebindableSyntax" LangExt.RebindableSyntax,
3261 flagSpec' "RecordPuns" LangExt.RecordPuns
3262 (deprecatedForExtension "NamedFieldPuns"),
3263 flagSpec "RecordWildCards" LangExt.RecordWildCards,
3264 flagSpec "RecursiveDo" LangExt.RecursiveDo,
3265 flagSpec "RelaxedLayout" LangExt.RelaxedLayout,
3266 flagSpec' "RelaxedPolyRec" LangExt.RelaxedPolyRec
3267 (\ turn_on -> unless turn_on $
3268 deprecate "You can't turn off RelaxedPolyRec any more"),
3269 flagSpec "RoleAnnotations" LangExt.RoleAnnotations,
3270 flagSpec "ScopedTypeVariables" LangExt.ScopedTypeVariables,
3271 flagSpec "StandaloneDeriving" LangExt.StandaloneDeriving,
3272 flagSpec "StaticPointers" LangExt.StaticPointers,
3273 flagSpec "Strict" LangExt.Strict,
3274 flagSpec "StrictData" LangExt.StrictData,
3275 flagSpec' "TemplateHaskell" LangExt.TemplateHaskell
3276 checkTemplateHaskellOk,
3277 flagSpec "TemplateHaskellQuotes" LangExt.TemplateHaskellQuotes,
3278 flagSpec "TraditionalRecordSyntax" LangExt.TraditionalRecordSyntax,
3279 flagSpec "TransformListComp" LangExt.TransformListComp,
3280 flagSpec "TupleSections" LangExt.TupleSections,
3281 flagSpec "TypeApplications" LangExt.TypeApplications,
3282 flagSpec "TypeInType" LangExt.TypeInType,
3283 flagSpec "TypeFamilies" LangExt.TypeFamilies,
3284 flagSpec "TypeOperators" LangExt.TypeOperators,
3285 flagSpec "TypeSynonymInstances" LangExt.TypeSynonymInstances,
3286 flagSpec "UnboxedTuples" LangExt.UnboxedTuples,
3287 flagSpec "UndecidableInstances" LangExt.UndecidableInstances,
3288 flagSpec "UndecidableSuperClasses" LangExt.UndecidableSuperClasses,
3289 flagSpec "UnicodeSyntax" LangExt.UnicodeSyntax,
3290 flagSpec "UnliftedFFITypes" LangExt.UnliftedFFITypes,
3291 flagSpec "ViewPatterns" LangExt.ViewPatterns
3292 ]
3293
3294 defaultFlags :: Settings -> [GeneralFlag]
3295 defaultFlags settings
3296 -- See Note [Updating flag description in the User's Guide]
3297 = [ Opt_AutoLinkPackages,
3298 Opt_EmbedManifest,
3299 Opt_FlatCache,
3300 Opt_GenManifest,
3301 Opt_GhciHistory,
3302 Opt_GhciSandbox,
3303 Opt_HelpfulErrors,
3304 Opt_OmitYields,
3305 Opt_PrintBindContents,
3306 Opt_ProfCountEntries,
3307 Opt_RPath,
3308 Opt_SharedImplib,
3309 Opt_SimplPreInlining
3310 ]
3311
3312 ++ [f | (ns,f) <- optLevelFlags, 0 `elem` ns]
3313 -- The default -O0 options
3314
3315 ++ default_PIC platform
3316
3317 ++ concatMap (wayGeneralFlags platform) (defaultWays settings)
3318
3319 where platform = sTargetPlatform settings
3320
3321 default_PIC :: Platform -> [GeneralFlag]
3322 default_PIC platform =
3323 case (platformOS platform, platformArch platform) of
3324 (OSDarwin, ArchX86_64) -> [Opt_PIC]
3325 (OSOpenBSD, ArchX86_64) -> [Opt_PIC] -- Due to PIE support in
3326 -- OpenBSD since 5.3 release
3327 -- (1 May 2013) we need to
3328 -- always generate PIC. See
3329 -- #10597 for more
3330 -- information.
3331 _ -> []
3332
3333 -- General flags that are switched on/off when other general flags are switched
3334 -- on
3335 impliedGFlags :: [(GeneralFlag, TurnOnFlag, GeneralFlag)]
3336 impliedGFlags = [(Opt_DeferTypeErrors, turnOn, Opt_DeferTypedHoles)
3337 ,(Opt_Strictness, turnOn, Opt_WorkerWrapper)
3338 ]
3339
3340 -- General flags that are switched on/off when other general flags are switched
3341 -- off
3342 impliedOffGFlags :: [(GeneralFlag, TurnOnFlag, GeneralFlag)]
3343 impliedOffGFlags = [(Opt_Strictness, turnOff, Opt_WorkerWrapper)]
3344
3345 impliedXFlags :: [(LangExt.Extension, TurnOnFlag, LangExt.Extension)]
3346 impliedXFlags
3347 -- See Note [Updating flag description in the User's Guide]
3348 = [ (LangExt.RankNTypes, turnOn, LangExt.ExplicitForAll)
3349 , (LangExt.ScopedTypeVariables, turnOn, LangExt.ExplicitForAll)
3350 , (LangExt.LiberalTypeSynonyms, turnOn, LangExt.ExplicitForAll)
3351 , (LangExt.ExistentialQuantification, turnOn, LangExt.ExplicitForAll)
3352 , (LangExt.FlexibleInstances, turnOn, LangExt.TypeSynonymInstances)
3353 , (LangExt.FunctionalDependencies, turnOn, LangExt.MultiParamTypeClasses)
3354 , (LangExt.MultiParamTypeClasses, turnOn, LangExt.ConstrainedClassMethods) -- c.f. Trac #7854
3355 , (LangExt.TypeFamilyDependencies, turnOn, LangExt.TypeFamilies)
3356
3357 , (LangExt.RebindableSyntax, turnOff, LangExt.ImplicitPrelude) -- NB: turn off!
3358
3359 , (LangExt.GADTs, turnOn, LangExt.GADTSyntax)
3360 , (LangExt.GADTs, turnOn, LangExt.MonoLocalBinds)
3361 , (LangExt.TypeFamilies, turnOn, LangExt.MonoLocalBinds)
3362
3363 , (LangExt.TypeFamilies, turnOn, LangExt.KindSignatures) -- Type families use kind signatures
3364 , (LangExt.PolyKinds, turnOn, LangExt.KindSignatures) -- Ditto polymorphic kinds
3365 , (LangExt.TypeInType, turnOn, LangExt.DataKinds)
3366 , (LangExt.TypeInType, turnOn, LangExt.PolyKinds)
3367 , (LangExt.TypeInType, turnOn, LangExt.KindSignatures)
3368
3369 -- AutoDeriveTypeable is not very useful without DeriveDataTypeable
3370 , (LangExt.AutoDeriveTypeable, turnOn, LangExt.DeriveDataTypeable)
3371
3372 -- We turn this on so that we can export associated type
3373 -- type synonyms in subordinates (e.g. MyClass(type AssocType))
3374 , (LangExt.TypeFamilies, turnOn, LangExt.ExplicitNamespaces)
3375 , (LangExt.TypeOperators, turnOn, LangExt.ExplicitNamespaces)
3376
3377 , (LangExt.ImpredicativeTypes, turnOn, LangExt.RankNTypes)
3378
3379 -- Record wild-cards implies field disambiguation
3380 -- Otherwise if you write (C {..}) you may well get
3381 -- stuff like " 'a' not in scope ", which is a bit silly
3382 -- if the compiler has just filled in field 'a' of constructor 'C'
3383 , (LangExt.RecordWildCards, turnOn, LangExt.DisambiguateRecordFields)
3384
3385 , (LangExt.ParallelArrays, turnOn, LangExt.ParallelListComp)
3386
3387 , (LangExt.JavaScriptFFI, turnOn, LangExt.InterruptibleFFI)
3388
3389 , (LangExt.DeriveTraversable, turnOn, LangExt.DeriveFunctor)
3390 , (LangExt.DeriveTraversable, turnOn, LangExt.DeriveFoldable)
3391
3392 -- Duplicate record fields require field disambiguation
3393 , (LangExt.DuplicateRecordFields, turnOn, LangExt.DisambiguateRecordFields)
3394
3395 , (LangExt.TemplateHaskell, turnOn, LangExt.TemplateHaskellQuotes)
3396 , (LangExt.Strict, turnOn, LangExt.StrictData)
3397 , (LangExt.TypeApplications, turnOn, LangExt.AllowAmbiguousTypes)
3398 ]
3399
3400 -- Note [Documenting optimisation flags]
3401 -- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3402 --
3403 -- If you change the list of flags enabled for particular optimisation levels
3404 -- please remember to update the User's Guide. The relevant files are:
3405 --
3406 -- * utils/mkUserGuidePart/Options/
3407 -- * docs/users_guide/using.rst
3408 --
3409 -- The first contains the Flag Refrence section, which breifly lists all
3410 -- available flags. The second contains a detailed description of the
3411 -- flags. Both places should contain information whether a flag is implied by
3412 -- -O0, -O or -O2.
3413
3414 optLevelFlags :: [([Int], GeneralFlag)]
3415 optLevelFlags -- see Note [Documenting optimisation flags]
3416 = [ ([0,1,2], Opt_DoLambdaEtaExpansion)
3417 , ([0,1,2], Opt_DmdTxDictSel)
3418 , ([0,1,2], Opt_LlvmTBAA)
3419 , ([0,1,2], Opt_VectorisationAvoidance)
3420 -- This one is important for a tiresome reason:
3421 -- we want to make sure that the bindings for data
3422 -- constructors are eta-expanded. This is probably
3423 -- a good thing anyway, but it seems fragile.
3424
3425 , ([0], Opt_IgnoreInterfacePragmas)
3426 , ([0], Opt_OmitInterfacePragmas)
3427
3428 , ([1,2], Opt_CallArity)
3429 , ([1,2], Opt_CaseMerge)
3430 , ([1,2], Opt_CmmElimCommonBlocks)
3431 , ([1,2], Opt_CmmSink)
3432 , ([1,2], Opt_CSE)
3433 , ([1,2], Opt_DoEtaReduction)
3434 , ([1,2], Opt_EnableRewriteRules) -- Off for -O0; see Note [Scoping for Builtin rules]
3435 -- in PrelRules
3436 , ([1,2], Opt_FloatIn)
3437 , ([1,2], Opt_FullLaziness)
3438 , ([1,2], Opt_IgnoreAsserts)
3439 , ([1,2], Opt_Loopification)
3440 , ([1,2], Opt_Specialise)
3441 , ([1,2], Opt_CrossModuleSpecialise)
3442 , ([1,2], Opt_Strictness)
3443 , ([1,2], Opt_UnboxSmallStrictFields)
3444 , ([1,2], Opt_CprAnal)
3445 , ([1,2], Opt_WorkerWrapper)
3446
3447 , ([2], Opt_LiberateCase)
3448 , ([2], Opt_SpecConstr)
3449 -- , ([2], Opt_RegsGraph)
3450 -- RegsGraph suffers performance regression. See #7679
3451 -- , ([2], Opt_StaticArgumentTransformation)
3452 -- Static Argument Transformation needs investigation. See #9374
3453 ]
3454
3455 -- -----------------------------------------------------------------------------
3456 -- Standard sets of warning options
3457
3458 -- Note [Documenting warning flags]
3459 -- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3460 --
3461 -- If you change the list of warning enabled by default
3462 -- please remember to update the User's Guide. The relevant file is:
3463 --
3464 -- * utils/mkUserGuidePart/
3465 -- * docs/users_guide/using.rst
3466
3467 -- | Warnings enabled unless specified otherwise
3468 standardWarnings :: [WarningFlag]
3469 standardWarnings -- see Note [Documenting warning flags]
3470 = [ Opt_WarnOverlappingPatterns,
3471 Opt_WarnWarningsDeprecations,
3472 Opt_WarnDeprecatedFlags,
3473 Opt_WarnDeferredTypeErrors,
3474 Opt_WarnTypedHoles,
3475 Opt_WarnPartialTypeSignatures,
3476 Opt_WarnUnrecognisedPragmas,
3477 Opt_WarnDuplicateExports,
3478 Opt_WarnOverflowedLiterals,
3479 Opt_WarnEmptyEnumerations,
3480 Opt_WarnMissingFields,
3481 Opt_WarnMissingMethods,
3482 Opt_WarnWrongDoBind,
3483 Opt_WarnUnsupportedCallingConventions,
3484 Opt_WarnDodgyForeignImports,
3485 Opt_WarnInlineRuleShadowing,
3486 Opt_WarnAlternativeLayoutRuleTransitional,
3487 Opt_WarnUnsupportedLlvmVersion,
3488 Opt_WarnTabs
3489 ]
3490
3491 -- | Things you get with -W
3492 minusWOpts :: [WarningFlag]
3493 minusWOpts
3494 = standardWarnings ++
3495 [ Opt_WarnUnusedTopBinds,
3496 Opt_WarnUnusedLocalBinds,
3497 Opt_WarnUnusedPatternBinds,
3498 Opt_WarnUnusedMatches,
3499 Opt_WarnUnusedImports,
3500 Opt_WarnIncompletePatterns,
3501 Opt_WarnDodgyExports,
3502 Opt_WarnDodgyImports
3503 ]
3504
3505 -- | Things you get with -Wall
3506 minusWallOpts :: [WarningFlag]
3507 minusWallOpts
3508 = minusWOpts ++
3509 [ Opt_WarnTypeDefaults,
3510 Opt_WarnNameShadowing,
3511 Opt_WarnMissingSigs,
3512 Opt_WarnHiShadows,
3513 Opt_WarnOrphans,
3514 Opt_WarnUnusedDoBind,
3515 Opt_WarnTrustworthySafe,
3516 Opt_WarnUntickedPromotedConstructors,
3517 Opt_WarnMissingPatSynSigs
3518 ]
3519
3520 -- | Things you get with -Wcompat.
3521 --
3522 -- This is intended to group together warnings that will be enabled by default
3523 -- at some point in the future, so that library authors eager to make their
3524 -- code future compatible to fix issues before they even generate warnings.
3525 minusWcompatOpts :: [WarningFlag]
3526 minusWcompatOpts
3527 = [ Opt_WarnMissingMonadFailInstance
3528 , Opt_WarnSemigroup
3529 , Opt_WarnNonCanonicalMonoidInstances
3530 ]
3531
3532 enableUnusedBinds :: DynP ()
3533 enableUnusedBinds = mapM_ setWarningFlag unusedBindsFlags
3534
3535 disableUnusedBinds :: DynP ()
3536 disableUnusedBinds = mapM_ unSetWarningFlag unusedBindsFlags
3537
3538 -- Things you get with -Wunused-binds
3539 unusedBindsFlags :: [WarningFlag]
3540 unusedBindsFlags = [ Opt_WarnUnusedTopBinds
3541 , Opt_WarnUnusedLocalBinds
3542 , Opt_WarnUnusedPatternBinds
3543 ]
3544
3545 enableGlasgowExts :: DynP ()
3546 enableGlasgowExts = do setGeneralFlag Opt_PrintExplicitForalls
3547 mapM_ setExtensionFlag glasgowExtsFlags
3548
3549 disableGlasgowExts :: DynP ()
3550 disableGlasgowExts = do unSetGeneralFlag Opt_PrintExplicitForalls
3551 mapM_ unSetExtensionFlag glasgowExtsFlags
3552
3553 glasgowExtsFlags :: [LangExt.Extension]
3554 glasgowExtsFlags = [
3555 LangExt.ConstrainedClassMethods
3556 , LangExt.DeriveDataTypeable
3557 , LangExt.DeriveFoldable
3558 , LangExt.DeriveFunctor
3559 , LangExt.DeriveGeneric
3560 , LangExt.DeriveTraversable
3561 , LangExt.EmptyDataDecls
3562 , LangExt.ExistentialQuantification
3563 , LangExt.ExplicitNamespaces
3564 , LangExt.FlexibleContexts
3565 , LangExt.FlexibleInstances
3566 , LangExt.ForeignFunctionInterface
3567 , LangExt.FunctionalDependencies
3568 , LangExt.GeneralizedNewtypeDeriving
3569 , LangExt.ImplicitParams
3570 , LangExt.KindSignatures
3571 , LangExt.LiberalTypeSynonyms
3572 , LangExt.MagicHash
3573 , LangExt.MultiParamTypeClasses
3574 , LangExt.ParallelListComp
3575 , LangExt.PatternGuards
3576 , LangExt.PostfixOperators
3577 , LangExt.RankNTypes
3578 , LangExt.RecursiveDo
3579 , LangExt.ScopedTypeVariables
3580 , LangExt.StandaloneDeriving
3581 , LangExt.TypeOperators
3582 , LangExt.TypeSynonymInstances
3583 , LangExt.UnboxedTuples
3584 , LangExt.UnicodeSyntax
3585 , LangExt.UnliftedFFITypes ]
3586
3587 foreign import ccall unsafe "rts_isProfiled" rtsIsProfiledIO :: IO CInt
3588
3589 -- | Was the runtime system built with profiling enabled?
3590 rtsIsProfiled :: Bool
3591 rtsIsProfiled = unsafeDupablePerformIO rtsIsProfiledIO /= 0
3592
3593 #ifdef GHCI
3594 -- Consult the RTS to find whether GHC itself has been built with
3595 -- dynamic linking. This can't be statically known at compile-time,
3596 -- because we build both the static and dynamic versions together with
3597 -- -dynamic-too.
3598 foreign import ccall unsafe "rts_isDynamic" rtsIsDynamicIO :: IO CInt
3599
3600 dynamicGhc :: Bool
3601 dynamicGhc = unsafeDupablePerformIO rtsIsDynamicIO /= 0
3602 #else
3603 dynamicGhc :: Bool
3604 dynamicGhc = False
3605 #endif
3606
3607 setWarnSafe :: Bool -> DynP ()
3608 setWarnSafe True = getCurLoc >>= \l -> upd (\d -> d { warnSafeOnLoc = l })
3609 setWarnSafe False = return ()
3610
3611 setWarnUnsafe :: Bool -> DynP ()
3612 setWarnUnsafe True = getCurLoc >>= \l -> upd (\d -> d { warnUnsafeOnLoc = l })
3613 setWarnUnsafe False = return ()
3614
3615 setPackageTrust :: DynP ()
3616 setPackageTrust = do
3617 setGeneralFlag Opt_PackageTrust
3618 l <- getCurLoc
3619 upd $ \d -> d { pkgTrustOnLoc = l }
3620
3621 setGenDeriving :: TurnOnFlag -> DynP ()
3622 setGenDeriving True = getCurLoc >>= \l -> upd (\d -> d { newDerivOnLoc = l })
3623 setGenDeriving False = return ()
3624
3625 setOverlappingInsts :: TurnOnFlag -> DynP ()
3626 setOverlappingInsts False = return ()
3627 setOverlappingInsts True = do
3628 l <- getCurLoc
3629 upd (\d -> d { overlapInstLoc = l })
3630 deprecate "instead use per-instance pragmas OVERLAPPING/OVERLAPPABLE/OVERLAPS"
3631
3632 setIncoherentInsts :: TurnOnFlag -> DynP ()
3633 setIncoherentInsts False = return ()
3634 setIncoherentInsts True = do
3635 l <- getCurLoc
3636 upd (\d -> d { incoherentOnLoc = l })
3637
3638 checkTemplateHaskellOk :: TurnOnFlag -> DynP ()
3639 #ifdef GHCI
3640 checkTemplateHaskellOk _turn_on
3641 = getCurLoc >>= \l -> upd (\d -> d { thOnLoc = l })
3642 #else
3643 -- In stage 1, Template Haskell is simply illegal, except with -M
3644 -- We don't bleat with -M because there's no problem with TH there,
3645 -- and in fact GHC's build system does ghc -M of the DPH libraries
3646 -- with a stage1 compiler
3647 checkTemplateHaskellOk turn_on
3648 | turn_on = do dfs <- liftEwM getCmdLineState
3649 case ghcMode dfs of
3650 MkDepend -> return ()
3651 _ -> addErr msg
3652 | otherwise = return ()
3653 where
3654 msg = "Template Haskell requires GHC with interpreter support\n " ++
3655 "Perhaps you are using a stage-1 compiler?"
3656 #endif
3657
3658 {- **********************************************************************
3659 %* *
3660 DynFlags constructors
3661 %* *
3662 %********************************************************************* -}
3663
3664 type DynP = EwM (CmdLineP DynFlags)
3665
3666 upd :: (DynFlags -> DynFlags) -> DynP ()
3667 upd f = liftEwM (do dflags <- getCmdLineState
3668 putCmdLineState $! f dflags)
3669
3670 updM :: (DynFlags -> DynP DynFlags) -> DynP ()
3671 updM f = do dflags <- liftEwM getCmdLineState
3672 dflags' <- f dflags
3673 liftEwM $ putCmdLineState $! dflags'
3674
3675 --------------- Constructor functions for OptKind -----------------
3676 noArg :: (DynFlags -> DynFlags) -> OptKind (CmdLineP DynFlags)
3677 noArg fn = NoArg (upd fn)
3678
3679 noArgM :: (DynFlags -> DynP DynFlags) -> OptKind (CmdLineP DynFlags)
3680 noArgM fn = NoArg (updM fn)
3681
3682 hasArg :: (String -> DynFlags -> DynFlags) -> OptKind (CmdLineP DynFlags)
3683 hasArg fn = HasArg (upd . fn)
3684
3685 sepArg :: (String -> DynFlags -> DynFlags) -> OptKind (CmdLineP DynFlags)
3686 sepArg fn = SepArg (upd . fn)
3687
3688 intSuffix :: (Int -> DynFlags -> DynFlags) -> OptKind (CmdLineP DynFlags)
3689 intSuffix fn = IntSuffix (\n -> upd (fn n))
3690
3691 intSuffixM :: (Int -> DynFlags -> DynP DynFlags) -> OptKind (CmdLineP DynFlags)
3692 intSuffixM fn = IntSuffix (\n -> updM (fn n))
3693
3694 floatSuffix :: (Float -> DynFlags -> DynFlags) -> OptKind (CmdLineP DynFlags)
3695 floatSuffix fn = FloatSuffix (\n -> upd (fn n))
3696
3697 optIntSuffixM :: (Maybe Int -> DynFlags -> DynP DynFlags)
3698 -> OptKind (CmdLineP DynFlags)
3699 optIntSuffixM fn = OptIntSuffix (\mi -> updM (fn mi))
3700
3701 setDumpFlag :: DumpFlag -> OptKind (CmdLineP DynFlags)
3702 setDumpFlag dump_flag = NoArg (setDumpFlag' dump_flag)
3703
3704 --------------------------
3705 addWay :: Way -> DynP ()
3706 addWay w = upd (addWay' w)
3707
3708 addWay' :: Way -> DynFlags -> DynFlags
3709 addWay' w dflags0 = let platform = targetPlatform dflags0
3710 dflags1 = dflags0 { ways = w : ways dflags0 }
3711 dflags2 = foldr setGeneralFlag' dflags1
3712 (wayGeneralFlags platform w)
3713 dflags3 = foldr unSetGeneralFlag' dflags2
3714 (wayUnsetGeneralFlags platform w)
3715 in dflags3
3716
3717 removeWayDyn :: DynP ()
3718 removeWayDyn = upd (\dfs -> dfs { ways = filter (WayDyn /=) (ways dfs) })
3719
3720 --------------------------
3721 setGeneralFlag, unSetGeneralFlag :: GeneralFlag -> DynP ()
3722 setGeneralFlag f = upd (setGeneralFlag' f)
3723 unSetGeneralFlag f = upd (unSetGeneralFlag' f)
3724
3725 setGeneralFlag' :: GeneralFlag -> DynFlags -> DynFlags
3726 setGeneralFlag' f dflags = foldr ($) (gopt_set dflags f) deps
3727 where
3728 deps = [ if turn_on then setGeneralFlag' d
3729 else unSetGeneralFlag' d
3730 | (f', turn_on, d) <- impliedGFlags, f' == f ]
3731 -- When you set f, set the ones it implies
3732 -- NB: use setGeneralFlag recursively, in case the implied flags
3733 -- implies further flags
3734
3735 unSetGeneralFlag' :: GeneralFlag -> DynFlags -> DynFlags
3736 unSetGeneralFlag' f dflags = foldr ($) (gopt_unset dflags f) deps
3737 where
3738 deps = [ if turn_on then setGeneralFlag' d
3739 else unSetGeneralFlag' d
3740 | (f', turn_on, d) <- impliedOffGFlags, f' == f ]
3741 -- In general, when you un-set f, we don't un-set the things it implies.
3742 -- There are however some exceptions, e.g., -fno-strictness implies
3743 -- -fno-worker-wrapper.
3744 --
3745 -- NB: use unSetGeneralFlag' recursively, in case the implied off flags
3746 -- imply further flags.
3747
3748 --------------------------
3749 setWarningFlag, unSetWarningFlag :: WarningFlag -> DynP ()
3750 setWarningFlag f = upd (\dfs -> wopt_set dfs f)
3751 unSetWarningFlag f = upd (\dfs -> wopt_unset dfs f)
3752
3753 --------------------------
3754 setExtensionFlag, unSetExtensionFlag :: LangExt.Extension -> DynP ()
3755 setExtensionFlag f = upd (setExtensionFlag' f)