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