2 % (c) The AQUA Project, Glasgow University, 1996
4 \section[CmdLineOpts]{Things to do with command-line options}
7 #include "HsVersions.h"
19 maybe_CompilingGhcInternals,
22 opt_AutoSccsOnAllToplevs,
23 opt_AutoSccsOnExportedToplevs,
24 opt_AutoSccsOnIndividualCafs,
25 opt_CompilingGhcInternals,
26 opt_UsingGhcInternals,
33 opt_D_dump_occur_anal,
43 opt_D_simplifier_stats,
45 opt_D_verbose_core2core,
46 opt_D_verbose_stg2stg,
50 opt_EnsureSplittableC,
58 opt_IgnoreIfacePragmas,
59 opt_IgnoreStrictnessPragmas,
60 opt_IrrefutableEverything,
61 opt_IrrefutableTuples,
62 opt_NoImplicitPrelude,
65 opt_OmitDefaultInstanceMethods,
66 opt_OmitInterfacePragmas,
73 opt_ReportWhyUnfoldingsDisallowed,
74 opt_ReturnInRegsThreshold,
78 opt_ShowPragmaNameErrs,
81 opt_SpecialiseImports,
82 opt_SpecialiseOverloaded,
84 opt_SpecialiseUnboxed,
85 opt_StgDoLetNoEscapes,
86 opt_UnfoldingCreationThreshold,
87 opt_UnfoldingOverrideThreshold,
88 opt_UnfoldingUseThreshold,
93 IMPORT_1_3(Array(array, (//)))
94 import PreludeGlaST -- bad bad bad boy, Will (_Array internals)
97 CHK_Ubiq() -- debugging consistency check
99 import Maybes ( assocMaybe, firstJust, maybeToBool )
100 import Util ( startsWith, panic, panic#, assertPanic )
103 A command-line {\em switch} is (generally) either on or off; e.g., the
104 ``verbose'' (-v) switch is either on or off. (The \tr{-G<group>}
105 switch is an exception; it's set to a string, or nothing.)
107 A list of {\em ToDo}s is things to be done in a particular part of
108 processing. A (fictitious) example for the Core-to-Core simplifier
109 might be: run the simplifier, then run the strictness analyser, then
110 run the simplifier again (three ``todos'').
112 There are three ``to-do processing centers'' at the moment. In the
113 main loop (\tr{main/Main.lhs}), in the Core-to-Core processing loop
114 (\tr{simplCore/SimplCore.lhs), and in the STG-to-STG processing loop
115 (\tr{simplStg/SimplStg.lhs}).
117 %************************************************************************
119 \subsection{Datatypes associated with command-line options}
121 %************************************************************************
125 = SwBool Bool -- on/off
126 | SwString FAST_STRING -- nothing or a String
127 | SwInt Int -- nothing or an Int
131 data CoreToDo -- These are diff core-to-core passes,
132 -- which may be invoked in any order,
133 -- as many times as you like.
135 = CoreDoSimplify -- The core-to-core simplifier.
136 (SimplifierSwitch -> SwitchResult)
137 -- Each run of the simplifier can take a different
138 -- set of simplifier-specific flags.
139 | CoreDoCalcInlinings1
140 | CoreDoCalcInlinings2
149 | CoreDoFoldrBuildWorkerWrapper
150 | CoreDoFoldrBuildWWAnal
156 | StgDoUpdateAnalysis
158 | StgDoMassageForProfiling -- should be (next to) last
159 -- There's also setStgVarInfo, but its absolute "lastness"
160 -- is so critical that it is hardwired in (no flag).
165 data SimplifierSwitch
167 | SimplFloatLetsExposingWHNF
168 | SimplOkToFloatPrimOps
169 | SimplAlwaysFloatLetsFromLets
174 | SimplMayDeleteConjurableIds
175 | SimplPedanticBottoms -- see Simplifier for an explanation
176 | SimplDoArityExpand -- expand arity of bindings
177 | SimplDoFoldrBuild -- This is the per-simplification flag;
178 -- see also FoldrBuildOn, used elsewhere
180 | SimplDoInlineFoldrBuild
181 -- inline foldr/build (*after* f/b rule is used)
184 | SimplDoLambdaEtaExpansion
185 | SimplDoEtaReduction
187 | EssentialUnfoldingsOnly -- never mind the thresholds, only
188 -- do unfoldings that *must* be done
189 -- (to saturate constructors and primitives)
191 | ShowSimplifierProgress -- report counts on every interation
193 | MaxSimplifierIterations Int
195 | SimplUnfoldingUseThreshold Int -- per-simplification variants
196 | SimplUnfoldingCreationThreshold Int
198 | KeepSpecPragmaIds -- We normally *toss* Ids we can do without
201 | SimplNoLetFromCase -- used when turning off floating entirely
202 | SimplNoLetFromApp -- (for experimentation only) WDP 95/10
203 | SimplNoLetFromStrictLet
205 | SimplDontFoldBackAppend
206 -- we fold `foldr (:)' back into flip (++),
207 -- but we *don't* want to do it when compiling
208 -- List.hs, otherwise
209 -- xs ++ ys = foldr (:) ys xs
210 -- {- via our loopback -}
211 -- xs ++ ys = xs ++ ys
213 -- So only use this flag inside List.hs
214 -- (Sigh, what a HACK, Andy. WDP 96/01)
217 %************************************************************************
219 \subsection{Classifying command-line options}
221 %************************************************************************
224 lookUp :: FAST_STRING -> Bool
225 lookup_int :: String -> Maybe Int
226 lookup_str :: String -> Maybe String
228 lookUp sw = maybeToBool (assoc_opts sw)
230 lookup_str sw = firstJust (map (startsWith sw) unpacked_opts)
232 lookup_int sw = case (lookup_str sw) of
234 Just xx -> Just (read xx)
236 assoc_opts = assocMaybe [ (a, True) | a <- argv ]
237 unpacked_opts = map _UNPK_ argv
241 opt_AllDemanded = lookUp SLIT("-fall-demanded")
242 opt_AllStrict = lookUp SLIT("-fall-strict")
243 opt_AutoSccsOnAllToplevs = lookUp SLIT("-fauto-sccs-on-all-toplevs")
244 opt_AutoSccsOnExportedToplevs = lookUp SLIT("-fauto-sccs-on-exported-toplevs")
245 opt_AutoSccsOnIndividualCafs = lookUp SLIT("-fauto-sccs-on-individual-cafs")
246 opt_D_dump_absC = lookUp SLIT("-ddump-absC")
247 opt_D_dump_asm = lookUp SLIT("-ddump-asm")
248 opt_D_dump_deforest = lookUp SLIT("-ddump-deforest")
249 opt_D_dump_deriv = lookUp SLIT("-ddump-deriv")
250 opt_D_dump_ds = lookUp SLIT("-ddump-ds")
251 opt_D_dump_flatC = lookUp SLIT("-ddump-flatC")
252 opt_D_dump_occur_anal = lookUp SLIT("-ddump-occur-anal")
253 opt_D_dump_rdr = lookUp SLIT("-ddump-rdr")
254 opt_D_dump_realC = lookUp SLIT("-ddump-realC")
255 opt_D_dump_rn = lookUp SLIT("-ddump-rn")
256 opt_D_dump_simpl = lookUp SLIT("-ddump-simpl")
257 opt_D_dump_spec = lookUp SLIT("-ddump-spec")
258 opt_D_dump_stg = lookUp SLIT("-ddump-stg")
259 opt_D_dump_stranal = lookUp SLIT("-ddump-stranal")
260 opt_D_dump_tc = lookUp SLIT("-ddump-tc")
261 opt_D_show_passes = lookUp SLIT("-dshow-passes")
262 opt_D_simplifier_stats = lookUp SLIT("-dsimplifier-stats")
263 opt_D_source_stats = lookUp SLIT("-dsource-stats")
264 opt_D_verbose_core2core = lookUp SLIT("-dverbose-simpl")
265 opt_D_verbose_stg2stg = lookUp SLIT("-dverbose-stg")
266 opt_DoCoreLinting = lookUp SLIT("-dcore-lint")
267 opt_DoSemiTagging = lookUp SLIT("-fsemi-tagging")
268 opt_DoTickyProfiling = lookUp SLIT("-fticky-ticky")
269 opt_FoldrBuildOn = lookUp SLIT("-ffoldr-build-on")
270 opt_FoldrBuildTrace = lookUp SLIT("-ffoldr-build-trace")
271 opt_ForConcurrent = lookUp SLIT("-fconcurrent")
272 opt_GranMacros = lookUp SLIT("-fgransim")
273 opt_GlasgowExts = lookUp SLIT("-fglasgow-exts")
274 opt_Haskell_1_3 = lookUp SLIT("-fhaskell-1.3")
275 opt_IgnoreStrictnessPragmas = lookUp SLIT("-fignore-strictness-pragmas")
276 opt_IrrefutableEverything = lookUp SLIT("-firrefutable-everything")
277 opt_IrrefutableTuples = lookUp SLIT("-firrefutable-tuples")
278 opt_WarnNameShadowing = lookUp SLIT("-fwarn-name-shadowing")
279 opt_NumbersStrict = lookUp SLIT("-fnumbers-strict")
280 opt_OmitBlackHoling = lookUp SLIT("-dno-black-holing")
281 opt_OmitDefaultInstanceMethods = lookUp SLIT("-fomit-default-instance-methods")
282 opt_OmitInterfacePragmas = lookUp SLIT("-fomit-interface-pragmas")
283 opt_PprStyle_All = lookUp SLIT("-dppr-all")
284 opt_PprStyle_Debug = lookUp SLIT("-dppr-debug")
285 opt_PprStyle_User = lookUp SLIT("-dppr-user")
286 opt_ReportWhyUnfoldingsDisallowed= lookUp SLIT("-freport-disallowed-unfoldings")
287 opt_SccProfilingOn = lookUp SLIT("-fscc-profiling")
288 opt_ShowImportSpecs = lookUp SLIT("-fshow-import-specs")
289 opt_ShowPragmaNameErrs = lookUp SLIT("-fshow-pragma-name-errs")
290 opt_SigsRequired = lookUp SLIT("-fsignatures-required")
291 opt_SpecialiseAll = lookUp SLIT("-fspecialise-all")
292 opt_SpecialiseImports = lookUp SLIT("-fspecialise-imports")
293 opt_SpecialiseOverloaded = lookUp SLIT("-fspecialise-overloaded")
294 opt_SpecialiseTrace = lookUp SLIT("-ftrace-specialisation")
295 opt_SpecialiseUnboxed = lookUp SLIT("-fspecialise-unboxed")
296 opt_StgDoLetNoEscapes = lookUp SLIT("-flet-no-escape")
297 opt_Verbose = lookUp SLIT("-v")
298 opt_UsingGhcInternals = lookUp SLIT("-fusing-ghc-internals")
299 opt_CompilingGhcInternals = maybeToBool maybe_CompilingGhcInternals
300 maybe_CompilingGhcInternals = lookup_str "-fcompiling-ghc-internals="
301 opt_SccGroup = lookup_str "-G="
302 opt_ProduceC = lookup_str "-C="
303 opt_ProduceS = lookup_str "-S="
304 opt_ProduceHi = lookup_str "-hifile=" -- the one to produce this time
305 opt_HiMap = lookup_str "-himap=" -- file saying where to look for .hi files
306 opt_EnsureSplittableC = lookup_str "-fglobalise-toplev-names="
307 opt_UnfoldingUseThreshold = lookup_int "-funfolding-use-threshold"
308 opt_UnfoldingCreationThreshold = lookup_int "-funfolding-creation-threshold"
309 opt_UnfoldingOverrideThreshold = lookup_int "-funfolding-override-threshold"
310 opt_ReturnInRegsThreshold = lookup_int "-freturn-in-regs-threshold"
312 opt_NoImplicitPrelude = lookUp SLIT("-fno-implicit-prelude")
313 opt_IgnoreIfacePragmas = lookUp SLIT("-fignore-interface-pragmas")
317 classifyOpts :: ([CoreToDo], -- Core-to-Core processing spec
318 [StgToDo]) -- STG-to-STG processing spec
320 classifyOpts = sep argv [] [] -- accumulators...
322 sep :: [FAST_STRING] -- cmd-line opts (input)
323 -> [CoreToDo] -> [StgToDo] -- to_do accumulators
324 -> ([CoreToDo], [StgToDo]) -- result
326 sep [] core_td stg_td -- all done!
327 = (reverse core_td, reverse stg_td)
329 # define CORE_TD(to_do) sep opts (to_do:core_td) stg_td
330 # define STG_TD(to_do) sep opts core_td (to_do:stg_td)
331 # define IGNORE_ARG() sep opts core_td stg_td
333 sep (opt1:opts) core_td stg_td
335 case (_UNPK_ opt1) of -- the non-"just match a string" options are at the end...
337 ',' : _ -> IGNORE_ARG() -- it is for the parser
339 "-fsimplify" -> -- gather up SimplifierSwitches specially...
340 simpl_sep opts [] core_td stg_td
342 "-fcalc-inlinings1"-> CORE_TD(CoreDoCalcInlinings1)
343 "-fcalc-inlinings2"-> CORE_TD(CoreDoCalcInlinings2)
344 "-ffloat-inwards" -> CORE_TD(CoreDoFloatInwards)
345 "-ffull-laziness" -> CORE_TD(CoreDoFullLaziness)
346 "-fliberate-case" -> CORE_TD(CoreLiberateCase)
347 "-fprint-core" -> CORE_TD(CoreDoPrintCore)
348 "-fstatic-args" -> CORE_TD(CoreDoStaticArgs)
349 "-fstrictness" -> CORE_TD(CoreDoStrictness)
350 "-fspecialise" -> CORE_TD(CoreDoSpecialising)
351 "-fdeforest" -> CORE_TD(CoreDoDeforest)
352 "-ffoldr-build-worker-wrapper" -> CORE_TD(CoreDoFoldrBuildWorkerWrapper)
353 "-ffoldr-build-ww-anal" -> CORE_TD(CoreDoFoldrBuildWWAnal)
355 "-fstg-static-args" -> STG_TD(StgDoStaticArgs)
356 "-fupdate-analysis" -> STG_TD(StgDoUpdateAnalysis)
357 "-dstg-stats" -> STG_TD(D_stg_stats)
358 "-flambda-lift" -> STG_TD(StgDoLambdaLift)
359 "-fmassage-stg-for-profiling" -> STG_TD(StgDoMassageForProfiling)
361 _ -> -- NB: the driver is really supposed to handle bad options
366 simpl_sep :: [FAST_STRING] -- cmd-line opts (input)
367 -> [SimplifierSwitch] -- simplifier-switch accumulator
368 -> [CoreToDo] -> [StgToDo] -- to_do accumulators
369 -> ([CoreToDo], [StgToDo]) -- result
371 -- "simpl_sep" tailcalls "sep" once it's seen one set
372 -- of SimplifierSwitches for a CoreDoSimplify.
375 simpl_sep input@[] simpl_sw core_td stg_td
376 = panic "simpl_sep []"
379 -- The SimplifierSwitches should be delimited by "(" and ")".
381 simpl_sep (opt1:opts) simpl_sw core_td stg_td
382 = case (_UNPK_ opt1) of
383 "(" -> ASSERT (null simpl_sw)
384 simpl_sep opts [] core_td stg_td
386 this_simpl = CoreDoSimplify (isAmongSimpl simpl_sw)
388 sep opts (this_simpl : core_td) stg_td
390 # define SIMPL_SW(sw) simpl_sep opts (sw:simpl_sw) core_td stg_td
392 -- the non-"just match a string" options are at the end...
393 "-fshow-simplifier-progress" -> SIMPL_SW(ShowSimplifierProgress)
394 "-fcode-duplication-ok" -> SIMPL_SW(SimplOkToDupCode)
395 "-ffloat-lets-exposing-whnf" -> SIMPL_SW(SimplFloatLetsExposingWHNF)
396 "-ffloat-primops-ok" -> SIMPL_SW(SimplOkToFloatPrimOps)
397 "-falways-float-lets-from-lets" -> SIMPL_SW(SimplAlwaysFloatLetsFromLets)
398 "-fdo-case-elim" -> SIMPL_SW(SimplDoCaseElim)
399 "-fdo-eta-reduction" -> SIMPL_SW(SimplDoEtaReduction)
400 "-fdo-lambda-eta-expansion" -> SIMPL_SW(SimplDoLambdaEtaExpansion)
401 "-fdo-foldr-build" -> SIMPL_SW(SimplDoFoldrBuild)
402 "-fdo-not-fold-back-append" -> SIMPL_SW(SimplDontFoldBackAppend)
403 "-fdo-arity-expand" -> SIMPL_SW(SimplDoArityExpand)
404 "-fdo-inline-foldr-build" -> SIMPL_SW(SimplDoInlineFoldrBuild)
405 "-freuse-con" -> SIMPL_SW(SimplReuseCon)
406 "-fcase-of-case" -> SIMPL_SW(SimplCaseOfCase)
407 "-flet-to-case" -> SIMPL_SW(SimplLetToCase)
408 "-fpedantic-bottoms" -> SIMPL_SW(SimplPedanticBottoms)
409 "-fkeep-spec-pragma-ids" -> SIMPL_SW(KeepSpecPragmaIds)
410 "-fkeep-unused-bindings" -> SIMPL_SW(KeepUnusedBindings)
411 "-fmay-delete-conjurable-ids" -> SIMPL_SW(SimplMayDeleteConjurableIds)
412 "-fessential-unfoldings-only" -> SIMPL_SW(EssentialUnfoldingsOnly)
413 "-fignore-inline-pragma" -> SIMPL_SW(IgnoreINLINEPragma)
414 "-fno-let-from-case" -> SIMPL_SW(SimplNoLetFromCase)
415 "-fno-let-from-app" -> SIMPL_SW(SimplNoLetFromApp)
416 "-fno-let-from-strict-let" -> SIMPL_SW(SimplNoLetFromStrictLet)
418 o | starts_with_msi -> SIMPL_SW(MaxSimplifierIterations (read after_msi))
419 | starts_with_suut -> SIMPL_SW(SimplUnfoldingUseThreshold (read after_suut))
420 | starts_with_suct -> SIMPL_SW(SimplUnfoldingCreationThreshold (read after_suct))
422 maybe_suut = startsWith "-fsimpl-uf-use-threshold" o
423 maybe_suct = startsWith "-fsimpl-uf-creation-threshold" o
424 maybe_msi = startsWith "-fmax-simplifier-iterations" o
425 starts_with_suut = maybeToBool maybe_suut
426 starts_with_suct = maybeToBool maybe_suct
427 starts_with_msi = maybeToBool maybe_msi
428 (Just after_suut) = maybe_suut
429 (Just after_suct) = maybe_suct
430 (Just after_msi) = maybe_msi
432 _ -> -- NB: the driver is really supposed to handle bad options
433 simpl_sep opts simpl_sw core_td stg_td
436 %************************************************************************
438 \subsection{Switch ordering}
440 %************************************************************************
442 In spite of the @Produce*@ and @SccGroup@ constructors, these things
443 behave just like enumeration types.
446 instance Eq SimplifierSwitch where
447 a == b = tagOf_SimplSwitch a _EQ_ tagOf_SimplSwitch b
449 instance Ord SimplifierSwitch where
450 a < b = tagOf_SimplSwitch a _LT_ tagOf_SimplSwitch b
451 a <= b = tagOf_SimplSwitch a _LE_ tagOf_SimplSwitch b
453 tagOf_SimplSwitch SimplOkToDupCode =(ILIT(0) :: FAST_INT)
454 tagOf_SimplSwitch SimplFloatLetsExposingWHNF = ILIT(1)
455 tagOf_SimplSwitch SimplOkToFloatPrimOps = ILIT(2)
456 tagOf_SimplSwitch SimplAlwaysFloatLetsFromLets = ILIT(3)
457 tagOf_SimplSwitch SimplDoCaseElim = ILIT(4)
458 tagOf_SimplSwitch SimplReuseCon = ILIT(5)
459 tagOf_SimplSwitch SimplCaseOfCase = ILIT(6)
460 tagOf_SimplSwitch SimplLetToCase = ILIT(7)
461 tagOf_SimplSwitch SimplMayDeleteConjurableIds = ILIT(9)
462 tagOf_SimplSwitch SimplPedanticBottoms = ILIT(10)
463 tagOf_SimplSwitch SimplDoArityExpand = ILIT(11)
464 tagOf_SimplSwitch SimplDoFoldrBuild = ILIT(12)
465 tagOf_SimplSwitch SimplDoInlineFoldrBuild = ILIT(14)
466 tagOf_SimplSwitch IgnoreINLINEPragma = ILIT(15)
467 tagOf_SimplSwitch SimplDoLambdaEtaExpansion = ILIT(16)
468 tagOf_SimplSwitch SimplDoEtaReduction = ILIT(18)
469 tagOf_SimplSwitch EssentialUnfoldingsOnly = ILIT(19)
470 tagOf_SimplSwitch ShowSimplifierProgress = ILIT(20)
471 tagOf_SimplSwitch (MaxSimplifierIterations _) = ILIT(21)
472 tagOf_SimplSwitch (SimplUnfoldingUseThreshold _) = ILIT(22)
473 tagOf_SimplSwitch (SimplUnfoldingCreationThreshold _) = ILIT(23)
474 tagOf_SimplSwitch KeepSpecPragmaIds = ILIT(24)
475 tagOf_SimplSwitch KeepUnusedBindings = ILIT(25)
476 tagOf_SimplSwitch SimplNoLetFromCase = ILIT(26)
477 tagOf_SimplSwitch SimplNoLetFromApp = ILIT(27)
478 tagOf_SimplSwitch SimplNoLetFromStrictLet = ILIT(28)
479 tagOf_SimplSwitch SimplDontFoldBackAppend = ILIT(29)
480 -- If you add anything here, be sure to change lAST_SIMPL_SWITCH_TAG, too!
482 tagOf_SimplSwitch _ = panic# "tagOf_SimplSwitch"
484 lAST_SIMPL_SWITCH_TAG = IBOX(tagOf_SimplSwitch SimplDontFoldBackAppend)
487 %************************************************************************
489 \subsection{Switch lookup}
491 %************************************************************************
494 #if __GLASGOW_HASKELL__ >= 200
496 # define LIFT GHCbase.Lift
500 # define ARRAY _Array
505 isAmongSimpl :: [SimplifierSwitch] -> SimplifierSwitch -> SwitchResult
507 isAmongSimpl on_switches
509 tidied_on_switches = foldl rm_dups [] on_switches
511 sw_tbl :: Array Int SwitchResult
513 sw_tbl = (array (0, lAST_SIMPL_SWITCH_TAG) -- bounds...
517 all_undefined = [ i SET_TO SwBool False | i <- [0 .. lAST_SIMPL_SWITCH_TAG ] ]
519 defined_elems = map mk_assoc_elem tidied_on_switches
521 -- (avoid some unboxing, bounds checking, and other horrible things:)
522 case sw_tbl of { ARRAY bounds_who_needs_'em stuff ->
524 case (indexArray# stuff (tagOf_SimplSwitch switch)) of
528 mk_assoc_elem k@(MaxSimplifierIterations lvl) = IBOX(tagOf_SimplSwitch k) SET_TO SwInt lvl
529 mk_assoc_elem k@(SimplUnfoldingUseThreshold i) = IBOX(tagOf_SimplSwitch k) SET_TO SwInt i
530 mk_assoc_elem k@(SimplUnfoldingCreationThreshold i) = IBOX(tagOf_SimplSwitch k) SET_TO SwInt i
532 mk_assoc_elem k = IBOX(tagOf_SimplSwitch k) SET_TO SwBool True -- I'm here, Mom!
534 -- cannot have duplicates if we are going to use the array thing
536 rm_dups switches_so_far switch
537 = if switch `is_elem` switches_so_far
539 else switch : switches_so_far
541 sw `is_elem` [] = False
542 sw `is_elem` (s:ss) = (tagOf_SimplSwitch sw) _EQ_ (tagOf_SimplSwitch s)
546 %************************************************************************
548 \subsection{Misc functions for command-line options}
550 %************************************************************************
554 switchIsOn :: (switch -> SwitchResult) -> switch -> Bool
556 switchIsOn lookup_fn switch
557 = case (lookup_fn switch) of
558 SwBool False -> False
561 stringSwitchSet :: (switch -> SwitchResult)
562 -> (FAST_STRING -> switch)
565 stringSwitchSet lookup_fn switch
566 = case (lookup_fn (switch (panic "stringSwitchSet"))) of
567 SwString str -> Just str
570 intSwitchSet :: (switch -> SwitchResult)
574 intSwitchSet lookup_fn switch
575 = case (lookup_fn (switch (panic "intSwitchSet"))) of
576 SwInt int -> Just int