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