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