2 % (c) The University of Glasgow, 1996-2000
4 \section[CmdLineOpts]{Things to do with command-line options}
10 SimplifierSwitch(..), isAmongSimpl,
15 DynFlag(..), -- needed non-abstractly by DriverFlags
26 opt_PprStyle_RawTypes,
32 -- other dynamic flags
38 -- sets of warning opts
44 opt_AutoSccsOnAllToplevs,
45 opt_AutoSccsOnExportedToplevs,
46 opt_AutoSccsOnIndividualCafs,
54 opt_MaxContextReductionDepth,
55 opt_IrrefutableTuples,
59 opt_NoMonomorphismRestriction,
66 opt_LiberateCaseThreshold,
67 opt_StgDoLetNoEscapes,
70 opt_UnboxStrictFields,
71 opt_SimplNoPreInlining,
72 opt_SimplDoEtaReduction,
73 opt_SimplDoLambdaEtaExpansion,
75 opt_SimplExcessPrecision,
78 opt_UF_CreationThreshold,
80 opt_UF_FunAppDiscount,
89 opt_EnsureSplittableC,
94 opt_IgnoreIfacePragmas,
97 opt_OmitInterfacePragmas,
104 #include "HsVersions.h"
106 import Array ( array, (//) )
108 import IOExts ( IORef, readIORef )
109 import Constants -- Default values for some flags
114 import Maybes ( firstJust )
115 import Panic ( panic )
117 #if __GLASGOW_HASKELL__ < 301
118 import ArrBase ( Array(..) )
120 import PrelArr ( Array(..) )
124 %************************************************************************
126 \subsection{Command-line options}
128 %************************************************************************
130 The hsc command-line options are split into two categories:
135 Static flags are represented by top-level values of type Bool or Int,
136 for example. They therefore have the same value throughout the
139 Dynamic flags are represented by an abstract type, DynFlags, which is
140 passed into hsc by the compilation manager for every compilation.
141 Dynamic flags are those that change on a per-compilation basis,
142 perhaps because they may be present in the OPTIONS pragma at the top
145 Other flag-related blurb:
147 A list of {\em ToDo}s is things to be done in a particular part of
148 processing. A (fictitious) example for the Core-to-Core simplifier
149 might be: run the simplifier, then run the strictness analyser, then
150 run the simplifier again (three ``todos'').
152 There are three ``to-do processing centers'' at the moment. In the
153 main loop (\tr{main/Main.lhs}), in the Core-to-Core processing loop
154 (\tr{simplCore/SimplCore.lhs), and in the STG-to-STG processing loop
155 (\tr{simplStg/SimplStg.lhs}).
157 %************************************************************************
159 \subsection{Datatypes associated with command-line options}
161 %************************************************************************
165 = SwBool Bool -- on/off
166 | SwString FAST_STRING -- nothing or a String
167 | SwInt Int -- nothing or an Int
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.
176 (SimplifierSwitch -> SwitchResult)
177 -- Each run of the simplifier can take a different
178 -- set of simplifier-specific flags.
180 | CoreDoFloatOutwards Bool -- True <=> float lambdas to top level
185 | CoreDoWorkerWrapper
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 SimplifierSwitch
206 = MaxSimplifierIterations Int
207 | SimplInlinePhase Int
213 %************************************************************************
215 \subsection{Dynamic command-line options}
217 %************************************************************************
230 | Opt_D_dump_inlinings
231 | Opt_D_dump_occur_anal
236 | Opt_D_dump_simpl_iterations
246 | Opt_D_dump_worker_wrapper
247 | Opt_D_dump_rn_trace
248 | Opt_D_dump_rn_stats
250 | Opt_D_dump_simpl_stats
251 | Opt_D_dump_tc_trace
254 | Opt_D_verbose_core2core
255 | Opt_D_verbose_stg2stg
257 | Opt_D_dump_hi_diffs
258 | Opt_D_dump_minimal_imports
263 | Opt_WarnDuplicateExports
265 | Opt_WarnIncompletePatterns
266 | Opt_WarnMissingFields
267 | Opt_WarnMissingMethods
268 | Opt_WarnMissingSigs
269 | Opt_WarnNameShadowing
270 | Opt_WarnOverlappingPatterns
271 | Opt_WarnSimplePatterns
272 | Opt_WarnTypeDefaults
273 | Opt_WarnUnusedBinds
274 | Opt_WarnUnusedImports
275 | Opt_WarnUnusedMatches
276 | Opt_WarnDeprecations
279 | Opt_AllowOverlappingInstances
280 | Opt_AllowUndecidableInstances
283 | Opt_NoImplicitPrelude
287 data DynFlags = DynFlags {
288 coreToDo :: [CoreToDo],
289 stgToDo :: [StgToDo],
291 hscOutName :: String, -- name of the output file
292 hscStubHOutName :: String, -- name of the .stub_h output file
293 hscStubCOutName :: String, -- name of the .stub_c output file
294 verbosity :: Int, -- verbosity level
295 cppFlag :: Bool, -- preprocess with cpp?
296 stolen_x86_regs :: Int,
297 cmdlineHcIncludes :: [String], -- -#includes
299 -- options for particular phases
310 defaultDynFlags = DynFlags {
311 coreToDo = [], stgToDo = [],
314 hscStubHOutName = "", hscStubCOutName = "",
318 cmdlineHcIncludes = [],
324 flags = standardWarnings,
330 0 | print errors & warnings only
331 1 | minimal verbosity: print "compiling M ... done." for each module.
332 2 | equivalent to -dshow-passes
333 3 | equivalent to existing "ghc -v"
334 4 | "ghc -v -ddump-most"
335 5 | "ghc -v -ddump-all"
338 dopt :: DynFlag -> DynFlags -> Bool
339 dopt f dflags = f `elem` (flags dflags)
341 dopt_CoreToDo :: DynFlags -> [CoreToDo]
342 dopt_CoreToDo = coreToDo
344 dopt_StgToDo :: DynFlags -> [StgToDo]
345 dopt_StgToDo = stgToDo
347 dopt_OutName :: DynFlags -> String
348 dopt_OutName = hscOutName
360 dopt_HscLang :: DynFlags -> HscLang
361 dopt_HscLang = hscLang
364 %************************************************************************
366 \subsection{Warnings}
368 %************************************************************************
372 = [ Opt_WarnDeprecations,
373 Opt_WarnOverlappingPatterns,
374 Opt_WarnMissingFields,
375 Opt_WarnMissingMethods,
376 Opt_WarnDuplicateExports
380 = standardWarnings ++
381 [ Opt_WarnUnusedBinds,
382 Opt_WarnUnusedMatches,
383 Opt_WarnUnusedImports,
384 Opt_WarnIncompletePatterns
389 [ Opt_WarnTypeDefaults,
390 Opt_WarnNameShadowing,
396 %************************************************************************
398 \subsection{Classifying command-line options}
400 %************************************************************************
403 -- v_Statis_hsc_opts is here to avoid a circular dependency with
405 GLOBAL_VAR(v_Static_hsc_opts, [], [String])
407 lookUp :: FAST_STRING -> Bool
408 lookup_int :: String -> Maybe Int
409 lookup_def_int :: String -> Int -> Int
410 lookup_def_float :: String -> Float -> Float
411 lookup_str :: String -> Maybe String
413 unpacked_static_opts = unsafePerformIO (readIORef v_Static_hsc_opts)
414 packed_static_opts = map _PK_ unpacked_static_opts
416 lookUp sw = sw `elem` packed_static_opts
418 lookup_str sw = firstJust (map (startsWith sw) unpacked_static_opts)
420 lookup_int sw = case (lookup_str sw) of
422 Just xx -> Just (read xx)
424 lookup_def_int sw def = case (lookup_str sw) of
425 Nothing -> def -- Use default
428 lookup_def_float sw def = case (lookup_str sw) of
429 Nothing -> def -- Use default
434 Putting the compiler options into temporary at-files
435 may turn out to be necessary later on if we turn hsc into
436 a pure Win32 application where I think there's a command-line
437 length limit of 255. unpacked_opts understands the @ option.
439 unpacked_opts :: [String]
443 map _UNPK_ argv -- NOT ARGV any more: v_Static_hsc_opts
445 expandAts ('@':fname) = words (unsafePerformIO (readFile fname))
450 %************************************************************************
452 \subsection{Static options}
454 %************************************************************************
458 opt_PprStyle_NoPrags = lookUp SLIT("-dppr-noprags")
459 opt_PprStyle_Debug = lookUp SLIT("-dppr-debug")
460 opt_PprStyle_RawTypes = lookUp SLIT("-dppr-rawtypes")
461 opt_PprUserLength = lookup_def_int "-dppr-user-length" 5 --ToDo: give this a name
464 opt_AutoSccsOnAllToplevs = lookUp SLIT("-fauto-sccs-on-all-toplevs")
465 opt_AutoSccsOnExportedToplevs = lookUp SLIT("-fauto-sccs-on-exported-toplevs")
466 opt_AutoSccsOnIndividualCafs = lookUp SLIT("-fauto-sccs-on-individual-cafs")
467 opt_AutoSccsOnDicts = lookUp SLIT("-fauto-sccs-on-dicts")
468 opt_SccProfilingOn = lookUp SLIT("-fscc-profiling")
469 opt_DoTickyProfiling = lookUp SLIT("-fticky-ticky")
472 opt_AllStrict = lookUp SLIT("-fall-strict")
473 opt_NoMonomorphismRestriction = lookUp SLIT("-fno-monomorphism-restriction")
474 opt_DictsStrict = lookUp SLIT("-fdicts-strict")
475 opt_IrrefutableTuples = lookUp SLIT("-firrefutable-tuples")
476 opt_MaxContextReductionDepth = lookup_def_int "-fcontext-stack" mAX_CONTEXT_REDUCTION_DEPTH
477 opt_NumbersStrict = lookUp SLIT("-fnumbers-strict")
478 opt_Parallel = lookUp SLIT("-fparallel")
479 opt_SMP = lookUp SLIT("-fsmp")
482 opt_NoMethodSharing = lookUp SLIT("-fno-method-sharing")
483 opt_DoSemiTagging = lookUp SLIT("-fsemi-tagging")
484 opt_FoldrBuildOn = lookUp SLIT("-ffoldr-build-on")
485 opt_LiberateCaseThreshold = lookup_def_int "-fliberate-case-threshold" (10::Int)
486 opt_StgDoLetNoEscapes = lookUp SLIT("-flet-no-escape")
487 opt_UnfoldCasms = lookUp SLIT("-funfold-casms-in-hi-file")
488 opt_UsageSPOn = lookUp SLIT("-fusagesp-on")
489 opt_UnboxStrictFields = lookUp SLIT("-funbox-strict-fields")
492 The optional '-inpackage=P' flag tells what package
493 we are compiling this module for.
494 The Prelude, for example is compiled with '-inpackage std'
496 opt_InPackage = case lookup_str "-inpackage=" of
498 Nothing -> SLIT("Main") -- The package name if none is specified
500 opt_EmitCExternDecls = lookUp SLIT("-femit-extern-decls")
501 opt_EnsureSplittableC = lookUp SLIT("-fglobalise-toplev-names")
502 opt_GranMacros = lookUp SLIT("-fgransim")
503 opt_HiVersion = read cProjectVersionInt :: Int
504 opt_HistorySize = lookup_def_int "-fhistory-size" 20
505 opt_IgnoreAsserts = lookUp SLIT("-fignore-asserts")
506 opt_IgnoreIfacePragmas = lookUp SLIT("-fignore-interface-pragmas")
507 opt_NoHiCheck = lookUp SLIT("-fno-hi-version-check")
508 opt_OmitBlackHoling = lookUp SLIT("-dno-black-holing")
509 opt_OmitInterfacePragmas = lookUp SLIT("-fomit-interface-pragmas")
510 opt_KeepStgTypes = lookUp SLIT("-fkeep-stg-types")
512 -- Simplifier switches
513 opt_SimplNoPreInlining = lookUp SLIT("-fno-pre-inlining")
514 -- NoPreInlining is there just to see how bad things
515 -- get if you don't do it!
516 opt_SimplDoEtaReduction = lookUp SLIT("-fdo-eta-reduction")
517 opt_SimplDoLambdaEtaExpansion = lookUp SLIT("-fdo-lambda-eta-expansion")
518 opt_SimplCaseMerge = lookUp SLIT("-fcase-merge")
519 opt_SimplExcessPrecision = lookUp SLIT("-fexcess-precision")
522 opt_UF_CreationThreshold = lookup_def_int "-funfolding-creation-threshold" (45::Int)
523 opt_UF_UseThreshold = lookup_def_int "-funfolding-use-threshold" (8::Int) -- Discounts can be big
524 opt_UF_FunAppDiscount = lookup_def_int "-funfolding-fun-discount" (6::Int) -- It's great to inline a fn
525 opt_UF_KeenessFactor = lookup_def_float "-funfolding-keeness-factor" (1.5::Float)
526 opt_UF_UpdateInPlace = lookUp SLIT("-funfolding-update-in-place")
528 opt_UF_CheapOp = ( 1 :: Int) -- Only one instruction; and the args are charged for
529 opt_UF_DearOp = ( 4 :: Int)
531 opt_NoPruneDecls = lookUp SLIT("-fno-prune-decls")
532 opt_NoPruneTyDecls = lookUp SLIT("-fno-prune-tydecls")
533 opt_Static = lookUp SLIT("-static")
534 opt_Unregisterised = lookUp SLIT("-funregisterised")
537 %************************************************************************
539 \subsection{List of static hsc flags}
541 %************************************************************************
546 "fauto-sccs-on-all-toplevs",
547 "fauto-sccs-on-exported-toplevs",
548 "fauto-sccs-on-individual-cafs",
549 "fauto-sccs-on-dicts",
554 "firrefutable-tuples",
561 "funfold-casms-in-hi-file",
563 "funbox-strict-fields",
564 "femit-extern-decls",
565 "fglobalise-toplev-names",
568 "fignore-interface-pragmas",
569 "fno-hi-version-check",
571 "fno-method-sharing",
572 "fno-monomorphism-restriction",
573 "fomit-interface-pragmas",
577 "fdo-lambda-eta-expansion",
580 "funfolding-update-in-place",
586 || any (flip prefixMatch f) [
588 "fliberate-case-threshold",
590 "funfolding-creation-threshold",
591 "funfolding-use-threshold",
592 "funfolding-fun-discount",
593 "funfolding-keeness-factor"
597 %************************************************************************
599 \subsection{Switch ordering}
601 %************************************************************************
603 These things behave just like enumeration types.
606 instance Eq SimplifierSwitch where
607 a == b = tagOf_SimplSwitch a ==# tagOf_SimplSwitch b
609 instance Ord SimplifierSwitch where
610 a < b = tagOf_SimplSwitch a <# tagOf_SimplSwitch b
611 a <= b = tagOf_SimplSwitch a <=# tagOf_SimplSwitch b
614 tagOf_SimplSwitch (SimplInlinePhase _) = _ILIT(1)
615 tagOf_SimplSwitch (MaxSimplifierIterations _) = _ILIT(2)
616 tagOf_SimplSwitch DontApplyRules = _ILIT(3)
617 tagOf_SimplSwitch SimplLetToCase = _ILIT(4)
618 tagOf_SimplSwitch NoCaseOfCase = _ILIT(5)
620 -- If you add anything here, be sure to change lAST_SIMPL_SWITCH_TAG, too!
622 lAST_SIMPL_SWITCH_TAG = 5
625 %************************************************************************
627 \subsection{Switch lookup}
629 %************************************************************************
632 isAmongSimpl :: [SimplifierSwitch] -> SimplifierSwitch -> SwitchResult
633 isAmongSimpl on_switches -- Switches mentioned later occur *earlier*
634 -- in the list; defaults right at the end.
636 tidied_on_switches = foldl rm_dups [] on_switches
637 -- The fold*l* ensures that we keep the latest switches;
638 -- ie the ones that occur earliest in the list.
640 sw_tbl :: Array Int SwitchResult
641 sw_tbl = (array (0, lAST_SIMPL_SWITCH_TAG) -- bounds...
645 all_undefined = [ (i, SwBool False) | i <- [0 .. lAST_SIMPL_SWITCH_TAG ] ]
647 defined_elems = map mk_assoc_elem tidied_on_switches
649 -- (avoid some unboxing, bounds checking, and other horrible things:)
650 #if __GLASGOW_HASKELL__ < 405
651 case sw_tbl of { Array bounds_who_needs_'em stuff ->
653 case sw_tbl of { Array _ _ stuff ->
656 case (indexArray# stuff (tagOf_SimplSwitch switch)) of
657 #if __GLASGOW_HASKELL__ < 400
659 #elif __GLASGOW_HASKELL__ < 403
666 mk_assoc_elem k@(MaxSimplifierIterations lvl)
667 = (iBox (tagOf_SimplSwitch k), SwInt lvl)
668 mk_assoc_elem k@(SimplInlinePhase n)
669 = (iBox (tagOf_SimplSwitch k), SwInt n)
671 = (iBox (tagOf_SimplSwitch k), SwBool True) -- I'm here, Mom!
673 -- cannot have duplicates if we are going to use the array thing
674 rm_dups switches_so_far switch
675 = if switch `is_elem` switches_so_far
677 else switch : switches_so_far
679 sw `is_elem` [] = False
680 sw `is_elem` (s:ss) = (tagOf_SimplSwitch sw) ==# (tagOf_SimplSwitch s)
685 %************************************************************************
687 \subsection{Misc functions for command-line options}
689 %************************************************************************
693 switchIsOn :: (switch -> SwitchResult) -> switch -> Bool
695 switchIsOn lookup_fn switch
696 = case (lookup_fn switch) of
697 SwBool False -> False
700 intSwitchSet :: (switch -> SwitchResult)
704 intSwitchSet lookup_fn switch
705 = case (lookup_fn (switch (panic "intSwitchSet"))) of
706 SwInt int -> Just int
711 startsWith :: String -> String -> Maybe String
712 -- startsWith pfx (pfx++rest) = Just rest
714 startsWith [] str = Just str
715 startsWith (c:cs) (s:ss)
716 = if c /= s then Nothing else startsWith cs ss
717 startsWith _ [] = Nothing
719 endsWith :: String -> String -> Maybe String
721 = case (startsWith (reverse cs) (reverse ss)) of
723 Just rs -> Just (reverse rs)