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