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