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
38 -- sets of warning opts
44 opt_AutoSccsOnAllToplevs,
45 opt_AutoSccsOnExportedToplevs,
46 opt_AutoSccsOnIndividualCafs,
54 opt_MaxContextReductionDepth,
55 opt_IrrefutableTuples,
59 opt_NoMonomorphismRestriction,
66 opt_LiberateCaseThreshold,
67 opt_StgDoLetNoEscapes,
70 opt_UnboxStrictFields,
71 opt_SimplNoPreInlining,
72 opt_SimplDoEtaReduction,
73 opt_SimplDoLambdaEtaExpansion,
75 opt_SimplExcessPrecision,
78 opt_UF_CreationThreshold,
80 opt_UF_FunAppDiscount,
89 opt_EnsureSplittableC,
94 opt_IgnoreIfacePragmas,
97 opt_OmitInterfacePragmas,
104 #include "HsVersions.h"
106 import Array ( array, (//) )
108 import IOExts ( IORef, readIORef )
109 import Constants -- Default values for some flags
114 import Maybes ( firstJust )
115 import Panic ( panic )
117 #if __GLASGOW_HASKELL__ < 301
118 import ArrBase ( Array(..) )
120 import PrelArr ( Array(..) )
124 %************************************************************************
126 \subsection{Command-line options}
128 %************************************************************************
130 The hsc command-line options are split into two categories:
135 Static flags are represented by top-level values of type Bool or Int,
136 for example. They therefore have the same value throughout the
139 Dynamic flags are represented by an abstract type, DynFlags, which is
140 passed into hsc by the compilation manager for every compilation.
141 Dynamic flags are those that change on a per-compilation basis,
142 perhaps because they may be present in the OPTIONS pragma at the top
145 Other flag-related blurb:
147 A list of {\em ToDo}s is things to be done in a particular part of
148 processing. A (fictitious) example for the Core-to-Core simplifier
149 might be: run the simplifier, then run the strictness analyser, then
150 run the simplifier again (three ``todos'').
152 There are three ``to-do processing centers'' at the moment. In the
153 main loop (\tr{main/Main.lhs}), in the Core-to-Core processing loop
154 (\tr{simplCore/SimplCore.lhs), and in the STG-to-STG processing loop
155 (\tr{simplStg/SimplStg.lhs}).
157 %************************************************************************
159 \subsection{Datatypes associated with command-line options}
161 %************************************************************************
165 = SwBool Bool -- on/off
166 | SwString FAST_STRING -- nothing or a String
167 | SwInt Int -- nothing or an Int
171 data CoreToDo -- These are diff core-to-core passes,
172 -- which may be invoked in any order,
173 -- as many times as you like.
175 = CoreDoSimplify -- The core-to-core simplifier.
176 (SimplifierSwitch -> SwitchResult)
177 -- Each run of the simplifier can take a different
178 -- set of simplifier-specific flags.
180 | CoreDoFloatOutwards Bool -- True <=> float lambdas to top level
185 | CoreDoWorkerWrapper
193 | CoreDoNothing -- useful when building up lists of these things
198 = StgDoMassageForProfiling -- should be (next to) last
199 -- There's also setStgVarInfo, but its absolute "lastness"
200 -- is so critical that it is hardwired in (no flag).
205 data SimplifierSwitch
206 = MaxSimplifierIterations Int
207 | SimplInlinePhase Int
213 %************************************************************************
215 \subsection{Dynamic command-line options}
217 %************************************************************************
230 | Opt_D_dump_inlinings
231 | Opt_D_dump_occur_anal
236 | Opt_D_dump_simpl_iterations
246 | Opt_D_dump_worker_wrapper
247 | Opt_D_dump_rn_trace
248 | Opt_D_dump_rn_stats
250 | Opt_D_dump_simpl_stats
251 | Opt_D_dump_tc_trace
254 | Opt_D_verbose_core2core
255 | Opt_D_verbose_stg2stg
257 | Opt_D_dump_hi_diffs
258 | Opt_D_dump_minimal_imports
263 | Opt_WarnDuplicateExports
265 | Opt_WarnIncompletePatterns
266 | Opt_WarnMissingFields
267 | Opt_WarnMissingMethods
268 | Opt_WarnMissingSigs
269 | Opt_WarnNameShadowing
270 | Opt_WarnOverlappingPatterns
271 | Opt_WarnSimplePatterns
272 | Opt_WarnTypeDefaults
273 | Opt_WarnUnusedBinds
274 | Opt_WarnUnusedImports
275 | Opt_WarnUnusedMatches
276 | Opt_WarnDeprecations
279 | Opt_AllowOverlappingInstances
280 | Opt_AllowUndecidableInstances
283 | Opt_NoImplicitPrelude
287 data DynFlags = DynFlags {
288 coreToDo :: [CoreToDo],
289 stgToDo :: [StgToDo],
291 hscOutName :: String, -- name of the output file
292 verbosity :: Int, -- verbosity level
293 cppFlag :: Bool, -- preprocess with cpp?
294 stolen_x86_regs :: Int,
295 cmdlineHcIncludes :: [String], -- -#includes
297 -- options for particular phases
308 defaultDynFlags = DynFlags {
309 coreToDo = [], stgToDo = [],
315 cmdlineHcIncludes = [],
321 flags = standardWarnings,
327 0 | print errors & warnings only
328 1 | minimal verbosity: print "compiling M ... done." for each module.
329 2 | equivalent to -dshow-passes
330 3 | equivalent to existing "ghc -v"
331 4 | "ghc -v -ddump-most"
332 5 | "ghc -v -ddump-all"
335 dopt :: DynFlag -> DynFlags -> Bool
336 dopt f dflags = f `elem` (flags dflags)
338 dopt_CoreToDo :: DynFlags -> [CoreToDo]
339 dopt_CoreToDo = coreToDo
341 dopt_StgToDo :: DynFlags -> [StgToDo]
342 dopt_StgToDo = stgToDo
344 dopt_OutName :: DynFlags -> String
345 dopt_OutName = hscOutName
357 dopt_HscLang :: DynFlags -> HscLang
358 dopt_HscLang = hscLang
361 %************************************************************************
363 \subsection{Warnings}
365 %************************************************************************
369 = [ Opt_WarnDeprecations,
370 Opt_WarnOverlappingPatterns,
371 Opt_WarnMissingFields,
372 Opt_WarnMissingMethods,
373 Opt_WarnDuplicateExports
377 = standardWarnings ++
378 [ Opt_WarnUnusedBinds,
379 Opt_WarnUnusedMatches,
380 Opt_WarnUnusedImports,
381 Opt_WarnIncompletePatterns
386 [ Opt_WarnTypeDefaults,
387 Opt_WarnNameShadowing,
393 %************************************************************************
395 \subsection{Classifying command-line options}
397 %************************************************************************
400 -- v_Statis_hsc_opts is here to avoid a circular dependency with
402 GLOBAL_VAR(v_Static_hsc_opts, [], [String])
404 lookUp :: FAST_STRING -> Bool
405 lookup_int :: String -> Maybe Int
406 lookup_def_int :: String -> Int -> Int
407 lookup_def_float :: String -> Float -> Float
408 lookup_str :: String -> Maybe String
410 unpacked_static_opts = unsafePerformIO (readIORef v_Static_hsc_opts)
411 packed_static_opts = map _PK_ unpacked_static_opts
413 lookUp sw = sw `elem` packed_static_opts
415 lookup_str sw = firstJust (map (startsWith sw) unpacked_static_opts)
417 lookup_int sw = case (lookup_str sw) of
419 Just xx -> Just (read xx)
421 lookup_def_int sw def = case (lookup_str sw) of
422 Nothing -> def -- Use default
425 lookup_def_float sw def = case (lookup_str sw) of
426 Nothing -> def -- Use default
431 Putting the compiler options into temporary at-files
432 may turn out to be necessary later on if we turn hsc into
433 a pure Win32 application where I think there's a command-line
434 length limit of 255. unpacked_opts understands the @ option.
436 unpacked_opts :: [String]
440 map _UNPK_ argv -- NOT ARGV any more: v_Static_hsc_opts
442 expandAts ('@':fname) = words (unsafePerformIO (readFile fname))
447 %************************************************************************
449 \subsection{Static options}
451 %************************************************************************
455 opt_PprStyle_NoPrags = lookUp SLIT("-dppr-noprags")
456 opt_PprStyle_Debug = lookUp SLIT("-dppr-debug")
457 opt_PprStyle_RawTypes = lookUp SLIT("-dppr-rawtypes")
458 opt_PprUserLength = lookup_def_int "-dppr-user-length" 5 --ToDo: give this a name
461 opt_AutoSccsOnAllToplevs = lookUp SLIT("-fauto-sccs-on-all-toplevs")
462 opt_AutoSccsOnExportedToplevs = lookUp SLIT("-fauto-sccs-on-exported-toplevs")
463 opt_AutoSccsOnIndividualCafs = lookUp SLIT("-fauto-sccs-on-individual-cafs")
464 opt_AutoSccsOnDicts = lookUp SLIT("-fauto-sccs-on-dicts")
465 opt_SccProfilingOn = lookUp SLIT("-fscc-profiling")
466 opt_DoTickyProfiling = lookUp SLIT("-fticky-ticky")
469 opt_AllStrict = lookUp SLIT("-fall-strict")
470 opt_NoMonomorphismRestriction = lookUp SLIT("-fno-monomorphism-restriction")
471 opt_DictsStrict = lookUp SLIT("-fdicts-strict")
472 opt_IrrefutableTuples = lookUp SLIT("-firrefutable-tuples")
473 opt_MaxContextReductionDepth = lookup_def_int "-fcontext-stack" mAX_CONTEXT_REDUCTION_DEPTH
474 opt_NumbersStrict = lookUp SLIT("-fnumbers-strict")
475 opt_Parallel = lookUp SLIT("-fparallel")
476 opt_SMP = lookUp SLIT("-fsmp")
479 opt_NoMethodSharing = lookUp SLIT("-fno-method-sharing")
480 opt_DoSemiTagging = lookUp SLIT("-fsemi-tagging")
481 opt_FoldrBuildOn = lookUp SLIT("-ffoldr-build-on")
482 opt_LiberateCaseThreshold = lookup_def_int "-fliberate-case-threshold" (10::Int)
483 opt_StgDoLetNoEscapes = lookUp SLIT("-flet-no-escape")
484 opt_UnfoldCasms = lookUp SLIT("-funfold-casms-in-hi-file")
485 opt_UsageSPOn = lookUp SLIT("-fusagesp-on")
486 opt_UnboxStrictFields = lookUp SLIT("-funbox-strict-fields")
489 The optional '-inpackage=P' flag tells what package
490 we are compiling this module for.
491 The Prelude, for example is compiled with '-inpackage std'
493 opt_InPackage = case lookup_str "-inpackage=" of
495 Nothing -> SLIT("Main") -- The package name if none is specified
497 opt_EmitCExternDecls = lookUp SLIT("-femit-extern-decls")
498 opt_EnsureSplittableC = lookUp SLIT("-fglobalise-toplev-names")
499 opt_GranMacros = lookUp SLIT("-fgransim")
500 opt_HiVersion = read cProjectVersionInt :: Int
501 opt_HistorySize = lookup_def_int "-fhistory-size" 20
502 opt_IgnoreAsserts = lookUp SLIT("-fignore-asserts")
503 opt_IgnoreIfacePragmas = lookUp SLIT("-fignore-interface-pragmas")
504 opt_NoHiCheck = lookUp SLIT("-fno-hi-version-check")
505 opt_OmitBlackHoling = lookUp SLIT("-dno-black-holing")
506 opt_OmitInterfacePragmas = lookUp SLIT("-fomit-interface-pragmas")
507 opt_KeepStgTypes = lookUp SLIT("-fkeep-stg-types")
509 -- Simplifier switches
510 opt_SimplNoPreInlining = lookUp SLIT("-fno-pre-inlining")
511 -- NoPreInlining is there just to see how bad things
512 -- get if you don't do it!
513 opt_SimplDoEtaReduction = lookUp SLIT("-fdo-eta-reduction")
514 opt_SimplDoLambdaEtaExpansion = lookUp SLIT("-fdo-lambda-eta-expansion")
515 opt_SimplCaseMerge = lookUp SLIT("-fcase-merge")
516 opt_SimplExcessPrecision = lookUp SLIT("-fexcess-precision")
519 opt_UF_CreationThreshold = lookup_def_int "-funfolding-creation-threshold" (45::Int)
520 opt_UF_UseThreshold = lookup_def_int "-funfolding-use-threshold" (8::Int) -- Discounts can be big
521 opt_UF_FunAppDiscount = lookup_def_int "-funfolding-fun-discount" (6::Int) -- It's great to inline a fn
522 opt_UF_KeenessFactor = lookup_def_float "-funfolding-keeness-factor" (1.5::Float)
523 opt_UF_UpdateInPlace = lookUp SLIT("-funfolding-update-in-place")
525 opt_UF_CheapOp = ( 1 :: Int) -- Only one instruction; and the args are charged for
526 opt_UF_DearOp = ( 4 :: Int)
528 opt_NoPruneDecls = lookUp SLIT("-fno-prune-decls")
529 opt_NoPruneTyDecls = lookUp SLIT("-fno-prune-tydecls")
530 opt_Static = lookUp SLIT("-static")
531 opt_Unregisterised = lookUp SLIT("-funregisterised")
534 %************************************************************************
536 \subsection{List of static hsc flags}
538 %************************************************************************
543 "fauto-sccs-on-all-toplevs",
544 "fauto-sccs-on-exported-toplevs",
545 "fauto-sccs-on-individual-cafs",
546 "fauto-sccs-on-dicts",
551 "firrefutable-tuples",
558 "funfold-casms-in-hi-file",
560 "funbox-strict-fields",
561 "femit-extern-decls",
562 "fglobalise-toplev-names",
565 "fignore-interface-pragmas",
566 "fno-hi-version-check",
568 "fno-method-sharing",
569 "fno-monomorphism-restriction",
570 "fomit-interface-pragmas",
574 "fdo-lambda-eta-expansion",
577 "funfolding-update-in-place",
583 || any (flip prefixMatch f) [
585 "fliberate-case-threshold",
587 "funfolding-creation-threshold",
588 "funfolding-use-threshold",
589 "funfolding-fun-discount",
590 "funfolding-keeness-factor"
594 %************************************************************************
596 \subsection{Switch ordering}
598 %************************************************************************
600 These things behave just like enumeration types.
603 instance Eq SimplifierSwitch where
604 a == b = tagOf_SimplSwitch a ==# tagOf_SimplSwitch b
606 instance Ord SimplifierSwitch where
607 a < b = tagOf_SimplSwitch a <# tagOf_SimplSwitch b
608 a <= b = tagOf_SimplSwitch a <=# tagOf_SimplSwitch b
611 tagOf_SimplSwitch (SimplInlinePhase _) = _ILIT(1)
612 tagOf_SimplSwitch (MaxSimplifierIterations _) = _ILIT(2)
613 tagOf_SimplSwitch DontApplyRules = _ILIT(3)
614 tagOf_SimplSwitch SimplLetToCase = _ILIT(4)
615 tagOf_SimplSwitch NoCaseOfCase = _ILIT(5)
617 -- If you add anything here, be sure to change lAST_SIMPL_SWITCH_TAG, too!
619 lAST_SIMPL_SWITCH_TAG = 5
622 %************************************************************************
624 \subsection{Switch lookup}
626 %************************************************************************
629 isAmongSimpl :: [SimplifierSwitch] -> SimplifierSwitch -> SwitchResult
630 isAmongSimpl on_switches -- Switches mentioned later occur *earlier*
631 -- in the list; defaults right at the end.
633 tidied_on_switches = foldl rm_dups [] on_switches
634 -- The fold*l* ensures that we keep the latest switches;
635 -- ie the ones that occur earliest in the list.
637 sw_tbl :: Array Int SwitchResult
638 sw_tbl = (array (0, lAST_SIMPL_SWITCH_TAG) -- bounds...
642 all_undefined = [ (i, SwBool False) | i <- [0 .. lAST_SIMPL_SWITCH_TAG ] ]
644 defined_elems = map mk_assoc_elem tidied_on_switches
646 -- (avoid some unboxing, bounds checking, and other horrible things:)
647 #if __GLASGOW_HASKELL__ < 405
648 case sw_tbl of { Array bounds_who_needs_'em stuff ->
650 case sw_tbl of { Array _ _ stuff ->
653 case (indexArray# stuff (tagOf_SimplSwitch switch)) of
654 #if __GLASGOW_HASKELL__ < 400
656 #elif __GLASGOW_HASKELL__ < 403
663 mk_assoc_elem k@(MaxSimplifierIterations lvl)
664 = (iBox (tagOf_SimplSwitch k), SwInt lvl)
665 mk_assoc_elem k@(SimplInlinePhase n)
666 = (iBox (tagOf_SimplSwitch k), SwInt n)
668 = (iBox (tagOf_SimplSwitch k), SwBool True) -- I'm here, Mom!
670 -- cannot have duplicates if we are going to use the array thing
671 rm_dups switches_so_far switch
672 = if switch `is_elem` switches_so_far
674 else switch : switches_so_far
676 sw `is_elem` [] = False
677 sw `is_elem` (s:ss) = (tagOf_SimplSwitch sw) ==# (tagOf_SimplSwitch s)
682 %************************************************************************
684 \subsection{Misc functions for command-line options}
686 %************************************************************************
690 switchIsOn :: (switch -> SwitchResult) -> switch -> Bool
692 switchIsOn lookup_fn switch
693 = case (lookup_fn switch) of
694 SwBool False -> False
697 intSwitchSet :: (switch -> SwitchResult)
701 intSwitchSet lookup_fn switch
702 = case (lookup_fn (switch (panic "intSwitchSet"))) of
703 SwInt int -> Just int
708 startsWith :: String -> String -> Maybe String
709 -- startsWith pfx (pfx++rest) = Just rest
711 startsWith [] str = Just str
712 startsWith (c:cs) (s:ss)
713 = if c /= s then Nothing else startsWith cs ss
714 startsWith _ [] = Nothing
716 endsWith :: String -> String -> Maybe String
718 = case (startsWith (reverse cs) (reverse ss)) of
720 Just rs -> Just (reverse rs)