sunrpc/rpc/svc.h

   1 /* @(#)svc.h    2.2 88/07/29 4.0 RPCSRC; from 1.20 88/02/08 SMI */
   2 /*
   3  * Sun RPC is a product of Sun Microsystems, Inc. and is provided for
   4  * unrestricted use provided that this legend is included on all tape
   5  * media and as a part of the software program in whole or part.  Users
   6  * may copy or modify Sun RPC without charge, but are not authorized
   7  * to license or distribute it to anyone else except as part of a product or
   8  * program developed by the user.
   9  *
  10  * SUN RPC IS PROVIDED AS IS WITH NO WARRANTIES OF ANY KIND INCLUDING THE
  11  * WARRANTIES OF DESIGN, MERCHANTIBILITY AND FITNESS FOR A PARTICULAR
  12  * PURPOSE, OR ARISING FROM A COURSE OF DEALING, USAGE OR TRADE PRACTICE.
  13  *
  14  * Sun RPC is provided with no support and without any obligation on the
  15  * part of Sun Microsystems, Inc. to assist in its use, correction,
  16  * modification or enhancement.
  17  *
  18  * SUN MICROSYSTEMS, INC. SHALL HAVE NO LIABILITY WITH RESPECT TO THE
  19  * INFRINGEMENT OF COPYRIGHTS, TRADE SECRETS OR ANY PATENTS BY SUN RPC
  20  * OR ANY PART THEREOF.
  21  *
  22  * In no event will Sun Microsystems, Inc. be liable for any lost revenue
  23  * or profits or other special, indirect and consequential damages, even if
  24  * Sun has been advised of the possibility of such damages.
  25  *
  26  * Sun Microsystems, Inc.
  27  * 2550 Garcia Avenue
  28  * Mountain View, California  94043
  29  */
  30
  31 /*
  32  * svc.h, Server-side remote procedure call interface.
  33  *
  34  * Copyright (C) 1984, Sun Microsystems, Inc.
  35  */
  36
  37 #ifndef __SVC_HEADER__
  38 #define __SVC_HEADER__
  39
  40 __BEGIN_DECLS
  41
  42 /*
  43  * This interface must manage two items concerning remote procedure calling:
  44  *
  45  * 1) An arbitrary number of transport connections upon which rpc requests
  46  * are received.  The two most notable transports are TCP and UDP;  they are
  47  * created and registered by routines in svc_tcp.c and svc_udp.c, respectively;
  48  * they in turn call xprt_register and xprt_unregister.
  49  *
  50  * 2) An arbitrary number of locally registered services.  Services are
  51  * described by the following four data: program number, version number,
  52  * "service dispatch" function, a transport handle, and a boolean that
  53  * indicates whether or not the exported program should be registered with a
  54  * local binder service;  if true the program's number and version and the
  55  * port number from the transport handle are registered with the binder.
  56  * These data are registered with the rpc svc system via svc_register.
  57  *
  58  * A service's dispatch function is called whenever an rpc request comes in
  59  * on a transport.  The request's program and version numbers must match
  60  * those of the registered service.  The dispatch function is passed two
  61  * parameters, struct svc_req * and SVCXPRT *, defined below.
  62  */
  63
  64 enum xprt_stat {
  65         XPRT_DIED,
  66         XPRT_MOREREQS,
  67         XPRT_IDLE
  68 };
  69
  70 /*
  71  * Server side transport handle
  72  */
  73 typedef struct {
  74         int             xp_sock;
  75         u_short         xp_port;         /* associated port number */
  76         struct xp_ops {
  77             bool_t      (*xp_recv)();    /* receive incoming requests */
  78             enum xprt_stat (*xp_stat)(); /* get transport status */
  79             bool_t      (*xp_getargs)(); /* get arguments */
  80             bool_t      (*xp_reply)();   /* send reply */
  81             bool_t      (*xp_freeargs)();/* free mem allocated for args */
  82             void        (*xp_destroy)(); /* destroy this struct */
  83         } *xp_ops;
  84         int             xp_addrlen;      /* length of remote address */
  85         struct sockaddr_in xp_raddr;     /* remote address */
  86         struct opaque_auth xp_verf;      /* raw response verifier */
  87         caddr_t         xp_p1;           /* private */
  88         caddr_t         xp_p2;           /* private */
  89 } SVCXPRT;
  90
  91 /*
  92  *  Approved way of getting address of caller
  93  */
  94 #define svc_getcaller(x) (&(x)->xp_raddr)
  95
  96 /*
  97  * Operations defined on an SVCXPRT handle
  98  *
  99  * SVCXPRT              *xprt;
 100  * struct rpc_msg       *msg;
 101  * xdrproc_t             xargs;
 102  * caddr_t               argsp;
 103  */
 104 #define SVC_RECV(xprt, msg)                             \
 105         (*(xprt)->xp_ops->xp_recv)((xprt), (msg))
 106 #define svc_recv(xprt, msg)                             \
 107         (*(xprt)->xp_ops->xp_recv)((xprt), (msg))
 108
 109 #define SVC_STAT(xprt)                                  \
 110         (*(xprt)->xp_ops->xp_stat)(xprt)
 111 #define svc_stat(xprt)                                  \
 112         (*(xprt)->xp_ops->xp_stat)(xprt)
 113
 114 #define SVC_GETARGS(xprt, xargs, argsp)                 \
 115         (*(xprt)->xp_ops->xp_getargs)((xprt), (xargs), (argsp))
 116 #define svc_getargs(xprt, xargs, argsp)                 \
 117         (*(xprt)->xp_ops->xp_getargs)((xprt), (xargs), (argsp))
 118
 119 #define SVC_REPLY(xprt, msg)                            \
 120         (*(xprt)->xp_ops->xp_reply) ((xprt), (msg))
 121 #define svc_reply(xprt, msg)                            \
 122         (*(xprt)->xp_ops->xp_reply) ((xprt), (msg))
 123
 124 #define SVC_FREEARGS(xprt, xargs, argsp)                \
 125         (*(xprt)->xp_ops->xp_freeargs)((xprt), (xargs), (argsp))
 126 #define svc_freeargs(xprt, xargs, argsp)                \
 127         (*(xprt)->xp_ops->xp_freeargs)((xprt), (xargs), (argsp))
 128
 129 #define SVC_DESTROY(xprt)                               \
 130         (*(xprt)->xp_ops->xp_destroy)(xprt)
 131 #define svc_destroy(xprt)                               \
 132         (*(xprt)->xp_ops->xp_destroy)(xprt)
 133
 134
 135 /*
 136  * Service request
 137  */
 138 struct svc_req {
 139         u_long          rq_prog;        /* service program number */
 140         u_long          rq_vers;        /* service protocol version */
 141         u_long          rq_proc;        /* the desired procedure */
 142         struct opaque_auth rq_cred;     /* raw creds from the wire */
 143         caddr_t         rq_clntcred;    /* read only cooked cred */
 144         SVCXPRT *rq_xprt;               /* associated transport */
 145 };
 146
 147
 148 /*
 149  * Service registration
 150  *
 151  * svc_register(xprt, prog, vers, dispatch, protocol)
 152  *      SVCXPRT *xprt;
 153  *      u_long prog;
 154  *      u_long vers;
 155  *      void (*dispatch)();
 156  *      int protocol;  like TCP or UDP, zero means do not register
 157  */
 158 extern bool_t   svc_register __P ((SVCXPRT *__xprt, u_long __prog,
 159                                    u_long __vers, void (*__dispatch) (),
 160                                    int __protocol));
 161
 162 /*
 163  * Service un-registration
 164  *
 165  * svc_unregister(prog, vers)
 166  *      u_long prog;
 167  *      u_long vers;
 168  */
 169 extern void     svc_unregister __P ((u_long __prog, u_long __vers));
 170
 171 /*
 172  * Transport registration.
 173  *
 174  * xprt_register(xprt)
 175  *      SVCXPRT *xprt;
 176  */
 177 extern void     xprt_register __P ((SVCXPRT *__xprt));
 178
 179 /*
 180  * Transport un-register
 181  *
 182  * xprt_unregister(xprt)
 183  *      SVCXPRT *xprt;
 184  */
 185 extern void     xprt_unregister __P ((SVCXPRT *__xprt));
 186
 187
 188
 189
 190 /*
 191  * When the service routine is called, it must first check to see if it
 192  * knows about the procedure;  if not, it should call svcerr_noproc
 193  * and return.  If so, it should deserialize its arguments via
 194  * SVC_GETARGS (defined above).  If the deserialization does not work,
 195  * svcerr_decode should be called followed by a return.  Successful
 196  * decoding of the arguments should be followed the execution of the
 197  * procedure's code and a call to svc_sendreply.
 198  *
 199  * Also, if the service refuses to execute the procedure due to too-
 200  * weak authentication parameters, svcerr_weakauth should be called.
 201  * Note: do not confuse access-control failure with weak authentication!
 202  *
 203  * NB: In pure implementations of rpc, the caller always waits for a reply
 204  * msg.  This message is sent when svc_sendreply is called.
 205  * Therefore pure service implementations should always call
 206  * svc_sendreply even if the function logically returns void;  use
 207  * xdr.h - xdr_void for the xdr routine.  HOWEVER, tcp based rpc allows
 208  * for the abuse of pure rpc via batched calling or pipelining.  In the
 209  * case of a batched call, svc_sendreply should NOT be called since
 210  * this would send a return message, which is what batching tries to avoid.
 211  * It is the service/protocol writer's responsibility to know which calls are
 212  * batched and which are not.  Warning: responding to batch calls may
 213  * deadlock the caller and server processes!
 214  */
 215
 216 extern bool_t   svc_sendreply __P ((SVCXPRT *xprt, xdrproc_t __xdr_results,
 217                                     caddr_t __xdr_location));
 218
 219 extern void     svcerr_decode __P ((SVCXPRT *__xprt));
 220
 221 extern void     svcerr_weakauth __P ((SVCXPRT *__xprt));
 222
 223 extern void     svcerr_noproc __P ((SVCXPRT *__xprt));
 224
 225 extern void     svcerr_progvers __P ((SVCXPRT *__xprt, u_long __low_vers,
 226                                       u_long __high_vers));
 227
 228 extern void     svcerr_auth __P ((SVCXPRT *__xprt, enum auth_stat __why));
 229
 230 extern void     svcerr_noprog __P ((SVCXPRT *__xprt));
 231
 232 extern void     svcerr_systemerr __P ((SVCXPRT *__xprt));
 233
 234 /*
 235  * Lowest level dispatching -OR- who owns this process anyway.
 236  * Somebody has to wait for incoming requests and then call the correct
 237  * service routine.  The routine svc_run does infinite waiting; i.e.,
 238  * svc_run never returns.
 239  * Since another (coexistant) package may wish to selectively wait for
 240  * incoming calls or other events outside of the rpc architecture, the
 241  * routine svc_getreq is provided.  It must be passed readfds, the
 242  * "in-place" results of a select system call (see select, section 2).
 243  */
 244
 245 /*
 246  * Global keeper of rpc service descriptors in use
 247  * dynamic; must be inspected before each call to select
 248  */
 249 #ifdef FD_SETSIZE
 250 extern fd_set svc_fdset;
 251 #define svc_fds svc_fdset.fds_bits[0]   /* compatibility */
 252 #else
 253 extern int svc_fds;
 254 #endif /* def FD_SETSIZE */
 255
 256 /*
 257  * a small program implemented by the svc_rpc implementation itself;
 258  * also see clnt.h for protocol numbers.
 259  */
 260 extern void rpctest_service();
 261
 262 extern void     svc_getreq __P ((int __rdfds));
 263 extern void     svc_getreqset __P ((fd_set *readfds));
 264 extern void     svc_run __P ((void)) __attribute__ ((noreturn));
 265
 266 /*
 267  * Socket to use on svcxxx_create call to get default socket
 268  */
 269 #define RPC_ANYSOCK     -1
 270
 271 /*
 272  * These are the existing service side transport implementations
 273  */
 274
 275 /*
 276  * Memory based rpc for testing and timing.
 277  */
 278 extern SVCXPRT *svcraw_create __P ((void));
 279
 280 /*
 281  * Udp based rpc.
 282  */
 283 extern SVCXPRT *svcudp_create __P ((int __sock));
 284 extern SVCXPRT *svcudp_bufcreate __P ((int __sock, u_int __sendsz,
 285                                        u_int __recvsz));
 286
 287 /*
 288  * Tcp based rpc.
 289  */
 290 extern SVCXPRT *svctcp_create __P ((int __sock, u_int __sendsize,
 291                                     u_int __recvsize));
 292
 293
 294 __END_DECLS
 295
 296 #endif /* !__SVC_HEADER__ */