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