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