2 % (c) The University of Glasgow, 1996-2000
4 \section[CmdLineOpts]{Things to do with command-line options}
9 CoreToDo(..), buildCoreToDo, StgToDo(..),
11 SimplifierMode(..), FloatOutSwitches(..),
14 DynFlag(..), -- needed non-abstractly by DriverFlags
22 -- Manipulating DynFlags
23 defaultDynFlags, -- DynFlags
24 dopt, -- DynFlag -> DynFlags -> Bool
25 dopt_set, dopt_unset, -- DynFlags -> DynFlag -> DynFlags
26 dopt_CoreToDo, -- DynFlags -> [CoreToDo]
27 dopt_StgToDo, -- DynFlags -> [StgToDo]
28 dopt_HscTarget, -- DynFlags -> HscTarget
29 dopt_OutName, -- DynFlags -> String
30 getOpts, -- (DynFlags -> [a]) -> IO [a]
34 -- sets of warning opts
38 -- Output style options
43 opt_AutoSccsOnAllToplevs,
44 opt_AutoSccsOnExportedToplevs,
45 opt_AutoSccsOnIndividualCafs,
51 opt_MaxContextReductionDepth,
52 opt_IrrefutableTuples,
61 opt_LiberateCaseThreshold,
64 opt_SimplNoPreInlining,
65 opt_SimplExcessPrecision,
69 opt_UF_CreationThreshold,
71 opt_UF_FunAppDiscount,
79 opt_EnsureSplittableC,
90 #include "HsVersions.h"
92 import {-# SOURCE #-} Packages (PackageState)
93 import DriverPhases ( HscTarget(..) )
94 import Constants -- Default values for some flags
96 import FastString ( FastString, mkFastString )
98 import Maybes ( firstJust )
100 import Panic ( ghcError, GhcException(UsageError) )
102 import DATA_IOREF ( IORef, readIORef )
103 import UNSAFE_IO ( unsafePerformIO )
106 %************************************************************************
108 \subsection{Command-line options}
110 %************************************************************************
112 The hsc command-line options are split into two categories:
117 Static flags are represented by top-level values of type Bool or Int,
118 for example. They therefore have the same value throughout the
121 Dynamic flags are represented by an abstract type, DynFlags, which is
122 passed into hsc by the compilation manager for every compilation.
123 Dynamic flags are those that change on a per-compilation basis,
124 perhaps because they may be present in the OPTIONS pragma at the top
127 Other flag-related blurb:
129 A list of {\em ToDo}s is things to be done in a particular part of
130 processing. A (fictitious) example for the Core-to-Core simplifier
131 might be: run the simplifier, then run the strictness analyser, then
132 run the simplifier again (three ``todos'').
134 There are three ``to-do processing centers'' at the moment. In the
135 main loop (\tr{main/Main.lhs}), in the Core-to-Core processing loop
136 (\tr{simplCore/SimplCore.lhs), and in the STG-to-STG processing loop
137 (\tr{simplStg/SimplStg.lhs}).
139 %************************************************************************
141 \subsection{Datatypes associated with command-line options}
143 %************************************************************************
146 data CoreToDo -- These are diff core-to-core passes,
147 -- which may be invoked in any order,
148 -- as many times as you like.
150 = CoreDoSimplify -- The core-to-core simplifier.
153 -- Each run of the simplifier can take a different
154 -- set of simplifier-specific flags.
156 | CoreDoFloatOutwards FloatOutSwitches
161 | CoreDoWorkerWrapper
164 | CoreDoOldStrictness
167 | CoreDoRuleCheck Int{-CompilerPhase-} String -- Check for non-application of rules
168 -- matching this string
170 | CoreDoNothing -- useful when building up lists of these things
175 = StgDoMassageForProfiling -- should be (next to) last
176 -- There's also setStgVarInfo, but its absolute "lastness"
177 -- is so critical that it is hardwired in (no flag).
182 data SimplifierMode -- See comments in SimplMonad
186 data SimplifierSwitch
187 = MaxSimplifierIterations Int
190 data FloatOutSwitches
191 = FloatOutSw Bool -- True <=> float lambdas to top level
192 Bool -- True <=> float constants to top level,
193 -- even if they do not escape a lambda
196 %************************************************************************
198 \subsection{Dynamic command-line options}
200 %************************************************************************
213 | Opt_D_dump_inlinings
214 | Opt_D_dump_occur_anal
218 | Opt_D_dump_simpl_iterations
227 | Opt_D_dump_worker_wrapper
228 | Opt_D_dump_rn_trace
229 | Opt_D_dump_rn_stats
231 | Opt_D_dump_simpl_stats
232 | Opt_D_dump_tc_trace
233 | Opt_D_dump_if_trace
238 | Opt_D_verbose_core2core
239 | Opt_D_verbose_stg2stg
241 | Opt_D_dump_hi_diffs
242 | Opt_D_dump_minimal_imports
247 | Opt_WarnIsError -- -Werror; makes warnings fatal
248 | Opt_WarnDuplicateExports
250 | Opt_WarnIncompletePatterns
251 | Opt_WarnIncompletePatternsRecUpd
252 | Opt_WarnMissingFields
253 | Opt_WarnMissingMethods
254 | Opt_WarnMissingSigs
255 | Opt_WarnNameShadowing
256 | Opt_WarnOverlappingPatterns
257 | Opt_WarnSimplePatterns
258 | Opt_WarnTypeDefaults
259 | Opt_WarnUnusedBinds
260 | Opt_WarnUnusedImports
261 | Opt_WarnUnusedMatches
262 | Opt_WarnDeprecations
263 | Opt_WarnDodgyImports
267 | Opt_AllowOverlappingInstances
268 | Opt_AllowUndecidableInstances
269 | Opt_AllowIncoherentInstances
270 | Opt_MonomorphismRestriction
273 | Opt_PArr -- syntactic support for parallel arrays
274 | Opt_Arrows -- Arrow-notation syntax
278 | Opt_ImplicitPrelude
279 | Opt_ScopedTypeVariables
285 | Opt_IgnoreInterfacePragmas
286 | Opt_OmitInterfacePragmas
287 | Opt_DoLambdaEtaExpansion
291 | Opt_UnboxStrictFields
295 data DynFlags = DynFlags {
296 coreToDo :: Maybe [CoreToDo], -- reserved for use with -Ofile
297 stgToDo :: [StgToDo],
298 hscTarget :: HscTarget,
299 hscOutName :: String, -- name of the output file
300 hscStubHOutName :: String, -- name of the .stub_h output file
301 hscStubCOutName :: String, -- name of the .stub_c output file
302 extCoreName :: String, -- name of the .core output file
303 verbosity :: Int, -- verbosity level
304 optLevel :: Int, -- optimisation level
305 maxSimplIterations :: Int, -- max simplifier iterations
306 ruleCheck :: Maybe String,
307 cppFlag :: Bool, -- preprocess with cpp?
308 ppFlag :: Bool, -- preprocess with a Haskell Pp?
309 recompFlag :: Bool, -- True <=> recompilation checker is on
310 stolen_x86_regs :: Int,
311 cmdlineHcIncludes :: [String], -- -#includes
312 importPaths :: [FilePath],
314 -- options for particular phases
327 extraPkgConfs :: [FilePath],
328 -- The -package-conf flags given on the command line, in the order
331 readUserPkgConf :: Bool,
332 -- Whether or not to read the user package database
333 -- (-no-user-package-conf).
335 packageFlags :: [PackageFlag],
336 -- The -package and -hide-package flags from the command-line
339 pkgState :: PackageState,
346 = ExposePackage String
348 | IgnorePackage String
351 #if defined(i386_TARGET_ARCH) || defined(sparc_TARGET_ARCH) || defined(powerpc_TARGET_ARCH)
352 | cGhcWithNativeCodeGen == "YES" = HscAsm
356 defaultDynFlags = DynFlags {
357 coreToDo = Nothing, stgToDo = [],
358 hscTarget = defaultHscTarget,
360 hscStubHOutName = "", hscStubCOutName = "",
364 maxSimplIterations = 4,
370 cmdlineHcIncludes = [],
384 readUserPkgConf = True,
386 pkgState = error "pkgState",
390 Opt_MonomorphismRestriction,
392 -- Generating the helper-functions for
393 -- generics is now on by default
395 -- strictness is on by default, but this only
397 Opt_CSE, -- similarly for CSE.
398 Opt_FullLaziness, -- ...and for full laziness
400 Opt_DoLambdaEtaExpansion,
401 -- This one is important for a tiresome reason:
402 -- we want to make sure that the bindings for data
403 -- constructors are eta-expanded. This is probably
404 -- a good thing anyway, but it seems fragile.
406 -- and the default no-optimisation options:
407 Opt_IgnoreInterfacePragmas,
408 Opt_OmitInterfacePragmas
410 ] ++ standardWarnings
416 0 | print errors & warnings only
417 1 | minimal verbosity: print "compiling M ... done." for each module.
418 2 | equivalent to -dshow-passes
419 3 | equivalent to existing "ghc -v"
420 4 | "ghc -v -ddump-most"
421 5 | "ghc -v -ddump-all"
424 dopt :: DynFlag -> DynFlags -> Bool
425 dopt f dflags = f `elem` (flags dflags)
427 dopt_CoreToDo :: DynFlags -> Maybe [CoreToDo]
428 dopt_CoreToDo = coreToDo
430 dopt_StgToDo :: DynFlags -> [StgToDo]
431 dopt_StgToDo = stgToDo
433 dopt_OutName :: DynFlags -> String
434 dopt_OutName = hscOutName
436 dopt_HscTarget :: DynFlags -> HscTarget
437 dopt_HscTarget = hscTarget
439 dopt_set :: DynFlags -> DynFlag -> DynFlags
440 dopt_set dfs f = dfs{ flags = f : flags dfs }
442 dopt_unset :: DynFlags -> DynFlag -> DynFlags
443 dopt_unset dfs f = dfs{ flags = filter (/= f) (flags dfs) }
445 getOpts :: DynFlags -> (DynFlags -> [a]) -> [a]
446 -- We add to the options from the front, so we need to reverse the list
447 getOpts dflags opts = reverse (opts dflags)
450 | verbosity dflags >= 3 = "-v"
453 -----------------------------------------------------------------------------
454 -- Setting the optimisation level
456 updOptLevel :: Int -> DynFlags -> DynFlags
457 -- Set dynflags appropriate to the optimisation level
460 then dfs2{ hscTarget = HscC, optLevel = n } -- turn on -fvia-C with -O
461 else dfs2{ optLevel = n }
463 dfs1 = foldr (flip dopt_unset) dfs remove_dopts
464 dfs2 = foldr (flip dopt_set) dfs1 extra_dopts
467 | n == 0 = opt_0_dopts
468 | otherwise = opt_1_dopts
471 | n == 0 = opt_1_dopts
472 | otherwise = opt_0_dopts
475 Opt_IgnoreInterfacePragmas,
476 Opt_OmitInterfacePragmas
485 -- Core-to-core phases:
487 buildCoreToDo :: DynFlags -> [CoreToDo]
488 buildCoreToDo dflags = core_todo
490 opt_level = optLevel dflags
491 max_iter = maxSimplIterations dflags
492 strictness = dopt Opt_Strictness dflags
493 full_laziness = dopt Opt_FullLaziness dflags
494 cse = dopt Opt_CSE dflags
495 rule_check = ruleCheck dflags
498 if opt_level == 0 then
500 CoreDoSimplify (SimplPhase 0) [
501 MaxSimplifierIterations max_iter
505 else {- opt_level >= 1 -} [
507 -- initial simplify: mk specialiser happy: minimum effort please
508 CoreDoSimplify SimplGently [
510 -- Don't inline anything till full laziness has bitten
511 -- In particular, inlining wrappers inhibits floating
512 -- e.g. ...(case f x of ...)...
513 -- ==> ...(case (case x of I# x# -> fw x#) of ...)...
514 -- ==> ...(case x of I# x# -> case fw x# of ...)...
515 -- and now the redex (f x) isn't floatable any more
516 -- Similarly, don't apply any rules until after full
517 -- laziness. Notably, list fusion can prevent floating.
520 -- Don't do case-of-case transformations.
521 -- This makes full laziness work better
522 MaxSimplifierIterations max_iter
525 -- Specialisation is best done before full laziness
526 -- so that overloaded functions have all their dictionary lambdas manifest
529 if full_laziness then CoreDoFloatOutwards (FloatOutSw False False)
534 CoreDoSimplify (SimplPhase 2) [
535 -- Want to run with inline phase 2 after the specialiser to give
536 -- maximum chance for fusion to work before we inline build/augment
537 -- in phase 1. This made a difference in 'ansi' where an
538 -- overloaded function wasn't inlined till too late.
539 MaxSimplifierIterations max_iter
541 case rule_check of { Just pat -> CoreDoRuleCheck 2 pat; Nothing -> CoreDoNothing },
543 CoreDoSimplify (SimplPhase 1) [
544 -- Need inline-phase2 here so that build/augment get
545 -- inlined. I found that spectral/hartel/genfft lost some useful
546 -- strictness in the function sumcode' if augment is not inlined
547 -- before strictness analysis runs
548 MaxSimplifierIterations max_iter
550 case rule_check of { Just pat -> CoreDoRuleCheck 1 pat; Nothing -> CoreDoNothing },
552 CoreDoSimplify (SimplPhase 0) [
553 -- Phase 0: allow all Ids to be inlined now
554 -- This gets foldr inlined before strictness analysis
556 MaxSimplifierIterations 3
557 -- At least 3 iterations because otherwise we land up with
558 -- huge dead expressions because of an infelicity in the
560 -- let k = BIG in foldr k z xs
561 -- ==> let k = BIG in letrec go = \xs -> ...(k x).... in go xs
562 -- ==> let k = BIG in letrec go = \xs -> ...(BIG x).... in go xs
566 case rule_check of { Just pat -> CoreDoRuleCheck 0 pat; Nothing -> CoreDoNothing },
568 #ifdef OLD_STRICTNESS
571 if strictness then CoreDoStrictness else CoreDoNothing,
575 CoreDoSimplify (SimplPhase 0) [
576 MaxSimplifierIterations max_iter
579 if full_laziness then
580 CoreDoFloatOutwards (FloatOutSw False -- Not lambdas
581 True) -- Float constants
583 -- nofib/spectral/hartel/wang doubles in speed if you
584 -- do full laziness late in the day. It only happens
585 -- after fusion and other stuff, so the early pass doesn't
586 -- catch it. For the record, the redex is
587 -- f_el22 (f_el21 r_midblock)
590 -- We want CSE to follow the final full-laziness pass, because it may
591 -- succeed in commoning up things floated out by full laziness.
592 -- CSE used to rely on the no-shadowing invariant, but it doesn't any more
594 if cse then CoreCSE else CoreDoNothing,
598 -- Case-liberation for -O2. This should be after
599 -- strictness analysis and the simplification which follows it.
601 case rule_check of { Just pat -> CoreDoRuleCheck 0 pat; Nothing -> CoreDoNothing },
603 if opt_level >= 2 then
607 if opt_level >= 2 then
612 -- Final clean-up simplification:
613 CoreDoSimplify (SimplPhase 0) [
614 MaxSimplifierIterations max_iter
619 %************************************************************************
621 \subsection{Warnings}
623 %************************************************************************
627 = [ Opt_WarnDeprecations,
628 Opt_WarnOverlappingPatterns,
629 Opt_WarnMissingFields,
630 Opt_WarnMissingMethods,
631 Opt_WarnDuplicateExports
635 = standardWarnings ++
636 [ Opt_WarnUnusedBinds,
637 Opt_WarnUnusedMatches,
638 Opt_WarnUnusedImports,
639 Opt_WarnIncompletePatterns,
645 [ Opt_WarnTypeDefaults,
646 Opt_WarnNameShadowing,
653 %************************************************************************
655 \subsection{Classifying command-line options}
657 %************************************************************************
660 -- v_Statis_hsc_opts is here to avoid a circular dependency with
662 GLOBAL_VAR(v_Static_hsc_opts, [], [String])
664 lookUp :: FastString -> Bool
665 lookup_def_int :: String -> Int -> Int
666 lookup_def_float :: String -> Float -> Float
667 lookup_str :: String -> Maybe String
669 unpacked_static_opts = unsafePerformIO (readIORef v_Static_hsc_opts)
670 packed_static_opts = map mkFastString unpacked_static_opts
672 lookUp sw = sw `elem` packed_static_opts
674 -- (lookup_str "foo") looks for the flag -foo=X or -fooX,
675 -- and returns the string X
677 = case firstJust (map (startsWith sw) unpacked_static_opts) of
678 Just ('=' : str) -> Just str
682 lookup_def_int sw def = case (lookup_str sw) of
683 Nothing -> def -- Use default
684 Just xx -> try_read sw xx
686 lookup_def_float sw def = case (lookup_str sw) of
687 Nothing -> def -- Use default
688 Just xx -> try_read sw xx
691 try_read :: Read a => String -> String -> a
692 -- (try_read sw str) tries to read s; if it fails, it
693 -- bleats about flag sw
696 ((x,_):_) -> x -- Be forgiving: ignore trailing goop, and alternative parses
697 [] -> ghcError (UsageError ("Malformed argument " ++ str ++ " for flag " ++ sw))
698 -- ToDo: hack alert. We should really parse the arugments
699 -- and announce errors in a more civilised way.
703 Putting the compiler options into temporary at-files
704 may turn out to be necessary later on if we turn hsc into
705 a pure Win32 application where I think there's a command-line
706 length limit of 255. unpacked_opts understands the @ option.
708 unpacked_opts :: [String]
712 map unpackFS argv -- NOT ARGV any more: v_Static_hsc_opts
714 expandAts ('@':fname) = words (unsafePerformIO (readFile fname))
719 %************************************************************************
721 \subsection{Static options}
723 %************************************************************************
727 opt_PprStyle_Debug = lookUp FSLIT("-dppr-debug")
728 opt_PprUserLength = lookup_def_int "-dppr-user-length" 5 --ToDo: give this a name
731 opt_AutoSccsOnAllToplevs = lookUp FSLIT("-fauto-sccs-on-all-toplevs")
732 opt_AutoSccsOnExportedToplevs = lookUp FSLIT("-fauto-sccs-on-exported-toplevs")
733 opt_AutoSccsOnIndividualCafs = lookUp FSLIT("-fauto-sccs-on-individual-cafs")
734 opt_SccProfilingOn = lookUp FSLIT("-fscc-profiling")
735 opt_DoTickyProfiling = lookUp FSLIT("-fticky-ticky")
738 opt_DictsStrict = lookUp FSLIT("-fdicts-strict")
739 opt_IrrefutableTuples = lookUp FSLIT("-firrefutable-tuples")
740 opt_MaxContextReductionDepth = lookup_def_int "-fcontext-stack" mAX_CONTEXT_REDUCTION_DEPTH
741 opt_Parallel = lookUp FSLIT("-fparallel")
742 opt_SMP = lookUp FSLIT("-fsmp")
743 opt_Flatten = lookUp FSLIT("-fflatten")
746 opt_NoStateHack = lookUp FSLIT("-fno-state-hack")
747 opt_NoMethodSharing = lookUp FSLIT("-fno-method-sharing")
748 opt_CprOff = lookUp FSLIT("-fcpr-off")
749 opt_RulesOff = lookUp FSLIT("-frules-off")
750 -- Switch off CPR analysis in the new demand analyser
751 opt_LiberateCaseThreshold = lookup_def_int "-fliberate-case-threshold" (10::Int)
752 opt_MaxWorkerArgs = lookup_def_int "-fmax-worker-args" (10::Int)
754 opt_EmitCExternDecls = lookUp FSLIT("-femit-extern-decls")
755 opt_EnsureSplittableC = lookUp FSLIT("-fglobalise-toplev-names")
756 opt_GranMacros = lookUp FSLIT("-fgransim")
757 opt_HiVersion = read (cProjectVersionInt ++ cProjectPatchLevel) :: Int
758 opt_HistorySize = lookup_def_int "-fhistory-size" 20
759 opt_OmitBlackHoling = lookUp FSLIT("-dno-black-holing")
760 opt_RuntimeTypes = lookUp FSLIT("-fruntime-types")
762 -- Simplifier switches
763 opt_SimplNoPreInlining = lookUp FSLIT("-fno-pre-inlining")
764 -- NoPreInlining is there just to see how bad things
765 -- get if you don't do it!
766 opt_SimplExcessPrecision = lookUp FSLIT("-fexcess-precision")
769 opt_UF_CreationThreshold = lookup_def_int "-funfolding-creation-threshold" (45::Int)
770 opt_UF_UseThreshold = lookup_def_int "-funfolding-use-threshold" (8::Int) -- Discounts can be big
771 opt_UF_FunAppDiscount = lookup_def_int "-funfolding-fun-discount" (6::Int) -- It's great to inline a fn
772 opt_UF_KeenessFactor = lookup_def_float "-funfolding-keeness-factor" (1.5::Float)
773 opt_UF_UpdateInPlace = lookUp FSLIT("-funfolding-update-in-place")
775 opt_UF_DearOp = ( 4 :: Int)
777 opt_Static = lookUp FSLIT("-static")
778 opt_Unregisterised = lookUp FSLIT("-funregisterised")
779 opt_EmitExternalCore = lookUp FSLIT("-fext-core")
781 -- Include full span info in error messages, instead of just the start position.
782 opt_ErrorSpans = lookUp FSLIT("-ferror-spans")
784 opt_PIC = lookUp FSLIT("-fPIC")
787 %************************************************************************
789 \subsection{List of static hsc flags}
791 %************************************************************************
796 "fauto-sccs-on-all-toplevs",
797 "fauto-sccs-on-exported-toplevs",
798 "fauto-sccs-on-individual-cafs",
799 "fauto-sccs-on-dicts",
804 "firrefutable-tuples",
810 "femit-extern-decls",
811 "fglobalise-toplev-names",
813 "fno-hi-version-check",
815 "fno-method-sharing",
820 "funfolding-update-in-place",
830 || any (flip prefixMatch f) [
832 "fliberate-case-threshold",
835 "funfolding-creation-threshold",
836 "funfolding-use-threshold",
837 "funfolding-fun-discount",
838 "funfolding-keeness-factor"
842 %************************************************************************
844 \subsection{Misc functions for command-line options}
846 %************************************************************************
851 startsWith :: String -> String -> Maybe String
852 -- startsWith pfx (pfx++rest) = Just rest
854 startsWith [] str = Just str
855 startsWith (c:cs) (s:ss)
856 = if c /= s then Nothing else startsWith cs ss
857 startsWith _ [] = Nothing