compiler/vectorise/VectBuiltIn.hs

   1 {-# OPTIONS -w #-}
   2 -- The above warning supression flag is a temporary kludge.
   3 -- While working on this module you are encouraged to remove it and fix
   4 -- any warnings in the module. See
   5 --     http://hackage.haskell.org/trac/ghc/wiki/Commentary/CodingStyle#Warnings
   6 -- for details
   7
   8 module VectBuiltIn (
   9   Builtins(..), sumTyCon, prodTyCon, combinePAVar,
  10   initBuiltins, initBuiltinTyCons, initBuiltinPAs, initBuiltinPRs,
  11   initBuiltinBoxedTyCons,
  12
  13   primMethod, primPArray
  14 ) where
  15
  16 #include "HsVersions.h"
  17
  18 import DsMonad
  19 import IfaceEnv        ( lookupOrig )
  20
  21 import Module          ( Module )
  22 import DataCon         ( DataCon )
  23 import TyCon           ( TyCon, tyConName, tyConDataCons )
  24 import Var             ( Var )
  25 import Id              ( mkSysLocal )
  26 import Name            ( Name, getOccString )
  27 import NameEnv
  28 import OccName
  29
  30 import TypeRep         ( funTyCon )
  31 import Type            ( Type )
  32 import TysPrim
  33 import TysWiredIn      ( unitTyCon, tupleTyCon, intTyCon, intTyConName )
  34 import Module
  35 import BasicTypes      ( Boxity(..) )
  36
  37 import FastString
  38 import Outputable
  39
  40 import Data.Array
  41 import Control.Monad   ( liftM, zipWithM )
  42
  43 mAX_NDP_PROD :: Int
  44 mAX_NDP_PROD = 3
  45
  46 mAX_NDP_SUM :: Int
  47 mAX_NDP_SUM = 3
  48
  49 mAX_NDP_COMBINE :: Int
  50 mAX_NDP_COMBINE = 2
  51
  52 mkNDPModule :: FastString -> Module
  53 mkNDPModule m = mkModule ndpPackageId (mkModuleNameFS m)
  54
  55 nDP_PARRAY      = mkNDPModule FSLIT("Data.Array.Parallel.Lifted.PArray")
  56 nDP_REPR        = mkNDPModule FSLIT("Data.Array.Parallel.Lifted.Repr")
  57 nDP_CLOSURE     = mkNDPModule FSLIT("Data.Array.Parallel.Lifted.Closure")
  58 nDP_PRIM        = mkNDPModule FSLIT("Data.Array.Parallel.Lifted.Prim")
  59 nDP_INSTANCES   = mkNDPModule FSLIT("Data.Array.Parallel.Lifted.Instances")
  60
  61 data Builtins = Builtins {
  62                   parrayTyCon      :: TyCon
  63                 , paTyCon          :: TyCon
  64                 , paDataCon        :: DataCon
  65                 , preprTyCon       :: TyCon
  66                 , prTyCon          :: TyCon
  67                 , prDataCon        :: DataCon
  68                 , parrayIntPrimTyCon :: TyCon
  69                 , parrayBoolPrimTyCon :: TyCon
  70                 , voidTyCon        :: TyCon
  71                 , wrapTyCon        :: TyCon
  72                 , sumTyCons        :: Array Int TyCon
  73                 , closureTyCon     :: TyCon
  74                 , voidVar          :: Var
  75                 , mkPRVar          :: Var
  76                 , mkClosureVar     :: Var
  77                 , applyClosureVar  :: Var
  78                 , mkClosurePVar    :: Var
  79                 , applyClosurePVar :: Var
  80                 , replicatePAIntPrimVar :: Var
  81                 , upToPAIntPrimVar :: Var
  82                 , selectPAIntPrimVar :: Var
  83                 , truesPABoolPrimVar :: Var
  84                 , lengthPAVar      :: Var
  85                 , replicatePAVar   :: Var
  86                 , emptyPAVar       :: Var
  87                 , packPAVar        :: Var
  88                 , combinePAVars    :: Array Int Var
  89                 , liftingContext   :: Var
  90                 }
  91
  92 sumTyCon :: Int -> Builtins -> TyCon
  93 sumTyCon n bi
  94   | n >= 2 && n <= mAX_NDP_SUM = sumTyCons bi ! n
  95   | otherwise = pprPanic "sumTyCon" (ppr n)
  96
  97 prodTyCon :: Int -> Builtins -> TyCon
  98 prodTyCon n bi
  99   | n == 1                      = wrapTyCon bi
 100   | n >= 0 && n <= mAX_NDP_PROD = tupleTyCon Boxed n
 101   | otherwise = pprPanic "prodTyCon" (ppr n)
 102
 103 combinePAVar :: Int -> Builtins -> Var
 104 combinePAVar n bi
 105   | n >= 2 && n <= mAX_NDP_COMBINE = combinePAVars bi ! n
 106   | otherwise = pprPanic "combinePAVar" (ppr n)
 107
 108 initBuiltins :: DsM Builtins
 109 initBuiltins
 110   = do
 111       parrayTyCon  <- externalTyCon nDP_PARRAY FSLIT("PArray")
 112       paTyCon      <- externalTyCon nDP_PARRAY FSLIT("PA")
 113       let [paDataCon] = tyConDataCons paTyCon
 114       preprTyCon   <- externalTyCon nDP_PARRAY FSLIT("PRepr")
 115       prTyCon      <- externalTyCon nDP_PARRAY FSLIT("PR")
 116       let [prDataCon] = tyConDataCons prTyCon
 117       parrayIntPrimTyCon <- externalTyCon nDP_PRIM FSLIT("PArray_Int#")
 118       parrayBoolPrimTyCon <- externalTyCon nDP_PRIM FSLIT("PArray_Bool#")
 119       closureTyCon <- externalTyCon nDP_CLOSURE FSLIT(":->")
 120
 121       voidTyCon    <- externalTyCon nDP_REPR FSLIT("Void")
 122       wrapTyCon    <- externalTyCon nDP_REPR FSLIT("Wrap")
 123       sum_tcs <- mapM (externalTyCon nDP_REPR)
 124                       [mkFastString ("Sum" ++ show i) | i <- [2..mAX_NDP_SUM]]
 125
 126       let sumTyCons = listArray (2, mAX_NDP_SUM) sum_tcs
 127
 128       voidVar          <- externalVar nDP_REPR FSLIT("void")
 129       mkPRVar          <- externalVar nDP_PARRAY FSLIT("mkPR")
 130       mkClosureVar     <- externalVar nDP_CLOSURE FSLIT("mkClosure")
 131       applyClosureVar  <- externalVar nDP_CLOSURE FSLIT("$:")
 132       mkClosurePVar    <- externalVar nDP_CLOSURE FSLIT("mkClosureP")
 133       applyClosurePVar <- externalVar nDP_CLOSURE FSLIT("$:^")
 134       replicatePAIntPrimVar <- externalVar nDP_PRIM FSLIT("replicatePA_Int#")
 135       upToPAIntPrimVar <- externalVar nDP_PRIM FSLIT("upToPA_Int#")
 136       selectPAIntPrimVar <- externalVar nDP_PRIM FSLIT("selectPA_Int#")
 137       truesPABoolPrimVar <- externalVar nDP_PRIM FSLIT("truesPA_Bool#")
 138       lengthPAVar      <- externalVar nDP_PARRAY FSLIT("lengthPA")
 139       replicatePAVar   <- externalVar nDP_PARRAY FSLIT("replicatePA")
 140       emptyPAVar       <- externalVar nDP_PARRAY FSLIT("emptyPA")
 141       packPAVar        <- externalVar nDP_PARRAY FSLIT("packPA")
 142
 143       combines <- mapM (externalVar nDP_PARRAY)
 144                        [mkFastString ("combine" ++ show i ++ "PA")
 145                           | i <- [2..mAX_NDP_COMBINE]]
 146       let combinePAVars = listArray (2, mAX_NDP_COMBINE) combines
 147
 148       liftingContext <- liftM (\u -> mkSysLocal FSLIT("lc") u intPrimTy)
 149                               newUnique
 150
 151       return $ Builtins {
 152                  parrayTyCon      = parrayTyCon
 153                , paTyCon          = paTyCon
 154                , paDataCon        = paDataCon
 155                , preprTyCon       = preprTyCon
 156                , prTyCon          = prTyCon
 157                , prDataCon        = prDataCon
 158                , parrayIntPrimTyCon = parrayIntPrimTyCon
 159                , parrayBoolPrimTyCon = parrayBoolPrimTyCon
 160                , voidTyCon        = voidTyCon
 161                , wrapTyCon        = wrapTyCon
 162                , sumTyCons        = sumTyCons
 163                , closureTyCon     = closureTyCon
 164                , voidVar          = voidVar
 165                , mkPRVar          = mkPRVar
 166                , mkClosureVar     = mkClosureVar
 167                , applyClosureVar  = applyClosureVar
 168                , mkClosurePVar    = mkClosurePVar
 169                , applyClosurePVar = applyClosurePVar
 170                , replicatePAIntPrimVar = replicatePAIntPrimVar
 171                , upToPAIntPrimVar = upToPAIntPrimVar
 172                , selectPAIntPrimVar = selectPAIntPrimVar
 173                , truesPABoolPrimVar = truesPABoolPrimVar
 174                , lengthPAVar      = lengthPAVar
 175                , replicatePAVar   = replicatePAVar
 176                , emptyPAVar       = emptyPAVar
 177                , packPAVar        = packPAVar
 178                , combinePAVars    = combinePAVars
 179                , liftingContext   = liftingContext
 180                }
 181
 182 initBuiltinTyCons :: Builtins -> [(Name, TyCon)]
 183 initBuiltinTyCons bi = (tyConName funTyCon, closureTyCon bi)
 184                      : [(tyConName tc, tc) | tc <- defaultTyCons]
 185
 186 defaultTyCons :: [TyCon]
 187 defaultTyCons = [intTyCon]
 188
 189 initBuiltinDicts :: [(Name, Module, FastString)] -> DsM [(Name, Var)]
 190 initBuiltinDicts ps
 191   = do
 192       dicts <- zipWithM externalVar mods fss
 193       return $ zip tcs dicts
 194   where
 195     (tcs, mods, fss) = unzip3 ps
 196
 197 initBuiltinPAs = initBuiltinDicts . builtinPAs
 198
 199 builtinPAs :: Builtins -> [(Name, Module, FastString)]
 200 builtinPAs bi
 201   = [
 202       mk (tyConName $ closureTyCon bi)  nDP_CLOSURE     FSLIT("dPA_Clo")
 203     , mk (tyConName $ voidTyCon bi)     nDP_REPR        FSLIT("dPA_Void")
 204     , mk unitTyConName                  nDP_INSTANCES   FSLIT("dPA_Unit")
 205
 206     , mk intTyConName                   nDP_INSTANCES   FSLIT("dPA_Int")
 207     ]
 208     ++ tups
 209   where
 210     mk name mod fs = (name, mod, fs)
 211
 212     tups = map mk_tup [2..3]
 213     mk_tup n = mk (tyConName $ tupleTyCon Boxed n)
 214                   nDP_INSTANCES
 215                   (mkFastString $ "dPA_" ++ show n)
 216
 217 initBuiltinPRs = initBuiltinDicts . builtinPRs
 218
 219 builtinPRs :: Builtins -> [(Name, Module, FastString)]
 220 builtinPRs bi =
 221   [
 222     mk (tyConName unitTyCon)          nDP_REPR      FSLIT("dPR_Unit")
 223   , mk (tyConName $ voidTyCon bi)     nDP_REPR      FSLIT("dPR_Void")
 224   , mk (tyConName $ wrapTyCon bi)     nDP_REPR      FSLIT("dPR_Wrap")
 225   , mk (tyConName $ closureTyCon bi)  nDP_CLOSURE   FSLIT("dPR_Clo")
 226
 227     -- temporary
 228   , mk intTyConName          nDP_INSTANCES FSLIT("dPR_Int")
 229   ]
 230
 231   ++ map mk_sum  [2..mAX_NDP_SUM]
 232   ++ map mk_prod [2..mAX_NDP_PROD]
 233   where
 234     mk name mod fs = (name, mod, fs)
 235
 236     mk_sum n = (tyConName $ sumTyCon n bi, nDP_REPR,
 237                 mkFastString ("dPR_Sum" ++ show n))
 238
 239     mk_prod n = (tyConName $ prodTyCon n bi, nDP_REPR,
 240                  mkFastString ("dPR_" ++ show n))
 241
 242 initBuiltinBoxedTyCons :: Builtins -> DsM [(Name, TyCon)]
 243 initBuiltinBoxedTyCons = return . builtinBoxedTyCons
 244
 245 builtinBoxedTyCons :: Builtins -> [(Name, TyCon)]
 246 builtinBoxedTyCons bi =
 247   [(tyConName intPrimTyCon, intTyCon)]
 248
 249 externalVar :: Module -> FastString -> DsM Var
 250 externalVar mod fs
 251   = dsLookupGlobalId =<< lookupOrig mod (mkVarOccFS fs)
 252
 253 externalTyCon :: Module -> FastString -> DsM TyCon
 254 externalTyCon mod fs
 255   = dsLookupTyCon =<< lookupOrig mod (mkOccNameFS tcName fs)
 256
 257 unitTyConName = tyConName unitTyCon
 258
 259
 260 primMethod :: TyCon -> String -> DsM (Maybe Var)
 261 primMethod tycon method
 262   | Just suffix <- lookupNameEnv prim_ty_cons (tyConName tycon)
 263   = liftM Just
 264   $ dsLookupGlobalId =<< lookupOrig nDP_PRIM (mkVarOcc $ method ++ suffix)
 265
 266   | otherwise = return Nothing
 267
 268 primPArray :: TyCon -> DsM (Maybe TyCon)
 269 primPArray tycon
 270   | Just suffix <- lookupNameEnv prim_ty_cons (tyConName tycon)
 271   = liftM Just
 272   $ dsLookupTyCon =<< lookupOrig nDP_PRIM (mkOccName tcName $ "PArray" ++ suffix)
 273
 274   | otherwise = return Nothing
 275
 276 prim_ty_cons = mkNameEnv [mk_prim intPrimTyCon]
 277   where
 278     mk_prim tycon = (tyConName tycon, '_' : getOccString tycon)