ghc/compiler/deSugar/DsForeign.lhs

   1 %
   2 % (c) The AQUA Project, Glasgow University, 1998
   3 %
   4 \section[DsCCall]{Desugaring \tr{foreign} declarations}
   5
   6 Expanding out @foreign import@ and @foreign export@ declarations.
   7
   8 \begin{code}
   9 module DsForeign ( dsForeigns ) where
  10
  11 #include "HsVersions.h"
  12
  13 import CoreSyn
  14
  15 import DsCCall          ( dsCCall, mkFCall, boxResult, unboxArg, resultWrapper )
  16 import DsMonad
  17
  18 import HsSyn            ( ForeignDecl(..), FoExport(..), FoImport(..)  )
  19 import TcHsSyn          ( TypecheckedForeignDecl )
  20 import CoreUtils        ( exprType, mkInlineMe )
  21 import Id               ( Id, idType, idName, mkVanillaGlobal, mkSysLocal,
  22                           setInlinePragma )
  23 import IdInfo           ( neverInlinePrag, vanillaIdInfo )
  24 import Literal          ( Literal(..) )
  25 import Module           ( Module, moduleUserString )
  26 import Name             ( mkGlobalName, nameModule, nameOccName, getOccString,
  27                           mkForeignExportOcc, isLocalName,
  28                           NamedThing(..),
  29                         )
  30
  31         -- Import Type not TcType; in this module we are generating code
  32         -- to marshal representation types across to C
  33 import Type             ( splitTyConApp_maybe, funResultTy,
  34                           splitFunTys, splitForAllTys, splitAppTy,
  35                           Type, mkFunTys, mkForAllTys, mkTyConApp,
  36                           mkFunTy, applyTy, eqType, repType
  37                         )
  38 import TcType           ( tcSplitForAllTys, tcSplitFunTys,
  39                           tcSplitTyConApp_maybe, tcSplitAppTy,
  40                           tcFunResultTy
  41                         )
  42
  43 import ForeignCall      ( ForeignCall(..), CCallSpec(..),
  44                           Safety(..), playSafe,
  45                           CExportSpec(..),
  46                           CCallConv(..), ccallConvToInt
  47                         )
  48 import CStrings         ( CLabelString )
  49 import TysWiredIn       ( addrTy, unitTy, stablePtrTyCon )
  50 import TysPrim          ( addrPrimTy )
  51 import PrelNames        ( hasKey, ioTyConKey, deRefStablePtrName, newStablePtrName,
  52                           bindIOName, returnIOName
  53                         )
  54 import Outputable
  55
  56 import Maybe            ( fromJust )
  57 \end{code}
  58
  59 Desugaring of @foreign@ declarations is naturally split up into
  60 parts, an @import@ and an @export@  part. A @foreign import@
  61 declaration
  62 \begin{verbatim}
  63   foreign import cc nm f :: prim_args -> IO prim_res
  64 \end{verbatim}
  65 is the same as
  66 \begin{verbatim}
  67   f :: prim_args -> IO prim_res
  68   f a1 ... an = _ccall_ nm cc a1 ... an
  69 \end{verbatim}
  70 so we reuse the desugaring code in @DsCCall@ to deal with these.
  71
  72 \begin{code}
  73 type Binding = (Id, CoreExpr)   -- No rec/nonrec structure;
  74                                 -- the occurrence analyser will sort it all out
  75
  76 dsForeigns :: Module
  77            -> [TypecheckedForeignDecl]
  78            -> DsM ( [Id]                -- Foreign-exported binders;
  79                                         -- we have to generate code to register these
  80                   , [Binding]
  81                   , SDoc              -- Header file prototypes for
  82                                       -- "foreign exported" functions.
  83                   , SDoc              -- C stubs to use when calling
  84                                       -- "foreign exported" functions.
  85                   )
  86 dsForeigns mod_name fos
  87   = foldlDs combine ([], [], empty, empty) fos
  88  where
  89   combine (acc_feb, acc_f, acc_h, acc_c) (ForeignImport id _ spec _)
  90     = dsFImport mod_name id spec        `thenDs` \ (bs, h, c) ->
  91       returnDs (acc_feb, bs ++ acc_f, h $$ acc_h, c $$ acc_c)
  92
  93   combine (acc_feb, acc_f, acc_h, acc_c) (ForeignExport id _ (CExport (CExportStatic ext_nm cconv)) _)
  94     = dsFExport mod_name id (idType id) ext_nm cconv False      `thenDs` \ (feb, b, h, c) ->
  95       returnDs (feb:acc_feb, b : acc_f, h $$ acc_h, c $$ acc_c)
  96 \end{code}
  97
  98
  99 %************************************************************************
 100 %*                                                                      *
 101 \subsection{Foreign import}
 102 %*                                                                      *
 103 %************************************************************************
 104
 105 Desugaring foreign imports is just the matter of creating a binding
 106 that on its RHS unboxes its arguments, performs the external call
 107 (using the @CCallOp@ primop), before boxing the result up and returning it.
 108
 109 However, we create a worker/wrapper pair, thus:
 110
 111         foreign import f :: Int -> IO Int
 112 ==>
 113         f x = IO ( \s -> case x of { I# x# ->
 114                          case fw s x# of { (# s1, y# #) ->
 115                          (# s1, I# y# #)}})
 116
 117         fw s x# = ccall f s x#
 118
 119 The strictness/CPR analyser won't do this automatically because it doesn't look
 120 inside returned tuples; but inlining this wrapper is a Really Good Idea
 121 because it exposes the boxing to the call site.
 122
 123
 124 \begin{code}
 125 dsFImport :: Module
 126           -> Id
 127           -> FoImport
 128           -> DsM ([Binding], SDoc, SDoc)
 129 dsFImport mod_name lbl_id (LblImport ext_nm)
 130  = ASSERT(fromJust res_ty `eqType` addrPrimTy) -- typechecker ensures this
 131    returnDs ([(lbl_id, rhs)], empty, empty)
 132  where
 133    (res_ty, fo_rhs) = resultWrapper (idType lbl_id)
 134    rhs              = fo_rhs (mkLit (MachLabel ext_nm))
 135
 136 dsFImport mod_name fn_id (CImport spec)     = dsFCall mod_name fn_id (CCall spec)
 137 dsFImport mod_name fn_id (DNImport spec)    = dsFCall mod_name fn_id (DNCall spec)
 138 dsFImport mod_name fn_id (CDynImport cconv) = dsFExportDynamic mod_name fn_id cconv
 139 \end{code}
 140
 141
 142 %************************************************************************
 143 %*                                                                      *
 144 \subsection{Foreign calls}
 145 %*                                                                      *
 146 %************************************************************************
 147
 148 \begin{code}
 149 dsFCall mod_Name fn_id fcall
 150   = let
 151         ty                   = idType fn_id
 152         (tvs, fun_ty)        = tcSplitForAllTys ty
 153         (arg_tys, io_res_ty) = tcSplitFunTys fun_ty
 154     in
 155     newSysLocalsDs arg_tys                      `thenDs` \ args ->
 156     mapAndUnzipDs unboxArg (map Var args)       `thenDs` \ (val_args, arg_wrappers) ->
 157
 158     let
 159         work_arg_ids  = [v | Var v <- val_args] -- All guaranteed to be vars
 160
 161         -- These are the ids we pass to boxResult, which are used to decide
 162         -- whether to touch# an argument after the call (used to keep
 163         -- ForeignObj#s live across a 'safe' foreign import).
 164         maybe_arg_ids | unsafe_call fcall = work_arg_ids
 165                       | otherwise         = []
 166     in
 167     boxResult maybe_arg_ids io_res_ty           `thenDs` \ (ccall_result_ty, res_wrapper) ->
 168
 169     getUniqueDs                                 `thenDs` \ ccall_uniq ->
 170     getUniqueDs                                 `thenDs` \ work_uniq ->
 171     let
 172         -- Build the worker
 173         worker_ty     = mkForAllTys tvs (mkFunTys (map idType work_arg_ids) ccall_result_ty)
 174         the_ccall_app = mkFCall ccall_uniq fcall val_args ccall_result_ty
 175         work_rhs      = mkLams tvs (mkLams work_arg_ids the_ccall_app)
 176         work_id       = mkSysLocal SLIT("$wccall") work_uniq worker_ty
 177
 178         -- Build the wrapper
 179         work_app     = mkApps (mkVarApps (Var work_id) tvs) val_args
 180         wrapper_body = foldr ($) (res_wrapper work_app) arg_wrappers
 181         wrap_rhs     = mkInlineMe (mkLams (tvs ++ args) wrapper_body)
 182     in
 183     returnDs ([(work_id, work_rhs), (fn_id, wrap_rhs)], empty, empty)
 184
 185 unsafe_call (CCall (CCallSpec _ _ safety)) = playSafe safety
 186 unsafe_call (DNCall _)                     = False
 187 \end{code}
 188
 189
 190 %************************************************************************
 191 %*                                                                      *
 192 \subsection{Foreign export}
 193 %*                                                                      *
 194 %************************************************************************
 195
 196 The function that does most of the work for `@foreign export@' declarations.
 197 (see below for the boilerplate code a `@foreign export@' declaration expands
 198  into.)
 199
 200 For each `@foreign export foo@' in a module M we generate:
 201 \begin{itemize}
 202 \item a C function `@foo@', which calls
 203 \item a Haskell stub `@M.$ffoo@', which calls
 204 \end{itemize}
 205 the user-written Haskell function `@M.foo@'.
 206
 207 \begin{code}
 208 dsFExport :: Module
 209           -> Id                 -- Either the exported Id,
 210                                 -- or the foreign-export-dynamic constructor
 211           -> Type               -- The type of the thing callable from C
 212           -> CLabelString       -- The name to export to C land
 213           -> CCallConv
 214           -> Bool               -- True => foreign export dynamic
 215                                 --         so invoke IO action that's hanging off
 216                                 --         the first argument's stable pointer
 217           -> DsM ( Id           -- The foreign-exported Id
 218                  , Binding
 219                  , SDoc
 220                  , SDoc
 221                  )
 222 dsFExport mod_name fn_id ty ext_name cconv isDyn
 223   =     -- BUILD THE returnIO WRAPPER, if necessary
 224         -- Look at the result type of the exported function, orig_res_ty
 225         -- If it's IO t, return         (\x.x,          IO t, t)
 226         -- If it's plain t, return      (\x.returnIO x, IO t, t)
 227      (case tcSplitTyConApp_maybe orig_res_ty of
 228         Just (ioTyCon, [res_ty])
 229               -> ASSERT( ioTyCon `hasKey` ioTyConKey )
 230                         -- The function already returns IO t
 231                  returnDs (\body -> body, orig_res_ty, res_ty)
 232
 233         other ->        -- The function returns t, so wrap the call in returnIO
 234                  dsLookupGlobalValue returnIOName       `thenDs` \ retIOId ->
 235                  returnDs (\body -> mkApps (Var retIOId) [Type orig_res_ty, body],
 236                            tcFunResultTy (applyTy (idType retIOId) orig_res_ty),
 237                                 -- We don't have ioTyCon conveniently to hand
 238                            orig_res_ty)
 239
 240      )          `thenDs` \ (return_io_wrapper,  -- Either identity or returnIO
 241                             io_res_ty,          -- IO t
 242                             res_ty) ->          -- t
 243
 244
 245         -- BUILD THE deRefStablePtr WRAPPER, if necessary
 246      (if isDyn then
 247         newSysLocalDs stbl_ptr_ty                       `thenDs` \ stbl_ptr ->
 248         newSysLocalDs stbl_ptr_to_ty                    `thenDs` \ stbl_value ->
 249         dsLookupGlobalValue deRefStablePtrName          `thenDs` \ deRefStablePtrId ->
 250         dsLookupGlobalValue bindIOName                  `thenDs` \ bindIOId ->
 251         let
 252          the_deref_app = mkApps (Var deRefStablePtrId)
 253                                 [ Type stbl_ptr_to_ty, Var stbl_ptr ]
 254
 255          stbl_app cont = mkApps (Var bindIOId)
 256                                 [ Type stbl_ptr_to_ty
 257                                 , Type res_ty
 258                                 , the_deref_app
 259                                 , mkLams [stbl_value] cont]
 260         in
 261         returnDs (stbl_value, stbl_app, stbl_ptr)
 262       else
 263         returnDs (fn_id,
 264                   \ body -> body,
 265                   panic "stbl_ptr"  -- should never be touched.
 266                   ))                    `thenDs` \ (i, getFun_wrapper, stbl_ptr) ->
 267
 268
 269         -- BUILD THE HELPER
 270      getModuleDs                        `thenDs` \ mod ->
 271      getUniqueDs                        `thenDs` \ uniq ->
 272      getSrcLocDs                        `thenDs` \ src_loc ->
 273      newSysLocalsDs fe_arg_tys          `thenDs` \ fe_args ->
 274      let
 275         wrapper_args | isDyn      = stbl_ptr:fe_args
 276                      | otherwise  = fe_args
 277
 278         wrapper_arg_tys | isDyn      = stbl_ptr_ty:fe_arg_tys
 279                         | otherwise  = fe_arg_tys
 280
 281         helper_ty =  mkForAllTys tvs $
 282                      mkFunTys wrapper_arg_tys io_res_ty
 283
 284         f_helper_glob = mkVanillaGlobal helper_name helper_ty vanillaIdInfo
 285                       where
 286                         name                = idName fn_id
 287                         mod
 288                          | isLocalName name = mod_name
 289                          | otherwise        = nameModule name
 290
 291                         occ                 = mkForeignExportOcc (nameOccName name)
 292                         helper_name         = mkGlobalName uniq mod occ src_loc
 293
 294         the_app = getFun_wrapper (return_io_wrapper (mkVarApps (Var i) (tvs ++ fe_args)))
 295         the_body = mkLams (tvs ++ wrapper_args) the_app
 296
 297         (h_stub, c_stub) = fexportEntry (moduleUserString mod)
 298                                         ext_name f_helper_glob
 299                                         wrapper_arg_tys res_ty cconv isDyn
 300      in
 301      returnDs (f_helper_glob, (f_helper_glob, the_body), h_stub, c_stub)
 302
 303   where
 304    (tvs,sans_foralls)           = tcSplitForAllTys ty
 305    (fe_arg_tys', orig_res_ty)   = tcSplitFunTys sans_foralls
 306
 307    (_, stbl_ptr_ty')            = tcSplitForAllTys stbl_ptr_ty
 308    (_, stbl_ptr_to_ty)          = tcSplitAppTy stbl_ptr_ty'
 309
 310    fe_arg_tys | isDyn     = tail fe_arg_tys'
 311               | otherwise = fe_arg_tys'
 312
 313    stbl_ptr_ty | isDyn     = head fe_arg_tys'
 314                | otherwise = error "stbl_ptr_ty"
 315 \end{code}
 316
 317 @foreign export dynamic@ lets you dress up Haskell IO actions
 318 of some fixed type behind an externally callable interface (i.e.,
 319 as a C function pointer). Useful for callbacks and stuff.
 320
 321 \begin{verbatim}
 322 foreign export dynamic f :: (Addr -> Int -> IO Int) -> IO Addr
 323
 324 -- Haskell-visible constructor, which is generated from the above:
 325 -- SUP: No check for NULL from createAdjustor anymore???
 326
 327 f :: (Addr -> Int -> IO Int) -> IO Addr
 328 f cback =
 329    bindIO (newStablePtr cback)
 330           (\StablePtr sp# -> IO (\s1# ->
 331               case _ccall_ createAdjustor cconv sp# ``f_helper'' s1# of
 332                  (# s2#, a# #) -> (# s2#, A# a# #)))
 333
 334 foreign export "f_helper" f_helper :: StablePtr (Addr -> Int -> IO Int) -> Addr -> Int -> IO Int
 335 -- `special' foreign export that invokes the closure pointed to by the
 336 -- first argument.
 337 \end{verbatim}
 338
 339 \begin{code}
 340 dsFExportDynamic :: Module
 341                  -> Id
 342                  -> CCallConv
 343                  -> DsM ([Binding], SDoc, SDoc)
 344 dsFExportDynamic mod_name id cconv
 345   =  newSysLocalDs ty                                    `thenDs` \ fe_id ->
 346      let
 347         -- hack: need to get at the name of the C stub we're about to generate.
 348        fe_nm       = _PK_ (moduleUserString mod_name ++ "_" ++ toCName fe_id)
 349      in
 350      dsFExport mod_name id export_ty fe_nm cconv True   `thenDs` \ (feb, fe, h_code, c_code) ->
 351      newSysLocalDs arg_ty                               `thenDs` \ cback ->
 352      dsLookupGlobalValue newStablePtrName               `thenDs` \ newStablePtrId ->
 353      let
 354         mk_stbl_ptr_app    = mkApps (Var newStablePtrId) [ Type arg_ty, Var cback ]
 355      in
 356      dsLookupGlobalValue bindIOName                     `thenDs` \ bindIOId ->
 357      newSysLocalDs (mkTyConApp stablePtrTyCon [arg_ty]) `thenDs` \ stbl_value ->
 358      let
 359       stbl_app cont ret_ty
 360         = mkApps (Var bindIOId)
 361                  [ Type (mkTyConApp stablePtrTyCon [arg_ty])
 362                  , Type ret_ty
 363                  , mk_stbl_ptr_app
 364                  , cont
 365                  ]
 366
 367        {-
 368         The arguments to the external function which will
 369         create a little bit of (template) code on the fly
 370         for allowing the (stable pointed) Haskell closure
 371         to be entered using an external calling convention
 372         (stdcall, ccall).
 373        -}
 374       adj_args      = [ mkIntLitInt (ccallConvToInt cconv)
 375                       , Var stbl_value
 376                       , mkLit (MachLabel fe_nm)
 377                       ]
 378         -- name of external entry point providing these services.
 379         -- (probably in the RTS.)
 380       adjustor      = SLIT("createAdjustor")
 381      in
 382      dsCCall adjustor adj_args PlayRisky False io_res_ty        `thenDs` \ ccall_adj ->
 383         -- PlayRisky: the adjustor doesn't allocate in the Haskell heap or do a callback
 384      let ccall_adj_ty = exprType ccall_adj
 385          ccall_io_adj = mkLams [stbl_value]                  $
 386                         Note (Coerce io_res_ty ccall_adj_ty)
 387                              ccall_adj
 388          io_app = mkLams tvs     $
 389                   mkLams [cback] $
 390                   stbl_app ccall_io_adj res_ty
 391          fed = (id `setInlinePragma` neverInlinePrag, io_app)
 392                 -- Never inline the f.e.d. function, because the litlit
 393                 -- might not be in scope in other modules.
 394      in
 395      returnDs ([fed, fe], h_code, c_code)
 396
 397  where
 398   ty                               = idType id
 399   (tvs,sans_foralls)               = tcSplitForAllTys ty
 400   ([arg_ty], io_res_ty)            = tcSplitFunTys sans_foralls
 401   Just (ioTyCon, [res_ty])         = tcSplitTyConApp_maybe io_res_ty
 402   export_ty                        = mkFunTy (mkTyConApp stablePtrTyCon [arg_ty]) arg_ty
 403
 404 toCName :: Id -> String
 405 toCName i = showSDoc (pprCode CStyle (ppr (idName i)))
 406 \end{code}
 407
 408 %*
 409 %
 410 \subsection{Generating @foreign export@ stubs}
 411 %
 412 %*
 413
 414 For each @foreign export@ function, a C stub function is generated.
 415 The C stub constructs the application of the exported Haskell function
 416 using the hugs/ghc rts invocation API.
 417
 418 \begin{code}
 419 fexportEntry :: String
 420              -> FAST_STRING
 421              -> Id
 422              -> [Type]
 423              -> Type
 424              -> CCallConv
 425              -> Bool
 426              -> (SDoc, SDoc)
 427 fexportEntry mod_nm c_nm helper args res_ty cc isDyn = (header_bits, c_bits)
 428  where
 429    -- name of the (Haskell) helper function generated by the desugarer.
 430   h_nm      = ppr helper <> text "_closure"
 431    -- prototype for the exported function.
 432   header_bits = ptext SLIT("extern") <+> fun_proto <> semi
 433
 434   fun_proto = cResType <+> pprCconv <+> ptext c_nm <>
 435               parens (hsep (punctuate comma (zipWith (<+>) cParamTypes proto_args)))
 436
 437   c_bits =
 438     externDecl $$
 439     fun_proto  $$
 440     vcat
 441      [ lbrace
 442      ,   text "SchedulerStatus rc;"
 443      ,   declareResult
 444           -- create the application + perform it.
 445      ,   text "rc=rts_evalIO" <>
 446                   parens (foldl appArg (text "(StgClosure*)&" <> h_nm) (zip args c_args) <> comma <> text "&ret") <> semi
 447      ,   text "rts_checkSchedStatus" <> parens (doubleQuotes (ptext c_nm)
 448                                                 <> comma <> text "rc") <> semi
 449      ,   text "return" <> return_what <> semi
 450      , rbrace
 451      ]
 452
 453   appArg acc (a,c_a) =
 454      text "rts_apply" <> parens (acc <> comma <> mkHObj a <> parens c_a)
 455
 456   cParamTypes  = map showStgType real_args
 457
 458   res_ty_is_unit = res_ty `eqType` unitTy
 459
 460   cResType | res_ty_is_unit = text "void"
 461            | otherwise      = showStgType res_ty
 462
 463   pprCconv = case cc of
 464                 CCallConv   -> empty
 465                 StdCallConv -> ppr cc
 466
 467   declareResult  = text "HaskellObj ret;"
 468
 469   externDecl     = mkExtern (text "HaskellObj") h_nm
 470
 471   mkExtern ty nm = text "extern" <+> ty <+> nm <> semi
 472
 473   return_what | res_ty_is_unit = empty
 474               | otherwise      = parens (unpackHObj res_ty <> parens (text "ret"))
 475
 476   c_args = mkCArgNames 0 args
 477
 478   {-
 479    If we're generating an entry point for a 'foreign export ccall dynamic',
 480    then we receive the return address of the C function that wants to
 481    invoke a Haskell function as any other C function, as second arg.
 482    This arg is unused within the body of the generated C stub, but
 483    needed by the Adjustor.c code to get the stack cleanup right.
 484   -}
 485   (proto_args, real_args)
 486     = case cc of
 487         CCallConv | isDyn -> ( text "a0" : text "a_" : mkCArgNames 1 (tail args)
 488                              , head args : addrTy : tail args)
 489         other             -> (mkCArgNames 0 args, args)
 490
 491 mkCArgNames :: Int -> [a] -> [SDoc]
 492 mkCArgNames n as = zipWith (\ _ n -> text ('a':show n)) as [n..]
 493
 494 mkHObj :: Type -> SDoc
 495 mkHObj t = text "rts_mk" <> text (showFFIType t)
 496
 497 unpackHObj :: Type -> SDoc
 498 unpackHObj t = text "rts_get" <> text (showFFIType t)
 499
 500 showStgType :: Type -> SDoc
 501 showStgType t = text "Hs" <> text (showFFIType t)
 502
 503 showFFIType :: Type -> String
 504 showFFIType t = getOccString (getName tc)
 505  where
 506   tc = case splitTyConApp_maybe (repType t) of
 507             Just (tc,_) -> tc
 508             Nothing     -> pprPanic "showFFIType" (ppr t)
 509 \end{code}