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 )
  26 import MkId             ( mkWorkerId )
  27 import Literal          ( Literal(..) )
  28 import Module           ( Module, moduleUserString )
  29 import Name             ( mkGlobalName, nameModule, nameOccName, getOccString,
  30                           mkForeignExportOcc, isLocalName,
  31                           NamedThing(..), Provenance(..), ExportFlag(..)
  32                         )
  33 import PrelInfo         ( deRefStablePtr_NAME, returnIO_NAME, bindIO_NAME, makeStablePtr_NAME )
  34 import Type             ( unUsgTy,
  35                           splitTyConApp_maybe, splitFunTys, splitForAllTys,
  36                           Type, mkFunTys, mkForAllTys, mkTyConApp,
  37                           mkTyVarTy, mkFunTy, splitAppTy, applyTy, funResultTy
  38                         )
  39 import PrimOp           ( PrimOp(..), CCall(..), CCallTarget(..) )
  40 import Var              ( TyVar )
  41 import TysPrim          ( realWorldStatePrimTy, addrPrimTy )
  42 import TysWiredIn       ( unitTy, addrTy, stablePtrTyCon,
  43                           unboxedTupleCon, addrDataCon
  44                         )
  45 import Unique
  46 import Maybes           ( maybeToBool )
  47 import Outputable
  48 \end{code}
  49
  50 Desugaring of @foreign@ declarations is naturally split up into
  51 parts, an @import@ and an @export@  part. A @foreign import@
  52 declaration
  53 \begin{verbatim}
  54   foreign import cc nm f :: prim_args -> IO prim_res
  55 \end{verbatim}
  56 is the same as
  57 \begin{verbatim}
  58   f :: prim_args -> IO prim_res
  59   f a1 ... an = _ccall_ nm cc a1 ... an
  60 \end{verbatim}
  61 so we reuse the desugaring code in @DsCCall@ to deal with these.
  62
  63 \begin{code}
  64 dsForeigns :: Module
  65            -> [TypecheckedForeignDecl]
  66            -> DsM ( [CoreBind]        -- desugared foreign imports
  67                   , [CoreBind]        -- helper functions for foreign exports
  68                   , SDoc              -- Header file prototypes for
  69                                       -- "foreign exported" functions.
  70                   , SDoc              -- C stubs to use when calling
  71                                       -- "foreign exported" functions.
  72                   )
  73 dsForeigns mod_name fos = foldlDs combine ([],[],empty,empty) fos
  74  where
  75   combine (acc_fi, acc_fe, acc_h, acc_c) fo@(ForeignDecl i imp_exp _ ext_nm cconv _)
  76     | isForeignImport =   -- foreign import (dynamic)?
  77         dsFImport i (idType i) uns ext_nm cconv  `thenDs` \ bs ->
  78         returnDs (bs ++ acc_fi, acc_fe, acc_h, acc_c)
  79     | isForeignLabel =
  80         dsFLabel i ext_nm `thenDs` \ b ->
  81         returnDs (b:acc_fi, acc_fe, acc_h, acc_c)
  82     | isDynamicExtName ext_nm =
  83         dsFExportDynamic i (idType i) mod_name ext_nm cconv  `thenDs` \ (fi,fe,h,c) ->
  84         returnDs (fi:acc_fi, fe:acc_fe, h $$ acc_h, c $$ acc_c)
  85
  86     | otherwise        =  -- foreign export
  87         dsFExport i (idType i) mod_name ext_nm cconv False   `thenDs` \ (fe,h,c) ->
  88         returnDs (acc_fi, fe:acc_fe, h $$ acc_h, c $$ acc_c)
  89    where
  90     isForeignImport =
  91         case imp_exp of
  92           FoImport _ -> True
  93           _          -> False
  94
  95     isForeignLabel =
  96         case imp_exp of
  97           FoLabel -> True
  98           _       -> False
  99
 100     (FoImport uns)   = imp_exp
 101
 102 \end{code}
 103
 104 Desugaring foreign imports is just the matter of creating a binding
 105 that on its RHS unboxes its arguments, performs the external call
 106 (using the @CCallOp@ primop), before boxing the result up and returning it.
 107
 108 However, we create a worker/wrapper pair, thus:
 109
 110         foreign import f :: Int -> IO Int
 111 ==>
 112         f x = IO ( \s -> case x of { I# x# ->
 113                          case fw s x# of { (# s1, y# #) ->
 114                          (# s1, I# y# #)}})
 115
 116         fw s x# = ccall f s x#
 117
 118 The strictness/CPR analyser won't do this automatically because it doesn't look
 119 inside returned tuples; but inlining this wrapper is a Really Good Idea
 120 because it exposes the boxing to the call site.
 121
 122
 123 \begin{code}
 124 dsFImport :: Id
 125           -> Type               -- Type of foreign import.
 126           -> Bool               -- True <=> might cause Haskell GC
 127           -> ExtName
 128           -> CallConv
 129           -> DsM [CoreBind]
 130 dsFImport fn_id ty may_not_gc ext_name cconv
 131   = let
 132         (tvs, fun_ty)        = splitForAllTys ty
 133         (arg_tys, io_res_ty) = splitFunTys fun_ty
 134     in
 135     newSysLocalsDs arg_tys                      `thenDs` \ args ->
 136     mapAndUnzipDs unboxArg (map Var args)       `thenDs` \ (val_args, arg_wrappers) ->
 137     boxResult io_res_ty                         `thenDs` \ (ccall_result_ty, res_wrapper) ->
 138
 139     (case ext_name of
 140        Dynamic       -> getUniqueDs `thenDs` \ u ->
 141                         returnDs (DynamicTarget u)
 142        ExtName fs _  -> returnDs (StaticTarget fs))     `thenDs` \ lbl ->
 143
 144     getUniqueDs                                         `thenDs` \ ccall_uniq ->
 145     getUniqueDs                                         `thenDs` \ work_uniq ->
 146     let
 147         -- Build the worker
 148         work_arg_ids  = [v | Var v <- val_args]         -- All guaranteed to be vars
 149         worker_ty     = mkForAllTys tvs (mkFunTys (map idType work_arg_ids) ccall_result_ty)
 150         the_ccall     = CCall lbl False (not may_not_gc) cconv
 151         the_ccall_app = mkCCall ccall_uniq the_ccall val_args ccall_result_ty
 152         work_rhs      = mkLams tvs (mkLams work_arg_ids the_ccall_app)
 153         work_id       = mkWorkerId work_uniq fn_id worker_ty
 154
 155         -- Build the wrapper
 156         work_app     = mkApps (mkVarApps (Var work_id) tvs) val_args
 157         wrapper_body = foldr ($) (res_wrapper work_app) arg_wrappers
 158         wrap_rhs     = mkInlineMe (mkLams (tvs ++ args) wrapper_body)
 159     in
 160     returnDs [NonRec fn_id wrap_rhs, NonRec work_id work_rhs]
 161 \end{code}
 162
 163 Foreign labels
 164
 165 \begin{code}
 166 dsFLabel :: Id -> ExtName -> DsM CoreBind
 167 dsFLabel nm ext_name = returnDs (NonRec nm fo_rhs)
 168   where
 169    fo_rhs = mkConApp addrDataCon [mkLit (MachLitLit enm addrPrimTy)]
 170    enm    = extNameStatic ext_name
 171 \end{code}
 172
 173 The function that does most of the work for `@foreign export@' declarations.
 174 (see below for the boilerplate code a `@foreign export@' declaration expands
 175  into.)
 176
 177 For each `@foreign export foo@' in a module M we generate:
 178 \begin{itemize}
 179 \item a C function `@foo@', which calls
 180 \item a Haskell stub `@M.$ffoo@', which calls
 181 \end{itemize}
 182 the user-written Haskell function `@M.foo@'.
 183
 184 \begin{code}
 185 dsFExport :: Id
 186           -> Type               -- Type of foreign export.
 187           -> Module
 188           -> ExtName
 189           -> CallConv
 190           -> Bool               -- True => invoke IO action that's hanging off
 191                                 -- the first argument's stable pointer
 192           -> DsM ( CoreBind
 193                  , SDoc
 194                  , SDoc
 195                  )
 196 dsFExport i ty mod_name ext_name cconv isDyn
 197   =     -- BUILD THE returnIO WRAPPER, if necessary
 198         -- Look at the result type of the exported function, orig_res_ty
 199         -- If it's IO t, return         (\x.x,          IO t, t)
 200         -- If it's plain t, return      (\x.returnIO x, IO t, t)
 201      (case splitTyConApp_maybe orig_res_ty of
 202         Just (ioTyCon, [res_ty])
 203               -> ASSERT( getUnique ioTyCon == ioTyConKey )
 204                         -- The function already returns IO t
 205                  returnDs (\body -> body, orig_res_ty, res_ty)
 206
 207         other ->        -- The function returns t, so wrap the call in returnIO
 208                  dsLookupGlobalValue returnIO_NAME      `thenDs` \ retIOId ->
 209                  returnDs (\body -> mkApps (Var retIOId) [Type orig_res_ty, body],
 210                            funResultTy (applyTy (idType retIOId) orig_res_ty),
 211                                 -- We don't have ioTyCon conveniently to hand
 212                            orig_res_ty)
 213
 214      )          `thenDs` \ (return_io_wrapper,  -- Either identity or returnIO
 215                             io_res_ty,          -- IO t
 216                             res_ty) ->          -- t
 217
 218
 219         -- BUILD THE deRefStablePtr WRAPPER, if necessary
 220      (if isDyn then
 221         newSysLocalDs stbl_ptr_ty                       `thenDs` \ stbl_ptr ->
 222         newSysLocalDs stbl_ptr_to_ty                    `thenDs` \ stbl_value ->
 223         dsLookupGlobalValue deRefStablePtr_NAME         `thenDs` \ deRefStablePtrId ->
 224         let
 225          the_deref_app = mkApps (Var deRefStablePtrId)
 226                                 [ Type stbl_ptr_to_ty, Var stbl_ptr ]
 227         in
 228         dsLookupGlobalValue bindIO_NAME                  `thenDs` \ bindIOId ->
 229         let
 230          stbl_app cont = mkApps (Var bindIOId)
 231                                 [ Type stbl_ptr_to_ty
 232                                 , Type res_ty
 233                                 , the_deref_app
 234                                 , mkLams [stbl_value] cont]
 235         in
 236         returnDs (stbl_value, stbl_app, stbl_ptr)
 237       else
 238         returnDs (i,
 239                   \ body -> body,
 240                   panic "stbl_ptr"  -- should never be touched.
 241                   ))                    `thenDs` \ (i, getFun_wrapper, stbl_ptr) ->
 242
 243
 244         -- BUILD THE HELPER
 245      getModuleDs                        `thenDs` \ mod ->
 246      getUniqueDs                        `thenDs` \ uniq ->
 247      getSrcLocDs                        `thenDs` \ src_loc ->
 248      newSysLocalsDs fe_arg_tys          `thenDs` \ fe_args ->
 249      let
 250         wrapper_args | isDyn      = stbl_ptr:fe_args
 251                      | otherwise  = fe_args
 252
 253         wrapper_arg_tys | isDyn      = stbl_ptr_ty:fe_arg_tys
 254                         | otherwise  = fe_arg_tys
 255
 256         helper_ty =  mkForAllTys tvs $
 257                      mkFunTys wrapper_arg_tys io_res_ty
 258
 259         f_helper_glob = mkVanillaId helper_name helper_ty
 260                       where
 261                         name                = idName i
 262                         mod
 263                          | isLocalName name = mod_name
 264                          | otherwise        = nameModule name
 265
 266                         occ                 = mkForeignExportOcc (nameOccName name)
 267                         prov                = LocalDef src_loc Exported
 268                         helper_name         = mkGlobalName uniq mod occ prov
 269
 270         the_app = getFun_wrapper (return_io_wrapper (mkVarApps (Var i) (tvs ++ fe_args)))
 271         the_body = mkLams (tvs ++ wrapper_args) the_app
 272         c_nm     = extNameStatic ext_name
 273
 274         (h_stub, c_stub) = fexportEntry (moduleUserString mod)
 275                                       c_nm f_helper_glob
 276                                       wrapper_arg_tys res_ty cconv isDyn
 277      in
 278      returnDs (NonRec f_helper_glob the_body, h_stub, c_stub)
 279
 280   where
 281    (tvs,sans_foralls)                   = splitForAllTys ty
 282    (fe_arg_tys', orig_res_ty)           = splitFunTys sans_foralls
 283
 284    (_, stbl_ptr_ty')                    = splitForAllTys stbl_ptr_ty
 285    (_, stbl_ptr_to_ty)                  = splitAppTy stbl_ptr_ty'
 286
 287    fe_arg_tys | isDyn     = tail fe_arg_tys'
 288               | otherwise = fe_arg_tys'
 289
 290    stbl_ptr_ty | isDyn     = head fe_arg_tys'
 291                | otherwise = error "stbl_ptr_ty"
 292 \end{code}
 293
 294 @foreign export dynamic@ lets you dress up Haskell IO actions
 295 of some fixed type behind an externally callable interface (i.e.,
 296 as a C function pointer). Useful for callbacks and stuff.
 297
 298 \begin{verbatim}
 299 foreign export stdcall f :: (Addr -> Int -> IO Int) -> IO Addr
 300
 301 -- Haskell-visible constructor, which is generated from the
 302 -- above:
 303
 304 f :: (Addr -> Int -> IO Int) -> IO Addr
 305 f cback = IO ( \ s1# ->
 306   case makeStablePtr# cback s1# of { StateAndStablePtr# s2# sp# ->
 307   case _ccall_ "mkAdjustor" sp# ``f_helper'' s2# of
 308     StateAndAddr# s3# a# ->
 309     case addr2Int# a# of
 310       0# -> IOfail s# err
 311       _  ->
 312          let
 313           a :: Addr
 314           a = A# a#
 315          in
 316          IOok s3# a)
 317
 318 foreign export "f_helper" f_helper :: StablePtr (Addr -> Int -> IO Int) -> Addr -> Int -> IO Int
 319 -- `special' foreign export that invokes the closure pointed to by the
 320 -- first argument.
 321 \end{verbatim}
 322
 323 \begin{code}
 324 dsFExportDynamic :: Id
 325                  -> Type                -- Type of foreign export.
 326                  -> Module
 327                  -> ExtName
 328                  -> CallConv
 329                  -> DsM (CoreBind, CoreBind, SDoc, SDoc)
 330 dsFExportDynamic i ty mod_name ext_name cconv =
 331      newSysLocalDs ty                                    `thenDs` \ fe_id ->
 332      let
 333         -- hack: need to get at the name of the C stub we're about to generate.
 334        fe_nm       = toCName fe_id
 335        fe_ext_name = ExtName (_PK_ fe_nm) Nothing
 336      in
 337      dsFExport  i export_ty mod_name fe_ext_name cconv True
 338      `thenDs` \ (fe@(NonRec fe_helper fe_expr), h_code, c_code) ->
 339      newSysLocalDs arg_ty                       `thenDs` \ cback ->
 340      dsLookupGlobalValue makeStablePtr_NAME     `thenDs` \ makeStablePtrId ->
 341      let
 342         mk_stbl_ptr_app    = mkApps (Var makeStablePtrId) [ Type arg_ty, Var cback ]
 343      in
 344      dsLookupGlobalValue bindIO_NAME                    `thenDs` \ bindIOId ->
 345      newSysLocalDs (mkTyConApp stablePtrTyCon [arg_ty]) `thenDs` \ stbl_value ->
 346      let
 347       stbl_app cont ret_ty
 348         = mkApps (Var bindIOId)
 349                  [ Type (mkTyConApp stablePtrTyCon [arg_ty])
 350                  , Type ret_ty
 351                  , mk_stbl_ptr_app
 352                  , cont
 353                  ]
 354
 355        {-
 356         The arguments to the external function which will
 357         create a little bit of (template) code on the fly
 358         for allowing the (stable pointed) Haskell closure
 359         to be entered using an external calling convention
 360         (stdcall, ccall).
 361        -}
 362       adj_args      = [ mkIntLitInt (callConvToInt cconv)
 363                       , Var stbl_value
 364                       , mkLit (MachLitLit (_PK_ fe_nm) addrPrimTy)
 365                       ]
 366         -- name of external entry point providing these services.
 367         -- (probably in the RTS.)
 368       adjustor      = SLIT("createAdjustor")
 369      in
 370      dsCCall adjustor adj_args False False ioAddrTy `thenDs` \ ccall_adj ->
 371      let ccall_adj_ty = exprType ccall_adj
 372          ccall_io_adj = mkLams [stbl_value]                  $
 373                         Note (Coerce io_res_ty (unUsgTy ccall_adj_ty))
 374                              ccall_adj
 375      in
 376      let io_app = mkLams tvs     $
 377                   mkLams [cback] $
 378                   stbl_app ccall_io_adj addrTy
 379      in
 380      returnDs (NonRec i 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 (text mod_nm <> char '.' <> 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 t of
 495             Just (tc,_) -> tc
 496             Nothing     -> pprPanic "showFFIType" (ppr t)
 497 \end{code}