X-Git-Url: http://git.megacz.com/?a=blobdiff_plain;f=compiler%2Fvectorise%2FVectMonad.hs;h=65a348919bfcafd8e98cc5685802c0e10122ea2b;hb=d2ce0f52d42edf32bb9f13796e6ba6edba8bd516;hp=4ae6c17ecb6002f6e7f2292d1ffe1b189066575d;hpb=71fcb04ece12be6c4e94b50f4178610eb1c8df91;p=ghc-hetmet.git diff --git a/compiler/vectorise/VectMonad.hs b/compiler/vectorise/VectMonad.hs index 4ae6c17..65a3489 100644 --- a/compiler/vectorise/VectMonad.hs +++ b/compiler/vectorise/VectMonad.hs @@ -1,26 +1,29 @@ +{-# LANGUAGE NamedFieldPuns #-} + +-- | The Vectorisation monad. module VectMonad ( - Scope(..), VM, - noV, tryV, maybeV, traceMaybeV, orElseV, fixV, localV, closedV, initV, + noV, traceNoV, ensureV, traceEnsureV, tryV, maybeV, traceMaybeV, orElseV, + onlyIfV, fixV, localV, closedV, + initV, cantVectorise, maybeCantVectorise, maybeCantVectoriseM, liftDs, cloneName, cloneId, cloneVar, - newExportedVar, newLocalVar, newDummyVar, newTyVar, + newExportedVar, newLocalVar, newLocalVars, newDummyVar, newTyVar, - Builtins(..), sumTyCon, prodTyCon, uarrTy, intPrimArrayTy, - combinePAVar, + Builtins(..), sumTyCon, prodTyCon, prodDataCon, + selTy, selReplicate, selPick, selTags, selElements, + combinePDVar, scalarZip, closureCtrFun, builtin, builtins, - GlobalEnv(..), setFamInstEnv, readGEnv, setGEnv, updGEnv, - LocalEnv(..), readLEnv, setLEnv, updLEnv, getBindName, inBind, - lookupVar, defGlobalVar, + lookupVar, defGlobalVar, globalScalars, lookupTyCon, defTyCon, lookupDataCon, defDataCon, lookupTyConPA, defTyConPA, defTyConPAs, @@ -29,24 +32,27 @@ module VectMonad ( lookupPrimMethod, lookupPrimPArray, lookupTyVarPA, defLocalTyVar, defLocalTyVarWithPA, localTyVars, - {-lookupInst,-} lookupFamInst + lookupInst, lookupFamInst ) where #include "HsVersions.h" import VectBuiltIn +import Vectorise.Env -import HscTypes +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 Name import NameEnv -import IOEnv ( liftIO ) import DsMonad @@ -59,54 +65,59 @@ import SrcLoc ( noSrcSpan ) import Control.Monad +-- | Indicates what scope something (a variable) is in. data Scope a b = Global a | Local b --- ---------------------------------------------------------------------------- --- Vectorisation monad +-- | The global environment. data GlobalEnv = GlobalEnv { - -- Mapping from global variables to their vectorised versions. + -- | Mapping from global variables to their vectorised versions. -- global_vars :: VarEnv Var - -- Exported variables which have a vectorised version + -- | Purely scalar variables. Code which mentions only these + -- variables doesn't have to be lifted. + , global_scalars :: VarSet + + -- | 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. + -- | 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 DataCons to their vectorised versions + -- | Mapping from DataCons to their vectorised versions -- , global_datacons :: NameEnv DataCon - -- Mapping from TyCons to their PA dfuns + -- | Mapping from TyCons to their PA dfuns -- , global_pa_funs :: NameEnv Var - -- Mapping from TyCons to their PR dfuns + -- | Mapping from TyCons to their PR dfuns , global_pr_funs :: NameEnv Var - -- Mapping from unboxed TyCons to their boxed versions + -- | Mapping from unboxed TyCons to their boxed versions , global_boxed_tycons :: NameEnv TyCon - -- External package inst-env & home-package inst-env for class - -- instances + -- | 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 + -- | External package inst-env & home-package inst-env for family + -- instances -- , global_fam_inst_env :: FamInstEnvs - -- Hoisted bindings + -- | Hoisted bindings , global_bindings :: [(Var, CoreExpr)] } +-- | The local environment. data LocalEnv = LocalEnv { -- Mapping from local variables to their vectorised and -- lifted versions @@ -124,10 +135,13 @@ data LocalEnv = LocalEnv { , local_bind_name :: FastString } + +-- | Create an initial global environment initGlobalEnv :: VectInfo -> (InstEnv, InstEnv) -> FamInstEnvs -> GlobalEnv initGlobalEnv info instEnvs famInstEnvs = GlobalEnv { global_vars = mapVarEnv snd $ vectInfoVar info + , global_scalars = emptyVarSet , global_exported_vars = emptyVarEnv , global_tycons = mapNameEnv snd $ vectInfoTyCon info , global_datacons = mapNameEnv snd $ vectInfoDataCon info @@ -139,10 +153,16 @@ initGlobalEnv info instEnvs famInstEnvs , global_bindings = [] } + +-- Operators on Global Environments ------------------------------------------- extendImportedVarsEnv :: [(Var, Var)] -> GlobalEnv -> GlobalEnv extendImportedVarsEnv ps genv = genv { global_vars = extendVarEnvList (global_vars genv) ps } +extendScalars :: [Var] -> GlobalEnv -> GlobalEnv +extendScalars vs genv + = genv { global_scalars = extendVarSetList (global_scalars genv) vs } + setFamInstEnv :: FamInstEnv -> GlobalEnv -> GlobalEnv setFamInstEnv l_fam_inst genv = genv { global_fam_inst_env = (g_fam_inst, l_fam_inst) } @@ -169,6 +189,8 @@ setBoxedTyConsEnv :: [(Name, TyCon)] -> GlobalEnv -> GlobalEnv setBoxedTyConsEnv ps genv = genv { global_boxed_tycons = mkNameEnv ps } + +-- | Create an empty local environment. emptyLocalEnv :: LocalEnv emptyLocalEnv = LocalEnv { local_vars = emptyVarEnv @@ -187,11 +209,20 @@ updVectInfo env tyenv info , vectInfoPADFun = mk_env typeEnvTyCons global_pa_funs } where + mk_env :: NamedThing from => + (TypeEnv -> [from]) + -> (GlobalEnv -> NameEnv to) + -> NameEnv (from,to) mk_env from_tyenv from_env = mkNameEnv [(name, (from,to)) | from <- from_tyenv tyenv , let name = getName from , Just to <- [lookupNameEnv (from_env env) 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) } @@ -204,12 +235,54 @@ instance Monad VM where 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 @@ -218,6 +291,7 @@ 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 @@ -235,6 +309,10 @@ fixV f = VM (\bi genv lenv -> fixDs $ \r -> runVM (f (unYes r)) bi genv lenv ) 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 @@ -242,6 +320,7 @@ 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 @@ -250,15 +329,29 @@ closedV p = do setLEnv env return x +-- Lifting -------------------------------------------------------------------- +-- | Lift a desugaring computation into the vectorisation monad. liftDs :: DsM a -> VM a 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 $ \_ genv lenv -> return (Yes genv lenv (f genv)) @@ -268,23 +361,30 @@ 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 $ \_ 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 @@ -311,6 +411,7 @@ cloneId mk_occ id 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) @@ -330,8 +431,11 @@ newLocalVar fs ty 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 "ds") +newDummyVar = newLocalVar (fsLit "vv") newTyVar :: FastString -> Kind -> VM Var newTyVar fs k @@ -339,6 +443,8 @@ newTyVar fs k 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 v' @@ -348,15 +454,38 @@ defGlobalVar v v' = updGEnv $ \env -> upd env | isExportedId v = extendVarEnv env v (v, v') | otherwise = env +-- 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 - $ traceMaybeV "lookupVar" (ppr v) - (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 @@ -378,10 +507,10 @@ defDataCon dc dc' = updGEnv $ \env -> env { global_datacons = extendNameEnv (global_datacons env) (dataConName dc) dc' } lookupPrimPArray :: TyCon -> VM (Maybe TyCon) -lookupPrimPArray = liftDs . primPArray +lookupPrimPArray = liftBuiltinDs . primPArray lookupPrimMethod :: TyCon -> String -> VM (Maybe Var) -lookupPrimMethod tycon = liftDs . primMethod tycon +lookupPrimMethod tycon = liftBuiltinDs . primMethod tycon lookupTyConPA :: TyCon -> VM (Maybe Var) lookupTyConPA tc = readGEnv $ \env -> lookupNameEnv (global_pa_funs env) (tyConName tc) @@ -429,7 +558,6 @@ localTyVars = readLEnv (reverse . local_tyvars) -- instances head (i.e., no flexi vars); for details for what this means, -- see the docs at InstEnv.lookupInstEnv. -- -{- lookupInst :: Class -> [Type] -> VM (DFunId, [Type]) lookupInst cls tys = do { instEnv <- getInstEnv @@ -441,12 +569,12 @@ lookupInst cls tys where inst_tys' = [ty | Right ty <- inst_tys] noFlexiVar = all isRight inst_tys - _other -> traceNoV "lookupInst" (ppr cls <+> ppr tys) + _other -> + pprPanic "VectMonad.lookupInst: not found " (ppr cls <+> ppr tys) } where isRight (Left _) = False isRight (Right _) = True --} -- Look up the representation tycon of a family instance. -- @@ -466,7 +594,7 @@ lookupInst cls tys -- lookupFamInst :: TyCon -> [Type] -> VM (TyCon, [Type]) lookupFamInst tycon tys - = ASSERT( isOpenTyCon tycon ) + = ASSERT( isFamilyTyCon tycon ) do { instEnv <- getFamInstEnv ; case lookupFamInstEnv instEnv tycon tys of [(fam_inst, rep_tys)] -> return (famInstTyCon fam_inst, rep_tys) @@ -475,10 +603,14 @@ lookupFamInst tycon tys (ppr $ mkTyConApp tycon tys) } -initV :: HscEnv -> ModGuts -> VectInfo -> VM a -> IO (Maybe (VectInfo, a)) -initV hsc_env guts info p + +-- | Run a vectorisation computation. +initV :: PackageId -> HscEnv -> ModGuts -> VectInfo -> VM a -> IO (Maybe (VectInfo, a)) +initV pkg hsc_env guts info p = do - Just r <- initDs hsc_env (mg_module guts) + -- 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 @@ -487,19 +619,22 @@ initV hsc_env guts info p go = do - builtins <- initBuiltins + builtins <- initBuiltins pkg builtin_vars <- initBuiltinVars builtins builtin_tycons <- initBuiltinTyCons builtins let builtin_datacons = initBuiltinDataCons builtins - builtin_pas <- initBuiltinPAs builtins - builtin_prs <- initBuiltinPRs 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