5 noV, tryV, maybeV, traceMaybeV, orElseV, fixV, localV, closedV, initV,
7 newExportedVar, newLocalVar, newDummyVar, newTyVar,
14 readGEnv, setGEnv, updGEnv,
17 readLEnv, setLEnv, updLEnv,
21 lookupVar, defGlobalVar,
22 lookupTyCon, defTyCon,
23 lookupDataCon, defDataCon,
24 lookupTyConPA, defTyConPA, defTyConPAs, defTyConRdrPAs,
25 lookupTyVarPA, defLocalTyVar, defLocalTyVarWithPA, localTyVars,
27 {-lookupInst,-} lookupFamInst
30 #include "HsVersions.h"
43 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 , paDataCon :: DataCon
68 , closureTyCon :: TyCon
70 , applyClosureVar :: Var
71 , mkClosurePVar :: Var
72 , applyClosurePVar :: Var
74 , replicatePAVar :: Var
79 , liftingContext :: Var
82 initBuiltins :: DsM Builtins
85 parrayTyCon <- dsLookupTyCon parrayTyConName
86 paTyCon <- dsLookupTyCon paTyConName
87 let paDataCon = case tyConDataCons paTyCon of [dc] -> dc
88 closureTyCon <- dsLookupTyCon closureTyConName
90 mkClosureVar <- dsLookupGlobalId mkClosureName
91 applyClosureVar <- dsLookupGlobalId applyClosureName
92 mkClosurePVar <- dsLookupGlobalId mkClosurePName
93 applyClosurePVar <- dsLookupGlobalId applyClosurePName
94 lengthPAVar <- dsLookupGlobalId lengthPAName
95 replicatePAVar <- dsLookupGlobalId replicatePAName
96 emptyPAVar <- dsLookupGlobalId emptyPAName
97 packPAVar <- dsLookupGlobalId packPAName
98 combinePAVar <- dsLookupGlobalId combinePAName
99 intEqPAVar <- dsLookupGlobalId intEqPAName
101 liftingContext <- liftM (\u -> mkSysLocal FSLIT("lc") u intPrimTy)
105 parrayTyCon = parrayTyCon
107 , paDataCon = paDataCon
108 , closureTyCon = closureTyCon
109 , mkClosureVar = mkClosureVar
110 , applyClosureVar = applyClosureVar
111 , mkClosurePVar = mkClosurePVar
112 , applyClosurePVar = applyClosurePVar
113 , lengthPAVar = lengthPAVar
114 , replicatePAVar = replicatePAVar
115 , emptyPAVar = emptyPAVar
116 , packPAVar = packPAVar
117 , combinePAVar = combinePAVar
118 , intEqPAVar = intEqPAVar
119 , liftingContext = liftingContext
122 data GlobalEnv = GlobalEnv {
123 -- Mapping from global variables to their vectorised versions.
125 global_vars :: VarEnv Var
127 -- Exported variables which have a vectorised version
129 , global_exported_vars :: VarEnv (Var, Var)
131 -- Mapping from TyCons to their vectorised versions.
132 -- TyCons which do not have to be vectorised are mapped to
135 , global_tycons :: NameEnv TyCon
137 -- Mapping from DataCons to their vectorised versions
139 , global_datacons :: NameEnv DataCon
141 -- Mapping from TyCons to their PA dfuns
143 , global_pa_funs :: NameEnv Var
145 -- External package inst-env & home-package inst-env for class
148 , global_inst_env :: (InstEnv, InstEnv)
150 -- External package inst-env & home-package inst-env for family
153 , global_fam_inst_env :: FamInstEnvs
156 , global_bindings :: [(Var, CoreExpr)]
158 -- Global Rdr environment (from ModGuts)
160 , global_rdr_env :: GlobalRdrEnv
163 data LocalEnv = LocalEnv {
164 -- Mapping from local variables to their vectorised and
167 local_vars :: VarEnv (Var, Var)
169 -- In-scope type variables
171 , local_tyvars :: [TyVar]
173 -- Mapping from tyvars to their PA dictionaries
174 , local_tyvar_pa :: VarEnv CoreExpr
176 -- Local binding name
177 , local_bind_name :: FastString
181 initGlobalEnv :: VectInfo -> (InstEnv, InstEnv) -> FamInstEnvs -> Builtins -> GlobalRdrEnv
183 initGlobalEnv info instEnvs famInstEnvs bi rdr_env
185 global_vars = mapVarEnv snd $ vectInfoVar info
186 , global_exported_vars = emptyVarEnv
187 , global_tycons = extendNameEnv (mapNameEnv snd (vectInfoTyCon info))
188 (tyConName funTyCon) (closureTyCon bi)
190 , global_datacons = mapNameEnv snd $ vectInfoDataCon info
191 , global_pa_funs = mapNameEnv snd $ vectInfoPADFun info
192 , global_inst_env = instEnvs
193 , global_fam_inst_env = famInstEnvs
194 , global_bindings = []
195 , global_rdr_env = rdr_env
198 setFamInstEnv :: FamInstEnv -> GlobalEnv -> GlobalEnv
199 setFamInstEnv l_fam_inst genv
200 = genv { global_fam_inst_env = (g_fam_inst, l_fam_inst) }
202 (g_fam_inst, _) = global_fam_inst_env genv
204 emptyLocalEnv = LocalEnv {
205 local_vars = emptyVarEnv
207 , local_tyvar_pa = emptyVarEnv
208 , local_bind_name = FSLIT("fn")
212 updVectInfo :: GlobalEnv -> TypeEnv -> VectInfo -> VectInfo
213 updVectInfo env tyenv info
215 vectInfoVar = global_exported_vars env
216 , vectInfoTyCon = mk_env typeEnvTyCons global_tycons
217 , vectInfoDataCon = mk_env typeEnvDataCons global_datacons
218 , vectInfoPADFun = mk_env typeEnvTyCons global_pa_funs
221 mk_env from_tyenv from_env = mkNameEnv [(name, (from,to))
222 | from <- from_tyenv tyenv
223 , let name = getName from
224 , Just to <- [lookupNameEnv (from_env env) name]]
226 data VResult a = Yes GlobalEnv LocalEnv a | No
228 newtype VM a = VM { runVM :: Builtins -> GlobalEnv -> LocalEnv -> DsM (VResult a) }
230 instance Monad VM where
231 return x = VM $ \bi genv lenv -> return (Yes genv lenv x)
232 VM p >>= f = VM $ \bi genv lenv -> do
235 Yes genv' lenv' x -> runVM (f x) bi genv' lenv'
239 noV = VM $ \_ _ _ -> return No
241 traceNoV :: String -> SDoc -> VM a
242 traceNoV s d = pprTrace s d noV
244 tryV :: VM a -> VM (Maybe a)
245 tryV (VM p) = VM $ \bi genv lenv ->
249 Yes genv' lenv' x -> return (Yes genv' lenv' (Just x))
250 No -> return (Yes genv lenv Nothing)
252 maybeV :: VM (Maybe a) -> VM a
253 maybeV p = maybe noV return =<< p
255 traceMaybeV :: String -> SDoc -> VM (Maybe a) -> VM a
256 traceMaybeV s d p = maybe (traceNoV s d) return =<< p
258 orElseV :: VM a -> VM a -> VM a
259 orElseV p q = maybe q return =<< tryV p
261 fixV :: (a -> VM a) -> VM a
262 fixV f = VM (\bi genv lenv -> fixDs $ \r -> runVM (f (unYes r)) bi genv lenv )
264 unYes (Yes _ _ x) = x
266 localV :: VM a -> VM a
273 closedV :: VM a -> VM a
276 setLEnv (emptyLocalEnv { local_bind_name = local_bind_name env })
281 liftDs :: DsM a -> VM a
282 liftDs p = VM $ \bi genv lenv -> do { x <- p; return (Yes genv lenv x) }
284 builtin :: (Builtins -> a) -> VM a
285 builtin f = VM $ \bi genv lenv -> return (Yes genv lenv (f bi))
287 readGEnv :: (GlobalEnv -> a) -> VM a
288 readGEnv f = VM $ \bi genv lenv -> return (Yes genv lenv (f genv))
290 setGEnv :: GlobalEnv -> VM ()
291 setGEnv genv = VM $ \_ _ lenv -> return (Yes genv lenv ())
293 updGEnv :: (GlobalEnv -> GlobalEnv) -> VM ()
294 updGEnv f = VM $ \_ genv lenv -> return (Yes (f genv) lenv ())
296 readLEnv :: (LocalEnv -> a) -> VM a
297 readLEnv f = VM $ \bi genv lenv -> return (Yes genv lenv (f lenv))
299 setLEnv :: LocalEnv -> VM ()
300 setLEnv lenv = VM $ \_ genv _ -> return (Yes genv lenv ())
302 updLEnv :: (LocalEnv -> LocalEnv) -> VM ()
303 updLEnv f = VM $ \_ genv lenv -> return (Yes genv (f lenv) ())
305 getInstEnv :: VM (InstEnv, InstEnv)
306 getInstEnv = readGEnv global_inst_env
308 getFamInstEnv :: VM FamInstEnvs
309 getFamInstEnv = readGEnv global_fam_inst_env
311 getBindName :: VM FastString
312 getBindName = readLEnv local_bind_name
314 inBind :: Id -> VM a -> VM a
316 = do updLEnv $ \env -> env { local_bind_name = occNameFS (getOccName id) }
319 lookupRdrName :: RdrName -> VM Name
320 lookupRdrName rdr_name
322 rdr_env <- readGEnv global_rdr_env
323 case lookupGRE_RdrName rdr_name rdr_env of
324 [gre] -> return (gre_name gre)
325 [] -> pprPanic "VectMonad.lookupRdrName: not found" (ppr rdr_name)
326 _ -> pprPanic "VectMonad.lookupRdrName: ambiguous" (ppr rdr_name)
328 lookupRdrVar :: RdrName -> VM Var
329 lookupRdrVar rdr_name
331 name <- lookupRdrName rdr_name
332 liftDs (dsLookupGlobalId name)
334 cloneName :: (OccName -> OccName) -> Name -> VM Name
335 cloneName mk_occ name = liftM make (liftDs newUnique)
337 occ_name = mk_occ (nameOccName name)
339 make u | isExternalName name = mkExternalName u (nameModule name)
342 | otherwise = mkSystemName u occ_name
344 cloneId :: (OccName -> OccName) -> Id -> Type -> VM Id
347 name <- cloneName mk_occ (getName id)
348 let id' | isExportedId id = Id.mkExportedLocalId name ty
349 | otherwise = Id.mkLocalId name ty
352 newExportedVar :: OccName -> Type -> VM Var
353 newExportedVar occ_name ty
355 mod <- liftDs getModuleDs
356 u <- liftDs newUnique
358 let name = mkExternalName u mod occ_name noSrcSpan
360 return $ Id.mkExportedLocalId name ty
362 newLocalVar :: FastString -> Type -> VM Var
365 u <- liftDs newUnique
366 return $ mkSysLocal fs u ty
368 newDummyVar :: Type -> VM Var
369 newDummyVar = newLocalVar FSLIT("ds")
371 newTyVar :: FastString -> Kind -> VM Var
374 u <- liftDs newUnique
375 return $ mkTyVar (mkSysTvName u fs) k
377 defGlobalVar :: Var -> Var -> VM ()
378 defGlobalVar v v' = updGEnv $ \env ->
379 env { global_vars = extendVarEnv (global_vars env) v v'
380 , global_exported_vars = upd (global_exported_vars env)
383 upd env | isExportedId v = extendVarEnv env v (v, v')
386 lookupVar :: Var -> VM (Scope Var (Var, Var))
389 r <- readLEnv $ \env -> lookupVarEnv (local_vars env) v
391 Just e -> return (Local e)
392 Nothing -> liftM Global
393 $ traceMaybeV "lookupVar" (ppr v)
394 (readGEnv $ \env -> lookupVarEnv (global_vars env) v)
396 lookupTyCon :: TyCon -> VM (Maybe TyCon)
398 | isUnLiftedTyCon tc || isTupleTyCon tc = return (Just tc)
400 | otherwise = readGEnv $ \env -> lookupNameEnv (global_tycons env) (tyConName tc)
402 defTyCon :: TyCon -> TyCon -> VM ()
403 defTyCon tc tc' = updGEnv $ \env ->
404 env { global_tycons = extendNameEnv (global_tycons env) (tyConName tc) tc' }
406 lookupDataCon :: DataCon -> VM (Maybe DataCon)
407 lookupDataCon dc = readGEnv $ \env -> lookupNameEnv (global_datacons env) (dataConName dc)
409 defDataCon :: DataCon -> DataCon -> VM ()
410 defDataCon dc dc' = updGEnv $ \env ->
411 env { global_datacons = extendNameEnv (global_datacons env) (dataConName dc) dc' }
413 lookupTyConPA :: TyCon -> VM (Maybe Var)
414 lookupTyConPA tc = readGEnv $ \env -> lookupNameEnv (global_pa_funs env) (tyConName tc)
416 defTyConPA :: TyCon -> Var -> VM ()
417 defTyConPA tc pa = updGEnv $ \env ->
418 env { global_pa_funs = extendNameEnv (global_pa_funs env) (tyConName tc) pa }
420 defTyConPAs :: [(TyCon, Var)] -> VM ()
421 defTyConPAs ps = updGEnv $ \env ->
422 env { global_pa_funs = extendNameEnvList (global_pa_funs env)
423 [(tyConName tc, pa) | (tc, pa) <- ps] }
425 defTyConRdrPAs :: [(Name, RdrName)] -> VM ()
428 pas <- mapM lookupRdrVar rdr_names
430 env { global_pa_funs = extendNameEnvList (global_pa_funs env)
433 (tcs, rdr_names) = unzip ps
435 lookupTyVarPA :: Var -> VM (Maybe CoreExpr)
436 lookupTyVarPA tv = readLEnv $ \env -> lookupVarEnv (local_tyvar_pa env) tv
438 defLocalTyVar :: TyVar -> VM ()
439 defLocalTyVar tv = updLEnv $ \env ->
440 env { local_tyvars = tv : local_tyvars env
441 , local_tyvar_pa = local_tyvar_pa env `delVarEnv` tv
444 defLocalTyVarWithPA :: TyVar -> CoreExpr -> VM ()
445 defLocalTyVarWithPA tv pa = updLEnv $ \env ->
446 env { local_tyvars = tv : local_tyvars env
447 , local_tyvar_pa = extendVarEnv (local_tyvar_pa env) tv pa
450 localTyVars :: VM [TyVar]
451 localTyVars = readLEnv (reverse . local_tyvars)
453 -- Look up the dfun of a class instance.
455 -- The match must be unique - ie, match exactly one instance - but the
456 -- type arguments used for matching may be more specific than those of
457 -- the class instance declaration. The found class instances must not have
458 -- any type variables in the instance context that do not appear in the
459 -- instances head (i.e., no flexi vars); for details for what this means,
460 -- see the docs at InstEnv.lookupInstEnv.
463 lookupInst :: Class -> [Type] -> VM (DFunId, [Type])
465 = do { instEnv <- getInstEnv
466 ; case lookupInstEnv instEnv cls tys of
467 ([(inst, inst_tys)], _)
468 | noFlexiVar -> return (instanceDFunId inst, inst_tys')
469 | otherwise -> pprPanic "VectMonad.lookupInst: flexi var: "
470 (ppr $ mkTyConApp (classTyCon cls) tys)
472 inst_tys' = [ty | Right ty <- inst_tys]
473 noFlexiVar = all isRight inst_tys
474 _other -> traceNoV "lookupInst" (ppr cls <+> ppr tys)
477 isRight (Left _) = False
478 isRight (Right _) = True
481 -- Look up the representation tycon of a family instance.
483 -- The match must be unique - ie, match exactly one instance - but the
484 -- type arguments used for matching may be more specific than those of
485 -- the family instance declaration.
487 -- Return the instance tycon and its type instance. For example, if we have
489 -- lookupFamInst 'T' '[Int]' yields (':R42T', 'Int')
491 -- then we have a coercion (ie, type instance of family instance coercion)
493 -- :Co:R42T Int :: T [Int] ~ :R42T Int
495 -- which implies that :R42T was declared as 'data instance T [a]'.
497 lookupFamInst :: TyCon -> [Type] -> VM (TyCon, [Type])
498 lookupFamInst tycon tys
499 = ASSERT( isOpenTyCon tycon )
500 do { instEnv <- getFamInstEnv
501 ; case lookupFamInstEnv instEnv tycon tys of
502 [(fam_inst, rep_tys)] -> return (famInstTyCon fam_inst, rep_tys)
504 pprPanic "VectMonad.lookupFamInst: not found: "
505 (ppr $ mkTyConApp tycon tys)
508 initV :: HscEnv -> ModGuts -> VectInfo -> VM a -> IO (Maybe (VectInfo, a))
509 initV hsc_env guts info p
511 eps <- hscEPS hsc_env
512 let famInstEnvs = (eps_fam_inst_env eps, mg_fam_inst_env guts)
513 let instEnvs = (eps_inst_env eps, mg_inst_env guts)
515 Just r <- initDs hsc_env (mg_module guts)
518 (go instEnvs famInstEnvs)
522 go instEnvs famInstEnvs =
524 builtins <- initBuiltins
525 r <- runVM p builtins (initGlobalEnv info
532 Yes genv _ x -> return $ Just (new_info genv, x)
535 new_info genv = updVectInfo genv (mg_types guts) info