Vectorise top-level bindings of a module
[ghc-hetmet.git] / compiler / vectorise / Vectorise.hs
index ed77f9a..59039e9 100644 (file)
@@ -3,25 +3,40 @@ where
 
 #include "HsVersions.h"
 
+import VectMonad
+import VectUtils
+
 import DynFlags
 import HscTypes
 
 import CoreLint             ( showPass, endPass )
+import CoreSyn
+import CoreUtils
+import CoreFVs
+import DataCon
 import TyCon
 import Type
 import TypeRep
 import Var
 import VarEnv
-import Name                 ( mkSysTvName )
+import VarSet
+import Name                 ( mkSysTvName, getName )
 import NameEnv
+import Id
+import MkId                 ( unwrapFamInstScrut )
+import OccName
 
-import DsMonad
+import DsMonad hiding (mapAndUnzipM)
+import DsUtils              ( mkCoreTup, mkCoreTupTy )
 
 import PrelNames
+import TysWiredIn
+import BasicTypes           ( Boxity(..) )
 
 import Outputable
 import FastString
-import Control.Monad        ( liftM2 )
+import Control.Monad        ( liftM, liftM2, mapAndUnzipM, zipWithM_ )
+import Data.Maybe           ( maybeToList )
 
 vectorise :: HscEnv -> ModGuts -> IO ModGuts
 vectorise hsc_env guts
@@ -31,192 +46,382 @@ vectorise hsc_env guts
       showPass dflags "Vectorisation"
       eps <- hscEPS hsc_env
       let info = hptVectInfo hsc_env `plusVectInfo` eps_vect_info eps
-      Just guts' <- initDs hsc_env (mg_module guts)
-                                   (mg_rdr_env guts)
-                                   (mg_types guts)
-                                   (vectoriseModule info guts)
+      Just (info', guts') <- initV hsc_env guts info (vectModule guts)
       endPass dflags "Vectorisation" Opt_D_dump_vect (mg_binds guts')
-      return guts'
+      return $ guts' { mg_vect_info = info' }
   where
     dflags = hsc_dflags hsc_env
 
+vectModule :: ModGuts -> VM ModGuts
+vectModule guts
+  = do
+      binds' <- mapM vectTopBind (mg_binds guts)
+      return $ guts { mg_binds = binds' }
+
+vectTopBind :: CoreBind -> VM CoreBind
+vectTopBind b@(NonRec var expr)
+  = do
+      var'  <- vectTopBinder var
+      expr' <- vectTopRhs expr
+      hs    <- takeHoisted
+      return . Rec $ (var, expr) : (var', expr') : hs
+  `orElseV`
+    return b
+
+vectTopBind b@(Rec bs)
+  = do
+      vars'  <- mapM vectTopBinder vars
+      exprs' <- mapM vectTopRhs exprs
+      hs     <- takeHoisted
+      return . Rec $ bs ++ zip vars' exprs' ++ hs
+  `orElseV`
+    return b
+  where
+    (vars, exprs) = unzip bs
+
+vectTopBinder :: Var -> VM Var
+vectTopBinder var
+  = do
+      vty <- liftM (mkForAllTys tyvars) $ vectType mono_ty
+      name <- cloneName mkVectOcc (getName var)
+      let var' | isExportedId var = Id.mkExportedLocalId name vty
+               | otherwise        = Id.mkLocalId         name vty
+      defGlobalVar var var'
+      return var'
+  where
+    (tyvars, mono_ty) = splitForAllTys (idType var)
+    
+vectTopRhs :: CoreExpr -> VM CoreExpr
+vectTopRhs = liftM fst . closedV . vectPolyExpr (panic "Empty lifting context") . freeVars
+
 -- ----------------------------------------------------------------------------
--- Vectorisation monad
-
-data Builtins = Builtins {
-                  parrayTyCon      :: TyCon
-                , paTyCon          :: TyCon
-                , closureTyCon     :: TyCon
-                , mkClosureVar     :: Var
-                , applyClosureVar  :: Var
-                , mkClosurePVar    :: Var
-                , applyClosurePVar :: Var
-                , closurePAVar     :: Var
-                , lengthPAVar      :: Var
-                , replicatePAVar   :: Var
-                }
-
-initBuiltins :: DsM Builtins
-initBuiltins
-  = do
-      parrayTyCon  <- dsLookupTyCon parrayTyConName
-      paTyCon      <- dsLookupTyCon paTyConName
-      closureTyCon <- dsLookupTyCon closureTyConName
-
-      mkClosureVar     <- dsLookupGlobalId mkClosureName
-      applyClosureVar  <- dsLookupGlobalId applyClosureName
-      mkClosurePVar    <- dsLookupGlobalId mkClosurePName
-      applyClosurePVar <- dsLookupGlobalId applyClosurePName
-      closurePAVar     <- dsLookupGlobalId closurePAName
-      lengthPAVar      <- dsLookupGlobalId lengthPAName
-      replicatePAVar   <- dsLookupGlobalId replicatePAName
-
-      return $ Builtins {
-                 parrayTyCon      = parrayTyCon
-               , paTyCon          = paTyCon
-               , closureTyCon     = closureTyCon
-               , mkClosureVar     = mkClosureVar
-               , applyClosureVar  = applyClosureVar
-               , mkClosurePVar    = mkClosurePVar
-               , applyClosurePVar = applyClosurePVar
-               , closurePAVar     = closurePAVar
-               , lengthPAVar      = lengthPAVar
-               , replicatePAVar   = replicatePAVar
-               }
+-- Bindings
 
-data VEnv = VEnv {
-              -- Mapping from variables to their vectorised versions
-              --
-              vect_vars :: VarEnv Var
-
-              -- Exported variables which have a vectorised version
-              --
-            , vect_exported_vars :: VarEnv (Var, Var)
-
-              -- Mapping from TyCons to their vectorised versions.
-              -- TyCons which do not have to be vectorised are mapped to
-              -- themselves.
-            , vect_tycons :: NameEnv TyCon
-            }
-
-initVEnv :: VectInfo -> DsM VEnv
-initVEnv info
-  = return $ VEnv {
-               vect_vars          = mapVarEnv  snd $ vectInfoCCVar   info
-             , vect_exported_vars = emptyVarEnv
-             , vect_tycons        = mapNameEnv snd $ vectInfoCCTyCon info
-             }
+vectBndr :: Var -> VM (Var, Var)
+vectBndr v
+  = do
+      vty <- vectType (idType v)
+      lty <- mkPArrayType vty
+      let vv = v `Id.setIdType` vty
+          lv = v `Id.setIdType` lty
+      updLEnv (mapTo vv lv)
+      return (vv, lv)
+  where
+    mapTo vv lv env = env { local_vars = extendVarEnv (local_vars env) v (Var vv, Var lv) }
+
+vectBndrIn :: Var -> VM a -> VM (Var, Var, a)
+vectBndrIn v p
+  = localV
+  $ do
+      (vv, lv) <- vectBndr v
+      x <- p
+      return (vv, lv, x)
+
+vectBndrsIn :: [Var] -> VM a -> VM ([Var], [Var], a)
+vectBndrsIn vs p
+  = localV
+  $ do
+      (vvs, lvs) <- mapAndUnzipM vectBndr vs
+      x <- p
+      return (vvs, lvs, x)
 
--- FIXME
-updVectInfo :: VEnv -> ModGuts -> ModGuts
-updVectInfo env guts = guts { mg_vect_info = info' }
+-- ----------------------------------------------------------------------------
+-- Expressions
+
+replicateP :: CoreExpr -> CoreExpr -> VM CoreExpr
+replicateP expr len
+  = do
+      dict <- paDictOfType ty
+      rep  <- builtin replicatePAVar
+      return $ mkApps (Var rep) [Type ty, dict, expr, len]
   where
-    info' = info {
-              vectInfoCCVar   = vect_exported_vars env
-            , vectInfoCCTyCon = tc_env
-            }
+    ty = exprType expr
 
-    info  = mg_vect_info guts
-    tyenv = mg_types guts
+capply :: (CoreExpr, CoreExpr) -> (CoreExpr, CoreExpr) -> VM (CoreExpr, CoreExpr)
+capply (vfn, lfn) (varg, larg)
+  = do
+      apply  <- builtin applyClosureVar
+      applyP <- builtin applyClosurePVar
+      return (mkApps (Var apply)  [Type arg_ty, Type res_ty, vfn, varg],
+              mkApps (Var applyP) [Type arg_ty, Type res_ty, lfn, larg])
+  where
+    fn_ty            = exprType vfn
+    (arg_ty, res_ty) = splitClosureTy fn_ty
 
-    tc_env = mkNameEnv [(tc_name, (tc,tc')) | tc <- typeEnvTyCons tyenv
-                                            , let tc_name = tyConName tc
-                                            , Just tc' <- [lookupNameEnv (vect_tycons env) tc_name]]
+vectVar :: CoreExpr -> Var -> VM (CoreExpr, CoreExpr)
+vectVar lc v
+  = do
+      r <- lookupVar v
+      case r of
+        Local es     -> return es
+        Global vexpr -> do
+                          lexpr <- replicateP vexpr lc
+                          return (vexpr, lexpr)
 
-data VResult a = Yes VEnv a | No
+vectPolyVar :: CoreExpr -> Var -> [Type] -> VM (CoreExpr, CoreExpr)
+vectPolyVar lc v tys
+  = do
+      r <- lookupVar v
+      case r of
+        Local (vexpr, lexpr) -> liftM2 (,) (mk_app vexpr) (mk_app lexpr)
+        Global poly          -> do
+                                  vexpr <- mk_app poly
+                                  lexpr <- replicateP vexpr lc
+                                  return (vexpr, lexpr)
+  where
+    mk_app e = applyToTypes e =<< mapM vectType tys
 
-newtype VM a = VM { runVM :: Builtins -> VEnv -> DsM (VResult a) }
+abstractOverTyVars :: [TyVar] -> ((CoreExpr -> CoreExpr) -> VM a) -> VM a
+abstractOverTyVars tvs p
+  = do
+      mdicts <- mapM mk_dict_var tvs
+      zipWithM_ (\tv -> maybe (deleteTyVarPA tv) (extendTyVarPA tv . Var)) tvs mdicts
+      p (mk_lams mdicts)
+  where
+    mk_dict_var tv = do
+                       r <- paDictArgType tv
+                       case r of
+                         Just ty -> liftM Just (newLocalVar FSLIT("dPA") ty)
+                         Nothing -> return Nothing
 
-instance Monad VM where
-  return x   = VM $ \bi env -> return (Yes env x)
-  VM p >>= f = VM $ \bi env -> do
-                                 r <- p bi env
-                                 case r of
-                                   Yes env' x -> runVM (f x) bi env'
-                                   No         -> return No
+    mk_lams mdicts = mkLams [arg | (tv, mdict) <- zip tvs mdicts
+                                 , arg <- tv : maybeToList mdict]
 
-noV :: VM a
-noV = VM $ \bi env -> return No
+applyToTypes :: CoreExpr -> [Type] -> VM CoreExpr
+applyToTypes expr tys
+  = do
+      dicts <- mapM paDictOfType tys
+      return $ mkApps expr [arg | (ty, dict) <- zip tys dicts
+                                , arg <- [Type ty, dict]]
+    
+
+vectPolyExpr :: CoreExpr -> CoreExprWithFVs -> VM (CoreExpr, CoreExpr)
+vectPolyExpr lc expr
+  = localV
+  . abstractOverTyVars tvs $ \mk_lams ->
+    -- FIXME: shadowing (tvs in lc)
+    do
+      (vmono, lmono) <- vectExpr lc mono
+      return $ (mk_lams vmono, mk_lams lmono)
+  where
+    (tvs, mono) = collectAnnTypeBinders expr  
+                
+vectExpr :: CoreExpr -> CoreExprWithFVs -> VM (CoreExpr, CoreExpr)
+vectExpr lc (_, AnnType ty)
+  = do
+      vty <- vectType ty
+      return (Type vty, Type vty)
 
-tryV :: VM a -> VM (Maybe a)
-tryV (VM p) = VM $ \bi env -> do
-                                r <- p bi env
-                                case r of
-                                  Yes env' x -> return (Yes env' (Just x))
-                                  No         -> return (Yes env Nothing)
+vectExpr lc (_, AnnVar v)   = vectVar lc v
 
-liftDs :: DsM a -> VM a
-liftDs p = VM $ \bi env -> do { x <- p; return (Yes env x) }
+vectExpr lc (_, AnnLit lit)
+  = do
+      let vexpr = Lit lit
+      lexpr <- replicateP vexpr lc
+      return (vexpr, lexpr)
 
-builtin :: (Builtins -> a) -> VM a
-builtin f = VM $ \bi env -> return (Yes env (f bi))
+vectExpr lc (_, AnnNote note expr)
+  = do
+      (vexpr, lexpr) <- vectExpr lc expr
+      return (Note note vexpr, Note note lexpr)
 
-readEnv :: (VEnv -> a) -> VM a
-readEnv f = VM $ \bi env -> return (Yes env (f env))
+vectExpr lc e@(_, AnnApp _ arg)
+  | isAnnTypeArg arg
+  = vectTyAppExpr lc fn tys
+  where
+    (fn, tys) = collectAnnTypeArgs e
 
-setEnv :: VEnv -> VM ()
-setEnv env = VM $ \_ _ -> return (Yes env ())
+vectExpr lc (_, AnnApp fn arg)
+  = do
+      fn'  <- vectExpr lc fn
+      arg' <- vectExpr lc arg
+      capply fn' arg'
 
-updEnv :: (VEnv -> VEnv) -> VM ()
-updEnv f = VM $ \_ env -> return (Yes (f env) ())
+vectExpr lc (_, AnnCase expr bndr ty alts)
+  = panic "vectExpr: case"
 
-newTyVar :: FastString -> Kind -> VM Var
-newTyVar fs k
+vectExpr lc (_, AnnLet (AnnNonRec bndr rhs) body)
   = do
-      u <- liftDs newUnique
-      return $ mkTyVar (mkSysTvName u fs) k
+      (vrhs, lrhs) <- vectPolyExpr lc rhs
+      (vbndr, lbndr, (vbody, lbody)) <- vectBndrIn bndr (vectExpr lc body)
+      return (Let (NonRec vbndr vrhs) vbody,
+              Let (NonRec lbndr lrhs) lbody)
 
-lookupTyCon :: TyCon -> VM (Maybe TyCon)
-lookupTyCon tc = readEnv $ \env -> lookupNameEnv (vect_tycons env) (tyConName tc)
+vectExpr lc (_, AnnLet (AnnRec prs) body)
+  = do
+      (vbndrs, lbndrs, (vrhss, vbody, lrhss, lbody)) <- vectBndrsIn bndrs vect
+      return (Let (Rec (zip vbndrs vrhss)) vbody,
+              Let (Rec (zip lbndrs lrhss)) lbody)
+  where
+    (bndrs, rhss) = unzip prs
+    
+    vect = do
+             (vrhss, lrhss) <- mapAndUnzipM (vectExpr lc) rhss
+             (vbody, lbody) <- vectPolyExpr lc body
+             return (vrhss, vbody, lrhss, lbody)
 
--- ----------------------------------------------------------------------------
--- Bindings
+vectExpr lc e@(_, AnnLam bndr body)
+  | isTyVar bndr = pprPanic "vectExpr" (ppr $ deAnnotate e)
 
-vectoriseModule :: VectInfo -> ModGuts -> DsM ModGuts
-vectoriseModule info guts
+vectExpr lc (fvs, AnnLam bndr body)
   = do
-      builtins <- initBuiltins
-      env <- initVEnv info
-      r <- runVM (vectModule guts) builtins env
-      case r of
-        Yes env' guts' -> return $ updVectInfo env' guts'
-        No             -> return guts
+      let tyvars = filter isTyVar (varSetElems fvs)
+      info <- mkCEnvInfo fvs bndr body
+      (poly_vfn, poly_lfn) <- mkClosureFns info tyvars bndr body
 
-vectModule :: ModGuts -> VM ModGuts
-vectModule guts = return guts
+      vfn_var <- hoistExpr FSLIT("vfn") poly_vfn
+      lfn_var <- hoistExpr FSLIT("lfn") poly_lfn
 
--- ----------------------------------------------------------------------------
--- Types
+      let (venv, lenv) = mkClosureEnvs info lc
 
-paArgType :: Type -> Kind -> VM (Maybe Type)
-paArgType ty k
-  | Just k' <- kindView k = paArgType ty k'
+      let env_ty = cenv_vty info
 
--- Here, we assume that for a kind (k1 -> k2) to be valid, k1 and k2 can only
--- be made up of * and (->), i.e., they can't be coercion kinds or #.
-paArgType ty (FunTy k1 k2)
-  = do
-      tv  <- newTyVar FSLIT("a") k1
-      ty1 <- paArgType' (TyVarTy tv) k1
-      ty2 <- paArgType' (AppTy ty (TyVarTy tv)) k2
-      return . Just $ ForAllTy tv (FunTy ty1 ty2)
+      pa_dict <- paDictOfType env_ty
+
+      arg_ty <- vectType (varType bndr)
+      res_ty <- vectType (exprType $ deAnnotate body)
+
+      -- FIXME: move the functions to the top level
+      mono_vfn <- applyToTypes (Var vfn_var) (map TyVarTy tyvars)
+      mono_lfn <- applyToTypes (Var lfn_var) (map TyVarTy tyvars)
 
-paArgType ty k
-  | isLiftedTypeKind k
+      mk_clo <- builtin mkClosureVar
+      mk_cloP <- builtin mkClosurePVar
+
+      let vclo = Var mk_clo  `mkTyApps` [arg_ty, res_ty, env_ty]
+                             `mkApps`   [pa_dict, mono_vfn, mono_lfn, venv]
+          
+          lclo = Var mk_cloP `mkTyApps` [arg_ty, res_ty, env_ty]
+                             `mkApps`   [pa_dict, mono_vfn, mono_lfn, lenv]
+
+      return (vclo, lclo)
+       
+
+data CEnvInfo = CEnvInfo {
+               cenv_vars         :: [Var]
+             , cenv_values       :: [(CoreExpr, CoreExpr)]
+             , cenv_vty          :: Type
+             , cenv_lty          :: Type
+             , cenv_repr_tycon   :: TyCon
+             , cenv_repr_tyargs  :: [Type]
+             , cenv_repr_datacon :: DataCon
+             }
+
+mkCEnvInfo :: VarSet -> Var -> CoreExprWithFVs -> VM CEnvInfo
+mkCEnvInfo fvs arg body
   = do
-      tc <- builtin paTyCon
-      return . Just $ TyConApp tc [ty]
+      locals <- readLEnv local_vars
+      let
+          (vars, vals) = unzip
+                 [(var, val) | var      <- varSetElems fvs
+                             , Just val <- [lookupVarEnv locals var]]
+      vtys <- mapM (vectType . varType) vars
+
+      (vty, repr_tycon, repr_tyargs, repr_datacon) <- mk_env_ty vtys
+      lty <- mkPArrayType vty
+      
+      return $ CEnvInfo {
+                 cenv_vars         = vars
+               , cenv_values       = vals
+               , cenv_vty          = vty
+               , cenv_lty          = lty
+               , cenv_repr_tycon   = repr_tycon
+               , cenv_repr_tyargs  = repr_tyargs
+               , cenv_repr_datacon = repr_datacon
+               }
+  where
+    mk_env_ty [vty]
+      = return (vty, error "absent cinfo_repr_tycon"
+                   , error "absent cinfo_repr_tyargs"
+                   , error "absent cinfo_repr_datacon")
+
+    mk_env_ty vtys
+      = do
+          let ty = mkCoreTupTy vtys
+          (repr_tc, repr_tyargs) <- lookupPArrayFamInst ty
+          let [repr_con] = tyConDataCons repr_tc
+          return (ty, repr_tc, repr_tyargs, repr_con)
+
+    
+
+mkClosureEnvs :: CEnvInfo -> CoreExpr -> (CoreExpr, CoreExpr)
+mkClosureEnvs info lc
+  | [] <- vals
+  = (Var unitDataConId, mkApps (Var $ dataConWrapId (cenv_repr_datacon info))
+                               [lc, Var unitDataConId])
+
+  | [(vval, lval)] <- vals
+  = (vval, lval)
 
   | otherwise
-  = return Nothing 
+  = (mkCoreTup vvals, Var (dataConWrapId $ cenv_repr_datacon info)
+                      `mkTyApps` cenv_repr_tyargs info
+                      `mkApps`   (lc : lvals))
 
-paArgType' :: Type -> Kind -> VM Type
-paArgType' ty k
+  where
+    vals = cenv_values info
+    (vvals, lvals) = unzip vals
+
+mkClosureFns :: CEnvInfo -> [TyVar] -> Var -> CoreExprWithFVs
+             -> VM (CoreExpr, CoreExpr)
+mkClosureFns info tyvars arg body
+  = closedV
+  . abstractOverTyVars tyvars
+  $ \mk_tlams ->
+  do
+    (vfn, lfn) <- mkClosureMonoFns info arg body
+    return (mk_tlams vfn, mk_tlams lfn)
+
+mkClosureMonoFns :: CEnvInfo -> Var -> CoreExprWithFVs -> VM (CoreExpr, CoreExpr)
+mkClosureMonoFns info arg body
   = do
-      r <- paArgType ty k
-      case r of
-        Just ty' -> return ty'
-        Nothing  -> pprPanic "paArgType'" (ppr ty)
+      lc_bndr <- newLocalVar FSLIT("lc") intTy
+      (varg : vbndrs, larg : lbndrs, (vbody, lbody))
+        <- vectBndrsIn (arg : cenv_vars info)
+                       (vectExpr (Var lc_bndr) body)
+
+      venv_bndr <- newLocalVar FSLIT("env") vty
+      lenv_bndr <- newLocalVar FSLIT("env") lty
+
+      let vcase = bind_venv (Var venv_bndr) vbody vbndrs
+      lcase <- bind_lenv (Var lenv_bndr) lbody lc_bndr lbndrs
+      return (mkLams [venv_bndr, varg] vcase, mkLams [lenv_bndr, larg] lcase)
+  where
+    vty = cenv_vty info
+    lty = cenv_lty info
+
+    arity = length (cenv_vars info)
+
+    bind_venv venv vbody []      = vbody
+    bind_venv venv vbody [vbndr] = Let (NonRec vbndr venv) vbody
+    bind_venv venv vbody vbndrs
+      = Case venv (mkWildId vty) (exprType vbody)
+             [(DataAlt (tupleCon Boxed arity), vbndrs, vbody)]
+
+    bind_lenv lenv lbody lc_bndr [lbndr]
+      = do
+          lengthPA <- builtin lengthPAVar
+          return . Let (NonRec lbndr lenv)
+                 $ Case (mkApps (Var lengthPA) [Type vty, (Var lbndr)])
+                        lc_bndr
+                        intTy
+                        [(DEFAULT, [], lbody)]
+
+    bind_lenv lenv lbody lc_bndr lbndrs
+      = return
+      $ Case (unwrapFamInstScrut (cenv_repr_tycon info)
+                                 (cenv_repr_tyargs info)
+                                 lenv)
+             (mkWildId lty)
+             (exprType lbody)
+             [(DataAlt (cenv_repr_datacon info), lc_bndr : lbndrs, lbody)]
+          
+vectTyAppExpr :: CoreExpr -> CoreExprWithFVs -> [Type] -> VM (CoreExpr, CoreExpr)
+vectTyAppExpr lc (_, AnnVar v) tys = vectPolyVar lc v tys
+vectTyAppExpr lc e tys = pprPanic "vectTyAppExpr" (ppr $ deAnnotate e)
+
+-- ----------------------------------------------------------------------------
+-- Types
 
 vectTyCon :: TyCon -> VM TyCon
 vectTyCon tc
@@ -240,9 +445,12 @@ vectType (FunTy ty1 ty2)   = liftM2 TyConApp (builtin closureTyCon)
                                              (mapM vectType [ty1,ty2])
 vectType (ForAllTy tv ty)
   = do
-      r   <- paArgType (TyVarTy tv) (tyVarKind tv)
+      r   <- paDictArgType tv
       ty' <- vectType ty
-      return . ForAllTy tv $ case r of { Just paty -> FunTy paty ty'; Nothing -> ty' }
+      return $ ForAllTy tv (wrap r ty')
+  where
+    wrap Nothing      = id
+    wrap (Just pa_ty) = FunTy pa_ty
 
 vectType ty = pprPanic "vectType:" (ppr ty)