2 % (c) The University of Glasgow, 1996-2000
4 \section[CmdLineOpts]{Things to do with command-line options}
10 SimplifierSwitch(..), isAmongSimpl,
14 DynFlag(..), -- needed non-abstractly by DriverFlags
29 -- other dynamic flags
36 opt_AutoSccsOnAllToplevs,
37 opt_AutoSccsOnExportedToplevs,
38 opt_AutoSccsOnIndividualCafs,
46 opt_MaxContextReductionDepth,
47 opt_IrrefutableTuples,
55 opt_LiberateCaseThreshold,
56 opt_StgDoLetNoEscapes,
59 opt_UnboxStrictFields,
60 opt_SimplNoPreInlining,
61 opt_SimplDoEtaReduction,
62 opt_SimplDoLambdaEtaExpansion,
65 opt_SimplPedanticBottoms,
66 opt_SimplExcessPrecision,
69 opt_UF_HiFileThreshold,
70 opt_UF_CreationThreshold,
72 opt_UF_FunAppDiscount,
81 opt_EnsureSplittableC,
86 opt_IgnoreIfacePragmas,
88 opt_NoImplicitPrelude,
90 opt_OmitInterfacePragmas,
98 #include "HsVersions.h"
100 import Array ( array, (//) )
102 import IOExts ( IORef, readIORef )
103 import Constants -- Default values for some flags
107 import Maybes ( firstJust )
108 import Panic ( panic )
110 #if __GLASGOW_HASKELL__ < 301
111 import ArrBase ( Array(..) )
113 import PrelArr ( Array(..) )
117 %************************************************************************
119 \subsection{Command-line options}
121 %************************************************************************
123 The hsc command-line options are split into two categories:
128 Static flags are represented by top-level values of type Bool or Int,
129 for example. They therefore have the same value throughout the
132 Dynamic flags are represented by an abstract type, DynFlags, which is
133 passed into hsc by the compilation manager for every compilation.
134 Dynamic flags are those that change on a per-compilation basis,
135 perhaps because they may be present in the OPTIONS pragma at the top
138 Other flag-related blurb:
140 A list of {\em ToDo}s is things to be done in a particular part of
141 processing. A (fictitious) example for the Core-to-Core simplifier
142 might be: run the simplifier, then run the strictness analyser, then
143 run the simplifier again (three ``todos'').
145 There are three ``to-do processing centers'' at the moment. In the
146 main loop (\tr{main/Main.lhs}), in the Core-to-Core processing loop
147 (\tr{simplCore/SimplCore.lhs), and in the STG-to-STG processing loop
148 (\tr{simplStg/SimplStg.lhs}).
150 %************************************************************************
152 \subsection{Datatypes associated with command-line options}
154 %************************************************************************
158 = SwBool Bool -- on/off
159 | SwString FAST_STRING -- nothing or a String
160 | SwInt Int -- nothing or an Int
164 data CoreToDo -- These are diff core-to-core passes,
165 -- which may be invoked in any order,
166 -- as many times as you like.
168 = CoreDoSimplify -- The core-to-core simplifier.
169 (SimplifierSwitch -> SwitchResult)
170 -- Each run of the simplifier can take a different
171 -- set of simplifier-specific flags.
173 | CoreDoFloatOutwards Bool -- True <=> float lambdas to top level
178 | CoreDoWorkerWrapper
185 | CoreDoNothing -- useful when building up lists of these things
192 | StgDoMassageForProfiling -- should be (next to) last
193 -- There's also setStgVarInfo, but its absolute "lastness"
194 -- is so critical that it is hardwired in (no flag).
199 data SimplifierSwitch
200 = MaxSimplifierIterations Int
201 | SimplInlinePhase Int
207 %************************************************************************
209 \subsection{Dynamic command-line options}
211 %************************************************************************
226 | Opt_D_dump_inlinings
227 | Opt_D_dump_occur_anal
232 | Opt_D_dump_simpl_iterations
241 | Opt_D_dump_worker_wrapper
243 | Opt_D_dump_rn_trace
244 | Opt_D_dump_rn_stats
246 | Opt_D_dump_simpl_stats
248 | Opt_D_verbose_core2core
249 | Opt_D_verbose_stg2stg
250 | Opt_D_dump_hi_diffs
251 | Opt_D_dump_minimal_imports
256 | Opt_WarnDuplicateExports
258 | Opt_WarnIncompletePatterns
259 | Opt_WarnMissingFields
260 | Opt_WarnMissingMethods
261 | Opt_WarnMissingSigs
262 | Opt_WarnNameShadowing
263 | Opt_WarnOverlappingPatterns
264 | Opt_WarnSimplePatterns
265 | Opt_WarnTypeDefaults
266 | Opt_WarnUnusedBinds
267 | Opt_WarnUnusedImports
268 | Opt_WarnUnusedMatches
269 | Opt_WarnDeprecations
272 | Opt_AllowOverlappingInstances
273 | Opt_AllowUndecidableInstances
281 data DynFlags = DynFlags {
282 coreToDo :: [CoreToDo],
283 stgToDo :: [StgToDo],
285 hscOutName :: String, -- name of the file in which to place output
289 dopt :: DynFlag -> DynFlags -> Bool
290 dopt f dflags = f `elem` (flags dflags)
292 dopt_CoreToDo :: DynFlags -> [CoreToDo]
293 dopt_CoreToDo = coreToDo
295 dopt_StgToDo :: DynFlags -> [StgToDo]
296 dopt_StgToDo = stgToDo
298 dopt_OutName :: DynFlags -> String
299 dopt_OutName = hscOutName
308 dopt_HscLang :: DynFlags -> HscLang
309 dopt_HscLang = hscLang
312 %************************************************************************
314 \subsection{Classifying command-line options}
316 %************************************************************************
319 -- v_Statis_hsc_opts is here to avoid a circular dependency with
321 GLOBAL_VAR(v_Static_hsc_opts, [], [String])
323 lookUp :: FAST_STRING -> Bool
324 lookup_int :: String -> Maybe Int
325 lookup_def_int :: String -> Int -> Int
326 lookup_def_float :: String -> Float -> Float
327 lookup_str :: String -> Maybe String
329 unpacked_static_opts = unsafePerformIO (readIORef v_Static_hsc_opts)
330 packed_static_opts = map _PK_ unpacked_static_opts
332 lookUp sw = sw `elem` packed_static_opts
334 lookup_str sw = firstJust (map (startsWith sw) unpacked_static_opts)
336 lookup_int sw = case (lookup_str sw) of
338 Just xx -> Just (read xx)
340 lookup_def_int sw def = case (lookup_str sw) of
341 Nothing -> def -- Use default
344 lookup_def_char sw def = case (lookup_str sw) of
346 _ -> def -- Use default
348 lookup_def_float sw def = case (lookup_str sw) of
349 Nothing -> def -- Use default
354 Putting the compiler options into temporary at-files
355 may turn out to be necessary later on if we turn hsc into
356 a pure Win32 application where I think there's a command-line
357 length limit of 255. unpacked_opts understands the @ option.
359 unpacked_opts :: [String]
363 map _UNPK_ argv -- NOT ARGV any more: v_Static_hsc_opts
365 expandAts ('@':fname) = words (unsafePerformIO (readFile fname))
370 %************************************************************************
372 \subsection{Static options}
374 %************************************************************************
378 opt_PprStyle_NoPrags = lookUp SLIT("-dppr-noprags")
379 opt_PprStyle_Debug = lookUp SLIT("-dppr-debug")
380 opt_PprUserLength = lookup_def_int "-dppr-user-length" 5 --ToDo: give this a name
383 opt_AutoSccsOnAllToplevs = lookUp SLIT("-fauto-sccs-on-all-toplevs")
384 opt_AutoSccsOnExportedToplevs = lookUp SLIT("-fauto-sccs-on-exported-toplevs")
385 opt_AutoSccsOnIndividualCafs = lookUp SLIT("-fauto-sccs-on-individual-cafs")
386 opt_AutoSccsOnDicts = lookUp SLIT("-fauto-sccs-on-dicts")
387 opt_SccProfilingOn = lookUp SLIT("-fscc-profiling")
388 opt_DoTickyProfiling = lookUp SLIT("-fticky-ticky")
391 opt_AllStrict = lookUp SLIT("-fall-strict")
392 opt_DictsStrict = lookUp SLIT("-fdicts-strict")
393 opt_IrrefutableTuples = lookUp SLIT("-firrefutable-tuples")
394 opt_MaxContextReductionDepth = lookup_def_int "-fcontext-stack" mAX_CONTEXT_REDUCTION_DEPTH
395 opt_NumbersStrict = lookUp SLIT("-fnumbers-strict")
396 opt_Parallel = lookUp SLIT("-fparallel")
397 opt_SMP = lookUp SLIT("-fsmp")
400 opt_DoSemiTagging = lookUp SLIT("-fsemi-tagging")
401 opt_FoldrBuildOn = lookUp SLIT("-ffoldr-build-on")
402 opt_LiberateCaseThreshold = lookup_def_int "-fliberate-case-threshold" (10::Int)
403 opt_StgDoLetNoEscapes = lookUp SLIT("-flet-no-escape")
404 opt_UnfoldCasms = lookUp SLIT("-funfold-casms-in-hi-file")
405 opt_UsageSPOn = lookUp SLIT("-fusagesp-on")
406 opt_UnboxStrictFields = lookUp SLIT("-funbox-strict-fields")
409 The optional '-inpackage=P' flag tells what package
410 we are compiling this module for.
411 The Prelude, for example is compiled with '-package prelude'
413 opt_InPackage = case lookup_str "-inpackage=" of
415 Nothing -> SLIT("Main") -- The package name if none is specified
417 opt_EmitCExternDecls = lookUp SLIT("-femit-extern-decls")
418 opt_EnsureSplittableC = lookUp SLIT("-fglobalise-toplev-names")
419 opt_GranMacros = lookUp SLIT("-fgransim")
420 opt_HiVersion = lookup_def_int "-fhi-version=" 0 -- what version we're compiling.
421 opt_HistorySize = lookup_def_int "-fhistory-size" 20
422 opt_IgnoreAsserts = lookUp SLIT("-fignore-asserts")
423 opt_IgnoreIfacePragmas = lookUp SLIT("-fignore-interface-pragmas")
424 opt_NoHiCheck = lookUp SLIT("-fno-hi-version-check")
425 opt_NoImplicitPrelude = lookUp SLIT("-fno-implicit-prelude")
426 opt_OmitBlackHoling = lookUp SLIT("-dno-black-holing")
427 opt_OmitInterfacePragmas = lookUp SLIT("-fomit-interface-pragmas")
429 -- Simplifier switches
430 opt_SimplNoPreInlining = lookUp SLIT("-fno-pre-inlining")
431 -- NoPreInlining is there just to see how bad things
432 -- get if you don't do it!
433 opt_SimplDoEtaReduction = lookUp SLIT("-fdo-eta-reduction")
434 opt_SimplDoLambdaEtaExpansion = lookUp SLIT("-fdo-lambda-eta-expansion")
435 opt_SimplCaseOfCase = lookUp SLIT("-fcase-of-case")
436 opt_SimplCaseMerge = lookUp SLIT("-fcase-merge")
437 opt_SimplPedanticBottoms = lookUp SLIT("-fpedantic-bottoms")
438 opt_SimplExcessPrecision = lookUp SLIT("-fexcess-precision")
441 opt_UF_HiFileThreshold = lookup_def_int "-funfolding-interface-threshold" (45::Int)
442 opt_UF_CreationThreshold = lookup_def_int "-funfolding-creation-threshold" (45::Int)
443 opt_UF_UseThreshold = lookup_def_int "-funfolding-use-threshold" (8::Int) -- Discounts can be big
444 opt_UF_FunAppDiscount = lookup_def_int "-funfolding-fun-discount" (6::Int) -- It's great to inline a fn
445 opt_UF_KeenessFactor = lookup_def_float "-funfolding-keeness-factor" (1.5::Float)
446 opt_UF_UpdateInPlace = lookUp SLIT("-funfolding-update-in-place")
448 opt_UF_CheapOp = ( 1 :: Int) -- Only one instruction; and the args are charged for
449 opt_UF_DearOp = ( 4 :: Int)
451 opt_NoPruneDecls = lookUp SLIT("-fno-prune-decls")
452 opt_NoPruneTyDecls = lookUp SLIT("-fno-prune-tydecls")
453 opt_Static = lookUp SLIT("-static")
454 opt_Unregisterised = lookUp SLIT("-funregisterised")
455 opt_Verbose = lookUp SLIT("-v")
458 %************************************************************************
460 \subsection{List of static hsc flags}
462 %************************************************************************
467 "-fauto-sccs-on-all-toplevs",
468 "-fauto-sccs-on-exported-toplevs",
469 "-fauto-sccs-on-individual-cafs",
470 "-fauto-sccs-on-dicts",
476 "-firrefutable-tuples",
483 "-funfold-casms-in-hi-file",
485 "-funbox-strict-fields",
486 "-femit-extern-decls",
487 "-fglobalise-toplev-names",
490 "-fignore-interface-pragmas",
491 "-fno-hi-version-check",
492 "-fno-implicit-prelude",
494 "-fomit-interface-pragmas",
496 "-fdo-eta-reduction",
497 "-fdo-lambda-eta-expansion",
500 "-fpedantic-bottoms",
501 "-fexcess-precision",
502 "-funfolding-update-in-place",
505 "-fno-prune-tydecls",
509 || any (flip prefixMatch f) [
511 "-fliberate-case-threshold",
514 "-funfolding-interface-threshold",
515 "-funfolding-creation-threshold",
516 "-funfolding-use-threshold",
517 "-funfolding-fun-discount",
518 "-funfolding-keeness-factor"
522 %************************************************************************
524 \subsection{Switch ordering}
526 %************************************************************************
528 These things behave just like enumeration types.
531 instance Eq SimplifierSwitch where
532 a == b = tagOf_SimplSwitch a ==# tagOf_SimplSwitch b
534 instance Ord SimplifierSwitch where
535 a < b = tagOf_SimplSwitch a <# tagOf_SimplSwitch b
536 a <= b = tagOf_SimplSwitch a <=# tagOf_SimplSwitch b
539 tagOf_SimplSwitch (SimplInlinePhase _) = _ILIT(1)
540 tagOf_SimplSwitch (MaxSimplifierIterations _) = _ILIT(2)
541 tagOf_SimplSwitch DontApplyRules = _ILIT(3)
542 tagOf_SimplSwitch SimplLetToCase = _ILIT(4)
543 tagOf_SimplSwitch NoCaseOfCase = _ILIT(5)
545 -- If you add anything here, be sure to change lAST_SIMPL_SWITCH_TAG, too!
547 lAST_SIMPL_SWITCH_TAG = 5
550 %************************************************************************
552 \subsection{Switch lookup}
554 %************************************************************************
557 isAmongSimpl :: [SimplifierSwitch] -> SimplifierSwitch -> SwitchResult
558 isAmongSimpl on_switches -- Switches mentioned later occur *earlier*
559 -- in the list; defaults right at the end.
561 tidied_on_switches = foldl rm_dups [] on_switches
562 -- The fold*l* ensures that we keep the latest switches;
563 -- ie the ones that occur earliest in the list.
565 sw_tbl :: Array Int SwitchResult
566 sw_tbl = (array (0, lAST_SIMPL_SWITCH_TAG) -- bounds...
570 all_undefined = [ (i, SwBool False) | i <- [0 .. lAST_SIMPL_SWITCH_TAG ] ]
572 defined_elems = map mk_assoc_elem tidied_on_switches
574 -- (avoid some unboxing, bounds checking, and other horrible things:)
575 #if __GLASGOW_HASKELL__ < 405
576 case sw_tbl of { Array bounds_who_needs_'em stuff ->
578 case sw_tbl of { Array _ _ stuff ->
581 case (indexArray# stuff (tagOf_SimplSwitch switch)) of
582 #if __GLASGOW_HASKELL__ < 400
584 #elif __GLASGOW_HASKELL__ < 403
591 mk_assoc_elem k@(MaxSimplifierIterations lvl)
592 = (iBox (tagOf_SimplSwitch k), SwInt lvl)
593 mk_assoc_elem k@(SimplInlinePhase n)
594 = (iBox (tagOf_SimplSwitch k), SwInt n)
596 = (iBox (tagOf_SimplSwitch k), SwBool True) -- I'm here, Mom!
598 -- cannot have duplicates if we are going to use the array thing
599 rm_dups switches_so_far switch
600 = if switch `is_elem` switches_so_far
602 else switch : switches_so_far
604 sw `is_elem` [] = False
605 sw `is_elem` (s:ss) = (tagOf_SimplSwitch sw) ==# (tagOf_SimplSwitch s)
609 Default settings for simplifier switches
612 defaultSimplSwitches = [MaxSimplifierIterations 1]
615 %************************************************************************
617 \subsection{Misc functions for command-line options}
619 %************************************************************************
623 switchIsOn :: (switch -> SwitchResult) -> switch -> Bool
625 switchIsOn lookup_fn switch
626 = case (lookup_fn switch) of
627 SwBool False -> False
630 intSwitchSet :: (switch -> SwitchResult)
634 intSwitchSet lookup_fn switch
635 = case (lookup_fn (switch (panic "intSwitchSet"))) of
636 SwInt int -> Just int
641 startsWith :: String -> String -> Maybe String
642 -- startsWith pfx (pfx++rest) = Just rest
644 startsWith [] str = Just str
645 startsWith (c:cs) (s:ss)
646 = if c /= s then Nothing else startsWith cs ss
647 startsWith _ [] = Nothing
649 endsWith :: String -> String -> Maybe String
651 = case (startsWith (reverse cs) (reverse ss)) of
653 Just rs -> Just (reverse rs)