1 module VectType ( vectTyCon, vectType, vectTypeEnv,
2 PAInstance, buildPADict )
5 #include "HsVersions.h"
11 import HscTypes ( TypeEnv, extendTypeEnvList, typeEnvTyCons )
20 import FamInstEnv ( FamInst, mkLocalFamInst )
21 import InstEnv ( Instance, mkLocalInstance, instanceDFunId )
24 import BasicTypes ( StrictnessMark(..), OverlapFlag(..), boolToRecFlag )
26 import Id ( mkWildId )
27 import Name ( Name, getOccName )
29 import TysWiredIn ( unitTy, intTy, intDataCon )
30 import TysPrim ( intPrimTy )
35 import Digraph ( SCC(..), stronglyConnComp )
39 import Control.Monad ( liftM, liftM2, zipWithM, zipWithM_ )
40 import Data.List ( inits, tails, zipWith4, zipWith5 )
42 -- ----------------------------------------------------------------------------
45 vectTyCon :: TyCon -> VM TyCon
47 | isFunTyCon tc = builtin closureTyCon
48 | isBoxedTupleTyCon tc = return tc
49 | isUnLiftedTyCon tc = return tc
53 Just tc' -> return tc'
55 -- FIXME: just for now
56 Nothing -> pprTrace "ccTyCon:" (ppr tc) $ return tc
58 vectType :: Type -> VM Type
59 vectType ty | Just ty' <- coreView ty = vectType ty'
60 vectType (TyVarTy tv) = return $ TyVarTy tv
61 vectType (AppTy ty1 ty2) = liftM2 AppTy (vectType ty1) (vectType ty2)
62 vectType (TyConApp tc tys) = liftM2 TyConApp (vectTyCon tc) (mapM vectType tys)
63 vectType (FunTy ty1 ty2) = liftM2 TyConApp (builtin closureTyCon)
64 (mapM vectType [ty1,ty2])
65 vectType ty@(ForAllTy _ _)
67 mdicts <- mapM paDictArgType tyvars
68 mono_ty' <- vectType mono_ty
69 return $ tyvars `mkForAllTys` ([dict | Just dict <- mdicts] `mkFunTys` mono_ty')
71 (tyvars, mono_ty) = splitForAllTys ty
73 vectType ty = pprPanic "vectType:" (ppr ty)
75 -- ----------------------------------------------------------------------------
78 type TyConGroup = ([TyCon], UniqSet TyCon)
80 data PAInstance = PAInstance {
82 , painstOrigTyCon :: TyCon
83 , painstVectTyCon :: TyCon
84 , painstArrTyCon :: TyCon
87 vectTypeEnv :: TypeEnv -> VM (TypeEnv, [FamInst], [(Var, CoreExpr)])
90 cs <- readGEnv $ mk_map . global_tycons
91 let (conv_tcs, keep_tcs) = classifyTyCons cs groups
92 keep_dcs = concatMap tyConDataCons keep_tcs
93 zipWithM_ defTyCon keep_tcs keep_tcs
94 zipWithM_ defDataCon keep_dcs keep_dcs
95 new_tcs <- vectTyConDecls conv_tcs
97 let orig_tcs = keep_tcs ++ conv_tcs
98 vect_tcs = keep_tcs ++ new_tcs
100 repr_tcs <- zipWithM buildPReprTyCon orig_tcs vect_tcs
101 parr_tcs <- zipWithM buildPArrayTyCon orig_tcs vect_tcs
102 dfuns <- mapM mkPADFun vect_tcs
103 defTyConPAs (zip vect_tcs dfuns)
104 binds <- sequence (zipWith5 buildTyConBindings orig_tcs
110 let all_new_tcs = new_tcs ++ repr_tcs ++ parr_tcs
112 let new_env = extendTypeEnvList env
113 (map ATyCon all_new_tcs
114 ++ [ADataCon dc | tc <- all_new_tcs
115 , dc <- tyConDataCons tc])
117 return (new_env, map mkLocalFamInst (repr_tcs ++ parr_tcs), concat binds)
119 tycons = typeEnvTyCons env
120 groups = tyConGroups tycons
122 mk_map env = listToUFM_Directly [(u, getUnique n /= u) | (u,n) <- nameEnvUniqueElts env]
124 keep_tc tc = let dcs = tyConDataCons tc
126 defTyCon tc tc >> zipWithM_ defDataCon dcs dcs
129 vectTyConDecls :: [TyCon] -> VM [TyCon]
130 vectTyConDecls tcs = fixV $ \tcs' ->
132 mapM_ (uncurry defTyCon) (lazy_zip tcs tcs')
133 mapM vectTyConDecl tcs
136 lazy_zip (x:xs) ~(y:ys) = (x,y) : lazy_zip xs ys
138 vectTyConDecl :: TyCon -> VM TyCon
141 name' <- cloneName mkVectTyConOcc name
142 rhs' <- vectAlgTyConRhs (algTyConRhs tc)
144 liftDs $ buildAlgTyCon name'
146 [] -- no stupid theta
148 rec_flag -- FIXME: is this ok?
149 False -- FIXME: no generics
150 False -- not GADT syntax
151 Nothing -- not a family instance
154 tyvars = tyConTyVars tc
155 rec_flag = boolToRecFlag (isRecursiveTyCon tc)
157 vectAlgTyConRhs :: AlgTyConRhs -> VM AlgTyConRhs
158 vectAlgTyConRhs (DataTyCon { data_cons = data_cons
162 data_cons' <- mapM vectDataCon data_cons
163 zipWithM_ defDataCon data_cons data_cons'
164 return $ DataTyCon { data_cons = data_cons'
168 vectDataCon :: DataCon -> VM DataCon
170 | not . null $ dataConExTyVars dc = pprPanic "vectDataCon: existentials" (ppr dc)
171 | not . null $ dataConEqSpec dc = pprPanic "vectDataCon: eq spec" (ppr dc)
174 name' <- cloneName mkVectDataConOcc name
175 tycon' <- vectTyCon tycon
176 arg_tys <- mapM vectType rep_arg_tys
178 liftDs $ buildDataCon name'
180 (map (const NotMarkedStrict) arg_tys)
181 [] -- no labelled fields
183 [] -- no existential tvs for now
184 [] -- no eq spec for now
189 name = dataConName dc
190 univ_tvs = dataConUnivTyVars dc
191 rep_arg_tys = dataConRepArgTys dc
192 tycon = dataConTyCon dc
194 mk_fam_inst :: TyCon -> TyCon -> (TyCon, [Type])
195 mk_fam_inst fam_tc arg_tc
196 = (fam_tc, [mkTyConApp arg_tc . mkTyVarTys $ tyConTyVars arg_tc])
198 buildPReprTyCon :: TyCon -> TyCon -> VM TyCon
199 buildPReprTyCon orig_tc vect_tc
201 name <- cloneName mkPReprTyConOcc (tyConName orig_tc)
202 rhs_ty <- buildPReprType vect_tc
203 prepr_tc <- builtin preprTyCon
204 liftDs $ buildSynTyCon name
206 (SynonymTyCon rhs_ty)
207 (Just $ mk_fam_inst prepr_tc vect_tc)
209 tyvars = tyConTyVars vect_tc
211 buildPReprType :: TyCon -> VM Type
212 buildPReprType = liftM repr_type . mkTyConRepr
214 buildToPRepr :: Shape -> TyCon -> TyCon -> TyCon -> VM CoreExpr
215 buildToPRepr _ vect_tc prepr_tc _
217 arg <- newLocalVar FSLIT("x") arg_ty
218 bndrss <- mapM (mapM (newLocalVar FSLIT("x"))) rep_tys
219 (alt_bodies, res_ty) <- mkToPRepr $ map (map Var) bndrss
222 . wrapFamInstBody prepr_tc var_tys
223 . Case (Var arg) (mkWildId arg_ty) res_ty
224 $ zipWith3 mk_alt data_cons bndrss alt_bodies
226 var_tys = mkTyVarTys $ tyConTyVars vect_tc
227 arg_ty = mkTyConApp vect_tc var_tys
228 data_cons = tyConDataCons vect_tc
229 rep_tys = map dataConRepArgTys data_cons
231 mk_alt data_con bndrs body = (DataAlt data_con, bndrs, body)
233 buildToArrPRepr :: Shape -> TyCon -> TyCon -> TyCon -> VM CoreExpr
234 buildToArrPRepr _ vect_tc prepr_tc arr_tc
236 arg_ty <- mkPArrayType el_ty
237 rep_tys <- mapM (mapM mkPArrayType) rep_el_tys
239 arg <- newLocalVar FSLIT("xs") arg_ty
240 bndrss <- mapM (mapM (newLocalVar FSLIT("ys"))) rep_tys
241 len <- newLocalVar FSLIT("len") intPrimTy
242 sel <- newLocalVar FSLIT("sel") =<< mkPArrayType intTy
244 let add_sel xs | has_selector = sel : xs
247 all_bndrs = len : add_sel (concat bndrss)
249 res <- parrayCoerce prepr_tc var_tys
250 =<< mkToArrPRepr (Var len) (Var sel) (map (map Var) bndrss)
251 res_ty <- mkPArrayType =<< mkPReprType el_ty
254 $ Case (unwrapFamInstScrut arr_tc var_tys (Var arg))
255 (mkWildId (mkTyConApp arr_tc var_tys))
257 [(DataAlt arr_dc, all_bndrs, res)]
259 var_tys = mkTyVarTys $ tyConTyVars vect_tc
260 el_ty = mkTyConApp vect_tc var_tys
261 data_cons = tyConDataCons vect_tc
262 rep_el_tys = map dataConRepArgTys data_cons
264 [arr_dc] = tyConDataCons arr_tc
266 has_selector | [_] <- data_cons = False
270 buildFromPRepr :: Shape -> TyCon -> TyCon -> TyCon -> VM CoreExpr
271 buildFromPRepr _ vect_tc prepr_tc _
273 arg_ty <- mkPReprType res_ty
274 arg <- newLocalVar FSLIT("x") arg_ty
275 alts <- mapM mk_alt data_cons
276 body <- mkFromPRepr (unwrapFamInstScrut prepr_tc var_tys (Var arg))
278 return $ Lam arg body
280 var_tys = mkTyVarTys $ tyConTyVars vect_tc
281 res_ty = mkTyConApp vect_tc var_tys
282 data_cons = tyConDataCons vect_tc
285 bndrs <- mapM (newLocalVar FSLIT("x")) $ dataConRepArgTys dc
286 return (bndrs, mkConApp dc (map Type var_tys ++ map Var bndrs))
288 buildFromArrPRepr :: Shape -> TyCon -> TyCon -> TyCon -> VM CoreExpr
289 buildFromArrPRepr _ vect_tc prepr_tc arr_tc
290 = mkFromArrPRepr undefined undefined undefined undefined undefined undefined
292 buildPRDict :: Shape -> TyCon -> TyCon -> TyCon -> VM CoreExpr
293 buildPRDict _ vect_tc prepr_tc _
294 = prCoerce prepr_tc var_tys
295 =<< prDictOfType (mkTyConApp prepr_tc var_tys)
297 var_tys = mkTyVarTys $ tyConTyVars vect_tc
299 buildPArrayTyCon :: TyCon -> TyCon -> VM TyCon
300 buildPArrayTyCon orig_tc vect_tc = fixV $ \repr_tc ->
302 name' <- cloneName mkPArrayTyConOcc orig_name
303 rhs <- buildPArrayTyConRhs orig_name vect_tc repr_tc
304 parray <- builtin parrayTyCon
306 liftDs $ buildAlgTyCon name'
308 [] -- no stupid theta
310 rec_flag -- FIXME: is this ok?
311 False -- FIXME: no generics
312 False -- not GADT syntax
313 (Just $ mk_fam_inst parray vect_tc)
315 orig_name = tyConName orig_tc
316 tyvars = tyConTyVars vect_tc
317 rec_flag = boolToRecFlag (isRecursiveTyCon vect_tc)
320 buildPArrayTyConRhs :: Name -> TyCon -> TyCon -> VM AlgTyConRhs
321 buildPArrayTyConRhs orig_name vect_tc repr_tc
323 data_con <- buildPArrayDataCon orig_name vect_tc repr_tc
324 return $ DataTyCon { data_cons = [data_con], is_enum = False }
326 buildPArrayDataCon :: Name -> TyCon -> TyCon -> VM DataCon
327 buildPArrayDataCon orig_name vect_tc repr_tc
329 dc_name <- cloneName mkPArrayDataConOcc orig_name
330 shape <- tyConShape vect_tc
331 repr_tys <- mapM mkPArrayType types
333 liftDs $ buildDataCon dc_name
335 (shapeStrictness shape ++ map (const NotMarkedStrict) repr_tys)
336 [] -- no field labels
337 (tyConTyVars vect_tc)
338 [] -- no existentials
341 (shapeReprTys shape ++ repr_tys)
344 types = [ty | dc <- tyConDataCons vect_tc
345 , ty <- dataConRepArgTys dc]
347 mkPADFun :: TyCon -> VM Var
349 = newExportedVar (mkPADFunOcc $ getOccName vect_tc) =<< paDFunType vect_tc
352 shapeReprTys :: [Type]
353 , shapeStrictness :: [StrictnessMark]
354 , shapeLength :: [CoreExpr] -> VM CoreExpr
355 , shapeReplicate :: CoreExpr -> CoreExpr -> VM [CoreExpr]
358 tyConShape :: TyCon -> VM Shape
360 | isProductTyCon vect_tc
362 shapeReprTys = [intPrimTy]
363 , shapeStrictness = [NotMarkedStrict]
364 , shapeLength = \[len] -> return len
365 , shapeReplicate = \len _ -> return [len]
370 repr_ty <- mkPArrayType intTy -- FIXME: we want to unbox this
372 shapeReprTys = [repr_ty]
373 , shapeStrictness = [MarkedStrict]
374 , shapeLength = \[sel] -> lengthPA sel
375 , shapeReplicate = \len n -> do
376 e <- replicatePA len n
380 buildTyConBindings :: TyCon -> TyCon -> TyCon -> TyCon -> Var
381 -> VM [(Var, CoreExpr)]
382 buildTyConBindings orig_tc vect_tc prepr_tc arr_tc dfun
384 shape <- tyConShape vect_tc
385 sequence_ (zipWith4 (vectDataConWorker shape vect_tc arr_tc arr_dc)
390 dict <- buildPADict shape vect_tc prepr_tc arr_tc dfun
392 return $ (dfun, dict) : binds
394 orig_dcs = tyConDataCons orig_tc
395 vect_dcs = tyConDataCons vect_tc
396 [arr_dc] = tyConDataCons arr_tc
398 repr_tys = map dataConRepArgTys vect_dcs
400 vectDataConWorker :: Shape -> TyCon -> TyCon -> DataCon
401 -> DataCon -> DataCon -> [[Type]] -> [[Type]]
403 vectDataConWorker shape vect_tc arr_tc arr_dc orig_dc vect_dc pre (dc_tys : post)
407 . polyAbstract tvs $ \abstract ->
408 liftM (abstract . vectorised)
409 $ buildClosures tvs [] dc_tys res_ty (liftM2 (,) mk_vect mk_lift)
411 worker <- cloneId mkVectOcc orig_worker (exprType clo)
412 hoistBinding worker clo
413 defGlobalVar orig_worker worker
416 tvs = tyConTyVars vect_tc
417 arg_tys = mkTyVarTys tvs
418 res_ty = mkTyConApp vect_tc arg_tys
420 orig_worker = dataConWorkId orig_dc
422 mk_vect = return . mkConApp vect_dc $ map Type arg_tys
424 len <- newLocalVar FSLIT("n") intPrimTy
425 arr_tys <- mapM mkPArrayType dc_tys
426 args <- mapM (newLocalVar FSLIT("xs")) arr_tys
427 shapes <- shapeReplicate shape
429 (mkDataConTag vect_dc)
431 empty_pre <- mapM emptyPA (concat pre)
432 empty_post <- mapM emptyPA (concat post)
434 return . mkLams (len : args)
435 . wrapFamInstBody arr_tc arg_tys
437 $ map Type arg_tys ++ shapes
442 buildPADict :: Shape -> TyCon -> TyCon -> TyCon -> Var -> VM CoreExpr
443 buildPADict shape vect_tc prepr_tc arr_tc dfun
444 = polyAbstract tvs $ \abstract ->
446 meth_binds <- mapM (mk_method shape) paMethods
447 let meth_exprs = map (Var . fst) meth_binds
449 pa_dc <- builtin paDataCon
450 let dict = mkConApp pa_dc (Type (mkTyConApp vect_tc arg_tys) : meth_exprs)
451 body = Let (Rec meth_binds) dict
452 return . mkInlineMe $ abstract body
454 tvs = tyConTyVars arr_tc
455 arg_tys = mkTyVarTys tvs
457 mk_method shape (name, build)
460 body <- build shape vect_tc prepr_tc arr_tc
461 var <- newLocalVar name (exprType body)
462 return (var, mkInlineMe body)
464 paMethods = [(FSLIT("toPRepr"), buildToPRepr),
465 (FSLIT("fromPRepr"), buildFromPRepr),
466 (FSLIT("toArrPRepr"), buildToArrPRepr),
467 (FSLIT("fromArrPRepr"), buildFromArrPRepr),
468 (FSLIT("dictPRepr"), buildPRDict)]
470 -- | Split the given tycons into two sets depending on whether they have to be
471 -- converted (first list) or not (second list). The first argument contains
472 -- information about the conversion status of external tycons:
474 -- * tycons which have converted versions are mapped to True
475 -- * tycons which are not changed by vectorisation are mapped to False
476 -- * tycons which can't be converted are not elements of the map
478 classifyTyCons :: UniqFM Bool -> [TyConGroup] -> ([TyCon], [TyCon])
479 classifyTyCons = classify [] []
481 classify conv keep cs [] = (conv, keep)
482 classify conv keep cs ((tcs, ds) : rs)
483 | can_convert && must_convert
484 = classify (tcs ++ conv) keep (cs `addListToUFM` [(tc,True) | tc <- tcs]) rs
486 = classify conv (tcs ++ keep) (cs `addListToUFM` [(tc,False) | tc <- tcs]) rs
488 = classify conv keep cs rs
490 refs = ds `delListFromUniqSet` tcs
492 can_convert = isNullUFM (refs `minusUFM` cs) && all convertable tcs
493 must_convert = foldUFM (||) False (intersectUFM_C const cs refs)
495 convertable tc = isDataTyCon tc && all isVanillaDataCon (tyConDataCons tc)
497 -- | Compute mutually recursive groups of tycons in topological order
499 tyConGroups :: [TyCon] -> [TyConGroup]
500 tyConGroups tcs = map mk_grp (stronglyConnComp edges)
502 edges = [((tc, ds), tc, uniqSetToList ds) | tc <- tcs
503 , let ds = tyConsOfTyCon tc]
505 mk_grp (AcyclicSCC (tc, ds)) = ([tc], ds)
506 mk_grp (CyclicSCC els) = (tcs, unionManyUniqSets dss)
508 (tcs, dss) = unzip els
510 tyConsOfTyCon :: TyCon -> UniqSet TyCon
512 = tyConsOfTypes . concatMap dataConRepArgTys . tyConDataCons
514 tyConsOfType :: Type -> UniqSet TyCon
516 | Just ty' <- coreView ty = tyConsOfType ty'
517 tyConsOfType (TyVarTy v) = emptyUniqSet
518 tyConsOfType (TyConApp tc tys) = extend (tyConsOfTypes tys)
520 extend | isUnLiftedTyCon tc
521 || isTupleTyCon tc = id
523 | otherwise = (`addOneToUniqSet` tc)
525 tyConsOfType (AppTy a b) = tyConsOfType a `unionUniqSets` tyConsOfType b
526 tyConsOfType (FunTy a b) = (tyConsOfType a `unionUniqSets` tyConsOfType b)
527 `addOneToUniqSet` funTyCon
528 tyConsOfType (ForAllTy _ ty) = tyConsOfType ty
529 tyConsOfType other = pprPanic "ClosureConv.tyConsOfType" $ ppr other
531 tyConsOfTypes :: [Type] -> UniqSet TyCon
532 tyConsOfTypes = unionManyUniqSets . map tyConsOfType