Sort all the PADict/PData/PRDict/PRepr stuff into their own modules
[ghc-hetmet.git] / compiler / vectorise / VectType.hs
index d5a1ba1..11d69d6 100644 (file)
-module VectType ( vectTyCon, vectType, vectTypeEnv )
+{-# OPTIONS -fno-warn-missing-signatures #-}
+
+module VectType ( 
+       vectTyCon,
+       vectAndLiftType,
+       vectType,
+       vectTypeEnv,
+        buildPADict,
+        fromVect
+)
 where
-
-#include "HsVersions.h"
-
-import VectMonad
 import VectUtils
-
-import HscTypes          ( TypeEnv, extendTypeEnvList, typeEnvTyCons )
+import Vectorise.Env
+import Vectorise.Convert
+import Vectorise.Vect
+import Vectorise.Monad
+import Vectorise.Builtins
+import Vectorise.Type.Type
+import Vectorise.Type.TyConDecl
+import Vectorise.Type.Classify
+import Vectorise.Type.PADict
+import Vectorise.Type.PData
+import Vectorise.Type.PRepr
+import Vectorise.Type.Repr
+import Vectorise.Utils.Closure
+import Vectorise.Utils.Hoisting
+
+import HscTypes
+import CoreSyn
+import CoreUtils
+import CoreUnfold
 import DataCon
 import TyCon
 import Type
-import TypeRep
-import Coercion
+import FamInstEnv
 import OccName
+import Id
 import MkId
-import BasicTypes        ( StrictnessMark(..), boolToRecFlag )
-import Name              ( Name )
+import Var
 import NameEnv
-import TysWiredIn        ( intTy )
 
 import Unique
 import UniqFM
-import UniqSet
-import Digraph           ( SCC(..), stronglyConnComp )
-
+import Util
 import Outputable
-
-import Control.Monad  ( liftM2, zipWithM, zipWithM_ )
-
--- ----------------------------------------------------------------------------
--- Types
-
-vectTyCon :: TyCon -> VM TyCon
-vectTyCon tc
-  | isFunTyCon tc        = builtin closureTyCon
-  | isBoxedTupleTyCon tc = return tc
-  | isUnLiftedTyCon tc   = return tc
-  | otherwise = do
-                  r <- lookupTyCon tc
-                  case r of
-                    Just tc' -> return tc'
-
-                    -- FIXME: just for now
-                    Nothing  -> pprTrace "ccTyCon:" (ppr tc) $ return tc
-
-vectType :: Type -> VM Type
-vectType ty | Just ty' <- coreView ty = vectType ty'
-vectType (TyVarTy tv) = return $ TyVarTy tv
-vectType (AppTy ty1 ty2) = liftM2 AppTy (vectType ty1) (vectType ty2)
-vectType (TyConApp tc tys) = liftM2 TyConApp (vectTyCon tc) (mapM vectType tys)
-vectType (FunTy ty1 ty2)   = liftM2 TyConApp (builtin closureTyCon)
-                                             (mapM vectType [ty1,ty2])
-vectType ty@(ForAllTy _ _)
-  = do
-      mdicts   <- mapM paDictArgType tyvars
-      mono_ty' <- vectType mono_ty
-      return $ tyvars `mkForAllTys` ([dict | Just dict <- mdicts] `mkFunTys` mono_ty')
-  where
-    (tyvars, mono_ty) = splitForAllTys ty
-
-vectType ty = pprPanic "vectType:" (ppr ty)
-
--- ----------------------------------------------------------------------------
--- Type definitions
-
-type TyConGroup = ([TyCon], UniqSet TyCon)
-
-vectTypeEnv :: TypeEnv -> VM TypeEnv
+import FastString
+import MonadUtils
+import Control.Monad
+import Data.List
+
+debug          = False
+dtrace s x     = if debug then pprTrace "VectType" s x else x
+
+
+-- | Vectorise a type environment.
+--   The type environment contains all the type things defined in a module.
+vectTypeEnv 
+       :: TypeEnv
+       -> VM ( TypeEnv                 -- Vectorised type environment.
+             , [FamInst]               -- New type family instances.
+             , [(Var, CoreExpr)])      -- New top level bindings.
+       
 vectTypeEnv env
-  = do
+ = dtrace (ppr env)
+ $ do
       cs <- readGEnv $ mk_map . global_tycons
+
+      -- Split the list of TyCons into the ones we have to vectorise vs the
+      -- ones we can pass through unchanged. We also pass through algebraic 
+      -- types that use non Haskell98 features, as we don't handle those.
       let (conv_tcs, keep_tcs) = classifyTyCons cs groups
           keep_dcs             = concatMap tyConDataCons keep_tcs
+
       zipWithM_ defTyCon   keep_tcs keep_tcs
       zipWithM_ defDataCon keep_dcs keep_dcs
-      vect_tcs <- vectTyConDecls conv_tcs
-      parr_tcs1 <- mapM (\tc -> buildPArrayTyCon (tyConName tc) tc) keep_tcs
-      parr_tcs2 <- zipWithM (buildPArrayTyCon . tyConName) conv_tcs vect_tcs
-      let new_tcs = vect_tcs ++ parr_tcs1 ++ parr_tcs2
-      return $ extendTypeEnvList env
-                 (map ATyCon new_tcs ++ [ADataCon dc | tc <- new_tcs
-                                                     , dc <- tyConDataCons tc])
-  where
-    tycons = typeEnvTyCons env
-    groups = tyConGroups tycons
 
-    mk_map env = listToUFM_Directly [(u, getUnique n /= u) | (u,n) <- nameEnvUniqueElts env]
+      new_tcs <- vectTyConDecls conv_tcs
 
-    keep_tc tc = let dcs = tyConDataCons tc
-                 in
-                 defTyCon tc tc >> zipWithM_ defDataCon dcs dcs
+      let orig_tcs = keep_tcs ++ conv_tcs
 
+      -- We don't need to make new representation types for dictionary
+      -- constructors. The constructors are always fully applied, and we don't 
+      -- need to lift them to arrays as a dictionary of a particular type
+      -- always has the same value.
+      let vect_tcs = filter (not . isClassTyCon) 
+                   $ keep_tcs ++ new_tcs
 
-vectTyConDecls :: [TyCon] -> VM [TyCon]
-vectTyConDecls tcs = fixV $ \tcs' ->
-  do
-    mapM_ (uncurry defTyCon) (lazy_zip tcs tcs')
-    mapM vectTyConDecl tcs
-  where
-    lazy_zip [] _ = []
-    lazy_zip (x:xs) ~(y:ys) = (x,y) : lazy_zip xs ys
-
-vectTyConDecl :: TyCon -> VM TyCon
-vectTyConDecl tc
-  = do
-      name' <- cloneName mkVectTyConOcc name
-      rhs'  <- vectAlgTyConRhs (algTyConRhs tc)
-
-      return $ mkAlgTyCon name'
-                          kind
-                          tyvars
-                          []              -- no stupid theta
-                          rhs'
-                          []              -- no selector ids
-                          NoParentTyCon   -- FIXME
-                          rec_flag        -- FIXME: is this ok?
-                          False           -- FIXME: no generics
-                          False           -- not GADT syntax
-  where
-    name   = tyConName tc
-    kind   = tyConKind tc
-    tyvars = tyConTyVars tc
-    rec_flag = boolToRecFlag (isRecursiveTyCon tc)
-
-vectAlgTyConRhs :: AlgTyConRhs -> VM AlgTyConRhs
-vectAlgTyConRhs (DataTyCon { data_cons = data_cons
-                           , is_enum   = is_enum
-                           })
-  = do
-      data_cons' <- mapM vectDataCon data_cons
-      zipWithM_ defDataCon data_cons data_cons'
-      return $ DataTyCon { data_cons = data_cons'
-                         , is_enum   = is_enum
-                         }
-
-vectDataCon :: DataCon -> VM DataCon
-vectDataCon dc
-  | not . null $ dataConExTyVars dc = pprPanic "vectDataCon: existentials" (ppr dc)
-  | not . null $ dataConEqSpec   dc = pprPanic "vectDataCon: eq spec" (ppr dc)
-  | otherwise
-  = do
-      name'    <- cloneName mkVectDataConOcc name
-      tycon'   <- vectTyCon tycon
-      arg_tys  <- mapM vectType rep_arg_tys
-      wrk_name <- cloneName mkDataConWorkerOcc name'
-
-      let ids      = mkDataConIds (panic "vectDataCon: wrapper id")
-                                  wrk_name
-                                  data_con
-          data_con = mkDataCon name'
-                               False           -- not infix
-                               (map (const NotMarkedStrict) arg_tys)
-                               []              -- no labelled fields
-                               univ_tvs
-                               []              -- no existential tvs for now
-                               []              -- no eq spec for now
-                               []              -- no theta
-                               arg_tys
-                               tycon'
-                               []              -- no stupid theta
-                               ids
-      return data_con
-  where
-    name        = dataConName dc
-    univ_tvs    = dataConUnivTyVars dc
-    rep_arg_tys = dataConRepArgTys dc
-    tycon       = dataConTyCon dc
-
-buildPArrayTyCon :: Name -> TyCon -> VM TyCon
-buildPArrayTyCon orig_name vect_tc = fixV $ \repr_tc ->
-  do
-    name'  <- cloneName mkPArrayTyConOcc orig_name
-    parent <- buildPArrayParentInfo orig_name vect_tc repr_tc
-    rhs    <- buildPArrayTyConRhs orig_name vect_tc repr_tc
-
-    return $ mkAlgTyCon name'
-                        kind
-                        tyvars
-                        []              -- no stupid theta
-                        rhs
-                        []              -- no selector ids
-                        parent
-                        rec_flag        -- FIXME: is this ok?
-                        False           -- FIXME: no generics
-                        False           -- not GADT syntax
-  where
-    name   = tyConName vect_tc
-    kind   = tyConKind vect_tc
-    tyvars = tyConTyVars vect_tc
-    rec_flag = boolToRecFlag (isRecursiveTyCon vect_tc)
-    
-
-buildPArrayParentInfo :: Name -> TyCon -> TyCon -> VM TyConParent
-buildPArrayParentInfo orig_name vect_tc repr_tc
-  = do
-      parray_tc <- builtin parrayTyCon
-      co_name <- cloneName mkInstTyCoOcc orig_name
-
-      let inst_tys = [mkTyConApp vect_tc (map mkTyVarTy tyvars)]
-
-      return . FamilyTyCon parray_tc inst_tys
-             $ mkFamInstCoercion co_name
-                                 tyvars
-                                 parray_tc
-                                 inst_tys
-                                 repr_tc
-  where
-    tyvars = tyConTyVars vect_tc
-
-buildPArrayTyConRhs :: Name -> TyCon -> TyCon -> VM AlgTyConRhs
-buildPArrayTyConRhs orig_name vect_tc repr_tc
-  = do
-      data_con <- buildPArrayDataCon orig_name vect_tc repr_tc
-      return $ DataTyCon { data_cons = [data_con], is_enum = False }
-
-buildPArrayDataCon :: Name -> TyCon -> TyCon -> VM DataCon
-buildPArrayDataCon orig_name vect_tc repr_tc
-  = do
-      dc_name  <- cloneName mkPArrayDataConOcc orig_name
-      shape_ty <- mkPArrayType intTy   -- FIXME: we want to unbox this!
-      repr_tys <- mapM mkPArrayType types
-      wrk_name <- cloneName mkDataConWorkerOcc  dc_name
-      wrp_name <- cloneName mkDataConWrapperOcc dc_name
-
-      let ids      = mkDataConIds wrp_name wrk_name data_con
-          data_con = mkDataCon dc_name
-                               False
-                               (MarkedStrict : map (const NotMarkedStrict) repr_tys)
-                               []
-                               (tyConTyVars vect_tc)
-                               []
-                               []
-                               []
-                               (shape_ty : repr_tys)
-                               repr_tc
-                               []
-                               ids
-
-      return data_con
-  where
-    types = [ty | dc <- tyConDataCons vect_tc
-                , ty <- dataConRepArgTys dc]
-
--- | Split the given tycons into two sets depending on whether they have to be
--- converted (first list) or not (second list). The first argument contains
--- information about the conversion status of external tycons:
--- 
---   * tycons which have converted versions are mapped to True
---   * tycons which are not changed by vectorisation are mapped to False
---   * tycons which can't be converted are not elements of the map
---
-classifyTyCons :: UniqFM Bool -> [TyConGroup] -> ([TyCon], [TyCon])
-classifyTyCons = classify [] []
-  where
-    classify conv keep cs [] = (conv, keep)
-    classify conv keep cs ((tcs, ds) : rs)
-      | can_convert && must_convert
-        = classify (tcs ++ conv) keep (cs `addListToUFM` [(tc,True) | tc <- tcs]) rs
-      | can_convert
-        = classify conv (tcs ++ keep) (cs `addListToUFM` [(tc,False) | tc <- tcs]) rs
-      | otherwise
-        = classify conv keep cs rs
-      where
-        refs = ds `delListFromUniqSet` tcs
+      (_, binds, inst_tcs) <- fixV $ \ ~(dfuns', _, _) ->
+        do
+          defTyConPAs (zipLazy vect_tcs dfuns')
+          reprs     <- mapM tyConRepr vect_tcs
+          repr_tcs  <- zipWith3M buildPReprTyCon orig_tcs vect_tcs reprs
+          pdata_tcs <- zipWith3M buildPDataTyCon orig_tcs vect_tcs reprs
 
-        can_convert  = isNullUFM (refs `minusUFM` cs) && all convertable tcs
-        must_convert = foldUFM (||) False (intersectUFM_C const cs refs)
+          dfuns     <- sequence 
+                    $  zipWith5 buildTyConBindings
+                               orig_tcs
+                               vect_tcs
+                               repr_tcs
+                               pdata_tcs
+                               reprs
 
-        convertable tc = isDataTyCon tc && all isVanillaDataCon (tyConDataCons tc)
-    
--- | Compute mutually recursive groups of tycons in topological order
---
-tyConGroups :: [TyCon] -> [TyConGroup]
-tyConGroups tcs = map mk_grp (stronglyConnComp edges)
-  where
-    edges = [((tc, ds), tc, uniqSetToList ds) | tc <- tcs
-                                , let ds = tyConsOfTyCon tc]
+          binds     <- takeHoisted
+          return (dfuns, binds, repr_tcs ++ pdata_tcs)
 
-    mk_grp (AcyclicSCC (tc, ds)) = ([tc], ds)
-    mk_grp (CyclicSCC els)       = (tcs, unionManyUniqSets dss)
-      where
-        (tcs, dss) = unzip els
+      let all_new_tcs = new_tcs ++ inst_tcs
 
-tyConsOfTyCon :: TyCon -> UniqSet TyCon
-tyConsOfTyCon 
-  = tyConsOfTypes . concatMap dataConRepArgTys . tyConDataCons
+      let new_env = extendTypeEnvList env
+                       (map ATyCon all_new_tcs
+                        ++ [ADataCon dc | tc <- all_new_tcs
+                                        , dc <- tyConDataCons tc])
 
-tyConsOfType :: Type -> UniqSet TyCon
-tyConsOfType ty
-  | Just ty' <- coreView ty    = tyConsOfType ty'
-tyConsOfType (TyVarTy v)       = emptyUniqSet
-tyConsOfType (TyConApp tc tys) = extend (tyConsOfTypes tys)
+      return (new_env, map mkLocalFamInst inst_tcs, binds)
   where
-    extend | isUnLiftedTyCon tc
-           || isTupleTyCon   tc = id
+    tycons = typeEnvTyCons env
+    groups = tyConGroups tycons
+
+    mk_map env = listToUFM_Directly [(u, getUnique n /= u) | (u,n) <- nameEnvUniqueElts env]
 
-           | otherwise          = (`addOneToUniqSet` tc)
 
-tyConsOfType (AppTy a b)       = tyConsOfType a `unionUniqSets` tyConsOfType b
-tyConsOfType (FunTy a b)       = (tyConsOfType a `unionUniqSets` tyConsOfType b)
-                                 `addOneToUniqSet` funTyCon
-tyConsOfType (ForAllTy _ ty)   = tyConsOfType ty
-tyConsOfType other             = pprPanic "ClosureConv.tyConsOfType" $ ppr other
 
-tyConsOfTypes :: [Type] -> UniqSet TyCon
-tyConsOfTypes = unionManyUniqSets . map tyConsOfType
+buildTyConBindings :: TyCon -> TyCon -> TyCon -> TyCon -> SumRepr -> VM Var
+buildTyConBindings orig_tc vect_tc prepr_tc pdata_tc repr
+ = do vectDataConWorkers orig_tc vect_tc pdata_tc
+      buildPADict vect_tc prepr_tc pdata_tc repr
+
+
+vectDataConWorkers :: TyCon -> TyCon -> TyCon -> VM ()
+vectDataConWorkers orig_tc vect_tc arr_tc
+ = do bs <- sequence
+          . zipWith3 def_worker  (tyConDataCons orig_tc) rep_tys
+          $ zipWith4 mk_data_con (tyConDataCons vect_tc)
+                                 rep_tys
+                                 (inits rep_tys)
+                                 (tail $ tails rep_tys)
+      mapM_ (uncurry hoistBinding) bs
+ where
+    tyvars   = tyConTyVars vect_tc
+    var_tys  = mkTyVarTys tyvars
+    ty_args  = map Type var_tys
+    res_ty   = mkTyConApp vect_tc var_tys
+
+    cons     = tyConDataCons vect_tc
+    arity    = length cons
+    [arr_dc] = tyConDataCons arr_tc
+
+    rep_tys  = map dataConRepArgTys $ tyConDataCons vect_tc
+
+
+    mk_data_con con tys pre post
+      = liftM2 (,) (vect_data_con con)
+                   (lift_data_con tys pre post (mkDataConTag con))
+
+    sel_replicate len tag
+      | arity > 1 = do
+                      rep <- builtin (selReplicate arity)
+                      return [rep `mkApps` [len, tag]]
+
+      | otherwise = return []
+
+    vect_data_con con = return $ mkConApp con ty_args
+    lift_data_con tys pre_tys post_tys tag
+      = do
+          len  <- builtin liftingContext
+          args <- mapM (newLocalVar (fsLit "xs"))
+                  =<< mapM mkPDataType tys
+
+          sel  <- sel_replicate (Var len) tag
+
+          pre   <- mapM emptyPD (concat pre_tys)
+          post  <- mapM emptyPD (concat post_tys)
+
+          return . mkLams (len : args)
+                 . wrapFamInstBody arr_tc var_tys
+                 . mkConApp arr_dc
+                 $ ty_args ++ sel ++ pre ++ map Var args ++ post
+
+    def_worker data_con arg_tys mk_body
+      = do
+          arity <- polyArity tyvars
+          body <- closedV
+                . inBind orig_worker
+                . polyAbstract tyvars $ \args ->
+                  liftM (mkLams (tyvars ++ args) . vectorised)
+                $ buildClosures tyvars [] arg_tys res_ty mk_body
+
+          raw_worker <- cloneId mkVectOcc orig_worker (exprType body)
+          let vect_worker = raw_worker `setIdUnfolding`
+                              mkInlineRule body (Just arity)
+          defGlobalVar orig_worker vect_worker
+          return (vect_worker, body)
+      where
+        orig_worker = dataConWorkId data_con