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