5 noV, tryV, maybeV, orElseV, fixV, localV, closedV, initV,
6 cloneName, newLocalVar, newTyVar,
8 Builtins(..), paDictTyCon, paDictDataCon,
13 readGEnv, setGEnv, updGEnv,
16 readLEnv, setLEnv, updLEnv,
18 lookupVar, defGlobalVar,
19 lookupTyCon, defTyCon,
20 lookupDataCon, defDataCon,
21 lookupTyVarPA, defLocalTyVar, defLocalTyVarWithPA, localTyVars,
23 lookupInst, lookupFamInst
26 #include "HsVersions.h"
51 import Control.Monad ( liftM )
53 data Scope a b = Global a | Local b
55 -- ----------------------------------------------------------------------------
56 -- Vectorisation monad
58 data Builtins = Builtins {
61 , closureTyCon :: TyCon
63 , applyClosureVar :: Var
64 , mkClosurePVar :: Var
65 , applyClosurePVar :: Var
67 , replicatePAVar :: Var
71 paDictTyCon :: Builtins -> TyCon
72 paDictTyCon = classTyCon . paClass
74 paDictDataCon :: Builtins -> DataCon
75 paDictDataCon = classDataCon . paClass
77 initBuiltins :: DsM Builtins
80 parrayTyCon <- dsLookupTyCon parrayTyConName
81 paClass <- dsLookupClass paClassName
82 closureTyCon <- dsLookupTyCon closureTyConName
84 mkClosureVar <- dsLookupGlobalId mkClosureName
85 applyClosureVar <- dsLookupGlobalId applyClosureName
86 mkClosurePVar <- dsLookupGlobalId mkClosurePName
87 applyClosurePVar <- dsLookupGlobalId applyClosurePName
88 lengthPAVar <- dsLookupGlobalId lengthPAName
89 replicatePAVar <- dsLookupGlobalId replicatePAName
90 emptyPAVar <- dsLookupGlobalId emptyPAName
93 parrayTyCon = parrayTyCon
95 , closureTyCon = closureTyCon
96 , mkClosureVar = mkClosureVar
97 , applyClosureVar = applyClosureVar
98 , mkClosurePVar = mkClosurePVar
99 , applyClosurePVar = applyClosurePVar
100 , lengthPAVar = lengthPAVar
101 , replicatePAVar = replicatePAVar
102 , emptyPAVar = emptyPAVar
105 data GlobalEnv = GlobalEnv {
106 -- Mapping from global variables to their vectorised versions.
108 global_vars :: VarEnv CoreExpr
110 -- Exported variables which have a vectorised version
112 , global_exported_vars :: VarEnv (Var, Var)
114 -- Mapping from TyCons to their vectorised versions.
115 -- TyCons which do not have to be vectorised are mapped to
118 , global_tycons :: NameEnv TyCon
120 -- Mapping from DataCons to their vectorised versions
122 , global_datacons :: NameEnv DataCon
124 -- External package inst-env & home-package inst-env for class
127 , global_inst_env :: (InstEnv, InstEnv)
129 -- External package inst-env & home-package inst-env for family
132 , global_fam_inst_env :: FamInstEnvs
135 , global_bindings :: [(Var, CoreExpr)]
138 data LocalEnv = LocalEnv {
139 -- Mapping from local variables to their vectorised and
142 local_vars :: VarEnv (CoreExpr, CoreExpr)
144 -- In-scope type variables
146 , local_tyvars :: [TyVar]
148 -- Mapping from tyvars to their PA dictionaries
149 , local_tyvar_pa :: VarEnv CoreExpr
153 initGlobalEnv :: VectInfo -> (InstEnv, InstEnv) -> FamInstEnvs -> Builtins -> GlobalEnv
154 initGlobalEnv info instEnvs famInstEnvs bi
156 global_vars = mapVarEnv (Var . snd) $ vectInfoVar info
157 , global_exported_vars = emptyVarEnv
158 , global_tycons = extendNameEnv (mapNameEnv snd (vectInfoTyCon info))
159 (tyConName funTyCon) (closureTyCon bi)
161 , global_datacons = mapNameEnv snd $ vectInfoDataCon info
162 , global_inst_env = instEnvs
163 , global_fam_inst_env = famInstEnvs
164 , global_bindings = []
167 setInstEnvs :: InstEnv -> FamInstEnv -> GlobalEnv -> GlobalEnv
168 setInstEnvs l_inst l_fam_inst genv
169 | (g_inst, _) <- global_inst_env genv
170 , (g_fam_inst, _) <- global_fam_inst_env genv
171 = genv { global_inst_env = (g_inst, l_inst)
172 , global_fam_inst_env = (g_fam_inst, l_fam_inst) }
174 emptyLocalEnv = LocalEnv {
175 local_vars = emptyVarEnv
177 , local_tyvar_pa = emptyVarEnv
181 updVectInfo :: GlobalEnv -> TypeEnv -> VectInfo -> VectInfo
182 updVectInfo env tyenv info
184 vectInfoVar = global_exported_vars env
185 , vectInfoTyCon = mk_env typeEnvTyCons global_tycons
186 , vectInfoDataCon = mk_env typeEnvDataCons global_datacons
189 mk_env from_tyenv from_env = mkNameEnv [(name, (from,to))
190 | from <- from_tyenv tyenv
191 , let name = getName from
192 , Just to <- [lookupNameEnv (from_env env) name]]
194 data VResult a = Yes GlobalEnv LocalEnv a | No
196 newtype VM a = VM { runVM :: Builtins -> GlobalEnv -> LocalEnv -> DsM (VResult a) }
198 instance Monad VM where
199 return x = VM $ \bi genv lenv -> return (Yes genv lenv x)
200 VM p >>= f = VM $ \bi genv lenv -> do
203 Yes genv' lenv' x -> runVM (f x) bi genv' lenv'
207 noV = VM $ \_ _ _ -> return No
209 tryV :: VM a -> VM (Maybe a)
210 tryV (VM p) = VM $ \bi genv lenv ->
214 Yes genv' lenv' x -> return (Yes genv' lenv' (Just x))
215 No -> return (Yes genv lenv Nothing)
217 maybeV :: VM (Maybe a) -> VM a
218 maybeV p = maybe noV return =<< p
220 orElseV :: VM a -> VM a -> VM a
221 orElseV p q = maybe q return =<< tryV p
223 fixV :: (a -> VM a) -> VM a
224 fixV f = VM (\bi genv lenv -> fixDs $ \r -> runVM (f (unYes r)) bi genv lenv )
226 unYes (Yes _ _ x) = x
228 localV :: VM a -> VM a
235 closedV :: VM a -> VM a
238 setLEnv emptyLocalEnv
243 liftDs :: DsM a -> VM a
244 liftDs p = VM $ \bi genv lenv -> do { x <- p; return (Yes genv lenv x) }
246 builtin :: (Builtins -> a) -> VM a
247 builtin f = VM $ \bi genv lenv -> return (Yes genv lenv (f bi))
249 readGEnv :: (GlobalEnv -> a) -> VM a
250 readGEnv f = VM $ \bi genv lenv -> return (Yes genv lenv (f genv))
252 setGEnv :: GlobalEnv -> VM ()
253 setGEnv genv = VM $ \_ _ lenv -> return (Yes genv lenv ())
255 updGEnv :: (GlobalEnv -> GlobalEnv) -> VM ()
256 updGEnv f = VM $ \_ genv lenv -> return (Yes (f genv) lenv ())
258 readLEnv :: (LocalEnv -> a) -> VM a
259 readLEnv f = VM $ \bi genv lenv -> return (Yes genv lenv (f lenv))
261 setLEnv :: LocalEnv -> VM ()
262 setLEnv lenv = VM $ \_ genv _ -> return (Yes genv lenv ())
264 updLEnv :: (LocalEnv -> LocalEnv) -> VM ()
265 updLEnv f = VM $ \_ genv lenv -> return (Yes genv (f lenv) ())
267 getInstEnv :: VM (InstEnv, InstEnv)
268 getInstEnv = readGEnv global_inst_env
270 getFamInstEnv :: VM FamInstEnvs
271 getFamInstEnv = readGEnv global_fam_inst_env
273 cloneName :: (OccName -> OccName) -> Name -> VM Name
274 cloneName mk_occ name = liftM make (liftDs newUnique)
276 occ_name = mk_occ (nameOccName name)
278 make u | isExternalName name = mkExternalName u (nameModule name)
281 | otherwise = mkSystemName u occ_name
283 newLocalVar :: FastString -> Type -> VM Var
286 u <- liftDs newUnique
287 return $ mkSysLocal fs u ty
289 newTyVar :: FastString -> Kind -> VM Var
292 u <- liftDs newUnique
293 return $ mkTyVar (mkSysTvName u fs) k
295 defGlobalVar :: Var -> Var -> VM ()
296 defGlobalVar v v' = updGEnv $ \env ->
297 env { global_vars = extendVarEnv (global_vars env) v (Var v')
298 , global_exported_vars = upd (global_exported_vars env)
301 upd env | isExportedId v = extendVarEnv env v (v, v')
304 lookupVar :: Var -> VM (Scope CoreExpr (CoreExpr, CoreExpr))
307 r <- readLEnv $ \env -> lookupVarEnv (local_vars env) v
309 Just e -> return (Local e)
310 Nothing -> liftM Global
311 $ maybeV (readGEnv $ \env -> lookupVarEnv (global_vars env) v)
313 lookupTyCon :: TyCon -> VM (Maybe TyCon)
315 | isUnLiftedTyCon tc || isTupleTyCon tc = return (Just tc)
317 | otherwise = readGEnv $ \env -> lookupNameEnv (global_tycons env) (tyConName tc)
319 defTyCon :: TyCon -> TyCon -> VM ()
320 defTyCon tc tc' = updGEnv $ \env ->
321 env { global_tycons = extendNameEnv (global_tycons env) (tyConName tc) tc' }
323 lookupDataCon :: DataCon -> VM (Maybe DataCon)
324 lookupDataCon dc = readGEnv $ \env -> lookupNameEnv (global_datacons env) (dataConName dc)
326 defDataCon :: DataCon -> DataCon -> VM ()
327 defDataCon dc dc' = updGEnv $ \env ->
328 env { global_datacons = extendNameEnv (global_datacons env) (dataConName dc) dc' }
330 lookupTyVarPA :: Var -> VM (Maybe CoreExpr)
331 lookupTyVarPA tv = readLEnv $ \env -> lookupVarEnv (local_tyvar_pa env) tv
333 defLocalTyVar :: TyVar -> VM ()
334 defLocalTyVar tv = updLEnv $ \env ->
335 env { local_tyvars = tv : local_tyvars env
336 , local_tyvar_pa = local_tyvar_pa env `delVarEnv` tv
339 defLocalTyVarWithPA :: TyVar -> CoreExpr -> VM ()
340 defLocalTyVarWithPA tv pa = updLEnv $ \env ->
341 env { local_tyvars = tv : local_tyvars env
342 , local_tyvar_pa = extendVarEnv (local_tyvar_pa env) tv pa
345 localTyVars :: VM [TyVar]
346 localTyVars = readLEnv (reverse . local_tyvars)
348 -- Look up the dfun of a class instance.
350 -- The match must be unique - ie, match exactly one instance - but the
351 -- type arguments used for matching may be more specific than those of
352 -- the class instance declaration. The found class instances must not have
353 -- any type variables in the instance context that do not appear in the
354 -- instances head (i.e., no flexi vars); for details for what this means,
355 -- see the docs at InstEnv.lookupInstEnv.
357 lookupInst :: Class -> [Type] -> VM (DFunId, [Type])
359 = do { instEnv <- getInstEnv
360 ; case lookupInstEnv instEnv cls tys of
361 ([(inst, inst_tys)], _)
362 | noFlexiVar -> return (instanceDFunId inst, inst_tys')
363 | otherwise -> pprPanic "VectMonad.lookupInst: flexi var: "
364 (ppr $ mkTyConApp (classTyCon cls) tys)
366 inst_tys' = [ty | Right ty <- inst_tys]
367 noFlexiVar = all isRight inst_tys
371 isRight (Left _) = False
372 isRight (Right _) = True
374 -- Look up the representation tycon of a family instance.
376 -- The match must be unique - ie, match exactly one instance - but the
377 -- type arguments used for matching may be more specific than those of
378 -- the family instance declaration.
380 -- Return the instance tycon and its type instance. For example, if we have
382 -- lookupFamInst 'T' '[Int]' yields (':R42T', 'Int')
384 -- then we have a coercion (ie, type instance of family instance coercion)
386 -- :Co:R42T Int :: T [Int] ~ :R42T Int
388 -- which implies that :R42T was declared as 'data instance T [a]'.
390 lookupFamInst :: TyCon -> [Type] -> VM (TyCon, [Type])
391 lookupFamInst tycon tys
392 = ASSERT( isOpenTyCon tycon )
393 do { instEnv <- getFamInstEnv
394 ; case lookupFamInstEnv instEnv tycon tys of
395 [(fam_inst, rep_tys)] -> return (famInstTyCon fam_inst, rep_tys)
397 pprPanic "VectMonad.lookupFamInst: not found: "
398 (ppr $ mkTyConApp tycon tys)
401 initV :: HscEnv -> ModGuts -> VectInfo -> VM a -> IO (Maybe (VectInfo, a))
402 initV hsc_env guts info p
404 eps <- hscEPS hsc_env
405 let famInstEnvs = (eps_fam_inst_env eps, mg_fam_inst_env guts)
406 let instEnvs = (eps_inst_env eps, mg_inst_env guts)
408 Just r <- initDs hsc_env (mg_module guts)
411 (go instEnvs famInstEnvs)
415 go instEnvs famInstEnvs =
417 builtins <- initBuiltins
418 r <- runVM p builtins (initGlobalEnv info instEnvs famInstEnvs builtins)
421 Yes genv _ x -> return $ Just (new_info genv, x)
424 new_info genv = updVectInfo genv (mg_types guts) info