1 /* $OpenBSD: svc.h,v 1.11 2010/05/01 08:14:26 mk 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 #include <sys/poll.h> 46 47 /* 48 * This interface must manage two items concerning remote procedure calling: 49 * 50 * 1) An arbitrary number of transport connections upon which rpc requests 51 * are received. The two most notable transports are TCP and UDP; they are 52 * created and registered by routines in svc_tcp.c and svc_udp.c, respectively; 53 * they in turn call xprt_register and xprt_unregister. 54 * 55 * 2) An arbitrary number of locally registered services. Services are 56 * described by the following four data: program number, version number, 57 * "service dispatch" function, a transport handle, and a boolean that 58 * indicates whether or not the exported program should be registered with a 59 * local binder service; if true the program's number and version and the 60 * port number from the transport handle are registered with the binder. 61 * These data are registered with the rpc svc system via svc_register. 62 * 63 * A service's dispatch function is called whenever an rpc request comes in 64 * on a transport. The request's program and version numbers must match 65 * those of the registered service. The dispatch function is passed two 66 * parameters, struct svc_req * and SVCXPRT *, defined below. 67 */ 68 69 enum xprt_stat { 70 XPRT_DIED, 71 XPRT_MOREREQS, 72 XPRT_IDLE 73 }; 74 75 /* 76 * Server side transport handle 77 */ 78 typedef struct __rpc_svcxprt { 79 int xp_sock; 80 unsigned short xp_port; /* associated port number */ 81 struct xp_ops { 82 /* receive incoming requests */ 83 bool_t (*xp_recv)(struct __rpc_svcxprt *, 84 struct rpc_msg *); 85 /* get transport status */ 86 enum xprt_stat (*xp_stat)(struct __rpc_svcxprt *); 87 /* get arguments */ 88 bool_t (*xp_getargs)(struct __rpc_svcxprt *, xdrproc_t, 89 caddr_t); 90 /* send reply */ 91 bool_t (*xp_reply)(struct __rpc_svcxprt *, struct rpc_msg *); 92 /* free mem allocated for args */ 93 bool_t (*xp_freeargs)(struct __rpc_svcxprt *, xdrproc_t, 94 caddr_t); 95 /* destroy this struct */ 96 void (*xp_destroy)(struct __rpc_svcxprt *); 97 } *xp_ops; 98 socklen_t xp_addrlen; /* length of remote address */ 99 struct sockaddr_in xp_raddr; /* remote address */ 100 struct opaque_auth xp_verf; /* raw response verifier */ 101 caddr_t xp_p1; /* private */ 102 caddr_t xp_p2; /* private */ 103 } SVCXPRT; 104 105 /* 106 * Approved way of getting address of caller 107 */ 108 #define svc_getcaller(x) (&(x)->xp_raddr) 109 110 /* 111 * Operations defined on an SVCXPRT handle 112 * 113 * SVCXPRT *xprt; 114 * struct rpc_msg *msg; 115 * xdrproc_t xargs; 116 * caddr_t argsp; 117 */ 118 #define SVC_RECV(xprt, msg) \ 119 (*(xprt)->xp_ops->xp_recv)((xprt), (msg)) 120 #define svc_recv(xprt, msg) \ 121 (*(xprt)->xp_ops->xp_recv)((xprt), (msg)) 122 123 #define SVC_STAT(xprt) \ 124 (*(xprt)->xp_ops->xp_stat)(xprt) 125 #define svc_stat(xprt) \ 126 (*(xprt)->xp_ops->xp_stat)(xprt) 127 128 #define SVC_GETARGS(xprt, xargs, argsp) \ 129 (*(xprt)->xp_ops->xp_getargs)((xprt), (xargs), (argsp)) 130 #define svc_getargs(xprt, xargs, argsp) \ 131 (*(xprt)->xp_ops->xp_getargs)((xprt), (xargs), (argsp)) 132 133 #define SVC_REPLY(xprt, msg) \ 134 (*(xprt)->xp_ops->xp_reply) ((xprt), (msg)) 135 #define svc_reply(xprt, msg) \ 136 (*(xprt)->xp_ops->xp_reply) ((xprt), (msg)) 137 138 #define SVC_FREEARGS(xprt, xargs, argsp) \ 139 (*(xprt)->xp_ops->xp_freeargs)((xprt), (xargs), (argsp)) 140 #define svc_freeargs(xprt, xargs, argsp) \ 141 (*(xprt)->xp_ops->xp_freeargs)((xprt), (xargs), (argsp)) 142 143 #define SVC_DESTROY(xprt) \ 144 (*(xprt)->xp_ops->xp_destroy)(xprt) 145 #define svc_destroy(xprt) \ 146 (*(xprt)->xp_ops->xp_destroy)(xprt) 147 148 149 /* 150 * Service request 151 */ 152 struct svc_req { 153 u_int32_t rq_prog; /* service program number */ 154 u_int32_t rq_vers; /* service protocol version */ 155 u_int32_t rq_proc; /* the desired procedure */ 156 struct opaque_auth rq_cred; /* raw creds from the wire */ 157 caddr_t rq_clntcred; /* read only cooked cred */ 158 SVCXPRT *rq_xprt; /* associated transport */ 159 }; 160 161 162 /* 163 * Service registration 164 * 165 * svc_register(xprt, prog, vers, dispatch, protocol) 166 * SVCXPRT *xprt; 167 * unsigned long prog; 168 * unsigned long vers; 169 * void (*dispatch)(); 170 * int protocol; like TCP or UDP, zero means do not register 171 */ 172 __BEGIN_DECLS 173 extern bool_t svc_register(SVCXPRT *, unsigned long, unsigned long, 174 void (*)(struct svc_req *, SVCXPRT *), int); 175 __END_DECLS 176 177 /* 178 * Service un-registration 179 * 180 * svc_unregister(prog, vers) 181 * unsigned long prog; 182 * unsigned long vers; 183 */ 184 __BEGIN_DECLS 185 extern void svc_unregister(unsigned long, unsigned long); 186 __END_DECLS 187 188 /* 189 * Transport registration. 190 * 191 * xprt_register(xprt) 192 * SVCXPRT *xprt; 193 */ 194 __BEGIN_DECLS 195 extern void xprt_register(SVCXPRT *); 196 extern int __xprt_register(SVCXPRT *); 197 __END_DECLS 198 199 /* 200 * Transport un-register 201 * 202 * xprt_unregister(xprt) 203 * SVCXPRT *xprt; 204 */ 205 __BEGIN_DECLS 206 extern void xprt_unregister(SVCXPRT *); 207 __END_DECLS 208 209 210 211 212 /* 213 * When the service routine is called, it must first check to see if it 214 * knows about the procedure; if not, it should call svcerr_noproc 215 * and return. If so, it should deserialize its arguments via 216 * SVC_GETARGS (defined above). If the deserialization does not work, 217 * svcerr_decode should be called followed by a return. Successful 218 * decoding of the arguments should be followed the execution of the 219 * procedure's code and a call to svc_sendreply. 220 * 221 * Also, if the service refuses to execute the procedure due to too- 222 * weak authentication parameters, svcerr_weakauth should be called. 223 * Note: do not confuse access-control failure with weak authentication! 224 * 225 * NB: In pure implementations of rpc, the caller always waits for a reply 226 * msg. This message is sent when svc_sendreply is called. 227 * Therefore pure service implementations should always call 228 * svc_sendreply even if the function logically returns void; use 229 * xdr.h - xdr_void for the xdr routine. HOWEVER, tcp based rpc allows 230 * for the abuse of pure rpc via batched calling or pipelining. In the 231 * case of a batched call, svc_sendreply should NOT be called since 232 * this would send a return message, which is what batching tries to avoid. 233 * It is the service/protocol writer's responsibility to know which calls are 234 * batched and which are not. Warning: responding to batch calls may 235 * deadlock the caller and server processes! 236 */ 237 238 __BEGIN_DECLS 239 extern bool_t svc_sendreply(SVCXPRT *, xdrproc_t, char *); 240 extern void svcerr_decode(SVCXPRT *); 241 extern void svcerr_weakauth(SVCXPRT *); 242 extern void svcerr_noproc(SVCXPRT *); 243 extern void svcerr_progvers(SVCXPRT *, unsigned long, unsigned long); 244 extern void svcerr_auth(SVCXPRT *, enum auth_stat); 245 extern void svcerr_noprog(SVCXPRT *); 246 extern void svcerr_systemerr(SVCXPRT *); 247 __END_DECLS 248 249 /* 250 * Lowest level dispatching -OR- who owns this process anyway. 251 * Somebody has to wait for incoming requests and then call the correct 252 * service routine. The routine svc_run does infinite waiting; i.e., 253 * svc_run never returns. 254 * Since another (co-existent) package may wish to selectively wait for 255 * incoming calls or other events outside of the rpc architecture, the 256 * routine svc_getreq is provided. It must be passed readfds, the 257 * "in-place" results of a select system call (see select, section 2). 258 */ 259 260 /* 261 * Global keeper of rpc service descriptors in use 262 * dynamic; must be inspected before each call to select 263 */ 264 extern fd_set svc_fdset; 265 #define svc_fds svc_fdset.fds_bits[0] /* compatibility */ 266 extern struct pollfd *svc_pollfd; 267 extern int svc_max_pollfd; 268 extern int svc_maxfd; /* non-standard */ 269 270 /* 271 * a small program implemented by the svc_rpc implementation itself; 272 * also see clnt.h for protocol numbers. 273 */ 274 extern void rpctest_service(); /* XXX relic? */ 275 276 __BEGIN_DECLS 277 extern void svc_getreq(int); 278 extern void svc_getreq_common(int); 279 extern void svc_getreq_poll(struct pollfd *, const int); 280 extern void svc_getreqset(fd_set *); 281 extern void svc_getreqset2(fd_set *, int); 282 extern void svc_run(void); 283 __END_DECLS 284 285 /* 286 * Socket to use on svcxxx_create call to get default socket 287 */ 288 #define RPC_ANYSOCK -1 289 290 /* 291 * These are the existing service side transport implementations 292 */ 293 294 /* 295 * Memory based rpc for testing and timing. 296 */ 297 __BEGIN_DECLS 298 extern SVCXPRT *svcraw_create(void); 299 __END_DECLS 300 301 302 /* 303 * Udp based rpc. 304 */ 305 __BEGIN_DECLS 306 extern SVCXPRT *svcudp_create(int); 307 extern SVCXPRT *svcudp_bufcreate(int, unsigned int, unsigned int); 308 __END_DECLS 309 310 311 /* 312 * Tcp based rpc. 313 */ 314 __BEGIN_DECLS 315 extern SVCXPRT *svctcp_create(int, unsigned int, unsigned int); 316 __END_DECLS 317 318 /* 319 * Fd based rpc. 320 */ 321 __BEGIN_DECLS 322 extern SVCXPRT *svcfd_create(int, unsigned int, unsigned int); 323 __END_DECLS 324 325 #endif /* !_RPC_SVC_H */ 326