5 noV, tryV, maybeV, orElseV, fixV, localV, closedV, initV,
7 newExportedVar, newLocalVar, newDummyVar, newTyVar,
9 Builtins(..), paDictTyCon, paDictDataCon,
14 readGEnv, setGEnv, updGEnv,
17 readLEnv, setLEnv, updLEnv,
21 lookupVar, defGlobalVar,
22 lookupTyCon, defTyCon,
23 lookupDataCon, defDataCon,
24 lookupTyConPA, defTyConPA,
25 lookupTyVarPA, defLocalTyVar, defLocalTyVarWithPA, localTyVars,
27 lookupInst, lookupFamInst
30 #include "HsVersions.h"
44 import TysPrim ( intPrimTy )
55 import SrcLoc ( noSrcSpan )
57 import Control.Monad ( liftM )
59 data Scope a b = Global a | Local b
61 -- ----------------------------------------------------------------------------
62 -- Vectorisation monad
64 data Builtins = Builtins {
67 , closureTyCon :: TyCon
69 , applyClosureVar :: Var
70 , mkClosurePVar :: Var
71 , applyClosurePVar :: Var
73 , replicatePAVar :: Var
75 , liftingContext :: Var
78 paDictTyCon :: Builtins -> TyCon
79 paDictTyCon = classTyCon . paClass
81 paDictDataCon :: Builtins -> DataCon
82 paDictDataCon = classDataCon . paClass
84 initBuiltins :: DsM Builtins
87 parrayTyCon <- dsLookupTyCon parrayTyConName
88 paClass <- dsLookupClass paClassName
89 closureTyCon <- dsLookupTyCon closureTyConName
91 mkClosureVar <- dsLookupGlobalId mkClosureName
92 applyClosureVar <- dsLookupGlobalId applyClosureName
93 mkClosurePVar <- dsLookupGlobalId mkClosurePName
94 applyClosurePVar <- dsLookupGlobalId applyClosurePName
95 lengthPAVar <- dsLookupGlobalId lengthPAName
96 replicatePAVar <- dsLookupGlobalId replicatePAName
97 emptyPAVar <- dsLookupGlobalId emptyPAName
99 liftingContext <- liftM (\u -> mkSysLocal FSLIT("lc") u intPrimTy)
103 parrayTyCon = parrayTyCon
105 , closureTyCon = closureTyCon
106 , mkClosureVar = mkClosureVar
107 , applyClosureVar = applyClosureVar
108 , mkClosurePVar = mkClosurePVar
109 , applyClosurePVar = applyClosurePVar
110 , lengthPAVar = lengthPAVar
111 , replicatePAVar = replicatePAVar
112 , emptyPAVar = emptyPAVar
113 , liftingContext = liftingContext
116 data GlobalEnv = GlobalEnv {
117 -- Mapping from global variables to their vectorised versions.
119 global_vars :: VarEnv Var
121 -- Exported variables which have a vectorised version
123 , global_exported_vars :: VarEnv (Var, Var)
125 -- Mapping from TyCons to their vectorised versions.
126 -- TyCons which do not have to be vectorised are mapped to
129 , global_tycons :: NameEnv TyCon
131 -- Mapping from DataCons to their vectorised versions
133 , global_datacons :: NameEnv DataCon
135 -- Mapping from TyCons to their PA dfuns
137 , global_pa_funs :: NameEnv Var
139 -- External package inst-env & home-package inst-env for class
142 , global_inst_env :: (InstEnv, InstEnv)
144 -- External package inst-env & home-package inst-env for family
147 , global_fam_inst_env :: FamInstEnvs
150 , global_bindings :: [(Var, CoreExpr)]
153 data LocalEnv = LocalEnv {
154 -- Mapping from local variables to their vectorised and
157 local_vars :: VarEnv (Var, Var)
159 -- In-scope type variables
161 , local_tyvars :: [TyVar]
163 -- Mapping from tyvars to their PA dictionaries
164 , local_tyvar_pa :: VarEnv CoreExpr
166 -- Local binding name
167 , local_bind_name :: FastString
171 initGlobalEnv :: VectInfo -> (InstEnv, InstEnv) -> FamInstEnvs -> Builtins -> GlobalEnv
172 initGlobalEnv info instEnvs famInstEnvs bi
174 global_vars = mapVarEnv snd $ vectInfoVar info
175 , global_exported_vars = emptyVarEnv
176 , global_tycons = extendNameEnv (mapNameEnv snd (vectInfoTyCon info))
177 (tyConName funTyCon) (closureTyCon bi)
179 , global_datacons = mapNameEnv snd $ vectInfoDataCon info
180 , global_pa_funs = mapNameEnv snd $ vectInfoPADFun info
181 , global_inst_env = instEnvs
182 , global_fam_inst_env = famInstEnvs
183 , global_bindings = []
186 setInstEnvs :: InstEnv -> FamInstEnv -> GlobalEnv -> GlobalEnv
187 setInstEnvs l_inst l_fam_inst genv
188 | (g_inst, _) <- global_inst_env genv
189 , (g_fam_inst, _) <- global_fam_inst_env genv
190 = genv { global_inst_env = (g_inst, l_inst)
191 , global_fam_inst_env = (g_fam_inst, l_fam_inst) }
193 emptyLocalEnv = LocalEnv {
194 local_vars = emptyVarEnv
196 , local_tyvar_pa = emptyVarEnv
197 , local_bind_name = FSLIT("fn")
201 updVectInfo :: GlobalEnv -> TypeEnv -> VectInfo -> VectInfo
202 updVectInfo env tyenv info
204 vectInfoVar = global_exported_vars env
205 , vectInfoTyCon = mk_env typeEnvTyCons global_tycons
206 , vectInfoDataCon = mk_env typeEnvDataCons global_datacons
207 , vectInfoPADFun = mk_env typeEnvTyCons global_pa_funs
210 mk_env from_tyenv from_env = mkNameEnv [(name, (from,to))
211 | from <- from_tyenv tyenv
212 , let name = getName from
213 , Just to <- [lookupNameEnv (from_env env) name]]
215 data VResult a = Yes GlobalEnv LocalEnv a | No
217 newtype VM a = VM { runVM :: Builtins -> GlobalEnv -> LocalEnv -> DsM (VResult a) }
219 instance Monad VM where
220 return x = VM $ \bi genv lenv -> return (Yes genv lenv x)
221 VM p >>= f = VM $ \bi genv lenv -> do
224 Yes genv' lenv' x -> runVM (f x) bi genv' lenv'
228 noV = VM $ \_ _ _ -> return No
230 traceNoV :: String -> SDoc -> VM a
231 traceNoV s d = pprTrace s d noV
233 tryV :: VM a -> VM (Maybe a)
234 tryV (VM p) = VM $ \bi genv lenv ->
238 Yes genv' lenv' x -> return (Yes genv' lenv' (Just x))
239 No -> return (Yes genv lenv Nothing)
241 maybeV :: VM (Maybe a) -> VM a
242 maybeV p = maybe noV return =<< p
244 traceMaybeV :: String -> SDoc -> VM (Maybe a) -> VM a
245 traceMaybeV s d p = maybe (traceNoV s d) return =<< p
247 orElseV :: VM a -> VM a -> VM a
248 orElseV p q = maybe q return =<< tryV p
250 fixV :: (a -> VM a) -> VM a
251 fixV f = VM (\bi genv lenv -> fixDs $ \r -> runVM (f (unYes r)) bi genv lenv )
253 unYes (Yes _ _ x) = x
255 localV :: VM a -> VM a
262 closedV :: VM a -> VM a
265 setLEnv (emptyLocalEnv { local_bind_name = local_bind_name env })
270 liftDs :: DsM a -> VM a
271 liftDs p = VM $ \bi genv lenv -> do { x <- p; return (Yes genv lenv x) }
273 builtin :: (Builtins -> a) -> VM a
274 builtin f = VM $ \bi genv lenv -> return (Yes genv lenv (f bi))
276 readGEnv :: (GlobalEnv -> a) -> VM a
277 readGEnv f = VM $ \bi genv lenv -> return (Yes genv lenv (f genv))
279 setGEnv :: GlobalEnv -> VM ()
280 setGEnv genv = VM $ \_ _ lenv -> return (Yes genv lenv ())
282 updGEnv :: (GlobalEnv -> GlobalEnv) -> VM ()
283 updGEnv f = VM $ \_ genv lenv -> return (Yes (f genv) lenv ())
285 readLEnv :: (LocalEnv -> a) -> VM a
286 readLEnv f = VM $ \bi genv lenv -> return (Yes genv lenv (f lenv))
288 setLEnv :: LocalEnv -> VM ()
289 setLEnv lenv = VM $ \_ genv _ -> return (Yes genv lenv ())
291 updLEnv :: (LocalEnv -> LocalEnv) -> VM ()
292 updLEnv f = VM $ \_ genv lenv -> return (Yes genv (f lenv) ())
294 getInstEnv :: VM (InstEnv, InstEnv)
295 getInstEnv = readGEnv global_inst_env
297 getFamInstEnv :: VM FamInstEnvs
298 getFamInstEnv = readGEnv global_fam_inst_env
300 getBindName :: VM FastString
301 getBindName = readLEnv local_bind_name
303 inBind :: Id -> VM a -> VM a
305 = do updLEnv $ \env -> env { local_bind_name = occNameFS (getOccName id) }
308 cloneName :: (OccName -> OccName) -> Name -> VM Name
309 cloneName mk_occ name = liftM make (liftDs newUnique)
311 occ_name = mk_occ (nameOccName name)
313 make u | isExternalName name = mkExternalName u (nameModule name)
316 | otherwise = mkSystemName u occ_name
318 cloneId :: (OccName -> OccName) -> Id -> Type -> VM Id
321 name <- cloneName mk_occ (getName id)
322 let id' | isExportedId id = Id.mkExportedLocalId name ty
323 | otherwise = Id.mkLocalId name ty
326 newExportedVar :: OccName -> Type -> VM Var
327 newExportedVar occ_name ty
329 mod <- liftDs getModuleDs
330 u <- liftDs newUnique
332 let name = mkExternalName u mod occ_name noSrcSpan
334 return $ Id.mkExportedLocalId name ty
336 newLocalVar :: FastString -> Type -> VM Var
339 u <- liftDs newUnique
340 return $ mkSysLocal fs u ty
342 newDummyVar :: Type -> VM Var
343 newDummyVar = newLocalVar FSLIT("ds")
345 newTyVar :: FastString -> Kind -> VM Var
348 u <- liftDs newUnique
349 return $ mkTyVar (mkSysTvName u fs) k
351 defGlobalVar :: Var -> Var -> VM ()
352 defGlobalVar v v' = updGEnv $ \env ->
353 env { global_vars = extendVarEnv (global_vars env) v v'
354 , global_exported_vars = upd (global_exported_vars env)
357 upd env | isExportedId v = extendVarEnv env v (v, v')
360 lookupVar :: Var -> VM (Scope Var (Var, Var))
363 r <- readLEnv $ \env -> lookupVarEnv (local_vars env) v
365 Just e -> return (Local e)
366 Nothing -> liftM Global
367 $ traceMaybeV "lookupVar" (ppr v)
368 (readGEnv $ \env -> lookupVarEnv (global_vars env) v)
370 lookupTyCon :: TyCon -> VM (Maybe TyCon)
372 | isUnLiftedTyCon tc || isTupleTyCon tc = return (Just tc)
374 | otherwise = readGEnv $ \env -> lookupNameEnv (global_tycons env) (tyConName tc)
376 defTyCon :: TyCon -> TyCon -> VM ()
377 defTyCon tc tc' = updGEnv $ \env ->
378 env { global_tycons = extendNameEnv (global_tycons env) (tyConName tc) tc' }
380 lookupDataCon :: DataCon -> VM (Maybe DataCon)
381 lookupDataCon dc = readGEnv $ \env -> lookupNameEnv (global_datacons env) (dataConName dc)
383 defDataCon :: DataCon -> DataCon -> VM ()
384 defDataCon dc dc' = updGEnv $ \env ->
385 env { global_datacons = extendNameEnv (global_datacons env) (dataConName dc) dc' }
387 lookupTyConPA :: TyCon -> VM (Maybe Var)
388 lookupTyConPA tc = readGEnv $ \env -> lookupNameEnv (global_pa_funs env) (tyConName tc)
390 defTyConPA :: TyCon -> Var -> VM ()
391 defTyConPA tc pa = updGEnv $ \env ->
392 env { global_pa_funs = extendNameEnv (global_pa_funs env) (tyConName tc) pa }
394 lookupTyVarPA :: Var -> VM (Maybe CoreExpr)
395 lookupTyVarPA tv = readLEnv $ \env -> lookupVarEnv (local_tyvar_pa env) tv
397 defLocalTyVar :: TyVar -> VM ()
398 defLocalTyVar tv = updLEnv $ \env ->
399 env { local_tyvars = tv : local_tyvars env
400 , local_tyvar_pa = local_tyvar_pa env `delVarEnv` tv
403 defLocalTyVarWithPA :: TyVar -> CoreExpr -> VM ()
404 defLocalTyVarWithPA tv pa = updLEnv $ \env ->
405 env { local_tyvars = tv : local_tyvars env
406 , local_tyvar_pa = extendVarEnv (local_tyvar_pa env) tv pa
409 localTyVars :: VM [TyVar]
410 localTyVars = readLEnv (reverse . local_tyvars)
412 -- Look up the dfun of a class instance.
414 -- The match must be unique - ie, match exactly one instance - but the
415 -- type arguments used for matching may be more specific than those of
416 -- the class instance declaration. The found class instances must not have
417 -- any type variables in the instance context that do not appear in the
418 -- instances head (i.e., no flexi vars); for details for what this means,
419 -- see the docs at InstEnv.lookupInstEnv.
421 lookupInst :: Class -> [Type] -> VM (DFunId, [Type])
423 = do { instEnv <- getInstEnv
424 ; case lookupInstEnv instEnv cls tys of
425 ([(inst, inst_tys)], _)
426 | noFlexiVar -> return (instanceDFunId inst, inst_tys')
427 | otherwise -> pprPanic "VectMonad.lookupInst: flexi var: "
428 (ppr $ mkTyConApp (classTyCon cls) tys)
430 inst_tys' = [ty | Right ty <- inst_tys]
431 noFlexiVar = all isRight inst_tys
432 _other -> traceNoV "lookupInst" (ppr cls <+> ppr tys)
435 isRight (Left _) = False
436 isRight (Right _) = True
438 -- Look up the representation tycon of a family instance.
440 -- The match must be unique - ie, match exactly one instance - but the
441 -- type arguments used for matching may be more specific than those of
442 -- the family instance declaration.
444 -- Return the instance tycon and its type instance. For example, if we have
446 -- lookupFamInst 'T' '[Int]' yields (':R42T', 'Int')
448 -- then we have a coercion (ie, type instance of family instance coercion)
450 -- :Co:R42T Int :: T [Int] ~ :R42T Int
452 -- which implies that :R42T was declared as 'data instance T [a]'.
454 lookupFamInst :: TyCon -> [Type] -> VM (TyCon, [Type])
455 lookupFamInst tycon tys
456 = ASSERT( isOpenTyCon tycon )
457 do { instEnv <- getFamInstEnv
458 ; case lookupFamInstEnv instEnv tycon tys of
459 [(fam_inst, rep_tys)] -> return (famInstTyCon fam_inst, rep_tys)
461 pprPanic "VectMonad.lookupFamInst: not found: "
462 (ppr $ mkTyConApp tycon tys)
465 initV :: HscEnv -> ModGuts -> VectInfo -> VM a -> IO (Maybe (VectInfo, a))
466 initV hsc_env guts info p
468 eps <- hscEPS hsc_env
469 let famInstEnvs = (eps_fam_inst_env eps, mg_fam_inst_env guts)
470 let instEnvs = (eps_inst_env eps, mg_inst_env guts)
472 Just r <- initDs hsc_env (mg_module guts)
475 (go instEnvs famInstEnvs)
479 go instEnvs famInstEnvs =
481 builtins <- initBuiltins
482 r <- runVM p builtins (initGlobalEnv info instEnvs famInstEnvs builtins)
485 Yes genv _ x -> return $ Just (new_info genv, x)
488 new_info genv = updVectInfo genv (mg_types guts) info