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