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 )
56 import SrcLoc ( noSrcSpan )
58 import Control.Monad ( liftM )
60 data Scope a b = Global a | Local b
62 -- ----------------------------------------------------------------------------
63 -- Vectorisation monad
65 data Builtins = Builtins {
68 , closureTyCon :: TyCon
70 , applyClosureVar :: Var
71 , mkClosurePVar :: Var
72 , applyClosurePVar :: Var
74 , replicatePAVar :: Var
76 , liftingContext :: Var
79 paDictTyCon :: Builtins -> TyCon
80 paDictTyCon = classTyCon . paClass
82 paDictDataCon :: Builtins -> DataCon
83 paDictDataCon = classDataCon . paClass
85 initBuiltins :: DsM Builtins
88 parrayTyCon <- dsLookupTyCon parrayTyConName
89 paClass <- dsLookupClass paClassName
90 closureTyCon <- dsLookupTyCon closureTyConName
92 mkClosureVar <- dsLookupGlobalId mkClosureName
93 applyClosureVar <- dsLookupGlobalId applyClosureName
94 mkClosurePVar <- dsLookupGlobalId mkClosurePName
95 applyClosurePVar <- dsLookupGlobalId applyClosurePName
96 lengthPAVar <- dsLookupGlobalId lengthPAName
97 replicatePAVar <- dsLookupGlobalId replicatePAName
98 emptyPAVar <- dsLookupGlobalId emptyPAName
100 liftingContext <- liftM (\u -> mkSysLocal FSLIT("lc") u intPrimTy)
104 parrayTyCon = parrayTyCon
106 , closureTyCon = closureTyCon
107 , mkClosureVar = mkClosureVar
108 , applyClosureVar = applyClosureVar
109 , mkClosurePVar = mkClosurePVar
110 , applyClosurePVar = applyClosurePVar
111 , lengthPAVar = lengthPAVar
112 , replicatePAVar = replicatePAVar
113 , emptyPAVar = emptyPAVar
114 , liftingContext = liftingContext
117 data GlobalEnv = GlobalEnv {
118 -- Mapping from global variables to their vectorised versions.
120 global_vars :: VarEnv Var
122 -- Exported variables which have a vectorised version
124 , global_exported_vars :: VarEnv (Var, Var)
126 -- Mapping from TyCons to their vectorised versions.
127 -- TyCons which do not have to be vectorised are mapped to
130 , global_tycons :: NameEnv TyCon
132 -- Mapping from DataCons to their vectorised versions
134 , global_datacons :: NameEnv DataCon
136 -- Mapping from TyCons to their PA dfuns
138 , global_pa_funs :: NameEnv Var
140 -- External package inst-env & home-package inst-env for class
143 , global_inst_env :: (InstEnv, InstEnv)
145 -- External package inst-env & home-package inst-env for family
148 , global_fam_inst_env :: FamInstEnvs
151 , global_bindings :: [(Var, CoreExpr)]
153 -- Global Rdr environment (from ModGuts)
155 , global_rdr_env :: GlobalRdrEnv
158 data LocalEnv = LocalEnv {
159 -- Mapping from local variables to their vectorised and
162 local_vars :: VarEnv (Var, Var)
164 -- In-scope type variables
166 , local_tyvars :: [TyVar]
168 -- Mapping from tyvars to their PA dictionaries
169 , local_tyvar_pa :: VarEnv CoreExpr
171 -- Local binding name
172 , local_bind_name :: FastString
176 initGlobalEnv :: VectInfo -> (InstEnv, InstEnv) -> FamInstEnvs -> Builtins -> GlobalRdrEnv
178 initGlobalEnv info instEnvs famInstEnvs bi rdr_env
180 global_vars = mapVarEnv snd $ vectInfoVar info
181 , global_exported_vars = emptyVarEnv
182 , global_tycons = extendNameEnv (mapNameEnv snd (vectInfoTyCon info))
183 (tyConName funTyCon) (closureTyCon bi)
185 , global_datacons = mapNameEnv snd $ vectInfoDataCon info
186 , global_pa_funs = mapNameEnv snd $ vectInfoPADFun info
187 , global_inst_env = instEnvs
188 , global_fam_inst_env = famInstEnvs
189 , global_bindings = []
190 , global_rdr_env = rdr_env
193 setInstEnvs :: InstEnv -> FamInstEnv -> GlobalEnv -> GlobalEnv
194 setInstEnvs l_inst l_fam_inst genv
195 | (g_inst, _) <- global_inst_env genv
196 , (g_fam_inst, _) <- global_fam_inst_env genv
197 = genv { global_inst_env = (g_inst, l_inst)
198 , global_fam_inst_env = (g_fam_inst, l_fam_inst) }
200 emptyLocalEnv = LocalEnv {
201 local_vars = emptyVarEnv
203 , local_tyvar_pa = emptyVarEnv
204 , local_bind_name = FSLIT("fn")
208 updVectInfo :: GlobalEnv -> TypeEnv -> VectInfo -> VectInfo
209 updVectInfo env tyenv info
211 vectInfoVar = global_exported_vars env
212 , vectInfoTyCon = mk_env typeEnvTyCons global_tycons
213 , vectInfoDataCon = mk_env typeEnvDataCons global_datacons
214 , vectInfoPADFun = mk_env typeEnvTyCons global_pa_funs
217 mk_env from_tyenv from_env = mkNameEnv [(name, (from,to))
218 | from <- from_tyenv tyenv
219 , let name = getName from
220 , Just to <- [lookupNameEnv (from_env env) name]]
222 data VResult a = Yes GlobalEnv LocalEnv a | No
224 newtype VM a = VM { runVM :: Builtins -> GlobalEnv -> LocalEnv -> DsM (VResult a) }
226 instance Monad VM where
227 return x = VM $ \bi genv lenv -> return (Yes genv lenv x)
228 VM p >>= f = VM $ \bi genv lenv -> do
231 Yes genv' lenv' x -> runVM (f x) bi genv' lenv'
235 noV = VM $ \_ _ _ -> return No
237 traceNoV :: String -> SDoc -> VM a
238 traceNoV s d = pprTrace s d noV
240 tryV :: VM a -> VM (Maybe a)
241 tryV (VM p) = VM $ \bi genv lenv ->
245 Yes genv' lenv' x -> return (Yes genv' lenv' (Just x))
246 No -> return (Yes genv lenv Nothing)
248 maybeV :: VM (Maybe a) -> VM a
249 maybeV p = maybe noV return =<< p
251 traceMaybeV :: String -> SDoc -> VM (Maybe a) -> VM a
252 traceMaybeV s d p = maybe (traceNoV s d) return =<< p
254 orElseV :: VM a -> VM a -> VM a
255 orElseV p q = maybe q return =<< tryV p
257 fixV :: (a -> VM a) -> VM a
258 fixV f = VM (\bi genv lenv -> fixDs $ \r -> runVM (f (unYes r)) bi genv lenv )
260 unYes (Yes _ _ x) = x
262 localV :: VM a -> VM a
269 closedV :: VM a -> VM a
272 setLEnv (emptyLocalEnv { local_bind_name = local_bind_name env })
277 liftDs :: DsM a -> VM a
278 liftDs p = VM $ \bi genv lenv -> do { x <- p; return (Yes genv lenv x) }
280 builtin :: (Builtins -> a) -> VM a
281 builtin f = VM $ \bi genv lenv -> return (Yes genv lenv (f bi))
283 readGEnv :: (GlobalEnv -> a) -> VM a
284 readGEnv f = VM $ \bi genv lenv -> return (Yes genv lenv (f genv))
286 setGEnv :: GlobalEnv -> VM ()
287 setGEnv genv = VM $ \_ _ lenv -> return (Yes genv lenv ())
289 updGEnv :: (GlobalEnv -> GlobalEnv) -> VM ()
290 updGEnv f = VM $ \_ genv lenv -> return (Yes (f genv) lenv ())
292 readLEnv :: (LocalEnv -> a) -> VM a
293 readLEnv f = VM $ \bi genv lenv -> return (Yes genv lenv (f lenv))
295 setLEnv :: LocalEnv -> VM ()
296 setLEnv lenv = VM $ \_ genv _ -> return (Yes genv lenv ())
298 updLEnv :: (LocalEnv -> LocalEnv) -> VM ()
299 updLEnv f = VM $ \_ genv lenv -> return (Yes genv (f lenv) ())
301 getInstEnv :: VM (InstEnv, InstEnv)
302 getInstEnv = readGEnv global_inst_env
304 getFamInstEnv :: VM FamInstEnvs
305 getFamInstEnv = readGEnv global_fam_inst_env
307 getBindName :: VM FastString
308 getBindName = readLEnv local_bind_name
310 inBind :: Id -> VM a -> VM a
312 = do updLEnv $ \env -> env { local_bind_name = occNameFS (getOccName id) }
315 lookupRdrName :: RdrName -> VM Name
316 lookupRdrName rdr_name
318 rdr_env <- readGEnv global_rdr_env
319 case lookupGRE_RdrName rdr_name rdr_env of
320 [gre] -> return (gre_name gre)
321 [] -> pprPanic "VectMonad.lookupRdrName: not found" (ppr rdr_name)
322 _ -> pprPanic "VectMonad.lookupRdrName: ambiguous" (ppr rdr_name)
324 lookupRdrVar :: RdrName -> VM Var
325 lookupRdrVar rdr_name
327 name <- lookupRdrName rdr_name
328 liftDs (dsLookupGlobalId name)
330 cloneName :: (OccName -> OccName) -> Name -> VM Name
331 cloneName mk_occ name = liftM make (liftDs newUnique)
333 occ_name = mk_occ (nameOccName name)
335 make u | isExternalName name = mkExternalName u (nameModule name)
338 | otherwise = mkSystemName u occ_name
340 cloneId :: (OccName -> OccName) -> Id -> Type -> VM Id
343 name <- cloneName mk_occ (getName id)
344 let id' | isExportedId id = Id.mkExportedLocalId name ty
345 | otherwise = Id.mkLocalId name ty
348 newExportedVar :: OccName -> Type -> VM Var
349 newExportedVar occ_name ty
351 mod <- liftDs getModuleDs
352 u <- liftDs newUnique
354 let name = mkExternalName u mod occ_name noSrcSpan
356 return $ Id.mkExportedLocalId name ty
358 newLocalVar :: FastString -> Type -> VM Var
361 u <- liftDs newUnique
362 return $ mkSysLocal fs u ty
364 newDummyVar :: Type -> VM Var
365 newDummyVar = newLocalVar FSLIT("ds")
367 newTyVar :: FastString -> Kind -> VM Var
370 u <- liftDs newUnique
371 return $ mkTyVar (mkSysTvName u fs) k
373 defGlobalVar :: Var -> Var -> VM ()
374 defGlobalVar v v' = updGEnv $ \env ->
375 env { global_vars = extendVarEnv (global_vars env) v v'
376 , global_exported_vars = upd (global_exported_vars env)
379 upd env | isExportedId v = extendVarEnv env v (v, v')
382 lookupVar :: Var -> VM (Scope Var (Var, Var))
385 r <- readLEnv $ \env -> lookupVarEnv (local_vars env) v
387 Just e -> return (Local e)
388 Nothing -> liftM Global
389 $ traceMaybeV "lookupVar" (ppr v)
390 (readGEnv $ \env -> lookupVarEnv (global_vars env) v)
392 lookupTyCon :: TyCon -> VM (Maybe TyCon)
394 | isUnLiftedTyCon tc || isTupleTyCon tc = return (Just tc)
396 | otherwise = readGEnv $ \env -> lookupNameEnv (global_tycons env) (tyConName tc)
398 defTyCon :: TyCon -> TyCon -> VM ()
399 defTyCon tc tc' = updGEnv $ \env ->
400 env { global_tycons = extendNameEnv (global_tycons env) (tyConName tc) tc' }
402 lookupDataCon :: DataCon -> VM (Maybe DataCon)
403 lookupDataCon dc = readGEnv $ \env -> lookupNameEnv (global_datacons env) (dataConName dc)
405 defDataCon :: DataCon -> DataCon -> VM ()
406 defDataCon dc dc' = updGEnv $ \env ->
407 env { global_datacons = extendNameEnv (global_datacons env) (dataConName dc) dc' }
409 lookupTyConPA :: TyCon -> VM (Maybe Var)
410 lookupTyConPA tc = readGEnv $ \env -> lookupNameEnv (global_pa_funs env) (tyConName tc)
412 defTyConPA :: TyCon -> Var -> VM ()
413 defTyConPA tc pa = updGEnv $ \env ->
414 env { global_pa_funs = extendNameEnv (global_pa_funs env) (tyConName tc) pa }
416 lookupTyVarPA :: Var -> VM (Maybe CoreExpr)
417 lookupTyVarPA tv = readLEnv $ \env -> lookupVarEnv (local_tyvar_pa env) tv
419 defLocalTyVar :: TyVar -> VM ()
420 defLocalTyVar tv = updLEnv $ \env ->
421 env { local_tyvars = tv : local_tyvars env
422 , local_tyvar_pa = local_tyvar_pa env `delVarEnv` tv
425 defLocalTyVarWithPA :: TyVar -> CoreExpr -> VM ()
426 defLocalTyVarWithPA tv pa = updLEnv $ \env ->
427 env { local_tyvars = tv : local_tyvars env
428 , local_tyvar_pa = extendVarEnv (local_tyvar_pa env) tv pa
431 localTyVars :: VM [TyVar]
432 localTyVars = readLEnv (reverse . local_tyvars)
434 -- Look up the dfun of a class instance.
436 -- The match must be unique - ie, match exactly one instance - but the
437 -- type arguments used for matching may be more specific than those of
438 -- the class instance declaration. The found class instances must not have
439 -- any type variables in the instance context that do not appear in the
440 -- instances head (i.e., no flexi vars); for details for what this means,
441 -- see the docs at InstEnv.lookupInstEnv.
443 lookupInst :: Class -> [Type] -> VM (DFunId, [Type])
445 = do { instEnv <- getInstEnv
446 ; case lookupInstEnv instEnv cls tys of
447 ([(inst, inst_tys)], _)
448 | noFlexiVar -> return (instanceDFunId inst, inst_tys')
449 | otherwise -> pprPanic "VectMonad.lookupInst: flexi var: "
450 (ppr $ mkTyConApp (classTyCon cls) tys)
452 inst_tys' = [ty | Right ty <- inst_tys]
453 noFlexiVar = all isRight inst_tys
454 _other -> traceNoV "lookupInst" (ppr cls <+> ppr tys)
457 isRight (Left _) = False
458 isRight (Right _) = True
460 -- Look up the representation tycon of a family instance.
462 -- The match must be unique - ie, match exactly one instance - but the
463 -- type arguments used for matching may be more specific than those of
464 -- the family instance declaration.
466 -- Return the instance tycon and its type instance. For example, if we have
468 -- lookupFamInst 'T' '[Int]' yields (':R42T', 'Int')
470 -- then we have a coercion (ie, type instance of family instance coercion)
472 -- :Co:R42T Int :: T [Int] ~ :R42T Int
474 -- which implies that :R42T was declared as 'data instance T [a]'.
476 lookupFamInst :: TyCon -> [Type] -> VM (TyCon, [Type])
477 lookupFamInst tycon tys
478 = ASSERT( isOpenTyCon tycon )
479 do { instEnv <- getFamInstEnv
480 ; case lookupFamInstEnv instEnv tycon tys of
481 [(fam_inst, rep_tys)] -> return (famInstTyCon fam_inst, rep_tys)
483 pprPanic "VectMonad.lookupFamInst: not found: "
484 (ppr $ mkTyConApp tycon tys)
487 initV :: HscEnv -> ModGuts -> VectInfo -> VM a -> IO (Maybe (VectInfo, a))
488 initV hsc_env guts info p
490 eps <- hscEPS hsc_env
491 let famInstEnvs = (eps_fam_inst_env eps, mg_fam_inst_env guts)
492 let instEnvs = (eps_inst_env eps, mg_inst_env guts)
494 Just r <- initDs hsc_env (mg_module guts)
497 (go instEnvs famInstEnvs)
501 go instEnvs famInstEnvs =
503 builtins <- initBuiltins
504 r <- runVM p builtins (initGlobalEnv info
511 Yes genv _ x -> return $ Just (new_info genv, x)
514 new_info genv = updVectInfo genv (mg_types guts) info