[project @ 1999-07-14 22:10:40 by simonpj]
[ghc-hetmet.git] / ghc / compiler / stranal / WwLib.lhs
index 0633054..b8cf54c 100644 (file)
@@ -15,21 +15,22 @@ module WwLib (
 
 import CoreSyn
 import Id              ( Id, idType, mkSysLocal, getIdDemandInfo, setIdDemandInfo,
-                          mkWildId )
-import IdInfo          ( CprInfo(..), noCprInfo )
+                          mkWildId, setIdInfo
+                       )
+import IdInfo          ( CprInfo(..), noCprInfo, vanillaIdInfo )
 import Const           ( Con(..), DataCon )
-import DataCon         ( dataConArgTys )
+import DataCon         ( splitProductType_maybe, isExistentialDataCon, dataConArgTys )
 import Demand          ( Demand(..) )
 import PrelInfo                ( realWorldPrimId, aBSENT_ERROR_ID )
 import TysPrim         ( realWorldStatePrimTy )
 import TysWiredIn      ( unboxedTupleCon, unboxedTupleTyCon )
 import Type            ( isUnLiftedType, mkTyVarTys, mkTyVarTy, mkFunTys,
-                         splitForAllTys, splitFunTysN,
-                         splitAlgTyConApp_maybe, mkTyConApp,
+                         splitForAllTys, splitFunTys, splitFunTysN,
+                         splitAlgTyConApp_maybe, splitAlgTyConApp,
+                         mkTyConApp, splitNewType_maybe,
                          Type
                        )
-import TyCon            ( isNewTyCon,
-                          TyCon )
+import TyCon            ( isNewTyCon, isProductTyCon, TyCon )
 import BasicTypes      ( NewOrData(..) )
 import Var              ( TyVar )
 import UniqSupply      ( returnUs, thenUs, getUniqueUs, getUniquesUs, 
@@ -262,122 +263,162 @@ mkWrapper fun_ty arity demands cpr_info
 @mkWwBodies@ is called when doing the worker/wrapper split inside a module.
 
 \begin{code}
-mkWwBodies :: [TyVar] -> [Id] -> Type          -- Original fn args and body type
+mkWwBodies :: [TyVar] -> [Id]                  -- Original fn args 
+          -> Type                              -- Type of result of original function
           -> [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 cpr_info
-  | 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
-       --
-       -- 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 (\ work_id -> Note InlineMe $             -- Inline the wrapper
-                          mkLams tyvars $ mkLams args $
-                          mkApps (Var work_id) 
-                                 (map (Type . mkTyVarTy) tyvars ++ [Var realWorldPrimId]),
-             \ body    -> mkLams (tyvars ++ [void_arg]) body,
-             [WwLazy True])
-
-mkWwBodies tyvars wrap_args body_ty demands cpr_info
-  | otherwise
+mkWwBodies tyvars wrap_args res_ty demands cpr_info
   = let
         -- 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
+       
     in
-    mkWW wrap_args_w_demands           `thenUs` \ (wrap_fn, work_args_w_demands, work_fn) ->
-
-    mkWWcpr body_ty cpr_info            `thenUs` \ (wrap_fn_w_cpr, work_fn_w_cpr) ->
+    mkWWstr wrap_args_w_demands                        `thenUs` \ (wrap_fn_str,    work_fn_str,    work_arg_dmds) ->
+    mkWWcoerce res_ty                          `thenUs` \ (wrap_fn_coerce, work_fn_coerce, coerce_res_ty) ->
+    mkWWcpr coerce_res_ty cpr_info             `thenUs` \ (wrap_fn_cpr,    work_fn_cpr,    cpr_res_ty) ->
+    mkWWfixup cpr_res_ty (null work_arg_dmds)  `thenUs` \ (wrap_fn_fixup,  work_fn_fixup) ->
 
     returnUs (\ work_id -> Note InlineMe $
                           mkLams tyvars $ mkLams wrap_args_w_demands $
-                          (wrap_fn_w_cpr . wrap_fn) (mkTyApps (Var work_id) (mkTyVarTys tyvars)),
+                          (wrap_fn_coerce . wrap_fn_cpr . wrap_fn_str . wrap_fn_fixup) $
+                          mkVarApps (Var work_id) tyvars,
+
+             \ work_body  -> mkLams tyvars $ 
+                             (work_fn_fixup . work_fn_str . work_fn_cpr . work_fn_coerce) 
+                             work_body,
+
+             work_arg_dmds)
+\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
 
-             \ body    -> mkLams tyvars $ mkLams work_args_w_demands $
-                          (work_fn_w_cpr . work_fn) body,
+where R' is the representation type for R.
 
-             map getIdDemandInfo work_args_w_demands)
+\begin{code}
+mkWWcoerce body_ty 
+  = case splitNewType_maybe body_ty of
+
+       Nothing     -> returnUs (id, id, body_ty)
+
+       Just rep_ty -> returnUs (mkNote (Coerce body_ty rep_ty),
+                                mkNote (Coerce rep_ty body_ty),
+                                rep_ty)
 \end{code}    
 
 
+
+%************************************************************************
+%*                                                                     *
+\subsection{Fixup stuff}
+%*                                                                     *
+%************************************************************************
+
+\begin{code}
+mkWWfixup res_ty no_worker_args
+  | no_worker_args && isUnLiftedType res_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
+       --
+       -- 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 (\ call_to_worker -> App call_to_worker (Var void_arg),
+             \ worker_body    -> Lam void_arg worker_body)
+
+  | otherwise
+  = returnUs (id, id)
+\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 :: [Id]                                        -- Wrapper args; have their demand info on them
+        -> UniqSM (CoreExpr -> CoreExpr,       -- Wrapper body, lacking the worker call
+                                               -- and without its lambdas 
+                                               -- This fn adds the unboxing, and makes the
+                                               -- call passing the unboxed things
+                               
+                  CoreExpr -> CoreExpr,        -- Worker body, lacking the original body of the function,
+                                               -- but *with* lambdas
+                  [Demand])                    -- Worker arg demands
 
+mkWWstr wrap_args
+  = mk_ww_str wrap_args                `thenUs` \ (work_args_w_demands, wrap_fn, work_fn) ->
+    returnUs ( \ wrapper_body -> wrap_fn (mkVarApps wrapper_body work_args_w_demands),
+              \ worker_body  -> mkLams work_args_w_demands (work_fn worker_body),
+              map getIdDemandInfo work_args_w_demands)
 
        -- Empty case
-mkWW []
-  = returnUs (\ wrapper_body -> wrapper_body,
-             [],
+mk_ww_str []
+  = returnUs ([],
+             \ wrapper_body -> wrapper_body,
              \ worker_body  -> worker_body)
 
 
-mkWW (arg : ds)
+mk_ww_str (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_str 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_str" 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_str (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
-
-                Just (arg_tycon, tycon_arg_tys, [data_con]) ->
-                            -- The main event: a single-constructor data type
-                            (arg_tycon, tycon_arg_tys, data_con)
-
-                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"
-
+         (arg_tycon, tycon_arg_tys, data_con, inst_con_arg_tys) = splitProductType "mk_ww_str" (idType arg)
 
        -- 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)
+       mk_ww_str ds            `thenUs` \ (worker_args, wrap_fn, work_fn) ->
+       returnUs (arg : worker_args, wrap_fn, work_fn)
 \end{code}
 
+
+%************************************************************************
+%*                                                                     *
+\subsection{CPR stuff}
+%*                                                                     *
+%************************************************************************
+
+
 @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
@@ -391,18 +432,19 @@ left-to-right traversal of the result structure.
 mkWWcpr :: Type                              -- function body type
         -> CprInfo                           -- CPR analysis results
         -> UniqSM (CoreExpr -> CoreExpr,             -- New wrapper 
-                   CoreExpr -> CoreExpr)            -- New worker
+                   CoreExpr -> CoreExpr,            -- New worker
+                  Type)                        -- Type of worker's body 
 
 mkWWcpr body_ty NoCPRInfo 
-    = returnUs (id, id)      -- Must be just the strictness transf.
+    = returnUs (id, id, body_ty)      -- 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)
+      cpr_flatten body_ty cpr_info'                       `thenUs` \(flatten_fn, res_ty) ->
+      returnUs (reconst_fn, flatten_fn, res_ty)
     where
            -- We only make use of the outer level of CprInfo,  otherwise we
            -- may lose laziness.  :-(  Hopefully,  we will find a use for the
@@ -417,11 +459,14 @@ 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 :: Type -> CprInfo -> UniqSM (CoreExpr -> CoreExpr, Type)
 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))])
+      let
+       (unbx_tuple, unbx_tuple_ty) = mk_unboxed_tuple tup_ids
+      in
+      returnUs (\body -> Case body res_id [(DEFAULT, [], flatten_exp unbx_tuple)],
+               unbx_tuple_ty)
 
 
 
@@ -439,7 +484,7 @@ 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 (head inst_con_arg_tys, cpr_info) 
+      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 
@@ -464,7 +509,10 @@ mk_cpr_case (ty, cpr_info@(CPRInfo ci_args))
       in
         returnUs (id_id, new_tup, new_exp_case)
     where
-      (data_con, tycon, tycon_arg_tys, inst_con_arg_tys) = splitType "mk_cpr_case" ty
+      (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}
 
@@ -496,9 +544,11 @@ mk_cpr_let (ty, NoCPRInfo)
       returnUs (id_id, [id_id], id)
 
 mk_cpr_let (ty, cpr_info@(CPRInfo ci_args))
+
+{- Should not be needed now:  mkWWfixup does this job
     | isNewTyCon tycon   -- a new type: must coerce the argument to this type
     = ASSERT ( null $ tail inst_con_arg_tys )
-      mk_cpr_let (head inst_con_arg_tys, cpr_info) 
+      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 
@@ -508,6 +558,7 @@ mk_cpr_let (ty, cpr_info@(CPRInfo ci_args))
 
     | 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   ->
@@ -519,25 +570,41 @@ mk_cpr_let (ty, cpr_info@(CPRInfo ci_args))
       in
         returnUs (id_id, new_tup, new_exp)
     where
-      (data_con, tycon, tycon_arg_tys, inst_con_arg_tys) = splitType "mk_cpr_let" ty
-
-splitType :: String -> Type -> (DataCon, TyCon, [Type], [Type])
-splitType fname ty = (data_con, tycon, tycon_arg_tys, dataConArgTys data_con tycon_arg_tys) 
-    where
-      (data_con, tycon, tycon_arg_tys)
-         = case (splitAlgTyConApp_maybe ty) of
-             Just (arg_tycon, tycon_arg_tys, [data_con]) ->
-                   -- The main event: a single-constructor data type
-                  (data_con, arg_tycon, tycon_arg_tys)
-
-             Just (_, _, data_cons) ->
-                  pprPanic (fname ++ ":") 
-                           (text "not one constr (interface files not consistent/up to date?)"
-                           $$ ppr ty)
-
-             Nothing           ->
-                  pprPanic (fname ++ ":") 
-                            (text "not a datatype" $$ ppr ty)
+      (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])
+  -- For a tiresome reason, the type might not look like a product type
+  -- This happens when compiling the compiler!  The module Name
+  -- imports {-# SOURCE #-} TyCon and Id
+  --   data Name = Name NameSort Unique OccName Provenance
+  --    data NameSort = WiredInId Module Id | ...
+  -- So Name does not look recursive (because Id is imported via a hi-boot file,
+  -- which says nothing about Id's rep) but actually it is, because Ids have Names.
+  -- Modules that *import* Name have a more complete view, see that Name is recursive,
+  -- and therefore that it isn't a ProductType.  This conflicts with the CPR info
+  -- in exports from Name that say "do CPR".
+  --
+  -- Arguably we should regard Name as a product anyway because it isn't recursive
+  -- via products all the way... but we don't have that info to hand, and even if
+  -- we did this case might *still* arise.
+
+  -- 
+  -- So we hack our way out for now, by trusting the pragma that said "do CPR"
+  -- that means we can't use splitProductType_maybe
+
+splitProductType fname ty
+   = case splitAlgTyConApp_maybe ty of
+       Just (tycon, tycon_args, (con:other_cons))
+         | null other_cons && not (isExistentialDataCon con)
+         -> WARN( not (isProductTyCon tycon),
+                  text "splitProductType hack: I happened!" <+> ppr ty )
+            (tycon, tycon_args, con, dataConArgTys con tycon_args)
+            
+       Nothing -> pprPanic (fname ++ ": not a product") (ppr ty)
 \end{code}
 
 
@@ -561,14 +628,27 @@ mk_unpk_case NewType arg unpk_args boxing_con boxing_tycon body
        -- 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 )
@@ -592,6 +672,4 @@ mk_unboxed_tuple contents
                  map fst contents),
        mkTyConApp (unboxedTupleTyCon (length contents)) 
                   (map snd contents))
-
-
 \end{code}