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, unitTyCon, intTy, intDataCon, unitDataConId )
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 :: TyConRepr -> TyCon -> TyCon -> TyCon -> VM CoreExpr
215 buildToPRepr (TyConRepr {
217 , repr_prod_data_cons = prod_data_cons
218 , repr_prod_tys = prod_tys
219 , repr_sum_data_cons = sum_data_cons
220 , repr_type = repr_type
224 arg <- newLocalVar FSLIT("x") arg_ty
225 vars <- mapM (mapM (newLocalVar FSLIT("x"))) repr_tys
228 . wrapFamInstBody prepr_tc var_tys
229 . Case (Var arg) (mkWildId arg_ty) repr_type
230 . mk_alts data_cons vars
231 . zipWith3 mk_prod prod_data_cons repr_tys $ map (map Var) vars
233 var_tys = mkTyVarTys $ tyConTyVars vect_tc
234 arg_ty = mkTyConApp vect_tc var_tys
235 data_cons = tyConDataCons vect_tc
237 mk_alts _ _ [] = [(DEFAULT, [], Var unitDataConId)]
238 mk_alts [dc] [vars] [expr] = [(DataAlt dc, vars, expr)]
239 mk_alts dcs vars exprs = zipWith4 mk_alt dcs vars sum_data_cons exprs
241 mk_alt dc vars sum_dc expr = (DataAlt dc, vars,
242 mkConApp sum_dc (map Type prod_tys ++ [expr]))
244 mk_prod _ _ [] = Var unitDataConId
245 mk_prod _ _ [expr] = expr
246 mk_prod (Just dc) tys exprs = mkConApp dc (map Type tys ++ exprs)
248 buildFromPRepr :: TyConRepr -> TyCon -> TyCon -> TyCon -> VM CoreExpr
249 buildFromPRepr (TyConRepr {
251 , repr_prod_data_cons = prod_data_cons
252 , repr_prod_tys = prod_tys
253 , repr_sum_data_cons = sum_data_cons
254 , repr_type = repr_type
258 arg_ty <- mkPReprType res_ty
259 arg <- newLocalVar FSLIT("x") arg_ty
262 . un_sum (unwrapFamInstScrut prepr_tc var_tys (Var arg)))
264 $ zipWith4 un_prod data_cons prod_data_cons prod_tys repr_tys)
266 var_tys = mkTyVarTys $ tyConTyVars vect_tc
267 ty_args = map Type var_tys
268 res_ty = mkTyConApp vect_tc var_tys
269 data_cons = tyConDataCons vect_tc
273 var <- newLocalVar FSLIT("u") unitTy
274 return (var, mkConApp dc ty_args)
277 var <- newLocalVar FSLIT("x") ty
278 return (var, mkConApp dc (ty_args ++ [Var var]))
280 un_prod dc (Just prod_dc) prod_ty tys
282 vars <- mapM (newLocalVar FSLIT("x")) tys
283 pv <- newLocalVar FSLIT("p") prod_ty
285 let res = mkConApp dc (ty_args ++ map Var vars)
286 expr = Case (Var pv) (mkWildId prod_ty) res_ty
287 [(DataAlt prod_dc, vars, res)]
291 un_sum scrut [(var, expr)] = Let (NonRec var scrut) expr
293 = Case scrut (mkWildId repr_type) res_ty
294 $ zipWith mk_alt sum_data_cons alts
296 mk_alt sum_dc (var, expr) = (DataAlt sum_dc, [var], expr)
299 buildToArrPRepr :: TyConRepr -> TyCon -> TyCon -> TyCon -> VM CoreExpr
300 buildToArrPRepr _ vect_tc prepr_tc arr_tc
302 arg_ty <- mkPArrayType el_ty
303 rep_tys <- mapM (mapM mkPArrayType) rep_el_tys
305 arg <- newLocalVar FSLIT("xs") arg_ty
306 bndrss <- mapM (mapM (newLocalVar FSLIT("ys"))) rep_tys
307 len <- newLocalVar FSLIT("len") intPrimTy
308 sel <- newLocalVar FSLIT("sel") =<< mkPArrayType intTy
310 let add_sel xs | has_selector = sel : xs
313 all_bndrs = len : add_sel (concat bndrss)
315 res <- parrayCoerce prepr_tc var_tys
316 =<< mkToArrPRepr (Var len) (Var sel) (map (map Var) bndrss)
317 res_ty <- mkPArrayType =<< mkPReprType el_ty
320 $ Case (unwrapFamInstScrut arr_tc var_tys (Var arg))
321 (mkWildId (mkTyConApp arr_tc var_tys))
323 [(DataAlt arr_dc, all_bndrs, res)]
325 var_tys = mkTyVarTys $ tyConTyVars vect_tc
326 el_ty = mkTyConApp vect_tc var_tys
327 data_cons = tyConDataCons vect_tc
328 rep_el_tys = map dataConRepArgTys data_cons
330 [arr_dc] = tyConDataCons arr_tc
332 has_selector | [_] <- data_cons = False
335 buildFromArrPRepr :: TyConRepr -> TyCon -> TyCon -> TyCon -> VM CoreExpr
336 buildFromArrPRepr _ vect_tc prepr_tc arr_tc
337 = mkFromArrPRepr undefined undefined undefined undefined undefined undefined
339 buildPRDict :: TyConRepr -> TyCon -> TyCon -> TyCon -> VM CoreExpr
340 buildPRDict (TyConRepr {
342 , repr_prod_tycons = prod_tycons
343 , repr_prod_tys = prod_tys
344 , repr_sum_tycon = repr_sum_tycon
348 prs <- mapM (mapM mkPR) repr_tys
349 prod_prs <- sequence $ zipWith3 mk_prod_pr prod_tycons repr_tys prs
350 sum_pr <- mk_sum_pr prod_prs
351 prCoerce prepr_tc var_tys sum_pr
353 var_tys = mkTyVarTys $ tyConTyVars vect_tc
355 Just sum_tycon = repr_sum_tycon
357 mk_prod_pr _ _ [] = prDFunOfTyCon unitTyCon
358 mk_prod_pr _ _ [pr] = return pr
359 mk_prod_pr (Just tc) tys prs
361 dfun <- prDFunOfTyCon tc
362 return $ dfun `mkTyApps` tys `mkApps` prs
364 mk_sum_pr [pr] = return pr
367 dfun <- prDFunOfTyCon sum_tycon
368 return $ dfun `mkTyApps` prod_tys `mkApps` prs
370 buildPArrayTyCon :: TyCon -> TyCon -> VM TyCon
371 buildPArrayTyCon orig_tc vect_tc = fixV $ \repr_tc ->
373 name' <- cloneName mkPArrayTyConOcc orig_name
374 rhs <- buildPArrayTyConRhs orig_name vect_tc repr_tc
375 parray <- builtin parrayTyCon
377 liftDs $ buildAlgTyCon name'
379 [] -- no stupid theta
381 rec_flag -- FIXME: is this ok?
382 False -- FIXME: no generics
383 False -- not GADT syntax
384 (Just $ mk_fam_inst parray vect_tc)
386 orig_name = tyConName orig_tc
387 tyvars = tyConTyVars vect_tc
388 rec_flag = boolToRecFlag (isRecursiveTyCon vect_tc)
391 buildPArrayTyConRhs :: Name -> TyCon -> TyCon -> VM AlgTyConRhs
392 buildPArrayTyConRhs orig_name vect_tc repr_tc
394 data_con <- buildPArrayDataCon orig_name vect_tc repr_tc
395 return $ DataTyCon { data_cons = [data_con], is_enum = False }
397 buildPArrayDataCon :: Name -> TyCon -> TyCon -> VM DataCon
398 buildPArrayDataCon orig_name vect_tc repr_tc
400 dc_name <- cloneName mkPArrayDataConOcc orig_name
401 repr <- mkTyConRepr vect_tc
403 let all_tys = arr_shape_tys repr ++ concat (arr_repr_tys repr)
405 liftDs $ buildDataCon dc_name
407 (map (const NotMarkedStrict) all_tys)
408 [] -- no field labels
409 (tyConTyVars vect_tc)
410 [] -- no existentials
416 mkPADFun :: TyCon -> VM Var
418 = newExportedVar (mkPADFunOcc $ getOccName vect_tc) =<< paDFunType vect_tc
421 shapeReprTys :: [Type]
422 , shapeStrictness :: [StrictnessMark]
423 , shapeLength :: [CoreExpr] -> VM CoreExpr
424 , shapeReplicate :: CoreExpr -> CoreExpr -> VM [CoreExpr]
427 tyConShape :: TyCon -> VM Shape
429 | isProductTyCon vect_tc
431 shapeReprTys = [intPrimTy]
432 , shapeStrictness = [NotMarkedStrict]
433 , shapeLength = \[len] -> return len
434 , shapeReplicate = \len _ -> return [len]
439 repr_ty <- mkPArrayType intTy -- FIXME: we want to unbox this
441 shapeReprTys = [repr_ty]
442 , shapeStrictness = [MarkedStrict]
443 , shapeLength = \[sel] -> lengthPA sel
444 , shapeReplicate = \len n -> do
445 e <- replicatePA len n
449 buildTyConBindings :: TyCon -> TyCon -> TyCon -> TyCon -> Var
450 -> VM [(Var, CoreExpr)]
451 buildTyConBindings orig_tc vect_tc prepr_tc arr_tc dfun
453 shape <- tyConShape vect_tc
454 repr <- mkTyConRepr vect_tc
455 sequence_ (zipWith4 (vectDataConWorker shape vect_tc arr_tc arr_dc)
460 dict <- buildPADict repr vect_tc prepr_tc arr_tc dfun
462 return $ (dfun, dict) : binds
464 orig_dcs = tyConDataCons orig_tc
465 vect_dcs = tyConDataCons vect_tc
466 [arr_dc] = tyConDataCons arr_tc
468 repr_tys = map dataConRepArgTys vect_dcs
470 vectDataConWorker :: Shape -> TyCon -> TyCon -> DataCon
471 -> DataCon -> DataCon -> [[Type]] -> [[Type]]
473 vectDataConWorker shape vect_tc arr_tc arr_dc orig_dc vect_dc pre (dc_tys : post)
477 . polyAbstract tvs $ \abstract ->
478 liftM (abstract . vectorised)
479 $ buildClosures tvs [] dc_tys res_ty (liftM2 (,) mk_vect mk_lift)
481 worker <- cloneId mkVectOcc orig_worker (exprType clo)
482 hoistBinding worker clo
483 defGlobalVar orig_worker worker
486 tvs = tyConTyVars vect_tc
487 arg_tys = mkTyVarTys tvs
488 res_ty = mkTyConApp vect_tc arg_tys
490 orig_worker = dataConWorkId orig_dc
492 mk_vect = return . mkConApp vect_dc $ map Type arg_tys
494 len <- newLocalVar FSLIT("n") intPrimTy
495 arr_tys <- mapM mkPArrayType dc_tys
496 args <- mapM (newLocalVar FSLIT("xs")) arr_tys
497 shapes <- shapeReplicate shape
499 (mkDataConTag vect_dc)
501 empty_pre <- mapM emptyPA (concat pre)
502 empty_post <- mapM emptyPA (concat post)
504 return . mkLams (len : args)
505 . wrapFamInstBody arr_tc arg_tys
507 $ map Type arg_tys ++ shapes
512 buildPADict :: TyConRepr -> TyCon -> TyCon -> TyCon -> Var -> VM CoreExpr
513 buildPADict repr vect_tc prepr_tc arr_tc dfun
514 = polyAbstract tvs $ \abstract ->
516 meth_binds <- mapM (mk_method repr) paMethods
517 let meth_exprs = map (Var . fst) meth_binds
519 pa_dc <- builtin paDataCon
520 let dict = mkConApp pa_dc (Type (mkTyConApp vect_tc arg_tys) : meth_exprs)
521 body = Let (Rec meth_binds) dict
522 return . mkInlineMe $ abstract body
524 tvs = tyConTyVars arr_tc
525 arg_tys = mkTyVarTys tvs
527 mk_method repr (name, build)
530 body <- build repr vect_tc prepr_tc arr_tc
531 var <- newLocalVar name (exprType body)
532 return (var, mkInlineMe body)
534 paMethods = [(FSLIT("toPRepr"), buildToPRepr),
535 (FSLIT("fromPRepr"), buildFromPRepr),
536 (FSLIT("toArrPRepr"), buildToArrPRepr),
537 (FSLIT("fromArrPRepr"), buildFromArrPRepr),
538 (FSLIT("dictPRepr"), buildPRDict)]
540 -- | Split the given tycons into two sets depending on whether they have to be
541 -- converted (first list) or not (second list). The first argument contains
542 -- information about the conversion status of external tycons:
544 -- * tycons which have converted versions are mapped to True
545 -- * tycons which are not changed by vectorisation are mapped to False
546 -- * tycons which can't be converted are not elements of the map
548 classifyTyCons :: UniqFM Bool -> [TyConGroup] -> ([TyCon], [TyCon])
549 classifyTyCons = classify [] []
551 classify conv keep cs [] = (conv, keep)
552 classify conv keep cs ((tcs, ds) : rs)
553 | can_convert && must_convert
554 = classify (tcs ++ conv) keep (cs `addListToUFM` [(tc,True) | tc <- tcs]) rs
556 = classify conv (tcs ++ keep) (cs `addListToUFM` [(tc,False) | tc <- tcs]) rs
558 = classify conv keep cs rs
560 refs = ds `delListFromUniqSet` tcs
562 can_convert = isNullUFM (refs `minusUFM` cs) && all convertable tcs
563 must_convert = foldUFM (||) False (intersectUFM_C const cs refs)
565 convertable tc = isDataTyCon tc && all isVanillaDataCon (tyConDataCons tc)
567 -- | Compute mutually recursive groups of tycons in topological order
569 tyConGroups :: [TyCon] -> [TyConGroup]
570 tyConGroups tcs = map mk_grp (stronglyConnComp edges)
572 edges = [((tc, ds), tc, uniqSetToList ds) | tc <- tcs
573 , let ds = tyConsOfTyCon tc]
575 mk_grp (AcyclicSCC (tc, ds)) = ([tc], ds)
576 mk_grp (CyclicSCC els) = (tcs, unionManyUniqSets dss)
578 (tcs, dss) = unzip els
580 tyConsOfTyCon :: TyCon -> UniqSet TyCon
582 = tyConsOfTypes . concatMap dataConRepArgTys . tyConDataCons
584 tyConsOfType :: Type -> UniqSet TyCon
586 | Just ty' <- coreView ty = tyConsOfType ty'
587 tyConsOfType (TyVarTy v) = emptyUniqSet
588 tyConsOfType (TyConApp tc tys) = extend (tyConsOfTypes tys)
590 extend | isUnLiftedTyCon tc
591 || isTupleTyCon tc = id
593 | otherwise = (`addOneToUniqSet` tc)
595 tyConsOfType (AppTy a b) = tyConsOfType a `unionUniqSets` tyConsOfType b
596 tyConsOfType (FunTy a b) = (tyConsOfType a `unionUniqSets` tyConsOfType b)
597 `addOneToUniqSet` funTyCon
598 tyConsOfType (ForAllTy _ ty) = tyConsOfType ty
599 tyConsOfType other = pprPanic "ClosureConv.tyConsOfType" $ ppr other
601 tyConsOfTypes :: [Type] -> UniqSet TyCon
602 tyConsOfTypes = unionManyUniqSets . map tyConsOfType