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
39 opt_AutoSccsOnAllToplevs,
40 opt_AutoSccsOnExportedToplevs,
41 opt_AutoSccsOnIndividualCafs,
49 opt_MaxContextReductionDepth,
50 opt_IrrefutableTuples,
54 opt_NoMonomorphismRestriction,
59 opt_LiberateCaseThreshold,
60 opt_StgDoLetNoEscapes,
63 opt_UnboxStrictFields,
64 opt_SimplNoPreInlining,
65 opt_SimplDoEtaReduction,
66 opt_SimplDoLambdaEtaExpansion,
69 opt_SimplPedanticBottoms,
70 opt_SimplExcessPrecision,
73 opt_UF_HiFileThreshold,
74 opt_UF_CreationThreshold,
76 opt_UF_FunAppDiscount,
85 opt_EnsureSplittableC,
90 opt_IgnoreIfacePragmas,
93 opt_OmitInterfacePragmas,
100 #include "HsVersions.h"
102 import Array ( array, (//) )
104 import IOExts ( IORef, readIORef )
105 import Constants -- Default values for some flags
110 import Maybes ( firstJust )
111 import Panic ( panic )
113 #if __GLASGOW_HASKELL__ < 301
114 import ArrBase ( Array(..) )
116 import PrelArr ( Array(..) )
120 %************************************************************************
122 \subsection{Command-line options}
124 %************************************************************************
126 The hsc command-line options are split into two categories:
131 Static flags are represented by top-level values of type Bool or Int,
132 for example. They therefore have the same value throughout the
135 Dynamic flags are represented by an abstract type, DynFlags, which is
136 passed into hsc by the compilation manager for every compilation.
137 Dynamic flags are those that change on a per-compilation basis,
138 perhaps because they may be present in the OPTIONS pragma at the top
141 Other flag-related blurb:
143 A list of {\em ToDo}s is things to be done in a particular part of
144 processing. A (fictitious) example for the Core-to-Core simplifier
145 might be: run the simplifier, then run the strictness analyser, then
146 run the simplifier again (three ``todos'').
148 There are three ``to-do processing centers'' at the moment. In the
149 main loop (\tr{main/Main.lhs}), in the Core-to-Core processing loop
150 (\tr{simplCore/SimplCore.lhs), and in the STG-to-STG processing loop
151 (\tr{simplStg/SimplStg.lhs}).
153 %************************************************************************
155 \subsection{Datatypes associated with command-line options}
157 %************************************************************************
161 = SwBool Bool -- on/off
162 | SwString FAST_STRING -- nothing or a String
163 | SwInt Int -- nothing or an Int
167 data CoreToDo -- These are diff core-to-core passes,
168 -- which may be invoked in any order,
169 -- as many times as you like.
171 = CoreDoSimplify -- The core-to-core simplifier.
172 (SimplifierSwitch -> SwitchResult)
173 -- Each run of the simplifier can take a different
174 -- set of simplifier-specific flags.
176 | CoreDoFloatOutwards Bool -- True <=> float lambdas to top level
181 | CoreDoWorkerWrapper
188 | CoreDoNothing -- useful when building up lists of these things
193 = StgDoMassageForProfiling -- should be (next to) last
194 -- There's also setStgVarInfo, but its absolute "lastness"
195 -- is so critical that it is hardwired in (no flag).
200 data SimplifierSwitch
201 = MaxSimplifierIterations Int
202 | SimplInlinePhase Int
208 %************************************************************************
210 \subsection{Dynamic command-line options}
212 %************************************************************************
225 | Opt_D_dump_inlinings
226 | Opt_D_dump_occur_anal
231 | Opt_D_dump_simpl_iterations
241 | Opt_D_dump_worker_wrapper
242 | Opt_D_dump_rn_trace
243 | Opt_D_dump_rn_stats
245 | Opt_D_dump_simpl_stats
248 | Opt_D_verbose_core2core
249 | Opt_D_verbose_stg2stg
251 | Opt_D_dump_hi_diffs
252 | Opt_D_dump_minimal_imports
257 | Opt_WarnDuplicateExports
259 | Opt_WarnIncompletePatterns
260 | Opt_WarnMissingFields
261 | Opt_WarnMissingMethods
262 | Opt_WarnMissingSigs
263 | Opt_WarnNameShadowing
264 | Opt_WarnOverlappingPatterns
265 | Opt_WarnSimplePatterns
266 | Opt_WarnTypeDefaults
267 | Opt_WarnUnusedBinds
268 | Opt_WarnUnusedImports
269 | Opt_WarnUnusedMatches
270 | Opt_WarnDeprecations
273 | Opt_AllowOverlappingInstances
274 | Opt_AllowUndecidableInstances
277 | Opt_NoImplicitPrelude
283 data DynFlags = DynFlags {
284 coreToDo :: [CoreToDo],
285 stgToDo :: [StgToDo],
287 hscOutName :: String, -- name of the output file
288 verbosity :: Int, -- verbosity level
289 cppFlag :: Bool, -- preprocess with cpp?
290 stolen_x86_regs :: Int,
291 cmdlineHcIncludes :: [String], -- -#includes
293 -- options for particular phases
304 defaultDynFlags = DynFlags {
305 coreToDo = [], stgToDo = [],
311 cmdlineHcIncludes = [],
323 0 | print errors & warnings only
324 1 | minimal verbosity: print "compiling M ... done." for each module.
325 2 | equivalent to -dshow-passes
326 3 | equivalent to existing "ghc -v"
327 4 | "ghc -v -ddump-most"
328 5 | "ghc -v -ddump-all"
331 dopt :: DynFlag -> DynFlags -> Bool
332 dopt f dflags = f `elem` (flags dflags)
334 dopt_CoreToDo :: DynFlags -> [CoreToDo]
335 dopt_CoreToDo = coreToDo
337 dopt_StgToDo :: DynFlags -> [StgToDo]
338 dopt_StgToDo = stgToDo
340 dopt_OutName :: DynFlags -> String
341 dopt_OutName = hscOutName
350 dopt_HscLang :: DynFlags -> HscLang
351 dopt_HscLang = hscLang
354 %************************************************************************
356 \subsection{Classifying command-line options}
358 %************************************************************************
361 -- v_Statis_hsc_opts is here to avoid a circular dependency with
363 GLOBAL_VAR(v_Static_hsc_opts, [], [String])
365 lookUp :: FAST_STRING -> Bool
366 lookup_int :: String -> Maybe Int
367 lookup_def_int :: String -> Int -> Int
368 lookup_def_float :: String -> Float -> Float
369 lookup_str :: String -> Maybe String
371 unpacked_static_opts = unsafePerformIO (readIORef v_Static_hsc_opts)
372 packed_static_opts = map _PK_ unpacked_static_opts
374 lookUp sw = sw `elem` packed_static_opts
376 lookup_str sw = firstJust (map (startsWith sw) unpacked_static_opts)
378 lookup_int sw = case (lookup_str sw) of
380 Just xx -> Just (read xx)
382 lookup_def_int sw def = case (lookup_str sw) of
383 Nothing -> def -- Use default
386 lookup_def_float sw def = case (lookup_str sw) of
387 Nothing -> def -- Use default
392 Putting the compiler options into temporary at-files
393 may turn out to be necessary later on if we turn hsc into
394 a pure Win32 application where I think there's a command-line
395 length limit of 255. unpacked_opts understands the @ option.
397 unpacked_opts :: [String]
401 map _UNPK_ argv -- NOT ARGV any more: v_Static_hsc_opts
403 expandAts ('@':fname) = words (unsafePerformIO (readFile fname))
408 %************************************************************************
410 \subsection{Static options}
412 %************************************************************************
416 opt_PprStyle_NoPrags = lookUp SLIT("-dppr-noprags")
417 opt_PprStyle_Debug = lookUp SLIT("-dppr-debug")
418 opt_PprStyle_RawTypes = lookUp SLIT("-dppr-rawtypes")
419 opt_PprUserLength = lookup_def_int "-dppr-user-length" 5 --ToDo: give this a name
422 opt_AutoSccsOnAllToplevs = lookUp SLIT("-fauto-sccs-on-all-toplevs")
423 opt_AutoSccsOnExportedToplevs = lookUp SLIT("-fauto-sccs-on-exported-toplevs")
424 opt_AutoSccsOnIndividualCafs = lookUp SLIT("-fauto-sccs-on-individual-cafs")
425 opt_AutoSccsOnDicts = lookUp SLIT("-fauto-sccs-on-dicts")
426 opt_SccProfilingOn = lookUp SLIT("-fscc-profiling")
427 opt_DoTickyProfiling = lookUp SLIT("-fticky-ticky")
430 opt_AllStrict = lookUp SLIT("-fall-strict")
431 opt_NoMonomorphismRestriction = lookUp SLIT("-fno-monomorphism-restriction")
432 opt_DictsStrict = lookUp SLIT("-fdicts-strict")
433 opt_IrrefutableTuples = lookUp SLIT("-firrefutable-tuples")
434 opt_MaxContextReductionDepth = lookup_def_int "-fcontext-stack" mAX_CONTEXT_REDUCTION_DEPTH
435 opt_NumbersStrict = lookUp SLIT("-fnumbers-strict")
436 opt_Parallel = lookUp SLIT("-fparallel")
437 opt_SMP = lookUp SLIT("-fsmp")
440 opt_DoSemiTagging = lookUp SLIT("-fsemi-tagging")
441 opt_FoldrBuildOn = lookUp SLIT("-ffoldr-build-on")
442 opt_LiberateCaseThreshold = lookup_def_int "-fliberate-case-threshold" (10::Int)
443 opt_StgDoLetNoEscapes = lookUp SLIT("-flet-no-escape")
444 opt_UnfoldCasms = lookUp SLIT("-funfold-casms-in-hi-file")
445 opt_UsageSPOn = lookUp SLIT("-fusagesp-on")
446 opt_UnboxStrictFields = lookUp SLIT("-funbox-strict-fields")
449 The optional '-inpackage=P' flag tells what package
450 we are compiling this module for.
451 The Prelude, for example is compiled with '-package prelude'
453 opt_InPackage = case lookup_str "-inpackage=" of
455 Nothing -> SLIT("Main") -- The package name if none is specified
457 opt_EmitCExternDecls = lookUp SLIT("-femit-extern-decls")
458 opt_EnsureSplittableC = lookUp SLIT("-fglobalise-toplev-names")
459 opt_GranMacros = lookUp SLIT("-fgransim")
460 opt_HiVersion = read cProjectVersionInt :: Int
461 opt_HistorySize = lookup_def_int "-fhistory-size" 20
462 opt_IgnoreAsserts = lookUp SLIT("-fignore-asserts")
463 opt_IgnoreIfacePragmas = lookUp SLIT("-fignore-interface-pragmas")
464 opt_NoHiCheck = lookUp SLIT("-fno-hi-version-check")
465 opt_OmitBlackHoling = lookUp SLIT("-dno-black-holing")
466 opt_OmitInterfacePragmas = lookUp SLIT("-fomit-interface-pragmas")
468 -- Simplifier switches
469 opt_SimplNoPreInlining = lookUp SLIT("-fno-pre-inlining")
470 -- NoPreInlining is there just to see how bad things
471 -- get if you don't do it!
472 opt_SimplDoEtaReduction = lookUp SLIT("-fdo-eta-reduction")
473 opt_SimplDoLambdaEtaExpansion = lookUp SLIT("-fdo-lambda-eta-expansion")
474 opt_SimplCaseOfCase = lookUp SLIT("-fcase-of-case")
475 opt_SimplCaseMerge = lookUp SLIT("-fcase-merge")
476 opt_SimplPedanticBottoms = lookUp SLIT("-fpedantic-bottoms")
477 opt_SimplExcessPrecision = lookUp SLIT("-fexcess-precision")
480 opt_UF_HiFileThreshold = lookup_def_int "-funfolding-interface-threshold" (45::Int)
481 opt_UF_CreationThreshold = lookup_def_int "-funfolding-creation-threshold" (45::Int)
482 opt_UF_UseThreshold = lookup_def_int "-funfolding-use-threshold" (8::Int) -- Discounts can be big
483 opt_UF_FunAppDiscount = lookup_def_int "-funfolding-fun-discount" (6::Int) -- It's great to inline a fn
484 opt_UF_KeenessFactor = lookup_def_float "-funfolding-keeness-factor" (1.5::Float)
485 opt_UF_UpdateInPlace = lookUp SLIT("-funfolding-update-in-place")
487 opt_UF_CheapOp = ( 1 :: Int) -- Only one instruction; and the args are charged for
488 opt_UF_DearOp = ( 4 :: Int)
490 opt_NoPruneDecls = lookUp SLIT("-fno-prune-decls")
491 opt_NoPruneTyDecls = lookUp SLIT("-fno-prune-tydecls")
492 opt_Static = lookUp SLIT("-static")
493 opt_Unregisterised = lookUp SLIT("-funregisterised")
496 %************************************************************************
498 \subsection{List of static hsc flags}
500 %************************************************************************
505 "fauto-sccs-on-all-toplevs",
506 "fauto-sccs-on-exported-toplevs",
507 "fauto-sccs-on-individual-cafs",
508 "fauto-sccs-on-dicts",
513 "firrefutable-tuples",
520 "funfold-casms-in-hi-file",
522 "funbox-strict-fields",
523 "femit-extern-decls",
524 "fglobalise-toplev-names",
527 "fignore-interface-pragmas",
528 "fno-hi-version-check",
530 "fomit-interface-pragmas",
533 "fdo-lambda-eta-expansion",
538 "funfolding-update-in-place",
545 || any (flip prefixMatch f) [
547 "fliberate-case-threshold",
549 "funfolding-interface-threshold",
550 "funfolding-creation-threshold",
551 "funfolding-use-threshold",
552 "funfolding-fun-discount",
553 "funfolding-keeness-factor"
557 %************************************************************************
559 \subsection{Switch ordering}
561 %************************************************************************
563 These things behave just like enumeration types.
566 instance Eq SimplifierSwitch where
567 a == b = tagOf_SimplSwitch a ==# tagOf_SimplSwitch b
569 instance Ord SimplifierSwitch where
570 a < b = tagOf_SimplSwitch a <# tagOf_SimplSwitch b
571 a <= b = tagOf_SimplSwitch a <=# tagOf_SimplSwitch b
574 tagOf_SimplSwitch (SimplInlinePhase _) = _ILIT(1)
575 tagOf_SimplSwitch (MaxSimplifierIterations _) = _ILIT(2)
576 tagOf_SimplSwitch DontApplyRules = _ILIT(3)
577 tagOf_SimplSwitch SimplLetToCase = _ILIT(4)
578 tagOf_SimplSwitch NoCaseOfCase = _ILIT(5)
580 -- If you add anything here, be sure to change lAST_SIMPL_SWITCH_TAG, too!
582 lAST_SIMPL_SWITCH_TAG = 5
585 %************************************************************************
587 \subsection{Switch lookup}
589 %************************************************************************
592 isAmongSimpl :: [SimplifierSwitch] -> SimplifierSwitch -> SwitchResult
593 isAmongSimpl on_switches -- Switches mentioned later occur *earlier*
594 -- in the list; defaults right at the end.
596 tidied_on_switches = foldl rm_dups [] on_switches
597 -- The fold*l* ensures that we keep the latest switches;
598 -- ie the ones that occur earliest in the list.
600 sw_tbl :: Array Int SwitchResult
601 sw_tbl = (array (0, lAST_SIMPL_SWITCH_TAG) -- bounds...
605 all_undefined = [ (i, SwBool False) | i <- [0 .. lAST_SIMPL_SWITCH_TAG ] ]
607 defined_elems = map mk_assoc_elem tidied_on_switches
609 -- (avoid some unboxing, bounds checking, and other horrible things:)
610 #if __GLASGOW_HASKELL__ < 405
611 case sw_tbl of { Array bounds_who_needs_'em stuff ->
613 case sw_tbl of { Array _ _ stuff ->
616 case (indexArray# stuff (tagOf_SimplSwitch switch)) of
617 #if __GLASGOW_HASKELL__ < 400
619 #elif __GLASGOW_HASKELL__ < 403
626 mk_assoc_elem k@(MaxSimplifierIterations lvl)
627 = (iBox (tagOf_SimplSwitch k), SwInt lvl)
628 mk_assoc_elem k@(SimplInlinePhase n)
629 = (iBox (tagOf_SimplSwitch k), SwInt n)
631 = (iBox (tagOf_SimplSwitch k), SwBool True) -- I'm here, Mom!
633 -- cannot have duplicates if we are going to use the array thing
634 rm_dups switches_so_far switch
635 = if switch `is_elem` switches_so_far
637 else switch : switches_so_far
639 sw `is_elem` [] = False
640 sw `is_elem` (s:ss) = (tagOf_SimplSwitch sw) ==# (tagOf_SimplSwitch s)
645 %************************************************************************
647 \subsection{Misc functions for command-line options}
649 %************************************************************************
653 switchIsOn :: (switch -> SwitchResult) -> switch -> Bool
655 switchIsOn lookup_fn switch
656 = case (lookup_fn switch) of
657 SwBool False -> False
660 intSwitchSet :: (switch -> SwitchResult)
664 intSwitchSet lookup_fn switch
665 = case (lookup_fn (switch (panic "intSwitchSet"))) of
666 SwInt int -> Just int
671 startsWith :: String -> String -> Maybe String
672 -- startsWith pfx (pfx++rest) = Just rest
674 startsWith [] str = Just str
675 startsWith (c:cs) (s:ss)
676 = if c /= s then Nothing else startsWith cs ss
677 startsWith _ [] = Nothing
679 endsWith :: String -> String -> Maybe String
681 = case (startsWith (reverse cs) (reverse ss)) of
683 Just rs -> Just (reverse rs)