5 noV, tryV, maybeV, orElseV, fixV, localV, closedV, initV,
6 cloneName, newLocalVar, newTyVar,
8 Builtins(..), paDictTyCon,
13 readGEnv, setGEnv, updGEnv,
16 readLEnv, setLEnv, updLEnv,
18 lookupVar, defGlobalVar,
19 lookupTyCon, defTyCon,
20 lookupDataCon, defDataCon,
21 lookupTyVarPA, defLocalTyVar, defLocalTyVarWithPA, localTyVars,
23 lookupInst, lookupFamInst
26 #include "HsVersions.h"
51 import Control.Monad ( liftM )
53 data Scope a b = Global a | Local b
55 -- ----------------------------------------------------------------------------
56 -- Vectorisation monad
58 data Builtins = Builtins {
61 , closureTyCon :: TyCon
63 , applyClosureVar :: Var
64 , mkClosurePVar :: Var
65 , applyClosurePVar :: Var
67 , replicatePAVar :: Var
71 paDictTyCon :: Builtins -> TyCon
72 paDictTyCon = classTyCon . paClass
74 initBuiltins :: DsM Builtins
77 parrayTyCon <- dsLookupTyCon parrayTyConName
78 paClass <- dsLookupClass paClassName
79 closureTyCon <- dsLookupTyCon closureTyConName
81 mkClosureVar <- dsLookupGlobalId mkClosureName
82 applyClosureVar <- dsLookupGlobalId applyClosureName
83 mkClosurePVar <- dsLookupGlobalId mkClosurePName
84 applyClosurePVar <- dsLookupGlobalId applyClosurePName
85 lengthPAVar <- dsLookupGlobalId lengthPAName
86 replicatePAVar <- dsLookupGlobalId replicatePAName
87 emptyPAVar <- dsLookupGlobalId emptyPAName
90 parrayTyCon = parrayTyCon
92 , closureTyCon = closureTyCon
93 , mkClosureVar = mkClosureVar
94 , applyClosureVar = applyClosureVar
95 , mkClosurePVar = mkClosurePVar
96 , applyClosurePVar = applyClosurePVar
97 , lengthPAVar = lengthPAVar
98 , replicatePAVar = replicatePAVar
99 , emptyPAVar = emptyPAVar
102 data GlobalEnv = GlobalEnv {
103 -- Mapping from global variables to their vectorised versions.
105 global_vars :: VarEnv CoreExpr
107 -- Exported variables which have a vectorised version
109 , global_exported_vars :: VarEnv (Var, Var)
111 -- Mapping from TyCons to their vectorised versions.
112 -- TyCons which do not have to be vectorised are mapped to
115 , global_tycons :: NameEnv TyCon
117 -- Mapping from DataCons to their vectorised versions
119 , global_datacons :: NameEnv DataCon
121 -- External package inst-env & home-package inst-env for class
124 , global_inst_env :: (InstEnv, InstEnv)
126 -- External package inst-env & home-package inst-env for family
129 , global_fam_inst_env :: FamInstEnvs
132 , global_bindings :: [(Var, CoreExpr)]
135 data LocalEnv = LocalEnv {
136 -- Mapping from local variables to their vectorised and
139 local_vars :: VarEnv (CoreExpr, CoreExpr)
141 -- In-scope type variables
143 , local_tyvars :: [TyVar]
145 -- Mapping from tyvars to their PA dictionaries
146 , local_tyvar_pa :: VarEnv CoreExpr
150 initGlobalEnv :: VectInfo -> (InstEnv, InstEnv) -> FamInstEnvs -> Builtins -> GlobalEnv
151 initGlobalEnv info instEnvs famInstEnvs bi
153 global_vars = mapVarEnv (Var . snd) $ vectInfoVar info
154 , global_exported_vars = emptyVarEnv
155 , global_tycons = extendNameEnv (mapNameEnv snd (vectInfoTyCon info))
156 (tyConName funTyCon) (closureTyCon bi)
158 , global_datacons = mapNameEnv snd $ vectInfoDataCon info
159 , global_inst_env = instEnvs
160 , global_fam_inst_env = famInstEnvs
161 , global_bindings = []
164 setInstEnvs :: InstEnv -> FamInstEnv -> GlobalEnv -> GlobalEnv
165 setInstEnvs l_inst l_fam_inst genv
166 | (g_inst, _) <- global_inst_env genv
167 , (g_fam_inst, _) <- global_fam_inst_env genv
168 = genv { global_inst_env = (g_inst, l_inst)
169 , global_fam_inst_env = (g_fam_inst, l_fam_inst) }
171 emptyLocalEnv = LocalEnv {
172 local_vars = emptyVarEnv
174 , local_tyvar_pa = emptyVarEnv
178 updVectInfo :: GlobalEnv -> TypeEnv -> VectInfo -> VectInfo
179 updVectInfo env tyenv info
181 vectInfoVar = global_exported_vars env
182 , vectInfoTyCon = mk_env typeEnvTyCons global_tycons
183 , vectInfoDataCon = mk_env typeEnvDataCons global_datacons
186 mk_env from_tyenv from_env = mkNameEnv [(name, (from,to))
187 | from <- from_tyenv tyenv
188 , let name = getName from
189 , Just to <- [lookupNameEnv (from_env env) name]]
191 data VResult a = Yes GlobalEnv LocalEnv a | No
193 newtype VM a = VM { runVM :: Builtins -> GlobalEnv -> LocalEnv -> DsM (VResult a) }
195 instance Monad VM where
196 return x = VM $ \bi genv lenv -> return (Yes genv lenv x)
197 VM p >>= f = VM $ \bi genv lenv -> do
200 Yes genv' lenv' x -> runVM (f x) bi genv' lenv'
204 noV = VM $ \_ _ _ -> return No
206 tryV :: VM a -> VM (Maybe a)
207 tryV (VM p) = VM $ \bi genv lenv ->
211 Yes genv' lenv' x -> return (Yes genv' lenv' (Just x))
212 No -> return (Yes genv lenv Nothing)
214 maybeV :: VM (Maybe a) -> VM a
215 maybeV p = maybe noV return =<< p
217 orElseV :: VM a -> VM a -> VM a
218 orElseV p q = maybe q return =<< tryV p
220 fixV :: (a -> VM a) -> VM a
221 fixV f = VM (\bi genv lenv -> fixDs $ \r -> runVM (f (unYes r)) bi genv lenv )
223 unYes (Yes _ _ x) = x
225 localV :: VM a -> VM a
232 closedV :: VM a -> VM a
235 setLEnv emptyLocalEnv
240 liftDs :: DsM a -> VM a
241 liftDs p = VM $ \bi genv lenv -> do { x <- p; return (Yes genv lenv x) }
243 builtin :: (Builtins -> a) -> VM a
244 builtin f = VM $ \bi genv lenv -> return (Yes genv lenv (f bi))
246 readGEnv :: (GlobalEnv -> a) -> VM a
247 readGEnv f = VM $ \bi genv lenv -> return (Yes genv lenv (f genv))
249 setGEnv :: GlobalEnv -> VM ()
250 setGEnv genv = VM $ \_ _ lenv -> return (Yes genv lenv ())
252 updGEnv :: (GlobalEnv -> GlobalEnv) -> VM ()
253 updGEnv f = VM $ \_ genv lenv -> return (Yes (f genv) lenv ())
255 readLEnv :: (LocalEnv -> a) -> VM a
256 readLEnv f = VM $ \bi genv lenv -> return (Yes genv lenv (f lenv))
258 setLEnv :: LocalEnv -> VM ()
259 setLEnv lenv = VM $ \_ genv _ -> return (Yes genv lenv ())
261 updLEnv :: (LocalEnv -> LocalEnv) -> VM ()
262 updLEnv f = VM $ \_ genv lenv -> return (Yes genv (f lenv) ())
264 getInstEnv :: VM (InstEnv, InstEnv)
265 getInstEnv = readGEnv global_inst_env
267 getFamInstEnv :: VM FamInstEnvs
268 getFamInstEnv = readGEnv global_fam_inst_env
270 cloneName :: (OccName -> OccName) -> Name -> VM Name
271 cloneName mk_occ name = liftM make (liftDs newUnique)
273 occ_name = mk_occ (nameOccName name)
275 make u | isExternalName name = mkExternalName u (nameModule name)
278 | otherwise = mkSystemName u occ_name
280 newLocalVar :: FastString -> Type -> VM Var
283 u <- liftDs newUnique
284 return $ mkSysLocal fs u ty
286 newTyVar :: FastString -> Kind -> VM Var
289 u <- liftDs newUnique
290 return $ mkTyVar (mkSysTvName u fs) k
292 defGlobalVar :: Var -> Var -> VM ()
293 defGlobalVar v v' = updGEnv $ \env ->
294 env { global_vars = extendVarEnv (global_vars env) v (Var v')
295 , global_exported_vars = upd (global_exported_vars env)
298 upd env | isExportedId v = extendVarEnv env v (v, v')
301 lookupVar :: Var -> VM (Scope CoreExpr (CoreExpr, CoreExpr))
304 r <- readLEnv $ \env -> lookupVarEnv (local_vars env) v
306 Just e -> return (Local e)
307 Nothing -> liftM Global
308 $ maybeV (readGEnv $ \env -> lookupVarEnv (global_vars env) v)
310 lookupTyCon :: TyCon -> VM (Maybe TyCon)
312 | isUnLiftedTyCon tc || isTupleTyCon tc = return (Just tc)
314 | otherwise = readGEnv $ \env -> lookupNameEnv (global_tycons env) (tyConName tc)
316 defTyCon :: TyCon -> TyCon -> VM ()
317 defTyCon tc tc' = updGEnv $ \env ->
318 env { global_tycons = extendNameEnv (global_tycons env) (tyConName tc) tc' }
320 lookupDataCon :: DataCon -> VM (Maybe DataCon)
321 lookupDataCon dc = readGEnv $ \env -> lookupNameEnv (global_datacons env) (dataConName dc)
323 defDataCon :: DataCon -> DataCon -> VM ()
324 defDataCon dc dc' = updGEnv $ \env ->
325 env { global_datacons = extendNameEnv (global_datacons env) (dataConName dc) dc' }
327 lookupTyVarPA :: Var -> VM (Maybe CoreExpr)
328 lookupTyVarPA tv = readLEnv $ \env -> lookupVarEnv (local_tyvar_pa env) tv
330 defLocalTyVar :: TyVar -> VM ()
331 defLocalTyVar tv = updLEnv $ \env ->
332 env { local_tyvars = tv : local_tyvars env
333 , local_tyvar_pa = local_tyvar_pa env `delVarEnv` tv
336 defLocalTyVarWithPA :: TyVar -> CoreExpr -> VM ()
337 defLocalTyVarWithPA tv pa = updLEnv $ \env ->
338 env { local_tyvars = tv : local_tyvars env
339 , local_tyvar_pa = extendVarEnv (local_tyvar_pa env) tv pa
342 localTyVars :: VM [TyVar]
343 localTyVars = readLEnv (reverse . local_tyvars)
345 -- Look up the dfun of a class instance.
347 -- The match must be unique - ie, match exactly one instance - but the
348 -- type arguments used for matching may be more specific than those of
349 -- the class instance declaration. The found class instances must not have
350 -- any type variables in the instance context that do not appear in the
351 -- instances head (i.e., no flexi vars); for details for what this means,
352 -- see the docs at InstEnv.lookupInstEnv.
354 lookupInst :: Class -> [Type] -> VM (DFunId, [Type])
356 = do { instEnv <- getInstEnv
357 ; case lookupInstEnv instEnv cls tys of
358 ([(inst, inst_tys)], _)
359 | noFlexiVar -> return (instanceDFunId inst, inst_tys')
360 | otherwise -> pprPanic "VectMonad.lookupInst: flexi var: "
361 (ppr $ mkTyConApp (classTyCon cls) tys)
363 inst_tys' = [ty | Right ty <- inst_tys]
364 noFlexiVar = all isRight inst_tys
368 isRight (Left _) = False
369 isRight (Right _) = True
371 -- Look up the representation tycon of a family instance.
373 -- The match must be unique - ie, match exactly one instance - but the
374 -- type arguments used for matching may be more specific than those of
375 -- the family instance declaration.
377 -- Return the instance tycon and its type instance. For example, if we have
379 -- lookupFamInst 'T' '[Int]' yields (':R42T', 'Int')
381 -- then we have a coercion (ie, type instance of family instance coercion)
383 -- :Co:R42T Int :: T [Int] ~ :R42T Int
385 -- which implies that :R42T was declared as 'data instance T [a]'.
387 lookupFamInst :: TyCon -> [Type] -> VM (TyCon, [Type])
388 lookupFamInst tycon tys
389 = ASSERT( isOpenTyCon tycon )
390 do { instEnv <- getFamInstEnv
391 ; case lookupFamInstEnv instEnv tycon tys of
392 [(fam_inst, rep_tys)] -> return (famInstTyCon fam_inst, rep_tys)
394 pprPanic "VectMonad.lookupFamInst: not found: "
395 (ppr $ mkTyConApp tycon tys)
398 initV :: HscEnv -> ModGuts -> VectInfo -> VM a -> IO (Maybe (VectInfo, a))
399 initV hsc_env guts info p
401 eps <- hscEPS hsc_env
402 let famInstEnvs = (eps_fam_inst_env eps, mg_fam_inst_env guts)
403 let instEnvs = (eps_inst_env eps, mg_inst_env guts)
405 Just r <- initDs hsc_env (mg_module guts)
408 (go instEnvs famInstEnvs)
412 go instEnvs famInstEnvs =
414 builtins <- initBuiltins
415 r <- runVM p builtins (initGlobalEnv info instEnvs famInstEnvs builtins)
418 Yes genv _ x -> return $ Just (new_info genv, x)
421 new_info genv = updVectInfo genv (mg_types guts) info