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