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
24 -- Manipulating DynFlags
25 defaultDynFlags, -- DynFlags
26 dopt, -- DynFlag -> DynFlags -> Bool
27 dopt_set, dopt_unset, -- DynFlags -> DynFlag -> DynFlags
28 dopt_CoreToDo, -- DynFlags -> [CoreToDo]
29 dopt_StgToDo, -- DynFlags -> [StgToDo]
30 dopt_HscLang, -- DynFlags -> HscLang
31 dopt_OutName, -- DynFlags -> String
33 -- Manipulating the DynFlags state
34 getDynFlags, -- IO DynFlags
35 setDynFlags, -- DynFlags -> IO ()
36 updDynFlags, -- (DynFlags -> DynFlags) -> IO ()
37 dynFlag, -- (DynFlags -> a) -> IO a
38 setDynFlag, unSetDynFlag, -- DynFlag -> IO ()
39 saveDynFlags, -- IO ()
40 restoreDynFlags, -- IO DynFlags
42 -- sets of warning opts
47 -- Output style options
49 opt_PprStyle_RawTypes,
54 opt_AutoSccsOnAllToplevs,
55 opt_AutoSccsOnExportedToplevs,
56 opt_AutoSccsOnIndividualCafs,
64 opt_MaxContextReductionDepth,
65 opt_IrrefutableTuples,
69 opt_NoMonomorphismRestriction,
76 opt_LiberateCaseThreshold,
77 opt_StgDoLetNoEscapes,
80 opt_UnboxStrictFields,
81 opt_SimplNoPreInlining,
82 opt_SimplDoEtaReduction,
83 opt_SimplDoLambdaEtaExpansion,
85 opt_SimplExcessPrecision,
89 opt_UF_CreationThreshold,
91 opt_UF_FunAppDiscount,
100 opt_EnsureSplittableC,
105 opt_IgnoreIfacePragmas,
108 opt_OmitInterfacePragmas,
116 #include "HsVersions.h"
118 import Array ( array, (//) )
120 import IOExts ( IORef, readIORef, writeIORef )
121 import Constants -- Default values for some flags
126 import Maybes ( firstJust )
127 import Panic ( panic )
129 #if __GLASGOW_HASKELL__ < 301
130 import ArrBase ( Array(..) )
132 import PrelArr ( Array(..) )
136 %************************************************************************
138 \subsection{Command-line options}
140 %************************************************************************
142 The hsc command-line options are split into two categories:
147 Static flags are represented by top-level values of type Bool or Int,
148 for example. They therefore have the same value throughout the
151 Dynamic flags are represented by an abstract type, DynFlags, which is
152 passed into hsc by the compilation manager for every compilation.
153 Dynamic flags are those that change on a per-compilation basis,
154 perhaps because they may be present in the OPTIONS pragma at the top
157 Other flag-related blurb:
159 A list of {\em ToDo}s is things to be done in a particular part of
160 processing. A (fictitious) example for the Core-to-Core simplifier
161 might be: run the simplifier, then run the strictness analyser, then
162 run the simplifier again (three ``todos'').
164 There are three ``to-do processing centers'' at the moment. In the
165 main loop (\tr{main/Main.lhs}), in the Core-to-Core processing loop
166 (\tr{simplCore/SimplCore.lhs), and in the STG-to-STG processing loop
167 (\tr{simplStg/SimplStg.lhs}).
169 %************************************************************************
171 \subsection{Datatypes associated with command-line options}
173 %************************************************************************
177 = SwBool Bool -- on/off
178 | SwString FAST_STRING -- nothing or a String
179 | SwInt Int -- nothing or an Int
183 data CoreToDo -- These are diff core-to-core passes,
184 -- which may be invoked in any order,
185 -- as many times as you like.
187 = CoreDoSimplify -- The core-to-core simplifier.
188 (SimplifierSwitch -> SwitchResult)
189 -- Each run of the simplifier can take a different
190 -- set of simplifier-specific flags.
192 | CoreDoFloatOutwards Bool -- True <=> float lambdas to top level
197 | CoreDoWorkerWrapper
205 | CoreDoNothing -- useful when building up lists of these things
210 = StgDoMassageForProfiling -- should be (next to) last
211 -- There's also setStgVarInfo, but its absolute "lastness"
212 -- is so critical that it is hardwired in (no flag).
217 data SimplifierSwitch
218 = MaxSimplifierIterations Int
219 | SimplInlinePhase Int
225 %************************************************************************
227 \subsection{Dynamic command-line options}
229 %************************************************************************
242 | Opt_D_dump_inlinings
243 | Opt_D_dump_occur_anal
248 | Opt_D_dump_simpl_iterations
258 | Opt_D_dump_worker_wrapper
259 | Opt_D_dump_rn_trace
260 | Opt_D_dump_rn_stats
262 | Opt_D_dump_simpl_stats
263 | Opt_D_dump_tc_trace
266 | Opt_D_verbose_core2core
267 | Opt_D_verbose_stg2stg
269 | Opt_D_dump_hi_diffs
270 | Opt_D_dump_minimal_imports
275 | Opt_WarnDuplicateExports
277 | Opt_WarnIncompletePatterns
278 | Opt_WarnMissingFields
279 | Opt_WarnMissingMethods
280 | Opt_WarnMissingSigs
281 | Opt_WarnNameShadowing
282 | Opt_WarnOverlappingPatterns
283 | Opt_WarnSimplePatterns
284 | Opt_WarnTypeDefaults
285 | Opt_WarnUnusedBinds
286 | Opt_WarnUnusedImports
287 | Opt_WarnUnusedMatches
288 | Opt_WarnDeprecations
292 | Opt_AllowOverlappingInstances
293 | Opt_AllowUndecidableInstances
296 | Opt_NoImplicitPrelude
300 data DynFlags = DynFlags {
301 coreToDo :: [CoreToDo],
302 stgToDo :: [StgToDo],
304 hscOutName :: String, -- name of the output file
305 hscStubHOutName :: String, -- name of the .stub_h output file
306 hscStubCOutName :: String, -- name of the .stub_c output file
307 extCoreName :: String, -- name of the .core output file
308 verbosity :: Int, -- verbosity level
309 cppFlag :: Bool, -- preprocess with cpp?
310 stolen_x86_regs :: Int,
311 cmdlineHcIncludes :: [String], -- -#includes
313 -- options for particular phases
332 defaultDynFlags = DynFlags {
333 coreToDo = [], stgToDo = [],
336 hscStubHOutName = "", hscStubCOutName = "",
341 cmdlineHcIncludes = [],
347 flags = standardWarnings,
353 0 | print errors & warnings only
354 1 | minimal verbosity: print "compiling M ... done." for each module.
355 2 | equivalent to -dshow-passes
356 3 | equivalent to existing "ghc -v"
357 4 | "ghc -v -ddump-most"
358 5 | "ghc -v -ddump-all"
361 dopt :: DynFlag -> DynFlags -> Bool
362 dopt f dflags = f `elem` (flags dflags)
364 dopt_CoreToDo :: DynFlags -> [CoreToDo]
365 dopt_CoreToDo = coreToDo
367 dopt_StgToDo :: DynFlags -> [StgToDo]
368 dopt_StgToDo = stgToDo
370 dopt_OutName :: DynFlags -> String
371 dopt_OutName = hscOutName
373 dopt_HscLang :: DynFlags -> HscLang
374 dopt_HscLang = hscLang
376 dopt_set :: DynFlags -> DynFlag -> DynFlags
377 dopt_set dfs f = dfs{ flags = f : flags dfs }
379 dopt_unset :: DynFlags -> DynFlag -> DynFlags
380 dopt_unset dfs f = dfs{ flags = filter (/= f) (flags dfs) }
383 -----------------------------------------------------------------------------
384 -- Mess about with the mutable variables holding the dynamic arguments
387 -- is the "baseline" dynamic flags, initialised from
388 -- the defaults and command line options, and updated by the
389 -- ':s' command in GHCi.
392 -- is the dynamic flags for the current compilation. It is reset
393 -- to the value of v_InitDynFlags before each compilation, then
394 -- updated by reading any OPTIONS pragma in the current module.
397 GLOBAL_VAR(v_InitDynFlags, defaultDynFlags, DynFlags)
398 GLOBAL_VAR(v_DynFlags, defaultDynFlags, DynFlags)
400 setDynFlags :: DynFlags -> IO ()
401 setDynFlags dfs = writeIORef v_DynFlags dfs
403 saveDynFlags :: IO ()
404 saveDynFlags = do dfs <- readIORef v_DynFlags
405 writeIORef v_InitDynFlags dfs
407 restoreDynFlags :: IO DynFlags
408 restoreDynFlags = do dfs <- readIORef v_InitDynFlags
409 writeIORef v_DynFlags dfs
412 getDynFlags :: IO DynFlags
413 getDynFlags = readIORef v_DynFlags
415 updDynFlags :: (DynFlags -> DynFlags) -> IO ()
416 updDynFlags f = do dfs <- readIORef v_DynFlags
417 writeIORef v_DynFlags (f dfs)
419 dynFlag :: (DynFlags -> a) -> IO a
420 dynFlag f = do dflags <- readIORef v_DynFlags; return (f dflags)
422 setDynFlag, unSetDynFlag :: DynFlag -> IO ()
423 setDynFlag f = updDynFlags (\dfs -> dopt_set dfs f)
424 unSetDynFlag f = updDynFlags (\dfs -> dopt_unset dfs f)
428 %************************************************************************
430 \subsection{Warnings}
432 %************************************************************************
436 = [ Opt_WarnDeprecations,
437 Opt_WarnOverlappingPatterns,
438 Opt_WarnMissingFields,
439 Opt_WarnMissingMethods,
440 Opt_WarnDuplicateExports
444 = standardWarnings ++
445 [ Opt_WarnUnusedBinds,
446 Opt_WarnUnusedMatches,
447 Opt_WarnUnusedImports,
448 Opt_WarnIncompletePatterns,
454 [ Opt_WarnTypeDefaults,
455 Opt_WarnNameShadowing,
461 %************************************************************************
463 \subsection{Classifying command-line options}
465 %************************************************************************
468 -- v_Statis_hsc_opts is here to avoid a circular dependency with
470 GLOBAL_VAR(v_Static_hsc_opts, [], [String])
472 lookUp :: FAST_STRING -> Bool
473 lookup_int :: String -> Maybe Int
474 lookup_def_int :: String -> Int -> Int
475 lookup_def_float :: String -> Float -> Float
476 lookup_str :: String -> Maybe String
478 unpacked_static_opts = unsafePerformIO (readIORef v_Static_hsc_opts)
479 packed_static_opts = map _PK_ unpacked_static_opts
481 lookUp sw = sw `elem` packed_static_opts
483 lookup_str sw = firstJust (map (startsWith sw) unpacked_static_opts)
485 lookup_int sw = case (lookup_str sw) of
487 Just xx -> Just (read xx)
489 lookup_def_int sw def = case (lookup_str sw) of
490 Nothing -> def -- Use default
493 lookup_def_float sw def = case (lookup_str sw) of
494 Nothing -> def -- Use default
499 Putting the compiler options into temporary at-files
500 may turn out to be necessary later on if we turn hsc into
501 a pure Win32 application where I think there's a command-line
502 length limit of 255. unpacked_opts understands the @ option.
504 unpacked_opts :: [String]
508 map _UNPK_ argv -- NOT ARGV any more: v_Static_hsc_opts
510 expandAts ('@':fname) = words (unsafePerformIO (readFile fname))
515 %************************************************************************
517 \subsection{Static options}
519 %************************************************************************
523 opt_PprStyle_NoPrags = lookUp SLIT("-dppr-noprags")
524 opt_PprStyle_Debug = lookUp SLIT("-dppr-debug")
525 opt_PprStyle_RawTypes = lookUp SLIT("-dppr-rawtypes")
526 opt_PprUserLength = lookup_def_int "-dppr-user-length" 5 --ToDo: give this a name
529 opt_AutoSccsOnAllToplevs = lookUp SLIT("-fauto-sccs-on-all-toplevs")
530 opt_AutoSccsOnExportedToplevs = lookUp SLIT("-fauto-sccs-on-exported-toplevs")
531 opt_AutoSccsOnIndividualCafs = lookUp SLIT("-fauto-sccs-on-individual-cafs")
532 opt_AutoSccsOnDicts = lookUp SLIT("-fauto-sccs-on-dicts")
533 opt_SccProfilingOn = lookUp SLIT("-fscc-profiling")
534 opt_DoTickyProfiling = lookUp SLIT("-fticky-ticky")
537 opt_AllStrict = lookUp SLIT("-fall-strict")
538 opt_NoMonomorphismRestriction = lookUp SLIT("-fno-monomorphism-restriction")
539 opt_DictsStrict = lookUp SLIT("-fdicts-strict")
540 opt_IrrefutableTuples = lookUp SLIT("-firrefutable-tuples")
541 opt_MaxContextReductionDepth = lookup_def_int "-fcontext-stack" mAX_CONTEXT_REDUCTION_DEPTH
542 opt_NumbersStrict = lookUp SLIT("-fnumbers-strict")
543 opt_Parallel = lookUp SLIT("-fparallel")
544 opt_SMP = lookUp SLIT("-fsmp")
547 opt_NoMethodSharing = lookUp SLIT("-fno-method-sharing")
548 opt_DoSemiTagging = lookUp SLIT("-fsemi-tagging")
549 opt_FoldrBuildOn = lookUp SLIT("-ffoldr-build-on")
550 opt_LiberateCaseThreshold = lookup_def_int "-fliberate-case-threshold" (10::Int)
551 opt_StgDoLetNoEscapes = lookUp SLIT("-flet-no-escape")
552 opt_UnfoldCasms = lookUp SLIT("-funfold-casms-in-hi-file")
553 opt_UsageSPOn = lookUp SLIT("-fusagesp-on")
554 opt_UnboxStrictFields = lookUp SLIT("-funbox-strict-fields")
555 opt_MaxWorkerArgs = lookup_def_int "-fmax-worker-args" (10::Int)
558 The optional '-inpackage=P' flag tells what package
559 we are compiling this module for.
560 The Prelude, for example is compiled with '-inpackage std'
562 opt_InPackage = case lookup_str "-inpackage=" of
564 Nothing -> SLIT("Main") -- The package name if none is specified
566 opt_EmitCExternDecls = lookUp SLIT("-femit-extern-decls")
567 opt_EnsureSplittableC = lookUp SLIT("-fglobalise-toplev-names")
568 opt_GranMacros = lookUp SLIT("-fgransim")
569 opt_HiVersion = read cProjectVersionInt :: Int
570 opt_HistorySize = lookup_def_int "-fhistory-size" 20
571 opt_IgnoreAsserts = lookUp SLIT("-fignore-asserts")
572 opt_IgnoreIfacePragmas = lookUp SLIT("-fignore-interface-pragmas")
573 opt_NoHiCheck = lookUp SLIT("-fno-hi-version-check")
574 opt_OmitBlackHoling = lookUp SLIT("-dno-black-holing")
575 opt_OmitInterfacePragmas = lookUp SLIT("-fomit-interface-pragmas")
576 opt_RuntimeTypes = lookUp SLIT("-fruntime-types")
578 -- Simplifier switches
579 opt_SimplNoPreInlining = lookUp SLIT("-fno-pre-inlining")
580 -- NoPreInlining is there just to see how bad things
581 -- get if you don't do it!
582 opt_SimplDoEtaReduction = lookUp SLIT("-fdo-eta-reduction")
583 opt_SimplDoLambdaEtaExpansion = lookUp SLIT("-fdo-lambda-eta-expansion")
584 opt_SimplCaseMerge = lookUp SLIT("-fcase-merge")
585 opt_SimplExcessPrecision = lookUp SLIT("-fexcess-precision")
588 opt_UF_CreationThreshold = lookup_def_int "-funfolding-creation-threshold" (45::Int)
589 opt_UF_UseThreshold = lookup_def_int "-funfolding-use-threshold" (8::Int) -- Discounts can be big
590 opt_UF_FunAppDiscount = lookup_def_int "-funfolding-fun-discount" (6::Int) -- It's great to inline a fn
591 opt_UF_KeenessFactor = lookup_def_float "-funfolding-keeness-factor" (1.5::Float)
592 opt_UF_UpdateInPlace = lookUp SLIT("-funfolding-update-in-place")
594 opt_UF_CheapOp = ( 1 :: Int) -- Only one instruction; and the args are charged for
595 opt_UF_DearOp = ( 4 :: Int)
597 opt_NoPruneDecls = lookUp SLIT("-fno-prune-decls")
598 opt_NoPruneTyDecls = lookUp SLIT("-fno-prune-tydecls")
599 opt_Static = lookUp SLIT("-static")
600 opt_Unregisterised = lookUp SLIT("-funregisterised")
601 opt_EmitExternalCore = lookUp SLIT("-fext-core")
604 %************************************************************************
606 \subsection{List of static hsc flags}
608 %************************************************************************
613 "fauto-sccs-on-all-toplevs",
614 "fauto-sccs-on-exported-toplevs",
615 "fauto-sccs-on-individual-cafs",
616 "fauto-sccs-on-dicts",
621 "firrefutable-tuples",
628 "funfold-casms-in-hi-file",
630 "funbox-strict-fields",
631 "femit-extern-decls",
632 "fglobalise-toplev-names",
635 "fignore-interface-pragmas",
636 "fno-hi-version-check",
638 "fno-method-sharing",
639 "fno-monomorphism-restriction",
640 "fomit-interface-pragmas",
644 "fdo-lambda-eta-expansion",
647 "funfolding-update-in-place",
654 || any (flip prefixMatch f) [
656 "fliberate-case-threshold",
659 "funfolding-creation-threshold",
660 "funfolding-use-threshold",
661 "funfolding-fun-discount",
662 "funfolding-keeness-factor"
666 %************************************************************************
668 \subsection{Switch ordering}
670 %************************************************************************
672 These things behave just like enumeration types.
675 instance Eq SimplifierSwitch where
676 a == b = tagOf_SimplSwitch a ==# tagOf_SimplSwitch b
678 instance Ord SimplifierSwitch where
679 a < b = tagOf_SimplSwitch a <# tagOf_SimplSwitch b
680 a <= b = tagOf_SimplSwitch a <=# tagOf_SimplSwitch b
683 tagOf_SimplSwitch (SimplInlinePhase _) = _ILIT(1)
684 tagOf_SimplSwitch (MaxSimplifierIterations _) = _ILIT(2)
685 tagOf_SimplSwitch DontApplyRules = _ILIT(3)
686 tagOf_SimplSwitch SimplLetToCase = _ILIT(4)
687 tagOf_SimplSwitch NoCaseOfCase = _ILIT(5)
689 -- If you add anything here, be sure to change lAST_SIMPL_SWITCH_TAG, too!
691 lAST_SIMPL_SWITCH_TAG = 5
694 %************************************************************************
696 \subsection{Switch lookup}
698 %************************************************************************
701 isAmongSimpl :: [SimplifierSwitch] -> SimplifierSwitch -> SwitchResult
702 isAmongSimpl on_switches -- Switches mentioned later occur *earlier*
703 -- in the list; defaults right at the end.
705 tidied_on_switches = foldl rm_dups [] on_switches
706 -- The fold*l* ensures that we keep the latest switches;
707 -- ie the ones that occur earliest in the list.
709 sw_tbl :: Array Int SwitchResult
710 sw_tbl = (array (0, lAST_SIMPL_SWITCH_TAG) -- bounds...
714 all_undefined = [ (i, SwBool False) | i <- [0 .. lAST_SIMPL_SWITCH_TAG ] ]
716 defined_elems = map mk_assoc_elem tidied_on_switches
718 -- (avoid some unboxing, bounds checking, and other horrible things:)
719 #if __GLASGOW_HASKELL__ < 405
720 case sw_tbl of { Array bounds_who_needs_'em stuff ->
722 case sw_tbl of { Array _ _ stuff ->
725 case (indexArray# stuff (tagOf_SimplSwitch switch)) of
726 #if __GLASGOW_HASKELL__ < 400
728 #elif __GLASGOW_HASKELL__ < 403
735 mk_assoc_elem k@(MaxSimplifierIterations lvl)
736 = (iBox (tagOf_SimplSwitch k), SwInt lvl)
737 mk_assoc_elem k@(SimplInlinePhase n)
738 = (iBox (tagOf_SimplSwitch k), SwInt n)
740 = (iBox (tagOf_SimplSwitch k), SwBool True) -- I'm here, Mom!
742 -- cannot have duplicates if we are going to use the array thing
743 rm_dups switches_so_far switch
744 = if switch `is_elem` switches_so_far
746 else switch : switches_so_far
748 sw `is_elem` [] = False
749 sw `is_elem` (s:ss) = (tagOf_SimplSwitch sw) ==# (tagOf_SimplSwitch s)
754 %************************************************************************
756 \subsection{Misc functions for command-line options}
758 %************************************************************************
762 switchIsOn :: (switch -> SwitchResult) -> switch -> Bool
764 switchIsOn lookup_fn switch
765 = case (lookup_fn switch) of
766 SwBool False -> False
769 intSwitchSet :: (switch -> SwitchResult)
773 intSwitchSet lookup_fn switch
774 = case (lookup_fn (switch (panic "intSwitchSet"))) of
775 SwInt int -> Just int
780 startsWith :: String -> String -> Maybe String
781 -- startsWith pfx (pfx++rest) = Just rest
783 startsWith [] str = Just str
784 startsWith (c:cs) (s:ss)
785 = if c /= s then Nothing else startsWith cs ss
786 startsWith _ [] = Nothing
788 endsWith :: String -> String -> Maybe String
790 = case (startsWith (reverse cs) (reverse ss)) of
792 Just rs -> Just (reverse rs)