5 noV, traceNoV, ensureV, traceEnsureV, tryV, maybeV, traceMaybeV, orElseV,
6 onlyIfV, fixV, localV, closedV,
7 initV, cantVectorise, maybeCantVectorise, maybeCantVectoriseM,
9 cloneName, cloneId, cloneVar,
10 newExportedVar, newLocalVar, newDummyVar, newTyVar,
12 Builtins(..), sumTyCon, prodTyCon,
13 combinePAVar, scalarZip, closureCtrFun,
18 readGEnv, setGEnv, updGEnv,
21 readLEnv, setLEnv, updLEnv,
25 lookupVar, defGlobalVar, globalScalars,
26 lookupTyCon, defTyCon,
27 lookupDataCon, defDataCon,
28 lookupTyConPA, defTyConPA, defTyConPAs,
31 lookupPrimMethod, lookupPrimPArray,
32 lookupTyVarPA, defLocalTyVar, defLocalTyVarWithPA, localTyVars,
34 lookupInst, lookupFamInst
37 #include "HsVersions.h"
41 import HscTypes hiding ( MonadThings(..) )
42 import Module ( PackageId )
54 import IOEnv ( liftIO )
63 import SrcLoc ( noSrcSpan )
67 data Scope a b = Global a | Local b
69 -- ----------------------------------------------------------------------------
70 -- Vectorisation monad
72 data GlobalEnv = GlobalEnv {
73 -- Mapping from global variables to their vectorised versions.
75 global_vars :: VarEnv Var
77 -- Purely scalar variables. Code which mentions only these
78 -- variables doesn't have to be lifted.
79 , global_scalars :: VarSet
81 -- Exported variables which have a vectorised version
83 , global_exported_vars :: VarEnv (Var, Var)
85 -- Mapping from TyCons to their vectorised versions.
86 -- TyCons which do not have to be vectorised are mapped to
89 , global_tycons :: NameEnv TyCon
91 -- Mapping from DataCons to their vectorised versions
93 , global_datacons :: NameEnv DataCon
95 -- Mapping from TyCons to their PA dfuns
97 , global_pa_funs :: NameEnv Var
99 -- Mapping from TyCons to their PR dfuns
100 , global_pr_funs :: NameEnv Var
102 -- Mapping from unboxed TyCons to their boxed versions
103 , global_boxed_tycons :: NameEnv TyCon
105 -- External package inst-env & home-package inst-env for class
108 , global_inst_env :: (InstEnv, InstEnv)
110 -- External package inst-env & home-package inst-env for family
113 , global_fam_inst_env :: FamInstEnvs
116 , global_bindings :: [(Var, CoreExpr)]
119 data LocalEnv = LocalEnv {
120 -- Mapping from local variables to their vectorised and
123 local_vars :: VarEnv (Var, Var)
125 -- In-scope type variables
127 , local_tyvars :: [TyVar]
129 -- Mapping from tyvars to their PA dictionaries
130 , local_tyvar_pa :: VarEnv CoreExpr
132 -- Local binding name
133 , local_bind_name :: FastString
136 initGlobalEnv :: VectInfo -> (InstEnv, InstEnv) -> FamInstEnvs -> GlobalEnv
137 initGlobalEnv info instEnvs famInstEnvs
139 global_vars = mapVarEnv snd $ vectInfoVar info
140 , global_scalars = emptyVarSet
141 , global_exported_vars = emptyVarEnv
142 , global_tycons = mapNameEnv snd $ vectInfoTyCon info
143 , global_datacons = mapNameEnv snd $ vectInfoDataCon info
144 , global_pa_funs = mapNameEnv snd $ vectInfoPADFun info
145 , global_pr_funs = emptyNameEnv
146 , global_boxed_tycons = emptyNameEnv
147 , global_inst_env = instEnvs
148 , global_fam_inst_env = famInstEnvs
149 , global_bindings = []
152 extendImportedVarsEnv :: [(Var, Var)] -> GlobalEnv -> GlobalEnv
153 extendImportedVarsEnv ps genv
154 = genv { global_vars = extendVarEnvList (global_vars genv) ps }
156 extendScalars :: [Var] -> GlobalEnv -> GlobalEnv
157 extendScalars vs genv
158 = genv { global_scalars = extendVarSetList (global_scalars genv) vs }
160 setFamInstEnv :: FamInstEnv -> GlobalEnv -> GlobalEnv
161 setFamInstEnv l_fam_inst genv
162 = genv { global_fam_inst_env = (g_fam_inst, l_fam_inst) }
164 (g_fam_inst, _) = global_fam_inst_env genv
166 extendTyConsEnv :: [(Name, TyCon)] -> GlobalEnv -> GlobalEnv
167 extendTyConsEnv ps genv
168 = genv { global_tycons = extendNameEnvList (global_tycons genv) ps }
170 extendDataConsEnv :: [(Name, DataCon)] -> GlobalEnv -> GlobalEnv
171 extendDataConsEnv ps genv
172 = genv { global_datacons = extendNameEnvList (global_datacons genv) ps }
174 extendPAFunsEnv :: [(Name, Var)] -> GlobalEnv -> GlobalEnv
175 extendPAFunsEnv ps genv
176 = genv { global_pa_funs = extendNameEnvList (global_pa_funs genv) ps }
178 setPRFunsEnv :: [(Name, Var)] -> GlobalEnv -> GlobalEnv
180 = genv { global_pr_funs = mkNameEnv ps }
182 setBoxedTyConsEnv :: [(Name, TyCon)] -> GlobalEnv -> GlobalEnv
183 setBoxedTyConsEnv ps genv
184 = genv { global_boxed_tycons = mkNameEnv ps }
186 emptyLocalEnv :: LocalEnv
187 emptyLocalEnv = LocalEnv {
188 local_vars = emptyVarEnv
190 , local_tyvar_pa = emptyVarEnv
191 , local_bind_name = fsLit "fn"
195 updVectInfo :: GlobalEnv -> TypeEnv -> VectInfo -> VectInfo
196 updVectInfo env tyenv info
198 vectInfoVar = global_exported_vars env
199 , vectInfoTyCon = mk_env typeEnvTyCons global_tycons
200 , vectInfoDataCon = mk_env typeEnvDataCons global_datacons
201 , vectInfoPADFun = mk_env typeEnvTyCons global_pa_funs
204 mk_env from_tyenv from_env = mkNameEnv [(name, (from,to))
205 | from <- from_tyenv tyenv
206 , let name = getName from
207 , Just to <- [lookupNameEnv (from_env env) name]]
209 data VResult a = Yes GlobalEnv LocalEnv a | No
211 newtype VM a = VM { runVM :: Builtins -> GlobalEnv -> LocalEnv -> DsM (VResult a) }
213 instance Monad VM where
214 return x = VM $ \_ genv lenv -> return (Yes genv lenv x)
215 VM p >>= f = VM $ \bi genv lenv -> do
218 Yes genv' lenv' x -> runVM (f x) bi genv' lenv'
222 cantVectorise :: String -> SDoc -> a
223 cantVectorise s d = pgmError
225 $ vcat [text "*** Vectorisation error ***",
226 nest 4 $ sep [text s, nest 4 d]]
228 maybeCantVectorise :: String -> SDoc -> Maybe a -> a
229 maybeCantVectorise s d Nothing = cantVectorise s d
230 maybeCantVectorise _ _ (Just x) = x
232 maybeCantVectoriseM :: Monad m => String -> SDoc -> m (Maybe a) -> m a
233 maybeCantVectoriseM s d p
238 Nothing -> cantVectorise s d
241 noV = VM $ \_ _ _ -> return No
243 traceNoV :: String -> SDoc -> VM a
244 traceNoV s d = pprTrace s d noV
246 ensureV :: Bool -> VM ()
248 ensureV True = return ()
250 onlyIfV :: Bool -> VM a -> VM a
251 onlyIfV b p = ensureV b >> p
253 traceEnsureV :: String -> SDoc -> Bool -> VM ()
254 traceEnsureV s d False = traceNoV s d
255 traceEnsureV _ _ True = return ()
257 tryV :: VM a -> VM (Maybe a)
258 tryV (VM p) = VM $ \bi genv lenv ->
262 Yes genv' lenv' x -> return (Yes genv' lenv' (Just x))
263 No -> return (Yes genv lenv Nothing)
265 maybeV :: VM (Maybe a) -> VM a
266 maybeV p = maybe noV return =<< p
268 traceMaybeV :: String -> SDoc -> VM (Maybe a) -> VM a
269 traceMaybeV s d p = maybe (traceNoV s d) return =<< p
271 orElseV :: VM a -> VM a -> VM a
272 orElseV p q = maybe q return =<< tryV p
274 fixV :: (a -> VM a) -> VM a
275 fixV f = VM (\bi genv lenv -> fixDs $ \r -> runVM (f (unYes r)) bi genv lenv )
277 -- NOTE: It is essential that we are lazy in r above so do not replace
278 -- calls to this function by an explicit case.
279 unYes (Yes _ _ x) = x
280 unYes No = panic "VectMonad.fixV: no result"
282 localV :: VM a -> VM a
289 closedV :: VM a -> VM a
292 setLEnv (emptyLocalEnv { local_bind_name = local_bind_name env })
297 liftDs :: DsM a -> VM a
298 liftDs p = VM $ \_ genv lenv -> do { x <- p; return (Yes genv lenv x) }
300 liftBuiltinDs :: (Builtins -> DsM a) -> VM a
301 liftBuiltinDs p = VM $ \bi genv lenv -> do { x <- p bi; return (Yes genv lenv x)}
303 builtin :: (Builtins -> a) -> VM a
304 builtin f = VM $ \bi genv lenv -> return (Yes genv lenv (f bi))
306 builtins :: (a -> Builtins -> b) -> VM (a -> b)
307 builtins f = VM $ \bi genv lenv -> return (Yes genv lenv (`f` bi))
309 readGEnv :: (GlobalEnv -> a) -> VM a
310 readGEnv f = VM $ \_ genv lenv -> return (Yes genv lenv (f genv))
312 setGEnv :: GlobalEnv -> VM ()
313 setGEnv genv = VM $ \_ _ lenv -> return (Yes genv lenv ())
315 updGEnv :: (GlobalEnv -> GlobalEnv) -> VM ()
316 updGEnv f = VM $ \_ genv lenv -> return (Yes (f genv) lenv ())
318 readLEnv :: (LocalEnv -> a) -> VM a
319 readLEnv f = VM $ \_ genv lenv -> return (Yes genv lenv (f lenv))
321 setLEnv :: LocalEnv -> VM ()
322 setLEnv lenv = VM $ \_ genv _ -> return (Yes genv lenv ())
324 updLEnv :: (LocalEnv -> LocalEnv) -> VM ()
325 updLEnv f = VM $ \_ genv lenv -> return (Yes genv (f lenv) ())
327 getInstEnv :: VM (InstEnv, InstEnv)
328 getInstEnv = readGEnv global_inst_env
330 getFamInstEnv :: VM FamInstEnvs
331 getFamInstEnv = readGEnv global_fam_inst_env
333 getBindName :: VM FastString
334 getBindName = readLEnv local_bind_name
336 inBind :: Id -> VM a -> VM a
338 = do updLEnv $ \env -> env { local_bind_name = occNameFS (getOccName id) }
341 cloneName :: (OccName -> OccName) -> Name -> VM Name
342 cloneName mk_occ name = liftM make (liftDs newUnique)
344 occ_name = mk_occ (nameOccName name)
346 make u | isExternalName name = mkExternalName u (nameModule name)
349 | otherwise = mkSystemName u occ_name
351 cloneId :: (OccName -> OccName) -> Id -> Type -> VM Id
354 name <- cloneName mk_occ (getName id)
355 let id' | isExportedId id = Id.mkExportedLocalId name ty
356 | otherwise = Id.mkLocalId name ty
359 cloneVar :: Var -> VM Var
360 cloneVar var = liftM (setIdUnique var) (liftDs newUnique)
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 "vv")
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 . maybeCantVectoriseM "Variable not vectorised:" (ppr v)
404 . readGEnv $ \env -> lookupVarEnv (global_vars env) v
406 globalScalars :: VM VarSet
407 globalScalars = readGEnv global_scalars
409 lookupTyCon :: TyCon -> VM (Maybe TyCon)
411 | isUnLiftedTyCon tc || isTupleTyCon tc = return (Just tc)
413 | otherwise = readGEnv $ \env -> lookupNameEnv (global_tycons env) (tyConName tc)
415 defTyCon :: TyCon -> TyCon -> VM ()
416 defTyCon tc tc' = updGEnv $ \env ->
417 env { global_tycons = extendNameEnv (global_tycons env) (tyConName tc) tc' }
419 lookupDataCon :: DataCon -> VM (Maybe DataCon)
421 | isTupleTyCon (dataConTyCon dc) = return (Just dc)
422 | otherwise = readGEnv $ \env -> lookupNameEnv (global_datacons env) (dataConName dc)
424 defDataCon :: DataCon -> DataCon -> VM ()
425 defDataCon dc dc' = updGEnv $ \env ->
426 env { global_datacons = extendNameEnv (global_datacons env) (dataConName dc) dc' }
428 lookupPrimPArray :: TyCon -> VM (Maybe TyCon)
429 lookupPrimPArray = liftBuiltinDs . primPArray
431 lookupPrimMethod :: TyCon -> String -> VM (Maybe Var)
432 lookupPrimMethod tycon = liftBuiltinDs . primMethod tycon
434 lookupTyConPA :: TyCon -> VM (Maybe Var)
435 lookupTyConPA tc = readGEnv $ \env -> lookupNameEnv (global_pa_funs env) (tyConName tc)
437 defTyConPA :: TyCon -> Var -> VM ()
438 defTyConPA tc pa = updGEnv $ \env ->
439 env { global_pa_funs = extendNameEnv (global_pa_funs env) (tyConName tc) pa }
441 defTyConPAs :: [(TyCon, Var)] -> VM ()
442 defTyConPAs ps = updGEnv $ \env ->
443 env { global_pa_funs = extendNameEnvList (global_pa_funs env)
444 [(tyConName tc, pa) | (tc, pa) <- ps] }
446 lookupTyVarPA :: Var -> VM (Maybe CoreExpr)
447 lookupTyVarPA tv = readLEnv $ \env -> lookupVarEnv (local_tyvar_pa env) tv
449 lookupTyConPR :: TyCon -> VM (Maybe Var)
450 lookupTyConPR tc = readGEnv $ \env -> lookupNameEnv (global_pr_funs env) (tyConName tc)
452 lookupBoxedTyCon :: TyCon -> VM (Maybe TyCon)
453 lookupBoxedTyCon tc = readGEnv $ \env -> lookupNameEnv (global_boxed_tycons env)
456 defLocalTyVar :: TyVar -> VM ()
457 defLocalTyVar tv = updLEnv $ \env ->
458 env { local_tyvars = tv : local_tyvars env
459 , local_tyvar_pa = local_tyvar_pa env `delVarEnv` tv
462 defLocalTyVarWithPA :: TyVar -> CoreExpr -> VM ()
463 defLocalTyVarWithPA tv pa = updLEnv $ \env ->
464 env { local_tyvars = tv : local_tyvars env
465 , local_tyvar_pa = extendVarEnv (local_tyvar_pa env) tv pa
468 localTyVars :: VM [TyVar]
469 localTyVars = readLEnv (reverse . local_tyvars)
471 -- Look up the dfun of a class instance.
473 -- The match must be unique - ie, match exactly one instance - but the
474 -- type arguments used for matching may be more specific than those of
475 -- the class instance declaration. The found class instances must not have
476 -- any type variables in the instance context that do not appear in the
477 -- instances head (i.e., no flexi vars); for details for what this means,
478 -- see the docs at InstEnv.lookupInstEnv.
480 lookupInst :: Class -> [Type] -> VM (DFunId, [Type])
482 = do { instEnv <- getInstEnv
483 ; case lookupInstEnv instEnv cls tys of
484 ([(inst, inst_tys)], _)
485 | noFlexiVar -> return (instanceDFunId inst, inst_tys')
486 | otherwise -> pprPanic "VectMonad.lookupInst: flexi var: "
487 (ppr $ mkTyConApp (classTyCon cls) tys)
489 inst_tys' = [ty | Right ty <- inst_tys]
490 noFlexiVar = all isRight inst_tys
492 pprPanic "VectMonad.lookupInst: not found " (ppr cls <+> ppr tys)
495 isRight (Left _) = False
496 isRight (Right _) = True
498 -- Look up the representation tycon of a family instance.
500 -- The match must be unique - ie, match exactly one instance - but the
501 -- type arguments used for matching may be more specific than those of
502 -- the family instance declaration.
504 -- Return the instance tycon and its type instance. For example, if we have
506 -- lookupFamInst 'T' '[Int]' yields (':R42T', 'Int')
508 -- then we have a coercion (ie, type instance of family instance coercion)
510 -- :Co:R42T Int :: T [Int] ~ :R42T Int
512 -- which implies that :R42T was declared as 'data instance T [a]'.
514 lookupFamInst :: TyCon -> [Type] -> VM (TyCon, [Type])
515 lookupFamInst tycon tys
516 = ASSERT( isOpenTyCon tycon )
517 do { instEnv <- getFamInstEnv
518 ; case lookupFamInstEnv instEnv tycon tys of
519 [(fam_inst, rep_tys)] -> return (famInstTyCon fam_inst, rep_tys)
521 pprPanic "VectMonad.lookupFamInst: not found: "
522 (ppr $ mkTyConApp tycon tys)
525 initV :: PackageId -> HscEnv -> ModGuts -> VectInfo -> VM a -> IO (Maybe (VectInfo, a))
526 initV pkg hsc_env guts info p
528 -- XXX: ignores error messages and warnings, check that this is
529 -- indeed ok (the use of "Just r" suggests so)
530 (_,Just r) <- initDs hsc_env (mg_module guts)
539 builtins <- initBuiltins pkg
540 builtin_vars <- initBuiltinVars builtins
541 builtin_tycons <- initBuiltinTyCons builtins
542 let builtin_datacons = initBuiltinDataCons builtins
543 builtin_pas <- initBuiltinPAs builtins
544 builtin_prs <- initBuiltinPRs builtins
545 builtin_boxed <- initBuiltinBoxedTyCons builtins
546 builtin_scalars <- initBuiltinScalars builtins
548 eps <- liftIO $ hscEPS hsc_env
549 let famInstEnvs = (eps_fam_inst_env eps, mg_fam_inst_env guts)
550 instEnvs = (eps_inst_env eps, mg_inst_env guts)
552 let genv = extendImportedVarsEnv builtin_vars
553 . extendScalars builtin_scalars
554 . extendTyConsEnv builtin_tycons
555 . extendDataConsEnv builtin_datacons
556 . extendPAFunsEnv builtin_pas
557 . setPRFunsEnv builtin_prs
558 . setBoxedTyConsEnv builtin_boxed
559 $ initGlobalEnv info instEnvs famInstEnvs
561 r <- runVM p builtins genv emptyLocalEnv
563 Yes genv _ x -> return $ Just (new_info genv, x)
566 new_info genv = updVectInfo genv (mg_types guts) info