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