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