/* * ***************************************************************** * * * * * Copyright (c) Digital Equipment Corporation, 1991, 1994 * * * * * * All Rights Reserved. Unpublished rights reserved under * * * the copyright laws of the United States. * * * * * * The software contained on this media is proprietary to * * * and embodies the confidential technology of Digital * * * Equipment Corporation. Possession, use, duplication or * * * dissemination of the software and media is authorized only * * * pursuant to a valid written license from Digital Equipment * * * Corporation. * * * * * * RESTRICTED RIGHTS LEGEND Use, duplication, or disclosure * * * by the U.S. Government is subject to restrictions as set * * * forth in Subparagraph (c)(1)(ii) of DFARS 252.227-7013, * * * or in FAR 52.227-19, as applicable. * * * * * ***************************************************************** */ /* * HISTORY */ /* * @(#)$RCSfile: svc.h,v $ $Revision: 4.2.10.2 $ (DEC) $Date: 1994/03/29 18:37:20 $ */ /* */ /* * Copyright (c) 1990 by Sun Microsystems, Inc. */ /* * svc.h, Server-side remote procedure call interface. */ #ifndef _rpc_svc_h #define _rpc_svc_h #include #include #include #include #include #include /* * 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. */ enum xprt_stat { XPRT_DIED, XPRT_MOREREQS, XPRT_IDLE }; /* * Server side transport handle */ typedef struct __svcxprt { #ifdef KERNEL struct socket *xp_sock; #else int xp_sock; #endif u_short xp_port; /* associated port number */ struct xp_ops { bool_t (*xp_recv) __((struct __svcxprt *, struct rpc_msg *)); /* receive incomming requests */ enum xprt_stat (*xp_stat) __((struct __svcxprt *)); /* get transport status */ bool_t (*xp_getargs) __((struct __svcxprt *, xdrproc_t, caddr_t)); /* get arguments */ bool_t (*xp_reply) __((struct __svcxprt *, struct rpc_msg *)); /* send reply */ bool_t (*xp_freeargs) __((struct __svcxprt *, xdrproc_t, caddr_t)); /* free mem allocated for args */ void (*xp_destroy) __((struct __svcxprt *)); /* destroy this struct */ } *xp_ops; 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: for use by svc ops */ caddr_t xp_p2; /* private: for use by svc ops */ caddr_t xp_p3; /* private: for use by svc lib */ } SVCXPRT; /* * Approved way of getting address of caller */ #define svc_getcaller(x) (&(x)->xp_raddr) /* * Operations defined on an SVCXPRT handle * * SVCXPRT *xprt; * struct rpc_msg *msg; * xdrproc_t xargs; * caddr_t argsp; */ #define SVC_RECV(xprt, msg) \ (*(xprt)->xp_ops->xp_recv)((xprt), (msg)) #define svc_recv(xprt, msg) \ (*(xprt)->xp_ops->xp_recv)((xprt), (msg)) #define SVC_STAT(xprt) \ (*(xprt)->xp_ops->xp_stat)(xprt) #ifdef _NAME_SPACE_WEAK_STRONG #ifdef svc_stat #undef svc_stat #endif #endif #define svc_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) /* * Service request */ struct svc_req { u_int rq_prog; /* service program number */ u_int rq_vers; /* service protocol version */ u_int 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 */ }; /* * Service registration * * svc_register(xprt, prog, vers, dispatch, protocol) * SVCXPRT *xprt; * u_int prog; * u_int vers; * void (*dispatch)(); * int protocol; /* like TCP or UDP, zero means do not register */ _BEGIN_CPLUSPLUS extern bool_t svc_register __((SVCXPRT*, u_long, u_long, void (*) (struct svc_req *, SVCXPRT *), u_long)); /* * Service un-registration * * svc_unregister(prog, vers) * u_int prog; * u_int vers; */ extern void svc_unregister __((u_long, u_long)); /* * Transport registration. * * xprt_register(xprt) * SVCXPRT *xprt; */ extern void xprt_register __((SVCXPRT *)); #ifndef KERNEL /* * Transport un-register * * xprt_unregister(xprt) * SVCXPRT *xprt; */ extern void xprt_unregister __((SVCXPRT *)); #endif /* !KERNEL */ /* * 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 __((SVCXPRT*, xdrproc_t, char *)); extern void svcerr_decode __((SVCXPRT*)); extern void svcerr_weakauth __((SVCXPRT*)); extern void svcerr_noproc __((SVCXPRT*)); extern void svcerr_progvers __((SVCXPRT*)); extern void svcerr_auth __((SVCXPRT*, enum auth_stat)); extern void svcerr_noprog __((SVCXPRT*)); #ifndef KERNEL extern void svcerr_systemerr __((SVCXPRT*)); #endif _END_CPLUSPLUS /* * 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., * svc_run never returns. * 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). */ #ifndef KERNEL /* * Global keeper of rpc service descriptors in use * dynamic; must be inspected before each call to select */ extern fd_set svc_fdset; #define svc_fds svc_fdset.fds_bits[0] /* compatibility */ /* * a small program implemented by the svc_rpc implementation itself; * also see clnt.h for protocol numbers. */ _BEGIN_CPLUSPLUS extern void rpctest_service(); _END_CPLUSPLUS #endif /* !KERNEL */ _BEGIN_CPLUSPLUS extern void svc_getreq __((int)); #ifndef KERNEL extern void svc_getreqset __((fd_set *)); /* takes fdset instead of int */ #endif extern void svc_run (); /* never returns */ _END_CPLUSPLUS /* * Socket to use on svcxxx_create call to get default socket */ #define RPC_ANYSOCK -1 /* * These are the existing service side transport implementations */ _BEGIN_CPLUSPLUS #ifndef KERNEL /* * Memory based rpc for testing and timing. */ extern SVCXPRT *svcraw_create(); /* * Udp based rpc. */ extern SVCXPRT *svcudp_create __((int)); extern SVCXPRT *svcudp_bufcreate(); /* * Tcp based rpc. */ extern SVCXPRT *svctcp_create __((int, u_int,u_int)); /* * Like svtcp_create(), except the routine takes any *open* UNIX file * descriptor as its first input. */ SVCXPRT *svcfd_create __((int, u_int, u_int)); #else /* * Kernel udp based rpc. */ extern SVCXPRT *svckudp_create(); #endif /* !KERNEL */ _END_CPLUSPLUS #endif /*!_rpc_svc_h*/