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