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,
88 opt_UF_CreationThreshold,
90 opt_UF_FunAppDiscount,
99 opt_EnsureSplittableC,
104 opt_IgnoreIfacePragmas,
107 opt_OmitInterfacePragmas,
115 #include "HsVersions.h"
117 import Array ( array, (//) )
119 import IOExts ( IORef, readIORef, writeIORef )
120 import Constants -- Default values for some flags
125 import Maybes ( firstJust )
126 import Panic ( panic )
128 #if __GLASGOW_HASKELL__ < 301
129 import ArrBase ( Array(..) )
131 import PrelArr ( Array(..) )
135 %************************************************************************
137 \subsection{Command-line options}
139 %************************************************************************
141 The hsc command-line options are split into two categories:
146 Static flags are represented by top-level values of type Bool or Int,
147 for example. They therefore have the same value throughout the
150 Dynamic flags are represented by an abstract type, DynFlags, which is
151 passed into hsc by the compilation manager for every compilation.
152 Dynamic flags are those that change on a per-compilation basis,
153 perhaps because they may be present in the OPTIONS pragma at the top
156 Other flag-related blurb:
158 A list of {\em ToDo}s is things to be done in a particular part of
159 processing. A (fictitious) example for the Core-to-Core simplifier
160 might be: run the simplifier, then run the strictness analyser, then
161 run the simplifier again (three ``todos'').
163 There are three ``to-do processing centers'' at the moment. In the
164 main loop (\tr{main/Main.lhs}), in the Core-to-Core processing loop
165 (\tr{simplCore/SimplCore.lhs), and in the STG-to-STG processing loop
166 (\tr{simplStg/SimplStg.lhs}).
168 %************************************************************************
170 \subsection{Datatypes associated with command-line options}
172 %************************************************************************
176 = SwBool Bool -- on/off
177 | SwString FAST_STRING -- nothing or a String
178 | SwInt Int -- nothing or an Int
182 data CoreToDo -- These are diff core-to-core passes,
183 -- which may be invoked in any order,
184 -- as many times as you like.
186 = CoreDoSimplify -- The core-to-core simplifier.
187 (SimplifierSwitch -> SwitchResult)
188 -- Each run of the simplifier can take a different
189 -- set of simplifier-specific flags.
191 | CoreDoFloatOutwards Bool -- True <=> float lambdas to top level
196 | CoreDoWorkerWrapper
204 | CoreDoNothing -- useful when building up lists of these things
209 = StgDoMassageForProfiling -- should be (next to) last
210 -- There's also setStgVarInfo, but its absolute "lastness"
211 -- is so critical that it is hardwired in (no flag).
216 data SimplifierSwitch
217 = MaxSimplifierIterations Int
218 | SimplInlinePhase Int
224 %************************************************************************
226 \subsection{Dynamic command-line options}
228 %************************************************************************
241 | Opt_D_dump_inlinings
242 | Opt_D_dump_occur_anal
247 | Opt_D_dump_simpl_iterations
257 | Opt_D_dump_worker_wrapper
258 | Opt_D_dump_rn_trace
259 | Opt_D_dump_rn_stats
261 | Opt_D_dump_simpl_stats
262 | Opt_D_dump_tc_trace
265 | Opt_D_verbose_core2core
266 | Opt_D_verbose_stg2stg
268 | Opt_D_dump_hi_diffs
269 | Opt_D_dump_minimal_imports
274 | Opt_WarnDuplicateExports
276 | Opt_WarnIncompletePatterns
277 | Opt_WarnMissingFields
278 | Opt_WarnMissingMethods
279 | Opt_WarnMissingSigs
280 | Opt_WarnNameShadowing
281 | Opt_WarnOverlappingPatterns
282 | Opt_WarnSimplePatterns
283 | Opt_WarnTypeDefaults
284 | Opt_WarnUnusedBinds
285 | Opt_WarnUnusedImports
286 | Opt_WarnUnusedMatches
287 | Opt_WarnDeprecations
291 | Opt_AllowOverlappingInstances
292 | Opt_AllowUndecidableInstances
295 | Opt_NoImplicitPrelude
299 data DynFlags = DynFlags {
300 coreToDo :: [CoreToDo],
301 stgToDo :: [StgToDo],
303 hscOutName :: String, -- name of the output file
304 hscStubHOutName :: String, -- name of the .stub_h output file
305 hscStubCOutName :: String, -- name of the .stub_c output file
306 extCoreName :: String, -- name of the .core output file
307 verbosity :: Int, -- verbosity level
308 cppFlag :: Bool, -- preprocess with cpp?
309 stolen_x86_regs :: Int,
310 cmdlineHcIncludes :: [String], -- -#includes
312 -- options for particular phases
331 defaultDynFlags = DynFlags {
332 coreToDo = [], stgToDo = [],
335 hscStubHOutName = "", hscStubCOutName = "",
340 cmdlineHcIncludes = [],
346 flags = standardWarnings,
352 0 | print errors & warnings only
353 1 | minimal verbosity: print "compiling M ... done." for each module.
354 2 | equivalent to -dshow-passes
355 3 | equivalent to existing "ghc -v"
356 4 | "ghc -v -ddump-most"
357 5 | "ghc -v -ddump-all"
360 dopt :: DynFlag -> DynFlags -> Bool
361 dopt f dflags = f `elem` (flags dflags)
363 dopt_CoreToDo :: DynFlags -> [CoreToDo]
364 dopt_CoreToDo = coreToDo
366 dopt_StgToDo :: DynFlags -> [StgToDo]
367 dopt_StgToDo = stgToDo
369 dopt_OutName :: DynFlags -> String
370 dopt_OutName = hscOutName
372 dopt_HscLang :: DynFlags -> HscLang
373 dopt_HscLang = hscLang
375 dopt_set :: DynFlags -> DynFlag -> DynFlags
376 dopt_set dfs f = dfs{ flags = f : flags dfs }
378 dopt_unset :: DynFlags -> DynFlag -> DynFlags
379 dopt_unset dfs f = dfs{ flags = filter (/= f) (flags dfs) }
382 -----------------------------------------------------------------------------
383 -- Mess about with the mutable variables holding the dynamic arguments
386 -- is the "baseline" dynamic flags, initialised from
387 -- the defaults and command line options, and updated by the
388 -- ':s' command in GHCi.
391 -- is the dynamic flags for the current compilation. It is reset
392 -- to the value of v_InitDynFlags before each compilation, then
393 -- updated by reading any OPTIONS pragma in the current module.
396 GLOBAL_VAR(v_InitDynFlags, defaultDynFlags, DynFlags)
397 GLOBAL_VAR(v_DynFlags, defaultDynFlags, DynFlags)
399 setDynFlags :: DynFlags -> IO ()
400 setDynFlags dfs = writeIORef v_DynFlags dfs
402 saveDynFlags :: IO ()
403 saveDynFlags = do dfs <- readIORef v_DynFlags
404 writeIORef v_InitDynFlags dfs
406 restoreDynFlags :: IO DynFlags
407 restoreDynFlags = do dfs <- readIORef v_InitDynFlags
408 writeIORef v_DynFlags dfs
411 getDynFlags :: IO DynFlags
412 getDynFlags = readIORef v_DynFlags
414 updDynFlags :: (DynFlags -> DynFlags) -> IO ()
415 updDynFlags f = do dfs <- readIORef v_DynFlags
416 writeIORef v_DynFlags (f dfs)
418 dynFlag :: (DynFlags -> a) -> IO a
419 dynFlag f = do dflags <- readIORef v_DynFlags; return (f dflags)
421 setDynFlag, unSetDynFlag :: DynFlag -> IO ()
422 setDynFlag f = updDynFlags (\dfs -> dopt_set dfs f)
423 unSetDynFlag f = updDynFlags (\dfs -> dopt_unset dfs f)
427 %************************************************************************
429 \subsection{Warnings}
431 %************************************************************************
435 = [ Opt_WarnDeprecations,
436 Opt_WarnOverlappingPatterns,
437 Opt_WarnMissingFields,
438 Opt_WarnMissingMethods,
439 Opt_WarnDuplicateExports
443 = standardWarnings ++
444 [ Opt_WarnUnusedBinds,
445 Opt_WarnUnusedMatches,
446 Opt_WarnUnusedImports,
447 Opt_WarnIncompletePatterns,
453 [ Opt_WarnTypeDefaults,
454 Opt_WarnNameShadowing,
460 %************************************************************************
462 \subsection{Classifying command-line options}
464 %************************************************************************
467 -- v_Statis_hsc_opts is here to avoid a circular dependency with
469 GLOBAL_VAR(v_Static_hsc_opts, [], [String])
471 lookUp :: FAST_STRING -> Bool
472 lookup_int :: String -> Maybe Int
473 lookup_def_int :: String -> Int -> Int
474 lookup_def_float :: String -> Float -> Float
475 lookup_str :: String -> Maybe String
477 unpacked_static_opts = unsafePerformIO (readIORef v_Static_hsc_opts)
478 packed_static_opts = map _PK_ unpacked_static_opts
480 lookUp sw = sw `elem` packed_static_opts
482 lookup_str sw = firstJust (map (startsWith sw) unpacked_static_opts)
484 lookup_int sw = case (lookup_str sw) of
486 Just xx -> Just (read xx)
488 lookup_def_int sw def = case (lookup_str sw) of
489 Nothing -> def -- Use default
492 lookup_def_float sw def = case (lookup_str sw) of
493 Nothing -> def -- Use default
498 Putting the compiler options into temporary at-files
499 may turn out to be necessary later on if we turn hsc into
500 a pure Win32 application where I think there's a command-line
501 length limit of 255. unpacked_opts understands the @ option.
503 unpacked_opts :: [String]
507 map _UNPK_ argv -- NOT ARGV any more: v_Static_hsc_opts
509 expandAts ('@':fname) = words (unsafePerformIO (readFile fname))
514 %************************************************************************
516 \subsection{Static options}
518 %************************************************************************
522 opt_PprStyle_NoPrags = lookUp SLIT("-dppr-noprags")
523 opt_PprStyle_Debug = lookUp SLIT("-dppr-debug")
524 opt_PprStyle_RawTypes = lookUp SLIT("-dppr-rawtypes")
525 opt_PprUserLength = lookup_def_int "-dppr-user-length" 5 --ToDo: give this a name
528 opt_AutoSccsOnAllToplevs = lookUp SLIT("-fauto-sccs-on-all-toplevs")
529 opt_AutoSccsOnExportedToplevs = lookUp SLIT("-fauto-sccs-on-exported-toplevs")
530 opt_AutoSccsOnIndividualCafs = lookUp SLIT("-fauto-sccs-on-individual-cafs")
531 opt_AutoSccsOnDicts = lookUp SLIT("-fauto-sccs-on-dicts")
532 opt_SccProfilingOn = lookUp SLIT("-fscc-profiling")
533 opt_DoTickyProfiling = lookUp SLIT("-fticky-ticky")
536 opt_AllStrict = lookUp SLIT("-fall-strict")
537 opt_NoMonomorphismRestriction = lookUp SLIT("-fno-monomorphism-restriction")
538 opt_DictsStrict = lookUp SLIT("-fdicts-strict")
539 opt_IrrefutableTuples = lookUp SLIT("-firrefutable-tuples")
540 opt_MaxContextReductionDepth = lookup_def_int "-fcontext-stack" mAX_CONTEXT_REDUCTION_DEPTH
541 opt_NumbersStrict = lookUp SLIT("-fnumbers-strict")
542 opt_Parallel = lookUp SLIT("-fparallel")
543 opt_SMP = lookUp SLIT("-fsmp")
546 opt_NoMethodSharing = lookUp SLIT("-fno-method-sharing")
547 opt_DoSemiTagging = lookUp SLIT("-fsemi-tagging")
548 opt_FoldrBuildOn = lookUp SLIT("-ffoldr-build-on")
549 opt_LiberateCaseThreshold = lookup_def_int "-fliberate-case-threshold" (10::Int)
550 opt_StgDoLetNoEscapes = lookUp SLIT("-flet-no-escape")
551 opt_UnfoldCasms = lookUp SLIT("-funfold-casms-in-hi-file")
552 opt_UsageSPOn = lookUp SLIT("-fusagesp-on")
553 opt_UnboxStrictFields = lookUp SLIT("-funbox-strict-fields")
556 The optional '-inpackage=P' flag tells what package
557 we are compiling this module for.
558 The Prelude, for example is compiled with '-inpackage std'
560 opt_InPackage = case lookup_str "-inpackage=" of
562 Nothing -> SLIT("Main") -- The package name if none is specified
564 opt_EmitCExternDecls = lookUp SLIT("-femit-extern-decls")
565 opt_EnsureSplittableC = lookUp SLIT("-fglobalise-toplev-names")
566 opt_GranMacros = lookUp SLIT("-fgransim")
567 opt_HiVersion = read cProjectVersionInt :: Int
568 opt_HistorySize = lookup_def_int "-fhistory-size" 20
569 opt_IgnoreAsserts = lookUp SLIT("-fignore-asserts")
570 opt_IgnoreIfacePragmas = lookUp SLIT("-fignore-interface-pragmas")
571 opt_NoHiCheck = lookUp SLIT("-fno-hi-version-check")
572 opt_OmitBlackHoling = lookUp SLIT("-dno-black-holing")
573 opt_OmitInterfacePragmas = lookUp SLIT("-fomit-interface-pragmas")
574 opt_RuntimeTypes = lookUp SLIT("-fruntime-types")
576 -- Simplifier switches
577 opt_SimplNoPreInlining = lookUp SLIT("-fno-pre-inlining")
578 -- NoPreInlining is there just to see how bad things
579 -- get if you don't do it!
580 opt_SimplDoEtaReduction = lookUp SLIT("-fdo-eta-reduction")
581 opt_SimplDoLambdaEtaExpansion = lookUp SLIT("-fdo-lambda-eta-expansion")
582 opt_SimplCaseMerge = lookUp SLIT("-fcase-merge")
583 opt_SimplExcessPrecision = lookUp SLIT("-fexcess-precision")
586 opt_UF_CreationThreshold = lookup_def_int "-funfolding-creation-threshold" (45::Int)
587 opt_UF_UseThreshold = lookup_def_int "-funfolding-use-threshold" (8::Int) -- Discounts can be big
588 opt_UF_FunAppDiscount = lookup_def_int "-funfolding-fun-discount" (6::Int) -- It's great to inline a fn
589 opt_UF_KeenessFactor = lookup_def_float "-funfolding-keeness-factor" (1.5::Float)
590 opt_UF_UpdateInPlace = lookUp SLIT("-funfolding-update-in-place")
592 opt_UF_CheapOp = ( 1 :: Int) -- Only one instruction; and the args are charged for
593 opt_UF_DearOp = ( 4 :: Int)
595 opt_NoPruneDecls = lookUp SLIT("-fno-prune-decls")
596 opt_NoPruneTyDecls = lookUp SLIT("-fno-prune-tydecls")
597 opt_Static = lookUp SLIT("-static")
598 opt_Unregisterised = lookUp SLIT("-funregisterised")
599 opt_EmitExternalCore = lookUp SLIT("-fext-core")
602 %************************************************************************
604 \subsection{List of static hsc flags}
606 %************************************************************************
611 "fauto-sccs-on-all-toplevs",
612 "fauto-sccs-on-exported-toplevs",
613 "fauto-sccs-on-individual-cafs",
614 "fauto-sccs-on-dicts",
619 "firrefutable-tuples",
626 "funfold-casms-in-hi-file",
628 "funbox-strict-fields",
629 "femit-extern-decls",
630 "fglobalise-toplev-names",
633 "fignore-interface-pragmas",
634 "fno-hi-version-check",
636 "fno-method-sharing",
637 "fno-monomorphism-restriction",
638 "fomit-interface-pragmas",
642 "fdo-lambda-eta-expansion",
645 "funfolding-update-in-place",
652 || any (flip prefixMatch f) [
654 "fliberate-case-threshold",
656 "funfolding-creation-threshold",
657 "funfolding-use-threshold",
658 "funfolding-fun-discount",
659 "funfolding-keeness-factor"
663 %************************************************************************
665 \subsection{Switch ordering}
667 %************************************************************************
669 These things behave just like enumeration types.
672 instance Eq SimplifierSwitch where
673 a == b = tagOf_SimplSwitch a ==# tagOf_SimplSwitch b
675 instance Ord SimplifierSwitch where
676 a < b = tagOf_SimplSwitch a <# tagOf_SimplSwitch b
677 a <= b = tagOf_SimplSwitch a <=# tagOf_SimplSwitch b
680 tagOf_SimplSwitch (SimplInlinePhase _) = _ILIT(1)
681 tagOf_SimplSwitch (MaxSimplifierIterations _) = _ILIT(2)
682 tagOf_SimplSwitch DontApplyRules = _ILIT(3)
683 tagOf_SimplSwitch SimplLetToCase = _ILIT(4)
684 tagOf_SimplSwitch NoCaseOfCase = _ILIT(5)
686 -- If you add anything here, be sure to change lAST_SIMPL_SWITCH_TAG, too!
688 lAST_SIMPL_SWITCH_TAG = 5
691 %************************************************************************
693 \subsection{Switch lookup}
695 %************************************************************************
698 isAmongSimpl :: [SimplifierSwitch] -> SimplifierSwitch -> SwitchResult
699 isAmongSimpl on_switches -- Switches mentioned later occur *earlier*
700 -- in the list; defaults right at the end.
702 tidied_on_switches = foldl rm_dups [] on_switches
703 -- The fold*l* ensures that we keep the latest switches;
704 -- ie the ones that occur earliest in the list.
706 sw_tbl :: Array Int SwitchResult
707 sw_tbl = (array (0, lAST_SIMPL_SWITCH_TAG) -- bounds...
711 all_undefined = [ (i, SwBool False) | i <- [0 .. lAST_SIMPL_SWITCH_TAG ] ]
713 defined_elems = map mk_assoc_elem tidied_on_switches
715 -- (avoid some unboxing, bounds checking, and other horrible things:)
716 #if __GLASGOW_HASKELL__ < 405
717 case sw_tbl of { Array bounds_who_needs_'em stuff ->
719 case sw_tbl of { Array _ _ stuff ->
722 case (indexArray# stuff (tagOf_SimplSwitch switch)) of
723 #if __GLASGOW_HASKELL__ < 400
725 #elif __GLASGOW_HASKELL__ < 403
732 mk_assoc_elem k@(MaxSimplifierIterations lvl)
733 = (iBox (tagOf_SimplSwitch k), SwInt lvl)
734 mk_assoc_elem k@(SimplInlinePhase n)
735 = (iBox (tagOf_SimplSwitch k), SwInt n)
737 = (iBox (tagOf_SimplSwitch k), SwBool True) -- I'm here, Mom!
739 -- cannot have duplicates if we are going to use the array thing
740 rm_dups switches_so_far switch
741 = if switch `is_elem` switches_so_far
743 else switch : switches_so_far
745 sw `is_elem` [] = False
746 sw `is_elem` (s:ss) = (tagOf_SimplSwitch sw) ==# (tagOf_SimplSwitch s)
751 %************************************************************************
753 \subsection{Misc functions for command-line options}
755 %************************************************************************
759 switchIsOn :: (switch -> SwitchResult) -> switch -> Bool
761 switchIsOn lookup_fn switch
762 = case (lookup_fn switch) of
763 SwBool False -> False
766 intSwitchSet :: (switch -> SwitchResult)
770 intSwitchSet lookup_fn switch
771 = case (lookup_fn (switch (panic "intSwitchSet"))) of
772 SwInt int -> Just int
777 startsWith :: String -> String -> Maybe String
778 -- startsWith pfx (pfx++rest) = Just rest
780 startsWith [] str = Just str
781 startsWith (c:cs) (s:ss)
782 = if c /= s then Nothing else startsWith cs ss
783 startsWith _ [] = Nothing
785 endsWith :: String -> String -> Maybe String
787 = case (startsWith (reverse cs) (reverse ss)) of
789 Just rs -> Just (reverse rs)