\section[WorkWrap]{Worker/wrapper-generating back-end of strictness analyser}
\begin{code}
-module WorkWrap ( wwTopBinds ) where
+module WorkWrap ( wwTopBinds, mkWrapper ) where
#include "HsVersions.h"
import CoreSyn
-import CoreUnfold ( Unfolding, certainlySmallEnoughToInline, calcUnfoldingGuidance )
-import CmdLineOpts ( opt_UF_CreationThreshold , opt_D_verbose_core2core,
- opt_D_dump_worker_wrapper
+import CoreUnfold ( certainlyWillInline )
+import CoreLint ( showPass, endPass )
+import CoreUtils ( exprType, exprIsValue )
+import Id ( Id, idType, isOneShotLambda,
+ setIdNewStrictness, mkWorkerId,
+ setIdWorkerInfo, setInlinePragma,
+ idInfo )
+import MkId ( lazyIdKey, lazyIdUnfolding )
+import Type ( Type )
+import IdInfo ( WorkerInfo(..), arityInfo,
+ newDemandInfo, newStrictnessInfo, unfoldingInfo, inlinePragInfo
)
-import CoreLint ( beginPass, endPass )
-import CoreUtils ( coreExprType )
-import Const ( Con(..) )
-import DataCon ( DataCon )
-import MkId ( mkWorkerId )
-import Id ( Id, getIdStrictness, setIdArity,
- setIdStrictness,
- setIdWorkerInfo, getIdCprInfo )
-import VarSet
-import Type ( isNewType )
-import IdInfo ( mkStrictnessInfo, noStrictnessInfo, StrictnessInfo(..),
- CprInfo(..), exactArity
+import NewDemand ( Demand(..), StrictSig(..), DmdType(..), DmdResult(..),
+ Demands(..), mkTopDmdType, isBotRes, returnsCPR, topSig, isAbsent
)
-import Demand ( wwLazy )
-import SaLib
import UniqSupply ( UniqSupply, initUs_, returnUs, thenUs, mapUs, getUniqueUs, UniqSM )
-import UniqSet
+import Unique ( hasKey )
+import BasicTypes ( RecFlag(..), isNonRec, Activation(..) )
+import VarEnv ( isEmptyVarEnv )
+import Maybes ( orElse )
+import CmdLineOpts
import WwLib
+import Util ( lengthIs, notNull )
import Outputable
\end{code}
\begin{code}
-wwTopBinds :: UniqSupply
- -> [CoreBind]
- -> IO [CoreBind]
+wwTopBinds :: DynFlags
+ -> UniqSupply
+ -> [CoreBind]
+ -> IO [CoreBind]
-wwTopBinds us binds
+wwTopBinds dflags us binds
= do {
- beginPass "Worker Wrapper binds";
+ showPass dflags "Worker Wrapper binds";
-- Create worker/wrappers, and mark binders with their
-- "strictness info" [which encodes their worker/wrapper-ness]
let { binds' = workersAndWrappers us binds };
- endPass "Worker Wrapper binds" (opt_D_dump_worker_wrapper ||
- opt_D_verbose_core2core) binds'
+ endPass dflags "Worker Wrapper binds"
+ Opt_D_dump_worker_wrapper binds'
}
\end{code}
workersAndWrappers us top_binds
= initUs_ us $
- mapUs (wwBind True{-top-level-}) top_binds `thenUs` \ top_binds2 ->
- let
- top_binds3 = map make_top_binding top_binds2
- in
- returnUs (concat top_binds3)
- where
- make_top_binding :: WwBinding -> [CoreBind]
-
- make_top_binding (WwLet binds) = binds
+ mapUs wwBind top_binds `thenUs` \ top_binds' ->
+ returnUs (concat top_binds')
\end{code}
%************************************************************************
turn. Non-recursive case first, then recursive...
\begin{code}
-wwBind :: Bool -- True <=> top-level binding
- -> CoreBind
- -> UniqSM WwBinding -- returns a WwBinding intermediate form;
+wwBind :: CoreBind
+ -> UniqSM [CoreBind] -- returns a WwBinding intermediate form;
-- the caller will convert to Expr/Binding,
-- as appropriate.
-wwBind top_level (NonRec binder rhs)
- = wwExpr rhs `thenUs` \ new_rhs ->
- tryWW True {- non-recursive -} binder new_rhs `thenUs` \ new_pairs ->
- returnUs (WwLet [NonRec b e | (b,e) <- new_pairs])
+wwBind (NonRec binder rhs)
+ = wwExpr rhs `thenUs` \ new_rhs ->
+ tryWW NonRecursive binder new_rhs `thenUs` \ new_pairs ->
+ returnUs [NonRec b e | (b,e) <- new_pairs]
-- Generated bindings must be non-recursive
-- because the original binding was.
-------------------------------
-
-wwBind top_level (Rec pairs)
+wwBind (Rec pairs)
= mapUs do_one pairs `thenUs` \ new_pairs ->
- returnUs (WwLet [Rec (concat new_pairs)])
+ returnUs [Rec (concat new_pairs)]
where
do_one (binder, rhs) = wwExpr rhs `thenUs` \ new_rhs ->
- tryWW False {- recursive -} binder new_rhs
+ tryWW Recursive binder new_rhs
\end{code}
@wwExpr@ basically just walks the tree, looking for appropriate
annotations that can be used. Remember it is @wwBind@ that does the
matching by looking for strict arguments of the correct type.
@wwExpr@ is a version that just returns the ``Plain'' Tree.
-???????????????? ToDo
\begin{code}
wwExpr :: CoreExpr -> UniqSM CoreExpr
-wwExpr e@(Type _) = returnUs e
-wwExpr e@(Var _) = returnUs e
+wwExpr e@(Type _) = returnUs e
+wwExpr e@(Lit _) = returnUs e
+wwExpr e@(Note InlineMe expr) = returnUs e
+ -- Don't w/w inside InlineMe's
-wwExpr e@(Con con args)
- = mapUs wwExpr args `thenUs` \ args' ->
- returnUs (Con con args')
+wwExpr e@(Var v)
+ | v `hasKey` lazyIdKey = returnUs lazyIdUnfolding
+ | otherwise = returnUs e
+ -- Inline 'lazy' after strictness analysis
+ -- (but not inside InlineMe's)
wwExpr (Lam binder expr)
= wwExpr expr `thenUs` \ new_expr ->
returnUs (Note note new_expr)
wwExpr (Let bind expr)
- = wwBind False{-not top-level-} bind `thenUs` \ intermediate_bind ->
- wwExpr expr `thenUs` \ new_expr ->
- returnUs (mash_ww_bind intermediate_bind new_expr)
- where
- mash_ww_bind (WwLet binds) body = mkLets binds body
- mash_ww_bind (WwCase case_fn) body = case_fn body
+ = wwBind bind `thenUs` \ intermediate_bind ->
+ wwExpr expr `thenUs` \ new_expr ->
+ returnUs (mkLets intermediate_bind new_expr)
wwExpr (Case expr binder alts)
= wwExpr expr `thenUs` \ new_expr ->
The only reason this is monadised is for the unique supply.
\begin{code}
-tryWW :: Bool -- True <=> a non-recursive binding
+tryWW :: RecFlag
-> Id -- The fn binder
-> CoreExpr -- The bound rhs; its innards
-- are already ww'd
-- the orig "wrapper" lives on);
-- if two, then a worker and a
-- wrapper.
-tryWW non_rec fn_id rhs
- | (non_rec && -- Don't split if its non-recursive and small
- certainlySmallEnoughToInline (calcUnfoldingGuidance opt_UF_CreationThreshold rhs) &&
- -- No point in worker/wrappering something that is going to be
+tryWW is_rec fn_id rhs
+ | isNonRec is_rec && certainlyWillInline unfolding
+ -- No point in worker/wrappering a function that is going to be
-- INLINEd wholesale anyway. If the strictness analyser is run
-- twice, this test also prevents wrappers (which are INLINEd)
-- from being re-done.
+ --
+ -- It's very important to refrain from w/w-ing an INLINE function
+ -- If we do so by mistake we transform
+ -- f = __inline (\x -> E)
+ -- into
+ -- f = __inline (\x -> case x of (a,b) -> fw E)
+ -- fw = \ab -> (__inline (\x -> E)) (a,b)
+ -- and the original __inline now vanishes, so E is no longer
+ -- inside its __inline wrapper. Death! Disaster!
+ = returnUs [ (new_fn_id, rhs) ]
+
+ | is_thunk && worthSplittingThunk maybe_fn_dmd res_info
+ = ASSERT2( isNonRec is_rec, ppr new_fn_id ) -- The thunk must be non-recursive
+ splitThunk new_fn_id rhs
+
+ | is_fun && worthSplittingFun wrap_dmds res_info
+ = splitFun new_fn_id fn_info wrap_dmds res_info inline_prag rhs
+
+ | otherwise
+ = returnUs [ (new_fn_id, rhs) ]
- not (null wrap_args && do_coerce_ww)
- -- However, if we have f = coerce T E
- -- then we want to w/w anyway, to get
- -- fw = E
- -- f = coerce T fw
- -- We want to do this even if the binding is small and non-rec.
- -- Reason: I've seen this situation:
- -- let f = coerce T (\s -> E)
- -- in \x -> case x of
- -- p -> coerce T' f
- -- q -> \s -> E2
- -- If only we w/w'd f, we'd inline the coerce (because it's trivial)
- -- to get
- -- let fw = \s -> E
- -- in \x -> case x of
- -- p -> fw
- -- q -> \s -> E2
- -- Now we'll see that fw has arity 1, and will arity expand
- -- the \x to get what we want.
- )
-
- || not (do_strict_ww || do_cpr_ww || do_coerce_ww)
- = returnUs [ (fn_id, rhs) ]
-
- | otherwise -- Do w/w split
- = mkWwBodies tyvars wrap_args
- body_ty
- wrap_demands
- cpr_info
- `thenUs` \ (wrap_fn, work_fn, work_demands) ->
- getUniqueUs `thenUs` \ work_uniq ->
+ where
+ fn_info = idInfo fn_id
+ maybe_fn_dmd = newDemandInfo fn_info
+ unfolding = unfoldingInfo fn_info
+ inline_prag = inlinePragInfo fn_info
+ maybe_sig = newStrictnessInfo fn_info
+
+ -- In practice it always will have a strictness
+ -- signature, even if it's a uninformative one
+ strict_sig = newStrictnessInfo fn_info `orElse` topSig
+ StrictSig (DmdType env wrap_dmds res_info) = strict_sig
+
+ -- new_fn_id has the DmdEnv zapped.
+ -- (a) it is never used again
+ -- (b) it wastes space
+ -- (c) it becomes incorrect as things are cloned, because
+ -- we don't push the substitution into it
+ new_fn_id | isEmptyVarEnv env = fn_id
+ | otherwise = fn_id `setIdNewStrictness`
+ StrictSig (mkTopDmdType wrap_dmds res_info)
+
+ is_fun = notNull wrap_dmds
+ is_thunk = not is_fun && not (exprIsValue rhs)
+
+---------------------
+splitFun fn_id fn_info wrap_dmds res_info inline_prag rhs
+ = WARN( not (wrap_dmds `lengthIs` arity), ppr fn_id <+> (ppr arity $$ ppr wrap_dmds $$ ppr res_info) )
+ -- The arity should match the signature
+ mkWwBodies fun_ty wrap_dmds res_info one_shots `thenUs` \ (work_demands, wrap_fn, work_fn) ->
+ getUniqueUs `thenUs` \ work_uniq ->
let
- work_rhs = work_fn body
- work_id = mkWorkerId work_uniq fn_id (coreExprType work_rhs) `setIdStrictness`
- (if has_strictness_info then mkStrictnessInfo (work_demands ++ remaining_arg_demands, result_bot)
- else noStrictnessInfo)
+ work_rhs = work_fn rhs
+ work_id = mkWorkerId work_uniq fn_id (exprType work_rhs)
+ `setInlinePragma` inline_prag
+ `setIdNewStrictness` StrictSig (mkTopDmdType work_demands work_res_info)
+ -- Even though we may not be at top level,
+ -- it's ok to give it an empty DmdEnv
wrap_rhs = wrap_fn work_id
- wrap_id = fn_id `setIdStrictness`
- (if has_strictness_info then mkStrictnessInfo (wrap_demands ++ remaining_arg_demands, result_bot)
- else noStrictnessInfo)
- `setIdWorkerInfo` Just work_id
- `setIdArity` exactArity (length wrap_args)
- -- Add info to the wrapper:
- -- (a) we want to inline it everywhere
- -- (b) we want to pin on its revised strictness info
- -- (c) we pin on its worker id
+ wrap_id = fn_id `setIdWorkerInfo` HasWorker work_id arity
+ `setInlinePragma` AlwaysActive -- Zap any inline pragma;
+ -- Put it on the worker instead
in
returnUs ([(work_id, work_rhs), (wrap_id, wrap_rhs)])
-- Worker first, because wrapper mentions it
+ -- mkWwBodies has already built a wrap_rhs with an INLINE pragma wrapped around it
where
- (tyvars, wrap_args, body) = collectTyAndValBinders rhs
- n_wrap_args = length wrap_args
- body_ty = coreExprType body
- strictness_info = getIdStrictness fn_id
- has_strictness_info = case strictness_info of
- StrictnessInfo _ _ -> True
- other -> False
-
- StrictnessInfo arg_demands result_bot = strictness_info
-
- -- NB: There maybe be more items in arg_demands than wrap_args, because
- -- the strictness info is semantic and looks through InlineMe and Scc
- -- Notes, whereas wrap_args does not
- demands_for_visible_args = take n_wrap_args arg_demands
- remaining_arg_demands = drop n_wrap_args arg_demands
-
- wrap_demands | has_strictness_info = setUnpackStrategy demands_for_visible_args
- | otherwise = repeat wwLazy
-
- do_strict_ww = has_strictness_info && worthSplitting wrap_demands result_bot
-
- -------------------------------------------------------------
- cpr_info = getIdCprInfo fn_id
- has_cpr_info = case cpr_info of
- CPRInfo _ -> True
- other -> False
-
- do_cpr_ww = has_cpr_info
-
- -------------------------------------------------------------
- -- Do the coercion thing if the body is of a newtype
- do_coerce_ww = isNewType body_ty
-
-
-{- July 99: removed again by Simon
-
--- This rather (nay! extremely!) crude function looks at a wrapper function, and
--- snaffles out the worker Id from the wrapper.
--- This is needed when we write an interface file.
--- [May 1999: we used to get the constructors too, but that's no longer
--- necessary, because the renamer hauls in all type decls in
--- their fullness.]
-
--- <Mar 1999 (keving)> - Well, since the addition of the CPR transformation this function
--- got too crude!
--- Now the worker id is stored directly in the id's Info field. We still use this function to
--- snaffle the wrapper's constructors but I don't trust the code to find the worker id.
-getWorkerId :: Id -> CoreExpr -> Id
-getWorkerId wrap_id wrapper_fn
- = work_id wrapper_fn
+ fun_ty = idType fn_id
+
+ arity = arityInfo fn_info -- The arity is set by the simplifier using exprEtaExpandArity
+ -- So it may be more than the number of top-level-visible lambdas
+
+ work_res_info | isBotRes res_info = BotRes -- Cpr stuff done by wrapper
+ | otherwise = TopRes
+
+ one_shots = get_one_shots rhs
+
+-- If the original function has one-shot arguments, it is important to
+-- make the wrapper and worker have corresponding one-shot arguments too.
+-- Otherwise we spuriously float stuff out of case-expression join points,
+-- which is very annoying.
+get_one_shots (Lam b e)
+ | isId b = isOneShotLambda b : get_one_shots e
+ | otherwise = get_one_shots e
+get_one_shots (Note _ e) = get_one_shots e
+get_one_shots other = noOneShotInfo
+\end{code}
+
+Thunk splitting
+~~~~~~~~~~~~~~~
+Suppose x is used strictly (never mind whether it has the CPR
+property).
+
+ let
+ x* = x-rhs
+ in body
+
+splitThunk transforms like this:
+
+ let
+ x* = case x-rhs of { I# a -> I# a }
+ in body
+
+Now simplifier will transform to
+
+ case x-rhs of
+ I# a -> let x* = I# b
+ in body
+
+which is what we want. Now suppose x-rhs is itself a case:
+
+ x-rhs = case e of { T -> I# a; F -> I# b }
+
+The join point will abstract over a, rather than over (which is
+what would have happened before) which is fine.
+
+Notice that x certainly has the CPR property now!
+
+In fact, splitThunk uses the function argument w/w splitting
+function, so that if x's demand is deeper (say U(U(L,L),L))
+then the splitting will go deeper too.
+
+\begin{code}
+-- splitThunk converts the *non-recursive* binding
+-- x = e
+-- into
+-- x = let x = e
+-- in case x of
+-- I# y -> let x = I# y in x }
+-- See comments above. Is it not beautifully short?
+
+splitThunk fn_id rhs
+ = mkWWstr [fn_id] `thenUs` \ (_, wrap_fn, work_fn) ->
+ returnUs [ (fn_id, Let (NonRec fn_id rhs) (wrap_fn (work_fn (Var fn_id)))) ]
+\end{code}
+
+
+%************************************************************************
+%* *
+\subsection{Functions over Demands}
+%* *
+%************************************************************************
+
+\begin{code}
+worthSplittingFun :: [Demand] -> DmdResult -> Bool
+ -- True <=> the wrapper would not be an identity function
+worthSplittingFun ds res
+ = any worth_it ds || returnsCPR res
+ -- worthSplitting returns False for an empty list of demands,
+ -- and hence do_strict_ww is False if arity is zero and there is no CPR
+
+ -- We used not to split if the result is bottom.
+ -- [Justification: there's no efficiency to be gained.]
+ -- But it's sometimes bad not to make a wrapper. Consider
+ -- fw = \x# -> let x = I# x# in case e of
+ -- p1 -> error_fn x
+ -- p2 -> error_fn x
+ -- p3 -> the real stuff
+ -- The re-boxing code won't go away unless error_fn gets a wrapper too.
+ -- [We don't do reboxing now, but in general it's better to pass
+ -- an unboxed thing to f, and have it reboxed in the error cases....]
+ where
+ worth_it Abs = True -- Absent arg
+ worth_it (Eval (Prod ds)) = True -- Product arg to evaluate
+ worth_it other = False
+
+worthSplittingThunk :: Maybe Demand -- Demand on the thunk
+ -> DmdResult -- CPR info for the thunk
+ -> Bool
+worthSplittingThunk maybe_dmd res
+ = worth_it maybe_dmd || returnsCPR res
where
+ -- Split if the thing is unpacked
+ worth_it (Just (Eval (Prod ds))) = not (all isAbsent ds)
+ worth_it other = False
+\end{code}
+
+
+
+%************************************************************************
+%* *
+\subsection{The worker wrapper core}
+%* *
+%************************************************************************
+
+@mkWrapper@ is called when importing a function. We have the type of
+the function and the name of its worker, and we want to make its body (the wrapper).
+
+\begin{code}
+mkWrapper :: Type -- Wrapper type
+ -> StrictSig -- Wrapper strictness info
+ -> UniqSM (Id -> CoreExpr) -- Wrapper body, missing worker Id
+
+mkWrapper fun_ty (StrictSig (DmdType _ demands res_info))
+ = mkWwBodies fun_ty demands res_info noOneShotInfo `thenUs` \ (_, wrap_fn, _) ->
+ returnUs wrap_fn
- work_id wrapper_fn
- = case get_work_id wrapper_fn of
- [] -> case work_id_try2 wrapper_fn of
- [] -> pprPanic "getWorkerId: can't find worker id" (ppr wrap_id)
- [id] -> id
- _ -> pprPanic "getWorkerId: found too many worker ids" (ppr wrap_id)
- [id] -> id
- _ -> pprPanic "getWorkerId: found too many worker ids" (ppr wrap_id)
-
- get_work_id (Lam _ body) = get_work_id body
- get_work_id (Case _ _ [(_,_,rhs@(Case _ _ _))]) = get_work_id rhs
- get_work_id (Case scrut _ [(_,_,rhs)]) = (get_work_id scrut) ++ (get_work_id rhs)
- get_work_id (Note _ body) = get_work_id body
- get_work_id (Let _ body) = get_work_id body
- get_work_id (App (Var work_id) _) = [work_id]
- get_work_id (App fn _) = get_work_id fn
- get_work_id (Var work_id) = []
- get_work_id other = []
-
- work_id_try2 (Lam _ body) = work_id_try2 body
- work_id_try2 (Note _ body) = work_id_try2 body
- work_id_try2 (Let _ body) = work_id_try2 body
- work_id_try2 (App fn _) = work_id_try2 fn
- work_id_try2 (Var work_id) = [work_id]
- work_id_try2 other = []
--}
+noOneShotInfo = repeat False
\end{code}
projects / ghc-hetmet.git / blobdiff