* Sun RPC is a product of Sun Microsystems, Inc. and is provided for
* unrestricted use provided that this legend is included on all tape
* media and as a part of the software program in whole or part. Users
* may copy or modify Sun RPC without charge, but are not authorized
* to license or distribute it to anyone else except as part of a product or
* program developed by the user.
* SUN RPC IS PROVIDED AS IS WITH NO WARRANTIES OF ANY KIND INCLUDING THE
* WARRANTIES OF DESIGN, MERCHANTIBILITY AND FITNESS FOR A PARTICULAR
* PURPOSE, OR ARISING FROM A COURSE OF DEALING, USAGE OR TRADE PRACTICE.
* Sun RPC is provided with no support and without any obligation on the
* part of Sun Microsystems, Inc. to assist in its use, correction,
* modification or enhancement.
* SUN MICROSYSTEMS, INC. SHALL HAVE NO LIABILITY WITH RESPECT TO THE
* INFRINGEMENT OF COPYRIGHTS, TRADE SECRETS OR ANY PATENTS BY SUN RPC
* In no event will Sun Microsystems, Inc. be liable for any lost revenue
* or profits or other special, indirect and consequential damages, even if
* Sun has been advised of the possibility of such damages.
* Mountain View, California 94043
/* @(#)svc.h 1.2 85/02/08 SMI */
* svc.h, Server-side remote procedure call interface.
* Copyright (C) 1984, Sun Microsystems, Inc.
* This interface must manage two items concerning remote procedure calling:
* 1) An arbitrary number of transport connections upon which rpc requests
* are received. The two most notable transports are TCP and UDP; they are
* created and registered by routines in svc_tcp.c and svc_udp.c, respectively;
* they in turn call xprt_register and xprt_unregister.
* 2) An arbitrary number of locally registered services. Services are
* described by the following four data: program number, version number,
* "service dispatch" function, a transport handle, and a boolean that
* indicates whether or not the exported program should be registered with a
* local binder service; if true the program's number and version and the
* port number from the transport handle are registered with the binder.
* These data are registered with the rpc svc system via svc_register.
* A service's dispatch function is called whenever an rpc request comes in
* on a transport. The request's program and version numbers must match
* those of the registered service. The dispatch function is passed two
* parameters, struct svc_req * and SVCXPRT *, defined below.
* Server side transport handle
u_short xp_port
; /* associated port number */
bool_t (*xp_recv
)(); /* receive incomming requests */
enum xprt_stat (*xp_stat
)(); /* get transport status */
bool_t (*xp_getargs
)(); /* get arguments */
bool_t (*xp_reply
)(); /* send reply */
bool_t (*xp_freeargs
)();/* free mem allocated for args */
void (*xp_destroy
)(); /* destroy this struct */
int xp_addrlen
; /* length of remote address */
struct sockaddr_in xp_raddr
; /* remote address */
struct opaque_auth xp_verf
; /* raw response verifier */
caddr_t xp_p1
; /* private */
caddr_t xp_p2
; /* private */
* Approved way of getting address of caller
#define svc_getcaller(x) (&(x)->xp_raddr)
* Operations defined on an SVCXPRT handle
#define SVC_RECV(xprt, msg) \
(*(xprt)->xp_ops->xp_recv)((xprt), (msg))
#define svc_recv(xprt, msg) \
(*(xprt)->xp_ops->xp_recv)((xprt), (msg))
(*(xprt)->xp_ops->xp_stat)(xprt)
(*(xprt)->xp_ops->xp_stat)(xprt)
#define SVC_GETARGS(xprt, xargs, argsp) \
(*(xprt)->xp_ops->xp_getargs)((xprt), (xargs), (argsp))
#define svc_getargs(xprt, xargs, argsp) \
(*(xprt)->xp_ops->xp_getargs)((xprt), (xargs), (argsp))
#define SVC_REPLY(xprt, msg) \
(*(xprt)->xp_ops->xp_reply) ((xprt), (msg))
#define svc_reply(xprt, msg) \
(*(xprt)->xp_ops->xp_reply) ((xprt), (msg))
#define SVC_FREEARGS(xprt, xargs, argsp) \
(*(xprt)->xp_ops->xp_freeargs)((xprt), (xargs), (argsp))
#define svc_freeargs(xprt, xargs, argsp) \
(*(xprt)->xp_ops->xp_freeargs)((xprt), (xargs), (argsp))
#define SVC_DESTROY(xprt) \
(*(xprt)->xp_ops->xp_destroy)(xprt)
#define svc_destroy(xprt) \
(*(xprt)->xp_ops->xp_destroy)(xprt)
u_long rq_prog
; /* service program number */
u_long rq_vers
; /* service protocol version */
u_long rq_proc
; /* the desired procedure */
struct opaque_auth rq_cred
; /* raw creds from the wire */
caddr_t rq_clntcred
; /* read only cooked cred */
SVCXPRT
*rq_xprt
; /* associated transport */
* svc_register(xprt, prog, vers, dispatch, protocol)
* int protocol; /* like TCP or UDP, zero means do not register
extern bool_t
svc_register();
* Service un-registration
* svc_unregister(prog, vers)
extern void svc_unregister();
* Transport registration.
extern void xprt_register();
extern void xprt_unregister();
* When the service routine is called, it must first check to see if it
* knows about the procedure; if not, it should call svcerr_noproc
* and return. If so, it should deserialize its arguments via
* SVC_GETARGS (defined above). If the deserialization does not work,
* svcerr_decode should be called followed by a return. Successful
* decoding of the arguments should be followed the execution of the
* procedure's code and a call to svc_sendreply.
* Also, if the service refuses to execute the procedure due to too-
* weak authentication parameters, svcerr_weakauth should be called.
* Note: do not confuse access-control failure with weak authentication!
* NB: In pure implementations of rpc, the caller always waits for a reply
* msg. This message is sent when svc_sendreply is called.
* Therefore pure service implementations should always call
* svc_sendreply even if the function logically returns void; use
* xdr.h - xdr_void for the xdr routine. HOWEVER, tcp based rpc allows
* for the abuse of pure rpc via batched calling or pipelining. In the
* case of a batched call, svc_sendreply should NOT be called since
* this would send a return message, which is what batching tries to avoid.
* It is the service/protocol writer's responsibility to know which calls are
* batched and which are not. Warning: responding to batch calls may
* deadlock the caller and server processes!
extern bool_t
svc_sendreply();
extern void svcerr_noproc();
extern void svcerr_decode();
extern void svcerr_weakauth();
* Lowest level dispatching -OR- who owns this process anyway.
* Somebody has to wait for incoming requests and then call the correct
* service routine. The routine svc_run does infinite waiting; i.e.,
* Since another (co-existant) package may wish to selectively wait for
* incoming calls or other events outside of the rpc architecture, the
* routine svc_getreq is provided. It must be passed readfds, the
* "in-place" results of a select system call (see select, section 2).
/* dynamic; must be inspected before each call to select */
extern void svc_getreq();
extern void svc_run(); /* never returns */
* a small program implemented by the svc_rpc implementation itself;
* also see clnt.h for protocol numbers.
extern void rpctest_service();
* Socket to use on svcxxx_create call to get default socket
* These are the existing service side transport implementations
* Memory based rpc for testing and timing.
extern SVCXPRT
*svcraw_create();
extern SVCXPRT
*svcudp_create();
extern SVCXPRT
*svctcp_create();