compiler/vectorise/VectBuiltIn.hs

   1 module VectBuiltIn (
   2   Builtins(..), sumTyCon, prodTyCon, uarrTy, intPrimArrayTy,
   3   combinePAVar,
   4   initBuiltins, initBuiltinVars, initBuiltinTyCons, initBuiltinDataCons,
   5   initBuiltinPAs, initBuiltinPRs,
   6   initBuiltinBoxedTyCons,
   7
   8   primMethod, primPArray
   9 ) where
  10
  11 #include "HsVersions.h"
  12
  13 import DsMonad
  14 import IfaceEnv        ( lookupOrig )
  15
  16 import Module
  17 import DataCon         ( DataCon, dataConName, dataConWorkId )
  18 import TyCon           ( TyCon, tyConName, tyConDataCons )
  19 import Var             ( Var )
  20 import Id              ( mkSysLocal )
  21 import Name            ( Name, getOccString )
  22 import NameEnv
  23 import OccName
  24
  25 import TypeRep         ( funTyCon )
  26 import Type            ( Type, mkTyConApp )
  27 import TysPrim
  28 import TysWiredIn      ( unitTyCon, unitDataCon,
  29                          tupleTyCon,
  30                          intTyCon, intTyConName, intTy,
  31                          doubleTyCon, doubleTyConName,
  32                          boolTyCon, boolTyConName, trueDataCon, falseDataCon,
  33                          parrTyConName )
  34 import PrelNames       ( gHC_PARR )
  35 import BasicTypes      ( Boxity(..) )
  36
  37 import FastString
  38 import Outputable
  39
  40 import Data.Array
  41 import Control.Monad   ( liftM, zipWithM )
  42 import Data.List       ( unzip4 )
  43
  44 mAX_NDP_PROD :: Int
  45 mAX_NDP_PROD = 5
  46
  47 mAX_NDP_SUM :: Int
  48 mAX_NDP_SUM = 3
  49
  50 mAX_NDP_COMBINE :: Int
  51 mAX_NDP_COMBINE = 2
  52
  53 mkNDPModule :: FastString -> Module
  54 mkNDPModule m = mkModule ndpPackageId (mkModuleNameFS m)
  55
  56 nDP_UARR, nDP_PARRAY, nDP_REPR, nDP_CLOSURE, nDP_UNBOXED, nDP_INSTANCES, nDP_COMBINATORS,
  57     nDP_PRELUDE_PARR, nDP_PRELUDE_INT, nDP_PRELUDE_DOUBLE :: Module
  58
  59 nDP_UARR        = mkNDPModule FSLIT("Data.Array.Parallel.Unlifted.Flat.UArr")
  60 nDP_PARRAY      = mkNDPModule FSLIT("Data.Array.Parallel.Lifted.PArray")
  61 nDP_REPR        = mkNDPModule FSLIT("Data.Array.Parallel.Lifted.Repr")
  62 nDP_CLOSURE     = mkNDPModule FSLIT("Data.Array.Parallel.Lifted.Closure")
  63 nDP_UNBOXED     = mkNDPModule FSLIT("Data.Array.Parallel.Lifted.Unboxed")
  64 nDP_INSTANCES   = mkNDPModule FSLIT("Data.Array.Parallel.Lifted.Instances")
  65 nDP_COMBINATORS = mkNDPModule FSLIT("Data.Array.Parallel.Lifted.Combinators")
  66
  67 nDP_PRELUDE_PARR = mkNDPModule FSLIT("Data.Array.Parallel.Prelude.Base.PArr")
  68 nDP_PRELUDE_INT  = mkNDPModule FSLIT("Data.Array.Parallel.Prelude.Base.Int")
  69 nDP_PRELUDE_DOUBLE = mkNDPModule FSLIT("Data.Array.Parallel.Prelude.Base.Double")
  70
  71 data Builtins = Builtins {
  72                   parrayTyCon      :: TyCon
  73                 , paTyCon          :: TyCon
  74                 , paDataCon        :: DataCon
  75                 , preprTyCon       :: TyCon
  76                 , prTyCon          :: TyCon
  77                 , prDataCon        :: DataCon
  78                 , uarrTyCon        :: TyCon
  79                 , voidTyCon        :: TyCon
  80                 , wrapTyCon        :: TyCon
  81                 , enumerationTyCon :: TyCon
  82                 , sumTyCons        :: Array Int TyCon
  83                 , closureTyCon     :: TyCon
  84                 , voidVar          :: Var
  85                 , mkPRVar          :: Var
  86                 , mkClosureVar     :: Var
  87                 , applyClosureVar  :: Var
  88                 , mkClosurePVar    :: Var
  89                 , applyClosurePVar :: Var
  90                 , replicatePAIntPrimVar :: Var
  91                 , upToPAIntPrimVar :: Var
  92                 , selectPAIntPrimVar :: Var
  93                 , truesPABoolPrimVar :: Var
  94                 , lengthPAVar      :: Var
  95                 , replicatePAVar   :: Var
  96                 , emptyPAVar       :: Var
  97                 , packPAVar        :: Var
  98                 , combinePAVars    :: Array Int Var
  99                 , liftingContext   :: Var
 100                 }
 101
 102 uarrTy :: Type -> Builtins -> Type
 103 uarrTy ty bi = mkTyConApp (uarrTyCon bi) [ty]
 104
 105 intPrimArrayTy :: Builtins -> Type
 106 intPrimArrayTy = uarrTy intTy
 107
 108 sumTyCon :: Int -> Builtins -> TyCon
 109 sumTyCon n bi
 110   | n >= 2 && n <= mAX_NDP_SUM = sumTyCons bi ! n
 111   | otherwise = pprPanic "sumTyCon" (ppr n)
 112
 113 prodTyCon :: Int -> Builtins -> TyCon
 114 prodTyCon n bi
 115   | n == 1                      = wrapTyCon bi
 116   | n >= 0 && n <= mAX_NDP_PROD = tupleTyCon Boxed n
 117   | otherwise = pprPanic "prodTyCon" (ppr n)
 118
 119 combinePAVar :: Int -> Builtins -> Var
 120 combinePAVar n bi
 121   | n >= 2 && n <= mAX_NDP_COMBINE = combinePAVars bi ! n
 122   | otherwise = pprPanic "combinePAVar" (ppr n)
 123
 124 initBuiltins :: DsM Builtins
 125 initBuiltins
 126   = do
 127       parrayTyCon  <- externalTyCon nDP_PARRAY FSLIT("PArray")
 128       paTyCon      <- externalTyCon nDP_PARRAY FSLIT("PA")
 129       let [paDataCon] = tyConDataCons paTyCon
 130       preprTyCon   <- externalTyCon nDP_PARRAY FSLIT("PRepr")
 131       prTyCon      <- externalTyCon nDP_PARRAY FSLIT("PR")
 132       let [prDataCon] = tyConDataCons prTyCon
 133       uarrTyCon    <- externalTyCon nDP_UARR   FSLIT("UArr")
 134       closureTyCon <- externalTyCon nDP_CLOSURE FSLIT(":->")
 135
 136       voidTyCon    <- externalTyCon nDP_REPR FSLIT("Void")
 137       wrapTyCon    <- externalTyCon nDP_REPR FSLIT("Wrap")
 138       enumerationTyCon <- externalTyCon nDP_REPR FSLIT("Enumeration")
 139       sum_tcs <- mapM (externalTyCon nDP_REPR)
 140                       [mkFastString ("Sum" ++ show i) | i <- [2..mAX_NDP_SUM]]
 141
 142       let sumTyCons = listArray (2, mAX_NDP_SUM) sum_tcs
 143
 144       voidVar          <- externalVar nDP_REPR FSLIT("void")
 145       mkPRVar          <- externalVar nDP_PARRAY FSLIT("mkPR")
 146       mkClosureVar     <- externalVar nDP_CLOSURE FSLIT("mkClosure")
 147       applyClosureVar  <- externalVar nDP_CLOSURE FSLIT("$:")
 148       mkClosurePVar    <- externalVar nDP_CLOSURE FSLIT("mkClosureP")
 149       applyClosurePVar <- externalVar nDP_CLOSURE FSLIT("$:^")
 150       replicatePAIntPrimVar <- externalVar nDP_UNBOXED FSLIT("replicatePA_Int#")
 151       upToPAIntPrimVar <- externalVar nDP_UNBOXED FSLIT("upToPA_Int#")
 152       selectPAIntPrimVar <- externalVar nDP_UNBOXED FSLIT("selectPA_Int#")
 153       truesPABoolPrimVar <- externalVar nDP_UNBOXED FSLIT("truesPA_Bool#")
 154       lengthPAVar      <- externalVar nDP_PARRAY FSLIT("lengthPA#")
 155       replicatePAVar   <- externalVar nDP_PARRAY FSLIT("replicatePA#")
 156       emptyPAVar       <- externalVar nDP_PARRAY FSLIT("emptyPA")
 157       packPAVar        <- externalVar nDP_PARRAY FSLIT("packPA#")
 158
 159       combines <- mapM (externalVar nDP_PARRAY)
 160                        [mkFastString ("combine" ++ show i ++ "PA#")
 161                           | i <- [2..mAX_NDP_COMBINE]]
 162       let combinePAVars = listArray (2, mAX_NDP_COMBINE) combines
 163
 164       liftingContext <- liftM (\u -> mkSysLocal FSLIT("lc") u intPrimTy)
 165                               newUnique
 166
 167       return $ Builtins {
 168                  parrayTyCon      = parrayTyCon
 169                , paTyCon          = paTyCon
 170                , paDataCon        = paDataCon
 171                , preprTyCon       = preprTyCon
 172                , prTyCon          = prTyCon
 173                , prDataCon        = prDataCon
 174                , uarrTyCon        = uarrTyCon
 175                , voidTyCon        = voidTyCon
 176                , wrapTyCon        = wrapTyCon
 177                , enumerationTyCon = enumerationTyCon
 178                , sumTyCons        = sumTyCons
 179                , closureTyCon     = closureTyCon
 180                , voidVar          = voidVar
 181                , mkPRVar          = mkPRVar
 182                , mkClosureVar     = mkClosureVar
 183                , applyClosureVar  = applyClosureVar
 184                , mkClosurePVar    = mkClosurePVar
 185                , applyClosurePVar = applyClosurePVar
 186                , replicatePAIntPrimVar = replicatePAIntPrimVar
 187                , upToPAIntPrimVar = upToPAIntPrimVar
 188                , selectPAIntPrimVar = selectPAIntPrimVar
 189                , truesPABoolPrimVar = truesPABoolPrimVar
 190                , lengthPAVar      = lengthPAVar
 191                , replicatePAVar   = replicatePAVar
 192                , emptyPAVar       = emptyPAVar
 193                , packPAVar        = packPAVar
 194                , combinePAVars    = combinePAVars
 195                , liftingContext   = liftingContext
 196                }
 197
 198 initBuiltinVars :: Builtins -> DsM [(Var, Var)]
 199 initBuiltinVars _
 200   = do
 201       uvars <- zipWithM externalVar umods ufs
 202       vvars <- zipWithM externalVar vmods vfs
 203       return $ [(v,v) | v <- map dataConWorkId defaultDataConWorkers]
 204                ++ zip uvars vvars
 205   where
 206     (umods, ufs, vmods, vfs) = unzip4 preludeVars
 207
 208 defaultDataConWorkers :: [DataCon]
 209 defaultDataConWorkers = [trueDataCon, falseDataCon, unitDataCon]
 210
 211 preludeVars :: [(Module, FastString, Module, FastString)]
 212 preludeVars
 213   = [
 214       mk gHC_PARR FSLIT("mapP")       nDP_COMBINATORS FSLIT("mapPA")
 215     , mk gHC_PARR FSLIT("zipWithP")   nDP_COMBINATORS FSLIT("zipWithPA")
 216     , mk gHC_PARR FSLIT("zipP")       nDP_COMBINATORS FSLIT("zipPA")
 217     , mk gHC_PARR FSLIT("unzipP")     nDP_COMBINATORS FSLIT("unzipPA")
 218     , mk gHC_PARR FSLIT("filterP")    nDP_COMBINATORS FSLIT("filterPA")
 219     , mk gHC_PARR FSLIT("lengthP")    nDP_COMBINATORS FSLIT("lengthPA")
 220     , mk gHC_PARR FSLIT("replicateP") nDP_COMBINATORS FSLIT("replicatePA")
 221     , mk gHC_PARR FSLIT("!:")         nDP_COMBINATORS FSLIT("indexPA")
 222     , mk gHC_PARR FSLIT("crossMapP")  nDP_COMBINATORS FSLIT("crossMapPA")
 223     , mk gHC_PARR FSLIT("singletonP") nDP_COMBINATORS FSLIT("singletonPA")
 224     , mk gHC_PARR FSLIT("concatP")    nDP_COMBINATORS FSLIT("concatPA")
 225     , mk gHC_PARR FSLIT("+:+")        nDP_COMBINATORS FSLIT("appPA")
 226
 227     , mk nDP_PRELUDE_INT  FSLIT("plus") nDP_PRELUDE_INT FSLIT("plusV")
 228     , mk nDP_PRELUDE_INT  FSLIT("minus") nDP_PRELUDE_INT FSLIT("minusV")
 229     , mk nDP_PRELUDE_INT  FSLIT("mult")  nDP_PRELUDE_INT FSLIT("multV")
 230     , mk nDP_PRELUDE_INT  FSLIT("intDiv")  nDP_PRELUDE_INT FSLIT("intDivV")
 231     , mk nDP_PRELUDE_INT  FSLIT("sumP")  nDP_PRELUDE_INT FSLIT("sumPA")
 232     , mk nDP_PRELUDE_INT  FSLIT("upToP") nDP_PRELUDE_INT FSLIT("upToPA")
 233
 234     , mk nDP_PRELUDE_INT  FSLIT("eq") nDP_PRELUDE_INT FSLIT("eqV")
 235     , mk nDP_PRELUDE_INT  FSLIT("neq") nDP_PRELUDE_INT FSLIT("neqV")
 236     , mk nDP_PRELUDE_INT  FSLIT("le")  nDP_PRELUDE_INT FSLIT("leV")
 237     , mk nDP_PRELUDE_INT  FSLIT("lt") nDP_PRELUDE_INT FSLIT("ltV")
 238     , mk nDP_PRELUDE_INT  FSLIT("ge") nDP_PRELUDE_INT FSLIT("geV")
 239     , mk nDP_PRELUDE_INT  FSLIT("gt")  nDP_PRELUDE_INT FSLIT("gtV")
 240
 241     , mk nDP_PRELUDE_DOUBLE  FSLIT("plus") nDP_PRELUDE_DOUBLE FSLIT("plusV")
 242     , mk nDP_PRELUDE_DOUBLE  FSLIT("minus") nDP_PRELUDE_DOUBLE FSLIT("minusV")
 243     , mk nDP_PRELUDE_DOUBLE  FSLIT("mult")  nDP_PRELUDE_DOUBLE FSLIT("multV")
 244     , mk nDP_PRELUDE_DOUBLE  FSLIT("divide")  nDP_PRELUDE_DOUBLE FSLIT("divideV")
 245     , mk nDP_PRELUDE_DOUBLE  FSLIT("sumP")  nDP_PRELUDE_DOUBLE FSLIT("sumPA")
 246     , mk nDP_PRELUDE_DOUBLE  FSLIT("minIndexP")
 247          nDP_PRELUDE_DOUBLE  FSLIT("minIndexPA")
 248     , mk nDP_PRELUDE_DOUBLE  FSLIT("maxIndexP")
 249          nDP_PRELUDE_DOUBLE  FSLIT("maxIndexPA")
 250
 251     , mk nDP_PRELUDE_DOUBLE  FSLIT("eq") nDP_PRELUDE_DOUBLE FSLIT("eqV")
 252     , mk nDP_PRELUDE_DOUBLE  FSLIT("neq") nDP_PRELUDE_DOUBLE FSLIT("neqV")
 253     , mk nDP_PRELUDE_DOUBLE  FSLIT("le")  nDP_PRELUDE_DOUBLE FSLIT("leV")
 254     , mk nDP_PRELUDE_DOUBLE  FSLIT("lt") nDP_PRELUDE_DOUBLE FSLIT("ltV")
 255     , mk nDP_PRELUDE_DOUBLE  FSLIT("ge") nDP_PRELUDE_DOUBLE FSLIT("geV")
 256     , mk nDP_PRELUDE_DOUBLE  FSLIT("gt")  nDP_PRELUDE_DOUBLE FSLIT("gtV")
 257
 258     -- FIXME: temporary
 259     , mk nDP_PRELUDE_PARR FSLIT("fromPArrayP") nDP_PRELUDE_PARR FSLIT("fromPArrayPA")
 260     , mk nDP_PRELUDE_PARR FSLIT("toPArrayP") nDP_PRELUDE_PARR FSLIT("toPArrayPA")
 261     , mk nDP_PRELUDE_PARR FSLIT("fromNestedPArrayP") nDP_PRELUDE_PARR FSLIT("fromNestedPArrayPA")
 262     ]
 263   where
 264     mk = (,,,)
 265
 266 initBuiltinTyCons :: Builtins -> DsM [(Name, TyCon)]
 267 initBuiltinTyCons bi
 268   = do
 269       -- parr <- externalTyCon nDP_PRELUDE_PARR FSLIT("PArr")
 270       return $ (tyConName funTyCon, closureTyCon bi)
 271              : (parrTyConName,      parrayTyCon bi)
 272
 273              -- FIXME: temporary
 274              : (tyConName $ parrayTyCon bi, parrayTyCon bi)
 275
 276              : [(tyConName tc, tc) | tc <- defaultTyCons]
 277
 278 defaultTyCons :: [TyCon]
 279 defaultTyCons = [intTyCon, boolTyCon, doubleTyCon]
 280
 281 initBuiltinDataCons :: Builtins -> [(Name, DataCon)]
 282 initBuiltinDataCons _ = [(dataConName dc, dc)| dc <- defaultDataCons]
 283
 284 defaultDataCons :: [DataCon]
 285 defaultDataCons = [trueDataCon, falseDataCon, unitDataCon]
 286
 287 initBuiltinDicts :: [(Name, Module, FastString)] -> DsM [(Name, Var)]
 288 initBuiltinDicts ps
 289   = do
 290       dicts <- zipWithM externalVar mods fss
 291       return $ zip tcs dicts
 292   where
 293     (tcs, mods, fss) = unzip3 ps
 294
 295 initBuiltinPAs :: Builtins -> DsM [(Name, Var)]
 296 initBuiltinPAs = initBuiltinDicts . builtinPAs
 297
 298 builtinPAs :: Builtins -> [(Name, Module, FastString)]
 299 builtinPAs bi
 300   = [
 301       mk (tyConName $ closureTyCon bi)  nDP_CLOSURE     FSLIT("dPA_Clo")
 302     , mk (tyConName $ voidTyCon bi)     nDP_REPR        FSLIT("dPA_Void")
 303     , mk (tyConName $ parrayTyCon bi)   nDP_INSTANCES   FSLIT("dPA_PArray")
 304     , mk unitTyConName                  nDP_INSTANCES   FSLIT("dPA_Unit")
 305
 306     , mk intTyConName                   nDP_INSTANCES   FSLIT("dPA_Int")
 307     , mk doubleTyConName                nDP_INSTANCES   FSLIT("dPA_Double")
 308     , mk boolTyConName                  nDP_INSTANCES   FSLIT("dPA_Bool")
 309     ]
 310     ++ tups
 311   where
 312     mk name mod fs = (name, mod, fs)
 313
 314     tups = map mk_tup [2..mAX_NDP_PROD]
 315     mk_tup n = mk (tyConName $ tupleTyCon Boxed n)
 316                   nDP_INSTANCES
 317                   (mkFastString $ "dPA_" ++ show n)
 318
 319 initBuiltinPRs :: Builtins -> DsM [(Name, Var)]
 320 initBuiltinPRs = initBuiltinDicts . builtinPRs
 321
 322 builtinPRs :: Builtins -> [(Name, Module, FastString)]
 323 builtinPRs bi =
 324   [
 325     mk (tyConName unitTyCon)          nDP_REPR      FSLIT("dPR_Unit")
 326   , mk (tyConName $ voidTyCon bi)     nDP_REPR      FSLIT("dPR_Void")
 327   , mk (tyConName $ wrapTyCon bi)     nDP_REPR      FSLIT("dPR_Wrap")
 328   , mk (tyConName $ enumerationTyCon bi) nDP_REPR   FSLIT("dPR_Enumeration")
 329   , mk (tyConName $ closureTyCon bi)  nDP_CLOSURE   FSLIT("dPR_Clo")
 330
 331     -- temporary
 332   , mk intTyConName          nDP_INSTANCES FSLIT("dPR_Int")
 333   , mk doubleTyConName       nDP_INSTANCES FSLIT("dPR_Double")
 334   ]
 335
 336   ++ map mk_sum  [2..mAX_NDP_SUM]
 337   ++ map mk_prod [2..mAX_NDP_PROD]
 338   where
 339     mk name mod fs = (name, mod, fs)
 340
 341     mk_sum n = (tyConName $ sumTyCon n bi, nDP_REPR,
 342                 mkFastString ("dPR_Sum" ++ show n))
 343
 344     mk_prod n = (tyConName $ prodTyCon n bi, nDP_REPR,
 345                  mkFastString ("dPR_" ++ show n))
 346
 347 initBuiltinBoxedTyCons :: Builtins -> DsM [(Name, TyCon)]
 348 initBuiltinBoxedTyCons = return . builtinBoxedTyCons
 349
 350 builtinBoxedTyCons :: Builtins -> [(Name, TyCon)]
 351 builtinBoxedTyCons _ =
 352   [(tyConName intPrimTyCon, intTyCon)]
 353
 354 externalVar :: Module -> FastString -> DsM Var
 355 externalVar mod fs
 356   = dsLookupGlobalId =<< lookupOrig mod (mkVarOccFS fs)
 357
 358 externalTyCon :: Module -> FastString -> DsM TyCon
 359 externalTyCon mod fs
 360   = dsLookupTyCon =<< lookupOrig mod (mkOccNameFS tcName fs)
 361
 362 unitTyConName :: Name
 363 unitTyConName = tyConName unitTyCon
 364
 365
 366 primMethod :: TyCon -> String -> DsM (Maybe Var)
 367 primMethod tycon method
 368   | Just suffix <- lookupNameEnv prim_ty_cons (tyConName tycon)
 369   = liftM Just
 370   $ dsLookupGlobalId =<< lookupOrig nDP_UNBOXED (mkVarOcc $ method ++ suffix)
 371
 372   | otherwise = return Nothing
 373
 374 primPArray :: TyCon -> DsM (Maybe TyCon)
 375 primPArray tycon
 376   | Just suffix <- lookupNameEnv prim_ty_cons (tyConName tycon)
 377   = liftM Just
 378   $ dsLookupTyCon =<< lookupOrig nDP_UNBOXED (mkOccName tcName $ "PArray" ++ suffix)
 379
 380   | otherwise = return Nothing
 381
 382 prim_ty_cons :: NameEnv String
 383 prim_ty_cons = mkNameEnv [mk_prim intPrimTyCon]
 384   where
 385     mk_prim tycon = (tyConName tycon, '_' : getOccString tycon)
 386