1 /* $NetBSD: svc.h,v 1.17 2000/06/02 22:57:56 fvdl Exp $ */ 2 3 /* 4 * Sun RPC is a product of Sun Microsystems, Inc. and is provided for 5 * unrestricted use provided that this legend is included on all tape 6 * media and as a part of the software program in whole or part. Users 7 * may copy or modify Sun RPC without charge, but are not authorized 8 * to license or distribute it to anyone else except as part of a product or 9 * program developed by the user. 10 * 11 * SUN RPC IS PROVIDED AS IS WITH NO WARRANTIES OF ANY KIND INCLUDING THE 12 * WARRANTIES OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR 13 * PURPOSE, OR ARISING FROM A COURSE OF DEALING, USAGE OR TRADE PRACTICE. 14 * 15 * Sun RPC is provided with no support and without any obligation on the 16 * part of Sun Microsystems, Inc. to assist in its use, correction, 17 * modification or enhancement. 18 * 19 * SUN MICROSYSTEMS, INC. SHALL HAVE NO LIABILITY WITH RESPECT TO THE 20 * INFRINGEMENT OF COPYRIGHTS, TRADE SECRETS OR ANY PATENTS BY SUN RPC 21 * OR ANY PART THEREOF. 22 * 23 * In no event will Sun Microsystems, Inc. be liable for any lost revenue 24 * or profits or other special, indirect and consequential damages, even if 25 * Sun has been advised of the possibility of such damages. 26 * 27 * Sun Microsystems, Inc. 28 * 2550 Garcia Avenue 29 * Mountain View, California 94043 30 * 31 * from: @(#)svc.h 1.35 88/12/17 SMI 32 * from: @(#)svc.h 1.27 94/04/25 SMI 33 * $FreeBSD$ 34 */ 35 36 /* 37 * svc.h, Server-side remote procedure call interface. 38 * 39 * Copyright (C) 1986-1993 by 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 68 /* 69 * Service control requests 70 */ 71 #define SVCGET_VERSQUIET 1 72 #define SVCSET_VERSQUIET 2 73 #define SVCGET_CONNMAXREC 3 74 #define SVCSET_CONNMAXREC 4 75 76 /* 77 * Operations for rpc_control(). 78 */ 79 #define RPC_SVC_CONNMAXREC_SET 0 /* set max rec size, enable nonblock */ 80 #define RPC_SVC_CONNMAXREC_GET 1 81 82 enum xprt_stat { 83 XPRT_DIED, 84 XPRT_MOREREQS, 85 XPRT_IDLE 86 }; 87 88 /* 89 * Server side transport handle 90 */ 91 typedef struct __rpc_svcxprt { 92 int xp_fd; 93 u_short xp_port; /* associated port number */ 94 const struct xp_ops { 95 /* receive incoming requests */ 96 bool_t (*xp_recv)(struct __rpc_svcxprt *, struct rpc_msg *); 97 /* get transport status */ 98 enum xprt_stat (*xp_stat)(struct __rpc_svcxprt *); 99 /* get arguments */ 100 bool_t (*xp_getargs)(struct __rpc_svcxprt *, xdrproc_t, 101 void *); 102 /* send reply */ 103 bool_t (*xp_reply)(struct __rpc_svcxprt *, struct rpc_msg *); 104 /* free mem allocated for args */ 105 bool_t (*xp_freeargs)(struct __rpc_svcxprt *, xdrproc_t, 106 void *); 107 /* destroy this struct */ 108 void (*xp_destroy)(struct __rpc_svcxprt *); 109 } *xp_ops; 110 int xp_addrlen; /* length of remote address */ 111 struct sockaddr_in xp_raddr; /* remote addr. (backward ABI compat) */ 112 /* XXX - fvdl stick this here for ABI backward compat reasons */ 113 const struct xp_ops2 { 114 /* catch-all function */ 115 bool_t (*xp_control)(struct __rpc_svcxprt *, const u_int, 116 void *); 117 } *xp_ops2; 118 char *xp_tp; /* transport provider device name */ 119 char *xp_netid; /* network token */ 120 struct netbuf xp_ltaddr; /* local transport address */ 121 struct netbuf xp_rtaddr; /* remote transport address */ 122 struct opaque_auth xp_verf; /* raw response verifier */ 123 void *xp_p1; /* private: for use by svc ops */ 124 void *xp_p2; /* private: for use by svc ops */ 125 void *xp_p3; /* private: for use by svc lib */ 126 int xp_type; /* transport type */ 127 } SVCXPRT; 128 129 /* 130 * Service request 131 */ 132 struct svc_req { 133 u_int32_t rq_prog; /* service program number */ 134 u_int32_t rq_vers; /* service protocol version */ 135 u_int32_t rq_proc; /* the desired procedure */ 136 struct opaque_auth rq_cred; /* raw creds from the wire */ 137 void *rq_clntcred; /* read only cooked cred */ 138 SVCXPRT *rq_xprt; /* associated transport */ 139 }; 140 141 /* 142 * Approved way of getting address of caller 143 */ 144 #define svc_getrpccaller(x) (&(x)->xp_rtaddr) 145 146 /* 147 * FreeBSD-only definition to get the creds of the caller (AF_LOCAL). 148 */ 149 #define __svc_getcallercreds(x) ((struct cmsgcred *)(x)->xp_p2) 150 151 /* 152 * Operations defined on an SVCXPRT handle 153 * 154 * SVCXPRT *xprt; 155 * struct rpc_msg *msg; 156 * xdrproc_t xargs; 157 * void * argsp; 158 */ 159 #define SVC_RECV(xprt, msg) \ 160 (*(xprt)->xp_ops->xp_recv)((xprt), (msg)) 161 #define svc_recv(xprt, msg) \ 162 (*(xprt)->xp_ops->xp_recv)((xprt), (msg)) 163 164 #define SVC_STAT(xprt) \ 165 (*(xprt)->xp_ops->xp_stat)(xprt) 166 #define svc_stat(xprt) \ 167 (*(xprt)->xp_ops->xp_stat)(xprt) 168 169 #define SVC_GETARGS(xprt, xargs, argsp) \ 170 (*(xprt)->xp_ops->xp_getargs)((xprt), (xargs), (argsp)) 171 #define svc_getargs(xprt, xargs, argsp) \ 172 (*(xprt)->xp_ops->xp_getargs)((xprt), (xargs), (argsp)) 173 174 #define SVC_REPLY(xprt, msg) \ 175 (*(xprt)->xp_ops->xp_reply) ((xprt), (msg)) 176 #define svc_reply(xprt, msg) \ 177 (*(xprt)->xp_ops->xp_reply) ((xprt), (msg)) 178 179 #define SVC_FREEARGS(xprt, xargs, argsp) \ 180 (*(xprt)->xp_ops->xp_freeargs)((xprt), (xargs), (argsp)) 181 #define svc_freeargs(xprt, xargs, argsp) \ 182 (*(xprt)->xp_ops->xp_freeargs)((xprt), (xargs), (argsp)) 183 184 #define SVC_DESTROY(xprt) \ 185 (*(xprt)->xp_ops->xp_destroy)(xprt) 186 #define svc_destroy(xprt) \ 187 (*(xprt)->xp_ops->xp_destroy)(xprt) 188 189 #define SVC_CONTROL(xprt, rq, in) \ 190 (*(xprt)->xp_ops2->xp_control)((xprt), (rq), (in)) 191 192 /* 193 * Service registration 194 * 195 * svc_reg(xprt, prog, vers, dispatch, nconf) 196 * const SVCXPRT *xprt; 197 * const rpcprog_t prog; 198 * const rpcvers_t vers; 199 * const void (*dispatch)(); 200 * const struct netconfig *nconf; 201 */ 202 203 __BEGIN_DECLS 204 extern bool_t svc_reg(SVCXPRT *, const rpcprog_t, const rpcvers_t, 205 void (*)(struct svc_req *, SVCXPRT *), 206 const struct netconfig *); 207 __END_DECLS 208 209 /* 210 * Service un-registration 211 * 212 * svc_unreg(prog, vers) 213 * const rpcprog_t prog; 214 * const rpcvers_t vers; 215 */ 216 217 __BEGIN_DECLS 218 extern void svc_unreg(const rpcprog_t, const rpcvers_t); 219 __END_DECLS 220 221 /* 222 * Transport registration. 223 * 224 * xprt_register(xprt) 225 * SVCXPRT *xprt; 226 */ 227 __BEGIN_DECLS 228 extern void xprt_register(SVCXPRT *); 229 __END_DECLS 230 231 /* 232 * Transport un-register 233 * 234 * xprt_unregister(xprt) 235 * SVCXPRT *xprt; 236 */ 237 __BEGIN_DECLS 238 extern void xprt_unregister(SVCXPRT *); 239 __END_DECLS 240 241 242 /* 243 * When the service routine is called, it must first check to see if it 244 * knows about the procedure; if not, it should call svcerr_noproc 245 * and return. If so, it should deserialize its arguments via 246 * SVC_GETARGS (defined above). If the deserialization does not work, 247 * svcerr_decode should be called followed by a return. Successful 248 * decoding of the arguments should be followed the execution of the 249 * procedure's code and a call to svc_sendreply. 250 * 251 * Also, if the service refuses to execute the procedure due to too- 252 * weak authentication parameters, svcerr_weakauth should be called. 253 * Note: do not confuse access-control failure with weak authentication! 254 * 255 * NB: In pure implementations of rpc, the caller always waits for a reply 256 * msg. This message is sent when svc_sendreply is called. 257 * Therefore pure service implementations should always call 258 * svc_sendreply even if the function logically returns void; use 259 * xdr.h - xdr_void for the xdr routine. HOWEVER, tcp based rpc allows 260 * for the abuse of pure rpc via batched calling or pipelining. In the 261 * case of a batched call, svc_sendreply should NOT be called since 262 * this would send a return message, which is what batching tries to avoid. 263 * It is the service/protocol writer's responsibility to know which calls are 264 * batched and which are not. Warning: responding to batch calls may 265 * deadlock the caller and server processes! 266 */ 267 268 __BEGIN_DECLS 269 extern bool_t svc_sendreply(SVCXPRT *, xdrproc_t, void *); 270 extern void svcerr_decode(SVCXPRT *); 271 extern void svcerr_weakauth(SVCXPRT *); 272 extern void svcerr_noproc(SVCXPRT *); 273 extern void svcerr_progvers(SVCXPRT *, rpcvers_t, rpcvers_t); 274 extern void svcerr_auth(SVCXPRT *, enum auth_stat); 275 extern void svcerr_noprog(SVCXPRT *); 276 extern void svcerr_systemerr(SVCXPRT *); 277 extern int rpc_reg(rpcprog_t, rpcvers_t, rpcproc_t, 278 char *(*)(char *), xdrproc_t, xdrproc_t, 279 char *); 280 __END_DECLS 281 282 /* 283 * Lowest level dispatching -OR- who owns this process anyway. 284 * Somebody has to wait for incoming requests and then call the correct 285 * service routine. The routine svc_run does infinite waiting; i.e., 286 * svc_run never returns. 287 * Since another (co-existant) package may wish to selectively wait for 288 * incoming calls or other events outside of the rpc architecture, the 289 * routine svc_getreq is provided. It must be passed readfds, the 290 * "in-place" results of a select system call (see select, section 2). 291 */ 292 293 /* 294 * Global keeper of rpc service descriptors in use 295 * dynamic; must be inspected before each call to select 296 */ 297 extern int svc_maxfd; 298 #ifdef FD_SETSIZE 299 extern fd_set svc_fdset; 300 #define svc_fds svc_fdset.fds_bits[0] /* compatibility */ 301 #else 302 extern int svc_fds; 303 #endif /* def FD_SETSIZE */ 304 305 /* 306 * a small program implemented by the svc_rpc implementation itself; 307 * also see clnt.h for protocol numbers. 308 */ 309 __BEGIN_DECLS 310 extern void rpctest_service(void); 311 __END_DECLS 312 313 __BEGIN_DECLS 314 extern void svc_getreq(int); 315 extern void svc_getreqset(fd_set *); 316 extern void svc_getreq_common(int); 317 struct pollfd; 318 extern void svc_getreq_poll(struct pollfd *, int); 319 320 extern void svc_run(void); 321 extern void svc_exit(void); 322 __END_DECLS 323 324 /* 325 * Socket to use on svcxxx_create call to get default socket 326 */ 327 #define RPC_ANYSOCK -1 328 #define RPC_ANYFD RPC_ANYSOCK 329 330 /* 331 * These are the existing service side transport implementations 332 */ 333 334 __BEGIN_DECLS 335 /* 336 * Transport independent svc_create routine. 337 */ 338 extern int svc_create(void (*)(struct svc_req *, SVCXPRT *), 339 const rpcprog_t, const rpcvers_t, const char *); 340 /* 341 * void (*dispatch)(); -- dispatch routine 342 * const rpcprog_t prognum; -- program number 343 * const rpcvers_t versnum; -- version number 344 * const char *nettype; -- network type 345 */ 346 347 348 /* 349 * Generic server creation routine. It takes a netconfig structure 350 * instead of a nettype. 351 */ 352 353 extern SVCXPRT *svc_tp_create(void (*)(struct svc_req *, SVCXPRT *), 354 const rpcprog_t, const rpcvers_t, 355 const struct netconfig *); 356 /* 357 * void (*dispatch)(); -- dispatch routine 358 * const rpcprog_t prognum; -- program number 359 * const rpcvers_t versnum; -- version number 360 * const struct netconfig *nconf; -- netconfig structure 361 */ 362 363 364 /* 365 * Generic TLI create routine 366 */ 367 extern SVCXPRT *svc_tli_create(const int, const struct netconfig *, 368 const struct t_bind *, const u_int, 369 const u_int); 370 /* 371 * const int fd; -- connection end point 372 * const struct netconfig *nconf; -- netconfig structure for network 373 * const struct t_bind *bindaddr; -- local bind address 374 * const u_int sendsz; -- max sendsize 375 * const u_int recvsz; -- max recvsize 376 */ 377 378 /* 379 * Connectionless and connectionful create routines 380 */ 381 382 extern SVCXPRT *svc_vc_create(const int, const u_int, const u_int); 383 /* 384 * const int fd; -- open connection end point 385 * const u_int sendsize; -- max send size 386 * const u_int recvsize; -- max recv size 387 */ 388 389 /* 390 * Added for compatibility to old rpc 4.0. Obsoleted by svc_vc_create(). 391 */ 392 extern SVCXPRT *svcunix_create(int, u_int, u_int, char *); 393 394 extern SVCXPRT *svc_dg_create(const int, const u_int, const u_int); 395 /* 396 * const int fd; -- open connection 397 * const u_int sendsize; -- max send size 398 * const u_int recvsize; -- max recv size 399 */ 400 401 402 /* 403 * the routine takes any *open* connection 404 * descriptor as its first input and is used for open connections. 405 */ 406 extern SVCXPRT *svc_fd_create(const int, const u_int, const u_int); 407 /* 408 * const int fd; -- open connection end point 409 * const u_int sendsize; -- max send size 410 * const u_int recvsize; -- max recv size 411 */ 412 413 /* 414 * Added for compatibility to old rpc 4.0. Obsoleted by svc_fd_create(). 415 */ 416 extern SVCXPRT *svcunixfd_create(int, u_int, u_int); 417 418 /* 419 * Memory based rpc (for speed check and testing) 420 */ 421 extern SVCXPRT *svc_raw_create(void); 422 423 /* 424 * svc_dg_enable_cache() enables the cache on dg transports. 425 */ 426 int svc_dg_enablecache(SVCXPRT *, const u_int); 427 428 int __rpc_get_local_uid(SVCXPRT *_transp, uid_t *_uid); 429 430 __END_DECLS 431 432 433 /* for backward compatibility */ 434 #include <rpc/svc_soc.h> 435 436 #endif /* !_RPC_SVC_H */ 437