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