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,
81 opt_UnboxStrictFields,
82 opt_SimplNoPreInlining,
83 opt_SimplDoEtaReduction,
84 opt_SimplDoLambdaEtaExpansion,
86 opt_SimplExcessPrecision,
90 opt_UF_CreationThreshold,
92 opt_UF_FunAppDiscount,
100 opt_EmitCExternDecls,
101 opt_EnsureSplittableC,
106 opt_IgnoreIfacePragmas,
109 opt_OmitInterfacePragmas,
117 #include "HsVersions.h"
119 import Constants -- Default values for some flags
121 import FastString ( FastString, mkFastString )
123 import Maybes ( firstJust )
126 import DATA_IOREF ( IORef, readIORef, writeIORef )
127 import UNSAFE_IO ( unsafePerformIO )
130 %************************************************************************
132 \subsection{Command-line options}
134 %************************************************************************
136 The hsc command-line options are split into two categories:
141 Static flags are represented by top-level values of type Bool or Int,
142 for example. They therefore have the same value throughout the
145 Dynamic flags are represented by an abstract type, DynFlags, which is
146 passed into hsc by the compilation manager for every compilation.
147 Dynamic flags are those that change on a per-compilation basis,
148 perhaps because they may be present in the OPTIONS pragma at the top
151 Other flag-related blurb:
153 A list of {\em ToDo}s is things to be done in a particular part of
154 processing. A (fictitious) example for the Core-to-Core simplifier
155 might be: run the simplifier, then run the strictness analyser, then
156 run the simplifier again (three ``todos'').
158 There are three ``to-do processing centers'' at the moment. In the
159 main loop (\tr{main/Main.lhs}), in the Core-to-Core processing loop
160 (\tr{simplCore/SimplCore.lhs), and in the STG-to-STG processing loop
161 (\tr{simplStg/SimplStg.lhs}).
163 %************************************************************************
165 \subsection{Datatypes associated with command-line options}
167 %************************************************************************
170 data CoreToDo -- These are diff core-to-core passes,
171 -- which may be invoked in any order,
172 -- as many times as you like.
174 = CoreDoSimplify -- The core-to-core simplifier.
177 -- Each run of the simplifier can take a different
178 -- set of simplifier-specific flags.
180 | CoreDoFloatOutwards FloatOutSwitches
185 | CoreDoWorkerWrapper
188 | CoreDoOldStrictness
191 | CoreDoRuleCheck Int{-CompilerPhase-} String -- Check for non-application of rules
192 -- matching this string
194 | CoreDoNothing -- useful when building up lists of these things
199 = StgDoMassageForProfiling -- should be (next to) last
200 -- There's also setStgVarInfo, but its absolute "lastness"
201 -- is so critical that it is hardwired in (no flag).
206 data SimplifierMode -- See comments in SimplMonad
210 data SimplifierSwitch
211 = MaxSimplifierIterations Int
214 data FloatOutSwitches
215 = FloatOutSw Bool -- True <=> float lambdas to top level
216 Bool -- True <=> float constants to top level,
217 -- even if they do not escape a lambda
220 %************************************************************************
222 \subsection{Dynamic command-line options}
224 %************************************************************************
237 | Opt_D_dump_inlinings
238 | Opt_D_dump_occur_anal
243 | Opt_D_dump_simpl_iterations
252 | Opt_D_dump_worker_wrapper
253 | Opt_D_dump_rn_trace
254 | Opt_D_dump_rn_stats
256 | Opt_D_dump_simpl_stats
257 | Opt_D_dump_tc_trace
262 | Opt_D_verbose_core2core
263 | Opt_D_verbose_stg2stg
265 | Opt_D_dump_hi_diffs
266 | Opt_D_dump_minimal_imports
270 | Opt_WarnIsError -- -Werror; makes warnings fatal
271 | Opt_WarnDuplicateExports
273 | Opt_WarnIncompletePatterns
274 | Opt_WarnMissingFields
275 | Opt_WarnMissingMethods
276 | Opt_WarnMissingSigs
277 | Opt_WarnNameShadowing
278 | Opt_WarnOverlappingPatterns
279 | Opt_WarnSimplePatterns
280 | Opt_WarnTypeDefaults
281 | Opt_WarnUnusedBinds
282 | Opt_WarnUnusedImports
283 | Opt_WarnUnusedMatches
284 | Opt_WarnDeprecations
288 | Opt_AllowOverlappingInstances
289 | Opt_AllowUndecidableInstances
290 | Opt_AllowIncoherentInstances
291 | Opt_NoMonomorphismRestriction
294 | Opt_PArr -- syntactic support for parallel arrays
295 | Opt_With -- deprecated keyword for implicit parms
296 | Opt_Arrows -- Arrow-notation syntax
298 | Opt_NoImplicitPrelude
302 data DynFlags = DynFlags {
303 coreToDo :: [CoreToDo],
304 stgToDo :: [StgToDo],
306 hscOutName :: String, -- name of the output file
307 hscStubHOutName :: String, -- name of the .stub_h output file
308 hscStubCOutName :: String, -- name of the .stub_c output file
309 extCoreName :: String, -- name of the .core output file
310 verbosity :: Int, -- verbosity level
311 cppFlag :: Bool, -- preprocess with cpp?
312 ppFlag :: Bool, -- preprocess with a Haskell Pp?
313 stolen_x86_regs :: Int,
314 cmdlineHcIncludes :: [String], -- -#includes
316 -- options for particular phases
342 | cGhcWithNativeCodeGen == "YES" &&
343 (prefixMatch "i386" cTARGETPLATFORM ||
344 prefixMatch "sparc" cTARGETPLATFORM ||
345 prefixMatch "powerpc" cTARGETPLATFORM) = HscAsm
348 defaultDynFlags = DynFlags {
349 coreToDo = [], stgToDo = [],
350 hscLang = defaultHscLang,
352 hscStubHOutName = "", hscStubCOutName = "",
358 cmdlineHcIncludes = [],
369 flags = [Opt_Generics] ++ standardWarnings,
370 -- Generating the helper-functions for
371 -- generics is now on by default
377 0 | print errors & warnings only
378 1 | minimal verbosity: print "compiling M ... done." for each module.
379 2 | equivalent to -dshow-passes
380 3 | equivalent to existing "ghc -v"
381 4 | "ghc -v -ddump-most"
382 5 | "ghc -v -ddump-all"
385 dopt :: DynFlag -> DynFlags -> Bool
386 dopt f dflags = f `elem` (flags dflags)
388 dopt_CoreToDo :: DynFlags -> [CoreToDo]
389 dopt_CoreToDo = coreToDo
391 dopt_StgToDo :: DynFlags -> [StgToDo]
392 dopt_StgToDo = stgToDo
394 dopt_OutName :: DynFlags -> String
395 dopt_OutName = hscOutName
397 dopt_HscLang :: DynFlags -> HscLang
398 dopt_HscLang = hscLang
400 dopt_set :: DynFlags -> DynFlag -> DynFlags
401 dopt_set dfs f = dfs{ flags = f : flags dfs }
403 dopt_unset :: DynFlags -> DynFlag -> DynFlags
404 dopt_unset dfs f = dfs{ flags = filter (/= f) (flags dfs) }
406 getOpts :: (DynFlags -> [a]) -> IO [a]
407 -- We add to the options from the front, so we need to reverse the list
408 getOpts opts = dynFlag opts >>= return . reverse
410 -- we can only switch between HscC, HscAsmm, and HscILX with dynamic flags
411 -- (-fvia-C, -fasm, -filx respectively).
412 setLang l = updDynFlags (\ dfs -> case hscLang dfs of
413 HscC -> dfs{ hscLang = l }
414 HscAsm -> dfs{ hscLang = l }
415 HscILX -> dfs{ hscLang = l }
419 verb <- dynFlag verbosity
420 if verb >= 3 then return "-v" else return ""
423 -----------------------------------------------------------------------------
424 -- Mess about with the mutable variables holding the dynamic arguments
427 -- is the "baseline" dynamic flags, initialised from
428 -- the defaults and command line options, and updated by the
429 -- ':s' command in GHCi.
432 -- is the dynamic flags for the current compilation. It is reset
433 -- to the value of v_InitDynFlags before each compilation, then
434 -- updated by reading any OPTIONS pragma in the current module.
437 GLOBAL_VAR(v_InitDynFlags, defaultDynFlags, DynFlags)
438 GLOBAL_VAR(v_DynFlags, defaultDynFlags, DynFlags)
440 setDynFlags :: DynFlags -> IO ()
441 setDynFlags dfs = writeIORef v_DynFlags dfs
443 saveDynFlags :: IO ()
444 saveDynFlags = do dfs <- readIORef v_DynFlags
445 writeIORef v_InitDynFlags dfs
447 restoreDynFlags :: IO DynFlags
448 restoreDynFlags = do dfs <- readIORef v_InitDynFlags
449 writeIORef v_DynFlags dfs
452 getDynFlags :: IO DynFlags
453 getDynFlags = readIORef v_DynFlags
455 updDynFlags :: (DynFlags -> DynFlags) -> IO ()
456 updDynFlags f = do dfs <- readIORef v_DynFlags
457 writeIORef v_DynFlags (f dfs)
459 dynFlag :: (DynFlags -> a) -> IO a
460 dynFlag f = do dflags <- readIORef v_DynFlags; return (f dflags)
462 setDynFlag, unSetDynFlag :: DynFlag -> IO ()
463 setDynFlag f = updDynFlags (\dfs -> dopt_set dfs f)
464 unSetDynFlag f = updDynFlags (\dfs -> dopt_unset dfs f)
468 %************************************************************************
470 \subsection{Warnings}
472 %************************************************************************
476 = [ Opt_WarnDeprecations,
477 Opt_WarnOverlappingPatterns,
478 Opt_WarnMissingFields,
479 Opt_WarnMissingMethods,
480 Opt_WarnDuplicateExports
484 = standardWarnings ++
485 [ Opt_WarnUnusedBinds,
486 Opt_WarnUnusedMatches,
487 Opt_WarnUnusedImports,
488 Opt_WarnIncompletePatterns,
494 [ Opt_WarnTypeDefaults,
495 Opt_WarnNameShadowing,
501 %************************************************************************
503 \subsection{Classifying command-line options}
505 %************************************************************************
508 -- v_Statis_hsc_opts is here to avoid a circular dependency with
510 GLOBAL_VAR(v_Static_hsc_opts, [], [String])
512 lookUp :: FastString -> Bool
513 lookup_int :: String -> Maybe Int
514 lookup_def_int :: String -> Int -> Int
515 lookup_def_float :: String -> Float -> Float
516 lookup_str :: String -> Maybe String
518 unpacked_static_opts = unsafePerformIO (readIORef v_Static_hsc_opts)
519 packed_static_opts = map mkFastString unpacked_static_opts
521 lookUp sw = sw `elem` packed_static_opts
523 lookup_str sw = firstJust (map (startsWith sw) unpacked_static_opts)
525 lookup_int sw = case (lookup_str sw) of
527 Just xx -> Just (read xx)
529 lookup_def_int sw def = case (lookup_str sw) of
530 Nothing -> def -- Use default
533 lookup_def_float sw def = case (lookup_str sw) of
534 Nothing -> def -- Use default
539 Putting the compiler options into temporary at-files
540 may turn out to be necessary later on if we turn hsc into
541 a pure Win32 application where I think there's a command-line
542 length limit of 255. unpacked_opts understands the @ option.
544 unpacked_opts :: [String]
548 map unpackFS argv -- NOT ARGV any more: v_Static_hsc_opts
550 expandAts ('@':fname) = words (unsafePerformIO (readFile fname))
555 %************************************************************************
557 \subsection{Static options}
559 %************************************************************************
563 opt_PprStyle_NoPrags = lookUp FSLIT("-dppr-noprags")
564 opt_PprStyle_Debug = lookUp FSLIT("-dppr-debug")
565 opt_PprStyle_RawTypes = lookUp FSLIT("-dppr-rawtypes")
566 opt_PprUserLength = lookup_def_int "-dppr-user-length" 5 --ToDo: give this a name
569 opt_AutoSccsOnAllToplevs = lookUp FSLIT("-fauto-sccs-on-all-toplevs")
570 opt_AutoSccsOnExportedToplevs = lookUp FSLIT("-fauto-sccs-on-exported-toplevs")
571 opt_AutoSccsOnIndividualCafs = lookUp FSLIT("-fauto-sccs-on-individual-cafs")
572 opt_AutoSccsOnDicts = lookUp FSLIT("-fauto-sccs-on-dicts")
573 opt_SccProfilingOn = lookUp FSLIT("-fscc-profiling")
574 opt_DoTickyProfiling = lookUp FSLIT("-fticky-ticky")
577 opt_AllStrict = lookUp FSLIT("-fall-strict")
578 opt_DictsStrict = lookUp FSLIT("-fdicts-strict")
579 opt_IrrefutableTuples = lookUp FSLIT("-firrefutable-tuples")
580 opt_MaxContextReductionDepth = lookup_def_int "-fcontext-stack" mAX_CONTEXT_REDUCTION_DEPTH
581 opt_NumbersStrict = lookUp FSLIT("-fnumbers-strict")
582 opt_Parallel = lookUp FSLIT("-fparallel")
583 opt_SMP = lookUp FSLIT("-fsmp")
584 opt_Flatten = lookUp FSLIT("-fflatten")
587 opt_NoMethodSharing = lookUp FSLIT("-fno-method-sharing")
588 opt_DoSemiTagging = lookUp FSLIT("-fsemi-tagging")
589 opt_FoldrBuildOn = lookUp FSLIT("-ffoldr-build-on")
590 opt_CprOff = lookUp FSLIT("-fcpr-off")
591 -- Switch off CPR analysis in the new demand analyser
592 opt_LiberateCaseThreshold = lookup_def_int "-fliberate-case-threshold" (10::Int)
593 opt_StgDoLetNoEscapes = lookUp FSLIT("-flet-no-escape")
594 opt_UnfoldCasms = lookUp FSLIT("-funfold-casms-in-hi-file")
595 opt_UnboxStrictFields = lookUp FSLIT("-funbox-strict-fields")
596 opt_MaxWorkerArgs = lookup_def_int "-fmax-worker-args" (10::Int)
599 The optional '-inpackage=P' flag tells what package
600 we are compiling this module for.
601 The Prelude, for example is compiled with '-inpackage std'
603 opt_InPackage = case lookup_str "-inpackage=" of
604 Just p -> mkFastString p
605 Nothing -> FSLIT("Main") -- The package name if none is specified
607 opt_EmitCExternDecls = lookUp FSLIT("-femit-extern-decls")
608 opt_EnsureSplittableC = lookUp FSLIT("-fglobalise-toplev-names")
609 opt_GranMacros = lookUp FSLIT("-fgransim")
610 opt_HiVersion = read (cProjectVersionInt ++ cProjectPatchLevel) :: Int
611 opt_HistorySize = lookup_def_int "-fhistory-size" 20
612 opt_IgnoreAsserts = lookUp FSLIT("-fignore-asserts")
613 opt_IgnoreIfacePragmas = lookUp FSLIT("-fignore-interface-pragmas")
614 opt_NoHiCheck = lookUp FSLIT("-fno-hi-version-check")
615 opt_OmitBlackHoling = lookUp FSLIT("-dno-black-holing")
616 opt_OmitInterfacePragmas = lookUp FSLIT("-fomit-interface-pragmas")
617 opt_RuntimeTypes = lookUp FSLIT("-fruntime-types")
619 -- Simplifier switches
620 opt_SimplNoPreInlining = lookUp FSLIT("-fno-pre-inlining")
621 -- NoPreInlining is there just to see how bad things
622 -- get if you don't do it!
623 opt_SimplDoEtaReduction = lookUp FSLIT("-fdo-eta-reduction")
624 opt_SimplDoLambdaEtaExpansion = lookUp FSLIT("-fdo-lambda-eta-expansion")
625 opt_SimplCaseMerge = lookUp FSLIT("-fcase-merge")
626 opt_SimplExcessPrecision = lookUp FSLIT("-fexcess-precision")
629 opt_UF_CreationThreshold = lookup_def_int "-funfolding-creation-threshold" (45::Int)
630 opt_UF_UseThreshold = lookup_def_int "-funfolding-use-threshold" (8::Int) -- Discounts can be big
631 opt_UF_FunAppDiscount = lookup_def_int "-funfolding-fun-discount" (6::Int) -- It's great to inline a fn
632 opt_UF_KeenessFactor = lookup_def_float "-funfolding-keeness-factor" (1.5::Float)
633 opt_UF_UpdateInPlace = lookUp FSLIT("-funfolding-update-in-place")
635 opt_UF_CheapOp = ( 1 :: Int) -- Only one instruction; and the args are charged for
636 opt_UF_DearOp = ( 4 :: Int)
638 opt_NoPruneDecls = lookUp FSLIT("-fno-prune-decls")
639 opt_NoPruneTyDecls = lookUp FSLIT("-fno-prune-tydecls")
640 opt_Static = lookUp FSLIT("-static")
641 opt_Unregisterised = lookUp FSLIT("-funregisterised")
642 opt_EmitExternalCore = lookUp FSLIT("-fext-core")
645 %************************************************************************
647 \subsection{List of static hsc flags}
649 %************************************************************************
654 "fauto-sccs-on-all-toplevs",
655 "fauto-sccs-on-exported-toplevs",
656 "fauto-sccs-on-individual-cafs",
657 "fauto-sccs-on-dicts",
662 "firrefutable-tuples",
670 "funfold-casms-in-hi-file",
671 "funbox-strict-fields",
672 "femit-extern-decls",
673 "fglobalise-toplev-names",
676 "fignore-interface-pragmas",
677 "fno-hi-version-check",
679 "fno-method-sharing",
680 "fomit-interface-pragmas",
684 "fdo-lambda-eta-expansion",
687 "funfolding-update-in-place",
696 || any (flip prefixMatch f) [
698 "fliberate-case-threshold",
701 "funfolding-creation-threshold",
702 "funfolding-use-threshold",
703 "funfolding-fun-discount",
704 "funfolding-keeness-factor"
708 %************************************************************************
710 \subsection{Misc functions for command-line options}
712 %************************************************************************
717 startsWith :: String -> String -> Maybe String
718 -- startsWith pfx (pfx++rest) = Just rest
720 startsWith [] str = Just str
721 startsWith (c:cs) (s:ss)
722 = if c /= s then Nothing else startsWith cs ss
723 startsWith _ [] = Nothing
725 endsWith :: String -> String -> Maybe String
727 = case (startsWith (reverse cs) (reverse ss)) of
729 Just rs -> Just (reverse rs)