Move all vectorisation built-ins to VectBuiltIn
[ghc-hetmet.git] / compiler / vectorise / Vectorise.hs
index 1adb46d..85f4e46 100644 (file)
@@ -3,6 +3,11 @@ where
 
 #include "HsVersions.h"
 
+import VectMonad
+import VectUtils
+import VectType
+import VectCore
+
 import DynFlags
 import HscTypes
 
@@ -10,356 +15,302 @@ import CoreLint             ( showPass, endPass )
 import CoreSyn
 import CoreUtils
 import CoreFVs
+import SimplMonad           ( SimplCount, zeroSimplCount )
+import Rules                ( RuleBase )
+import DataCon
 import TyCon
 import Type
-import TypeRep
+import FamInstEnv           ( extendFamInstEnvList )
+import InstEnv              ( extendInstEnvList )
 import Var
 import VarEnv
-import Name                 ( mkSysTvName )
+import VarSet
+import Name                 ( Name, mkSysTvName, getName )
 import NameEnv
+import Id
+import MkId                 ( unwrapFamInstScrut )
+import OccName
+import Module               ( Module )
 
-import DsMonad
+import DsMonad hiding (mapAndUnzipM)
+import DsUtils              ( mkCoreTup, mkCoreTupTy )
 
+import Literal              ( Literal )
 import PrelNames
+import TysWiredIn
+import TysPrim              ( intPrimTy )
+import BasicTypes           ( Boxity(..) )
 
 import Outputable
 import FastString
-import Control.Monad        ( liftM2 )
+import Control.Monad        ( liftM, liftM2, zipWithM, mapAndUnzipM )
 
-vectorise :: HscEnv -> ModGuts -> IO ModGuts
-vectorise hsc_env guts
-  | not (Opt_Vectorise `dopt` dflags) = return guts
-  | otherwise
+vectorise :: HscEnv -> UniqSupply -> RuleBase -> ModGuts
+          -> IO (SimplCount, ModGuts)
+vectorise hsc_env _ _ guts
   = do
       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 (zeroSimplCount dflags, guts' { mg_vect_info = info' })
   where
     dflags = hsc_dflags hsc_env
 
--- ----------------------------------------------------------------------------
--- 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
+vectModule :: ModGuts -> VM ModGuts
+vectModule guts
+  = do
+      (types', fam_insts, tc_binds) <- vectTypeEnv (mg_types guts)
+      
+      let fam_inst_env' = extendFamInstEnvList (mg_fam_inst_env guts) fam_insts
+      updGEnv (setFamInstEnv fam_inst_env')
+     
+      -- dicts   <- mapM buildPADict pa_insts
+      -- workers <- mapM vectDataConWorkers pa_insts
+      binds'  <- mapM vectTopBind (mg_binds guts)
+      return $ guts { mg_types        = types'
+                    , mg_binds        = Rec tc_binds : binds'
+                    , mg_fam_inst_env = fam_inst_env'
+                    , mg_fam_insts    = mg_fam_insts guts ++ fam_insts
+                    }
+
+vectTopBind :: CoreBind -> VM CoreBind
+vectTopBind b@(NonRec var expr)
   = 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
-               }
-
-data VEnv = VEnv {
-              -- Mapping from global variables to their vectorised versions.
-              -- 
-              vect_global_vars :: VarEnv CoreExpr
-
-              -- Mapping from local variables to their vectorised and lifted
-              -- versions.
-              --
-            , vect_local_vars :: VarEnv (CoreExpr, CoreExpr)
-
-              -- 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
-
-              -- Mapping from TyCons to their PA dictionaries
-              --
-            , vect_tycon_pa :: NameEnv CoreExpr
-
-              -- Mapping from tyvars to their PA dictionaries
-              --
-            , vect_tyvar_pa :: VarEnv CoreExpr
-            }
-
-initVEnv :: VectInfo -> DsM VEnv
-initVEnv info
-  = return $ VEnv {
-               vect_global_vars   = mapVarEnv  (Var . snd) $ vectInfoCCVar   info
-             , vect_local_vars    = emptyVarEnv
-             , vect_exported_vars = emptyVarEnv
-             , vect_tycons        = mapNameEnv snd $ vectInfoCCTyCon info
-             , vect_tycon_pa      = emptyNameEnv
-             , vect_tyvar_pa      = emptyVarEnv
-             }
-
--- FIXME
-updVectInfo :: VEnv -> ModGuts -> ModGuts
-updVectInfo env guts = guts { mg_vect_info = info' }
+      var'  <- vectTopBinder var
+      expr' <- vectTopRhs var expr
+      hs    <- takeHoisted
+      return . Rec $ (var, expr) : (var', expr') : hs
+  `orElseV`
+    return b
+
+vectTopBind b@(Rec bs)
+  = do
+      vars'  <- mapM vectTopBinder vars
+      exprs' <- zipWithM vectTopRhs vars exprs
+      hs     <- takeHoisted
+      return . Rec $ bs ++ zip vars' exprs' ++ hs
+  `orElseV`
+    return b
   where
-    info' = info {
-              vectInfoCCVar   = vect_exported_vars env
-            , vectInfoCCTyCon = tc_env
-            }
-
-    info  = mg_vect_info guts
-    tyenv = mg_types guts
-
-    tc_env = mkNameEnv [(tc_name, (tc,tc')) | tc <- typeEnvTyCons tyenv
-                                            , let tc_name = tyConName tc
-                                            , Just tc' <- [lookupNameEnv (vect_tycons env) tc_name]]
-
-data VResult a = Yes VEnv a | No
-
-newtype VM a = VM { runVM :: Builtins -> VEnv -> DsM (VResult a) }
-
-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
-
-noV :: VM a
-noV = VM $ \bi env -> return No
-
-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)
-
-maybeV :: VM (Maybe a) -> VM a
-maybeV p = maybe noV return =<< p
-
-orElseV :: VM a -> VM a -> VM a
-orElseV p q = maybe q return =<< tryV p
+    (vars, exprs) = unzip bs
 
-liftDs :: DsM a -> VM a
-liftDs p = VM $ \bi env -> do { x <- p; return (Yes env x) }
-
-builtin :: (Builtins -> a) -> VM a
-builtin f = VM $ \bi env -> return (Yes env (f bi))
-
-readEnv :: (VEnv -> a) -> VM a
-readEnv f = VM $ \bi env -> return (Yes env (f env))
-
-setEnv :: VEnv -> VM ()
-setEnv env = VM $ \_ _ -> return (Yes env ())
-
-updEnv :: (VEnv -> VEnv) -> VM ()
-updEnv f = VM $ \_ env -> return (Yes (f env) ())
-
-newTyVar :: FastString -> Kind -> VM Var
-newTyVar fs k
+vectTopBinder :: Var -> VM Var
+vectTopBinder var
   = do
-      u <- liftDs newUnique
-      return $ mkTyVar (mkSysTvName u fs) k
-
-lookupTyCon :: TyCon -> VM (Maybe TyCon)
-lookupTyCon tc = readEnv $ \env -> lookupNameEnv (vect_tycons env) (tyConName tc)
+      vty  <- vectType (idType var)
+      var' <- cloneId mkVectOcc var vty
+      defGlobalVar var var'
+      return var'
+    
+vectTopRhs :: Var -> CoreExpr -> VM CoreExpr
+vectTopRhs var expr
+  = do
+      closedV . liftM vectorised
+              . inBind var
+              $ vectPolyExpr (freeVars expr)
 
 -- ----------------------------------------------------------------------------
 -- Bindings
 
-vectoriseModule :: VectInfo -> ModGuts -> DsM ModGuts
-vectoriseModule info guts
+vectBndr :: Var -> VM VVar
+vectBndr v
   = 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
-
-vectModule :: ModGuts -> VM ModGuts
-vectModule guts = return guts
+      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 (vv, lv) }
+
+vectBndrIn :: Var -> VM a -> VM (VVar, a)
+vectBndrIn v p
+  = localV
+  $ do
+      vv <- vectBndr v
+      x <- p
+      return (vv, x)
+
+vectBndrIn' :: Var -> (VVar -> VM a) -> VM (VVar, a)
+vectBndrIn' v p
+  = localV
+  $ do
+      vv <- vectBndr v
+      x  <- p vv
+      return (vv, x)
+
+vectBndrsIn :: [Var] -> VM a -> VM ([VVar], a)
+vectBndrsIn vs p
+  = localV
+  $ do
+      vvs <- mapM vectBndr vs
+      x <- p
+      return (vvs, x)
 
 -- ----------------------------------------------------------------------------
 -- Expressions
 
-replicateP :: CoreExpr -> CoreExpr -> VM CoreExpr
-replicateP expr len
+vectVar :: Var -> VM VExpr
+vectVar v
   = do
-      pa  <- paOfType ty
-      rep <- builtin replicatePAVar
-      return $ mkApps (Var rep) [Type ty, pa, expr, len]
-  where
-    ty = exprType expr
-
-capply :: (CoreExpr, CoreExpr) -> (CoreExpr, CoreExpr) -> VM (CoreExpr, CoreExpr)
-capply (vfn, lfn) (varg, larg)
+      r <- lookupVar v
+      case r of
+        Local (vv,lv) -> return (Var vv, Var lv)
+        Global vv     -> do
+                           let vexpr = Var vv
+                           lexpr <- liftPA vexpr
+                           return (vexpr, lexpr)
+
+vectPolyVar :: Var -> [Type] -> VM VExpr
+vectPolyVar v tys
   = 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
-
-vectVar :: CoreExpr -> Var -> VM (CoreExpr, CoreExpr)
-vectVar lc v = local v `orElseV` global v
+      vtys <- mapM vectType tys
+      r <- lookupVar v
+      case r of
+        Local (vv, lv) -> liftM2 (,) (polyApply (Var vv) vtys)
+                                     (polyApply (Var lv) vtys)
+        Global poly    -> do
+                            vexpr <- polyApply (Var poly) vtys
+                            lexpr <- liftPA vexpr
+                            return (vexpr, lexpr)
+
+vectLiteral :: Literal -> VM VExpr
+vectLiteral lit
+  = do
+      lexpr <- liftPA (Lit lit)
+      return (Lit lit, lexpr)
+
+vectPolyExpr :: CoreExprWithFVs -> VM VExpr
+vectPolyExpr expr
+  = polyAbstract tvs $ \abstract ->
+    do
+      mono' <- vectExpr mono
+      return $ mapVect abstract mono'
   where
-    local  v = maybeV (readEnv $ \env -> lookupVarEnv (vect_local_vars env) v)
-    global v = do
-                 vexpr <- maybeV (readEnv $ \env -> lookupVarEnv (vect_global_vars env) v)
-                 lexpr <- replicateP vexpr lc
-                 return (vexpr, lexpr)
+    (tvs, mono) = collectAnnTypeBinders expr  
                 
-vectExpr :: CoreExpr -> CoreExprWithFVs -> VM (CoreExpr, CoreExpr)
-vectExpr lc (_, AnnType ty)
-  = do
-      vty <- vectType ty
-      return (Type vty, Type vty)
-vectExpr lc (_, AnnVar v)   = vectVar lc v
-vectExpr lc (_, AnnLit lit)
-  = do
-      let vexpr = Lit lit
-      lexpr <- replicateP vexpr lc
-      return (vexpr, lexpr)
-vectExpr lc (_, AnnNote note expr)
-  = do
-      (vexpr, lexpr) <- vectExpr lc expr
-      return (Note note vexpr, Note note lexpr)
-vectExpr lc (_, AnnApp fn arg)
-  = do
-      fn'  <- vectExpr lc fn
-      arg' <- vectExpr lc arg
-      capply fn' arg'
+vectExpr :: CoreExprWithFVs -> VM VExpr
+vectExpr (_, AnnType ty)
+  = liftM vType (vectType ty)
 
--- ----------------------------------------------------------------------------
--- PA dictionaries
+vectExpr (_, AnnVar v) = vectVar v
 
-paArgType :: Type -> Kind -> VM (Maybe Type)
-paArgType ty k
-  | Just k' <- kindView k = paArgType ty k'
+vectExpr (_, AnnLit lit) = vectLiteral lit
 
--- 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)
-
-paArgType ty k
-  | isLiftedTypeKind k
-  = do
-      tc <- builtin paTyCon
-      return . Just $ TyConApp tc [ty]
+vectExpr (_, AnnNote note expr)
+  = liftM (vNote note) (vectExpr expr)
 
-  | otherwise
-  = return Nothing 
+vectExpr e@(_, AnnApp _ arg)
+  | isAnnTypeArg arg
+  = vectTyAppExpr fn tys
+  where
+    (fn, tys) = collectAnnTypeArgs e
 
-paArgType' :: Type -> Kind -> VM Type
-paArgType' ty k
+vectExpr (_, AnnApp fn arg)
   = do
-      r <- paArgType ty k
-      case r of
-        Just ty' -> return ty'
-        Nothing  -> pprPanic "paArgType'" (ppr ty)
+      fn'  <- vectExpr fn
+      arg' <- vectExpr arg
+      mkClosureApp fn' arg'
 
-paOfTyCon :: TyCon -> VM CoreExpr
--- FIXME: just for now
-paOfTyCon tc = maybeV (readEnv $ \env -> lookupNameEnv (vect_tycon_pa env) (tyConName tc))
+vectExpr (_, AnnCase scrut bndr ty alts)
+  | isAlgType scrut_ty
+  = vectAlgCase scrut bndr ty alts
+  where
+    scrut_ty = exprType (deAnnotate scrut)
 
-paOfType :: Type -> VM CoreExpr
-paOfType ty | Just ty' <- coreView ty = paOfType ty'
+vectExpr (_, AnnCase expr bndr ty alts)
+  = panic "vectExpr: case"
 
-paOfType (TyVarTy tv) = maybeV (readEnv $ \env -> lookupVarEnv (vect_tyvar_pa env) tv)
-paOfType (AppTy ty1 ty2)
-  = do
-      e1 <- paOfType ty1
-      e2 <- paOfType ty2
-      return $ mkApps e1 [Type ty2, e2]
-paOfType (TyConApp tc tys)
+vectExpr (_, AnnLet (AnnNonRec bndr rhs) body)
   = do
-      e  <- paOfTyCon tc
-      es <- mapM paOfType tys
-      return $ mkApps e [arg | (t,e) <- zip tys es, arg <- [Type t, e]]
-paOfType (FunTy ty1 ty2) = paOfType (TyConApp funTyCon [ty1,ty2])
-paOfType t@(ForAllTy tv ty) = pprPanic "paOfType:" (ppr t)
-paOfType ty = pprPanic "paOfType:" (ppr ty)
-        
+      vrhs <- localV . inBind bndr $ vectPolyExpr rhs
+      (vbndr, vbody) <- vectBndrIn bndr (vectExpr body)
+      return $ vLet (vNonRec vbndr vrhs) vbody
 
-
--- ----------------------------------------------------------------------------
--- Types
-
-vectTyCon :: TyCon -> VM TyCon
-vectTyCon tc
-  | isFunTyCon tc        = builtin closureTyCon
-  | isBoxedTupleTyCon tc = return tc
-  | isUnLiftedTyCon tc   = return tc
-  | otherwise = do
-                  r <- lookupTyCon tc
-                  case r of
-                    Just tc' -> return tc'
-
-                    -- FIXME: just for now
-                    Nothing  -> pprTrace "ccTyCon:" (ppr tc) $ return tc
-
-vectType :: Type -> VM Type
-vectType ty | Just ty' <- coreView ty = vectType ty
-vectType (TyVarTy tv) = return $ TyVarTy tv
-vectType (AppTy ty1 ty2) = liftM2 AppTy (vectType ty1) (vectType ty2)
-vectType (TyConApp tc tys) = liftM2 TyConApp (vectTyCon tc) (mapM vectType tys)
-vectType (FunTy ty1 ty2)   = liftM2 TyConApp (builtin closureTyCon)
-                                             (mapM vectType [ty1,ty2])
-vectType (ForAllTy tv ty)
+vectExpr (_, AnnLet (AnnRec bs) body)
   = do
-      r   <- paArgType (TyVarTy tv) (tyVarKind tv)
-      ty' <- vectType ty
-      return . ForAllTy tv $ case r of { Just paty -> FunTy paty ty'; Nothing -> ty' }
-
-vectType ty = pprPanic "vectType:" (ppr ty)
+      (vbndrs, (vrhss, vbody)) <- vectBndrsIn bndrs
+                                $ liftM2 (,)
+                                  (zipWithM vect_rhs bndrs rhss)
+                                  (vectPolyExpr body)
+      return $ vLet (vRec vbndrs vrhss) vbody
+  where
+    (bndrs, rhss) = unzip bs
 
-isClosureTyCon :: TyCon -> Bool
-isClosureTyCon tc = tyConUnique tc == closureTyConKey
+    vect_rhs bndr rhs = localV
+                      . inBind bndr
+                      $ vectExpr rhs
 
-splitClosureTy :: Type -> (Type, Type)
-splitClosureTy ty
-  | Just (tc, [arg_ty, res_ty]) <- splitTyConApp_maybe ty
-  , isClosureTyCon tc
-  = (arg_ty, res_ty)
+vectExpr e@(fvs, AnnLam bndr _)
+  | not (isId bndr) = pprPanic "vectExpr" (ppr $ deAnnotate e)
+  | otherwise = vectLam fvs bs body
+  where
+    (bs,body) = collectAnnValBinders e
 
-  | otherwise = pprPanic "splitClosureTy" (ppr ty)
+vectLam :: VarSet -> [Var] -> CoreExprWithFVs -> VM VExpr
+vectLam fvs bs body
+  = do
+      tyvars <- localTyVars
+      (vs, vvs) <- readLEnv $ \env ->
+                   unzip [(var, vv) | var <- varSetElems fvs
+                                    , Just vv <- [lookupVarEnv (local_vars env) var]]
+
+      arg_tys <- mapM (vectType . idType) bs
+      res_ty  <- vectType (exprType $ deAnnotate body)
+
+      buildClosures tyvars vvs arg_tys res_ty
+        . hoistPolyVExpr tyvars
+        $ do
+            lc <- builtin liftingContext
+            (vbndrs, vbody) <- vectBndrsIn (vs ++ bs)
+                                           (vectExpr body)
+            return $ vLams lc vbndrs vbody
+  
+vectTyAppExpr :: CoreExprWithFVs -> [Type] -> VM VExpr
+vectTyAppExpr (_, AnnVar v) tys = vectPolyVar v tys
+vectTyAppExpr e tys = pprPanic "vectTyAppExpr" (ppr $ deAnnotate e)
+
+type CoreAltWithFVs = AnnAlt Id VarSet
+
+-- We convert
+--
+--   case e :: t of v { ... }
+--
+-- to
+--
+--   V:    let v = e in case v of _ { ... }
+--   L:    let v = e in case v `cast` ... of _ { ... }
+--
+-- When lifting, we have to do it this way because v must have the type
+-- [:V(T):] but the scrutinee must be cast to the representation type.
+--   
+
+-- FIXME: this is too lazy
+vectAlgCase scrut bndr ty [(DEFAULT, [], body)]
+  = do
+      vscrut <- vectExpr scrut
+      vty    <- vectType ty
+      lty    <- mkPArrayType vty
+      (vbndr, vbody) <- vectBndrIn bndr (vectExpr body)
+      return $ vCaseDEFAULT vscrut vbndr vty lty vbody
 
+vectAlgCase scrut bndr ty [(DataAlt dc, bndrs, body)]
+  = do
+      vty <- vectType ty
+      lty <- mkPArrayType vty
+      vexpr <- vectExpr scrut
+      (vbndr, (vbndrs, vbody)) <- vectBndrIn bndr
+                                . vectBndrsIn bndrs
+                                $ vectExpr body
+
+      (vscrut, arr_tc, arg_tys) <- mkVScrut (vVar vbndr)
+      vect_dc <- maybeV (lookupDataCon dc)
+      let [arr_dc] = tyConDataCons arr_tc
+      let shape_tys = take (dataConRepArity arr_dc - length bndrs)
+                           (dataConRepArgTys arr_dc)
+      shape_bndrs <- mapM (newLocalVar FSLIT("s")) shape_tys
+      return . vLet (vNonRec vbndr vexpr)
+             $ vCaseProd vscrut vty lty vect_dc arr_dc shape_bndrs vbndrs vbody