2 % (c) The AQUA Project, Glasgow University, 1998
4 \section[DsCCall]{Desugaring \tr{foreign} declarations}
6 Expanding out @foreign import@ and @foreign export@ declarations.
9 module DsForeign ( dsForeigns ) where
11 #include "HsVersions.h"
15 import DsCCall ( dsCCall, mkFCall, boxResult, unboxArg, resultWrapper )
18 import HsSyn ( ForeignDecl(..), ForeignExport(..),
19 ForeignImport(..), CImportSpec(..) )
20 import TcHsSyn ( TypecheckedForeignDecl )
21 import CoreUtils ( exprType, mkInlineMe )
22 import Id ( Id, idType, idName, mkVanillaGlobal, mkSysLocal,
24 import IdInfo ( vanillaIdInfo )
25 import Literal ( Literal(..) )
26 import Module ( Module, moduleUserString )
27 import Name ( mkGlobalName, nameModule, nameOccName, getOccString,
28 mkForeignExportOcc, isLocalName,
31 import Type ( repType, eqType )
32 import TcType ( Type, mkFunTys, mkForAllTys, mkTyConApp,
34 tcSplitForAllTys, tcSplitFunTys, tcTyConAppArgs,
35 tcSplitTyConApp_maybe, tcSplitAppTy,
39 import ForeignCall ( ForeignCall(..), CCallSpec(..),
42 CCallConv(..), ccallConvToInt,
45 import CStrings ( CLabelString )
46 import TysWiredIn ( addrTy, unitTy, stablePtrTyCon )
47 import TysPrim ( addrPrimTy )
48 import PrelNames ( hasKey, ioTyConKey, deRefStablePtrName, newStablePtrName,
49 bindIOName, returnIOName
51 import BasicTypes ( Activation( NeverActive ) )
52 import ErrUtils ( addShortWarnLocLine )
54 import Maybe ( fromJust )
57 Desugaring of @foreign@ declarations is naturally split up into
58 parts, an @import@ and an @export@ part. A @foreign import@
61 foreign import cc nm f :: prim_args -> IO prim_res
65 f :: prim_args -> IO prim_res
66 f a1 ... an = _ccall_ nm cc a1 ... an
68 so we reuse the desugaring code in @DsCCall@ to deal with these.
71 type Binding = (Id, CoreExpr) -- No rec/nonrec structure;
72 -- the occurrence analyser will sort it all out
75 -> [TypecheckedForeignDecl]
76 -> DsM ( [Id] -- Foreign-exported binders;
77 -- we have to generate code to register these
79 , SDoc -- Header file prototypes for
80 -- "foreign exported" functions.
81 , SDoc -- C stubs to use when calling
82 -- "foreign exported" functions.
83 , [FAST_STRING] -- headers that need to be included
84 -- into C code generated for this module
86 dsForeigns mod_name fos
87 = foldlDs combine ([], [], empty, empty, []) fos
89 combine (acc_feb, acc_f, acc_h, acc_c, acc_header)
90 (ForeignImport id _ spec depr loc)
91 = dsFImport mod_name id spec `thenDs` \(bs, h, c, hd) ->
92 warnDepr depr loc `thenDs` \_ ->
93 returnDs (acc_feb, bs ++ acc_f, h $$ acc_h, c $$ acc_c, hd ++ acc_header)
95 combine (acc_feb, acc_f, acc_h, acc_c, acc_header)
96 (ForeignExport id _ (CExport (CExportStatic ext_nm cconv)) depr loc)
97 = dsFExport mod_name id (idType id)
98 ext_nm cconv False `thenDs` \(feb, b, h, c) ->
99 warnDepr depr loc `thenDs` \_ ->
100 returnDs (feb:acc_feb, b:acc_f, h $$ acc_h, c $$ acc_c, acc_header)
102 warnDepr False _ = returnDs ()
103 warnDepr True loc = dsWarn (addShortWarnLocLine loc msg)
105 msg = ptext SLIT("foreign declaration uses deprecated non-standard syntax")
109 %************************************************************************
111 \subsection{Foreign import}
113 %************************************************************************
115 Desugaring foreign imports is just the matter of creating a binding
116 that on its RHS unboxes its arguments, performs the external call
117 (using the @CCallOp@ primop), before boxing the result up and returning it.
119 However, we create a worker/wrapper pair, thus:
121 foreign import f :: Int -> IO Int
123 f x = IO ( \s -> case x of { I# x# ->
124 case fw s x# of { (# s1, y# #) ->
127 fw s x# = ccall f s x#
129 The strictness/CPR analyser won't do this automatically because it doesn't look
130 inside returned tuples; but inlining this wrapper is a Really Good Idea
131 because it exposes the boxing to the call site.
137 -> DsM ([Binding], SDoc, SDoc, [FAST_STRING])
138 dsFImport modName id (CImport cconv safety header lib spec)
139 = dsCImport modName id spec cconv safety `thenDs` \(ids, h, c) ->
140 returnDs (ids, h, c, if _NULL_ header then [] else [header])
141 -- FIXME: the `lib' field is needed for .NET ILX generation when invoking
142 -- routines that are external to the .NET runtime, but GHC doesn't
143 -- support such calls yet; if `_NULL_ lib', the value was not given
144 dsFImport modName id (DNImport spec)
145 = dsFCall modName id (DNCall spec) `thenDs` \(ids, h, c) ->
146 returnDs (ids, h, c, [])
153 -> DsM ([Binding], SDoc, SDoc)
154 dsCImport modName id (CLabel cid) _ _
155 = ASSERT(fromJust resTy `eqType` addrPrimTy) -- typechecker ensures this
156 returnDs ([(id, rhs)], empty, empty)
158 (resTy, foRhs) = resultWrapper (idType id)
159 rhs = foRhs (mkLit (MachLabel cid))
160 dsCImport modName id (CFunction target) cconv safety
161 = dsFCall modName id (CCall (CCallSpec target cconv safety))
162 dsCImport modName id CWrapper cconv _
163 = dsFExportDynamic modName id cconv
167 %************************************************************************
169 \subsection{Foreign calls}
171 %************************************************************************
174 dsFCall mod_Name fn_id fcall
177 (tvs, fun_ty) = tcSplitForAllTys ty
178 (arg_tys, io_res_ty) = tcSplitFunTys fun_ty
179 -- Must use tcSplit* functions because we want to
180 -- see that (IO t) in the corner
182 newSysLocalsDs arg_tys `thenDs` \ args ->
183 mapAndUnzipDs unboxArg (map Var args) `thenDs` \ (val_args, arg_wrappers) ->
186 work_arg_ids = [v | Var v <- val_args] -- All guaranteed to be vars
188 -- These are the ids we pass to boxResult, which are used to decide
189 -- whether to touch# an argument after the call (used to keep
190 -- ForeignObj#s live across a 'safe' foreign import).
191 maybe_arg_ids | unsafe_call fcall = work_arg_ids
194 boxResult maybe_arg_ids io_res_ty `thenDs` \ (ccall_result_ty, res_wrapper) ->
196 getUniqueDs `thenDs` \ ccall_uniq ->
197 getUniqueDs `thenDs` \ work_uniq ->
200 worker_ty = mkForAllTys tvs (mkFunTys (map idType work_arg_ids) ccall_result_ty)
201 the_ccall_app = mkFCall ccall_uniq fcall val_args ccall_result_ty
202 work_rhs = mkLams tvs (mkLams work_arg_ids the_ccall_app)
203 work_id = mkSysLocal SLIT("$wccall") work_uniq worker_ty
206 work_app = mkApps (mkVarApps (Var work_id) tvs) val_args
207 wrapper_body = foldr ($) (res_wrapper work_app) arg_wrappers
208 wrap_rhs = mkInlineMe (mkLams (tvs ++ args) wrapper_body)
210 returnDs ([(work_id, work_rhs), (fn_id, wrap_rhs)], empty, empty)
212 unsafe_call (CCall (CCallSpec _ _ safety)) = playSafe safety
213 unsafe_call (DNCall _) = False
217 %************************************************************************
219 \subsection{Foreign export}
221 %************************************************************************
223 The function that does most of the work for `@foreign export@' declarations.
224 (see below for the boilerplate code a `@foreign export@' declaration expands
227 For each `@foreign export foo@' in a module M we generate:
229 \item a C function `@foo@', which calls
230 \item a Haskell stub `@M.$ffoo@', which calls
232 the user-written Haskell function `@M.foo@'.
236 -> Id -- Either the exported Id,
237 -- or the foreign-export-dynamic constructor
238 -> Type -- The type of the thing callable from C
239 -> CLabelString -- The name to export to C land
241 -> Bool -- True => foreign export dynamic
242 -- so invoke IO action that's hanging off
243 -- the first argument's stable pointer
244 -> DsM ( Id -- The foreign-exported Id
249 dsFExport mod_name fn_id ty ext_name cconv isDyn
250 = -- BUILD THE returnIO WRAPPER, if necessary
251 -- Look at the result type of the exported function, orig_res_ty
252 -- If it's IO t, return (\x.x, IO t, t)
253 -- If it's plain t, return (\x.returnIO x, IO t, t)
254 (case tcSplitTyConApp_maybe orig_res_ty of
255 -- We must use tcSplit here so that we see the (IO t) in
256 -- the type. [IO t is transparent to plain splitTyConApp.]
258 Just (ioTyCon, [res_ty])
259 -> ASSERT( ioTyCon `hasKey` ioTyConKey )
260 -- The function already returns IO t
261 returnDs (\body -> body, orig_res_ty, res_ty)
263 other -> -- The function returns t, so wrap the call in returnIO
264 dsLookupGlobalValue returnIOName `thenDs` \ retIOId ->
265 returnDs (\body -> mkApps (Var retIOId) [Type orig_res_ty, body],
266 tcFunResultTy (applyTy (idType retIOId) orig_res_ty),
267 -- We don't have ioTyCon conveniently to hand
270 ) `thenDs` \ (return_io_wrapper, -- Either identity or returnIO
275 -- BUILD THE deRefStablePtr WRAPPER, if necessary
277 newSysLocalDs stbl_ptr_ty `thenDs` \ stbl_ptr ->
278 newSysLocalDs stbl_ptr_to_ty `thenDs` \ stbl_value ->
279 dsLookupGlobalValue deRefStablePtrName `thenDs` \ deRefStablePtrId ->
280 dsLookupGlobalValue bindIOName `thenDs` \ bindIOId ->
282 the_deref_app = mkApps (Var deRefStablePtrId)
283 [ Type stbl_ptr_to_ty, Var stbl_ptr ]
285 stbl_app cont = mkApps (Var bindIOId)
286 [ Type stbl_ptr_to_ty
289 , mkLams [stbl_value] cont]
291 returnDs (stbl_value, stbl_app, stbl_ptr)
295 panic "stbl_ptr" -- should never be touched.
296 )) `thenDs` \ (i, getFun_wrapper, stbl_ptr) ->
300 getModuleDs `thenDs` \ mod ->
301 getUniqueDs `thenDs` \ uniq ->
302 getSrcLocDs `thenDs` \ src_loc ->
303 newSysLocalsDs fe_arg_tys `thenDs` \ fe_args ->
305 wrapper_args | isDyn = stbl_ptr:fe_args
306 | otherwise = fe_args
308 wrapper_arg_tys | isDyn = stbl_ptr_ty:fe_arg_tys
309 | otherwise = fe_arg_tys
311 helper_ty = mkForAllTys tvs $
312 mkFunTys wrapper_arg_tys io_res_ty
314 f_helper_glob = mkVanillaGlobal helper_name helper_ty vanillaIdInfo
318 | isLocalName name = mod_name
319 | otherwise = nameModule name
321 occ = mkForeignExportOcc (nameOccName name)
322 helper_name = mkGlobalName uniq mod occ src_loc
324 the_app = getFun_wrapper (return_io_wrapper (mkVarApps (Var i) (tvs ++ fe_args)))
325 the_body = mkLams (tvs ++ wrapper_args) the_app
327 (h_stub, c_stub) = fexportEntry (moduleUserString mod)
329 (if isDyn then Nothing else Just f_helper_glob)
330 fe_arg_tys res_ty cconv
332 returnDs (f_helper_glob, (f_helper_glob, the_body), h_stub, c_stub)
335 (tvs,sans_foralls) = tcSplitForAllTys ty
336 (fe_arg_tys', orig_res_ty) = tcSplitFunTys sans_foralls
337 -- We must use tcSplits here, because we want to see
338 -- the (IO t) in the corner of the type!
340 fe_arg_tys | isDyn = tail fe_arg_tys'
341 | otherwise = fe_arg_tys'
343 stbl_ptr_ty | isDyn = head fe_arg_tys'
344 | otherwise = error "stbl_ptr_ty"
346 (_, stbl_ptr_ty') = tcSplitForAllTys stbl_ptr_ty
347 (_, stbl_ptr_to_ty) = tcSplitAppTy stbl_ptr_ty'
348 -- Again, stable pointers are just newtypes,
349 -- so we must see them! Hence tcSplit*
352 @foreign export dynamic@ lets you dress up Haskell IO actions
353 of some fixed type behind an externally callable interface (i.e.,
354 as a C function pointer). Useful for callbacks and stuff.
357 foreign export dynamic f :: (Addr -> Int -> IO Int) -> IO Addr
359 -- Haskell-visible constructor, which is generated from the above:
360 -- SUP: No check for NULL from createAdjustor anymore???
362 f :: (Addr -> Int -> IO Int) -> IO Addr
364 bindIO (newStablePtr cback)
365 (\StablePtr sp# -> IO (\s1# ->
366 case _ccall_ createAdjustor cconv sp# ``f_helper'' s1# of
367 (# s2#, a# #) -> (# s2#, A# a# #)))
369 foreign export "f_helper" f_helper :: StablePtr (Addr -> Int -> IO Int) -> Addr -> Int -> IO Int
370 -- `special' foreign export that invokes the closure pointed to by the
375 dsFExportDynamic :: Module
378 -> DsM ([Binding], SDoc, SDoc)
379 dsFExportDynamic mod_name id cconv
380 = newSysLocalDs ty `thenDs` \ fe_id ->
382 -- hack: need to get at the name of the C stub we're about to generate.
383 fe_nm = _PK_ (moduleUserString mod_name ++ "_" ++ toCName fe_id)
385 dsFExport mod_name id export_ty fe_nm cconv True `thenDs` \ ({-feb-}_, {-fe-}_, h_code, c_code) ->
386 newSysLocalDs arg_ty `thenDs` \ cback ->
387 dsLookupGlobalValue newStablePtrName `thenDs` \ newStablePtrId ->
389 mk_stbl_ptr_app = mkApps (Var newStablePtrId) [ Type arg_ty, Var cback ]
391 dsLookupGlobalValue bindIOName `thenDs` \ bindIOId ->
392 newSysLocalDs (mkTyConApp stablePtrTyCon [arg_ty]) `thenDs` \ stbl_value ->
395 = mkApps (Var bindIOId)
396 [ Type (mkTyConApp stablePtrTyCon [arg_ty])
403 The arguments to the external function which will
404 create a little bit of (template) code on the fly
405 for allowing the (stable pointed) Haskell closure
406 to be entered using an external calling convention
409 adj_args = [ mkIntLitInt (ccallConvToInt cconv)
411 , mkLit (MachLabel fe_nm)
413 -- name of external entry point providing these services.
414 -- (probably in the RTS.)
415 adjustor = SLIT("createAdjustor")
417 dsCCall adjustor adj_args PlayRisky False io_res_ty `thenDs` \ ccall_adj ->
418 -- PlayRisky: the adjustor doesn't allocate in the Haskell heap or do a callback
419 let ccall_adj_ty = exprType ccall_adj
420 ccall_io_adj = mkLams [stbl_value] $
421 Note (Coerce io_res_ty ccall_adj_ty)
423 io_app = mkLams tvs $
425 stbl_app ccall_io_adj res_ty
426 fed = (id `setInlinePragma` NeverActive, io_app)
427 -- Never inline the f.e.d. function, because the litlit
428 -- might not be in scope in other modules.
430 returnDs ([fed] {-[fed, fe]-}, h_code, c_code)
434 (tvs,sans_foralls) = tcSplitForAllTys ty
435 ([arg_ty], io_res_ty) = tcSplitFunTys sans_foralls
436 [res_ty] = tcTyConAppArgs io_res_ty
437 -- Must use tcSplit* to see the (IO t), which is a newtype
438 export_ty = mkFunTy (mkTyConApp stablePtrTyCon [arg_ty]) arg_ty
440 toCName :: Id -> String
441 toCName i = showSDoc (pprCode CStyle (ppr (idName i)))
446 \subsection{Generating @foreign export@ stubs}
450 For each @foreign export@ function, a C stub function is generated.
451 The C stub constructs the application of the exported Haskell function
452 using the hugs/ghc rts invocation API.
455 fexportEntry :: String
457 -> Maybe Id -- Just==static, Nothing==dynamic
462 fexportEntry mod_nm c_nm maybe_target arg_htys res_hty cc = (header_bits, c_bits)
464 -- Create up types and names for the real args
465 arg_cnames, arg_ctys :: [SDoc]
466 arg_cnames = mkCArgNames 1 arg_htys
467 arg_ctys = map showStgType arg_htys
469 -- and also for auxiliary ones; the stable ptr in the dynamic case, and
470 -- a slot for the dummy return address in the dynamic + ccall case
471 extra_cnames_and_ctys
472 = case maybe_target of
473 Nothing -> [(text "the_stableptr", text "StgStablePtr")]
476 case (maybe_target, cc) of
477 (Nothing, CCallConv) -> [(text "original_return_addr", text "void*")]
480 all_cnames_and_ctys :: [(SDoc, SDoc)]
482 = extra_cnames_and_ctys ++ zip arg_cnames arg_ctys
484 -- stuff to do with the return type of the C function
485 res_hty_is_unit = res_hty `eqType` unitTy -- Look through any newtypes
487 cResType | res_hty_is_unit = text "void"
488 | otherwise = showStgType res_hty
490 -- Now we can cook up the prototype for the exported function.
491 pprCconv = case cc of
493 StdCallConv -> text (ccallConvAttribute cc)
495 header_bits = ptext SLIT("extern") <+> fun_proto <> semi
497 fun_proto = cResType <+> pprCconv <+> ptext c_nm <>
498 parens (hsep (punctuate comma (map (\(nm,ty) -> ty <+> nm)
499 all_cnames_and_ctys)))
501 -- the target which will form the root of what we ask rts_evalIO to run
503 = case maybe_target of
504 Nothing -> text "(StgClosure*)deRefStablePtr(the_stableptr)"
505 Just hs_fn -> ppr hs_fn <> text "_closure"
507 -- the expression we give to rts_evalIO
509 = foldl appArg the_cfun (zip arg_cnames arg_htys)
511 appArg acc (arg_cname, arg_hty)
513 <> parens (acc <> comma <> mkHObj arg_hty <> parens arg_cname)
515 -- various other bits for inside the fn
516 declareResult = text "HaskellObj ret;"
518 return_what | res_hty_is_unit = empty
519 | otherwise = parens (unpackHObj res_hty <> parens (text "ret"))
521 -- an extern decl for the fn being called
523 = case maybe_target of
525 Just hs_fn -> text "extern StgClosure* " <> ppr hs_fn <> text "_closure" <> semi
527 -- finally, the whole darn thing
533 , text "SchedulerStatus rc;"
535 -- create the application + perform it.
536 , text "rc=rts_evalIO"
537 <> parens (expr_to_run <+> comma <> text "&ret")
539 , text "rts_checkSchedStatus" <> parens (doubleQuotes (ptext c_nm)
540 <> comma <> text "rc") <> semi
541 , text "return" <> return_what <> semi
546 mkCArgNames :: Int -> [a] -> [SDoc]
547 mkCArgNames n as = zipWith (\ _ n -> text ('a':show n)) as [n..]
549 mkHObj :: Type -> SDoc
550 mkHObj t = text "rts_mk" <> text (showFFIType t)
552 unpackHObj :: Type -> SDoc
553 unpackHObj t = text "rts_get" <> text (showFFIType t)
555 showStgType :: Type -> SDoc
556 showStgType t = text "Hs" <> text (showFFIType t)
558 showFFIType :: Type -> String
559 showFFIType t = getOccString (getName tc)
561 tc = case tcSplitTyConApp_maybe (repType t) of
563 Nothing -> pprPanic "showFFIType" (ppr t)