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
70 paDictTyCon :: Builtins -> TyCon
71 paDictTyCon = classTyCon . paClass
73 initBuiltins :: DsM Builtins
76 parrayTyCon <- dsLookupTyCon parrayTyConName
77 paClass <- dsLookupClass paClassName
78 closureTyCon <- dsLookupTyCon closureTyConName
80 mkClosureVar <- dsLookupGlobalId mkClosureName
81 applyClosureVar <- dsLookupGlobalId applyClosureName
82 mkClosurePVar <- dsLookupGlobalId mkClosurePName
83 applyClosurePVar <- dsLookupGlobalId applyClosurePName
84 lengthPAVar <- dsLookupGlobalId lengthPAName
85 replicatePAVar <- dsLookupGlobalId replicatePAName
88 parrayTyCon = parrayTyCon
90 , closureTyCon = closureTyCon
91 , mkClosureVar = mkClosureVar
92 , applyClosureVar = applyClosureVar
93 , mkClosurePVar = mkClosurePVar
94 , applyClosurePVar = applyClosurePVar
95 , lengthPAVar = lengthPAVar
96 , replicatePAVar = replicatePAVar
99 data GlobalEnv = GlobalEnv {
100 -- Mapping from global variables to their vectorised versions.
102 global_vars :: VarEnv CoreExpr
104 -- Exported variables which have a vectorised version
106 , global_exported_vars :: VarEnv (Var, Var)
108 -- Mapping from TyCons to their vectorised versions.
109 -- TyCons which do not have to be vectorised are mapped to
112 , global_tycons :: NameEnv TyCon
114 -- Mapping from DataCons to their vectorised versions
116 , global_datacons :: NameEnv DataCon
118 -- External package inst-env & home-package inst-env for class
121 , global_inst_env :: (InstEnv, InstEnv)
123 -- External package inst-env & home-package inst-env for family
126 , global_fam_inst_env :: FamInstEnvs
129 , global_bindings :: [(Var, CoreExpr)]
132 data LocalEnv = LocalEnv {
133 -- Mapping from local variables to their vectorised and
136 local_vars :: VarEnv (CoreExpr, CoreExpr)
138 -- In-scope type variables
140 , local_tyvars :: [TyVar]
142 -- Mapping from tyvars to their PA dictionaries
143 , local_tyvar_pa :: VarEnv CoreExpr
147 initGlobalEnv :: VectInfo -> (InstEnv, InstEnv) -> FamInstEnvs -> Builtins -> GlobalEnv
148 initGlobalEnv info instEnvs famInstEnvs bi
150 global_vars = mapVarEnv (Var . snd) $ vectInfoVar info
151 , global_exported_vars = emptyVarEnv
152 , global_tycons = extendNameEnv (mapNameEnv snd (vectInfoTyCon info))
153 (tyConName funTyCon) (closureTyCon bi)
155 , global_datacons = mapNameEnv snd $ vectInfoDataCon info
156 , global_inst_env = instEnvs
157 , global_fam_inst_env = famInstEnvs
158 , global_bindings = []
161 setInstEnvs :: InstEnv -> FamInstEnv -> GlobalEnv -> GlobalEnv
162 setInstEnvs l_inst l_fam_inst genv
163 | (g_inst, _) <- global_inst_env genv
164 , (g_fam_inst, _) <- global_fam_inst_env genv
165 = genv { global_inst_env = (g_inst, l_inst)
166 , global_fam_inst_env = (g_fam_inst, l_fam_inst) }
168 emptyLocalEnv = LocalEnv {
169 local_vars = emptyVarEnv
171 , local_tyvar_pa = emptyVarEnv
175 updVectInfo :: GlobalEnv -> TypeEnv -> VectInfo -> VectInfo
176 updVectInfo env tyenv info
178 vectInfoVar = global_exported_vars env
179 , vectInfoTyCon = mk_env typeEnvTyCons global_tycons
180 , vectInfoDataCon = mk_env typeEnvDataCons global_datacons
183 mk_env from_tyenv from_env = mkNameEnv [(name, (from,to))
184 | from <- from_tyenv tyenv
185 , let name = getName from
186 , Just to <- [lookupNameEnv (from_env env) name]]
188 data VResult a = Yes GlobalEnv LocalEnv a | No
190 newtype VM a = VM { runVM :: Builtins -> GlobalEnv -> LocalEnv -> DsM (VResult a) }
192 instance Monad VM where
193 return x = VM $ \bi genv lenv -> return (Yes genv lenv x)
194 VM p >>= f = VM $ \bi genv lenv -> do
197 Yes genv' lenv' x -> runVM (f x) bi genv' lenv'
201 noV = VM $ \_ _ _ -> return No
203 tryV :: VM a -> VM (Maybe a)
204 tryV (VM p) = VM $ \bi genv lenv ->
208 Yes genv' lenv' x -> return (Yes genv' lenv' (Just x))
209 No -> return (Yes genv lenv Nothing)
211 maybeV :: VM (Maybe a) -> VM a
212 maybeV p = maybe noV return =<< p
214 orElseV :: VM a -> VM a -> VM a
215 orElseV p q = maybe q return =<< tryV p
217 fixV :: (a -> VM a) -> VM a
218 fixV f = VM (\bi genv lenv -> fixDs $ \r -> runVM (f (unYes r)) bi genv lenv )
220 unYes (Yes _ _ x) = x
222 localV :: VM a -> VM a
229 closedV :: VM a -> VM a
232 setLEnv emptyLocalEnv
237 liftDs :: DsM a -> VM a
238 liftDs p = VM $ \bi genv lenv -> do { x <- p; return (Yes genv lenv x) }
240 builtin :: (Builtins -> a) -> VM a
241 builtin f = VM $ \bi genv lenv -> return (Yes genv lenv (f bi))
243 readGEnv :: (GlobalEnv -> a) -> VM a
244 readGEnv f = VM $ \bi genv lenv -> return (Yes genv lenv (f genv))
246 setGEnv :: GlobalEnv -> VM ()
247 setGEnv genv = VM $ \_ _ lenv -> return (Yes genv lenv ())
249 updGEnv :: (GlobalEnv -> GlobalEnv) -> VM ()
250 updGEnv f = VM $ \_ genv lenv -> return (Yes (f genv) lenv ())
252 readLEnv :: (LocalEnv -> a) -> VM a
253 readLEnv f = VM $ \bi genv lenv -> return (Yes genv lenv (f lenv))
255 setLEnv :: LocalEnv -> VM ()
256 setLEnv lenv = VM $ \_ genv _ -> return (Yes genv lenv ())
258 updLEnv :: (LocalEnv -> LocalEnv) -> VM ()
259 updLEnv f = VM $ \_ genv lenv -> return (Yes genv (f lenv) ())
261 getInstEnv :: VM (InstEnv, InstEnv)
262 getInstEnv = readGEnv global_inst_env
264 getFamInstEnv :: VM FamInstEnvs
265 getFamInstEnv = readGEnv global_fam_inst_env
267 cloneName :: (OccName -> OccName) -> Name -> VM Name
268 cloneName mk_occ name = liftM make (liftDs newUnique)
270 occ_name = mk_occ (nameOccName name)
272 make u | isExternalName name = mkExternalName u (nameModule name)
275 | otherwise = mkSystemName u occ_name
277 newLocalVar :: FastString -> Type -> VM Var
280 u <- liftDs newUnique
281 return $ mkSysLocal fs u ty
283 newTyVar :: FastString -> Kind -> VM Var
286 u <- liftDs newUnique
287 return $ mkTyVar (mkSysTvName u fs) k
289 defGlobalVar :: Var -> Var -> VM ()
290 defGlobalVar v v' = updGEnv $ \env ->
291 env { global_vars = extendVarEnv (global_vars env) v (Var v')
292 , global_exported_vars = upd (global_exported_vars env)
295 upd env | isExportedId v = extendVarEnv env v (v, v')
298 lookupVar :: Var -> VM (Scope CoreExpr (CoreExpr, CoreExpr))
301 r <- readLEnv $ \env -> lookupVarEnv (local_vars env) v
303 Just e -> return (Local e)
304 Nothing -> liftM Global
305 $ maybeV (readGEnv $ \env -> lookupVarEnv (global_vars env) v)
307 lookupTyCon :: TyCon -> VM (Maybe TyCon)
309 | isUnLiftedTyCon tc || isTupleTyCon tc = return (Just tc)
311 | otherwise = readGEnv $ \env -> lookupNameEnv (global_tycons env) (tyConName tc)
313 defTyCon :: TyCon -> TyCon -> VM ()
314 defTyCon tc tc' = updGEnv $ \env ->
315 env { global_tycons = extendNameEnv (global_tycons env) (tyConName tc) tc' }
317 lookupDataCon :: DataCon -> VM (Maybe DataCon)
318 lookupDataCon dc = readGEnv $ \env -> lookupNameEnv (global_datacons env) (dataConName dc)
320 defDataCon :: DataCon -> DataCon -> VM ()
321 defDataCon dc dc' = updGEnv $ \env ->
322 env { global_datacons = extendNameEnv (global_datacons env) (dataConName dc) dc' }
324 lookupTyVarPA :: Var -> VM (Maybe CoreExpr)
325 lookupTyVarPA tv = readLEnv $ \env -> lookupVarEnv (local_tyvar_pa env) tv
327 defLocalTyVar :: TyVar -> VM ()
328 defLocalTyVar tv = updLEnv $ \env ->
329 env { local_tyvars = tv : local_tyvars env
330 , local_tyvar_pa = local_tyvar_pa env `delVarEnv` tv
333 defLocalTyVarWithPA :: TyVar -> CoreExpr -> VM ()
334 defLocalTyVarWithPA tv pa = updLEnv $ \env ->
335 env { local_tyvars = tv : local_tyvars env
336 , local_tyvar_pa = extendVarEnv (local_tyvar_pa env) tv pa
339 localTyVars :: VM [TyVar]
340 localTyVars = readLEnv (reverse . local_tyvars)
342 -- Look up the dfun of a class instance.
344 -- The match must be unique - ie, match exactly one instance - but the
345 -- type arguments used for matching may be more specific than those of
346 -- the class instance declaration. The found class instances must not have
347 -- any type variables in the instance context that do not appear in the
348 -- instances head (i.e., no flexi vars); for details for what this means,
349 -- see the docs at InstEnv.lookupInstEnv.
351 lookupInst :: Class -> [Type] -> VM (DFunId, [Type])
353 = do { instEnv <- getInstEnv
354 ; case lookupInstEnv instEnv cls tys of
355 ([(inst, inst_tys)], _)
356 | noFlexiVar -> return (instanceDFunId inst, inst_tys')
357 | otherwise -> pprPanic "VectMonad.lookupInst: flexi var: "
358 (ppr $ mkTyConApp (classTyCon cls) tys)
360 inst_tys' = [ty | Right ty <- inst_tys]
361 noFlexiVar = all isRight inst_tys
365 isRight (Left _) = False
366 isRight (Right _) = True
368 -- Look up the representation tycon of a family instance.
370 -- The match must be unique - ie, match exactly one instance - but the
371 -- type arguments used for matching may be more specific than those of
372 -- the family instance declaration.
374 -- Return the instance tycon and its type instance. For example, if we have
376 -- lookupFamInst 'T' '[Int]' yields (':R42T', 'Int')
378 -- then we have a coercion (ie, type instance of family instance coercion)
380 -- :Co:R42T Int :: T [Int] ~ :R42T Int
382 -- which implies that :R42T was declared as 'data instance T [a]'.
384 lookupFamInst :: TyCon -> [Type] -> VM (TyCon, [Type])
385 lookupFamInst tycon tys
386 = ASSERT( isOpenTyCon tycon )
387 do { instEnv <- getFamInstEnv
388 ; case lookupFamInstEnv instEnv tycon tys of
389 [(fam_inst, rep_tys)] -> return (famInstTyCon fam_inst, rep_tys)
391 pprPanic "VectMonad.lookupFamInst: not found: "
392 (ppr $ mkTyConApp tycon tys)
395 initV :: HscEnv -> ModGuts -> VectInfo -> VM a -> IO (Maybe (VectInfo, a))
396 initV hsc_env guts info p
398 eps <- hscEPS hsc_env
399 let famInstEnvs = (eps_fam_inst_env eps, mg_fam_inst_env guts)
400 let instEnvs = (eps_inst_env eps, mg_inst_env guts)
402 Just r <- initDs hsc_env (mg_module guts)
405 (go instEnvs famInstEnvs)
409 go instEnvs famInstEnvs =
411 builtins <- initBuiltins
412 r <- runVM p builtins (initGlobalEnv info instEnvs famInstEnvs builtins)
415 Yes genv _ x -> return $ Just (new_info genv, x)
418 new_info genv = updVectInfo genv (mg_types guts) info