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"
121 import IOExts ( IORef, readIORef, writeIORef )
122 import Constants -- Default values for some flags
125 import FastString ( FastString, mkFastString )
128 import Maybes ( firstJust )
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
264 | Opt_D_verbose_core2core
265 | Opt_D_verbose_stg2stg
267 | Opt_D_dump_hi_diffs
268 | Opt_D_dump_minimal_imports
273 | Opt_WarnDuplicateExports
275 | Opt_WarnIncompletePatterns
276 | Opt_WarnMissingFields
277 | Opt_WarnMissingMethods
278 | Opt_WarnMissingSigs
279 | Opt_WarnNameShadowing
280 | Opt_WarnOverlappingPatterns
281 | Opt_WarnSimplePatterns
282 | Opt_WarnTypeDefaults
283 | Opt_WarnUnusedBinds
284 | Opt_WarnUnusedImports
285 | Opt_WarnUnusedMatches
286 | Opt_WarnDeprecations
290 | Opt_AllowOverlappingInstances
291 | Opt_AllowUndecidableInstances
292 | Opt_AllowIncoherentInstances
293 | Opt_NoMonomorphismRestriction
295 | Opt_PArr -- syntactic support for parallel arrays
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
342 | cGhcWithNativeCodeGen == "YES" &&
343 (prefixMatch "i386" cTARGETPLATFORM ||
344 prefixMatch "sparc" 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_FoldrBuildOn = lookUp FSLIT("-ffoldr-build-on")
589 opt_CprOff = lookUp FSLIT("-fcpr-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_UsageSPOn = lookUp FSLIT("-fusagesp-on")
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",
672 "funbox-strict-fields",
673 "femit-extern-decls",
674 "fglobalise-toplev-names",
677 "fignore-interface-pragmas",
678 "fno-hi-version-check",
680 "fno-method-sharing",
681 "fomit-interface-pragmas",
685 "fdo-lambda-eta-expansion",
688 "funfolding-update-in-place",
697 || any (flip prefixMatch f) [
699 "fliberate-case-threshold",
702 "funfolding-creation-threshold",
703 "funfolding-use-threshold",
704 "funfolding-fun-discount",
705 "funfolding-keeness-factor"
709 %************************************************************************
711 \subsection{Misc functions for command-line options}
713 %************************************************************************
718 startsWith :: String -> String -> Maybe String
719 -- startsWith pfx (pfx++rest) = Just rest
721 startsWith [] str = Just str
722 startsWith (c:cs) (s:ss)
723 = if c /= s then Nothing else startsWith cs ss
724 startsWith _ [] = Nothing
726 endsWith :: String -> String -> Maybe String
728 = case (startsWith (reverse cs) (reverse ss)) of
730 Just rs -> Just (reverse rs)