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