Don't use DPH backend directly in vectoriser
[ghc-hetmet.git] / compiler / vectorise / VectBuiltIn.hs
1 module VectBuiltIn (
2   Builtins(..), sumTyCon, prodTyCon,
3   combinePAVar,
4   initBuiltins, initBuiltinVars, initBuiltinTyCons, initBuiltinDataCons,
5   initBuiltinPAs, initBuiltinPRs,
6   initBuiltinBoxedTyCons,
7
8   primMethod, primPArray
9 ) where
10
11 import DsMonad
12 import IfaceEnv        ( lookupOrig )
13
14 import Module
15 import DataCon         ( DataCon, dataConName, dataConWorkId )
16 import TyCon           ( TyCon, tyConName, tyConDataCons )
17 import Var             ( Var )
18 import Id              ( mkSysLocal )
19 import Name            ( Name, getOccString )
20 import NameEnv
21 import OccName
22
23 import TypeRep         ( funTyCon )
24 import Type            ( Type, mkTyConApp )
25 import TysPrim
26 import TysWiredIn      ( unitTyCon, unitDataCon,
27                          tupleTyCon, tupleCon,
28                          intTyCon, intTyConName,
29                          doubleTyCon, doubleTyConName,
30                          boolTyCon, boolTyConName, trueDataCon, falseDataCon,
31                          parrTyConName )
32 import PrelNames       ( gHC_PARR )
33 import BasicTypes      ( Boxity(..) )
34
35 import FastString
36 import Outputable
37
38 import Data.Array
39 import Control.Monad   ( liftM, zipWithM )
40 import Data.List       ( unzip4 )
41
42 mAX_NDP_PROD :: Int
43 mAX_NDP_PROD = 5
44
45 mAX_NDP_SUM :: Int
46 mAX_NDP_SUM = 3
47
48 mAX_NDP_COMBINE :: Int
49 mAX_NDP_COMBINE = 2
50
51 mkNDPModule :: FastString -> Module
52 mkNDPModule m = mkModule ndpPackageId (mkModuleNameFS m)
53
54 nDP_PARRAY,
55   nDP_REPR,
56   nDP_CLOSURE,
57   nDP_UNBOXED,
58   nDP_INSTANCES,
59   nDP_COMBINATORS,
60   nDP_PRELUDE_PARR,
61   nDP_PRELUDE_INT,
62   nDP_PRELUDE_DOUBLE,
63   nDP_PRELUDE_BOOL,
64   nDP_PRELUDE_TUPLE :: Module
65
66 nDP_PARRAY      = mkNDPModule (fsLit "Data.Array.Parallel.Lifted.PArray")
67 nDP_REPR        = mkNDPModule (fsLit "Data.Array.Parallel.Lifted.Repr")
68 nDP_CLOSURE     = mkNDPModule (fsLit "Data.Array.Parallel.Lifted.Closure")
69 nDP_UNBOXED     = mkNDPModule (fsLit "Data.Array.Parallel.Lifted.Unboxed")
70 nDP_INSTANCES   = mkNDPModule (fsLit "Data.Array.Parallel.Lifted.Instances")
71 nDP_COMBINATORS = mkNDPModule (fsLit "Data.Array.Parallel.Lifted.Combinators")
72
73 nDP_PRELUDE_PARR = mkNDPModule (fsLit "Data.Array.Parallel.Prelude.Base.PArr")
74 nDP_PRELUDE_INT  = mkNDPModule (fsLit "Data.Array.Parallel.Prelude.Base.Int")
75 nDP_PRELUDE_DOUBLE = mkNDPModule (fsLit "Data.Array.Parallel.Prelude.Base.Double")
76 nDP_PRELUDE_BOOL = mkNDPModule (fsLit "Data.Array.Parallel.Prelude.Base.Bool")
77 nDP_PRELUDE_TUPLE  = mkNDPModule (fsLit "Data.Array.Parallel.Prelude.Base.Tuple")
78
79 data Builtins = Builtins {
80                   parrayTyCon      :: TyCon
81                 , paTyCon          :: TyCon
82                 , paDataCon        :: DataCon
83                 , preprTyCon       :: TyCon
84                 , prTyCon          :: TyCon
85                 , prDataCon        :: DataCon
86                 , intPrimArrayTy   :: Type
87                 , voidTyCon        :: TyCon
88                 , wrapTyCon        :: TyCon
89                 , enumerationTyCon :: TyCon
90                 , sumTyCons        :: Array Int TyCon
91                 , closureTyCon     :: TyCon
92                 , voidVar          :: Var
93                 , mkPRVar          :: Var
94                 , mkClosureVar     :: Var
95                 , applyClosureVar  :: Var
96                 , mkClosurePVar    :: Var
97                 , applyClosurePVar :: Var
98                 , replicatePAIntPrimVar :: Var
99                 , upToPAIntPrimVar :: Var
100                 , selectPAIntPrimVar :: Var
101                 , truesPABoolPrimVar :: Var
102                 , lengthPAVar      :: Var
103                 , replicatePAVar   :: Var
104                 , emptyPAVar       :: Var
105                 , packPAVar        :: Var
106                 , combinePAVars    :: Array Int Var
107                 , liftingContext   :: Var
108                 }
109
110 sumTyCon :: Int -> Builtins -> TyCon
111 sumTyCon n bi
112   | n >= 2 && n <= mAX_NDP_SUM = sumTyCons bi ! n
113   | otherwise = pprPanic "sumTyCon" (ppr n)
114
115 prodTyCon :: Int -> Builtins -> TyCon
116 prodTyCon n bi
117   | n == 1                      = wrapTyCon bi
118   | n >= 0 && n <= mAX_NDP_PROD = tupleTyCon Boxed n
119   | otherwise = pprPanic "prodTyCon" (ppr n)
120
121 combinePAVar :: Int -> Builtins -> Var
122 combinePAVar n bi
123   | n >= 2 && n <= mAX_NDP_COMBINE = combinePAVars bi ! n
124   | otherwise = pprPanic "combinePAVar" (ppr n)
125
126 initBuiltins :: DsM Builtins
127 initBuiltins
128   = do
129       parrayTyCon  <- externalTyCon nDP_PARRAY (fsLit "PArray")
130       paTyCon      <- externalTyCon nDP_PARRAY (fsLit "PA")
131       let [paDataCon] = tyConDataCons paTyCon
132       preprTyCon   <- externalTyCon nDP_PARRAY (fsLit "PRepr")
133       prTyCon      <- externalTyCon nDP_PARRAY (fsLit "PR")
134       let [prDataCon] = tyConDataCons prTyCon
135       intPrimArrayTy <- externalType nDP_UNBOXED (fsLit "PArray_Int#")
136       closureTyCon <- externalTyCon nDP_CLOSURE (fsLit ":->")
137
138       voidTyCon    <- externalTyCon nDP_REPR (fsLit "Void")
139       wrapTyCon    <- externalTyCon nDP_REPR (fsLit "Wrap")
140       enumerationTyCon <- externalTyCon nDP_REPR (fsLit "Enumeration")
141       sum_tcs <- mapM (externalTyCon nDP_REPR)
142                       [mkFastString ("Sum" ++ show i) | i <- [2..mAX_NDP_SUM]]
143
144       let sumTyCons = listArray (2, mAX_NDP_SUM) sum_tcs
145
146       voidVar          <- externalVar nDP_REPR (fsLit "void")
147       mkPRVar          <- externalVar nDP_PARRAY (fsLit "mkPR")
148       mkClosureVar     <- externalVar nDP_CLOSURE (fsLit "mkClosure")
149       applyClosureVar  <- externalVar nDP_CLOSURE (fsLit "$:")
150       mkClosurePVar    <- externalVar nDP_CLOSURE (fsLit "mkClosureP")
151       applyClosurePVar <- externalVar nDP_CLOSURE (fsLit "$:^")
152       replicatePAIntPrimVar <- externalVar nDP_UNBOXED (fsLit "replicatePA_Int#")
153       upToPAIntPrimVar <- externalVar nDP_UNBOXED (fsLit "upToPA_Int#")
154       selectPAIntPrimVar <- externalVar nDP_UNBOXED (fsLit "selectPA_Int#")
155       truesPABoolPrimVar <- externalVar nDP_UNBOXED (fsLit "truesPA_Bool#")
156       lengthPAVar      <- externalVar nDP_PARRAY (fsLit "lengthPA#")
157       replicatePAVar   <- externalVar nDP_PARRAY (fsLit "replicatePA#")
158       emptyPAVar       <- externalVar nDP_PARRAY (fsLit "emptyPA")
159       packPAVar        <- externalVar nDP_PARRAY (fsLit "packPA#")
160
161       combines <- mapM (externalVar nDP_PARRAY)
162                        [mkFastString ("combine" ++ show i ++ "PA#")
163                           | i <- [2..mAX_NDP_COMBINE]]
164       let combinePAVars = listArray (2, mAX_NDP_COMBINE) combines
165
166       liftingContext <- liftM (\u -> mkSysLocal (fsLit "lc") u intPrimTy)
167                               newUnique
168
169       return $ Builtins {
170                  parrayTyCon      = parrayTyCon
171                , paTyCon          = paTyCon
172                , paDataCon        = paDataCon
173                , preprTyCon       = preprTyCon
174                , prTyCon          = prTyCon
175                , prDataCon        = prDataCon
176                , intPrimArrayTy   = intPrimArrayTy
177                , voidTyCon        = voidTyCon
178                , wrapTyCon        = wrapTyCon
179                , enumerationTyCon = enumerationTyCon
180                , sumTyCons        = sumTyCons
181                , closureTyCon     = closureTyCon
182                , voidVar          = voidVar
183                , mkPRVar          = mkPRVar
184                , mkClosureVar     = mkClosureVar
185                , applyClosureVar  = applyClosureVar
186                , mkClosurePVar    = mkClosurePVar
187                , applyClosurePVar = applyClosurePVar
188                , replicatePAIntPrimVar = replicatePAIntPrimVar
189                , upToPAIntPrimVar = upToPAIntPrimVar
190                , selectPAIntPrimVar = selectPAIntPrimVar
191                , truesPABoolPrimVar = truesPABoolPrimVar
192                , lengthPAVar      = lengthPAVar
193                , replicatePAVar   = replicatePAVar
194                , emptyPAVar       = emptyPAVar
195                , packPAVar        = packPAVar
196                , combinePAVars    = combinePAVars
197                , liftingContext   = liftingContext
198                }
199
200 initBuiltinVars :: Builtins -> DsM [(Var, Var)]
201 initBuiltinVars _
202   = do
203       uvars <- zipWithM externalVar umods ufs
204       vvars <- zipWithM externalVar vmods vfs
205       cvars <- zipWithM externalVar cmods cfs
206       return $ [(v,v) | v <- map dataConWorkId defaultDataConWorkers]
207                ++ zip (map dataConWorkId cons) cvars
208                ++ zip uvars vvars
209   where
210     (umods, ufs, vmods, vfs) = unzip4 preludeVars
211
212     (cons, cmods, cfs) = unzip3 preludeDataCons
213
214 defaultDataConWorkers :: [DataCon]
215 defaultDataConWorkers = [trueDataCon, falseDataCon, unitDataCon]
216
217 preludeDataCons :: [(DataCon, Module, FastString)]
218 preludeDataCons
219   = [mk_tup n nDP_PRELUDE_TUPLE (mkFastString $ "tup" ++ show n) | n <- [2..3]]
220   where
221     mk_tup n mod name = (tupleCon Boxed n, mod, name)
222
223 preludeVars :: [(Module, FastString, Module, FastString)]
224 preludeVars
225   = [
226       mk gHC_PARR (fsLit "mapP")       nDP_COMBINATORS (fsLit "mapPA")
227     , mk gHC_PARR (fsLit "zipWithP")   nDP_COMBINATORS (fsLit "zipWithPA")
228     , mk gHC_PARR (fsLit "zipP")       nDP_COMBINATORS (fsLit "zipPA")
229     , mk gHC_PARR (fsLit "unzipP")     nDP_COMBINATORS (fsLit "unzipPA")
230     , mk gHC_PARR (fsLit "filterP")    nDP_COMBINATORS (fsLit "filterPA")
231     , mk gHC_PARR (fsLit "lengthP")    nDP_COMBINATORS (fsLit "lengthPA")
232     , mk gHC_PARR (fsLit "replicateP") nDP_COMBINATORS (fsLit "replicatePA")
233     , mk gHC_PARR (fsLit "!:")         nDP_COMBINATORS (fsLit "indexPA")
234     , mk gHC_PARR (fsLit "crossMapP")  nDP_COMBINATORS (fsLit "crossMapPA")
235     , mk gHC_PARR (fsLit "singletonP") nDP_COMBINATORS (fsLit "singletonPA")
236     , mk gHC_PARR (fsLit "concatP")    nDP_COMBINATORS (fsLit "concatPA")
237     , mk gHC_PARR (fsLit "+:+")        nDP_COMBINATORS (fsLit "appPA")
238     , mk gHC_PARR (fsLit "emptyP")     nDP_PARRAY (fsLit "emptyPA")
239
240     , mk nDP_PRELUDE_INT  (fsLit "plus") nDP_PRELUDE_INT (fsLit "plusV")
241     , mk nDP_PRELUDE_INT  (fsLit "minus") nDP_PRELUDE_INT (fsLit "minusV")
242     , mk nDP_PRELUDE_INT  (fsLit "mult")  nDP_PRELUDE_INT (fsLit "multV")
243     , mk nDP_PRELUDE_INT  (fsLit "intDiv")  nDP_PRELUDE_INT (fsLit "intDivV")
244     , mk nDP_PRELUDE_INT  (fsLit "intMod")  nDP_PRELUDE_INT (fsLit "intModV")
245     , mk nDP_PRELUDE_INT  (fsLit "intSquareRoot")  nDP_PRELUDE_INT (fsLit "intSquareRootV")
246     , mk nDP_PRELUDE_INT  (fsLit "intSumP")  nDP_PRELUDE_INT (fsLit "intSumPA")
247     , mk nDP_PRELUDE_INT  (fsLit "enumFromToP")  nDP_PRELUDE_INT (fsLit "enumFromToPA")
248     , mk nDP_PRELUDE_INT  (fsLit "upToP") nDP_PRELUDE_INT (fsLit "upToPA")
249
250     , mk nDP_PRELUDE_INT  (fsLit "eq") nDP_PRELUDE_INT (fsLit "eqV")
251     , mk nDP_PRELUDE_INT  (fsLit "neq") nDP_PRELUDE_INT (fsLit "neqV")
252     , mk nDP_PRELUDE_INT  (fsLit "le")  nDP_PRELUDE_INT (fsLit "leV")
253     , mk nDP_PRELUDE_INT  (fsLit "lt") nDP_PRELUDE_INT (fsLit "ltV")
254     , mk nDP_PRELUDE_INT  (fsLit "ge") nDP_PRELUDE_INT (fsLit "geV")
255     , mk nDP_PRELUDE_INT  (fsLit "gt")  nDP_PRELUDE_INT (fsLit "gtV")
256
257     , mk nDP_PRELUDE_DOUBLE  (fsLit "plus") nDP_PRELUDE_DOUBLE (fsLit "plusV")
258     , mk nDP_PRELUDE_DOUBLE  (fsLit "minus") nDP_PRELUDE_DOUBLE (fsLit "minusV")
259     , mk nDP_PRELUDE_DOUBLE  (fsLit "mult")  nDP_PRELUDE_DOUBLE (fsLit "multV")
260     , mk nDP_PRELUDE_DOUBLE  (fsLit "divide")  nDP_PRELUDE_DOUBLE (fsLit "divideV")
261     , mk nDP_PRELUDE_DOUBLE  (fsLit  "squareRoot")  nDP_PRELUDE_DOUBLE (fsLit "squareRootV")    
262     , mk nDP_PRELUDE_DOUBLE  (fsLit "doubleSumP")  nDP_PRELUDE_DOUBLE (fsLit "doubleSumPA")
263     , mk nDP_PRELUDE_DOUBLE  (fsLit "minIndexP") 
264          nDP_PRELUDE_DOUBLE  (fsLit "minIndexPA")
265     , mk nDP_PRELUDE_DOUBLE  (fsLit "maxIndexP")
266          nDP_PRELUDE_DOUBLE  (fsLit "maxIndexPA")
267
268     , mk nDP_PRELUDE_DOUBLE  (fsLit "eq") nDP_PRELUDE_DOUBLE (fsLit "eqV")
269     , mk nDP_PRELUDE_DOUBLE  (fsLit "neq") nDP_PRELUDE_DOUBLE (fsLit "neqV")
270     , mk nDP_PRELUDE_DOUBLE  (fsLit "le")  nDP_PRELUDE_DOUBLE (fsLit "leV")
271     , mk nDP_PRELUDE_DOUBLE  (fsLit "lt") nDP_PRELUDE_DOUBLE (fsLit "ltV")
272     , mk nDP_PRELUDE_DOUBLE  (fsLit "ge") nDP_PRELUDE_DOUBLE (fsLit "geV")
273     , mk nDP_PRELUDE_DOUBLE  (fsLit "gt")  nDP_PRELUDE_DOUBLE (fsLit "gtV")
274
275     , mk nDP_PRELUDE_BOOL  (fsLit "andP")  nDP_PRELUDE_BOOL (fsLit "andPA")
276     , mk nDP_PRELUDE_BOOL  (fsLit "orP")  nDP_PRELUDE_BOOL (fsLit "orPA")
277
278     -- FIXME: temporary
279     , mk nDP_PRELUDE_PARR (fsLit "fromPArrayP") nDP_PRELUDE_PARR (fsLit "fromPArrayPA")
280     , mk nDP_PRELUDE_PARR (fsLit "toPArrayP") nDP_PRELUDE_PARR (fsLit "toPArrayPA")
281     , mk nDP_PRELUDE_PARR (fsLit "fromNestedPArrayP") nDP_PRELUDE_PARR (fsLit "fromNestedPArrayPA")
282     , mk nDP_PRELUDE_PARR (fsLit "combineP")    nDP_COMBINATORS (fsLit "combine2PA")
283     ]
284   where
285     mk = (,,,)
286
287 initBuiltinTyCons :: Builtins -> DsM [(Name, TyCon)]
288 initBuiltinTyCons bi
289   = do
290       -- parr <- externalTyCon nDP_PRELUDE_PARR (fsLit "PArr")
291       return $ (tyConName funTyCon, closureTyCon bi)
292              : (parrTyConName,      parrayTyCon bi)
293
294              -- FIXME: temporary
295              : (tyConName $ parrayTyCon bi, parrayTyCon bi)
296
297              : [(tyConName tc, tc) | tc <- defaultTyCons]
298
299 defaultTyCons :: [TyCon]
300 defaultTyCons = [intTyCon, boolTyCon, doubleTyCon]
301
302 initBuiltinDataCons :: Builtins -> [(Name, DataCon)]
303 initBuiltinDataCons _ = [(dataConName dc, dc)| dc <- defaultDataCons]
304
305 defaultDataCons :: [DataCon]
306 defaultDataCons = [trueDataCon, falseDataCon, unitDataCon]
307
308 initBuiltinDicts :: [(Name, Module, FastString)] -> DsM [(Name, Var)]
309 initBuiltinDicts ps
310   = do
311       dicts <- zipWithM externalVar mods fss
312       return $ zip tcs dicts
313   where
314     (tcs, mods, fss) = unzip3 ps
315
316 initBuiltinPAs :: Builtins -> DsM [(Name, Var)]
317 initBuiltinPAs = initBuiltinDicts . builtinPAs
318
319 builtinPAs :: Builtins -> [(Name, Module, FastString)]
320 builtinPAs bi
321   = [
322       mk (tyConName $ closureTyCon bi)  nDP_CLOSURE     (fsLit "dPA_Clo")
323     , mk (tyConName $ voidTyCon bi)     nDP_REPR        (fsLit "dPA_Void")
324     , mk (tyConName $ parrayTyCon bi)   nDP_INSTANCES   (fsLit "dPA_PArray")
325     , mk unitTyConName                  nDP_INSTANCES   (fsLit "dPA_Unit")
326
327     , mk intTyConName                   nDP_INSTANCES   (fsLit "dPA_Int")
328     , mk doubleTyConName                nDP_INSTANCES   (fsLit "dPA_Double")
329     , mk boolTyConName                  nDP_INSTANCES   (fsLit "dPA_Bool")
330     ]
331     ++ tups
332   where
333     mk name mod fs = (name, mod, fs)
334
335     tups = map mk_tup [2..mAX_NDP_PROD]
336     mk_tup n = mk (tyConName $ tupleTyCon Boxed n)
337                   nDP_INSTANCES
338                   (mkFastString $ "dPA_" ++ show n)
339
340 initBuiltinPRs :: Builtins -> DsM [(Name, Var)]
341 initBuiltinPRs = initBuiltinDicts . builtinPRs
342
343 builtinPRs :: Builtins -> [(Name, Module, FastString)]
344 builtinPRs bi =
345   [
346     mk (tyConName unitTyCon)          nDP_REPR      (fsLit "dPR_Unit")
347   , mk (tyConName $ voidTyCon bi)     nDP_REPR      (fsLit "dPR_Void")
348   , mk (tyConName $ wrapTyCon bi)     nDP_REPR      (fsLit "dPR_Wrap")
349   , mk (tyConName $ enumerationTyCon bi) nDP_REPR   (fsLit "dPR_Enumeration")
350   , mk (tyConName $ closureTyCon bi)  nDP_CLOSURE   (fsLit "dPR_Clo")
351
352     -- temporary
353   , mk intTyConName          nDP_INSTANCES (fsLit "dPR_Int")
354   , mk doubleTyConName       nDP_INSTANCES (fsLit "dPR_Double")
355   ]
356
357   ++ map mk_sum  [2..mAX_NDP_SUM]
358   ++ map mk_prod [2..mAX_NDP_PROD]
359   where
360     mk name mod fs = (name, mod, fs)
361
362     mk_sum n = (tyConName $ sumTyCon n bi, nDP_REPR,
363                 mkFastString ("dPR_Sum" ++ show n))
364
365     mk_prod n = (tyConName $ prodTyCon n bi, nDP_REPR,
366                  mkFastString ("dPR_" ++ show n))
367
368 initBuiltinBoxedTyCons :: Builtins -> DsM [(Name, TyCon)]
369 initBuiltinBoxedTyCons = return . builtinBoxedTyCons
370
371 builtinBoxedTyCons :: Builtins -> [(Name, TyCon)]
372 builtinBoxedTyCons _ =
373   [(tyConName intPrimTyCon, intTyCon)]
374
375 externalVar :: Module -> FastString -> DsM Var
376 externalVar mod fs
377   = dsLookupGlobalId =<< lookupOrig mod (mkVarOccFS fs)
378
379 externalTyCon :: Module -> FastString -> DsM TyCon
380 externalTyCon mod fs
381   = dsLookupTyCon =<< lookupOrig mod (mkOccNameFS tcName fs)
382
383 externalType :: Module -> FastString -> DsM Type
384 externalType mod fs
385   = do
386       tycon <- externalTyCon mod fs
387       return $ mkTyConApp tycon []
388
389 unitTyConName :: Name
390 unitTyConName = tyConName unitTyCon
391
392
393 primMethod :: TyCon -> String -> DsM (Maybe Var)
394 primMethod tycon method
395   | Just suffix <- lookupNameEnv prim_ty_cons (tyConName tycon)
396   = liftM Just
397   $ dsLookupGlobalId =<< lookupOrig nDP_UNBOXED (mkVarOcc $ method ++ suffix)
398
399   | otherwise = return Nothing
400
401 primPArray :: TyCon -> DsM (Maybe TyCon)
402 primPArray tycon
403   | Just suffix <- lookupNameEnv prim_ty_cons (tyConName tycon)
404   = liftM Just
405   $ dsLookupTyCon =<< lookupOrig nDP_UNBOXED (mkOccName tcName $ "PArray" ++ suffix)
406
407   | otherwise = return Nothing
408
409 prim_ty_cons :: NameEnv String
410 prim_ty_cons = mkNameEnv [mk_prim intPrimTyCon]
411   where
412     mk_prim tycon = (tyConName tycon, '_' : getOccString tycon)
413