X-Git-Url: http://git.megacz.com/?p=ghc-hetmet.git;a=blobdiff_plain;f=compiler%2Fvectorise%2FVectMonad.hs;h=6ac6d8d1dbecc147f0bf3e6dffdf0e326d3b8a3c;hp=b8f51a2195ba6261b396d50e55e9279b1ef53afd;hb=02c988e586dedff6d252ef59ef487dd4a8f567aa;hpb=d726d04e001bdc5b0a91eecc41aa56123068e362 diff --git a/compiler/vectorise/VectMonad.hs b/compiler/vectorise/VectMonad.hs index b8f51a2..6ac6d8d 100644 --- a/compiler/vectorise/VectMonad.hs +++ b/compiler/vectorise/VectMonad.hs @@ -1,21 +1,35 @@ +{-# LANGUAGE NamedFieldPuns #-} + +-- | The Vectorisation monad. module VectMonad ( - Scope(..), VM, - noV, tryV, maybeV, orElseV, fixV, localV, closedV, initV, - cloneName, newLocalVar, newTyVar, + noV, traceNoV, ensureV, traceEnsureV, tryV, maybeV, traceMaybeV, orElseV, + onlyIfV, fixV, localV, closedV, + initV, cantVectorise, maybeCantVectorise, maybeCantVectoriseM, + liftDs, + cloneName, cloneId, cloneVar, + newExportedVar, newLocalVar, newLocalVars, newDummyVar, newTyVar, - Builtins(..), paDictTyCon, - builtin, + Builtins(..), sumTyCon, prodTyCon, prodDataCon, + selTy, selReplicate, selPick, selTags, selElements, + combinePDVar, scalarZip, closureCtrFun, + builtin, builtins, - GlobalEnv(..), + setFamInstEnv, readGEnv, setGEnv, updGEnv, - LocalEnv(..), readLEnv, setLEnv, updLEnv, - defGlobalVar, lookupVar, - lookupTyCon, + getBindName, inBind, + + lookupVar, defGlobalVar, globalScalars, + lookupTyCon, defTyCon, + lookupDataCon, defDataCon, + lookupTyConPA, defTyConPA, defTyConPAs, + lookupTyConPR, + lookupBoxedTyCon, + lookupPrimMethod, lookupPrimPArray, lookupTyVarPA, defLocalTyVar, defLocalTyVarWithPA, localTyVars, lookupInst, lookupFamInst @@ -23,182 +37,101 @@ module VectMonad ( #include "HsVersions.h" -import HscTypes +import VectBuiltIn +import Vectorise.Env +import Vectorise.Vect + +import HscTypes hiding ( MonadThings(..) ) +import Module ( PackageId ) import CoreSyn import Class import TyCon import DataCon import Type import Var +import VarSet import VarEnv import Id -import OccName import Name import NameEnv import DsMonad -import PrelNames import InstEnv import FamInstEnv -import Panic import Outputable import FastString +import SrcLoc ( noSrcSpan ) -import Control.Monad ( liftM ) - -data Scope a b = Global a | Local b - --- ---------------------------------------------------------------------------- --- Vectorisation monad +import Control.Monad -data Builtins = Builtins { - parrayTyCon :: TyCon - , paClass :: Class - , closureTyCon :: TyCon - , mkClosureVar :: Var - , applyClosureVar :: Var - , mkClosurePVar :: Var - , applyClosurePVar :: Var - , lengthPAVar :: Var - , replicatePAVar :: Var - } - -paDictTyCon :: Builtins -> TyCon -paDictTyCon = classTyCon . paClass - -initBuiltins :: DsM Builtins -initBuiltins - = do - parrayTyCon <- dsLookupTyCon parrayTyConName - paClass <- dsLookupClass paClassName - closureTyCon <- dsLookupTyCon closureTyConName - - mkClosureVar <- dsLookupGlobalId mkClosureName - applyClosureVar <- dsLookupGlobalId applyClosureName - mkClosurePVar <- dsLookupGlobalId mkClosurePName - applyClosurePVar <- dsLookupGlobalId applyClosurePName - lengthPAVar <- dsLookupGlobalId lengthPAName - replicatePAVar <- dsLookupGlobalId replicatePAName - - return $ Builtins { - parrayTyCon = parrayTyCon - , paClass = paClass - , closureTyCon = closureTyCon - , mkClosureVar = mkClosureVar - , applyClosureVar = applyClosureVar - , mkClosurePVar = mkClosurePVar - , applyClosurePVar = applyClosurePVar - , lengthPAVar = lengthPAVar - , replicatePAVar = replicatePAVar - } - -data GlobalEnv = GlobalEnv { - -- Mapping from global variables to their vectorised versions. - -- - global_vars :: VarEnv CoreExpr - - -- Exported variables which have a vectorised version - -- - , global_exported_vars :: VarEnv (Var, Var) - - -- Mapping from TyCons to their vectorised versions. - -- TyCons which do not have to be vectorised are mapped to - -- themselves. - -- - , global_tycons :: NameEnv TyCon - - -- Mapping from TyCons to their PA dictionaries - -- - , global_tycon_pa :: NameEnv CoreExpr - - -- Mapping from DataCons to their vectorised versions - -- - , global_datacons :: NameEnv DataCon - - -- External package inst-env & home-package inst-env for class - -- instances - -- - , global_inst_env :: (InstEnv, InstEnv) - - -- External package inst-env & home-package inst-env for family - -- instances - -- - , global_fam_inst_env :: FamInstEnvs - - -- Hoisted bindings - , global_bindings :: [(Var, CoreExpr)] - } - -data LocalEnv = LocalEnv { - -- Mapping from local variables to their vectorised and - -- lifted versions - -- - local_vars :: VarEnv (CoreExpr, CoreExpr) - - -- In-scope type variables - -- - , local_tyvars :: [TyVar] - - -- Mapping from tyvars to their PA dictionaries - , local_tyvar_pa :: VarEnv CoreExpr - } - - -initGlobalEnv :: VectInfo -> (InstEnv, InstEnv) -> FamInstEnvs -> GlobalEnv -initGlobalEnv info instEnvs famInstEnvs - = GlobalEnv { - global_vars = mapVarEnv (Var . snd) $ vectInfoVar info - , global_exported_vars = emptyVarEnv - , global_tycons = mapNameEnv snd $ vectInfoTyCon info - , global_tycon_pa = emptyNameEnv - , global_datacons = mapNameEnv snd $ vectInfoDataCon info - , global_inst_env = instEnvs - , global_fam_inst_env = famInstEnvs - , global_bindings = [] - } - -emptyLocalEnv = LocalEnv { - local_vars = emptyVarEnv - , local_tyvars = [] - , local_tyvar_pa = emptyVarEnv - } - --- FIXME -updVectInfo :: GlobalEnv -> TypeEnv -> VectInfo -> VectInfo -updVectInfo env tyenv info - = info { - vectInfoVar = global_exported_vars env - , vectInfoTyCon = tc_env - , vectInfoDataCon = dc_env - } - where - tc_env = mkNameEnv [(tc_name, (tc,tc')) - | tc <- typeEnvTyCons tyenv - , let tc_name = tyConName tc - , Just tc' <- [lookupNameEnv (global_tycons env) tc_name]] - dc_env = mkNameEnv [(dc_name, (dc,dc')) - | dc <- typeEnvDataCons tyenv - , let dc_name = dataConName dc - , Just dc' <- [lookupNameEnv (global_datacons env) dc_name]] +-- The Vectorisation Monad ---------------------------------------------------- +-- Vectorisation can either succeed with new envionment and a value, +-- or return with failure. +-- data VResult a = Yes GlobalEnv LocalEnv a | No newtype VM a = VM { runVM :: Builtins -> GlobalEnv -> LocalEnv -> DsM (VResult a) } instance Monad VM where - return x = VM $ \bi genv lenv -> return (Yes genv lenv x) + return x = VM $ \_ genv lenv -> return (Yes genv lenv x) VM p >>= f = VM $ \bi genv lenv -> do r <- p bi genv lenv case r of Yes genv' lenv' x -> runVM (f x) bi genv' lenv' No -> return No + +-- | Throw an error saying we can't vectorise something +cantVectorise :: String -> SDoc -> a +cantVectorise s d = pgmError + . showSDocDump + $ vcat [text "*** Vectorisation error ***", + nest 4 $ sep [text s, nest 4 d]] + +maybeCantVectorise :: String -> SDoc -> Maybe a -> a +maybeCantVectorise s d Nothing = cantVectorise s d +maybeCantVectorise _ _ (Just x) = x + +maybeCantVectoriseM :: Monad m => String -> SDoc -> m (Maybe a) -> m a +maybeCantVectoriseM s d p + = do + r <- p + case r of + Just x -> return x + Nothing -> cantVectorise s d + + +-- Control -------------------------------------------------------------------- +-- | Return some result saying we've failed. noV :: VM a noV = VM $ \_ _ _ -> return No +traceNoV :: String -> SDoc -> VM a +traceNoV s d = pprTrace s d noV + + +-- | If True then carry on, otherwise fail. +ensureV :: Bool -> VM () +ensureV False = noV +ensureV True = return () + + +-- | If True then return the first argument, otherwise fail. +onlyIfV :: Bool -> VM a -> VM a +onlyIfV b p = ensureV b >> p + +traceEnsureV :: String -> SDoc -> Bool -> VM () +traceEnsureV s d False = traceNoV s d +traceEnsureV _ _ True = return () + + +-- | Try some vectorisation computaton. +-- If it succeeds then return Just the result, +-- otherwise return Nothing. tryV :: VM a -> VM (Maybe a) tryV (VM p) = VM $ \bi genv lenv -> do @@ -207,17 +140,28 @@ tryV (VM p) = VM $ \bi genv lenv -> Yes genv' lenv' x -> return (Yes genv' lenv' (Just x)) No -> return (Yes genv lenv Nothing) + maybeV :: VM (Maybe a) -> VM a maybeV p = maybe noV return =<< p +traceMaybeV :: String -> SDoc -> VM (Maybe a) -> VM a +traceMaybeV s d p = maybe (traceNoV s d) return =<< p + orElseV :: VM a -> VM a -> VM a orElseV p q = maybe q return =<< tryV p fixV :: (a -> VM a) -> VM a fixV f = VM (\bi genv lenv -> fixDs $ \r -> runVM (f (unYes r)) bi genv lenv ) where + -- NOTE: It is essential that we are lazy in r above so do not replace + -- calls to this function by an explicit case. unYes (Yes _ _ x) = x + unYes No = panic "VectMonad.fixV: no result" + +-- Local Environments --------------------------------------------------------- +-- | Perform a computation in its own local environment. +-- This does not alter the environment of the current state. localV :: VM a -> VM a localV p = do env <- readLEnv id @@ -225,22 +169,40 @@ localV p = do setLEnv env return x +-- | Perform a computation in an empty local environment. closedV :: VM a -> VM a closedV p = do env <- readLEnv id - setLEnv emptyLocalEnv + setLEnv (emptyLocalEnv { local_bind_name = local_bind_name env }) x <- p setLEnv env return x +-- Lifting -------------------------------------------------------------------- +-- | Lift a desugaring computation into the vectorisation monad. liftDs :: DsM a -> VM a -liftDs p = VM $ \bi genv lenv -> do { x <- p; return (Yes genv lenv x) } +liftDs p = VM $ \_ genv lenv -> do { x <- p; return (Yes genv lenv x) } + + +-- Builtins ------------------------------------------------------------------- +-- Operations on Builtins +liftBuiltinDs :: (Builtins -> DsM a) -> VM a +liftBuiltinDs p = VM $ \bi genv lenv -> do { x <- p bi; return (Yes genv lenv x)} + + +-- | Project something from the set of builtins. builtin :: (Builtins -> a) -> VM a builtin f = VM $ \bi genv lenv -> return (Yes genv lenv (f bi)) +builtins :: (a -> Builtins -> b) -> VM (a -> b) +builtins f = VM $ \bi genv lenv -> return (Yes genv lenv (`f` bi)) + + +-- Environments --------------------------------------------------------------- +-- | Project something from the global environment. readGEnv :: (GlobalEnv -> a) -> VM a -readGEnv f = VM $ \bi genv lenv -> return (Yes genv lenv (f genv)) +readGEnv f = VM $ \_ genv lenv -> return (Yes genv lenv (f genv)) setGEnv :: GlobalEnv -> VM () setGEnv genv = VM $ \_ _ lenv -> return (Yes genv lenv ()) @@ -248,21 +210,38 @@ setGEnv genv = VM $ \_ _ lenv -> return (Yes genv lenv ()) updGEnv :: (GlobalEnv -> GlobalEnv) -> VM () updGEnv f = VM $ \_ genv lenv -> return (Yes (f genv) lenv ()) + +-- | Project something from the local environment. readLEnv :: (LocalEnv -> a) -> VM a -readLEnv f = VM $ \bi genv lenv -> return (Yes genv lenv (f lenv)) +readLEnv f = VM $ \_ genv lenv -> return (Yes genv lenv (f lenv)) +-- | Set the local environment. setLEnv :: LocalEnv -> VM () setLEnv lenv = VM $ \_ genv _ -> return (Yes genv lenv ()) +-- | Update the enviroment using a provided function. updLEnv :: (LocalEnv -> LocalEnv) -> VM () updLEnv f = VM $ \_ genv lenv -> return (Yes genv (f lenv) ()) + +-- InstEnv -------------------------------------------------------------------- getInstEnv :: VM (InstEnv, InstEnv) getInstEnv = readGEnv global_inst_env getFamInstEnv :: VM FamInstEnvs getFamInstEnv = readGEnv global_fam_inst_env + +-- Names ---------------------------------------------------------------------- +-- | Get the name of the local binding currently being vectorised. +getBindName :: VM FastString +getBindName = readLEnv local_bind_name + +inBind :: Id -> VM a -> VM a +inBind id p + = do updLEnv $ \env -> env { local_bind_name = occNameFS (getOccName id) } + p + cloneName :: (OccName -> OccName) -> Name -> VM Name cloneName mk_occ name = liftM make (liftDs newUnique) where @@ -273,41 +252,136 @@ cloneName mk_occ name = liftM make (liftDs newUnique) (nameSrcSpan name) | otherwise = mkSystemName u occ_name +cloneId :: (OccName -> OccName) -> Id -> Type -> VM Id +cloneId mk_occ id ty + = do + name <- cloneName mk_occ (getName id) + let id' | isExportedId id = Id.mkExportedLocalId name ty + | otherwise = Id.mkLocalId name ty + return id' + +-- Make a fresh instance of this var, with a new unique. +cloneVar :: Var -> VM Var +cloneVar var = liftM (setIdUnique var) (liftDs newUnique) + +newExportedVar :: OccName -> Type -> VM Var +newExportedVar occ_name ty + = do + mod <- liftDs getModuleDs + u <- liftDs newUnique + + let name = mkExternalName u mod occ_name noSrcSpan + + return $ Id.mkExportedLocalId name ty + newLocalVar :: FastString -> Type -> VM Var newLocalVar fs ty = do u <- liftDs newUnique return $ mkSysLocal fs u ty +newLocalVars :: FastString -> [Type] -> VM [Var] +newLocalVars fs = mapM (newLocalVar fs) + +newDummyVar :: Type -> VM Var +newDummyVar = newLocalVar (fsLit "vv") + newTyVar :: FastString -> Kind -> VM Var newTyVar fs k = do u <- liftDs newUnique return $ mkTyVar (mkSysTvName u fs) k + +-- | Add a mapping between a global var and its vectorised version to the state. defGlobalVar :: Var -> Var -> VM () defGlobalVar v v' = updGEnv $ \env -> - env { global_vars = extendVarEnv (global_vars env) v (Var v') + env { global_vars = extendVarEnv (global_vars env) v v' , global_exported_vars = upd (global_exported_vars env) } where upd env | isExportedId v = extendVarEnv env v (v, v') | otherwise = env -lookupVar :: Var -> VM (Scope CoreExpr (CoreExpr, CoreExpr)) +-- Var ------------------------------------------------------------------------ +-- | Lookup the vectorised and\/or lifted versions of this variable. +-- If it's in the global environment we get the vectorised version. +-- If it's in the local environment we get both the vectorised and lifted version. +-- +lookupVar :: Var -> VM (Scope Var (Var, Var)) lookupVar v - = do - r <- readLEnv $ \env -> lookupVarEnv (local_vars env) v + = do r <- readLEnv $ \env -> lookupVarEnv (local_vars env) v case r of Just e -> return (Local e) Nothing -> liftM Global - $ maybeV (readGEnv $ \env -> lookupVarEnv (global_vars env) v) + . maybeCantVectoriseVarM v + . readGEnv $ \env -> lookupVarEnv (global_vars env) v + +maybeCantVectoriseVarM :: Monad m => Var -> m (Maybe Var) -> m Var +maybeCantVectoriseVarM v p + = do r <- p + case r of + Just x -> return x + Nothing -> dumpVar v + +dumpVar :: Var -> a +dumpVar var + | Just _ <- isClassOpId_maybe var + = cantVectorise "ClassOpId not vectorised:" (ppr var) + + | otherwise + = cantVectorise "Variable not vectorised:" (ppr var) + +------------------------------------------------------------------------------- +globalScalars :: VM VarSet +globalScalars = readGEnv global_scalars lookupTyCon :: TyCon -> VM (Maybe TyCon) -lookupTyCon tc = readGEnv $ \env -> lookupNameEnv (global_tycons env) (tyConName tc) +lookupTyCon tc + | isUnLiftedTyCon tc || isTupleTyCon tc = return (Just tc) + + | otherwise = readGEnv $ \env -> lookupNameEnv (global_tycons env) (tyConName tc) + +defTyCon :: TyCon -> TyCon -> VM () +defTyCon tc tc' = updGEnv $ \env -> + env { global_tycons = extendNameEnv (global_tycons env) (tyConName tc) tc' } + +lookupDataCon :: DataCon -> VM (Maybe DataCon) +lookupDataCon dc + | isTupleTyCon (dataConTyCon dc) = return (Just dc) + | otherwise = readGEnv $ \env -> lookupNameEnv (global_datacons env) (dataConName dc) + +defDataCon :: DataCon -> DataCon -> VM () +defDataCon dc dc' = updGEnv $ \env -> + env { global_datacons = extendNameEnv (global_datacons env) (dataConName dc) dc' } + +lookupPrimPArray :: TyCon -> VM (Maybe TyCon) +lookupPrimPArray = liftBuiltinDs . primPArray + +lookupPrimMethod :: TyCon -> String -> VM (Maybe Var) +lookupPrimMethod tycon = liftBuiltinDs . primMethod tycon + +lookupTyConPA :: TyCon -> VM (Maybe Var) +lookupTyConPA tc = readGEnv $ \env -> lookupNameEnv (global_pa_funs env) (tyConName tc) + +defTyConPA :: TyCon -> Var -> VM () +defTyConPA tc pa = updGEnv $ \env -> + env { global_pa_funs = extendNameEnv (global_pa_funs env) (tyConName tc) pa } + +defTyConPAs :: [(TyCon, Var)] -> VM () +defTyConPAs ps = updGEnv $ \env -> + env { global_pa_funs = extendNameEnvList (global_pa_funs env) + [(tyConName tc, pa) | (tc, pa) <- ps] } lookupTyVarPA :: Var -> VM (Maybe CoreExpr) -lookupTyVarPA tv = readLEnv $ \env -> lookupVarEnv (local_tyvar_pa env) tv +lookupTyVarPA tv = readLEnv $ \env -> lookupVarEnv (local_tyvar_pa env) tv + +lookupTyConPR :: TyCon -> VM (Maybe Var) +lookupTyConPR tc = readGEnv $ \env -> lookupNameEnv (global_pr_funs env) (tyConName tc) + +lookupBoxedTyCon :: TyCon -> VM (Maybe TyCon) +lookupBoxedTyCon tc = readGEnv $ \env -> lookupNameEnv (global_boxed_tycons env) + (tyConName tc) defLocalTyVar :: TyVar -> VM () defLocalTyVar tv = updLEnv $ \env -> @@ -344,7 +418,8 @@ lookupInst cls tys where inst_tys' = [ty | Right ty <- inst_tys] noFlexiVar = all isRight inst_tys - _other -> noV + _other -> + pprPanic "VectMonad.lookupInst: not found " (ppr cls <+> ppr tys) } where isRight (Left _) = False @@ -377,25 +452,46 @@ lookupFamInst tycon tys (ppr $ mkTyConApp tycon tys) } -initV :: HscEnv -> ModGuts -> VectInfo -> VM a -> IO (Maybe (VectInfo, a)) -initV hsc_env guts info p - = do - eps <- hscEPS hsc_env - let famInstEnvs = (eps_fam_inst_env eps, mg_fam_inst_env guts) - let instEnvs = (eps_inst_env eps, mg_inst_env guts) - Just r <- initDs hsc_env (mg_module guts) +-- | Run a vectorisation computation. +initV :: PackageId -> HscEnv -> ModGuts -> VectInfo -> VM a -> IO (Maybe (VectInfo, a)) +initV pkg hsc_env guts info p + = do + -- XXX: ignores error messages and warnings, check that this is + -- indeed ok (the use of "Just r" suggests so) + (_,Just r) <- initDs hsc_env (mg_module guts) (mg_rdr_env guts) (mg_types guts) - (go instEnvs famInstEnvs) + go return r where - go instEnvs famInstEnvs = + go = do - builtins <- initBuiltins - r <- runVM p builtins (initGlobalEnv info instEnvs famInstEnvs) - emptyLocalEnv + builtins <- initBuiltins pkg + builtin_vars <- initBuiltinVars builtins + builtin_tycons <- initBuiltinTyCons builtins + let builtin_datacons = initBuiltinDataCons builtins + builtin_boxed <- initBuiltinBoxedTyCons builtins + builtin_scalars <- initBuiltinScalars builtins + + eps <- liftIO $ hscEPS hsc_env + let famInstEnvs = (eps_fam_inst_env eps, mg_fam_inst_env guts) + instEnvs = (eps_inst_env eps, mg_inst_env guts) + + builtin_prs <- initBuiltinPRs builtins instEnvs + builtin_pas <- initBuiltinPAs builtins instEnvs + + let genv = extendImportedVarsEnv builtin_vars + . extendScalars builtin_scalars + . extendTyConsEnv builtin_tycons + . extendDataConsEnv builtin_datacons + . extendPAFunsEnv builtin_pas + . setPRFunsEnv builtin_prs + . setBoxedTyConsEnv builtin_boxed + $ initGlobalEnv info instEnvs famInstEnvs + + r <- runVM p builtins genv emptyLocalEnv case r of Yes genv _ x -> return $ Just (new_info genv, x) No -> return Nothing