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,
76 opt_LiberateCaseThreshold,
77 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,
116 #include "HsVersions.h"
118 import Constants -- Default values for some flags
120 import FastString ( FastString, mkFastString )
122 import Maybes ( firstJust )
125 import DATA_IOREF ( IORef, readIORef, writeIORef )
126 import UNSAFE_IO ( unsafePerformIO )
129 %************************************************************************
131 \subsection{Command-line options}
133 %************************************************************************
135 The hsc command-line options are split into two categories:
140 Static flags are represented by top-level values of type Bool or Int,
141 for example. They therefore have the same value throughout the
144 Dynamic flags are represented by an abstract type, DynFlags, which is
145 passed into hsc by the compilation manager for every compilation.
146 Dynamic flags are those that change on a per-compilation basis,
147 perhaps because they may be present in the OPTIONS pragma at the top
150 Other flag-related blurb:
152 A list of {\em ToDo}s is things to be done in a particular part of
153 processing. A (fictitious) example for the Core-to-Core simplifier
154 might be: run the simplifier, then run the strictness analyser, then
155 run the simplifier again (three ``todos'').
157 There are three ``to-do processing centers'' at the moment. In the
158 main loop (\tr{main/Main.lhs}), in the Core-to-Core processing loop
159 (\tr{simplCore/SimplCore.lhs), and in the STG-to-STG processing loop
160 (\tr{simplStg/SimplStg.lhs}).
162 %************************************************************************
164 \subsection{Datatypes associated with command-line options}
166 %************************************************************************
169 data CoreToDo -- These are diff core-to-core passes,
170 -- which may be invoked in any order,
171 -- as many times as you like.
173 = CoreDoSimplify -- The core-to-core simplifier.
176 -- Each run of the simplifier can take a different
177 -- set of simplifier-specific flags.
179 | CoreDoFloatOutwards FloatOutSwitches
184 | CoreDoWorkerWrapper
187 | CoreDoOldStrictness
190 | CoreDoRuleCheck Int{-CompilerPhase-} String -- Check for non-application of rules
191 -- matching this string
193 | CoreDoNothing -- useful when building up lists of these things
198 = StgDoMassageForProfiling -- should be (next to) last
199 -- There's also setStgVarInfo, but its absolute "lastness"
200 -- is so critical that it is hardwired in (no flag).
205 data SimplifierMode -- See comments in SimplMonad
209 data SimplifierSwitch
210 = MaxSimplifierIterations Int
213 data FloatOutSwitches
214 = FloatOutSw Bool -- True <=> float lambdas to top level
215 Bool -- True <=> float constants to top level,
216 -- even if they do not escape a lambda
219 %************************************************************************
221 \subsection{Dynamic command-line options}
223 %************************************************************************
236 | Opt_D_dump_inlinings
237 | Opt_D_dump_occur_anal
242 | Opt_D_dump_simpl_iterations
251 | Opt_D_dump_worker_wrapper
252 | Opt_D_dump_rn_trace
253 | Opt_D_dump_rn_stats
255 | Opt_D_dump_simpl_stats
256 | Opt_D_dump_tc_trace
261 | Opt_D_verbose_core2core
262 | Opt_D_verbose_stg2stg
264 | Opt_D_dump_hi_diffs
265 | Opt_D_dump_minimal_imports
269 | Opt_WarnIsError -- -Werror; makes warnings fatal
270 | Opt_WarnDuplicateExports
272 | Opt_WarnIncompletePatterns
273 | Opt_WarnMissingFields
274 | Opt_WarnMissingMethods
275 | Opt_WarnMissingSigs
276 | Opt_WarnNameShadowing
277 | Opt_WarnOverlappingPatterns
278 | Opt_WarnSimplePatterns
279 | Opt_WarnTypeDefaults
280 | Opt_WarnUnusedBinds
281 | Opt_WarnUnusedImports
282 | Opt_WarnUnusedMatches
283 | Opt_WarnDeprecations
287 | Opt_AllowOverlappingInstances
288 | Opt_AllowUndecidableInstances
289 | Opt_AllowIncoherentInstances
290 | Opt_NoMonomorphismRestriction
293 | Opt_PArr -- syntactic support for parallel arrays
294 | Opt_With -- deprecated keyword for implicit parms
295 | Opt_Arrows -- Arrow-notation syntax
297 | Opt_NoImplicitPrelude
301 data DynFlags = DynFlags {
302 coreToDo :: [CoreToDo],
303 stgToDo :: [StgToDo],
305 hscOutName :: String, -- name of the output file
306 hscStubHOutName :: String, -- name of the .stub_h output file
307 hscStubCOutName :: String, -- name of the .stub_c output file
308 extCoreName :: String, -- name of the .core output file
309 verbosity :: Int, -- verbosity level
310 cppFlag :: Bool, -- preprocess with cpp?
311 ppFlag :: Bool, -- preprocess with a Haskell Pp?
312 stolen_x86_regs :: Int,
313 cmdlineHcIncludes :: [String], -- -#includes
315 -- options for particular phases
341 | cGhcWithNativeCodeGen == "YES" &&
342 (prefixMatch "i386" cTARGETPLATFORM ||
343 prefixMatch "sparc" cTARGETPLATFORM ||
344 prefixMatch "powerpc" cTARGETPLATFORM) = HscAsm
347 defaultDynFlags = DynFlags {
348 coreToDo = [], stgToDo = [],
349 hscLang = defaultHscLang,
351 hscStubHOutName = "", hscStubCOutName = "",
357 cmdlineHcIncludes = [],
368 flags = [Opt_Generics] ++ standardWarnings,
369 -- Generating the helper-functions for
370 -- generics is now on by default
376 0 | print errors & warnings only
377 1 | minimal verbosity: print "compiling M ... done." for each module.
378 2 | equivalent to -dshow-passes
379 3 | equivalent to existing "ghc -v"
380 4 | "ghc -v -ddump-most"
381 5 | "ghc -v -ddump-all"
384 dopt :: DynFlag -> DynFlags -> Bool
385 dopt f dflags = f `elem` (flags dflags)
387 dopt_CoreToDo :: DynFlags -> [CoreToDo]
388 dopt_CoreToDo = coreToDo
390 dopt_StgToDo :: DynFlags -> [StgToDo]
391 dopt_StgToDo = stgToDo
393 dopt_OutName :: DynFlags -> String
394 dopt_OutName = hscOutName
396 dopt_HscLang :: DynFlags -> HscLang
397 dopt_HscLang = hscLang
399 dopt_set :: DynFlags -> DynFlag -> DynFlags
400 dopt_set dfs f = dfs{ flags = f : flags dfs }
402 dopt_unset :: DynFlags -> DynFlag -> DynFlags
403 dopt_unset dfs f = dfs{ flags = filter (/= f) (flags dfs) }
405 getOpts :: (DynFlags -> [a]) -> IO [a]
406 -- We add to the options from the front, so we need to reverse the list
407 getOpts opts = dynFlag opts >>= return . reverse
409 -- we can only switch between HscC, HscAsmm, and HscILX with dynamic flags
410 -- (-fvia-C, -fasm, -filx respectively).
411 setLang l = updDynFlags (\ dfs -> case hscLang dfs of
412 HscC -> dfs{ hscLang = l }
413 HscAsm -> dfs{ hscLang = l }
414 HscILX -> dfs{ hscLang = l }
418 verb <- dynFlag verbosity
419 if verb >= 3 then return "-v" else return ""
422 -----------------------------------------------------------------------------
423 -- Mess about with the mutable variables holding the dynamic arguments
426 -- is the "baseline" dynamic flags, initialised from
427 -- the defaults and command line options, and updated by the
428 -- ':s' command in GHCi.
431 -- is the dynamic flags for the current compilation. It is reset
432 -- to the value of v_InitDynFlags before each compilation, then
433 -- updated by reading any OPTIONS pragma in the current module.
436 GLOBAL_VAR(v_InitDynFlags, defaultDynFlags, DynFlags)
437 GLOBAL_VAR(v_DynFlags, defaultDynFlags, DynFlags)
439 setDynFlags :: DynFlags -> IO ()
440 setDynFlags dfs = writeIORef v_DynFlags dfs
442 saveDynFlags :: IO ()
443 saveDynFlags = do dfs <- readIORef v_DynFlags
444 writeIORef v_InitDynFlags dfs
446 restoreDynFlags :: IO DynFlags
447 restoreDynFlags = do dfs <- readIORef v_InitDynFlags
448 writeIORef v_DynFlags dfs
451 getDynFlags :: IO DynFlags
452 getDynFlags = readIORef v_DynFlags
454 updDynFlags :: (DynFlags -> DynFlags) -> IO ()
455 updDynFlags f = do dfs <- readIORef v_DynFlags
456 writeIORef v_DynFlags (f dfs)
458 dynFlag :: (DynFlags -> a) -> IO a
459 dynFlag f = do dflags <- readIORef v_DynFlags; return (f dflags)
461 setDynFlag, unSetDynFlag :: DynFlag -> IO ()
462 setDynFlag f = updDynFlags (\dfs -> dopt_set dfs f)
463 unSetDynFlag f = updDynFlags (\dfs -> dopt_unset dfs f)
467 %************************************************************************
469 \subsection{Warnings}
471 %************************************************************************
475 = [ Opt_WarnDeprecations,
476 Opt_WarnOverlappingPatterns,
477 Opt_WarnMissingFields,
478 Opt_WarnMissingMethods,
479 Opt_WarnDuplicateExports
483 = standardWarnings ++
484 [ Opt_WarnUnusedBinds,
485 Opt_WarnUnusedMatches,
486 Opt_WarnUnusedImports,
487 Opt_WarnIncompletePatterns,
493 [ Opt_WarnTypeDefaults,
494 Opt_WarnNameShadowing,
500 %************************************************************************
502 \subsection{Classifying command-line options}
504 %************************************************************************
507 -- v_Statis_hsc_opts is here to avoid a circular dependency with
509 GLOBAL_VAR(v_Static_hsc_opts, [], [String])
511 lookUp :: FastString -> Bool
512 lookup_int :: String -> Maybe Int
513 lookup_def_int :: String -> Int -> Int
514 lookup_def_float :: String -> Float -> Float
515 lookup_str :: String -> Maybe String
517 unpacked_static_opts = unsafePerformIO (readIORef v_Static_hsc_opts)
518 packed_static_opts = map mkFastString unpacked_static_opts
520 lookUp sw = sw `elem` packed_static_opts
522 lookup_str sw = firstJust (map (startsWith sw) unpacked_static_opts)
524 lookup_int sw = case (lookup_str sw) of
526 Just xx -> Just (read xx)
528 lookup_def_int sw def = case (lookup_str sw) of
529 Nothing -> def -- Use default
532 lookup_def_float sw def = case (lookup_str sw) of
533 Nothing -> def -- Use default
538 Putting the compiler options into temporary at-files
539 may turn out to be necessary later on if we turn hsc into
540 a pure Win32 application where I think there's a command-line
541 length limit of 255. unpacked_opts understands the @ option.
543 unpacked_opts :: [String]
547 map unpackFS argv -- NOT ARGV any more: v_Static_hsc_opts
549 expandAts ('@':fname) = words (unsafePerformIO (readFile fname))
554 %************************************************************************
556 \subsection{Static options}
558 %************************************************************************
562 opt_PprStyle_NoPrags = lookUp FSLIT("-dppr-noprags")
563 opt_PprStyle_Debug = lookUp FSLIT("-dppr-debug")
564 opt_PprStyle_RawTypes = lookUp FSLIT("-dppr-rawtypes")
565 opt_PprUserLength = lookup_def_int "-dppr-user-length" 5 --ToDo: give this a name
568 opt_AutoSccsOnAllToplevs = lookUp FSLIT("-fauto-sccs-on-all-toplevs")
569 opt_AutoSccsOnExportedToplevs = lookUp FSLIT("-fauto-sccs-on-exported-toplevs")
570 opt_AutoSccsOnIndividualCafs = lookUp FSLIT("-fauto-sccs-on-individual-cafs")
571 opt_AutoSccsOnDicts = lookUp FSLIT("-fauto-sccs-on-dicts")
572 opt_SccProfilingOn = lookUp FSLIT("-fscc-profiling")
573 opt_DoTickyProfiling = lookUp FSLIT("-fticky-ticky")
576 opt_AllStrict = lookUp FSLIT("-fall-strict")
577 opt_DictsStrict = lookUp FSLIT("-fdicts-strict")
578 opt_IrrefutableTuples = lookUp FSLIT("-firrefutable-tuples")
579 opt_MaxContextReductionDepth = lookup_def_int "-fcontext-stack" mAX_CONTEXT_REDUCTION_DEPTH
580 opt_NumbersStrict = lookUp FSLIT("-fnumbers-strict")
581 opt_Parallel = lookUp FSLIT("-fparallel")
582 opt_SMP = lookUp FSLIT("-fsmp")
583 opt_Flatten = lookUp FSLIT("-fflatten")
586 opt_NoMethodSharing = lookUp FSLIT("-fno-method-sharing")
587 opt_DoSemiTagging = lookUp FSLIT("-fsemi-tagging")
588 opt_CprOff = lookUp FSLIT("-fcpr-off")
589 opt_RulesOff = lookUp FSLIT("-frules-off")
590 -- Switch off CPR analysis in the new demand analyser
591 opt_LiberateCaseThreshold = lookup_def_int "-fliberate-case-threshold" (10::Int)
592 opt_StgDoLetNoEscapes = lookUp FSLIT("-flet-no-escape")
593 opt_UnfoldCasms = lookUp FSLIT("-funfold-casms-in-hi-file")
594 opt_UnboxStrictFields = lookUp FSLIT("-funbox-strict-fields")
595 opt_MaxWorkerArgs = lookup_def_int "-fmax-worker-args" (10::Int)
598 The optional '-inpackage=P' flag tells what package
599 we are compiling this module for.
600 The Prelude, for example is compiled with '-inpackage std'
602 opt_InPackage = case lookup_str "-inpackage=" of
603 Just p -> mkFastString p
604 Nothing -> FSLIT("Main") -- The package name if none is specified
606 opt_EmitCExternDecls = lookUp FSLIT("-femit-extern-decls")
607 opt_EnsureSplittableC = lookUp FSLIT("-fglobalise-toplev-names")
608 opt_GranMacros = lookUp FSLIT("-fgransim")
609 opt_HiVersion = read (cProjectVersionInt ++ cProjectPatchLevel) :: Int
610 opt_HistorySize = lookup_def_int "-fhistory-size" 20
611 opt_IgnoreAsserts = lookUp FSLIT("-fignore-asserts")
612 opt_IgnoreIfacePragmas = lookUp FSLIT("-fignore-interface-pragmas")
613 opt_NoHiCheck = lookUp FSLIT("-fno-hi-version-check")
614 opt_OmitBlackHoling = lookUp FSLIT("-dno-black-holing")
615 opt_OmitInterfacePragmas = lookUp FSLIT("-fomit-interface-pragmas")
616 opt_RuntimeTypes = lookUp FSLIT("-fruntime-types")
618 -- Simplifier switches
619 opt_SimplNoPreInlining = lookUp FSLIT("-fno-pre-inlining")
620 -- NoPreInlining is there just to see how bad things
621 -- get if you don't do it!
622 opt_SimplDoEtaReduction = lookUp FSLIT("-fdo-eta-reduction")
623 opt_SimplDoLambdaEtaExpansion = lookUp FSLIT("-fdo-lambda-eta-expansion")
624 opt_SimplCaseMerge = lookUp FSLIT("-fcase-merge")
625 opt_SimplExcessPrecision = lookUp FSLIT("-fexcess-precision")
628 opt_UF_CreationThreshold = lookup_def_int "-funfolding-creation-threshold" (45::Int)
629 opt_UF_UseThreshold = lookup_def_int "-funfolding-use-threshold" (8::Int) -- Discounts can be big
630 opt_UF_FunAppDiscount = lookup_def_int "-funfolding-fun-discount" (6::Int) -- It's great to inline a fn
631 opt_UF_KeenessFactor = lookup_def_float "-funfolding-keeness-factor" (1.5::Float)
632 opt_UF_UpdateInPlace = lookUp FSLIT("-funfolding-update-in-place")
634 opt_UF_CheapOp = ( 1 :: Int) -- Only one instruction; and the args are charged for
635 opt_UF_DearOp = ( 4 :: Int)
637 opt_NoPruneDecls = lookUp FSLIT("-fno-prune-decls")
638 opt_Static = lookUp FSLIT("-static")
639 opt_Unregisterised = lookUp FSLIT("-funregisterised")
640 opt_EmitExternalCore = lookUp FSLIT("-fext-core")
643 %************************************************************************
645 \subsection{List of static hsc flags}
647 %************************************************************************
652 "fauto-sccs-on-all-toplevs",
653 "fauto-sccs-on-exported-toplevs",
654 "fauto-sccs-on-individual-cafs",
655 "fauto-sccs-on-dicts",
660 "firrefutable-tuples",
667 "funfold-casms-in-hi-file",
668 "funbox-strict-fields",
669 "femit-extern-decls",
670 "fglobalise-toplev-names",
673 "fignore-interface-pragmas",
674 "fno-hi-version-check",
676 "fno-method-sharing",
677 "fomit-interface-pragmas",
681 "fdo-lambda-eta-expansion",
684 "funfolding-update-in-place",
693 || any (flip prefixMatch f) [
695 "fliberate-case-threshold",
698 "funfolding-creation-threshold",
699 "funfolding-use-threshold",
700 "funfolding-fun-discount",
701 "funfolding-keeness-factor"
705 %************************************************************************
707 \subsection{Misc functions for command-line options}
709 %************************************************************************
714 startsWith :: String -> String -> Maybe String
715 -- startsWith pfx (pfx++rest) = Just rest
717 startsWith [] str = Just str
718 startsWith (c:cs) (s:ss)
719 = if c /= s then Nothing else startsWith cs ss
720 startsWith _ [] = Nothing
722 endsWith :: String -> String -> Maybe String
724 = case (startsWith (reverse cs) (reverse ss)) of
726 Just rs -> Just (reverse rs)