DsForeign.lhs 15.8 KB
Newer Older
sof's avatar
sof committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
%
% (c) The AQUA Project, Glasgow University, 1998
%
\section[DsCCall]{Desugaring \tr{foreign} declarations}

Expanding out @foreign import@ and @foreign export@ declarations.

\begin{code}
module DsForeign ( dsForeigns ) where

#include "HsVersions.h"

import CoreSyn

15
import DsCCall		( dsCCall, mkCCall, boxResult, unboxArg, resultWrapper )
sof's avatar
sof committed
16
17
import DsMonad

18
19
import HsSyn		( ExtName(..), ForeignDecl(..), isDynamicExtName, ForKind(..) )
import HsDecls		( extNameStatic )
sof's avatar
sof committed
20
import CallConv
21
import TcHsSyn		( TypecheckedForeignDecl )
22
import CoreUtils	( exprType, mkInlineMe )
23
import Id		( Id, idType, idName, mkVanillaId, mkSysLocal,
24
25
			  setInlinePragma )
import IdInfo		( neverInlinePrag )
26
import Literal		( Literal(..) )
sof's avatar
sof committed
27
import Module		( Module, moduleUserString )
28
import Name		( mkGlobalName, nameModule, nameOccName, getOccString, 
sof's avatar
sof committed
29
			  mkForeignExportOcc, isLocalName,
30
			  NamedThing(..),
31
			)
32
import Type		( splitTyConApp_maybe, tyConAppTyCon, splitFunTys, splitForAllTys,
33
			  Type, mkFunTys, mkForAllTys, mkTyConApp,
34
			  mkFunTy, splitAppTy, applyTy, funResultTy
sof's avatar
sof committed
35
			)
36
37
import PrimOp		( CCall(..), CCallTarget(..), dynamicTarget )
import TysWiredIn	( unitTy, addrTy, stablePtrTyCon )
38
import TysPrim		( addrPrimTy )
39
40
import PrelNames	( hasKey, ioTyConKey, deRefStablePtrName, newStablePtrName,
			  bindIOName, returnIOName
41
			)
sof's avatar
sof committed
42
import Outputable
43
44

import Maybe 		( fromJust )
sof's avatar
sof committed
45
46
47
48
\end{code}

Desugaring of @foreign@ declarations is naturally split up into
parts, an @import@ and an @export@  part. A @foreign import@ 
49
50
declaration
\begin{verbatim}
sof's avatar
sof committed
51
  foreign import cc nm f :: prim_args -> IO prim_res
52
\end{verbatim}
sof's avatar
sof committed
53
is the same as
54
\begin{verbatim}
sof's avatar
sof committed
55
56
  f :: prim_args -> IO prim_res
  f a1 ... an = _ccall_ nm cc a1 ... an
57
\end{verbatim}
sof's avatar
sof committed
58
59
60
so we reuse the desugaring code in @DsCCall@ to deal with these.

\begin{code}
61
62
63
type Binding = (Id, CoreExpr)	-- No rec/nonrec structure;
				-- the occurrence analyser will sort it all out

sof's avatar
sof committed
64
65
dsForeigns :: Module
           -> [TypecheckedForeignDecl] 
66
67
68
	   -> DsM ( [Id]		-- Foreign-exported binders; 
					-- we have to generate code to register these
		  , [Binding]
69
70
71
72
		  , SDoc	      -- Header file prototypes for
                                      -- "foreign exported" functions.
		  , SDoc 	      -- C stubs to use when calling
                                      -- "foreign exported" functions.
sof's avatar
sof committed
73
		  )
74
dsForeigns mod_name fos = foldlDs combine ([], [], empty, empty) fos
sof's avatar
sof committed
75
 where
76
  combine (acc_feb, acc_f, acc_h, acc_c) fo@(ForeignDecl i imp_exp _ ext_nm cconv _) 
77
    | isForeignImport =   -- foreign import (dynamic)?
78
        dsFImport i (idType i) uns ext_nm cconv  `thenDs` \ bs -> 
79
	returnDs (acc_feb, bs ++ acc_f, acc_h, acc_c)
sof's avatar
sof committed
80
    | isForeignLabel = 
81
        dsFLabel i (idType i) ext_nm `thenDs` \ b -> 
82
	returnDs (acc_feb, b:acc_f, acc_h, acc_c)
83
    | isDynamicExtName ext_nm =
84
85
        dsFExportDynamic i (idType i) mod_name ext_nm cconv  `thenDs` \ (feb,bs,h,c) -> 
	returnDs (feb:acc_feb, bs ++ acc_f, h $$ acc_h, c $$ acc_c)
sof's avatar
sof committed
86

87
    | otherwise	       =  -- foreign export
88
89
        dsFExport i (idType i) mod_name ext_nm cconv False   `thenDs` \ (feb,fe,h,c) ->
	returnDs (feb:acc_feb, fe:acc_f, h $$ acc_h, c $$ acc_c)
sof's avatar
sof committed
90
   where
sof's avatar
sof committed
91
92
93
94
95
96
97
98
99
100
101
    isForeignImport = 
	case imp_exp of
	  FoImport _ -> True
	  _          -> False

    isForeignLabel = 
	case imp_exp of
	  FoLabel -> True
	  _       -> False

    (FoImport uns)   = imp_exp
sof's avatar
sof committed
102
103
104
105
106

\end{code}

Desugaring foreign imports is just the matter of creating a binding
that on its RHS unboxes its arguments, performs the external call
107
(using the @CCallOp@ primop), before boxing the result up and returning it.
sof's avatar
sof committed
108

109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
However, we create a worker/wrapper pair, thus:

	foreign import f :: Int -> IO Int
==>
	f x = IO ( \s -> case x of { I# x# ->
			 case fw s x# of { (# s1, y# #) ->
			 (# s1, I# y# #)}})

	fw s x# = ccall f s x#

The strictness/CPR analyser won't do this automatically because it doesn't look
inside returned tuples; but inlining this wrapper is a Really Good Idea 
because it exposes the boxing to the call site.
			

sof's avatar
sof committed
124
125
126
127
128
129
\begin{code}
dsFImport :: Id
	  -> Type		-- Type of foreign import.
	  -> Bool		-- True <=> might cause Haskell GC
	  -> ExtName
	  -> CallConv
130
	  -> DsM [Binding]
131
132
dsFImport fn_id ty may_not_gc ext_name cconv 
  = let
133
134
	(tvs, fun_ty)        = splitForAllTys ty
	(arg_tys, io_res_ty) = splitFunTys fun_ty
sof's avatar
sof committed
135
    in
136
    newSysLocalsDs arg_tys  			`thenDs` \ args ->
137
138
    mapAndUnzipDs unboxArg (map Var args)	`thenDs` \ (val_args, arg_wrappers) ->
    boxResult io_res_ty				`thenDs` \ (ccall_result_ty, res_wrapper) ->
139
140
141

    getUniqueDs						`thenDs` \ ccall_uniq ->
    getUniqueDs						`thenDs` \ work_uniq ->
sof's avatar
sof committed
142
    let
143
144
145
146
	lbl = case ext_name of
		Dynamic	     -> dynamicTarget
	        ExtName fs _ -> StaticTarget fs

147
148
149
150
151
152
	-- Build the worker
	work_arg_ids  = [v | Var v <- val_args]		-- All guaranteed to be vars
	worker_ty     = mkForAllTys tvs (mkFunTys (map idType work_arg_ids) ccall_result_ty)
	the_ccall     = CCall lbl False (not may_not_gc) cconv
 	the_ccall_app = mkCCall ccall_uniq the_ccall val_args ccall_result_ty
	work_rhs      = mkLams tvs (mkLams work_arg_ids the_ccall_app)
153
	work_id       = mkSysLocal SLIT("$wccall") work_uniq worker_ty
154
155
156
157

	-- Build the wrapper
	work_app     = mkApps (mkVarApps (Var work_id) tvs) val_args
	wrapper_body = foldr ($) (res_wrapper work_app) arg_wrappers
158
        wrap_rhs     = mkInlineMe (mkLams (tvs ++ args) wrapper_body)
sof's avatar
sof committed
159
    in
160
    returnDs [(work_id, work_rhs), (fn_id, wrap_rhs)]
161
162
\end{code}

163
Foreign labels 
sof's avatar
sof committed
164
165

\begin{code}
166
dsFLabel :: Id -> Type -> ExtName -> DsM Binding
167
168
dsFLabel nm ty ext_name = 
   ASSERT(fromJust res_ty == addrPrimTy) -- typechecker ensures this
169
   returnDs (nm, fo_rhs (mkLit (MachLabel enm)))
sof's avatar
sof committed
170
  where
171
   (res_ty, fo_rhs) = resultWrapper ty
172
   enm    = extNameStatic ext_name
sof's avatar
sof committed
173
174
\end{code}

175
176
The function that does most of the work for `@foreign export@' declarations.
(see below for the boilerplate code a `@foreign export@' declaration expands
177
 into.)
sof's avatar
sof committed
178

179
180
181
182
183
184
For each `@foreign export foo@' in a module M we generate:
\begin{itemize}
\item a C function `@foo@', which calls
\item a Haskell stub `@M.$ffoo@', which calls
\end{itemize}
the user-written Haskell function `@M.foo@'.
185

sof's avatar
sof committed
186
187
188
\begin{code}
dsFExport :: Id
	  -> Type		-- Type of foreign export.
sof's avatar
sof committed
189
	  -> Module
sof's avatar
sof committed
190
191
192
193
	  -> ExtName
	  -> CallConv
	  -> Bool		-- True => invoke IO action that's hanging off 
				-- the first argument's stable pointer
194
195
	  -> DsM ( Id		-- The foreign-exported Id
		 , Binding
196
197
198
		 , SDoc
		 , SDoc
		 )
199
dsFExport fn_id ty mod_name ext_name cconv isDyn
200
201
202
203
204
205
  = 	-- BUILD THE returnIO WRAPPER, if necessary
	-- Look at the result type of the exported function, orig_res_ty
	-- If it's IO t, return		(\x.x,	        IO t, t)
	-- If it's plain t, return	(\x.returnIO x, IO t, t)
     (case splitTyConApp_maybe orig_res_ty of
	Just (ioTyCon, [res_ty])
206
	      -> ASSERT( ioTyCon `hasKey` ioTyConKey )
207
208
209
210
			-- The function already returns IO t
		 returnDs (\body -> body, orig_res_ty, res_ty)

	other -> 	-- The function returns t, so wrap the call in returnIO
211
		 dsLookupGlobalValue returnIOName	`thenDs` \ retIOId ->
212
213
214
215
216
217
218
219
220
221
222
	         returnDs (\body -> mkApps (Var retIOId) [Type orig_res_ty, body],
		           funResultTy (applyTy (idType retIOId) orig_res_ty), 
				-- We don't have ioTyCon conveniently to hand
			   orig_res_ty)

     )		`thenDs` \ (return_io_wrapper, 	-- Either identity or returnIO
			    io_res_ty, 		-- IO t
			    res_ty) ->		-- t


	-- BUILD THE deRefStablePtr WRAPPER, if necessary
sof's avatar
sof committed
223
224
     (if isDyn then 
        newSysLocalDs stbl_ptr_ty			`thenDs` \ stbl_ptr ->
225
	newSysLocalDs stbl_ptr_to_ty			`thenDs` \ stbl_value ->
226
227
	dsLookupGlobalValue deRefStablePtrName		`thenDs` \ deRefStablePtrId ->
        dsLookupGlobalValue bindIOName			`thenDs` \ bindIOId ->
sof's avatar
sof committed
228
	let
229
230
	 the_deref_app = mkApps (Var deRefStablePtrId)
				[ Type stbl_ptr_to_ty, Var stbl_ptr ]
231

232
233
234
235
236
	 stbl_app cont = mkApps (Var bindIOId)
				[ Type stbl_ptr_to_ty
				, Type res_ty
				, the_deref_app
				, mkLams [stbl_value] cont]
237
238
        in
	returnDs (stbl_value, stbl_app, stbl_ptr)
sof's avatar
sof committed
239
      else
240
        returnDs (fn_id, 
sof's avatar
sof committed
241
242
	          \ body -> body,
		  panic "stbl_ptr"  -- should never be touched.
243
		  ))			`thenDs` \ (i, getFun_wrapper, stbl_ptr) ->
sof's avatar
sof committed
244
245


246
	-- BUILD THE HELPER
247
     getModuleDs			`thenDs` \ mod -> 
248
     getUniqueDs			`thenDs` \ uniq ->
249
250
     getSrcLocDs			`thenDs` \ src_loc ->
     newSysLocalsDs fe_arg_tys		`thenDs` \ fe_args ->
sof's avatar
sof committed
251
     let
252
253
        wrapper_args | isDyn      = stbl_ptr:fe_args
		     | otherwise  = fe_args
sof's avatar
sof committed
254

255
256
257
258
259
260
261
262
        wrapper_arg_tys | isDyn      = stbl_ptr_ty:fe_arg_tys
		        | otherwise  = fe_arg_tys

	helper_ty =  mkForAllTys tvs $
		     mkFunTys wrapper_arg_tys io_res_ty

	f_helper_glob = mkVanillaId helper_name helper_ty
		      where
263
			name	            = idName fn_id
264
265
266
267
268
			mod	
			 | isLocalName name = mod_name
			 | otherwise        = nameModule name

			occ	            = mkForeignExportOcc (nameOccName name)
269
			helper_name         = mkGlobalName uniq mod occ src_loc
270
271
272
273
274
275

      	the_app = getFun_wrapper (return_io_wrapper (mkVarApps (Var i) (tvs ++ fe_args)))
      	the_body = mkLams (tvs ++ wrapper_args) the_app
      	c_nm     = extNameStatic ext_name
  
      	(h_stub, c_stub) = fexportEntry (moduleUserString mod)
sof's avatar
sof committed
276
      				      c_nm f_helper_glob
277
                                      wrapper_arg_tys res_ty cconv isDyn
sof's avatar
sof committed
278
     in
279
     returnDs (f_helper_glob, (f_helper_glob, the_body), h_stub, c_stub)
280

sof's avatar
sof committed
281
  where
282
   (tvs,sans_foralls)			= splitForAllTys ty
283
   (fe_arg_tys', orig_res_ty)	        = splitFunTys sans_foralls
sof's avatar
sof committed
284
285
286
287

   (_, stbl_ptr_ty')			= splitForAllTys stbl_ptr_ty
   (_, stbl_ptr_to_ty)			= splitAppTy stbl_ptr_ty'

288
289
290
291
292
   fe_arg_tys | isDyn	  = tail fe_arg_tys'
	      | otherwise = fe_arg_tys'

   stbl_ptr_ty | isDyn     = head fe_arg_tys'
	       | otherwise = error "stbl_ptr_ty"
sof's avatar
sof committed
293
294
\end{code}

295
@foreign export dynamic@ lets you dress up Haskell IO actions
sof's avatar
sof committed
296
297
298
299
of some fixed type behind an externally callable interface (i.e.,
as a C function pointer). Useful for callbacks and stuff.

\begin{verbatim}
300
foreign export dynamic f :: (Addr -> Int -> IO Int) -> IO Addr
sof's avatar
sof committed
301

302
303
-- Haskell-visible constructor, which is generated from the above:
-- SUP: No check for NULL from createAdjustor anymore???
sof's avatar
sof committed
304
305

f :: (Addr -> Int -> IO Int) -> IO Addr
306
f cback =
307
   bindIO (newStablePtr cback)
308
309
310
          (\StablePtr sp# -> IO (\s1# ->
              case _ccall_ createAdjustor cconv sp# ``f_helper'' s1# of
                 (# s2#, a# #) -> (# s2#, A# a# #)))
sof's avatar
sof committed
311
312
313
314
315
316
317
318
319

foreign export "f_helper" f_helper :: StablePtr (Addr -> Int -> IO Int) -> Addr -> Int -> IO Int
-- `special' foreign export that invokes the closure pointed to by the
-- first argument.
\end{verbatim}

\begin{code}
dsFExportDynamic :: Id
		 -> Type		-- Type of foreign export.
sof's avatar
sof committed
320
		 -> Module
sof's avatar
sof committed
321
322
		 -> ExtName
		 -> CallConv
323
		 -> DsM (Id, [Binding], SDoc, SDoc)
sof's avatar
sof committed
324
dsFExportDynamic i ty mod_name ext_name cconv =
sof's avatar
sof committed
325
326
327
     newSysLocalDs ty					 `thenDs` \ fe_id ->
     let 
        -- hack: need to get at the name of the C stub we're about to generate.
328
       fe_nm	   = moduleUserString mod_name ++ "_" ++ toCName fe_id
sof's avatar
sof committed
329
330
       fe_ext_name = ExtName (_PK_ fe_nm) Nothing
     in
331
     dsFExport  i export_ty mod_name fe_ext_name cconv True
332
     	`thenDs` \ (feb, fe, h_code, c_code) ->
333
     newSysLocalDs arg_ty			`thenDs` \ cback ->
334
     dsLookupGlobalValue newStablePtrName	`thenDs` \ newStablePtrId ->
sof's avatar
sof committed
335
     let
336
	mk_stbl_ptr_app    = mkApps (Var newStablePtrId) [ Type arg_ty, Var cback ]
sof's avatar
sof committed
337
     in
338
     dsLookupGlobalValue bindIOName		        `thenDs` \ bindIOId ->
339
     newSysLocalDs (mkTyConApp stablePtrTyCon [arg_ty]) `thenDs` \ stbl_value ->
sof's avatar
sof committed
340
     let
341
342
343
344
345
346
347
      stbl_app cont ret_ty 
	= mkApps (Var bindIOId)
		 [ Type (mkTyConApp stablePtrTyCon [arg_ty])
		 , Type ret_ty
		 , mk_stbl_ptr_app
		 , cont
		 ]
348
349
350
351
352
353
354
355

       {-
        The arguments to the external function which will
	create a little bit of (template) code on the fly
	for allowing the (stable pointed) Haskell closure
	to be entered using an external calling convention
	(stdcall, ccall).
       -}
356
      adj_args      = [ mkIntLitInt (callConvToInt cconv)
357
		      , Var stbl_value
358
		      , mkLit (MachLabel (_PK_ fe_nm))
359
360
361
362
363
		      ]
        -- name of external entry point providing these services.
	-- (probably in the RTS.) 
      adjustor	    = SLIT("createAdjustor")
     in
364
     dsCCall adjustor adj_args False False io_res_ty `thenDs` \ ccall_adj ->
365
     let ccall_adj_ty = exprType ccall_adj
366
         ccall_io_adj = mkLams [stbl_value]		     $
367
			Note (Coerce io_res_ty ccall_adj_ty)
368
			     ccall_adj
369
370
371
     in
     let io_app = mkLams tvs	 $
		  mkLams [cback] $
372
		  stbl_app ccall_io_adj res_ty
373
374
375
	 fed = (i `setInlinePragma` neverInlinePrag, io_app)
		-- Never inline the f.e.d. function, because the litlit
		-- might not be in scope in other modules.
376
     in
377
     returnDs (feb, [fed, fe], h_code, c_code)
378

sof's avatar
sof committed
379
380
 where
  (tvs,sans_foralls)		   = splitForAllTys ty
381
  ([arg_ty], io_res_ty)		   = splitFunTys sans_foralls
sof's avatar
sof committed
382

383
  Just (ioTyCon, [res_ty])	   = splitTyConApp_maybe io_res_ty
sof's avatar
sof committed
384
385
386

  export_ty			   = mkFunTy (mkTyConApp stablePtrTyCon [arg_ty]) arg_ty

387
388
389
  ioAddrTy :: Type	-- IO Addr
  ioAddrTy = mkTyConApp ioTyCon [addrTy]

sof's avatar
sof committed
390
391
392
393
394
395
396
397
398
399
toCName :: Id -> String
toCName i = showSDoc (pprCode CStyle (ppr (idName i)))
\end{code}

%*
%
\subsection{Generating @foreign export@ stubs}
%
%*

400
401
402
For each @foreign export@ function, a C stub function is generated.
The C stub constructs the application of the exported Haskell function 
using the hugs/ghc rts invocation API.
sof's avatar
sof committed
403
404

\begin{code}
sof's avatar
sof committed
405
406
fexportEntry :: String
	     -> FAST_STRING
sof's avatar
sof committed
407
408
	     -> Id 
	     -> [Type] 
409
	     -> Type 
sof's avatar
sof committed
410
411
412
	     -> CallConv 
	     -> Bool
	     -> (SDoc, SDoc)
413
fexportEntry mod_nm c_nm helper args res_ty cc isDyn = (header_bits, c_bits)
sof's avatar
sof committed
414
415
 where
   -- name of the (Haskell) helper function generated by the desugarer.
416
417
418
  h_nm	    = ppr helper <> text "_closure"
   -- prototype for the exported function.
  header_bits = ptext SLIT("extern") <+> fun_proto <> semi
sof's avatar
sof committed
419

420
  fun_proto = cResType <+> pprCconv <+> ptext c_nm <>
sof's avatar
sof committed
421
	      parens (hsep (punctuate comma (zipWith (<+>) cParamTypes proto_args)))
sof's avatar
sof committed
422

423
424
425
  c_bits =
    externDecl $$
    fun_proto  $$
sof's avatar
sof committed
426
    vcat 
427
428
429
430
431
432
     [ lbrace
     ,   text "SchedulerStatus rc;"
     ,   declareResult
	  -- create the application + perform it.
     ,   text "rc=rts_evalIO" <> 
                  parens (foldl appArg (text "(StgClosure*)&" <> h_nm) (zip args c_args) <> comma <> text "&ret") <> semi
433
     ,   text "rts_checkSchedStatus" <> parens (doubleQuotes (ptext c_nm)
434
435
						<> comma <> text "rc") <> semi
     ,   text "return" <> return_what <> semi
436
437
     , rbrace
     ]
sof's avatar
sof committed
438

439
440
  appArg acc (a,c_a) =
     text "rts_apply" <> parens (acc <> comma <> mkHObj a <> parens c_a)
sof's avatar
sof committed
441

sof's avatar
sof committed
442
  cParamTypes  = map showStgType real_args
sof's avatar
sof committed
443

444
445
446
447
  res_ty_is_unit = res_ty == unitTy

  cResType | res_ty_is_unit = text "void"
	   | otherwise	    = showStgType res_ty
sof's avatar
sof committed
448
449
450
451
452

  pprCconv
   | cc == cCallConv = empty
   | otherwise	     = pprCallConv cc
     
453
  declareResult  = text "HaskellObj ret;"
sof's avatar
sof committed
454

455
  externDecl     = mkExtern (text "HaskellObj") h_nm
sof's avatar
sof committed
456

457
  mkExtern ty nm = text "extern" <+> ty <+> nm <> semi
sof's avatar
sof committed
458

459
460
  return_what | res_ty_is_unit = empty
	      | otherwise      = parens (unpackHObj res_ty <> parens (text "ret"))
sof's avatar
sof committed
461

sof's avatar
sof committed
462
463
464
465
466
467
468
469
470
471
472
473
474
475
  c_args = mkCArgNames 0 args

  {-
   If we're generating an entry point for a 'foreign export ccall dynamic',
   then we receive the return address of the C function that wants to
   invoke a Haskell function as any other C function, as second arg.
   This arg is unused within the body of the generated C stub, but
   needed by the Adjustor.c code to get the stack cleanup right.
  -}
  (proto_args, real_args)
    | cc == cCallConv && isDyn = ( text "a0" : text "a_" : mkCArgNames 1 (tail args)
				, head args : addrTy : tail args)
    | otherwise = (mkCArgNames 0 args, args)

sof's avatar
sof committed
476
477
mkCArgNames :: Int -> [a] -> [SDoc]
mkCArgNames n as = zipWith (\ _ n -> text ('a':show n)) as [n..] 
sof's avatar
sof committed
478

479
mkHObj :: Type -> SDoc
sof's avatar
sof committed
480
mkHObj t = text "rts_mk" <> text (showFFIType t)
sof's avatar
sof committed
481

482
unpackHObj :: Type -> SDoc
sof's avatar
sof committed
483
unpackHObj t = text "rts_get" <> text (showFFIType t)
484
485

showStgType :: Type -> SDoc
486
showStgType t = text "Hs" <> text (showFFIType t)
sof's avatar
sof committed
487

sof's avatar
sof committed
488
showFFIType :: Type -> String
489
showFFIType t = getOccString (getName (tyConAppTyCon t))
490
\end{code}