Vectoriser: only treat a function as scalar if it actually computes something
[ghc-hetmet.git] / compiler / vectorise / VectBuiltIn.hs
index 7ae2070..65579b4 100644 (file)
@@ -1,27 +1,32 @@
-{-# OPTIONS -w #-}
--- The above warning supression flag is a temporary kludge.
--- While working on this module you are encouraged to remove it and fix
--- any warnings in the module. See
---     http://hackage.haskell.org/trac/ghc/wiki/Commentary/CodingStyle#Warnings
--- for details
 
+-- | The vectoriser rewrites user code to use builtin types and functions exported by the DPH library.
+--   We track the names of those things in the `Builtis` type, and provide selection functions 
+--   to help extract their names.
 module VectBuiltIn (
-  Builtins(..), sumTyCon, prodTyCon, combinePAVar,
+  Builtins(..),
+
+  -- * Projections
+  sumTyCon, prodTyCon, prodDataCon,
+  selTy,selReplicate, selPick, selTags, selElements,
+  combinePDVar, scalarZip, closureCtrFun,
+
+  -- * Initialisation
   initBuiltins, initBuiltinVars, initBuiltinTyCons, initBuiltinDataCons,
   initBuiltinPAs, initBuiltinPRs,
-  initBuiltinBoxedTyCons,
+  initBuiltinBoxedTyCons, initBuiltinScalars,
 
   primMethod, primPArray
 ) where
 
-#include "HsVersions.h"
-
 import DsMonad
 import IfaceEnv        ( lookupOrig )
+import InstEnv
 
-import Module          ( Module )
+import Module
 import DataCon         ( DataCon, dataConName, dataConWorkId )
 import TyCon           ( TyCon, tyConName, tyConDataCons )
+import Class           ( Class, classTyCon )
+import CoreSyn         ( CoreExpr, Expr(..) )
 import Var             ( Var )
 import Id              ( mkSysLocal )
 import Name            ( Name, getOccString )
@@ -29,12 +34,15 @@ import NameEnv
 import OccName
 
 import TypeRep         ( funTyCon )
-import Type            ( Type )
+import Type            ( Type, mkTyConApp )
 import TysPrim
-import TysWiredIn      ( unitTyCon, tupleTyCon,
-                         intTyCon, intTyConName,
-                         boolTyCon, boolTyConName, trueDataCon, falseDataCon )
-import Module
+import TysWiredIn      ( unitDataCon,
+                         tupleTyCon, tupleCon,
+                         intTyCon,
+                         doubleTyCon,
+                         boolTyCon, trueDataCon, falseDataCon,
+                         parrTyConName )
+import PrelNames       ( word8TyConName, gHC_PARR )
 import BasicTypes      ( Boxity(..) )
 
 import FastString
@@ -44,282 +52,689 @@ import Data.Array
 import Control.Monad   ( liftM, zipWithM )
 import Data.List       ( unzip4 )
 
-mAX_NDP_PROD :: Int
-mAX_NDP_PROD = 3
-
-mAX_NDP_SUM :: Int
-mAX_NDP_SUM = 3
-
-mAX_NDP_COMBINE :: Int
-mAX_NDP_COMBINE = 2
-
-mkNDPModule :: FastString -> Module
-mkNDPModule m = mkModule ndpPackageId (mkModuleNameFS m)
-
-nDP_PARRAY      = mkNDPModule FSLIT("Data.Array.Parallel.Lifted.PArray")
-nDP_REPR        = mkNDPModule FSLIT("Data.Array.Parallel.Lifted.Repr")
-nDP_CLOSURE     = mkNDPModule FSLIT("Data.Array.Parallel.Lifted.Closure")
-nDP_PRIM        = mkNDPModule FSLIT("Data.Array.Parallel.Lifted.Prim")
-nDP_INSTANCES   = mkNDPModule FSLIT("Data.Array.Parallel.Lifted.Instances")
-nDP_COMBINATORS = mkNDPModule FSLIT("Data.Array.Parallel.Lifted.Combinators")
-
-nDP_PRELUDE_PARR = mkNDPModule FSLIT("Data.Array.Parallel.Prelude.PArr")
-nDP_PRELUDE_INT  = mkNDPModule FSLIT("Data.Array.Parallel.Prelude.Int")
-
-data Builtins = Builtins {
-                  parrayTyCon      :: TyCon
-                , paTyCon          :: TyCon
-                , paDataCon        :: DataCon
-                , preprTyCon       :: TyCon
-                , prTyCon          :: TyCon
-                , prDataCon        :: DataCon
-                , parrayIntPrimTyCon :: TyCon
-                , parrayBoolPrimTyCon :: TyCon
-                , voidTyCon        :: TyCon
-                , wrapTyCon        :: TyCon
-                , enumerationTyCon :: TyCon
-                , sumTyCons        :: Array Int TyCon
-                , closureTyCon     :: TyCon
-                , voidVar          :: Var
-                , mkPRVar          :: Var
-                , mkClosureVar     :: Var
-                , applyClosureVar  :: Var
-                , mkClosurePVar    :: Var
-                , applyClosurePVar :: Var
-                , replicatePAIntPrimVar :: Var
-                , upToPAIntPrimVar :: Var
-                , selectPAIntPrimVar :: Var
-                , truesPABoolPrimVar :: Var
-                , lengthPAVar      :: Var
-                , replicatePAVar   :: Var
-                , emptyPAVar       :: Var
-                , packPAVar        :: Var
-                , combinePAVars    :: Array Int Var
-                , liftingContext   :: Var
-                }
+
+-- Numbers of things exported by the DPH library.
+mAX_DPH_PROD :: Int
+mAX_DPH_PROD = 5
+
+mAX_DPH_SUM :: Int
+mAX_DPH_SUM = 2
+
+mAX_DPH_COMBINE :: Int
+mAX_DPH_COMBINE = 2
+
+mAX_DPH_SCALAR_ARGS :: Int
+mAX_DPH_SCALAR_ARGS = 3
+
+
+-- | Ids of the modules that contain our DPH builtins.
+data Modules 
+       = Modules 
+       { dph_PArray            :: Module
+        , dph_Repr             :: Module
+        , dph_Closure          :: Module
+        , dph_Unboxed          :: Module
+        , dph_Instances                :: Module
+        , dph_Combinators      :: Module
+        , dph_Scalar           :: Module
+        , dph_Selector         :: Module
+        , dph_Prelude_PArr     :: Module
+        , dph_Prelude_Int      :: Module
+        , dph_Prelude_Word8    :: Module
+        , dph_Prelude_Double   :: Module
+        , dph_Prelude_Bool     :: Module
+        , dph_Prelude_Tuple    :: Module
+       }
+
+
+-- | The locations of builtins in the current DPH library.
+dph_Modules :: PackageId -> Modules
+dph_Modules pkg 
+       = Modules 
+       { dph_PArray         = mk (fsLit "Data.Array.Parallel.Lifted.PArray")
+       , dph_Repr           = mk (fsLit "Data.Array.Parallel.Lifted.Repr")
+       , dph_Closure        = mk (fsLit "Data.Array.Parallel.Lifted.Closure")
+       , dph_Unboxed        = mk (fsLit "Data.Array.Parallel.Lifted.Unboxed")
+       , dph_Instances      = mk (fsLit "Data.Array.Parallel.Lifted.Instances")
+       , dph_Combinators    = mk (fsLit "Data.Array.Parallel.Lifted.Combinators")
+       , dph_Scalar         = mk (fsLit "Data.Array.Parallel.Lifted.Scalar")
+       , dph_Selector       = mk (fsLit "Data.Array.Parallel.Lifted.Selector")
+
+       , dph_Prelude_PArr   = mk (fsLit "Data.Array.Parallel.Prelude.Base.PArr")
+       , dph_Prelude_Int    = mk (fsLit "Data.Array.Parallel.Prelude.Base.Int")
+       , dph_Prelude_Word8  = mk (fsLit "Data.Array.Parallel.Prelude.Base.Word8")
+       , dph_Prelude_Double = mk (fsLit "Data.Array.Parallel.Prelude.Base.Double")
+       , dph_Prelude_Bool   = mk (fsLit "Data.Array.Parallel.Prelude.Base.Bool")
+       , dph_Prelude_Tuple  = mk (fsLit "Data.Array.Parallel.Prelude.Base.Tuple")
+       }
+       where   mk = mkModule pkg . mkModuleNameFS
+
+
+-- | Project out ids of modules that contain orphan instances that we need to load.
+dph_Orphans :: [Modules -> Module]
+dph_Orphans = [dph_Repr, dph_Instances]
+
+
+-- | Information about what builtin stuff to use from the DPH base libraries.
+data Builtins 
+        = Builtins 
+        { dphModules       :: Modules
+
+       -- From dph-common:Data.Array.Parallel.Lifted.PArray
+        , parrayTyCon      :: TyCon                    -- ^ PArray
+        , parrayDataCon    :: DataCon                  -- ^ PArray
+        , pdataTyCon       :: TyCon                    -- ^ PData
+        , paTyCon          :: TyCon                    -- ^ PA
+        , paDataCon        :: DataCon                  -- ^ PA
+        , preprTyCon       :: TyCon                    -- ^ PRepr
+        , prTyCon          :: TyCon                    -- ^ PR
+        , prDataCon        :: DataCon                  -- ^ PR
+        , replicatePDVar   :: Var                      -- ^ replicatePD
+        , emptyPDVar       :: Var                      -- ^ emptyPD
+        , packByTagPDVar   :: Var                      -- ^ packByTagPD
+        , combinePDVars    :: Array Int Var            -- ^ combinePD
+        , scalarClass      :: Class                    -- ^ Scalar
+
+        -- From dph-common:Data.Array.Parallel.Lifted.Closure
+        , closureTyCon     :: TyCon                    -- ^ :->
+        , closureVar       :: Var                      -- ^ closure
+        , applyVar         :: Var                      -- ^ $: 
+        , liftedClosureVar :: Var                      -- ^ liftedClosure
+        , liftedApplyVar   :: Var                      -- ^ liftedApply
+        , closureCtrFuns   :: Array Int Var            -- ^ closure1 .. closure2
+
+       -- From dph-common:Data.Array.Parallel.Lifted.Repr
+        , voidTyCon        :: TyCon                    -- ^ Void
+        , wrapTyCon        :: TyCon                    -- ^ Wrap
+        , sumTyCons        :: Array Int TyCon           -- ^ Sum2 .. Sum3
+        , voidVar          :: Var                      -- ^ void
+        , pvoidVar         :: Var                      -- ^ pvoid
+        , fromVoidVar      :: Var                      -- ^ fromVoid
+        , punitVar         :: Var                      -- ^ punit
+
+       -- From dph-common:Data.Array.Parallel.Lifted.Selector
+        , selTys           :: Array Int Type           -- ^ Sel2
+        , selReplicates    :: Array Int CoreExpr       -- ^ replicate2
+        , selPicks         :: Array Int CoreExpr       -- ^ pick2
+        , selTagss         :: Array Int CoreExpr       -- ^ tagsSel2
+        , selEls           :: Array (Int, Int) CoreExpr        -- ^ elementsSel2_0 .. elementsSel_2_1
+
+       -- From dph-common:Data.Array.Parallel.Lifted.Scalar
+       -- NOTE: map is counted as a zipWith fn with one argument array.
+        , scalarZips       :: Array Int Var            -- ^ map, zipWith, zipWith3
+
+       -- A Fresh variable
+        , liftingContext   :: Var                      -- ^ lc
+        }
+
+
+-- | Get an element from one of the arrays of contained by a `Builtins`.
+--   If the indexed thing is not in the array then panic.
+indexBuiltin 
+       :: (Ix i, Outputable i) 
+       => String                       -- ^ Name of the selector we've used, for panic messages.
+       -> (Builtins -> Array i a)      -- ^ Field selector for the `Builtins`.
+       -> i                            -- ^ Index into the array.
+       -> Builtins 
+       -> a
+
+indexBuiltin fn f i bi
+  | inRange (bounds xs) i = xs ! i
+  | otherwise = pprPanic fn (ppr i)
+  where
+    xs = f bi
+
+
+-- Projections ----------------------------------------------------------------
+selTy :: Int -> Builtins -> Type
+selTy          = indexBuiltin "selTy" selTys
+
+selReplicate :: Int -> Builtins -> CoreExpr
+selReplicate   = indexBuiltin "selReplicate" selReplicates 
+
+selPick :: Int -> Builtins -> CoreExpr
+selPick        = indexBuiltin "selPick" selPicks
+
+selTags :: Int -> Builtins -> CoreExpr
+selTags        = indexBuiltin "selTags" selTagss
+
+selElements :: Int -> Int -> Builtins -> CoreExpr
+selElements i j = indexBuiltin "selElements" selEls (i,j)
 
 sumTyCon :: Int -> Builtins -> TyCon
-sumTyCon n bi
-  | n >= 2 && n <= mAX_NDP_SUM = sumTyCons bi ! n
-  | otherwise = pprPanic "sumTyCon" (ppr n)
+sumTyCon       = indexBuiltin "sumTyCon" sumTyCons
 
 prodTyCon :: Int -> Builtins -> TyCon
-prodTyCon n bi
-  | n == 1                      = wrapTyCon bi
-  | n >= 0 && n <= mAX_NDP_PROD = tupleTyCon Boxed n
+prodTyCon n _
+  | n >= 2 && n <= mAX_DPH_PROD = tupleTyCon Boxed n
   | otherwise = pprPanic "prodTyCon" (ppr n)
 
-combinePAVar :: Int -> Builtins -> Var
-combinePAVar n bi
-  | n >= 2 && n <= mAX_NDP_COMBINE = combinePAVars bi ! n
-  | otherwise = pprPanic "combinePAVar" (ppr n)
+prodDataCon :: Int -> Builtins -> DataCon
+prodDataCon n bi = case tyConDataCons (prodTyCon n bi) of
+                     [con] -> con
+                     _     -> pprPanic "prodDataCon" (ppr n)
+
+combinePDVar :: Int -> Builtins -> Var
+combinePDVar   = indexBuiltin "combinePDVar" combinePDVars
 
-initBuiltins :: DsM Builtins
-initBuiltins
+scalarZip :: Int -> Builtins -> Var
+scalarZip      = indexBuiltin "scalarZip" scalarZips
+
+closureCtrFun :: Int -> Builtins -> Var
+closureCtrFun  = indexBuiltin "closureCtrFun" closureCtrFuns
+
+
+-- Initialisation -------------------------------------------------------------
+-- | Create the initial map of builtin types and functions.
+initBuiltins 
+       :: PackageId    -- ^ package id the builtins are in, eg dph-common
+       -> DsM Builtins
+
+initBuiltins pkg
   = do
-      parrayTyCon  <- externalTyCon nDP_PARRAY FSLIT("PArray")
-      paTyCon      <- externalTyCon nDP_PARRAY FSLIT("PA")
-      let [paDataCon] = tyConDataCons paTyCon
-      preprTyCon   <- externalTyCon nDP_PARRAY FSLIT("PRepr")
-      prTyCon      <- externalTyCon nDP_PARRAY FSLIT("PR")
-      let [prDataCon] = tyConDataCons prTyCon
-      parrayIntPrimTyCon <- externalTyCon nDP_PRIM FSLIT("PArray_Int#")
-      parrayBoolPrimTyCon <- externalTyCon nDP_PRIM FSLIT("PArray_Bool#")
-      closureTyCon <- externalTyCon nDP_CLOSURE FSLIT(":->")
-
-      voidTyCon    <- externalTyCon nDP_REPR FSLIT("Void")
-      wrapTyCon    <- externalTyCon nDP_REPR FSLIT("Wrap")
-      enumerationTyCon <- externalTyCon nDP_REPR FSLIT("Enumeration")
-      sum_tcs <- mapM (externalTyCon nDP_REPR)
-                      [mkFastString ("Sum" ++ show i) | i <- [2..mAX_NDP_SUM]]
-
-      let sumTyCons = listArray (2, mAX_NDP_SUM) sum_tcs
-
-      voidVar          <- externalVar nDP_REPR FSLIT("void")
-      mkPRVar          <- externalVar nDP_PARRAY FSLIT("mkPR")
-      mkClosureVar     <- externalVar nDP_CLOSURE FSLIT("mkClosure")
-      applyClosureVar  <- externalVar nDP_CLOSURE FSLIT("$:")
-      mkClosurePVar    <- externalVar nDP_CLOSURE FSLIT("mkClosureP")
-      applyClosurePVar <- externalVar nDP_CLOSURE FSLIT("$:^")
-      replicatePAIntPrimVar <- externalVar nDP_PRIM FSLIT("replicatePA_Int#")
-      upToPAIntPrimVar <- externalVar nDP_PRIM FSLIT("upToPA_Int#")
-      selectPAIntPrimVar <- externalVar nDP_PRIM FSLIT("selectPA_Int#")
-      truesPABoolPrimVar <- externalVar nDP_PRIM FSLIT("truesPA_Bool#")
-      lengthPAVar      <- externalVar nDP_PARRAY FSLIT("lengthPA")
-      replicatePAVar   <- externalVar nDP_PARRAY FSLIT("replicatePA")
-      emptyPAVar       <- externalVar nDP_PARRAY FSLIT("emptyPA")
-      packPAVar        <- externalVar nDP_PARRAY FSLIT("packPA")
-
-      combines <- mapM (externalVar nDP_PARRAY)
-                       [mkFastString ("combine" ++ show i ++ "PA")
-                          | i <- [2..mAX_NDP_COMBINE]]
-      let combinePAVars = listArray (2, mAX_NDP_COMBINE) combines
-
-      liftingContext <- liftM (\u -> mkSysLocal FSLIT("lc") u intPrimTy)
+      mapM_ load dph_Orphans
+
+      -- From dph-common:Data.Array.Parallel.Lifted.PArray
+      parrayTyCon      <- externalTyCon dph_PArray (fsLit "PArray")
+      let [parrayDataCon] = tyConDataCons parrayTyCon
+      pdataTyCon       <- externalTyCon dph_PArray (fsLit "PData")
+      paTyCon          <- externalClassTyCon dph_PArray (fsLit "PA")
+      let [paDataCon]  = tyConDataCons paTyCon
+      preprTyCon       <- externalTyCon dph_PArray (fsLit "PRepr")
+      prTyCon          <- externalClassTyCon dph_PArray (fsLit "PR")
+      let [prDataCon]  = tyConDataCons prTyCon
+
+      -- wher
+      closureTyCon     <- externalTyCon dph_Closure (fsLit ":->")
+
+      -- From dph-common:Data.Array.Parallel.Lifted.Repr
+      voidTyCon                <- externalTyCon dph_Repr (fsLit "Void")
+      wrapTyCon                <- externalTyCon dph_Repr (fsLit "Wrap")
+
+      -- From dph-common:Data.Array.Parallel.Lifted.Selector
+      sel_tys      <- mapM (externalType dph_Selector)
+                           (numbered "Sel" 2 mAX_DPH_SUM)
+
+      sel_replicates <- mapM (externalFun dph_Selector)
+                             (numbered "replicate" 2 mAX_DPH_SUM)
+
+      sel_picks    <- mapM (externalFun dph_Selector)
+                           (numbered "pick" 2 mAX_DPH_SUM)
+
+      sel_tags     <- mapM (externalFun dph_Selector)
+                           (numbered "tagsSel" 2 mAX_DPH_SUM)
+
+      sel_els      <- mapM mk_elements
+                           [(i,j) | i <- [2..mAX_DPH_SUM], j <- [0..i-1]]
+
+      sum_tcs      <- mapM (externalTyCon dph_Repr)
+                           (numbered "Sum" 2 mAX_DPH_SUM)
+
+      let selTys        = listArray (2, mAX_DPH_SUM) sel_tys
+          selReplicates = listArray (2, mAX_DPH_SUM) sel_replicates
+          selPicks      = listArray (2, mAX_DPH_SUM) sel_picks
+          selTagss      = listArray (2, mAX_DPH_SUM) sel_tags
+          selEls        = array ((2,0), (mAX_DPH_SUM, mAX_DPH_SUM)) sel_els
+          sumTyCons     = listArray (2, mAX_DPH_SUM) sum_tcs
+
+
+      voidVar          <- externalVar dph_Repr (fsLit "void")
+      pvoidVar         <- externalVar dph_Repr (fsLit "pvoid")
+      fromVoidVar      <- externalVar dph_Repr (fsLit "fromVoid")
+      punitVar         <- externalVar dph_Repr (fsLit "punit")
+      closureVar       <- externalVar dph_Closure (fsLit "closure")
+      applyVar         <- externalVar dph_Closure (fsLit "$:")
+      liftedClosureVar <- externalVar dph_Closure (fsLit "liftedClosure")
+      liftedApplyVar   <- externalVar dph_Closure (fsLit "liftedApply")
+      replicatePDVar   <- externalVar dph_PArray (fsLit "replicatePD")
+      emptyPDVar       <- externalVar dph_PArray (fsLit "emptyPD")
+      packByTagPDVar   <- externalVar dph_PArray (fsLit "packByTagPD")
+
+      combines                 <- mapM (externalVar dph_PArray)
+                                       [mkFastString ("combine" ++ show i ++ "PD")
+                                       | i <- [2..mAX_DPH_COMBINE]]
+      let combinePDVars = listArray (2, mAX_DPH_COMBINE) combines
+
+      scalarClass      <- externalClass dph_PArray (fsLit "Scalar")
+      scalar_map       <- externalVar dph_Scalar (fsLit "scalar_map")
+      scalar_zip2      <- externalVar dph_Scalar (fsLit "scalar_zipWith")
+      scalar_zips      <- mapM (externalVar dph_Scalar)
+                               (numbered "scalar_zipWith" 3 mAX_DPH_SCALAR_ARGS)
+      let scalarZips   = listArray (1, mAX_DPH_SCALAR_ARGS)
+                                 (scalar_map : scalar_zip2 : scalar_zips)
+      closures                 <- mapM (externalVar dph_Closure)
+                                       (numbered "closure" 1 mAX_DPH_SCALAR_ARGS)
+      let closureCtrFuns = listArray (1, mAX_DPH_COMBINE) closures
+
+      liftingContext <- liftM (\u -> mkSysLocal (fsLit "lc") u intPrimTy)
                               newUnique
 
       return $ Builtins {
-                 parrayTyCon      = parrayTyCon
+                 dphModules       = modules
+               , parrayTyCon      = parrayTyCon
+               , parrayDataCon    = parrayDataCon
+               , pdataTyCon       = pdataTyCon
                , paTyCon          = paTyCon
                , paDataCon        = paDataCon
                , preprTyCon       = preprTyCon
                , prTyCon          = prTyCon
                , prDataCon        = prDataCon
-               , parrayIntPrimTyCon = parrayIntPrimTyCon
-               , parrayBoolPrimTyCon = parrayBoolPrimTyCon
                , voidTyCon        = voidTyCon
                , wrapTyCon        = wrapTyCon
-               , enumerationTyCon = enumerationTyCon
+               , selTys           = selTys
+               , selReplicates    = selReplicates
+               , selPicks         = selPicks
+               , selTagss         = selTagss
+               , selEls           = selEls
                , sumTyCons        = sumTyCons
                , closureTyCon     = closureTyCon
                , voidVar          = voidVar
-               , mkPRVar          = mkPRVar
-               , mkClosureVar     = mkClosureVar
-               , applyClosureVar  = applyClosureVar
-               , mkClosurePVar    = mkClosurePVar
-               , applyClosurePVar = applyClosurePVar
-               , replicatePAIntPrimVar = replicatePAIntPrimVar
-               , upToPAIntPrimVar = upToPAIntPrimVar
-               , selectPAIntPrimVar = selectPAIntPrimVar
-               , truesPABoolPrimVar = truesPABoolPrimVar
-               , lengthPAVar      = lengthPAVar
-               , replicatePAVar   = replicatePAVar
-               , emptyPAVar       = emptyPAVar
-               , packPAVar        = packPAVar
-               , combinePAVars    = combinePAVars
+               , pvoidVar         = pvoidVar
+               , fromVoidVar      = fromVoidVar
+               , punitVar         = punitVar
+               , closureVar       = closureVar
+               , applyVar         = applyVar
+               , liftedClosureVar = liftedClosureVar
+               , liftedApplyVar   = liftedApplyVar
+               , replicatePDVar   = replicatePDVar
+               , emptyPDVar       = emptyPDVar
+               , packByTagPDVar   = packByTagPDVar
+               , combinePDVars    = combinePDVars
+               , scalarClass      = scalarClass
+               , scalarZips       = scalarZips
+               , closureCtrFuns   = closureCtrFuns
                , liftingContext   = liftingContext
                }
-
+  where
+    modules@(Modules {
+               dph_PArray         = dph_PArray
+             , dph_Repr           = dph_Repr
+             , dph_Closure        = dph_Closure
+             , dph_Selector       = dph_Selector
+             , dph_Scalar         = dph_Scalar
+             })
+      = dph_Modules pkg
+
+    load get_mod = dsLoadModule doc mod
+      where
+        mod = get_mod modules 
+        doc = ppr mod <+> ptext (sLit "is a DPH module")
+
+    -- Make a list of numbered strings in some range, eg foo3, foo4, foo5
+    numbered :: String -> Int -> Int -> [FastString]
+    numbered pfx m n = [mkFastString (pfx ++ show i) | i <- [m..n]]
+
+    mk_elements :: (Int, Int) -> DsM ((Int, Int), CoreExpr)
+    mk_elements (i,j)
+      = do
+          v <- externalVar dph_Selector
+             $ mkFastString ("elementsSel" ++ show i ++ "_" ++ show j ++ "#")
+          return ((i,j), Var v)
+
+
+-- | Get the mapping of names in the Prelude to names in the DPH library.
 initBuiltinVars :: Builtins -> DsM [(Var, Var)]
-initBuiltinVars bi
+initBuiltinVars (Builtins { dphModules = mods })
   = do
       uvars <- zipWithM externalVar umods ufs
       vvars <- zipWithM externalVar vmods vfs
+      cvars <- zipWithM externalVar cmods cfs
       return $ [(v,v) | v <- map dataConWorkId defaultDataConWorkers]
+               ++ zip (map dataConWorkId cons) cvars
                ++ zip uvars vvars
   where
-    (umods, ufs, vmods, vfs) = unzip4 preludeVars
+    (umods, ufs, vmods, vfs) = unzip4 (preludeVars mods)
+    (cons, cmods, cfs)       = unzip3 (preludeDataCons mods)
 
 defaultDataConWorkers :: [DataCon]
-defaultDataConWorkers = [trueDataCon, falseDataCon]
-
-preludeVars :: [(Module, FastString, Module, FastString)]
-preludeVars
-  = [
-      mk nDP_PRELUDE_PARR FSLIT("mapP") nDP_COMBINATORS FSLIT("mapPA")
-    , mk nDP_PRELUDE_INT  FSLIT("plus") nDP_PRELUDE_INT FSLIT("plusV")
-    , mk nDP_PRELUDE_INT  FSLIT("minus") nDP_PRELUDE_INT FSLIT("minusV")
-    ]
+defaultDataConWorkers = [trueDataCon, falseDataCon, unitDataCon]
+
+preludeDataCons :: Modules -> [(DataCon, Module, FastString)]
+preludeDataCons (Modules { dph_Prelude_Tuple = dph_Prelude_Tuple })
+  = [mk_tup n dph_Prelude_Tuple (mkFastString $ "tup" ++ show n) | n <- [2..3]]
   where
-    mk = (,,,)
+    mk_tup n mod name = (tupleCon Boxed n, mod, name)
+
+
+-- | Mapping of prelude functions to vectorised versions.
+--     Functions like filterP currently have a working but naive version in GHC.PArr
+--     During vectorisation we replace these by calls to filterPA, which are
+--     defined in dph-common Data.Array.Parallel.Lifted.Combinators
+--
+--     As renamer only sees the GHC.PArr functions, if you want to add a new function
+--     to the vectoriser there has to be a definition for it in GHC.PArr, even though
+--     it will never be used at runtime.
+--
+preludeVars :: Modules -> [(Module, FastString, Module, FastString)]
+preludeVars (Modules { dph_Combinators    = dph_Combinators
+                     , dph_PArray         = dph_PArray
+                     , dph_Prelude_Int    = dph_Prelude_Int
+                     , dph_Prelude_Word8  = dph_Prelude_Word8
+                     , dph_Prelude_Double = dph_Prelude_Double
+                     , dph_Prelude_Bool   = dph_Prelude_Bool 
+                     , dph_Prelude_PArr   = dph_Prelude_PArr
+                     })
+
+    -- Functions that work on whole PArrays, defined in GHC.PArr
+  = [ mk gHC_PARR (fsLit "mapP")       dph_Combinators (fsLit "mapPA")
+    , mk gHC_PARR (fsLit "zipWithP")   dph_Combinators (fsLit "zipWithPA")
+    , mk gHC_PARR (fsLit "zipP")       dph_Combinators (fsLit "zipPA")
+    , mk gHC_PARR (fsLit "unzipP")     dph_Combinators (fsLit "unzipPA")
+    , mk gHC_PARR (fsLit "filterP")    dph_Combinators (fsLit "filterPA")
+    , mk gHC_PARR (fsLit "lengthP")    dph_Combinators (fsLit "lengthPA")
+    , mk gHC_PARR (fsLit "replicateP") dph_Combinators (fsLit "replicatePA")
+    , mk gHC_PARR (fsLit "!:")         dph_Combinators (fsLit "indexPA")
+    , mk gHC_PARR (fsLit "sliceP")     dph_Combinators (fsLit "slicePA")
+    , mk gHC_PARR (fsLit "crossMapP")  dph_Combinators (fsLit "crossMapPA")
+    , mk gHC_PARR (fsLit "singletonP") dph_Combinators (fsLit "singletonPA")
+    , mk gHC_PARR (fsLit "concatP")    dph_Combinators (fsLit "concatPA")
+    , mk gHC_PARR (fsLit "+:+")        dph_Combinators (fsLit "appPA")
+    , mk gHC_PARR (fsLit "emptyP")     dph_PArray      (fsLit "emptyPA")
+
+    -- Map scalar functions to versions using closures. 
+    , mk' dph_Prelude_Int "div"         "divV"
+    , mk' dph_Prelude_Int "mod"         "modV"
+    , mk' dph_Prelude_Int "sqrt"        "sqrtV"
+    , mk' dph_Prelude_Int "enumFromToP" "enumFromToPA"
+    -- , mk' dph_Prelude_Int "upToP" "upToPA"
+    ]
+    ++ vars_Ord dph_Prelude_Int
+    ++ vars_Num dph_Prelude_Int
+
+    ++ vars_Ord dph_Prelude_Word8
+    ++ vars_Num dph_Prelude_Word8
+    ++
+    [ mk' dph_Prelude_Word8 "div"     "divV"
+    , mk' dph_Prelude_Word8 "mod"     "modV"
+    , mk' dph_Prelude_Word8 "fromInt" "fromIntV"
+    , mk' dph_Prelude_Word8 "toInt"   "toIntV"
+    ]
 
+    ++ vars_Ord        dph_Prelude_Double
+    ++ vars_Num        dph_Prelude_Double
+    ++ vars_Fractional dph_Prelude_Double
+    ++ vars_Floating   dph_Prelude_Double
+    ++ vars_RealFrac   dph_Prelude_Double
+    ++
+    [ mk dph_Prelude_Bool  (fsLit "andP")  dph_Prelude_Bool (fsLit "andPA")
+    , mk dph_Prelude_Bool  (fsLit "orP")   dph_Prelude_Bool (fsLit "orPA")
+
+    -- FIXME: temporary
+    , mk dph_Prelude_PArr (fsLit "fromPArrayP")       dph_Prelude_PArr (fsLit "fromPArrayPA")
+    , mk dph_Prelude_PArr (fsLit "toPArrayP")         dph_Prelude_PArr (fsLit "toPArrayPA")
+    , mk dph_Prelude_PArr (fsLit "fromNestedPArrayP") dph_Prelude_PArr (fsLit "fromNestedPArrayPA")
+    , mk dph_Prelude_PArr (fsLit "combineP")          dph_Combinators  (fsLit "combine2PA")
+    ]
+  where
+    mk  = (,,,)
+    mk' mod v v' = mk mod (fsLit v) mod (fsLit v')
+
+    vars_Ord mod 
+     = [ mk' mod "=="        "eqV"
+       , mk' mod "/="        "neqV"
+       , mk' mod "<="        "leV"
+       , mk' mod "<"         "ltV"
+       , mk' mod ">="        "geV"
+       , mk' mod ">"         "gtV"
+       , mk' mod "min"       "minV"
+       , mk' mod "max"       "maxV"
+       , mk' mod "minimumP"  "minimumPA"
+       , mk' mod "maximumP"  "maximumPA"
+       , mk' mod "minIndexP" "minIndexPA"
+       , mk' mod "maxIndexP" "maxIndexPA"
+       ]
+
+    vars_Num mod 
+     = [ mk' mod "+"        "plusV"
+       , mk' mod "-"        "minusV"
+       , mk' mod "*"        "multV"
+       , mk' mod "negate"   "negateV"
+       , mk' mod "abs"      "absV"
+       , mk' mod "sumP"     "sumPA"
+       , mk' mod "productP" "productPA"
+       ]
+
+    vars_Fractional mod 
+     = [ mk' mod "/"     "divideV"
+       , mk' mod "recip" "recipV"
+       ]
+
+    vars_Floating mod 
+     = [ mk' mod "pi"      "pi"
+       , mk' mod "exp"     "expV"
+       , mk' mod "sqrt"    "sqrtV"
+       , mk' mod "log"     "logV"
+       , mk' mod "sin"     "sinV"
+       , mk' mod "tan"     "tanV"
+       , mk' mod "cos"     "cosV"
+       , mk' mod "asin"    "asinV"
+       , mk' mod "atan"    "atanV"
+       , mk' mod "acos"    "acosV"
+       , mk' mod "sinh"    "sinhV"
+       , mk' mod "tanh"    "tanhV"
+       , mk' mod "cosh"    "coshV"
+       , mk' mod "asinh"   "asinhV"
+       , mk' mod "atanh"   "atanhV"
+       , mk' mod "acosh"   "acoshV"
+       , mk' mod "**"      "powV"
+       , mk' mod "logBase" "logBaseV"
+       ]
+
+    vars_RealFrac mod
+     = [ mk' mod "fromInt"  "fromIntV"
+       , mk' mod "truncate" "truncateV"
+       , mk' mod "round"    "roundV"
+       , mk' mod "ceiling"  "ceilingV"
+       , mk' mod "floor"    "floorV"
+       ]
+
+
+-- | Get a list of names to `TyCon`s in the mock prelude.
 initBuiltinTyCons :: Builtins -> DsM [(Name, TyCon)]
 initBuiltinTyCons bi
   = do
-      parr <- externalTyCon nDP_PRELUDE_PARR FSLIT("PArr")
+      -- parr <- externalTyCon dph_Prelude_PArr (fsLit "PArr")
+      dft_tcs <- defaultTyCons
       return $ (tyConName funTyCon, closureTyCon bi)
-             : (tyConName parr,     parrayTyCon bi)
-             : [(tyConName tc, tc) | tc <- defaultTyCons]
+             : (parrTyConName,      parrayTyCon bi)
+
+             -- FIXME: temporary
+             : (tyConName $ parrayTyCon bi, parrayTyCon bi)
 
-defaultTyCons :: [TyCon]
-defaultTyCons = [intTyCon, boolTyCon]
+             : [(tyConName tc, tc) | tc <- dft_tcs]
 
+defaultTyCons :: DsM [TyCon]
+defaultTyCons
+  = do
+      word8 <- dsLookupTyCon word8TyConName
+      return [intTyCon, boolTyCon, doubleTyCon, word8]
+
+
+-- | Get a list of names to `DataCon`s in the mock prelude.
 initBuiltinDataCons :: Builtins -> [(Name, DataCon)]
-initBuiltinDataCons bi = [(dataConName dc, dc)| dc <- defaultDataCons]
+initBuiltinDataCons _ = [(dataConName dc, dc)| dc <- defaultDataCons]
 
 defaultDataCons :: [DataCon]
-defaultDataCons = [trueDataCon, falseDataCon]
+defaultDataCons = [trueDataCon, falseDataCon, unitDataCon]
 
-initBuiltinDicts :: [(Name, Module, FastString)] -> DsM [(Name, Var)]
-initBuiltinDicts ps
-  = do
-      dicts <- zipWithM externalVar mods fss
-      return $ zip tcs dicts
-  where
-    (tcs, mods, fss) = unzip3 ps
 
-initBuiltinPAs = initBuiltinDicts . builtinPAs
+-- | Get the names of all buildin instance functions for the PA class.
+initBuiltinPAs :: Builtins -> (InstEnv, InstEnv) -> DsM [(Name, Var)]
+initBuiltinPAs (Builtins { dphModules = mods }) insts
+  = liftM (initBuiltinDicts insts) (externalClass (dph_PArray mods) (fsLit "PA"))
 
-builtinPAs :: Builtins -> [(Name, Module, FastString)]
-builtinPAs bi
-  = [
-      mk (tyConName $ closureTyCon bi)  nDP_CLOSURE     FSLIT("dPA_Clo")
-    , mk (tyConName $ voidTyCon bi)     nDP_REPR        FSLIT("dPA_Void")
-    , mk (tyConName $ parrayTyCon bi)   nDP_INSTANCES   FSLIT("dPA_PArray")
-    , mk unitTyConName                  nDP_INSTANCES   FSLIT("dPA_Unit")
 
-    , mk intTyConName                   nDP_INSTANCES   FSLIT("dPA_Int")
-    , mk boolTyConName                  nDP_INSTANCES   FSLIT("dPA_Bool")
-    ]
-    ++ tups
-  where
-    mk name mod fs = (name, mod, fs)
-
-    tups = map mk_tup [2..3]
-    mk_tup n = mk (tyConName $ tupleTyCon Boxed n)
-                  nDP_INSTANCES
-                  (mkFastString $ "dPA_" ++ show n)
-
-initBuiltinPRs = initBuiltinDicts . builtinPRs
-
-builtinPRs :: Builtins -> [(Name, Module, FastString)]
-builtinPRs bi =
-  [
-    mk (tyConName unitTyCon)          nDP_REPR      FSLIT("dPR_Unit")
-  , mk (tyConName $ voidTyCon bi)     nDP_REPR      FSLIT("dPR_Void")
-  , mk (tyConName $ wrapTyCon bi)     nDP_REPR      FSLIT("dPR_Wrap")
-  , mk (tyConName $ enumerationTyCon bi) nDP_REPR   FSLIT("dPR_Enumeration")
-  , mk (tyConName $ closureTyCon bi)  nDP_CLOSURE   FSLIT("dPR_Clo")
-
-    -- temporary
-  , mk intTyConName          nDP_INSTANCES FSLIT("dPR_Int")
-  ]
-
-  ++ map mk_sum  [2..mAX_NDP_SUM]
-  ++ map mk_prod [2..mAX_NDP_PROD]
-  where
-    mk name mod fs = (name, mod, fs)
+-- | Get the names of all builtin instance functions for the PR class.
+initBuiltinPRs :: Builtins -> (InstEnv, InstEnv) -> DsM [(Name, Var)]
+initBuiltinPRs (Builtins { dphModules = mods }) insts
+  = liftM (initBuiltinDicts insts) (externalClass (dph_PArray mods) (fsLit "PR"))
+
 
-    mk_sum n = (tyConName $ sumTyCon n bi, nDP_REPR,
-                mkFastString ("dPR_Sum" ++ show n))
+-- | Get the names of all DPH instance functions for this class.
+initBuiltinDicts :: (InstEnv, InstEnv) -> Class -> [(Name, Var)]
+initBuiltinDicts insts cls = map find $ classInstances insts cls
+  where
+    find i | [Just tc] <- instanceRoughTcs i   = (tc, instanceDFunId i)
+           | otherwise                         = pprPanic "Invalid DPH instance" (ppr i)
 
-    mk_prod n = (tyConName $ prodTyCon n bi, nDP_REPR,
-                 mkFastString ("dPR_" ++ show n))
 
+-- | Get a list of boxed `TyCons` in the mock prelude. This is Int only.
 initBuiltinBoxedTyCons :: Builtins -> DsM [(Name, TyCon)]
 initBuiltinBoxedTyCons = return . builtinBoxedTyCons
 
 builtinBoxedTyCons :: Builtins -> [(Name, TyCon)]
-builtinBoxedTyCons bi =
-  [(tyConName intPrimTyCon, intTyCon)]
+builtinBoxedTyCons _ 
+  = [(tyConName intPrimTyCon, intTyCon)]
+
+
+-- | Get a list of all scalar functions in the mock prelude.
+initBuiltinScalars :: Builtins -> DsM [Var]
+initBuiltinScalars bi
+  = mapM (uncurry externalVar) (preludeScalars $ dphModules bi)
+
 
+preludeScalars :: Modules -> [(Module, FastString)]
+preludeScalars (Modules { dph_Prelude_Int    = dph_Prelude_Int
+                        , dph_Prelude_Word8  = dph_Prelude_Word8
+                        , dph_Prelude_Double = dph_Prelude_Double
+                        })
+  = [ mk dph_Prelude_Int "div"
+    , mk dph_Prelude_Int "mod"
+    , mk dph_Prelude_Int "sqrt"
+    ]
+    ++ scalars_Ord dph_Prelude_Int
+    ++ scalars_Num dph_Prelude_Int
+
+    ++ scalars_Ord dph_Prelude_Word8
+    ++ scalars_Num dph_Prelude_Word8
+    ++
+    [ mk dph_Prelude_Word8 "div"
+    , mk dph_Prelude_Word8 "mod"
+    , mk dph_Prelude_Word8 "fromInt"
+    , mk dph_Prelude_Word8 "toInt"
+    ]
+
+    ++ scalars_Ord dph_Prelude_Double
+    ++ scalars_Num dph_Prelude_Double
+    ++ scalars_Fractional dph_Prelude_Double
+    ++ scalars_Floating dph_Prelude_Double
+    ++ scalars_RealFrac dph_Prelude_Double
+  where
+    mk mod s = (mod, fsLit s)
+
+    scalars_Ord mod 
+     = [ mk mod "=="
+       , mk mod "/="
+       , mk mod "<="
+       , mk mod "<"
+       , mk mod ">="
+       , mk mod ">"
+       , mk mod "min"
+       , mk mod "max"
+       ]
+
+    scalars_Num mod 
+     = [ mk mod "+"
+       , mk mod "-"
+       , mk mod "*"
+       , mk mod "negate"
+       , mk mod "abs"
+       ]
+
+    scalars_Fractional mod 
+     = [ mk mod "/"
+       , mk mod "recip"
+       ]
+
+    scalars_Floating mod 
+     = [ mk mod "pi"
+       , mk mod "exp"
+       , mk mod "sqrt"
+       , mk mod "log"
+       , mk mod "sin"
+       , mk mod "tan"
+       , mk mod "cos"
+       , mk mod "asin"
+       , mk mod "atan"
+       , mk mod "acos"
+       , mk mod "sinh"
+       , mk mod "tanh"
+       , mk mod "cosh"
+       , mk mod "asinh"
+       , mk mod "atanh"
+       , mk mod "acosh"
+       , mk mod "**"
+       , mk mod "logBase"
+       ]
+
+    scalars_RealFrac mod 
+     = [ mk mod "fromInt"
+       , mk mod "truncate"
+       , mk mod "round"
+       , mk mod "ceiling"
+       , mk mod "floor"
+       ]
+
+
+-- | Lookup some variable given its name and the module that contains it.
 externalVar :: Module -> FastString -> DsM Var
 externalVar mod fs
   = dsLookupGlobalId =<< lookupOrig mod (mkVarOccFS fs)
 
+
+-- | Like `externalVar` but wrap the `Var` in a `CoreExpr`
+externalFun :: Module -> FastString -> DsM CoreExpr
+externalFun mod fs
+ = do var <- externalVar mod fs
+      return $ Var var
+
+
+-- | Lookup some `TyCon` given its name and the module that contains it.
 externalTyCon :: Module -> FastString -> DsM TyCon
 externalTyCon mod fs
-  = dsLookupTyCon =<< lookupOrig mod (mkOccNameFS tcName fs)
+  = dsLookupTyCon =<< lookupOrig mod (mkTcOccFS fs)
 
-unitTyConName = tyConName unitTyCon
 
+-- | Lookup some `Type` given its name and the module that contains it.
+externalType :: Module -> FastString -> DsM Type
+externalType mod fs
+ = do  tycon <- externalTyCon mod fs
+       return $ mkTyConApp tycon []
 
-primMethod :: TyCon -> String -> DsM (Maybe Var)
-primMethod tycon method
+
+-- | Lookup some `Class` given its name and the module that contains it.
+externalClass :: Module -> FastString -> DsM Class
+externalClass mod fs
+  = dsLookupClass =<< lookupOrig mod (mkClsOccFS fs)
+
+
+-- | Like `externalClass`, but get the TyCon of of the class.
+externalClassTyCon :: Module -> FastString -> DsM TyCon
+externalClassTyCon mod fs = liftM classTyCon (externalClass mod fs)
+
+
+-- | Lookup a method function given its name and instance type.
+primMethod :: TyCon -> String -> Builtins -> DsM (Maybe Var)
+primMethod  tycon method (Builtins { dphModules = mods })
   | Just suffix <- lookupNameEnv prim_ty_cons (tyConName tycon)
   = liftM Just
-  $ dsLookupGlobalId =<< lookupOrig nDP_PRIM (mkVarOcc $ method ++ suffix)
+  $ dsLookupGlobalId =<< lookupOrig (dph_Unboxed mods)
+                                    (mkVarOcc $ method ++ suffix)
 
   | otherwise = return Nothing
 
-primPArray :: TyCon -> DsM (Maybe TyCon)
-primPArray tycon
+-- | Lookup the representation type we use for PArrays that contain a given element type.
+primPArray :: TyCon -> Builtins -> DsM (Maybe TyCon)
+primPArray tycon (Builtins { dphModules = mods })
   | Just suffix <- lookupNameEnv prim_ty_cons (tyConName tycon)
   = liftM Just
-  $ dsLookupTyCon =<< lookupOrig nDP_PRIM (mkOccName tcName $ "PArray" ++ suffix)
+  $ dsLookupTyCon =<< lookupOrig (dph_Unboxed mods)
+                                 (mkTcOcc $ "PArray" ++ suffix)
 
   | otherwise = return Nothing
 
+prim_ty_cons :: NameEnv String
 prim_ty_cons = mkNameEnv [mk_prim intPrimTyCon]
   where
     mk_prim tycon = (tyConName tycon, '_' : getOccString tycon)
+