2 % (c) The University of Glasgow, 1996-2000
4 \section[CmdLineOpts]{Things to do with command-line options}
9 CoreToDo(..), StgToDo(..),
11 SimplifierMode(..), FloatOutSwitches(..),
14 DynFlag(..), -- needed non-abstractly by DriverFlags
21 -- Manipulating DynFlags
22 defaultDynFlags, -- DynFlags
23 defaultHscLang, -- HscLang
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_HscLang, -- DynFlags -> HscLang
29 dopt_OutName, -- DynFlags -> String
30 getOpts, -- (DynFlags -> [a]) -> IO [a]
34 -- Manipulating the DynFlags state
35 getDynFlags, -- IO DynFlags
36 setDynFlags, -- DynFlags -> IO ()
37 updDynFlags, -- (DynFlags -> DynFlags) -> IO ()
38 dynFlag, -- (DynFlags -> a) -> IO a
39 setDynFlag, unSetDynFlag, -- DynFlag -> IO ()
40 saveDynFlags, -- IO ()
41 restoreDynFlags, -- IO DynFlags
43 -- sets of warning opts
48 -- Output style options
50 opt_PprStyle_RawTypes,
55 opt_AutoSccsOnAllToplevs,
56 opt_AutoSccsOnExportedToplevs,
57 opt_AutoSccsOnIndividualCafs,
65 opt_MaxContextReductionDepth,
66 opt_IrrefutableTuples,
77 opt_LiberateCaseThreshold,
78 opt_StgDoLetNoEscapes,
82 opt_UnboxStrictFields,
83 opt_SimplNoPreInlining,
84 opt_SimplDoEtaReduction,
85 opt_SimplDoLambdaEtaExpansion,
87 opt_SimplExcessPrecision,
91 opt_UF_CreationThreshold,
93 opt_UF_FunAppDiscount,
101 opt_EmitCExternDecls,
102 opt_EnsureSplittableC,
107 opt_IgnoreIfacePragmas,
110 opt_OmitInterfacePragmas,
118 #include "HsVersions.h"
120 import Constants -- Default values for some flags
122 import FastString ( FastString, mkFastString )
124 import Maybes ( firstJust )
127 import DATA_IOREF ( IORef, readIORef, writeIORef )
128 import UNSAFE_IO ( unsafePerformIO )
131 %************************************************************************
133 \subsection{Command-line options}
135 %************************************************************************
137 The hsc command-line options are split into two categories:
142 Static flags are represented by top-level values of type Bool or Int,
143 for example. They therefore have the same value throughout the
146 Dynamic flags are represented by an abstract type, DynFlags, which is
147 passed into hsc by the compilation manager for every compilation.
148 Dynamic flags are those that change on a per-compilation basis,
149 perhaps because they may be present in the OPTIONS pragma at the top
152 Other flag-related blurb:
154 A list of {\em ToDo}s is things to be done in a particular part of
155 processing. A (fictitious) example for the Core-to-Core simplifier
156 might be: run the simplifier, then run the strictness analyser, then
157 run the simplifier again (three ``todos'').
159 There are three ``to-do processing centers'' at the moment. In the
160 main loop (\tr{main/Main.lhs}), in the Core-to-Core processing loop
161 (\tr{simplCore/SimplCore.lhs), and in the STG-to-STG processing loop
162 (\tr{simplStg/SimplStg.lhs}).
164 %************************************************************************
166 \subsection{Datatypes associated with command-line options}
168 %************************************************************************
171 data CoreToDo -- These are diff core-to-core passes,
172 -- which may be invoked in any order,
173 -- as many times as you like.
175 = CoreDoSimplify -- The core-to-core simplifier.
178 -- Each run of the simplifier can take a different
179 -- set of simplifier-specific flags.
181 | CoreDoFloatOutwards FloatOutSwitches
186 | CoreDoWorkerWrapper
190 | CoreDoOldStrictness
193 | CoreDoRuleCheck Int{-CompilerPhase-} String -- Check for non-application of rules
194 -- matching this string
196 | CoreDoNothing -- useful when building up lists of these things
201 = StgDoMassageForProfiling -- should be (next to) last
202 -- There's also setStgVarInfo, but its absolute "lastness"
203 -- is so critical that it is hardwired in (no flag).
208 data SimplifierMode -- See comments in SimplMonad
212 data SimplifierSwitch
213 = MaxSimplifierIterations Int
216 data FloatOutSwitches
217 = FloatOutSw Bool -- True <=> float lambdas to top level
218 Bool -- True <=> float constants to top level,
219 -- even if they do not escape a lambda
222 %************************************************************************
224 \subsection{Dynamic command-line options}
226 %************************************************************************
239 | Opt_D_dump_inlinings
240 | Opt_D_dump_occur_anal
245 | Opt_D_dump_simpl_iterations
255 | Opt_D_dump_worker_wrapper
256 | Opt_D_dump_rn_trace
257 | Opt_D_dump_rn_stats
259 | Opt_D_dump_simpl_stats
260 | Opt_D_dump_tc_trace
265 | Opt_D_verbose_core2core
266 | Opt_D_verbose_stg2stg
268 | Opt_D_dump_hi_diffs
269 | Opt_D_dump_minimal_imports
274 | Opt_WarnIsError -- -Werror; makes warnings fatal
275 | Opt_WarnDuplicateExports
277 | Opt_WarnIncompletePatterns
278 | Opt_WarnMissingFields
279 | Opt_WarnMissingMethods
280 | Opt_WarnMissingSigs
281 | Opt_WarnNameShadowing
282 | Opt_WarnOverlappingPatterns
283 | Opt_WarnSimplePatterns
284 | Opt_WarnTypeDefaults
285 | Opt_WarnUnusedBinds
286 | Opt_WarnUnusedImports
287 | Opt_WarnUnusedMatches
288 | Opt_WarnDeprecations
292 | Opt_AllowOverlappingInstances
293 | Opt_AllowUndecidableInstances
294 | Opt_AllowIncoherentInstances
295 | Opt_NoMonomorphismRestriction
298 | Opt_PArr -- syntactic support for parallel arrays
299 | Opt_With -- deprecated keyword for implicit parms
301 | Opt_NoImplicitPrelude
305 data DynFlags = DynFlags {
306 coreToDo :: [CoreToDo],
307 stgToDo :: [StgToDo],
309 hscOutName :: String, -- name of the output file
310 hscStubHOutName :: String, -- name of the .stub_h output file
311 hscStubCOutName :: String, -- name of the .stub_c output file
312 extCoreName :: String, -- name of the .core output file
313 verbosity :: Int, -- verbosity level
314 cppFlag :: Bool, -- preprocess with cpp?
315 ppFlag :: Bool, -- preprocess with a Haskell Pp?
316 stolen_x86_regs :: Int,
317 cmdlineHcIncludes :: [String], -- -#includes
319 -- options for particular phases
345 | cGhcWithNativeCodeGen == "YES" &&
346 (prefixMatch "i386" cTARGETPLATFORM ||
347 prefixMatch "sparc" cTARGETPLATFORM) = HscAsm
350 defaultDynFlags = DynFlags {
351 coreToDo = [], stgToDo = [],
352 hscLang = defaultHscLang,
354 hscStubHOutName = "", hscStubCOutName = "",
360 cmdlineHcIncludes = [],
371 flags = [Opt_Generics] ++ standardWarnings,
372 -- Generating the helper-functions for
373 -- generics is now on by default
379 0 | print errors & warnings only
380 1 | minimal verbosity: print "compiling M ... done." for each module.
381 2 | equivalent to -dshow-passes
382 3 | equivalent to existing "ghc -v"
383 4 | "ghc -v -ddump-most"
384 5 | "ghc -v -ddump-all"
387 dopt :: DynFlag -> DynFlags -> Bool
388 dopt f dflags = f `elem` (flags dflags)
390 dopt_CoreToDo :: DynFlags -> [CoreToDo]
391 dopt_CoreToDo = coreToDo
393 dopt_StgToDo :: DynFlags -> [StgToDo]
394 dopt_StgToDo = stgToDo
396 dopt_OutName :: DynFlags -> String
397 dopt_OutName = hscOutName
399 dopt_HscLang :: DynFlags -> HscLang
400 dopt_HscLang = hscLang
402 dopt_set :: DynFlags -> DynFlag -> DynFlags
403 dopt_set dfs f = dfs{ flags = f : flags dfs }
405 dopt_unset :: DynFlags -> DynFlag -> DynFlags
406 dopt_unset dfs f = dfs{ flags = filter (/= f) (flags dfs) }
408 getOpts :: (DynFlags -> [a]) -> IO [a]
409 -- We add to the options from the front, so we need to reverse the list
410 getOpts opts = dynFlag opts >>= return . reverse
412 -- we can only switch between HscC, HscAsmm, and HscILX with dynamic flags
413 -- (-fvia-C, -fasm, -filx respectively).
414 setLang l = updDynFlags (\ dfs -> case hscLang dfs of
415 HscC -> dfs{ hscLang = l }
416 HscAsm -> dfs{ hscLang = l }
417 HscILX -> dfs{ hscLang = l }
421 verb <- dynFlag verbosity
422 if verb >= 3 then return "-v" else return ""
425 -----------------------------------------------------------------------------
426 -- Mess about with the mutable variables holding the dynamic arguments
429 -- is the "baseline" dynamic flags, initialised from
430 -- the defaults and command line options, and updated by the
431 -- ':s' command in GHCi.
434 -- is the dynamic flags for the current compilation. It is reset
435 -- to the value of v_InitDynFlags before each compilation, then
436 -- updated by reading any OPTIONS pragma in the current module.
439 GLOBAL_VAR(v_InitDynFlags, defaultDynFlags, DynFlags)
440 GLOBAL_VAR(v_DynFlags, defaultDynFlags, DynFlags)
442 setDynFlags :: DynFlags -> IO ()
443 setDynFlags dfs = writeIORef v_DynFlags dfs
445 saveDynFlags :: IO ()
446 saveDynFlags = do dfs <- readIORef v_DynFlags
447 writeIORef v_InitDynFlags dfs
449 restoreDynFlags :: IO DynFlags
450 restoreDynFlags = do dfs <- readIORef v_InitDynFlags
451 writeIORef v_DynFlags dfs
454 getDynFlags :: IO DynFlags
455 getDynFlags = readIORef v_DynFlags
457 updDynFlags :: (DynFlags -> DynFlags) -> IO ()
458 updDynFlags f = do dfs <- readIORef v_DynFlags
459 writeIORef v_DynFlags (f dfs)
461 dynFlag :: (DynFlags -> a) -> IO a
462 dynFlag f = do dflags <- readIORef v_DynFlags; return (f dflags)
464 setDynFlag, unSetDynFlag :: DynFlag -> IO ()
465 setDynFlag f = updDynFlags (\dfs -> dopt_set dfs f)
466 unSetDynFlag f = updDynFlags (\dfs -> dopt_unset dfs f)
470 %************************************************************************
472 \subsection{Warnings}
474 %************************************************************************
478 = [ Opt_WarnDeprecations,
479 Opt_WarnOverlappingPatterns,
480 Opt_WarnMissingFields,
481 Opt_WarnMissingMethods,
482 Opt_WarnDuplicateExports
486 = standardWarnings ++
487 [ Opt_WarnUnusedBinds,
488 Opt_WarnUnusedMatches,
489 Opt_WarnUnusedImports,
490 Opt_WarnIncompletePatterns,
496 [ Opt_WarnTypeDefaults,
497 Opt_WarnNameShadowing,
503 %************************************************************************
505 \subsection{Classifying command-line options}
507 %************************************************************************
510 -- v_Statis_hsc_opts is here to avoid a circular dependency with
512 GLOBAL_VAR(v_Static_hsc_opts, [], [String])
514 lookUp :: FastString -> Bool
515 lookup_int :: String -> Maybe Int
516 lookup_def_int :: String -> Int -> Int
517 lookup_def_float :: String -> Float -> Float
518 lookup_str :: String -> Maybe String
520 unpacked_static_opts = unsafePerformIO (readIORef v_Static_hsc_opts)
521 packed_static_opts = map mkFastString unpacked_static_opts
523 lookUp sw = sw `elem` packed_static_opts
525 lookup_str sw = firstJust (map (startsWith sw) unpacked_static_opts)
527 lookup_int sw = case (lookup_str sw) of
529 Just xx -> Just (read xx)
531 lookup_def_int sw def = case (lookup_str sw) of
532 Nothing -> def -- Use default
535 lookup_def_float sw def = case (lookup_str sw) of
536 Nothing -> def -- Use default
541 Putting the compiler options into temporary at-files
542 may turn out to be necessary later on if we turn hsc into
543 a pure Win32 application where I think there's a command-line
544 length limit of 255. unpacked_opts understands the @ option.
546 unpacked_opts :: [String]
550 map unpackFS argv -- NOT ARGV any more: v_Static_hsc_opts
552 expandAts ('@':fname) = words (unsafePerformIO (readFile fname))
557 %************************************************************************
559 \subsection{Static options}
561 %************************************************************************
565 opt_PprStyle_NoPrags = lookUp FSLIT("-dppr-noprags")
566 opt_PprStyle_Debug = lookUp FSLIT("-dppr-debug")
567 opt_PprStyle_RawTypes = lookUp FSLIT("-dppr-rawtypes")
568 opt_PprUserLength = lookup_def_int "-dppr-user-length" 5 --ToDo: give this a name
571 opt_AutoSccsOnAllToplevs = lookUp FSLIT("-fauto-sccs-on-all-toplevs")
572 opt_AutoSccsOnExportedToplevs = lookUp FSLIT("-fauto-sccs-on-exported-toplevs")
573 opt_AutoSccsOnIndividualCafs = lookUp FSLIT("-fauto-sccs-on-individual-cafs")
574 opt_AutoSccsOnDicts = lookUp FSLIT("-fauto-sccs-on-dicts")
575 opt_SccProfilingOn = lookUp FSLIT("-fscc-profiling")
576 opt_DoTickyProfiling = lookUp FSLIT("-fticky-ticky")
579 opt_AllStrict = lookUp FSLIT("-fall-strict")
580 opt_DictsStrict = lookUp FSLIT("-fdicts-strict")
581 opt_IrrefutableTuples = lookUp FSLIT("-firrefutable-tuples")
582 opt_MaxContextReductionDepth = lookup_def_int "-fcontext-stack" mAX_CONTEXT_REDUCTION_DEPTH
583 opt_NumbersStrict = lookUp FSLIT("-fnumbers-strict")
584 opt_Parallel = lookUp FSLIT("-fparallel")
585 opt_SMP = lookUp FSLIT("-fsmp")
586 opt_Flatten = lookUp FSLIT("-fflatten")
589 opt_NoMethodSharing = lookUp FSLIT("-fno-method-sharing")
590 opt_DoSemiTagging = lookUp FSLIT("-fsemi-tagging")
591 opt_FoldrBuildOn = lookUp FSLIT("-ffoldr-build-on")
592 opt_CprOff = lookUp FSLIT("-fcpr-off")
593 -- Switch off CPR analysis in the new demand analyser
594 opt_LiberateCaseThreshold = lookup_def_int "-fliberate-case-threshold" (10::Int)
595 opt_StgDoLetNoEscapes = lookUp FSLIT("-flet-no-escape")
596 opt_UnfoldCasms = lookUp FSLIT("-funfold-casms-in-hi-file")
597 opt_UsageSPOn = lookUp FSLIT("-fusagesp-on")
598 opt_UnboxStrictFields = lookUp FSLIT("-funbox-strict-fields")
599 opt_MaxWorkerArgs = lookup_def_int "-fmax-worker-args" (10::Int)
602 The optional '-inpackage=P' flag tells what package
603 we are compiling this module for.
604 The Prelude, for example is compiled with '-inpackage std'
606 opt_InPackage = case lookup_str "-inpackage=" of
607 Just p -> mkFastString p
608 Nothing -> FSLIT("Main") -- The package name if none is specified
610 opt_EmitCExternDecls = lookUp FSLIT("-femit-extern-decls")
611 opt_EnsureSplittableC = lookUp FSLIT("-fglobalise-toplev-names")
612 opt_GranMacros = lookUp FSLIT("-fgransim")
613 opt_HiVersion = read (cProjectVersionInt ++ cProjectPatchLevel) :: Int
614 opt_HistorySize = lookup_def_int "-fhistory-size" 20
615 opt_IgnoreAsserts = lookUp FSLIT("-fignore-asserts")
616 opt_IgnoreIfacePragmas = lookUp FSLIT("-fignore-interface-pragmas")
617 opt_NoHiCheck = lookUp FSLIT("-fno-hi-version-check")
618 opt_OmitBlackHoling = lookUp FSLIT("-dno-black-holing")
619 opt_OmitInterfacePragmas = lookUp FSLIT("-fomit-interface-pragmas")
620 opt_RuntimeTypes = lookUp FSLIT("-fruntime-types")
622 -- Simplifier switches
623 opt_SimplNoPreInlining = lookUp FSLIT("-fno-pre-inlining")
624 -- NoPreInlining is there just to see how bad things
625 -- get if you don't do it!
626 opt_SimplDoEtaReduction = lookUp FSLIT("-fdo-eta-reduction")
627 opt_SimplDoLambdaEtaExpansion = lookUp FSLIT("-fdo-lambda-eta-expansion")
628 opt_SimplCaseMerge = lookUp FSLIT("-fcase-merge")
629 opt_SimplExcessPrecision = lookUp FSLIT("-fexcess-precision")
632 opt_UF_CreationThreshold = lookup_def_int "-funfolding-creation-threshold" (45::Int)
633 opt_UF_UseThreshold = lookup_def_int "-funfolding-use-threshold" (8::Int) -- Discounts can be big
634 opt_UF_FunAppDiscount = lookup_def_int "-funfolding-fun-discount" (6::Int) -- It's great to inline a fn
635 opt_UF_KeenessFactor = lookup_def_float "-funfolding-keeness-factor" (1.5::Float)
636 opt_UF_UpdateInPlace = lookUp FSLIT("-funfolding-update-in-place")
638 opt_UF_CheapOp = ( 1 :: Int) -- Only one instruction; and the args are charged for
639 opt_UF_DearOp = ( 4 :: Int)
641 opt_NoPruneDecls = lookUp FSLIT("-fno-prune-decls")
642 opt_NoPruneTyDecls = lookUp FSLIT("-fno-prune-tydecls")
643 opt_Static = lookUp FSLIT("-static")
644 opt_Unregisterised = lookUp FSLIT("-funregisterised")
645 opt_EmitExternalCore = lookUp FSLIT("-fext-core")
648 %************************************************************************
650 \subsection{List of static hsc flags}
652 %************************************************************************
657 "fauto-sccs-on-all-toplevs",
658 "fauto-sccs-on-exported-toplevs",
659 "fauto-sccs-on-individual-cafs",
660 "fauto-sccs-on-dicts",
665 "firrefutable-tuples",
673 "funfold-casms-in-hi-file",
675 "funbox-strict-fields",
676 "femit-extern-decls",
677 "fglobalise-toplev-names",
680 "fignore-interface-pragmas",
681 "fno-hi-version-check",
683 "fno-method-sharing",
684 "fomit-interface-pragmas",
688 "fdo-lambda-eta-expansion",
691 "funfolding-update-in-place",
700 || any (flip prefixMatch f) [
702 "fliberate-case-threshold",
705 "funfolding-creation-threshold",
706 "funfolding-use-threshold",
707 "funfolding-fun-discount",
708 "funfolding-keeness-factor"
712 %************************************************************************
714 \subsection{Misc functions for command-line options}
716 %************************************************************************
721 startsWith :: String -> String -> Maybe String
722 -- startsWith pfx (pfx++rest) = Just rest
724 startsWith [] str = Just str
725 startsWith (c:cs) (s:ss)
726 = if c /= s then Nothing else startsWith cs ss
727 startsWith _ [] = Nothing
729 endsWith :: String -> String -> Maybe String
731 = case (startsWith (reverse cs) (reverse ss)) of
733 Just rs -> Just (reverse rs)