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
337 defaultDynFlags = DynFlags {
338 coreToDo = [], stgToDo = [],
341 hscStubHOutName = "", hscStubCOutName = "",
346 cmdlineHcIncludes = [],
356 flags = standardWarnings,
362 0 | print errors & warnings only
363 1 | minimal verbosity: print "compiling M ... done." for each module.
364 2 | equivalent to -dshow-passes
365 3 | equivalent to existing "ghc -v"
366 4 | "ghc -v -ddump-most"
367 5 | "ghc -v -ddump-all"
370 dopt :: DynFlag -> DynFlags -> Bool
371 dopt f dflags = f `elem` (flags dflags)
373 dopt_CoreToDo :: DynFlags -> [CoreToDo]
374 dopt_CoreToDo = coreToDo
376 dopt_StgToDo :: DynFlags -> [StgToDo]
377 dopt_StgToDo = stgToDo
379 dopt_OutName :: DynFlags -> String
380 dopt_OutName = hscOutName
382 dopt_HscLang :: DynFlags -> HscLang
383 dopt_HscLang = hscLang
385 dopt_set :: DynFlags -> DynFlag -> DynFlags
386 dopt_set dfs f = dfs{ flags = f : flags dfs }
388 dopt_unset :: DynFlags -> DynFlag -> DynFlags
389 dopt_unset dfs f = dfs{ flags = filter (/= f) (flags dfs) }
392 -----------------------------------------------------------------------------
393 -- Mess about with the mutable variables holding the dynamic arguments
396 -- is the "baseline" dynamic flags, initialised from
397 -- the defaults and command line options, and updated by the
398 -- ':s' command in GHCi.
401 -- is the dynamic flags for the current compilation. It is reset
402 -- to the value of v_InitDynFlags before each compilation, then
403 -- updated by reading any OPTIONS pragma in the current module.
406 GLOBAL_VAR(v_InitDynFlags, defaultDynFlags, DynFlags)
407 GLOBAL_VAR(v_DynFlags, defaultDynFlags, DynFlags)
409 setDynFlags :: DynFlags -> IO ()
410 setDynFlags dfs = writeIORef v_DynFlags dfs
412 saveDynFlags :: IO ()
413 saveDynFlags = do dfs <- readIORef v_DynFlags
414 writeIORef v_InitDynFlags dfs
416 restoreDynFlags :: IO DynFlags
417 restoreDynFlags = do dfs <- readIORef v_InitDynFlags
418 writeIORef v_DynFlags dfs
421 getDynFlags :: IO DynFlags
422 getDynFlags = readIORef v_DynFlags
424 updDynFlags :: (DynFlags -> DynFlags) -> IO ()
425 updDynFlags f = do dfs <- readIORef v_DynFlags
426 writeIORef v_DynFlags (f dfs)
428 dynFlag :: (DynFlags -> a) -> IO a
429 dynFlag f = do dflags <- readIORef v_DynFlags; return (f dflags)
431 setDynFlag, unSetDynFlag :: DynFlag -> IO ()
432 setDynFlag f = updDynFlags (\dfs -> dopt_set dfs f)
433 unSetDynFlag f = updDynFlags (\dfs -> dopt_unset dfs f)
437 %************************************************************************
439 \subsection{Warnings}
441 %************************************************************************
445 = [ Opt_WarnDeprecations,
446 Opt_WarnOverlappingPatterns,
447 Opt_WarnMissingFields,
448 Opt_WarnMissingMethods,
449 Opt_WarnDuplicateExports
453 = standardWarnings ++
454 [ Opt_WarnUnusedBinds,
455 Opt_WarnUnusedMatches,
456 Opt_WarnUnusedImports,
457 Opt_WarnIncompletePatterns,
463 [ Opt_WarnTypeDefaults,
464 Opt_WarnNameShadowing,
470 %************************************************************************
472 \subsection{Classifying command-line options}
474 %************************************************************************
477 -- v_Statis_hsc_opts is here to avoid a circular dependency with
479 GLOBAL_VAR(v_Static_hsc_opts, [], [String])
481 lookUp :: FAST_STRING -> Bool
482 lookup_int :: String -> Maybe Int
483 lookup_def_int :: String -> Int -> Int
484 lookup_def_float :: String -> Float -> Float
485 lookup_str :: String -> Maybe String
487 unpacked_static_opts = unsafePerformIO (readIORef v_Static_hsc_opts)
488 packed_static_opts = map _PK_ unpacked_static_opts
490 lookUp sw = sw `elem` packed_static_opts
492 lookup_str sw = firstJust (map (startsWith sw) unpacked_static_opts)
494 lookup_int sw = case (lookup_str sw) of
496 Just xx -> Just (read xx)
498 lookup_def_int sw def = case (lookup_str sw) of
499 Nothing -> def -- Use default
502 lookup_def_float sw def = case (lookup_str sw) of
503 Nothing -> def -- Use default
508 Putting the compiler options into temporary at-files
509 may turn out to be necessary later on if we turn hsc into
510 a pure Win32 application where I think there's a command-line
511 length limit of 255. unpacked_opts understands the @ option.
513 unpacked_opts :: [String]
517 map _UNPK_ argv -- NOT ARGV any more: v_Static_hsc_opts
519 expandAts ('@':fname) = words (unsafePerformIO (readFile fname))
524 %************************************************************************
526 \subsection{Static options}
528 %************************************************************************
532 opt_PprStyle_NoPrags = lookUp SLIT("-dppr-noprags")
533 opt_PprStyle_Debug = lookUp SLIT("-dppr-debug")
534 opt_PprStyle_RawTypes = lookUp SLIT("-dppr-rawtypes")
535 opt_PprUserLength = lookup_def_int "-dppr-user-length" 5 --ToDo: give this a name
538 opt_AutoSccsOnAllToplevs = lookUp SLIT("-fauto-sccs-on-all-toplevs")
539 opt_AutoSccsOnExportedToplevs = lookUp SLIT("-fauto-sccs-on-exported-toplevs")
540 opt_AutoSccsOnIndividualCafs = lookUp SLIT("-fauto-sccs-on-individual-cafs")
541 opt_AutoSccsOnDicts = lookUp SLIT("-fauto-sccs-on-dicts")
542 opt_SccProfilingOn = lookUp SLIT("-fscc-profiling")
543 opt_DoTickyProfiling = lookUp SLIT("-fticky-ticky")
546 opt_AllStrict = lookUp SLIT("-fall-strict")
547 opt_NoMonomorphismRestriction = lookUp SLIT("-fno-monomorphism-restriction")
548 opt_DictsStrict = lookUp SLIT("-fdicts-strict")
549 opt_IrrefutableTuples = lookUp SLIT("-firrefutable-tuples")
550 opt_MaxContextReductionDepth = lookup_def_int "-fcontext-stack" mAX_CONTEXT_REDUCTION_DEPTH
551 opt_NumbersStrict = lookUp SLIT("-fnumbers-strict")
552 opt_Parallel = lookUp SLIT("-fparallel")
553 opt_SMP = lookUp SLIT("-fsmp")
556 opt_NoMethodSharing = lookUp SLIT("-fno-method-sharing")
557 opt_DoSemiTagging = lookUp SLIT("-fsemi-tagging")
558 opt_FoldrBuildOn = lookUp SLIT("-ffoldr-build-on")
559 opt_LiberateCaseThreshold = lookup_def_int "-fliberate-case-threshold" (10::Int)
560 opt_StgDoLetNoEscapes = lookUp SLIT("-flet-no-escape")
561 opt_UnfoldCasms = lookUp SLIT("-funfold-casms-in-hi-file")
562 opt_UsageSPOn = lookUp SLIT("-fusagesp-on")
563 opt_UnboxStrictFields = lookUp SLIT("-funbox-strict-fields")
564 opt_MaxWorkerArgs = lookup_def_int "-fmax-worker-args" (10::Int)
567 The optional '-inpackage=P' flag tells what package
568 we are compiling this module for.
569 The Prelude, for example is compiled with '-inpackage std'
571 opt_InPackage = case lookup_str "-inpackage=" of
573 Nothing -> SLIT("Main") -- The package name if none is specified
575 opt_EmitCExternDecls = lookUp SLIT("-femit-extern-decls")
576 opt_EnsureSplittableC = lookUp SLIT("-fglobalise-toplev-names")
577 opt_GranMacros = lookUp SLIT("-fgransim")
578 opt_HiVersion = read cProjectVersionInt :: Int
579 opt_HistorySize = lookup_def_int "-fhistory-size" 20
580 opt_IgnoreAsserts = lookUp SLIT("-fignore-asserts")
581 opt_IgnoreIfacePragmas = lookUp SLIT("-fignore-interface-pragmas")
582 opt_NoHiCheck = lookUp SLIT("-fno-hi-version-check")
583 opt_OmitBlackHoling = lookUp SLIT("-dno-black-holing")
584 opt_OmitInterfacePragmas = lookUp SLIT("-fomit-interface-pragmas")
585 opt_RuntimeTypes = lookUp SLIT("-fruntime-types")
587 -- Simplifier switches
588 opt_SimplNoPreInlining = lookUp SLIT("-fno-pre-inlining")
589 -- NoPreInlining is there just to see how bad things
590 -- get if you don't do it!
591 opt_SimplDoEtaReduction = lookUp SLIT("-fdo-eta-reduction")
592 opt_SimplDoLambdaEtaExpansion = lookUp SLIT("-fdo-lambda-eta-expansion")
593 opt_SimplCaseMerge = lookUp SLIT("-fcase-merge")
594 opt_SimplExcessPrecision = lookUp SLIT("-fexcess-precision")
597 opt_UF_CreationThreshold = lookup_def_int "-funfolding-creation-threshold" (45::Int)
598 opt_UF_UseThreshold = lookup_def_int "-funfolding-use-threshold" (8::Int) -- Discounts can be big
599 opt_UF_FunAppDiscount = lookup_def_int "-funfolding-fun-discount" (6::Int) -- It's great to inline a fn
600 opt_UF_KeenessFactor = lookup_def_float "-funfolding-keeness-factor" (1.5::Float)
601 opt_UF_UpdateInPlace = lookUp SLIT("-funfolding-update-in-place")
603 opt_UF_CheapOp = ( 1 :: Int) -- Only one instruction; and the args are charged for
604 opt_UF_DearOp = ( 4 :: Int)
606 opt_NoPruneDecls = lookUp SLIT("-fno-prune-decls")
607 opt_NoPruneTyDecls = lookUp SLIT("-fno-prune-tydecls")
608 opt_Static = lookUp SLIT("-static")
609 opt_Unregisterised = lookUp SLIT("-funregisterised")
610 opt_EmitExternalCore = lookUp SLIT("-fext-core")
613 %************************************************************************
615 \subsection{List of static hsc flags}
617 %************************************************************************
622 "fauto-sccs-on-all-toplevs",
623 "fauto-sccs-on-exported-toplevs",
624 "fauto-sccs-on-individual-cafs",
625 "fauto-sccs-on-dicts",
630 "firrefutable-tuples",
637 "funfold-casms-in-hi-file",
639 "funbox-strict-fields",
640 "femit-extern-decls",
641 "fglobalise-toplev-names",
644 "fignore-interface-pragmas",
645 "fno-hi-version-check",
647 "fno-method-sharing",
648 "fno-monomorphism-restriction",
649 "fomit-interface-pragmas",
653 "fdo-lambda-eta-expansion",
656 "funfolding-update-in-place",
663 || any (flip prefixMatch f) [
665 "fliberate-case-threshold",
668 "funfolding-creation-threshold",
669 "funfolding-use-threshold",
670 "funfolding-fun-discount",
671 "funfolding-keeness-factor"
675 %************************************************************************
677 \subsection{Switch ordering}
679 %************************************************************************
681 These things behave just like enumeration types.
684 instance Eq SimplifierSwitch where
685 a == b = tagOf_SimplSwitch a ==# tagOf_SimplSwitch b
687 instance Ord SimplifierSwitch where
688 a < b = tagOf_SimplSwitch a <# tagOf_SimplSwitch b
689 a <= b = tagOf_SimplSwitch a <=# tagOf_SimplSwitch b
692 tagOf_SimplSwitch (SimplInlinePhase _) = _ILIT(1)
693 tagOf_SimplSwitch (MaxSimplifierIterations _) = _ILIT(2)
694 tagOf_SimplSwitch DontApplyRules = _ILIT(3)
695 tagOf_SimplSwitch SimplLetToCase = _ILIT(4)
696 tagOf_SimplSwitch NoCaseOfCase = _ILIT(5)
698 -- If you add anything here, be sure to change lAST_SIMPL_SWITCH_TAG, too!
700 lAST_SIMPL_SWITCH_TAG = 5
703 %************************************************************************
705 \subsection{Switch lookup}
707 %************************************************************************
710 isAmongSimpl :: [SimplifierSwitch] -> SimplifierSwitch -> SwitchResult
711 isAmongSimpl on_switches -- Switches mentioned later occur *earlier*
712 -- in the list; defaults right at the end.
714 tidied_on_switches = foldl rm_dups [] on_switches
715 -- The fold*l* ensures that we keep the latest switches;
716 -- ie the ones that occur earliest in the list.
718 sw_tbl :: Array Int SwitchResult
719 sw_tbl = (array (0, lAST_SIMPL_SWITCH_TAG) -- bounds...
723 all_undefined = [ (i, SwBool False) | i <- [0 .. lAST_SIMPL_SWITCH_TAG ] ]
725 defined_elems = map mk_assoc_elem tidied_on_switches
727 -- (avoid some unboxing, bounds checking, and other horrible things:)
728 #if __GLASGOW_HASKELL__ < 405
729 case sw_tbl of { Array bounds_who_needs_'em stuff ->
731 case sw_tbl of { Array _ _ stuff ->
734 case (indexArray# stuff (tagOf_SimplSwitch switch)) of
735 #if __GLASGOW_HASKELL__ < 400
737 #elif __GLASGOW_HASKELL__ < 403
744 mk_assoc_elem k@(MaxSimplifierIterations lvl)
745 = (iBox (tagOf_SimplSwitch k), SwInt lvl)
746 mk_assoc_elem k@(SimplInlinePhase n)
747 = (iBox (tagOf_SimplSwitch k), SwInt n)
749 = (iBox (tagOf_SimplSwitch k), SwBool True) -- I'm here, Mom!
751 -- cannot have duplicates if we are going to use the array thing
752 rm_dups switches_so_far switch
753 = if switch `is_elem` switches_so_far
755 else switch : switches_so_far
757 sw `is_elem` [] = False
758 sw `is_elem` (s:ss) = (tagOf_SimplSwitch sw) ==# (tagOf_SimplSwitch s)
763 %************************************************************************
765 \subsection{Misc functions for command-line options}
767 %************************************************************************
771 switchIsOn :: (switch -> SwitchResult) -> switch -> Bool
773 switchIsOn lookup_fn switch
774 = case (lookup_fn switch) of
775 SwBool False -> False
778 intSwitchSet :: (switch -> SwitchResult)
782 intSwitchSet lookup_fn switch
783 = case (lookup_fn (switch (panic "intSwitchSet"))) of
784 SwInt int -> Just int
789 startsWith :: String -> String -> Maybe String
790 -- startsWith pfx (pfx++rest) = Just rest
792 startsWith [] str = Just str
793 startsWith (c:cs) (s:ss)
794 = if c /= s then Nothing else startsWith cs ss
795 startsWith _ [] = Nothing
797 endsWith :: String -> String -> Maybe String
799 = case (startsWith (reverse cs) (reverse ss)) of
801 Just rs -> Just (reverse rs)