5 noV, tryV, maybeV, traceMaybeV, orElseV, fixV, localV, closedV, initV,
8 newExportedVar, newLocalVar, newDummyVar, newTyVar,
15 readGEnv, setGEnv, updGEnv,
18 readLEnv, setLEnv, updLEnv,
22 lookupVar, defGlobalVar,
23 lookupTyCon, defTyCon,
24 lookupDataCon, defDataCon,
25 lookupTyConPA, defTyConPA, defTyConPAs, defTyConBuiltinPAs,
26 lookupTyVarPA, defLocalTyVar, defLocalTyVarWithPA, localTyVars,
28 {-lookupInst,-} lookupFamInst
31 #include "HsVersions.h"
44 import TysPrim ( intPrimTy )
57 import SrcLoc ( noSrcSpan )
59 import Control.Monad ( liftM, zipWithM )
61 data Scope a b = Global a | Local b
63 -- ----------------------------------------------------------------------------
64 -- Vectorisation monad
66 data Builtins = Builtins {
69 , paDataCon :: DataCon
72 , embedDataCon :: DataCon
75 , closureTyCon :: TyCon
77 , applyClosureVar :: Var
78 , mkClosurePVar :: Var
79 , applyClosurePVar :: Var
81 , replicatePAVar :: Var
84 -- , combinePAVar :: Var
86 , liftingContext :: Var
89 initBuiltins :: DsM Builtins
92 parrayTyCon <- dsLookupTyCon parrayTyConName
93 paTyCon <- dsLookupTyCon paTyConName
94 let paDataCon = case tyConDataCons paTyCon of [dc] -> dc
95 preprTyCon <- dsLookupTyCon preprTyConName
96 embedTyCon <- dsLookupTyCon embedTyConName
97 let embedDataCon = case tyConDataCons embedTyCon of [dc] -> dc
98 crossTyCon <- dsLookupTyCon crossTyConName
99 plusTyCon <- dsLookupTyCon plusTyConName
100 closureTyCon <- dsLookupTyCon closureTyConName
102 mkClosureVar <- dsLookupGlobalId mkClosureName
103 applyClosureVar <- dsLookupGlobalId applyClosureName
104 mkClosurePVar <- dsLookupGlobalId mkClosurePName
105 applyClosurePVar <- dsLookupGlobalId applyClosurePName
106 lengthPAVar <- dsLookupGlobalId lengthPAName
107 replicatePAVar <- dsLookupGlobalId replicatePAName
108 emptyPAVar <- dsLookupGlobalId emptyPAName
109 -- packPAVar <- dsLookupGlobalId packPAName
110 -- combinePAVar <- dsLookupGlobalId combinePAName
111 intEqPAVar <- dsLookupGlobalId intEqPAName
113 liftingContext <- liftM (\u -> mkSysLocal FSLIT("lc") u intPrimTy)
117 parrayTyCon = parrayTyCon
119 , paDataCon = paDataCon
120 , preprTyCon = preprTyCon
121 , embedTyCon = embedTyCon
122 , embedDataCon = embedDataCon
123 , crossTyCon = crossTyCon
124 , plusTyCon = plusTyCon
125 , closureTyCon = closureTyCon
126 , mkClosureVar = mkClosureVar
127 , applyClosureVar = applyClosureVar
128 , mkClosurePVar = mkClosurePVar
129 , applyClosurePVar = applyClosurePVar
130 , lengthPAVar = lengthPAVar
131 , replicatePAVar = replicatePAVar
132 , emptyPAVar = emptyPAVar
133 -- , packPAVar = packPAVar
134 -- , combinePAVar = combinePAVar
135 , intEqPAVar = intEqPAVar
136 , liftingContext = liftingContext
139 data GlobalEnv = GlobalEnv {
140 -- Mapping from global variables to their vectorised versions.
142 global_vars :: VarEnv Var
144 -- Exported variables which have a vectorised version
146 , global_exported_vars :: VarEnv (Var, Var)
148 -- Mapping from TyCons to their vectorised versions.
149 -- TyCons which do not have to be vectorised are mapped to
152 , global_tycons :: NameEnv TyCon
154 -- Mapping from DataCons to their vectorised versions
156 , global_datacons :: NameEnv DataCon
158 -- Mapping from TyCons to their PA dfuns
160 , global_pa_funs :: NameEnv Var
162 -- External package inst-env & home-package inst-env for class
165 , global_inst_env :: (InstEnv, InstEnv)
167 -- External package inst-env & home-package inst-env for family
170 , global_fam_inst_env :: FamInstEnvs
173 , global_bindings :: [(Var, CoreExpr)]
176 data LocalEnv = LocalEnv {
177 -- Mapping from local variables to their vectorised and
180 local_vars :: VarEnv (Var, Var)
182 -- In-scope type variables
184 , local_tyvars :: [TyVar]
186 -- Mapping from tyvars to their PA dictionaries
187 , local_tyvar_pa :: VarEnv CoreExpr
189 -- Local binding name
190 , local_bind_name :: FastString
194 initGlobalEnv :: VectInfo -> (InstEnv, InstEnv) -> FamInstEnvs -> Builtins
196 initGlobalEnv info instEnvs famInstEnvs bi
198 global_vars = mapVarEnv snd $ vectInfoVar info
199 , global_exported_vars = emptyVarEnv
200 , global_tycons = extendNameEnv (mapNameEnv snd (vectInfoTyCon info))
201 (tyConName funTyCon) (closureTyCon bi)
203 , global_datacons = mapNameEnv snd $ vectInfoDataCon info
204 , global_pa_funs = mapNameEnv snd $ vectInfoPADFun info
205 , global_inst_env = instEnvs
206 , global_fam_inst_env = famInstEnvs
207 , global_bindings = []
210 setFamInstEnv :: FamInstEnv -> GlobalEnv -> GlobalEnv
211 setFamInstEnv l_fam_inst genv
212 = genv { global_fam_inst_env = (g_fam_inst, l_fam_inst) }
214 (g_fam_inst, _) = global_fam_inst_env genv
216 emptyLocalEnv = LocalEnv {
217 local_vars = emptyVarEnv
219 , local_tyvar_pa = emptyVarEnv
220 , local_bind_name = FSLIT("fn")
224 updVectInfo :: GlobalEnv -> TypeEnv -> VectInfo -> VectInfo
225 updVectInfo env tyenv info
227 vectInfoVar = global_exported_vars env
228 , vectInfoTyCon = mk_env typeEnvTyCons global_tycons
229 , vectInfoDataCon = mk_env typeEnvDataCons global_datacons
230 , vectInfoPADFun = mk_env typeEnvTyCons global_pa_funs
233 mk_env from_tyenv from_env = mkNameEnv [(name, (from,to))
234 | from <- from_tyenv tyenv
235 , let name = getName from
236 , Just to <- [lookupNameEnv (from_env env) name]]
238 data VResult a = Yes GlobalEnv LocalEnv a | No
240 newtype VM a = VM { runVM :: Builtins -> GlobalEnv -> LocalEnv -> DsM (VResult a) }
242 instance Monad VM where
243 return x = VM $ \bi genv lenv -> return (Yes genv lenv x)
244 VM p >>= f = VM $ \bi genv lenv -> do
247 Yes genv' lenv' x -> runVM (f x) bi genv' lenv'
251 noV = VM $ \_ _ _ -> return No
253 traceNoV :: String -> SDoc -> VM a
254 traceNoV s d = pprTrace s d noV
256 tryV :: VM a -> VM (Maybe a)
257 tryV (VM p) = VM $ \bi genv lenv ->
261 Yes genv' lenv' x -> return (Yes genv' lenv' (Just x))
262 No -> return (Yes genv lenv Nothing)
264 maybeV :: VM (Maybe a) -> VM a
265 maybeV p = maybe noV return =<< p
267 traceMaybeV :: String -> SDoc -> VM (Maybe a) -> VM a
268 traceMaybeV s d p = maybe (traceNoV s d) return =<< p
270 orElseV :: VM a -> VM a -> VM a
271 orElseV p q = maybe q return =<< tryV p
273 fixV :: (a -> VM a) -> VM a
274 fixV f = VM (\bi genv lenv -> fixDs $ \r -> runVM (f (unYes r)) bi genv lenv )
276 unYes (Yes _ _ x) = x
278 localV :: VM a -> VM a
285 closedV :: VM a -> VM a
288 setLEnv (emptyLocalEnv { local_bind_name = local_bind_name env })
293 liftDs :: DsM a -> VM a
294 liftDs p = VM $ \bi genv lenv -> do { x <- p; return (Yes genv lenv x) }
296 builtin :: (Builtins -> a) -> VM a
297 builtin f = VM $ \bi genv lenv -> return (Yes genv lenv (f bi))
299 readGEnv :: (GlobalEnv -> a) -> VM a
300 readGEnv f = VM $ \bi genv lenv -> return (Yes genv lenv (f genv))
302 setGEnv :: GlobalEnv -> VM ()
303 setGEnv genv = VM $ \_ _ lenv -> return (Yes genv lenv ())
305 updGEnv :: (GlobalEnv -> GlobalEnv) -> VM ()
306 updGEnv f = VM $ \_ genv lenv -> return (Yes (f genv) lenv ())
308 readLEnv :: (LocalEnv -> a) -> VM a
309 readLEnv f = VM $ \bi genv lenv -> return (Yes genv lenv (f lenv))
311 setLEnv :: LocalEnv -> VM ()
312 setLEnv lenv = VM $ \_ genv _ -> return (Yes genv lenv ())
314 updLEnv :: (LocalEnv -> LocalEnv) -> VM ()
315 updLEnv f = VM $ \_ genv lenv -> return (Yes genv (f lenv) ())
317 getInstEnv :: VM (InstEnv, InstEnv)
318 getInstEnv = readGEnv global_inst_env
320 getFamInstEnv :: VM FamInstEnvs
321 getFamInstEnv = readGEnv global_fam_inst_env
323 getBindName :: VM FastString
324 getBindName = readLEnv local_bind_name
326 inBind :: Id -> VM a -> VM a
328 = do updLEnv $ \env -> env { local_bind_name = occNameFS (getOccName id) }
331 lookupExternalVar :: Module -> FastString -> VM Var
332 lookupExternalVar mod fs
334 $ dsLookupGlobalId =<< lookupOrig mod (mkVarOccFS fs)
336 cloneName :: (OccName -> OccName) -> Name -> VM Name
337 cloneName mk_occ name = liftM make (liftDs newUnique)
339 occ_name = mk_occ (nameOccName name)
341 make u | isExternalName name = mkExternalName u (nameModule name)
344 | otherwise = mkSystemName u occ_name
346 cloneId :: (OccName -> OccName) -> Id -> Type -> VM Id
349 name <- cloneName mk_occ (getName id)
350 let id' | isExportedId id = Id.mkExportedLocalId name ty
351 | otherwise = Id.mkLocalId name ty
354 newExportedVar :: OccName -> Type -> VM Var
355 newExportedVar occ_name ty
357 mod <- liftDs getModuleDs
358 u <- liftDs newUnique
360 let name = mkExternalName u mod occ_name noSrcSpan
362 return $ Id.mkExportedLocalId name ty
364 newLocalVar :: FastString -> Type -> VM Var
367 u <- liftDs newUnique
368 return $ mkSysLocal fs u ty
370 newDummyVar :: Type -> VM Var
371 newDummyVar = newLocalVar FSLIT("ds")
373 newTyVar :: FastString -> Kind -> VM Var
376 u <- liftDs newUnique
377 return $ mkTyVar (mkSysTvName u fs) k
379 defGlobalVar :: Var -> Var -> VM ()
380 defGlobalVar v v' = updGEnv $ \env ->
381 env { global_vars = extendVarEnv (global_vars env) v v'
382 , global_exported_vars = upd (global_exported_vars env)
385 upd env | isExportedId v = extendVarEnv env v (v, v')
388 lookupVar :: Var -> VM (Scope Var (Var, Var))
391 r <- readLEnv $ \env -> lookupVarEnv (local_vars env) v
393 Just e -> return (Local e)
394 Nothing -> liftM Global
395 $ traceMaybeV "lookupVar" (ppr v)
396 (readGEnv $ \env -> lookupVarEnv (global_vars env) v)
398 lookupTyCon :: TyCon -> VM (Maybe TyCon)
400 | isUnLiftedTyCon tc || isTupleTyCon tc = return (Just tc)
402 | otherwise = readGEnv $ \env -> lookupNameEnv (global_tycons env) (tyConName tc)
404 defTyCon :: TyCon -> TyCon -> VM ()
405 defTyCon tc tc' = updGEnv $ \env ->
406 env { global_tycons = extendNameEnv (global_tycons env) (tyConName tc) tc' }
408 lookupDataCon :: DataCon -> VM (Maybe DataCon)
409 lookupDataCon dc = readGEnv $ \env -> lookupNameEnv (global_datacons env) (dataConName dc)
411 defDataCon :: DataCon -> DataCon -> VM ()
412 defDataCon dc dc' = updGEnv $ \env ->
413 env { global_datacons = extendNameEnv (global_datacons env) (dataConName dc) dc' }
415 lookupTyConPA :: TyCon -> VM (Maybe Var)
416 lookupTyConPA tc = readGEnv $ \env -> lookupNameEnv (global_pa_funs env) (tyConName tc)
418 defTyConPA :: TyCon -> Var -> VM ()
419 defTyConPA tc pa = updGEnv $ \env ->
420 env { global_pa_funs = extendNameEnv (global_pa_funs env) (tyConName tc) pa }
422 defTyConPAs :: [(TyCon, Var)] -> VM ()
423 defTyConPAs ps = updGEnv $ \env ->
424 env { global_pa_funs = extendNameEnvList (global_pa_funs env)
425 [(tyConName tc, pa) | (tc, pa) <- ps] }
427 defTyConBuiltinPAs :: [(Name, Module, FastString)] -> VM ()
428 defTyConBuiltinPAs ps
430 pas <- zipWithM lookupExternalVar mods fss
432 env { global_pa_funs = extendNameEnvList (global_pa_funs env)
435 (tcs, mods, fss) = unzip3 ps
437 lookupTyVarPA :: Var -> VM (Maybe CoreExpr)
438 lookupTyVarPA tv = readLEnv $ \env -> lookupVarEnv (local_tyvar_pa env) tv
440 defLocalTyVar :: TyVar -> VM ()
441 defLocalTyVar tv = updLEnv $ \env ->
442 env { local_tyvars = tv : local_tyvars env
443 , local_tyvar_pa = local_tyvar_pa env `delVarEnv` tv
446 defLocalTyVarWithPA :: TyVar -> CoreExpr -> VM ()
447 defLocalTyVarWithPA tv pa = updLEnv $ \env ->
448 env { local_tyvars = tv : local_tyvars env
449 , local_tyvar_pa = extendVarEnv (local_tyvar_pa env) tv pa
452 localTyVars :: VM [TyVar]
453 localTyVars = readLEnv (reverse . local_tyvars)
455 -- Look up the dfun of a class instance.
457 -- The match must be unique - ie, match exactly one instance - but the
458 -- type arguments used for matching may be more specific than those of
459 -- the class instance declaration. The found class instances must not have
460 -- any type variables in the instance context that do not appear in the
461 -- instances head (i.e., no flexi vars); for details for what this means,
462 -- see the docs at InstEnv.lookupInstEnv.
465 lookupInst :: Class -> [Type] -> VM (DFunId, [Type])
467 = do { instEnv <- getInstEnv
468 ; case lookupInstEnv instEnv cls tys of
469 ([(inst, inst_tys)], _)
470 | noFlexiVar -> return (instanceDFunId inst, inst_tys')
471 | otherwise -> pprPanic "VectMonad.lookupInst: flexi var: "
472 (ppr $ mkTyConApp (classTyCon cls) tys)
474 inst_tys' = [ty | Right ty <- inst_tys]
475 noFlexiVar = all isRight inst_tys
476 _other -> traceNoV "lookupInst" (ppr cls <+> ppr tys)
479 isRight (Left _) = False
480 isRight (Right _) = True
483 -- Look up the representation tycon of a family instance.
485 -- The match must be unique - ie, match exactly one instance - but the
486 -- type arguments used for matching may be more specific than those of
487 -- the family instance declaration.
489 -- Return the instance tycon and its type instance. For example, if we have
491 -- lookupFamInst 'T' '[Int]' yields (':R42T', 'Int')
493 -- then we have a coercion (ie, type instance of family instance coercion)
495 -- :Co:R42T Int :: T [Int] ~ :R42T Int
497 -- which implies that :R42T was declared as 'data instance T [a]'.
499 lookupFamInst :: TyCon -> [Type] -> VM (TyCon, [Type])
500 lookupFamInst tycon tys
501 = ASSERT( isOpenTyCon tycon )
502 do { instEnv <- getFamInstEnv
503 ; case lookupFamInstEnv instEnv tycon tys of
504 [(fam_inst, rep_tys)] -> return (famInstTyCon fam_inst, rep_tys)
506 pprPanic "VectMonad.lookupFamInst: not found: "
507 (ppr $ mkTyConApp tycon tys)
510 initV :: HscEnv -> ModGuts -> VectInfo -> VM a -> IO (Maybe (VectInfo, a))
511 initV hsc_env guts info p
513 eps <- hscEPS hsc_env
514 let famInstEnvs = (eps_fam_inst_env eps, mg_fam_inst_env guts)
515 let instEnvs = (eps_inst_env eps, mg_inst_env guts)
517 Just r <- initDs hsc_env (mg_module guts)
520 (go instEnvs famInstEnvs)
524 go instEnvs famInstEnvs =
526 builtins <- initBuiltins
527 r <- runVM p builtins (initGlobalEnv info
533 Yes genv _ x -> return $ Just (new_info genv, x)
536 new_info genv = updVectInfo genv (mg_types guts) info