[project @ 1997-09-24 09:08:21 by simonm]
[ghc-hetmet.git] / ghc / compiler / main / CmdLineOpts.lhs
1 %
2 % (c) The AQUA Project, Glasgow University, 1996
3 %
4 \section[CmdLineOpts]{Things to do with command-line options}
5
6 \begin{code}
7 #include "HsVersions.h"
8
9 module CmdLineOpts (
10         CoreToDo(..),
11         SimplifierSwitch(..),
12         StgToDo(..),
13         SwitchResult(..),
14         classifyOpts,
15
16         intSwitchSet,
17         switchIsOn,
18
19         maybe_CompilingGhcInternals,
20         opt_AllDemanded,
21         opt_AllStrict,
22         opt_AutoSccsOnAllToplevs,
23         opt_AutoSccsOnExportedToplevs,
24         opt_AutoSccsOnIndividualCafs,
25         opt_CompilingGhcInternals,
26         opt_D_dump_absC,
27         opt_D_dump_asm,
28         opt_D_dump_deriv,
29         opt_D_dump_ds,
30         opt_D_dump_flatC,
31         opt_D_dump_occur_anal,
32         opt_D_dump_rdr,
33         opt_D_dump_realC,
34         opt_D_dump_rn,
35         opt_D_dump_simpl,
36         opt_D_dump_simpl_iterations,
37         opt_D_dump_spec,
38         opt_D_dump_stg,
39         opt_D_dump_stranal,
40         opt_D_dump_tc,
41         opt_D_show_passes,
42         opt_D_show_rn_trace,
43         opt_D_simplifier_stats,
44         opt_D_source_stats,
45         opt_D_verbose_core2core,
46         opt_D_verbose_stg2stg,
47         opt_DoCoreLinting,
48         opt_DoStgLinting,
49         opt_DoSemiTagging,
50         opt_DoEtaReduction,
51         opt_DoTickyProfiling,
52         opt_EnsureSplittableC,
53         opt_FoldrBuildOn,
54         opt_FoldrBuildTrace,
55         opt_ForConcurrent,
56         opt_GlasgowExts,
57         opt_GranMacros,
58         opt_HiMap,
59         opt_IgnoreIfacePragmas,
60         opt_IgnoreStrictnessPragmas,
61         opt_IrrefutableEverything,
62         opt_IrrefutableTuples,
63         opt_LiberateCaseThreshold,
64         opt_NoImplicitPrelude,
65         opt_NumbersStrict,
66         opt_OmitBlackHoling,
67         opt_OmitDefaultInstanceMethods,
68         opt_OmitInterfacePragmas,
69         opt_PprStyle_All,
70         opt_PprStyle_Debug,
71         opt_PprStyle_User,              -- ToDo: rm
72         opt_PprUserLength,
73         opt_ProduceC,
74         opt_ProduceHi,
75         opt_ProduceS,
76         opt_ReportWhyUnfoldingsDisallowed,
77         opt_ReturnInRegsThreshold,
78         opt_SccGroup,
79         opt_SccProfilingOn,
80         opt_ShowImportSpecs,
81         opt_ShowPragmaNameErrs,
82         opt_SigsRequired,
83         opt_SourceUnchanged,
84         opt_SpecialiseAll,
85         opt_SpecialiseImports,
86         opt_SpecialiseOverloaded,
87         opt_SpecialiseTrace,
88         opt_SpecialiseUnboxed,
89         opt_StgDoLetNoEscapes,
90
91         opt_InterfaceUnfoldThreshold,
92         opt_UnfoldingCreationThreshold,
93         opt_UnfoldingConDiscount,
94         opt_UnfoldingUseThreshold,
95
96         opt_Verbose,
97         opt_WarnNameShadowing,
98         opt_WarnUnusedNames,
99         opt_WarnIncompletePatterns, opt_WarnOverlappedPatterns,
100         opt_PruneTyDecls, opt_PruneInstDecls,
101         opt_D_show_unused_imports,
102         opt_D_show_rn_stats,
103         
104         all_toplev_ids_visible
105     ) where
106
107 IMPORT_1_3(Array(array, (//)))
108 #if defined(__GLASGOW_HASKELL__) && __GLASGOW_HASKELL__ <= 201
109 import PreludeGlaST     -- bad bad bad boy, Will (_Array internals)
110 #else
111 import GlaExts
112 import ArrBase
113 -- 2.04 and later exports Lift from GlaExts
114 #if __GLASGOW_HASKELL__ < 204
115 import PrelBase (Lift(..))
116 #endif
117 #endif
118
119 CHK_Ubiq() -- debugging consistency check
120
121 import Argv
122 import Constants        -- Default values for some flags
123 import Maybes           ( assocMaybe, firstJust, maybeToBool )
124 import Util             ( startsWith, panic, panic#, assertPanic )
125 \end{code}
126
127 A command-line {\em switch} is (generally) either on or off; e.g., the
128 ``verbose'' (-v) switch is either on or off.  (The \tr{-G<group>}
129 switch is an exception; it's set to a string, or nothing.)
130
131 A list of {\em ToDo}s is things to be done in a particular part of
132 processing.  A (fictitious) example for the Core-to-Core simplifier
133 might be: run the simplifier, then run the strictness analyser, then
134 run the simplifier again (three ``todos'').
135
136 There are three ``to-do processing centers'' at the moment.  In the
137 main loop (\tr{main/Main.lhs}), in the Core-to-Core processing loop
138 (\tr{simplCore/SimplCore.lhs), and in the STG-to-STG processing loop
139 (\tr{simplStg/SimplStg.lhs}).
140
141 %************************************************************************
142 %*                                                                      *
143 \subsection{Datatypes associated with command-line options}
144 %*                                                                      *
145 %************************************************************************
146
147 \begin{code}
148 data SwitchResult
149   = SwBool      Bool            -- on/off
150   | SwString    FAST_STRING     -- nothing or a String
151   | SwInt       Int             -- nothing or an Int
152 \end{code}
153
154 \begin{code}
155 data CoreToDo           -- These are diff core-to-core passes,
156                         -- which may be invoked in any order,
157                         -- as many times as you like.
158
159   = CoreDoSimplify      -- The core-to-core simplifier.
160         (SimplifierSwitch -> SwitchResult)
161                         -- Each run of the simplifier can take a different
162                         -- set of simplifier-specific flags.
163   | CoreDoCalcInlinings1
164   | CoreDoCalcInlinings2
165   | CoreDoFloatInwards
166   | CoreDoFullLaziness
167   | CoreLiberateCase
168   | CoreDoPrintCore
169   | CoreDoStaticArgs
170   | CoreDoStrictness
171   | CoreDoSpecialising
172   | CoreDoFoldrBuildWorkerWrapper
173   | CoreDoFoldrBuildWWAnal
174 \end{code}
175
176 \begin{code}
177 data StgToDo
178   = StgDoStaticArgs
179   | StgDoUpdateAnalysis
180   | StgDoLambdaLift
181   | StgDoMassageForProfiling  -- should be (next to) last
182   -- There's also setStgVarInfo, but its absolute "lastness"
183   -- is so critical that it is hardwired in (no flag).
184   | D_stg_stats
185 \end{code}
186
187 \begin{code}
188 data SimplifierSwitch
189   = SimplOkToDupCode
190   | SimplFloatLetsExposingWHNF
191   | SimplOkToFloatPrimOps
192   | SimplAlwaysFloatLetsFromLets
193   | SimplDoCaseElim
194   | SimplReuseCon
195   | SimplCaseOfCase
196   | SimplLetToCase
197   | SimplMayDeleteConjurableIds
198   | SimplPedanticBottoms -- see Simplifier for an explanation
199   | SimplDoArityExpand   -- expand arity of bindings
200   | SimplDoFoldrBuild    -- This is the per-simplification flag;
201                          -- see also FoldrBuildOn, used elsewhere
202                          -- in the compiler.
203   | SimplDoInlineFoldrBuild
204                          -- inline foldr/build (*after* f/b rule is used)
205
206   | IgnoreINLINEPragma
207   | SimplDoLambdaEtaExpansion
208
209   | EssentialUnfoldingsOnly -- never mind the thresholds, only
210                             -- do unfoldings that *must* be done
211                             -- (to saturate constructors and primitives)
212
213   | ShowSimplifierProgress  -- report counts on every interation
214
215   | MaxSimplifierIterations Int
216
217   | KeepSpecPragmaIds       -- We normally *toss* Ids we can do without
218   | KeepUnusedBindings
219
220   | SimplNoLetFromCase      -- used when turning off floating entirely
221   | SimplNoLetFromApp       -- (for experimentation only) WDP 95/10
222   | SimplNoLetFromStrictLet
223
224   | SimplDontFoldBackAppend
225                         -- we fold `foldr (:)' back into flip (++),
226                         -- but we *don't* want to do it when compiling
227                         -- List.hs, otherwise
228                         -- xs ++ ys = foldr (:) ys xs
229                         -- {- via our loopback -}
230                         -- xs ++ ys = xs ++ ys
231                         -- Oops!
232                         -- So only use this flag inside List.hs
233                         -- (Sigh, what a HACK, Andy.  WDP 96/01)
234
235   | SimplCaseMerge
236   | SimplCaseScrutinee  -- This flag tells that the expression being simplified is
237                         -- the scrutinee of a case expression, so we should
238                         -- apply the scrutinee discount when considering inlinings.
239                         -- See SimplVar.lhs
240 \end{code}
241
242 %************************************************************************
243 %*                                                                      *
244 \subsection{Classifying command-line options}
245 %*                                                                      *
246 %************************************************************************
247
248 \begin{code}
249 lookUp         :: FAST_STRING -> Bool
250 lookup_int     :: String -> Maybe Int
251 lookup_def_int :: String -> Int -> Int
252 lookup_str     :: String -> Maybe String
253
254 lookUp     sw = maybeToBool (assoc_opts sw)
255         
256 lookup_str sw = firstJust (map (startsWith sw) unpacked_opts)
257
258 lookup_int sw = case (lookup_str sw) of
259                   Nothing -> Nothing
260                   Just xx -> Just (read xx)
261
262 lookup_def_int sw def = case (lookup_str sw) of
263                             Nothing -> def              -- Use default
264                             Just xx -> read xx
265
266 assoc_opts    = assocMaybe [ (a, True) | a <- argv ]
267 unpacked_opts = map _UNPK_ argv
268 \end{code}
269
270 \begin{code}
271 opt_AllDemanded                 = lookUp  SLIT("-fall-demanded")
272 opt_AllStrict                   = lookUp  SLIT("-fall-strict")
273 opt_AutoSccsOnAllToplevs        = lookUp  SLIT("-fauto-sccs-on-all-toplevs")
274 opt_AutoSccsOnExportedToplevs   = lookUp  SLIT("-fauto-sccs-on-exported-toplevs")
275 opt_AutoSccsOnIndividualCafs    = lookUp  SLIT("-fauto-sccs-on-individual-cafs")
276 opt_CompilingGhcInternals       = maybeToBool maybe_CompilingGhcInternals
277 maybe_CompilingGhcInternals     = lookup_str "-fcompiling-ghc-internals="
278 opt_D_dump_absC                 = lookUp  SLIT("-ddump-absC")
279 opt_D_dump_asm                  = lookUp  SLIT("-ddump-asm")
280 opt_D_dump_deriv                = lookUp  SLIT("-ddump-deriv")
281 opt_D_dump_ds                   = lookUp  SLIT("-ddump-ds")
282 opt_D_dump_flatC                = lookUp  SLIT("-ddump-flatC")
283 opt_D_dump_occur_anal           = lookUp  SLIT("-ddump-occur-anal")
284 opt_D_dump_rdr                  = lookUp  SLIT("-ddump-rdr")
285 opt_D_dump_realC                = lookUp  SLIT("-ddump-realC")
286 opt_D_dump_rn                   = lookUp  SLIT("-ddump-rn")
287 opt_D_dump_simpl                = lookUp  SLIT("-ddump-simpl")
288 opt_D_dump_simpl_iterations     = lookUp  SLIT("-ddump-simpl-iterations")
289 opt_D_dump_spec                 = lookUp  SLIT("-ddump-spec")
290 opt_D_dump_stg                  = lookUp  SLIT("-ddump-stg")
291 opt_D_dump_stranal              = lookUp  SLIT("-ddump-stranal")
292 opt_D_dump_tc                   = lookUp  SLIT("-ddump-tc")
293 opt_D_show_passes               = lookUp  SLIT("-dshow-passes")
294 opt_D_show_rn_trace             = lookUp  SLIT("-dshow-rn-trace")
295 opt_D_simplifier_stats          = lookUp  SLIT("-dsimplifier-stats")
296 opt_D_source_stats              = lookUp  SLIT("-dsource-stats")
297 opt_D_verbose_core2core         = lookUp  SLIT("-dverbose-simpl")
298 opt_D_verbose_stg2stg           = lookUp  SLIT("-dverbose-stg")
299 opt_DoCoreLinting               = lookUp  SLIT("-dcore-lint")
300 opt_DoStgLinting                = lookUp  SLIT("-dstg-lint")
301 opt_DoSemiTagging               = lookUp  SLIT("-fsemi-tagging")
302 opt_DoTickyProfiling            = lookUp  SLIT("-fticky-ticky")
303 opt_DoEtaReduction              = lookUp  SLIT("-fdo-eta-reduction")
304 opt_EnsureSplittableC           = lookUp  SLIT("-fglobalise-toplev-names")
305 opt_FoldrBuildOn                = lookUp  SLIT("-ffoldr-build-on")
306 opt_FoldrBuildTrace             = lookUp  SLIT("-ffoldr-build-trace")
307 opt_ForConcurrent               = lookUp  SLIT("-fconcurrent")
308 opt_GranMacros                  = lookUp  SLIT("-fgransim")
309 opt_GlasgowExts                 = lookUp  SLIT("-fglasgow-exts")
310 --UNUSED:opt_Haskell_1_3        = lookUp  SLIT("-fhaskell-1.3")
311 opt_HiMap                       = lookup_str "-himap="  -- file saying where to look for .hi files
312 opt_IgnoreIfacePragmas          = lookUp  SLIT("-fignore-interface-pragmas")
313 opt_IgnoreStrictnessPragmas     = lookUp  SLIT("-fignore-strictness-pragmas")
314 opt_IrrefutableEverything       = lookUp  SLIT("-firrefutable-everything")
315 opt_IrrefutableTuples           = lookUp  SLIT("-firrefutable-tuples")
316 opt_NoImplicitPrelude           = lookUp  SLIT("-fno-implicit-prelude")
317 opt_NumbersStrict               = lookUp  SLIT("-fnumbers-strict")
318 opt_OmitBlackHoling             = lookUp  SLIT("-dno-black-holing")
319 opt_OmitDefaultInstanceMethods  = lookUp  SLIT("-fomit-default-instance-methods")
320 opt_OmitInterfacePragmas        = lookUp  SLIT("-fomit-interface-pragmas")
321 opt_PprStyle_All                = lookUp  SLIT("-dppr-all")
322 opt_PprStyle_Debug              = lookUp  SLIT("-dppr-debug")
323 opt_PprStyle_User               = lookUp  SLIT("-dppr-user")
324 opt_PprUserLength               = lookup_def_int "-dppr-user-length" 5 --ToDo: give this a name
325 opt_ProduceC                    = lookup_str "-C="
326 opt_ProduceS                    = lookup_str "-S="
327 opt_ProduceHi                   = lookup_str "-hifile=" -- the one to produce this time 
328 opt_ReportWhyUnfoldingsDisallowed= lookUp SLIT("-freport-disallowed-unfoldings")
329 opt_SccProfilingOn              = lookUp  SLIT("-fscc-profiling")
330 opt_ShowImportSpecs             = lookUp  SLIT("-fshow-import-specs")
331 opt_ShowPragmaNameErrs          = lookUp  SLIT("-fshow-pragma-name-errs")
332 opt_SigsRequired                = lookUp  SLIT("-fsignatures-required")
333 opt_SourceUnchanged             = lookUp  SLIT("-fsource-unchanged")
334 opt_SpecialiseAll               = lookUp  SLIT("-fspecialise-all")
335 opt_SpecialiseImports           = lookUp  SLIT("-fspecialise-imports")
336 opt_SpecialiseOverloaded        = lookUp  SLIT("-fspecialise-overloaded")
337 opt_SpecialiseTrace             = lookUp  SLIT("-ftrace-specialisation")
338 opt_SpecialiseUnboxed           = lookUp  SLIT("-fspecialise-unboxed")
339 opt_StgDoLetNoEscapes           = lookUp  SLIT("-flet-no-escape")
340 opt_ReturnInRegsThreshold       = lookup_int "-freturn-in-regs-threshold"
341 opt_SccGroup                    = lookup_str "-G="
342 opt_Verbose                     = lookUp  SLIT("-v")
343
344 opt_InterfaceUnfoldThreshold    = lookup_def_int "-funfolding-interface-threshold" iNTERFACE_UNFOLD_THRESHOLD
345 opt_UnfoldingCreationThreshold  = lookup_def_int "-funfolding-creation-threshold"  uNFOLDING_CREATION_THRESHOLD
346 opt_UnfoldingUseThreshold       = lookup_def_int "-funfolding-use-threshold"       uNFOLDING_USE_THRESHOLD
347 opt_UnfoldingConDiscount        = lookup_def_int "-funfolding-con-discount"        uNFOLDING_CON_DISCOUNT_WEIGHT
348                         
349 opt_LiberateCaseThreshold       = lookup_def_int "-fliberate-case-threshold"       lIBERATE_CASE_THRESHOLD
350 opt_WarnNameShadowing           = lookUp  SLIT("-fwarn-name-shadowing")
351 opt_WarnIncompletePatterns      = not (lookUp  SLIT("-fno-warn-incomplete-patterns"))
352 opt_WarnOverlappedPatterns      = not (lookUp  SLIT("-fno-warn-overlapped-patterns"))
353 opt_WarnUnusedNames             = lookUp  SLIT("-fwarn-unused-names")
354 opt_PruneTyDecls                = not (lookUp SLIT("-fno-prune-tydecls"))
355 opt_PruneInstDecls              = not (lookUp SLIT("-fno-prune-instdecls"))
356 opt_D_show_unused_imports       = lookUp SLIT("-dshow-unused-imports")
357 opt_D_show_rn_stats             = lookUp SLIT("-dshow-rn-stats")
358
359 -- opt_UnfoldingOverrideThreshold       = lookup_int "-funfolding-override-threshold"
360 \end{code}
361
362
363 \begin{code}
364 all_toplev_ids_visible :: Bool
365 all_toplev_ids_visible = 
366   not opt_OmitInterfacePragmas ||  -- Pragmas can make them visible
367   opt_EnsureSplittableC        ||  -- Splitting requires visiblilty
368   opt_AutoSccsOnAllToplevs         -- ditto for profiling 
369                                    -- (ToDo: fix up the auto-annotation
370                                    -- pass in the desugarer to avoid having
371                                    -- to do this)
372
373 \end{code}
374
375
376
377 \begin{code}
378 classifyOpts :: ([CoreToDo],    -- Core-to-Core processing spec
379                  [StgToDo])     -- STG-to-STG   processing spec
380
381 classifyOpts = sep argv [] [] -- accumulators...
382   where
383     sep :: [FAST_STRING]                         -- cmd-line opts (input)
384         -> [CoreToDo] -> [StgToDo]       -- to_do accumulators
385         -> ([CoreToDo], [StgToDo])       -- result
386
387     sep [] core_td stg_td -- all done!
388       = (reverse core_td, reverse stg_td)
389
390 #       define CORE_TD(to_do) sep opts (to_do:core_td) stg_td
391 #       define STG_TD(to_do)  sep opts core_td (to_do:stg_td)
392 #       define IGNORE_ARG()   sep opts core_td stg_td
393
394     sep (opt1:opts) core_td stg_td
395       =
396         case (_UNPK_ opt1) of -- the non-"just match a string" options are at the end...
397
398           ',' : _       -> IGNORE_ARG() -- it is for the parser
399
400           "-fsimplify"  -> -- gather up SimplifierSwitches specially...
401                            simpl_sep opts defaultSimplSwitches core_td stg_td
402
403           "-fcalc-inlinings1"-> CORE_TD(CoreDoCalcInlinings1)
404           "-fcalc-inlinings2"-> CORE_TD(CoreDoCalcInlinings2)
405           "-ffloat-inwards"  -> CORE_TD(CoreDoFloatInwards)
406           "-ffull-laziness"  -> CORE_TD(CoreDoFullLaziness)
407           "-fliberate-case"  -> CORE_TD(CoreLiberateCase)
408           "-fprint-core"     -> CORE_TD(CoreDoPrintCore)
409           "-fstatic-args"    -> CORE_TD(CoreDoStaticArgs)
410           "-fstrictness"     -> CORE_TD(CoreDoStrictness)
411           "-fspecialise"     -> CORE_TD(CoreDoSpecialising)
412           "-ffoldr-build-worker-wrapper"  -> CORE_TD(CoreDoFoldrBuildWorkerWrapper)
413           "-ffoldr-build-ww-anal"  -> CORE_TD(CoreDoFoldrBuildWWAnal)
414
415           "-fstg-static-args" -> STG_TD(StgDoStaticArgs)
416           "-fupdate-analysis" -> STG_TD(StgDoUpdateAnalysis)
417           "-dstg-stats"       -> STG_TD(D_stg_stats)
418           "-flambda-lift"     -> STG_TD(StgDoLambdaLift)
419           "-fmassage-stg-for-profiling" -> STG_TD(StgDoMassageForProfiling)
420
421           _ -> -- NB: the driver is really supposed to handle bad options
422                IGNORE_ARG()
423
424     ----------------
425
426     simpl_sep :: [FAST_STRING]      -- cmd-line opts (input)
427         -> [SimplifierSwitch]       -- simplifier-switch accumulator
428         -> [CoreToDo] -> [StgToDo]  -- to_do accumulators
429         -> ([CoreToDo], [StgToDo])  -- result
430
431         -- "simpl_sep" tailcalls "sep" once it's seen one set
432         -- of SimplifierSwitches for a CoreDoSimplify.
433
434 #ifdef DEBUG
435     simpl_sep input@[] simpl_sw core_td stg_td
436       = panic "simpl_sep []"
437 #endif
438
439         -- The SimplifierSwitches should be delimited by "[" and "]".
440
441     simpl_sep (opt1:opts) simpl_sw core_td stg_td
442       = case (_UNPK_ opt1) of
443           "[" -> simpl_sep opts simpl_sw core_td stg_td
444           "]" -> let
445                     this_simpl = CoreDoSimplify (isAmongSimpl simpl_sw)
446                  in
447                  sep opts (this_simpl : core_td) stg_td
448
449 #         define SIMPL_SW(sw) simpl_sep opts (sw:simpl_sw) core_td stg_td
450
451           -- the non-"just match a string" options are at the end...
452           "-fshow-simplifier-progress"      -> SIMPL_SW(ShowSimplifierProgress)
453           "-fcode-duplication-ok"           -> SIMPL_SW(SimplOkToDupCode)
454           "-ffloat-lets-exposing-whnf"      -> SIMPL_SW(SimplFloatLetsExposingWHNF)
455           "-ffloat-primops-ok"              -> SIMPL_SW(SimplOkToFloatPrimOps)
456           "-falways-float-lets-from-lets"   -> SIMPL_SW(SimplAlwaysFloatLetsFromLets)
457           "-fdo-case-elim"                  -> SIMPL_SW(SimplDoCaseElim)
458           "-fdo-lambda-eta-expansion"       -> SIMPL_SW(SimplDoLambdaEtaExpansion)
459           "-fdo-foldr-build"                -> SIMPL_SW(SimplDoFoldrBuild)
460           "-fdo-not-fold-back-append"       -> SIMPL_SW(SimplDontFoldBackAppend)
461           "-fdo-arity-expand"               -> SIMPL_SW(SimplDoArityExpand)
462           "-fdo-inline-foldr-build"         -> SIMPL_SW(SimplDoInlineFoldrBuild)
463           "-freuse-con"                     -> SIMPL_SW(SimplReuseCon)
464           "-fcase-of-case"                  -> SIMPL_SW(SimplCaseOfCase)
465           "-fcase-merge"                    -> SIMPL_SW(SimplCaseMerge)
466           "-flet-to-case"                   -> SIMPL_SW(SimplLetToCase)
467           "-fpedantic-bottoms"              -> SIMPL_SW(SimplPedanticBottoms)
468           "-fkeep-spec-pragma-ids"          -> SIMPL_SW(KeepSpecPragmaIds)
469           "-fkeep-unused-bindings"          -> SIMPL_SW(KeepUnusedBindings)
470           "-fmay-delete-conjurable-ids"     -> SIMPL_SW(SimplMayDeleteConjurableIds)
471           "-fessential-unfoldings-only"     -> SIMPL_SW(EssentialUnfoldingsOnly)
472           "-fignore-inline-pragma"          -> SIMPL_SW(IgnoreINLINEPragma)
473           "-fno-let-from-case"              -> SIMPL_SW(SimplNoLetFromCase)
474           "-fno-let-from-app"               -> SIMPL_SW(SimplNoLetFromApp)
475           "-fno-let-from-strict-let"        -> SIMPL_SW(SimplNoLetFromStrictLet)
476
477           o | starts_with_msi  -> SIMPL_SW(MaxSimplifierIterations (read after_msi))
478            where
479             maybe_msi           = startsWith "-fmax-simplifier-iterations"   o
480             starts_with_msi     = maybeToBool maybe_msi
481             (Just after_msi)    = maybe_msi
482
483           _ -> -- NB: the driver is really supposed to handle bad options
484                simpl_sep opts simpl_sw core_td stg_td
485 \end{code}
486
487 %************************************************************************
488 %*                                                                      *
489 \subsection{Switch ordering}
490 %*                                                                      *
491 %************************************************************************
492
493 In spite of the @Produce*@ and @SccGroup@ constructors, these things
494 behave just like enumeration types.
495
496 \begin{code}
497 instance Eq SimplifierSwitch where
498     a == b = tagOf_SimplSwitch a _EQ_ tagOf_SimplSwitch b
499
500 instance Ord SimplifierSwitch where
501     a <  b  = tagOf_SimplSwitch a _LT_ tagOf_SimplSwitch b
502     a <= b  = tagOf_SimplSwitch a _LE_ tagOf_SimplSwitch b
503
504 tagOf_SimplSwitch SimplOkToDupCode              =(ILIT(0) :: FAST_INT)
505 tagOf_SimplSwitch SimplFloatLetsExposingWHNF    = ILIT(1)
506 tagOf_SimplSwitch SimplOkToFloatPrimOps         = ILIT(2)
507 tagOf_SimplSwitch SimplAlwaysFloatLetsFromLets  = ILIT(3)
508 tagOf_SimplSwitch SimplDoCaseElim               = ILIT(4)
509 tagOf_SimplSwitch SimplReuseCon                 = ILIT(5)
510 tagOf_SimplSwitch SimplCaseOfCase               = ILIT(6)
511 tagOf_SimplSwitch SimplLetToCase                = ILIT(7)
512 tagOf_SimplSwitch SimplMayDeleteConjurableIds   = ILIT(9)
513 tagOf_SimplSwitch SimplPedanticBottoms          = ILIT(10)
514 tagOf_SimplSwitch SimplDoArityExpand            = ILIT(11)
515 tagOf_SimplSwitch SimplDoFoldrBuild             = ILIT(12)
516 tagOf_SimplSwitch SimplDoInlineFoldrBuild       = ILIT(14)
517 tagOf_SimplSwitch IgnoreINLINEPragma            = ILIT(15)
518 tagOf_SimplSwitch SimplDoLambdaEtaExpansion     = ILIT(16)
519 tagOf_SimplSwitch EssentialUnfoldingsOnly       = ILIT(19)
520 tagOf_SimplSwitch ShowSimplifierProgress        = ILIT(20)
521 tagOf_SimplSwitch (MaxSimplifierIterations _)   = ILIT(21)
522 tagOf_SimplSwitch KeepSpecPragmaIds             = ILIT(25)
523 tagOf_SimplSwitch KeepUnusedBindings            = ILIT(26)
524 tagOf_SimplSwitch SimplNoLetFromCase            = ILIT(27)
525 tagOf_SimplSwitch SimplNoLetFromApp             = ILIT(28)
526 tagOf_SimplSwitch SimplNoLetFromStrictLet       = ILIT(29)
527 tagOf_SimplSwitch SimplDontFoldBackAppend       = ILIT(30)
528 tagOf_SimplSwitch SimplCaseMerge                = ILIT(31)
529 tagOf_SimplSwitch SimplCaseScrutinee            = ILIT(32)
530
531 -- If you add anything here, be sure to change lAST_SIMPL_SWITCH_TAG, too!
532
533 tagOf_SimplSwitch _ = panic# "tagOf_SimplSwitch"
534
535 lAST_SIMPL_SWITCH_TAG = IBOX(tagOf_SimplSwitch SimplCaseScrutinee)
536 \end{code}
537
538 %************************************************************************
539 %*                                                                      *
540 \subsection{Switch lookup}
541 %*                                                                      *
542 %************************************************************************
543
544 \begin{code}
545 #if __GLASGOW_HASKELL__ == 201
546 # define ARRAY      Array
547 # define LIFT       GHCbase.Lift
548 # define SET_TO     =:
549 (=:) a b = (a,b)
550 #elif __GLASGOW_HASKELL__ >= 202
551 # define ARRAY      Array
552 # define LIFT       Lift
553 # define SET_TO     =:
554 (=:) a b = (a,b)
555 #else
556 # define ARRAY      _Array
557 # define LIFT       _Lift
558 # define SET_TO     :=
559 #endif
560
561 isAmongSimpl :: [SimplifierSwitch] -> SimplifierSwitch -> SwitchResult
562
563 isAmongSimpl on_switches                -- Switches mentioned later occur *earlier*
564                                         -- in the list; defaults right at the end.
565   = let
566         tidied_on_switches = foldl rm_dups [] on_switches
567                 -- The fold*l* ensures that we keep the latest switches;
568                 -- ie the ones that occur earliest in the list.
569
570         sw_tbl :: Array Int SwitchResult
571
572         sw_tbl = (array (0, lAST_SIMPL_SWITCH_TAG) -- bounds...
573                         all_undefined)
574                  // defined_elems
575
576         all_undefined = [ i SET_TO SwBool False | i <- [0 .. lAST_SIMPL_SWITCH_TAG ] ]
577
578         defined_elems = map mk_assoc_elem tidied_on_switches
579     in
580     -- (avoid some unboxing, bounds checking, and other horrible things:)
581     case sw_tbl of { ARRAY bounds_who_needs_'em stuff ->
582     \ switch ->
583         case (indexArray# stuff (tagOf_SimplSwitch switch)) of
584           LIFT v -> v
585     }
586   where
587     mk_assoc_elem k@(MaxSimplifierIterations lvl)       = IBOX(tagOf_SimplSwitch k) SET_TO SwInt lvl
588
589     mk_assoc_elem k = IBOX(tagOf_SimplSwitch k) SET_TO SwBool   True -- I'm here, Mom!
590
591     -- cannot have duplicates if we are going to use the array thing
592     rm_dups switches_so_far switch
593       = if switch `is_elem` switches_so_far
594         then switches_so_far
595         else switch : switches_so_far
596       where
597         sw `is_elem` []     = False
598         sw `is_elem` (s:ss) = (tagOf_SimplSwitch sw) _EQ_ (tagOf_SimplSwitch s)
599                             || sw `is_elem` ss
600 \end{code}
601
602 Default settings for simplifier switches
603
604 \begin{code}
605 defaultSimplSwitches = [MaxSimplifierIterations         1
606                        ]
607 \end{code}
608
609 %************************************************************************
610 %*                                                                      *
611 \subsection{Misc functions for command-line options}
612 %*                                                                      *
613 %************************************************************************
614
615
616 \begin{code}
617 switchIsOn :: (switch -> SwitchResult) -> switch -> Bool
618
619 switchIsOn lookup_fn switch
620   = case (lookup_fn switch) of
621       SwBool False -> False
622       _            -> True
623
624 stringSwitchSet :: (switch -> SwitchResult)
625                 -> (FAST_STRING -> switch)
626                 -> Maybe FAST_STRING
627
628 stringSwitchSet lookup_fn switch
629   = case (lookup_fn (switch (panic "stringSwitchSet"))) of
630       SwString str -> Just str
631       _            -> Nothing
632
633 intSwitchSet :: (switch -> SwitchResult)
634              -> (Int -> switch)
635              -> Maybe Int
636
637 intSwitchSet lookup_fn switch
638   = case (lookup_fn (switch (panic "intSwitchSet"))) of
639       SwInt int -> Just int
640       _         -> Nothing
641 \end{code}