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