5 noV, tryV, maybeV, orElseV, fixV, localV, closedV, initV,
6 cloneName, newLocalVar, newTyVar,
8 Builtins(..), paDictTyCon,
12 readGEnv, setGEnv, updGEnv,
15 readLEnv, setLEnv, updLEnv,
17 defGlobalVar, lookupVar,
19 lookupTyVarPA, defLocalTyVar, defLocalTyVarWithPA, localTyVars,
21 lookupInst, lookupFamInst
24 #include "HsVersions.h"
49 import Control.Monad ( liftM )
51 data Scope a b = Global a | Local b
53 -- ----------------------------------------------------------------------------
54 -- Vectorisation monad
56 data Builtins = Builtins {
59 , closureTyCon :: TyCon
61 , applyClosureVar :: Var
62 , mkClosurePVar :: Var
63 , applyClosurePVar :: Var
65 , replicatePAVar :: Var
68 paDictTyCon :: Builtins -> TyCon
69 paDictTyCon = classTyCon . paClass
71 initBuiltins :: DsM Builtins
74 parrayTyCon <- dsLookupTyCon parrayTyConName
75 paClass <- dsLookupClass paClassName
76 closureTyCon <- dsLookupTyCon closureTyConName
78 mkClosureVar <- dsLookupGlobalId mkClosureName
79 applyClosureVar <- dsLookupGlobalId applyClosureName
80 mkClosurePVar <- dsLookupGlobalId mkClosurePName
81 applyClosurePVar <- dsLookupGlobalId applyClosurePName
82 lengthPAVar <- dsLookupGlobalId lengthPAName
83 replicatePAVar <- dsLookupGlobalId replicatePAName
86 parrayTyCon = parrayTyCon
88 , closureTyCon = closureTyCon
89 , mkClosureVar = mkClosureVar
90 , applyClosureVar = applyClosureVar
91 , mkClosurePVar = mkClosurePVar
92 , applyClosurePVar = applyClosurePVar
93 , lengthPAVar = lengthPAVar
94 , replicatePAVar = replicatePAVar
97 data GlobalEnv = GlobalEnv {
98 -- Mapping from global variables to their vectorised versions.
100 global_vars :: VarEnv CoreExpr
102 -- Exported variables which have a vectorised version
104 , global_exported_vars :: VarEnv (Var, Var)
106 -- Mapping from TyCons to their vectorised versions.
107 -- TyCons which do not have to be vectorised are mapped to
110 , global_tycons :: NameEnv TyCon
112 -- Mapping from DataCons to their vectorised versions
114 , global_datacons :: NameEnv DataCon
116 -- External package inst-env & home-package inst-env for class
119 , global_inst_env :: (InstEnv, InstEnv)
121 -- External package inst-env & home-package inst-env for family
124 , global_fam_inst_env :: FamInstEnvs
127 , global_bindings :: [(Var, CoreExpr)]
130 data LocalEnv = LocalEnv {
131 -- Mapping from local variables to their vectorised and
134 local_vars :: VarEnv (CoreExpr, CoreExpr)
136 -- In-scope type variables
138 , local_tyvars :: [TyVar]
140 -- Mapping from tyvars to their PA dictionaries
141 , local_tyvar_pa :: VarEnv CoreExpr
145 initGlobalEnv :: VectInfo -> (InstEnv, InstEnv) -> FamInstEnvs -> GlobalEnv
146 initGlobalEnv info instEnvs famInstEnvs
148 global_vars = mapVarEnv (Var . snd) $ vectInfoVar info
149 , global_exported_vars = emptyVarEnv
150 , global_tycons = mapNameEnv snd $ vectInfoTyCon info
151 , global_datacons = mapNameEnv snd $ vectInfoDataCon info
152 , global_inst_env = instEnvs
153 , global_fam_inst_env = famInstEnvs
154 , global_bindings = []
157 emptyLocalEnv = LocalEnv {
158 local_vars = emptyVarEnv
160 , local_tyvar_pa = emptyVarEnv
164 updVectInfo :: GlobalEnv -> TypeEnv -> VectInfo -> VectInfo
165 updVectInfo env tyenv info
167 vectInfoVar = global_exported_vars env
168 , vectInfoTyCon = mk_env typeEnvTyCons global_tycons
169 , vectInfoDataCon = mk_env typeEnvDataCons global_datacons
172 mk_env from_tyenv from_env = mkNameEnv [(name, (from,to))
173 | from <- from_tyenv tyenv
174 , let name = getName from
175 , Just to <- [lookupNameEnv (from_env env) name]]
177 data VResult a = Yes GlobalEnv LocalEnv a | No
179 newtype VM a = VM { runVM :: Builtins -> GlobalEnv -> LocalEnv -> DsM (VResult a) }
181 instance Monad VM where
182 return x = VM $ \bi genv lenv -> return (Yes genv lenv x)
183 VM p >>= f = VM $ \bi genv lenv -> do
186 Yes genv' lenv' x -> runVM (f x) bi genv' lenv'
190 noV = VM $ \_ _ _ -> return No
192 tryV :: VM a -> VM (Maybe a)
193 tryV (VM p) = VM $ \bi genv lenv ->
197 Yes genv' lenv' x -> return (Yes genv' lenv' (Just x))
198 No -> return (Yes genv lenv Nothing)
200 maybeV :: VM (Maybe a) -> VM a
201 maybeV p = maybe noV return =<< p
203 orElseV :: VM a -> VM a -> VM a
204 orElseV p q = maybe q return =<< tryV p
206 fixV :: (a -> VM a) -> VM a
207 fixV f = VM (\bi genv lenv -> fixDs $ \r -> runVM (f (unYes r)) bi genv lenv )
209 unYes (Yes _ _ x) = x
211 localV :: VM a -> VM a
218 closedV :: VM a -> VM a
221 setLEnv emptyLocalEnv
226 liftDs :: DsM a -> VM a
227 liftDs p = VM $ \bi genv lenv -> do { x <- p; return (Yes genv lenv x) }
229 builtin :: (Builtins -> a) -> VM a
230 builtin f = VM $ \bi genv lenv -> return (Yes genv lenv (f bi))
232 readGEnv :: (GlobalEnv -> a) -> VM a
233 readGEnv f = VM $ \bi genv lenv -> return (Yes genv lenv (f genv))
235 setGEnv :: GlobalEnv -> VM ()
236 setGEnv genv = VM $ \_ _ lenv -> return (Yes genv lenv ())
238 updGEnv :: (GlobalEnv -> GlobalEnv) -> VM ()
239 updGEnv f = VM $ \_ genv lenv -> return (Yes (f genv) lenv ())
241 readLEnv :: (LocalEnv -> a) -> VM a
242 readLEnv f = VM $ \bi genv lenv -> return (Yes genv lenv (f lenv))
244 setLEnv :: LocalEnv -> VM ()
245 setLEnv lenv = VM $ \_ genv _ -> return (Yes genv lenv ())
247 updLEnv :: (LocalEnv -> LocalEnv) -> VM ()
248 updLEnv f = VM $ \_ genv lenv -> return (Yes genv (f lenv) ())
250 getInstEnv :: VM (InstEnv, InstEnv)
251 getInstEnv = readGEnv global_inst_env
253 getFamInstEnv :: VM FamInstEnvs
254 getFamInstEnv = readGEnv global_fam_inst_env
256 cloneName :: (OccName -> OccName) -> Name -> VM Name
257 cloneName mk_occ name = liftM make (liftDs newUnique)
259 occ_name = mk_occ (nameOccName name)
261 make u | isExternalName name = mkExternalName u (nameModule name)
264 | otherwise = mkSystemName u occ_name
266 newLocalVar :: FastString -> Type -> VM Var
269 u <- liftDs newUnique
270 return $ mkSysLocal fs u ty
272 newTyVar :: FastString -> Kind -> VM Var
275 u <- liftDs newUnique
276 return $ mkTyVar (mkSysTvName u fs) k
278 defGlobalVar :: Var -> Var -> VM ()
279 defGlobalVar v v' = updGEnv $ \env ->
280 env { global_vars = extendVarEnv (global_vars env) v (Var v')
281 , global_exported_vars = upd (global_exported_vars env)
284 upd env | isExportedId v = extendVarEnv env v (v, v')
287 lookupVar :: Var -> VM (Scope CoreExpr (CoreExpr, CoreExpr))
290 r <- readLEnv $ \env -> lookupVarEnv (local_vars env) v
292 Just e -> return (Local e)
293 Nothing -> liftM Global
294 $ maybeV (readGEnv $ \env -> lookupVarEnv (global_vars env) v)
296 lookupTyCon :: TyCon -> VM (Maybe TyCon)
297 lookupTyCon tc = readGEnv $ \env -> lookupNameEnv (global_tycons env) (tyConName tc)
299 lookupTyVarPA :: Var -> VM (Maybe CoreExpr)
300 lookupTyVarPA tv = readLEnv $ \env -> lookupVarEnv (local_tyvar_pa env) tv
302 defLocalTyVar :: TyVar -> VM ()
303 defLocalTyVar tv = updLEnv $ \env ->
304 env { local_tyvars = tv : local_tyvars env
305 , local_tyvar_pa = local_tyvar_pa env `delVarEnv` tv
308 defLocalTyVarWithPA :: TyVar -> CoreExpr -> VM ()
309 defLocalTyVarWithPA tv pa = updLEnv $ \env ->
310 env { local_tyvars = tv : local_tyvars env
311 , local_tyvar_pa = extendVarEnv (local_tyvar_pa env) tv pa
314 localTyVars :: VM [TyVar]
315 localTyVars = readLEnv (reverse . local_tyvars)
317 -- Look up the dfun of a class instance.
319 -- The match must be unique - ie, match exactly one instance - but the
320 -- type arguments used for matching may be more specific than those of
321 -- the class instance declaration. The found class instances must not have
322 -- any type variables in the instance context that do not appear in the
323 -- instances head (i.e., no flexi vars); for details for what this means,
324 -- see the docs at InstEnv.lookupInstEnv.
326 lookupInst :: Class -> [Type] -> VM (DFunId, [Type])
328 = do { instEnv <- getInstEnv
329 ; case lookupInstEnv instEnv cls tys of
330 ([(inst, inst_tys)], _)
331 | noFlexiVar -> return (instanceDFunId inst, inst_tys')
332 | otherwise -> pprPanic "VectMonad.lookupInst: flexi var: "
333 (ppr $ mkTyConApp (classTyCon cls) tys)
335 inst_tys' = [ty | Right ty <- inst_tys]
336 noFlexiVar = all isRight inst_tys
340 isRight (Left _) = False
341 isRight (Right _) = True
343 -- Look up the representation tycon of a family instance.
345 -- The match must be unique - ie, match exactly one instance - but the
346 -- type arguments used for matching may be more specific than those of
347 -- the family instance declaration.
349 -- Return the instance tycon and its type instance. For example, if we have
351 -- lookupFamInst 'T' '[Int]' yields (':R42T', 'Int')
353 -- then we have a coercion (ie, type instance of family instance coercion)
355 -- :Co:R42T Int :: T [Int] ~ :R42T Int
357 -- which implies that :R42T was declared as 'data instance T [a]'.
359 lookupFamInst :: TyCon -> [Type] -> VM (TyCon, [Type])
360 lookupFamInst tycon tys
361 = ASSERT( isOpenTyCon tycon )
362 do { instEnv <- getFamInstEnv
363 ; case lookupFamInstEnv instEnv tycon tys of
364 [(fam_inst, rep_tys)] -> return (famInstTyCon fam_inst, rep_tys)
366 pprPanic "VectMonad.lookupFamInst: not found: "
367 (ppr $ mkTyConApp tycon tys)
370 initV :: HscEnv -> ModGuts -> VectInfo -> VM a -> IO (Maybe (VectInfo, a))
371 initV hsc_env guts info p
373 eps <- hscEPS hsc_env
374 let famInstEnvs = (eps_fam_inst_env eps, mg_fam_inst_env guts)
375 let instEnvs = (eps_inst_env eps, mg_inst_env guts)
377 Just r <- initDs hsc_env (mg_module guts)
380 (go instEnvs famInstEnvs)
384 go instEnvs famInstEnvs =
386 builtins <- initBuiltins
387 r <- runVM p builtins (initGlobalEnv info instEnvs famInstEnvs)
390 Yes genv _ x -> return $ Just (new_info genv, x)
393 new_info genv = updVectInfo genv (mg_types guts) info