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
74 , crossDataCon :: DataCon
76 , leftDataCon :: DataCon
77 , rightDataCon :: DataCon
78 , closureTyCon :: TyCon
80 , applyClosureVar :: Var
81 , mkClosurePVar :: Var
82 , applyClosurePVar :: Var
84 , replicatePAVar :: Var
87 -- , combinePAVar :: Var
89 , liftingContext :: Var
92 initBuiltins :: DsM Builtins
95 parrayTyCon <- dsLookupTyCon parrayTyConName
96 paTyCon <- dsLookupTyCon paTyConName
97 let [paDataCon] = tyConDataCons paTyCon
98 preprTyCon <- dsLookupTyCon preprTyConName
99 embedTyCon <- dsLookupTyCon embedTyConName
100 let [embedDataCon] = tyConDataCons embedTyCon
101 crossTyCon <- dsLookupTyCon crossTyConName
102 let [crossDataCon] = tyConDataCons crossTyCon
103 plusTyCon <- dsLookupTyCon plusTyConName
104 let [leftDataCon, rightDataCon] = tyConDataCons plusTyCon
105 closureTyCon <- dsLookupTyCon closureTyConName
107 mkClosureVar <- dsLookupGlobalId mkClosureName
108 applyClosureVar <- dsLookupGlobalId applyClosureName
109 mkClosurePVar <- dsLookupGlobalId mkClosurePName
110 applyClosurePVar <- dsLookupGlobalId applyClosurePName
111 lengthPAVar <- dsLookupGlobalId lengthPAName
112 replicatePAVar <- dsLookupGlobalId replicatePAName
113 emptyPAVar <- dsLookupGlobalId emptyPAName
114 -- packPAVar <- dsLookupGlobalId packPAName
115 -- combinePAVar <- dsLookupGlobalId combinePAName
116 intEqPAVar <- dsLookupGlobalId intEqPAName
118 liftingContext <- liftM (\u -> mkSysLocal FSLIT("lc") u intPrimTy)
122 parrayTyCon = parrayTyCon
124 , paDataCon = paDataCon
125 , preprTyCon = preprTyCon
126 , embedTyCon = embedTyCon
127 , embedDataCon = embedDataCon
128 , crossTyCon = crossTyCon
129 , crossDataCon = crossDataCon
130 , plusTyCon = plusTyCon
131 , leftDataCon = leftDataCon
132 , rightDataCon = rightDataCon
133 , closureTyCon = closureTyCon
134 , mkClosureVar = mkClosureVar
135 , applyClosureVar = applyClosureVar
136 , mkClosurePVar = mkClosurePVar
137 , applyClosurePVar = applyClosurePVar
138 , lengthPAVar = lengthPAVar
139 , replicatePAVar = replicatePAVar
140 , emptyPAVar = emptyPAVar
141 -- , packPAVar = packPAVar
142 -- , combinePAVar = combinePAVar
143 , intEqPAVar = intEqPAVar
144 , liftingContext = liftingContext
147 data GlobalEnv = GlobalEnv {
148 -- Mapping from global variables to their vectorised versions.
150 global_vars :: VarEnv Var
152 -- Exported variables which have a vectorised version
154 , global_exported_vars :: VarEnv (Var, Var)
156 -- Mapping from TyCons to their vectorised versions.
157 -- TyCons which do not have to be vectorised are mapped to
160 , global_tycons :: NameEnv TyCon
162 -- Mapping from DataCons to their vectorised versions
164 , global_datacons :: NameEnv DataCon
166 -- Mapping from TyCons to their PA dfuns
168 , global_pa_funs :: NameEnv Var
170 -- External package inst-env & home-package inst-env for class
173 , global_inst_env :: (InstEnv, InstEnv)
175 -- External package inst-env & home-package inst-env for family
178 , global_fam_inst_env :: FamInstEnvs
181 , global_bindings :: [(Var, CoreExpr)]
184 data LocalEnv = LocalEnv {
185 -- Mapping from local variables to their vectorised and
188 local_vars :: VarEnv (Var, Var)
190 -- In-scope type variables
192 , local_tyvars :: [TyVar]
194 -- Mapping from tyvars to their PA dictionaries
195 , local_tyvar_pa :: VarEnv CoreExpr
197 -- Local binding name
198 , local_bind_name :: FastString
202 initGlobalEnv :: VectInfo -> (InstEnv, InstEnv) -> FamInstEnvs -> Builtins
204 initGlobalEnv info instEnvs famInstEnvs bi
206 global_vars = mapVarEnv snd $ vectInfoVar info
207 , global_exported_vars = emptyVarEnv
208 , global_tycons = extendNameEnv (mapNameEnv snd (vectInfoTyCon info))
209 (tyConName funTyCon) (closureTyCon bi)
211 , global_datacons = mapNameEnv snd $ vectInfoDataCon info
212 , global_pa_funs = mapNameEnv snd $ vectInfoPADFun info
213 , global_inst_env = instEnvs
214 , global_fam_inst_env = famInstEnvs
215 , global_bindings = []
218 setFamInstEnv :: FamInstEnv -> GlobalEnv -> GlobalEnv
219 setFamInstEnv l_fam_inst genv
220 = genv { global_fam_inst_env = (g_fam_inst, l_fam_inst) }
222 (g_fam_inst, _) = global_fam_inst_env genv
224 emptyLocalEnv = LocalEnv {
225 local_vars = emptyVarEnv
227 , local_tyvar_pa = emptyVarEnv
228 , local_bind_name = FSLIT("fn")
232 updVectInfo :: GlobalEnv -> TypeEnv -> VectInfo -> VectInfo
233 updVectInfo env tyenv info
235 vectInfoVar = global_exported_vars env
236 , vectInfoTyCon = mk_env typeEnvTyCons global_tycons
237 , vectInfoDataCon = mk_env typeEnvDataCons global_datacons
238 , vectInfoPADFun = mk_env typeEnvTyCons global_pa_funs
241 mk_env from_tyenv from_env = mkNameEnv [(name, (from,to))
242 | from <- from_tyenv tyenv
243 , let name = getName from
244 , Just to <- [lookupNameEnv (from_env env) name]]
246 data VResult a = Yes GlobalEnv LocalEnv a | No
248 newtype VM a = VM { runVM :: Builtins -> GlobalEnv -> LocalEnv -> DsM (VResult a) }
250 instance Monad VM where
251 return x = VM $ \bi genv lenv -> return (Yes genv lenv x)
252 VM p >>= f = VM $ \bi genv lenv -> do
255 Yes genv' lenv' x -> runVM (f x) bi genv' lenv'
259 noV = VM $ \_ _ _ -> return No
261 traceNoV :: String -> SDoc -> VM a
262 traceNoV s d = pprTrace s d noV
264 tryV :: VM a -> VM (Maybe a)
265 tryV (VM p) = VM $ \bi genv lenv ->
269 Yes genv' lenv' x -> return (Yes genv' lenv' (Just x))
270 No -> return (Yes genv lenv Nothing)
272 maybeV :: VM (Maybe a) -> VM a
273 maybeV p = maybe noV return =<< p
275 traceMaybeV :: String -> SDoc -> VM (Maybe a) -> VM a
276 traceMaybeV s d p = maybe (traceNoV s d) return =<< p
278 orElseV :: VM a -> VM a -> VM a
279 orElseV p q = maybe q return =<< tryV p
281 fixV :: (a -> VM a) -> VM a
282 fixV f = VM (\bi genv lenv -> fixDs $ \r -> runVM (f (unYes r)) bi genv lenv )
284 unYes (Yes _ _ x) = x
286 localV :: VM a -> VM a
293 closedV :: VM a -> VM a
296 setLEnv (emptyLocalEnv { local_bind_name = local_bind_name env })
301 liftDs :: DsM a -> VM a
302 liftDs p = VM $ \bi genv lenv -> do { x <- p; return (Yes genv lenv x) }
304 builtin :: (Builtins -> a) -> VM a
305 builtin f = VM $ \bi genv lenv -> return (Yes genv lenv (f bi))
307 readGEnv :: (GlobalEnv -> a) -> VM a
308 readGEnv f = VM $ \bi genv lenv -> return (Yes genv lenv (f genv))
310 setGEnv :: GlobalEnv -> VM ()
311 setGEnv genv = VM $ \_ _ lenv -> return (Yes genv lenv ())
313 updGEnv :: (GlobalEnv -> GlobalEnv) -> VM ()
314 updGEnv f = VM $ \_ genv lenv -> return (Yes (f genv) lenv ())
316 readLEnv :: (LocalEnv -> a) -> VM a
317 readLEnv f = VM $ \bi genv lenv -> return (Yes genv lenv (f lenv))
319 setLEnv :: LocalEnv -> VM ()
320 setLEnv lenv = VM $ \_ genv _ -> return (Yes genv lenv ())
322 updLEnv :: (LocalEnv -> LocalEnv) -> VM ()
323 updLEnv f = VM $ \_ genv lenv -> return (Yes genv (f lenv) ())
325 getInstEnv :: VM (InstEnv, InstEnv)
326 getInstEnv = readGEnv global_inst_env
328 getFamInstEnv :: VM FamInstEnvs
329 getFamInstEnv = readGEnv global_fam_inst_env
331 getBindName :: VM FastString
332 getBindName = readLEnv local_bind_name
334 inBind :: Id -> VM a -> VM a
336 = do updLEnv $ \env -> env { local_bind_name = occNameFS (getOccName id) }
339 lookupExternalVar :: Module -> FastString -> VM Var
340 lookupExternalVar mod fs
342 $ dsLookupGlobalId =<< lookupOrig mod (mkVarOccFS fs)
344 cloneName :: (OccName -> OccName) -> Name -> VM Name
345 cloneName mk_occ name = liftM make (liftDs newUnique)
347 occ_name = mk_occ (nameOccName name)
349 make u | isExternalName name = mkExternalName u (nameModule name)
352 | otherwise = mkSystemName u occ_name
354 cloneId :: (OccName -> OccName) -> Id -> Type -> VM Id
357 name <- cloneName mk_occ (getName id)
358 let id' | isExportedId id = Id.mkExportedLocalId name ty
359 | otherwise = Id.mkLocalId name ty
362 newExportedVar :: OccName -> Type -> VM Var
363 newExportedVar occ_name ty
365 mod <- liftDs getModuleDs
366 u <- liftDs newUnique
368 let name = mkExternalName u mod occ_name noSrcSpan
370 return $ Id.mkExportedLocalId name ty
372 newLocalVar :: FastString -> Type -> VM Var
375 u <- liftDs newUnique
376 return $ mkSysLocal fs u ty
378 newDummyVar :: Type -> VM Var
379 newDummyVar = newLocalVar FSLIT("ds")
381 newTyVar :: FastString -> Kind -> VM Var
384 u <- liftDs newUnique
385 return $ mkTyVar (mkSysTvName u fs) k
387 defGlobalVar :: Var -> Var -> VM ()
388 defGlobalVar v v' = updGEnv $ \env ->
389 env { global_vars = extendVarEnv (global_vars env) v v'
390 , global_exported_vars = upd (global_exported_vars env)
393 upd env | isExportedId v = extendVarEnv env v (v, v')
396 lookupVar :: Var -> VM (Scope Var (Var, Var))
399 r <- readLEnv $ \env -> lookupVarEnv (local_vars env) v
401 Just e -> return (Local e)
402 Nothing -> liftM Global
403 $ traceMaybeV "lookupVar" (ppr v)
404 (readGEnv $ \env -> lookupVarEnv (global_vars env) v)
406 lookupTyCon :: TyCon -> VM (Maybe TyCon)
408 | isUnLiftedTyCon tc || isTupleTyCon tc = return (Just tc)
410 | otherwise = readGEnv $ \env -> lookupNameEnv (global_tycons env) (tyConName tc)
412 defTyCon :: TyCon -> TyCon -> VM ()
413 defTyCon tc tc' = updGEnv $ \env ->
414 env { global_tycons = extendNameEnv (global_tycons env) (tyConName tc) tc' }
416 lookupDataCon :: DataCon -> VM (Maybe DataCon)
417 lookupDataCon dc = readGEnv $ \env -> lookupNameEnv (global_datacons env) (dataConName dc)
419 defDataCon :: DataCon -> DataCon -> VM ()
420 defDataCon dc dc' = updGEnv $ \env ->
421 env { global_datacons = extendNameEnv (global_datacons env) (dataConName dc) dc' }
423 lookupTyConPA :: TyCon -> VM (Maybe Var)
424 lookupTyConPA tc = readGEnv $ \env -> lookupNameEnv (global_pa_funs env) (tyConName tc)
426 defTyConPA :: TyCon -> Var -> VM ()
427 defTyConPA tc pa = updGEnv $ \env ->
428 env { global_pa_funs = extendNameEnv (global_pa_funs env) (tyConName tc) pa }
430 defTyConPAs :: [(TyCon, Var)] -> VM ()
431 defTyConPAs ps = updGEnv $ \env ->
432 env { global_pa_funs = extendNameEnvList (global_pa_funs env)
433 [(tyConName tc, pa) | (tc, pa) <- ps] }
435 defTyConBuiltinPAs :: [(Name, Module, FastString)] -> VM ()
436 defTyConBuiltinPAs ps
438 pas <- zipWithM lookupExternalVar mods fss
440 env { global_pa_funs = extendNameEnvList (global_pa_funs env)
443 (tcs, mods, fss) = unzip3 ps
445 lookupTyVarPA :: Var -> VM (Maybe CoreExpr)
446 lookupTyVarPA tv = readLEnv $ \env -> lookupVarEnv (local_tyvar_pa env) tv
448 defLocalTyVar :: TyVar -> VM ()
449 defLocalTyVar tv = updLEnv $ \env ->
450 env { local_tyvars = tv : local_tyvars env
451 , local_tyvar_pa = local_tyvar_pa env `delVarEnv` tv
454 defLocalTyVarWithPA :: TyVar -> CoreExpr -> VM ()
455 defLocalTyVarWithPA tv pa = updLEnv $ \env ->
456 env { local_tyvars = tv : local_tyvars env
457 , local_tyvar_pa = extendVarEnv (local_tyvar_pa env) tv pa
460 localTyVars :: VM [TyVar]
461 localTyVars = readLEnv (reverse . local_tyvars)
463 -- Look up the dfun of a class instance.
465 -- The match must be unique - ie, match exactly one instance - but the
466 -- type arguments used for matching may be more specific than those of
467 -- the class instance declaration. The found class instances must not have
468 -- any type variables in the instance context that do not appear in the
469 -- instances head (i.e., no flexi vars); for details for what this means,
470 -- see the docs at InstEnv.lookupInstEnv.
473 lookupInst :: Class -> [Type] -> VM (DFunId, [Type])
475 = do { instEnv <- getInstEnv
476 ; case lookupInstEnv instEnv cls tys of
477 ([(inst, inst_tys)], _)
478 | noFlexiVar -> return (instanceDFunId inst, inst_tys')
479 | otherwise -> pprPanic "VectMonad.lookupInst: flexi var: "
480 (ppr $ mkTyConApp (classTyCon cls) tys)
482 inst_tys' = [ty | Right ty <- inst_tys]
483 noFlexiVar = all isRight inst_tys
484 _other -> traceNoV "lookupInst" (ppr cls <+> ppr tys)
487 isRight (Left _) = False
488 isRight (Right _) = True
491 -- Look up the representation tycon of a family instance.
493 -- The match must be unique - ie, match exactly one instance - but the
494 -- type arguments used for matching may be more specific than those of
495 -- the family instance declaration.
497 -- Return the instance tycon and its type instance. For example, if we have
499 -- lookupFamInst 'T' '[Int]' yields (':R42T', 'Int')
501 -- then we have a coercion (ie, type instance of family instance coercion)
503 -- :Co:R42T Int :: T [Int] ~ :R42T Int
505 -- which implies that :R42T was declared as 'data instance T [a]'.
507 lookupFamInst :: TyCon -> [Type] -> VM (TyCon, [Type])
508 lookupFamInst tycon tys
509 = ASSERT( isOpenTyCon tycon )
510 do { instEnv <- getFamInstEnv
511 ; case lookupFamInstEnv instEnv tycon tys of
512 [(fam_inst, rep_tys)] -> return (famInstTyCon fam_inst, rep_tys)
514 pprPanic "VectMonad.lookupFamInst: not found: "
515 (ppr $ mkTyConApp tycon tys)
518 initV :: HscEnv -> ModGuts -> VectInfo -> VM a -> IO (Maybe (VectInfo, a))
519 initV hsc_env guts info p
521 eps <- hscEPS hsc_env
522 let famInstEnvs = (eps_fam_inst_env eps, mg_fam_inst_env guts)
523 let instEnvs = (eps_inst_env eps, mg_inst_env guts)
525 Just r <- initDs hsc_env (mg_module guts)
528 (go instEnvs famInstEnvs)
532 go instEnvs famInstEnvs =
534 builtins <- initBuiltins
535 r <- runVM p builtins (initGlobalEnv info
541 Yes genv _ x -> return $ Just (new_info genv, x)
544 new_info genv = updVectInfo genv (mg_types guts) info