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