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