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 lookupTyVarPA, defLocalTyVar, defLocalTyVarWithPA, localTyVars,
26 lookupInst, lookupFamInst
29 #include "HsVersions.h"
43 import TysPrim ( intPrimTy )
54 import SrcLoc ( noSrcSpan )
56 import Control.Monad ( liftM )
58 data Scope a b = Global a | Local b
60 -- ----------------------------------------------------------------------------
61 -- Vectorisation monad
63 data Builtins = Builtins {
66 , closureTyCon :: TyCon
68 , applyClosureVar :: Var
69 , mkClosurePVar :: Var
70 , applyClosurePVar :: Var
72 , replicatePAVar :: Var
74 , liftingContext :: Var
77 paDictTyCon :: Builtins -> TyCon
78 paDictTyCon = classTyCon . paClass
80 paDictDataCon :: Builtins -> DataCon
81 paDictDataCon = classDataCon . paClass
83 initBuiltins :: DsM Builtins
86 parrayTyCon <- dsLookupTyCon parrayTyConName
87 paClass <- dsLookupClass paClassName
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
98 liftingContext <- liftM (\u -> mkSysLocal FSLIT("lc") u intPrimTy)
102 parrayTyCon = parrayTyCon
104 , closureTyCon = closureTyCon
105 , mkClosureVar = mkClosureVar
106 , applyClosureVar = applyClosureVar
107 , mkClosurePVar = mkClosurePVar
108 , applyClosurePVar = applyClosurePVar
109 , lengthPAVar = lengthPAVar
110 , replicatePAVar = replicatePAVar
111 , emptyPAVar = emptyPAVar
112 , liftingContext = liftingContext
115 data GlobalEnv = GlobalEnv {
116 -- Mapping from global variables to their vectorised versions.
118 global_vars :: VarEnv Var
120 -- Exported variables which have a vectorised version
122 , global_exported_vars :: VarEnv (Var, Var)
124 -- Mapping from TyCons to their vectorised versions.
125 -- TyCons which do not have to be vectorised are mapped to
128 , global_tycons :: NameEnv TyCon
130 -- Mapping from DataCons to their vectorised versions
132 , global_datacons :: NameEnv DataCon
134 -- Mapping from TyCons to their PA dfuns
136 , global_pa_funs :: NameEnv Var
138 -- External package inst-env & home-package inst-env for class
141 , global_inst_env :: (InstEnv, InstEnv)
143 -- External package inst-env & home-package inst-env for family
146 , global_fam_inst_env :: FamInstEnvs
149 , global_bindings :: [(Var, CoreExpr)]
152 data LocalEnv = LocalEnv {
153 -- Mapping from local variables to their vectorised and
156 local_vars :: VarEnv (Var, Var)
158 -- In-scope type variables
160 , local_tyvars :: [TyVar]
162 -- Mapping from tyvars to their PA dictionaries
163 , local_tyvar_pa :: VarEnv CoreExpr
165 -- Local binding name
166 , local_bind_name :: FastString
170 initGlobalEnv :: VectInfo -> (InstEnv, InstEnv) -> FamInstEnvs -> Builtins -> GlobalEnv
171 initGlobalEnv info instEnvs famInstEnvs bi
173 global_vars = mapVarEnv snd $ vectInfoVar info
174 , global_exported_vars = emptyVarEnv
175 , global_tycons = extendNameEnv (mapNameEnv snd (vectInfoTyCon info))
176 (tyConName funTyCon) (closureTyCon bi)
178 , global_datacons = mapNameEnv snd $ vectInfoDataCon info
179 , global_pa_funs = mapNameEnv snd $ vectInfoPADFun info
180 , global_inst_env = instEnvs
181 , global_fam_inst_env = famInstEnvs
182 , global_bindings = []
185 setInstEnvs :: InstEnv -> FamInstEnv -> GlobalEnv -> GlobalEnv
186 setInstEnvs l_inst l_fam_inst genv
187 | (g_inst, _) <- global_inst_env genv
188 , (g_fam_inst, _) <- global_fam_inst_env genv
189 = genv { global_inst_env = (g_inst, l_inst)
190 , global_fam_inst_env = (g_fam_inst, l_fam_inst) }
192 emptyLocalEnv = LocalEnv {
193 local_vars = emptyVarEnv
195 , local_tyvar_pa = emptyVarEnv
196 , local_bind_name = FSLIT("fn")
200 updVectInfo :: GlobalEnv -> TypeEnv -> VectInfo -> VectInfo
201 updVectInfo env tyenv info
203 vectInfoVar = global_exported_vars env
204 , vectInfoTyCon = mk_env typeEnvTyCons global_tycons
205 , vectInfoDataCon = mk_env typeEnvDataCons global_datacons
206 , vectInfoPADFun = mk_env typeEnvTyCons global_pa_funs
209 mk_env from_tyenv from_env = mkNameEnv [(name, (from,to))
210 | from <- from_tyenv tyenv
211 , let name = getName from
212 , Just to <- [lookupNameEnv (from_env env) name]]
214 data VResult a = Yes GlobalEnv LocalEnv a | No
216 newtype VM a = VM { runVM :: Builtins -> GlobalEnv -> LocalEnv -> DsM (VResult a) }
218 instance Monad VM where
219 return x = VM $ \bi genv lenv -> return (Yes genv lenv x)
220 VM p >>= f = VM $ \bi genv lenv -> do
223 Yes genv' lenv' x -> runVM (f x) bi genv' lenv'
227 noV = VM $ \_ _ _ -> return No
229 traceNoV :: String -> SDoc -> VM a
230 traceNoV s d = pprTrace s d noV
232 tryV :: VM a -> VM (Maybe a)
233 tryV (VM p) = VM $ \bi genv lenv ->
237 Yes genv' lenv' x -> return (Yes genv' lenv' (Just x))
238 No -> return (Yes genv lenv Nothing)
240 maybeV :: VM (Maybe a) -> VM a
241 maybeV p = maybe noV return =<< p
243 traceMaybeV :: String -> SDoc -> VM (Maybe a) -> VM a
244 traceMaybeV s d p = maybe (traceNoV s d) return =<< p
246 orElseV :: VM a -> VM a -> VM a
247 orElseV p q = maybe q return =<< tryV p
249 fixV :: (a -> VM a) -> VM a
250 fixV f = VM (\bi genv lenv -> fixDs $ \r -> runVM (f (unYes r)) bi genv lenv )
252 unYes (Yes _ _ x) = x
254 localV :: VM a -> VM a
261 closedV :: VM a -> VM a
264 setLEnv (emptyLocalEnv { local_bind_name = local_bind_name env })
269 liftDs :: DsM a -> VM a
270 liftDs p = VM $ \bi genv lenv -> do { x <- p; return (Yes genv lenv x) }
272 builtin :: (Builtins -> a) -> VM a
273 builtin f = VM $ \bi genv lenv -> return (Yes genv lenv (f bi))
275 readGEnv :: (GlobalEnv -> a) -> VM a
276 readGEnv f = VM $ \bi genv lenv -> return (Yes genv lenv (f genv))
278 setGEnv :: GlobalEnv -> VM ()
279 setGEnv genv = VM $ \_ _ lenv -> return (Yes genv lenv ())
281 updGEnv :: (GlobalEnv -> GlobalEnv) -> VM ()
282 updGEnv f = VM $ \_ genv lenv -> return (Yes (f genv) lenv ())
284 readLEnv :: (LocalEnv -> a) -> VM a
285 readLEnv f = VM $ \bi genv lenv -> return (Yes genv lenv (f lenv))
287 setLEnv :: LocalEnv -> VM ()
288 setLEnv lenv = VM $ \_ genv _ -> return (Yes genv lenv ())
290 updLEnv :: (LocalEnv -> LocalEnv) -> VM ()
291 updLEnv f = VM $ \_ genv lenv -> return (Yes genv (f lenv) ())
293 getInstEnv :: VM (InstEnv, InstEnv)
294 getInstEnv = readGEnv global_inst_env
296 getFamInstEnv :: VM FamInstEnvs
297 getFamInstEnv = readGEnv global_fam_inst_env
299 getBindName :: VM FastString
300 getBindName = readLEnv local_bind_name
302 inBind :: Id -> VM a -> VM a
304 = do updLEnv $ \env -> env { local_bind_name = occNameFS (getOccName id) }
307 cloneName :: (OccName -> OccName) -> Name -> VM Name
308 cloneName mk_occ name = liftM make (liftDs newUnique)
310 occ_name = mk_occ (nameOccName name)
312 make u | isExternalName name = mkExternalName u (nameModule name)
315 | otherwise = mkSystemName u occ_name
317 cloneId :: (OccName -> OccName) -> Id -> Type -> VM Id
320 name <- cloneName mk_occ (getName id)
321 let id' | isExportedId id = Id.mkExportedLocalId name ty
322 | otherwise = Id.mkLocalId name ty
325 newExportedVar :: OccName -> Type -> VM Var
326 newExportedVar occ_name ty
328 mod <- liftDs getModuleDs
329 u <- liftDs newUnique
331 let name = mkExternalName u mod occ_name noSrcSpan
333 return $ Id.mkExportedLocalId name ty
335 newLocalVar :: FastString -> Type -> VM Var
338 u <- liftDs newUnique
339 return $ mkSysLocal fs u ty
341 newDummyVar :: Type -> VM Var
342 newDummyVar = newLocalVar FSLIT("ds")
344 newTyVar :: FastString -> Kind -> VM Var
347 u <- liftDs newUnique
348 return $ mkTyVar (mkSysTvName u fs) k
350 defGlobalVar :: Var -> Var -> VM ()
351 defGlobalVar v v' = updGEnv $ \env ->
352 env { global_vars = extendVarEnv (global_vars env) v v'
353 , global_exported_vars = upd (global_exported_vars env)
356 upd env | isExportedId v = extendVarEnv env v (v, v')
359 lookupVar :: Var -> VM (Scope Var (Var, Var))
362 r <- readLEnv $ \env -> lookupVarEnv (local_vars env) v
364 Just e -> return (Local e)
365 Nothing -> liftM Global
366 $ traceMaybeV "lookupVar" (ppr v)
367 (readGEnv $ \env -> lookupVarEnv (global_vars env) v)
369 lookupTyCon :: TyCon -> VM (Maybe TyCon)
371 | isUnLiftedTyCon tc || isTupleTyCon tc = return (Just tc)
373 | otherwise = readGEnv $ \env -> lookupNameEnv (global_tycons env) (tyConName tc)
375 defTyCon :: TyCon -> TyCon -> VM ()
376 defTyCon tc tc' = updGEnv $ \env ->
377 env { global_tycons = extendNameEnv (global_tycons env) (tyConName tc) tc' }
379 lookupDataCon :: DataCon -> VM (Maybe DataCon)
380 lookupDataCon dc = readGEnv $ \env -> lookupNameEnv (global_datacons env) (dataConName dc)
382 defDataCon :: DataCon -> DataCon -> VM ()
383 defDataCon dc dc' = updGEnv $ \env ->
384 env { global_datacons = extendNameEnv (global_datacons env) (dataConName dc) dc' }
386 lookupTyVarPA :: Var -> VM (Maybe CoreExpr)
387 lookupTyVarPA tv = readLEnv $ \env -> lookupVarEnv (local_tyvar_pa env) tv
389 defLocalTyVar :: TyVar -> VM ()
390 defLocalTyVar tv = updLEnv $ \env ->
391 env { local_tyvars = tv : local_tyvars env
392 , local_tyvar_pa = local_tyvar_pa env `delVarEnv` tv
395 defLocalTyVarWithPA :: TyVar -> CoreExpr -> VM ()
396 defLocalTyVarWithPA tv pa = updLEnv $ \env ->
397 env { local_tyvars = tv : local_tyvars env
398 , local_tyvar_pa = extendVarEnv (local_tyvar_pa env) tv pa
401 localTyVars :: VM [TyVar]
402 localTyVars = readLEnv (reverse . local_tyvars)
404 -- Look up the dfun of a class instance.
406 -- The match must be unique - ie, match exactly one instance - but the
407 -- type arguments used for matching may be more specific than those of
408 -- the class instance declaration. The found class instances must not have
409 -- any type variables in the instance context that do not appear in the
410 -- instances head (i.e., no flexi vars); for details for what this means,
411 -- see the docs at InstEnv.lookupInstEnv.
413 lookupInst :: Class -> [Type] -> VM (DFunId, [Type])
415 = do { instEnv <- getInstEnv
416 ; case lookupInstEnv instEnv cls tys of
417 ([(inst, inst_tys)], _)
418 | noFlexiVar -> return (instanceDFunId inst, inst_tys')
419 | otherwise -> pprPanic "VectMonad.lookupInst: flexi var: "
420 (ppr $ mkTyConApp (classTyCon cls) tys)
422 inst_tys' = [ty | Right ty <- inst_tys]
423 noFlexiVar = all isRight inst_tys
424 _other -> traceNoV "lookupInst" (ppr cls <+> ppr tys)
427 isRight (Left _) = False
428 isRight (Right _) = True
430 -- Look up the representation tycon of a family instance.
432 -- The match must be unique - ie, match exactly one instance - but the
433 -- type arguments used for matching may be more specific than those of
434 -- the family instance declaration.
436 -- Return the instance tycon and its type instance. For example, if we have
438 -- lookupFamInst 'T' '[Int]' yields (':R42T', 'Int')
440 -- then we have a coercion (ie, type instance of family instance coercion)
442 -- :Co:R42T Int :: T [Int] ~ :R42T Int
444 -- which implies that :R42T was declared as 'data instance T [a]'.
446 lookupFamInst :: TyCon -> [Type] -> VM (TyCon, [Type])
447 lookupFamInst tycon tys
448 = ASSERT( isOpenTyCon tycon )
449 do { instEnv <- getFamInstEnv
450 ; case lookupFamInstEnv instEnv tycon tys of
451 [(fam_inst, rep_tys)] -> return (famInstTyCon fam_inst, rep_tys)
453 pprPanic "VectMonad.lookupFamInst: not found: "
454 (ppr $ mkTyConApp tycon tys)
457 initV :: HscEnv -> ModGuts -> VectInfo -> VM a -> IO (Maybe (VectInfo, a))
458 initV hsc_env guts info p
460 eps <- hscEPS hsc_env
461 let famInstEnvs = (eps_fam_inst_env eps, mg_fam_inst_env guts)
462 let instEnvs = (eps_inst_env eps, mg_inst_env guts)
464 Just r <- initDs hsc_env (mg_module guts)
467 (go instEnvs famInstEnvs)
471 go instEnvs famInstEnvs =
473 builtins <- initBuiltins
474 r <- runVM p builtins (initGlobalEnv info instEnvs famInstEnvs builtins)
477 Yes genv _ x -> return $ Just (new_info genv, x)
480 new_info genv = updVectInfo genv (mg_types guts) info