#include "HsVersions.h"
import CoreSyn
-import Id ( Id, idType, mkSysLocal, getIdDemandInfo, setIdDemandInfo )
-import Const ( Con(..) )
-import DataCon ( dataConArgTys )
+import Id ( Id, idType, mkSysLocal, getIdDemandInfo, setIdDemandInfo,
+ mkWildId, setIdInfo
+ )
+import IdInfo ( CprInfo(..), noCprInfo, vanillaIdInfo )
+import Const ( Con(..), DataCon )
+import DataCon ( splitProductType_maybe )
import Demand ( Demand(..) )
-import PrelVals ( aBSENT_ERROR_ID )
-import TysWiredIn ( unitTy, unitDataCon )
+import PrelInfo ( realWorldPrimId, aBSENT_ERROR_ID )
+import TysPrim ( realWorldStatePrimTy )
+import TysWiredIn ( unboxedTupleCon, unboxedTupleTyCon )
import Type ( isUnLiftedType, mkTyVarTys, mkTyVarTy, mkFunTys,
- splitForAllTys, splitFunTys,
- splitAlgTyConApp_maybe,
+ splitForAllTys, splitFunTys, splitFunTysN,
+ splitAlgTyConApp_maybe, splitAlgTyConApp,
+ mkTyConApp, splitNewType_maybe,
Type
)
+import TyCon ( isNewTyCon,
+ TyCon )
import BasicTypes ( NewOrData(..) )
import Var ( TyVar )
-import UniqSupply ( returnUs, thenUs, getUniqueUs, getUniquesUs, UniqSM )
-import Util ( zipWithEqual )
+import UniqSupply ( returnUs, thenUs, getUniqueUs, getUniquesUs,
+ mapUs, UniqSM )
+import Util ( zipWithEqual, zipEqual )
import Outputable
\end{code}
nonAbsentArgs (WwLazy True : ds) = nonAbsentArgs ds
nonAbsentArgs (d : ds) = 1 + nonAbsentArgs ds
-worthSplitting :: [Demand] -> Bool -- True <=> the wrapper would not be an identity function
-worthSplitting ds = any worth_it ds
+worthSplitting :: [Demand]
+ -> Bool -- Result is bottom
+ -> Bool -- True <=> the wrapper would not be an identity function
+worthSplitting ds result_bot = not result_bot && any worth_it ds
+ -- Don't split if the result is bottom; there's no efficiency to
+ -- be gained, and (worse) the wrapper body may not look like a wrapper
+ -- body to getWorkerIdAndCons
where
worth_it (WwLazy True) = True -- Absent arg
worth_it (WwUnpack _ True _) = True -- Arg to unpack
- worth_it WwStrict = True
+ worth_it WwStrict = False -- Don't w/w just because of strictness
worth_it other = False
allAbsent :: [Demand] -> Bool
\begin{code}
mkWrapper :: Type -- Wrapper type
+ -> Int -- Arity
-> [Demand] -- Wrapper strictness info
+ -> CprInfo -- Wrapper cpr info
-> UniqSM (Id -> CoreExpr) -- Wrapper body, missing worker Id
-mkWrapper fun_ty demands
- = let
- n_wrap_args = length demands
- in
- getUniquesUs n_wrap_args `thenUs` \ wrap_uniqs ->
+mkWrapper fun_ty arity demands cpr_info
+ = getUniquesUs arity `thenUs` \ wrap_uniqs ->
let
(tyvars, tau_ty) = splitForAllTys fun_ty
- (arg_tys, body_ty) = splitFunTys tau_ty
+ (arg_tys, body_ty) = splitFunTysN "mkWrapper" arity tau_ty
-- The "expanding dicts" part here is important, even for the splitForAll
-- The imported thing might be a dictionary, such as Functor Foo
-- But Functor Foo = forall a b. (a->b) -> Foo a -> Foo b
-- and as such might have some strictness info attached.
-- Then we need to have enough args to zip to the strictness info
- wrap_args = ASSERT( n_wrap_args <= length arg_tys )
- zipWith mk_ww_local wrap_uniqs arg_tys
-
- leftover_arg_tys = drop n_wrap_args arg_tys
- final_body_ty = mkFunTys leftover_arg_tys body_ty
+ wrap_args = zipWith mk_ww_local wrap_uniqs arg_tys
in
- mkWwBodies tyvars wrap_args final_body_ty demands `thenUs` \ (wrap_fn, _, _) ->
+ mkWwBodies tyvars wrap_args body_ty demands cpr_info `thenUs` \ (wrap_fn, _, _) ->
returnUs wrap_fn
\end{code}
\begin{code}
mkWwBodies :: [TyVar] -> [Id] -> Type -- Original fn args and body type
-> [Demand] -- Strictness info for original fn; corresp 1-1 with args
+ -> CprInfo -- Result of CPR analysis
-> UniqSM (Id -> CoreExpr, -- Wrapper body, lacking only the worker Id
CoreExpr -> CoreExpr, -- Worker body, lacking the original function body
[Demand]) -- Strictness info for worker
-mkWwBodies tyvars args body_ty demands
- | allAbsent demands &&
- isUnLiftedType body_ty
- = -- Horrid special case. If the worker would have no arguments, and the
- -- function returns a primitive type value, that would make the worker into
- -- an unboxed value. We box it by passing a dummy void argument, thus:
- --
- -- f = /\abc. \xyz. fw abc void
- -- fw = /\abc. \v. body
- --
- getUniqueUs `thenUs` \ void_arg_uniq ->
- let
- void_arg = mk_ww_local void_arg_uniq unitTy
- in
- returnUs (\ work_id -> mkLams tyvars $ mkLams args $
- mkApps (Var work_id)
- (map (Type . mkTyVarTy) tyvars ++ [mkConApp unitDataCon []]),
- \ body -> mkLams (tyvars ++ [void_arg]) body,
- [WwLazy True])
-
-mkWwBodies tyvars wrap_args body_ty demands
- | otherwise
+mkWwBodies tyvars wrap_args body_ty demands cpr_info
= let
- wrap_args_w_demands = zipWithEqual "mkWwBodies" setIdDemandInfo wrap_args demands
+ -- demands may be longer than number of args. If we aren't doing w/w
+ -- for strictness then demands is an infinite list of 'lazy' args.
+ wrap_args_w_demands = zipWith setIdDemandInfo wrap_args demands
+ (wrap_fn_coerce, work_fn_coerce) = mkWWcoerce body_ty
in
- mkWW wrap_args_w_demands `thenUs` \ (wrap_fn, work_args_w_demands, work_fn) ->
- returnUs (\ work_id -> mkLams tyvars $ mkLams wrap_args_w_demands $
- wrap_fn (mkTyApps (Var work_id) (mkTyVarTys tyvars)),
+ mkWWstr body_ty wrap_args_w_demands `thenUs` \ (work_args_w_demands, wrap_fn_str, work_fn_str) ->
+
+ mkWWcpr body_ty cpr_info `thenUs` \ (wrap_fn_cpr, work_fn_cpr) ->
- \ body -> mkLams tyvars $ mkLams work_args_w_demands $
- work_fn body,
+ returnUs (\ work_id -> Note InlineMe $
+ mkLams tyvars $ mkLams wrap_args_w_demands $
+ (wrap_fn_coerce . wrap_fn_str . wrap_fn_cpr) $
+ mkVarApps (Var work_id) (tyvars ++ work_args_w_demands),
+
+ \ work_body -> mkLams tyvars $ mkLams work_args_w_demands $
+ (work_fn_coerce . work_fn_str . work_fn_cpr)
+ work_body,
map getIdDemandInfo work_args_w_demands)
+\end{code}
+
+
+%************************************************************************
+%* *
+\subsection{Coercion stuff}
+%* *
+%************************************************************************
+
+The "coerce" transformation is
+ f :: T1 -> T2 -> R
+ f = \xy -> e
+===>
+ f = \xy -> coerce R R' (fw x y)
+ fw = \xy -> coerce R' R e
+
+where R' is the representation type for R.
+
+\begin{code}
+mkWWcoerce body_ty
+ = case splitNewType_maybe body_ty of
+ Nothing -> (id, id)
+ Just rep_ty -> (mkNote (Coerce body_ty rep_ty),
+ mkNote (Coerce rep_ty body_ty))
\end{code}
+
+%************************************************************************
+%* *
+\subsection{Strictness stuff}
+%* *
+%************************************************************************
+
+
\begin{code}
-mkWW :: [Id] -- Wrapper args; have their demand info on them
- -> UniqSM (CoreExpr -> CoreExpr, -- Wrapper body, lacking the inner call to the worker
- -- and without its lambdas
- [Id], -- Worker args; have their demand info on them
- CoreExpr -> CoreExpr) -- Worker body, lacking the original body of the function
+mkWWstr :: Type -- Body type
+ -> [Id] -- Wrapper args; have their demand info on them
+ -> UniqSM ([Id], -- Worker args; have their demand info on them
+
+ CoreExpr -> CoreExpr, -- Wrapper body, lacking the inner call to the worker
+ -- and without its lambdas
+ -- At the call site, the worker args are bound
+
+ CoreExpr -> CoreExpr) -- Worker body, lacking the original body of the function,
+ -- and without its lambdas
+
+mkWWstr body_ty wrap_args
+ = mk_ww wrap_args `thenUs` \ (work_args, wrap_fn, work_fn) ->
+
+ if null work_args && isUnLiftedType body_ty then
+ -- Horrid special case. If the worker would have no arguments, and the
+ -- function returns a primitive type value, that would make the worker into
+ -- an unboxed value. We box it by passing a dummy void argument, thus:
+ --
+ -- f = /\abc. \xyz. fw abc void
+ -- fw = /\abc. \v. body
+ --
+ -- We use the state-token type which generates no code
+ getUniqueUs `thenUs` \ void_arg_uniq ->
+ let
+ void_arg = mk_ww_local void_arg_uniq realWorldStatePrimTy
+ in
+ returnUs ([void_arg],
+ wrap_fn . Let (NonRec void_arg (Var realWorldPrimId)),
+ work_fn)
+ else
+ returnUs (work_args, wrap_fn, work_fn)
+
-- Empty case
-mkWW []
- = returnUs (\ wrapper_body -> wrapper_body,
- [],
+mk_ww []
+ = returnUs ([],
+ \ wrapper_body -> wrapper_body,
\ worker_body -> worker_body)
-mkWW (arg : ds)
+mk_ww (arg : ds)
= case getIdDemandInfo arg of
-- Absent case
WwLazy True ->
- mkWW ds `thenUs` \ (wrap_fn, worker_args, work_fn) ->
- returnUs (\ wrapper_body -> wrap_fn wrapper_body,
- worker_args,
- \ worker_body -> mk_absent_let arg (work_fn worker_body))
-
+ mk_ww ds `thenUs` \ (worker_args, wrap_fn, work_fn) ->
+ returnUs (worker_args, wrap_fn, mk_absent_let arg . work_fn)
-- Unpack case
WwUnpack new_or_data True cs ->
getUniquesUs (length inst_con_arg_tys) `thenUs` \ uniqs ->
let
unpk_args = zipWith mk_ww_local uniqs inst_con_arg_tys
- unpk_args_w_ds = zipWithEqual "mkWW" setIdDemandInfo unpk_args cs
+ unpk_args_w_ds = zipWithEqual "mk_ww" setIdDemandInfo unpk_args cs
in
- mkWW (unpk_args_w_ds ++ ds) `thenUs` \ (wrap_fn, worker_args, work_fn) ->
- returnUs (\ wrapper_body -> mk_unpk_case new_or_data arg unpk_args data_con arg_tycon
- (wrap_fn wrapper_body),
- worker_args,
- \ worker_body -> work_fn (mk_pk_let new_or_data arg data_con
- tycon_arg_tys unpk_args worker_body))
+ mk_ww (unpk_args_w_ds ++ ds) `thenUs` \ (worker_args, wrap_fn, work_fn) ->
+ returnUs (worker_args,
+ mk_unpk_case new_or_data arg unpk_args data_con arg_tycon . wrap_fn,
+ work_fn . mk_pk_let new_or_data arg data_con tycon_arg_tys unpk_args)
where
- inst_con_arg_tys = dataConArgTys data_con tycon_arg_tys
- (arg_tycon, tycon_arg_tys, data_con)
- = case (splitAlgTyConApp_maybe (idType arg)) of
+ (arg_tycon, tycon_arg_tys, data_con, inst_con_arg_tys) = splitProductType "mk_ww" (idType arg)
- Just (arg_tycon, tycon_arg_tys, [data_con]) ->
- -- The main event: a single-constructor data type
- (arg_tycon, tycon_arg_tys, data_con)
+ -- Other cases
+ other_demand ->
+ mk_ww ds `thenUs` \ (worker_args, wrap_fn, work_fn) ->
+ returnUs (arg : worker_args, wrap_fn, work_fn)
+\end{code}
- Just (_, _, data_cons) ->
- pprPanic "mk_ww_arg_processing:"
- (text "not one constr (interface files not consistent/up to date?)"
- $$ (ppr arg <+> ppr (idType arg)))
- Nothing ->
- panic "mk_ww_arg_processing: not datatype"
+%************************************************************************
+%* *
+\subsection{CPR stuff}
+%* *
+%************************************************************************
- -- Other cases
- other_demand ->
- mkWW ds `thenUs` \ (wrap_fn, worker_args, work_fn) ->
- returnUs (\ wrapper_body -> wrap_fn (App wrapper_body (Var arg)),
- arg : worker_args,
- work_fn)
+@mkWWcpr@ takes the worker/wrapper pair produced from the strictness
+info and adds in the CPR transformation. The worker returns an
+unboxed tuple containing non-CPR components. The wrapper takes this
+tuple and re-produces the correct structured output.
+
+The non-CPR results appear ordered in the unboxed tuple as if by a
+left-to-right traversal of the result structure.
+
+
+\begin{code}
+mkWWcpr :: Type -- function body type
+ -> CprInfo -- CPR analysis results
+ -> UniqSM (CoreExpr -> CoreExpr, -- New wrapper
+ CoreExpr -> CoreExpr) -- New worker
+
+mkWWcpr body_ty NoCPRInfo
+ = returnUs (id, id) -- Must be just the strictness transf.
+mkWWcpr body_ty (CPRInfo cpr_args)
+ = getUniqueUs `thenUs` \ body_arg_uniq ->
+ let
+ body_var = mk_ww_local body_arg_uniq body_ty
+ in
+ cpr_reconstruct body_ty cpr_info' `thenUs` \reconst_fn ->
+ cpr_flatten body_ty cpr_info' `thenUs` \flatten_fn ->
+ returnUs (reconst_fn, flatten_fn)
+ where
+ -- We only make use of the outer level of CprInfo, otherwise we
+ -- may lose laziness. :-( Hopefully, we will find a use for the
+ -- extra info some day (e.g. creating versions specialized to
+ -- the use made of the components of the result by the callee)
+ cpr_info' = CPRInfo (map (const NoCPRInfo) cpr_args)
+\end{code}
+
+
+@cpr_flatten@ takes the result type produced by the body and the info
+from the CPR analysis and flattens the constructed product components.
+These are returned in an unboxed tuple.
+
+\begin{code}
+cpr_flatten :: Type -> CprInfo -> UniqSM (CoreExpr -> CoreExpr)
+cpr_flatten ty cpr_info
+ = mk_cpr_case (ty, cpr_info) `thenUs` \(res_id, tup_ids, flatten_exp) ->
+ returnUs (\body -> Case body res_id
+ [(DEFAULT, [], flatten_exp (fst $ mk_unboxed_tuple tup_ids))])
+
+
+
+mk_cpr_case :: (Type, CprInfo) ->
+ UniqSM (CoreBndr, -- Name of binder for this part of result
+ [(CoreExpr, Type)], -- expressions for flattened result
+ CoreExpr -> CoreExpr) -- add in code to flatten result
+
+mk_cpr_case (ty, NoCPRInfo)
+ -- this component must be returned as a component of the unboxed tuple result
+ = getUniqueUs `thenUs` \id_uniq ->
+ let id_id = mk_ww_local id_uniq ty in
+ returnUs (id_id, [(Var id_id, ty)], id)
+mk_cpr_case (ty, cpr_info@(CPRInfo ci_args))
+ | isNewTyCon tycon -- a new type: under the coercions must be a
+ -- constructed product
+ = ASSERT ( null $ tail inst_con_arg_tys )
+ mk_cpr_case (target_of_from_type, cpr_info)
+ `thenUs` \(arg, tup, exp) ->
+ getUniqueUs `thenUs` \id_uniq ->
+ let id_id = mk_ww_local id_uniq ty
+ new_exp_case = \var -> Case (Note (Coerce (idType arg) ty) (Var id_id))
+ arg
+ [(DEFAULT,[], exp var)]
+ in
+ returnUs (id_id, tup, new_exp_case)
+
+ | otherwise -- a data type
+ -- flatten components
+ = mapUs mk_cpr_case (zip inst_con_arg_tys ci_args)
+ `thenUs` \sub_builds ->
+ getUniqueUs `thenUs` \id_uniq ->
+ let id_id = mk_ww_local id_uniq ty
+ (args, tup, exp) = unzip3 sub_builds
+ con_app = mkConApp data_con (map Var args)
+ new_tup = concat tup
+ new_exp_case = \var -> Case (Var id_id) (mkWildId ty)
+ [(DataCon data_con, args,
+ foldl (\e f -> f e) var exp)]
+ in
+ returnUs (id_id, new_tup, new_exp_case)
+ where
+ (tycon, tycon_arg_tys, data_con, inst_con_arg_tys) = splitProductType "mk_cpr_case" ty
+ from_type = head inst_con_arg_tys
+ -- if coerced from a function 'look through' to find result type
+ target_of_from_type = (snd.splitFunTys.snd.splitForAllTys) from_type
+
+\end{code}
+
+@cpr_reconstruct@ does the opposite of @cpr_flatten@. It takes the unboxed
+tuple produced by the worker and reconstructs the structured result.
+
+\begin{code}
+cpr_reconstruct :: Type -> CprInfo -> UniqSM (CoreExpr -> CoreExpr)
+cpr_reconstruct ty cpr_info
+ = mk_cpr_let (ty,cpr_info) `thenUs` \(res_id, tup_ids, reconstruct_exp) ->
+ returnUs (\worker -> Case worker (mkWildId $ worker_type tup_ids)
+ [(DataCon $ unboxedTupleCon $ length tup_ids,
+ tup_ids, reconstruct_exp $ Var res_id)])
+
+ where
+ worker_type ids = mkTyConApp (unboxedTupleTyCon (length ids)) (map idType ids)
+
+
+mk_cpr_let :: (Type, CprInfo) ->
+ UniqSM (CoreBndr, -- Binder for this component of result
+ [CoreBndr], -- Binders which will appear in worker's result
+ CoreExpr -> CoreExpr) -- Code to produce structured result.
+mk_cpr_let (ty, NoCPRInfo)
+ -- this component will appear explicitly in the unboxed tuple.
+ = getUniqueUs `thenUs` \id_uniq ->
+ let
+ id_id = mk_ww_local id_uniq ty
+ in
+ returnUs (id_id, [id_id], id)
+
+mk_cpr_let (ty, cpr_info@(CPRInfo ci_args))
+ | isNewTyCon tycon -- a new type: must coerce the argument to this type
+ = ASSERT ( null $ tail inst_con_arg_tys )
+ mk_cpr_let (target_of_from_type, cpr_info)
+ `thenUs` \(arg, tup, exp) ->
+ getUniqueUs `thenUs` \id_uniq ->
+ let id_id = mk_ww_local id_uniq ty
+ new_exp = \var -> exp (Let (NonRec id_id (Note (Coerce ty (idType arg)) (Var arg))) var)
+ in
+ returnUs (id_id, tup, new_exp)
+
+ | otherwise -- a data type
+ -- reconstruct components then apply data con
+ = mapUs mk_cpr_let (zip inst_con_arg_tys ci_args)
+ `thenUs` \sub_builds ->
+ getUniqueUs `thenUs` \id_uniq ->
+ let id_id = mk_ww_local id_uniq ty
+ (args, tup, exp) = unzip3 sub_builds
+ con_app = mkConApp data_con $ (map Type tycon_arg_tys) ++ (map Var args)
+ new_tup = concat tup
+ new_exp = \var -> foldl (\e f -> f e) (Let (NonRec id_id con_app) var) exp
+ in
+ returnUs (id_id, new_tup, new_exp)
+ where
+ (tycon, tycon_arg_tys, data_con, inst_con_arg_tys) = splitProductType "mk_cpr_let" ty
+ from_type = head inst_con_arg_tys
+ -- if coerced from a function 'look through' to find result type
+ target_of_from_type = (snd.splitFunTys.snd.splitForAllTys) from_type
+
+
+splitProductType :: String -> Type -> (TyCon, [Type], DataCon, [Type])
+splitProductType fname ty = case splitProductType_maybe ty of
+ Just stuff -> stuff
+ Nothing -> pprPanic (fname ++ ": not a product") (ppr ty)
\end{code}
-- A newtype! Use a coercion not a case
= ASSERT( null other_args )
Case (Note (Coerce (idType unpk_arg) (idType arg)) (Var arg))
- unpk_arg
+ (sanitiseCaseBndr unpk_arg)
[(DEFAULT,[],body)]
where
(unpk_arg:other_args) = unpk_args
mk_unpk_case DataType arg unpk_args boxing_con boxing_tycon body
-- A data type
- = Case (Var arg) arg [(DataCon boxing_con, unpk_args, body)]
+ = Case (Var arg)
+ (sanitiseCaseBndr arg)
+ [(DataCon boxing_con, unpk_args, body)]
+
+sanitiseCaseBndr :: Id -> Id
+-- The argument we are scrutinising has the right type to be
+-- a case binder, so it's convenient to re-use it for that purpose.
+-- But we *must* throw away all its IdInfo. In particular, the argument
+-- will have demand info on it, and that demand info may be incorrect for
+-- the case binder. e.g. case ww_arg of ww_arg { I# x -> ... }
+-- Quite likely ww_arg isn't used in '...'. The case may get discarded
+-- if the case binder says "I'm demanded". This happened in a situation
+-- like (x+y) `seq` ....
+sanitiseCaseBndr id = id `setIdInfo` vanillaIdInfo
mk_pk_let NewType arg boxing_con con_tys unpk_args body
= ASSERT( null other_args )
con_args = map Type con_tys ++ map Var unpk_args
-mk_ww_local uniq ty = mkSysLocal uniq ty
+mk_ww_local uniq ty = mkSysLocal SLIT("ww") uniq ty
+
+
+mk_unboxed_tuple :: [(CoreExpr, Type)] -> (CoreExpr, Type)
+mk_unboxed_tuple contents
+ = (mkConApp (unboxedTupleCon (length contents))
+ (map (Type . snd) contents ++
+ map fst contents),
+ mkTyConApp (unboxedTupleTyCon (length contents))
+ (map snd contents))
\end{code}