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 #ifdef _KERNEL 47 #include <sys/queue.h> 48 #include <sys/_lock.h> 49 #include <sys/_mutex.h> 50 #include <sys/_sx.h> 51 #include <sys/condvar.h> 52 #include <sys/sysctl.h> 53 #endif 54 55 /* 56 * This interface must manage two items concerning remote procedure calling: 57 * 58 * 1) An arbitrary number of transport connections upon which rpc requests 59 * are received. The two most notable transports are TCP and UDP; they are 60 * created and registered by routines in svc_tcp.c and svc_udp.c, respectively; 61 * they in turn call xprt_register and xprt_unregister. 62 * 63 * 2) An arbitrary number of locally registered services. Services are 64 * described by the following four data: program number, version number, 65 * "service dispatch" function, a transport handle, and a boolean that 66 * indicates whether or not the exported program should be registered with a 67 * local binder service; if true the program's number and version and the 68 * port number from the transport handle are registered with the binder. 69 * These data are registered with the rpc svc system via svc_register. 70 * 71 * A service's dispatch function is called whenever an rpc request comes in 72 * on a transport. The request's program and version numbers must match 73 * those of the registered service. The dispatch function is passed two 74 * parameters, struct svc_req * and SVCXPRT *, defined below. 75 */ 76 77 /* 78 * Service control requests 79 */ 80 #define SVCGET_VERSQUIET 1 81 #define SVCSET_VERSQUIET 2 82 #define SVCGET_CONNMAXREC 3 83 #define SVCSET_CONNMAXREC 4 84 85 /* 86 * Operations for rpc_control(). 87 */ 88 #define RPC_SVC_CONNMAXREC_SET 0 /* set max rec size, enable nonblock */ 89 #define RPC_SVC_CONNMAXREC_GET 1 90 91 enum xprt_stat { 92 XPRT_DIED, 93 XPRT_MOREREQS, 94 XPRT_IDLE 95 }; 96 97 struct __rpc_svcxprt; 98 struct mbuf; 99 100 struct xp_ops { 101 #ifdef _KERNEL 102 /* receive incoming requests */ 103 bool_t (*xp_recv)(struct __rpc_svcxprt *, struct rpc_msg *, 104 struct sockaddr **, struct mbuf **); 105 /* get transport status */ 106 enum xprt_stat (*xp_stat)(struct __rpc_svcxprt *); 107 /* send reply */ 108 bool_t (*xp_reply)(struct __rpc_svcxprt *, struct rpc_msg *, 109 struct sockaddr *, struct mbuf *); 110 /* destroy this struct */ 111 void (*xp_destroy)(struct __rpc_svcxprt *); 112 /* catch-all function */ 113 bool_t (*xp_control)(struct __rpc_svcxprt *, const u_int, void *); 114 #else 115 /* receive incoming requests */ 116 bool_t (*xp_recv)(struct __rpc_svcxprt *, struct rpc_msg *); 117 /* get transport status */ 118 enum xprt_stat (*xp_stat)(struct __rpc_svcxprt *); 119 /* get arguments */ 120 bool_t (*xp_getargs)(struct __rpc_svcxprt *, xdrproc_t, void *); 121 /* send reply */ 122 bool_t (*xp_reply)(struct __rpc_svcxprt *, struct rpc_msg *); 123 /* free mem allocated for args */ 124 bool_t (*xp_freeargs)(struct __rpc_svcxprt *, xdrproc_t, void *); 125 /* destroy this struct */ 126 void (*xp_destroy)(struct __rpc_svcxprt *); 127 #endif 128 }; 129 130 #ifndef _KERNEL 131 struct xp_ops2 { 132 /* catch-all function */ 133 bool_t (*xp_control)(struct __rpc_svcxprt *, const u_int, void *); 134 }; 135 #endif 136 137 #ifdef _KERNEL 138 struct __rpc_svcpool; 139 struct __rpc_svcthread; 140 #endif 141 142 /* 143 * Server side transport handle. In the kernel, transports have a 144 * reference count which tracks the number of currently assigned 145 * worker threads plus one for the service pool's reference. 146 */ 147 typedef struct __rpc_svcxprt { 148 #ifdef _KERNEL 149 volatile u_int xp_refs; 150 struct sx xp_lock; 151 struct __rpc_svcpool *xp_pool; /* owning pool (see below) */ 152 TAILQ_ENTRY(__rpc_svcxprt) xp_link; 153 TAILQ_ENTRY(__rpc_svcxprt) xp_alink; 154 bool_t xp_registered; /* xprt_register has been called */ 155 bool_t xp_active; /* xprt_active has been called */ 156 struct __rpc_svcthread *xp_thread; /* assigned service thread */ 157 struct socket* xp_socket; 158 const struct xp_ops *xp_ops; 159 char *xp_netid; /* network token */ 160 struct sockaddr_storage xp_ltaddr; /* local transport address */ 161 struct sockaddr_storage xp_rtaddr; /* remote transport address */ 162 void *xp_p1; /* private: for use by svc ops */ 163 void *xp_p2; /* private: for use by svc ops */ 164 void *xp_p3; /* private: for use by svc lib */ 165 int xp_type; /* transport type */ 166 int xp_idletimeout; /* idle time before closing */ 167 time_t xp_lastactive; /* time of last RPC */ 168 u_int64_t xp_sockref; /* set by nfsv4 to identify socket */ 169 #else 170 int xp_fd; 171 u_short xp_port; /* associated port number */ 172 const struct xp_ops *xp_ops; 173 int xp_addrlen; /* length of remote address */ 174 struct sockaddr_in xp_raddr; /* remote addr. (backward ABI compat) */ 175 /* XXX - fvdl stick this here for ABI backward compat reasons */ 176 const struct xp_ops2 *xp_ops2; 177 char *xp_tp; /* transport provider device name */ 178 char *xp_netid; /* network token */ 179 struct netbuf xp_ltaddr; /* local transport address */ 180 struct netbuf xp_rtaddr; /* remote transport address */ 181 struct opaque_auth xp_verf; /* raw response verifier */ 182 void *xp_p1; /* private: for use by svc ops */ 183 void *xp_p2; /* private: for use by svc ops */ 184 void *xp_p3; /* private: for use by svc lib */ 185 int xp_type; /* transport type */ 186 #endif 187 } SVCXPRT; 188 189 /* 190 * Interface to server-side authentication flavors. 191 */ 192 typedef struct __rpc_svcauth { 193 struct svc_auth_ops { 194 #ifdef _KERNEL 195 int (*svc_ah_wrap)(struct __rpc_svcauth *, struct mbuf **); 196 int (*svc_ah_unwrap)(struct __rpc_svcauth *, struct mbuf **); 197 void (*svc_ah_release)(struct __rpc_svcauth *); 198 #else 199 int (*svc_ah_wrap)(struct __rpc_svcauth *, XDR *, 200 xdrproc_t, caddr_t); 201 int (*svc_ah_unwrap)(struct __rpc_svcauth *, XDR *, 202 xdrproc_t, caddr_t); 203 #endif 204 } *svc_ah_ops; 205 void *svc_ah_private; 206 } SVCAUTH; 207 208 /* 209 * Server transport extensions (accessed via xp_p3). 210 */ 211 typedef struct __rpc_svcxprt_ext { 212 int xp_flags; /* versquiet */ 213 SVCAUTH xp_auth; /* interface to auth methods */ 214 } SVCXPRT_EXT; 215 216 #ifdef _KERNEL 217 218 /* 219 * The services list 220 * Each entry represents a set of procedures (an rpc program). 221 * The dispatch routine takes request structs and runs the 222 * apropriate procedure. 223 */ 224 struct svc_callout { 225 TAILQ_ENTRY(svc_callout) sc_link; 226 rpcprog_t sc_prog; 227 rpcvers_t sc_vers; 228 char *sc_netid; 229 void (*sc_dispatch)(struct svc_req *, SVCXPRT *); 230 }; 231 TAILQ_HEAD(svc_callout_list, svc_callout); 232 233 struct __rpc_svcthread; 234 235 /* 236 * Service request 237 */ 238 struct svc_req { 239 STAILQ_ENTRY(svc_req) rq_link; /* list of requests for a thread */ 240 struct __rpc_svcthread *rq_thread; /* thread which is to execute this */ 241 uint32_t rq_xid; /* RPC transaction ID */ 242 uint32_t rq_prog; /* service program number */ 243 uint32_t rq_vers; /* service protocol version */ 244 uint32_t rq_proc; /* the desired procedure */ 245 size_t rq_size; /* space used by request */ 246 struct mbuf *rq_args; /* XDR-encoded procedure arguments */ 247 struct opaque_auth rq_cred; /* raw creds from the wire */ 248 struct opaque_auth rq_verf; /* verifier for the reply */ 249 void *rq_clntcred; /* read only cooked cred */ 250 SVCAUTH rq_auth; /* interface to auth methods */ 251 SVCXPRT *rq_xprt; /* associated transport */ 252 struct sockaddr *rq_addr; /* reply address or NULL if connected */ 253 void *rq_p1; /* application workspace */ 254 int rq_p2; /* application workspace */ 255 uint64_t rq_p3; /* application workspace */ 256 char rq_credarea[3*MAX_AUTH_BYTES]; 257 }; 258 STAILQ_HEAD(svc_reqlist, svc_req); 259 260 #define svc_getrpccaller(rq) \ 261 ((rq)->rq_addr ? (rq)->rq_addr : \ 262 (struct sockaddr *) &(rq)->rq_xprt->xp_rtaddr) 263 264 /* 265 * This structure is used to manage a thread which is executing 266 * requests from a service pool. A service thread is in one of three 267 * states: 268 * 269 * SVCTHREAD_SLEEPING waiting for a request to process 270 * SVCTHREAD_ACTIVE processing a request 271 * SVCTHREAD_EXITING exiting after finishing current request 272 * 273 * Threads which have no work to process sleep on the pool's sp_active 274 * list. When a transport becomes active, it is assigned a service 275 * thread to read and execute pending RPCs. 276 */ 277 typedef struct __rpc_svcthread { 278 SVCXPRT *st_xprt; /* transport we are processing */ 279 struct svc_reqlist st_reqs; /* RPC requests to execute */ 280 int st_reqcount; /* number of queued reqs */ 281 struct cv st_cond; /* sleeping for work */ 282 LIST_ENTRY(__rpc_svcthread) st_link; /* all threads list */ 283 LIST_ENTRY(__rpc_svcthread) st_ilink; /* idle threads list */ 284 LIST_ENTRY(__rpc_svcthread) st_alink; /* application thread list */ 285 } SVCTHREAD; 286 LIST_HEAD(svcthread_list, __rpc_svcthread); 287 288 /* 289 * In the kernel, we can't use global variables to store lists of 290 * transports etc. since otherwise we could not have two unrelated RPC 291 * services running, each on its own thread. We solve this by 292 * importing a tiny part of a Solaris kernel concept, SVCPOOL. 293 * 294 * A service pool contains a set of transports and service callbacks 295 * for a set of related RPC services. The pool handle should be passed 296 * when creating new transports etc. Future work may include extending 297 * this to support something similar to the Solaris multi-threaded RPC 298 * server. 299 */ 300 TAILQ_HEAD(svcxprt_list, __rpc_svcxprt); 301 enum svcpool_state { 302 SVCPOOL_INIT, /* svc_run not called yet */ 303 SVCPOOL_ACTIVE, /* normal running state */ 304 SVCPOOL_THREADWANTED, /* new service thread requested */ 305 SVCPOOL_THREADSTARTING, /* new service thread started */ 306 SVCPOOL_CLOSING /* svc_exit called */ 307 }; 308 typedef SVCTHREAD *pool_assign_fn(SVCTHREAD *, struct svc_req *); 309 typedef void pool_done_fn(SVCTHREAD *, struct svc_req *); 310 typedef struct __rpc_svcpool { 311 struct mtx sp_lock; /* protect the transport lists */ 312 const char *sp_name; /* pool name (e.g. "nfsd", "NLM" */ 313 enum svcpool_state sp_state; /* current pool state */ 314 struct proc *sp_proc; /* process which is in svc_run */ 315 struct svcxprt_list sp_xlist; /* all transports in the pool */ 316 struct svcxprt_list sp_active; /* transports needing service */ 317 struct svc_callout_list sp_callouts; /* (prog,vers)->dispatch list */ 318 struct svcthread_list sp_threads; /* service threads */ 319 struct svcthread_list sp_idlethreads; /* idle service threads */ 320 int sp_minthreads; /* minimum service thread count */ 321 int sp_maxthreads; /* maximum service thread count */ 322 int sp_threadcount; /* current service thread count */ 323 time_t sp_lastcreatetime; /* when we last started a thread */ 324 time_t sp_lastidlecheck; /* when we last checked idle transports */ 325 326 /* 327 * Hooks to allow an application to control request to thread 328 * placement. 329 */ 330 pool_assign_fn *sp_assign; 331 pool_done_fn *sp_done; 332 333 /* 334 * These variables are used to put an upper bound on the 335 * amount of memory used by RPC requests which are queued 336 * waiting for execution. 337 */ 338 unsigned int sp_space_low; 339 unsigned int sp_space_high; 340 unsigned int sp_space_used; 341 unsigned int sp_space_used_highest; 342 bool_t sp_space_throttled; 343 int sp_space_throttle_count; 344 345 struct replay_cache *sp_rcache; /* optional replay cache */ 346 struct sysctl_ctx_list sp_sysctl; 347 } SVCPOOL; 348 349 #else 350 351 /* 352 * Service request 353 */ 354 struct svc_req { 355 uint32_t rq_prog; /* service program number */ 356 uint32_t rq_vers; /* service protocol version */ 357 uint32_t rq_proc; /* the desired procedure */ 358 struct opaque_auth rq_cred; /* raw creds from the wire */ 359 void *rq_clntcred; /* read only cooked cred */ 360 SVCXPRT *rq_xprt; /* associated transport */ 361 }; 362 363 /* 364 * Approved way of getting address of caller 365 */ 366 #define svc_getrpccaller(x) (&(x)->xp_rtaddr) 367 368 #endif 369 370 /* 371 * Operations defined on an SVCXPRT handle 372 * 373 * SVCXPRT *xprt; 374 * struct rpc_msg *msg; 375 * xdrproc_t xargs; 376 * void * argsp; 377 */ 378 #ifdef _KERNEL 379 380 #define SVC_ACQUIRE(xprt) \ 381 refcount_acquire(&(xprt)->xp_refs) 382 383 #define SVC_RELEASE(xprt) \ 384 if (refcount_release(&(xprt)->xp_refs)) \ 385 SVC_DESTROY(xprt) 386 387 #define SVC_RECV(xprt, msg, addr, args) \ 388 (*(xprt)->xp_ops->xp_recv)((xprt), (msg), (addr), (args)) 389 390 #define SVC_STAT(xprt) \ 391 (*(xprt)->xp_ops->xp_stat)(xprt) 392 393 #define SVC_REPLY(xprt, msg, addr, m) \ 394 (*(xprt)->xp_ops->xp_reply) ((xprt), (msg), (addr), (m)) 395 396 #define SVC_DESTROY(xprt) \ 397 (*(xprt)->xp_ops->xp_destroy)(xprt) 398 399 #define SVC_CONTROL(xprt, rq, in) \ 400 (*(xprt)->xp_ops->xp_control)((xprt), (rq), (in)) 401 402 #else 403 404 #define SVC_RECV(xprt, msg) \ 405 (*(xprt)->xp_ops->xp_recv)((xprt), (msg)) 406 #define svc_recv(xprt, msg) \ 407 (*(xprt)->xp_ops->xp_recv)((xprt), (msg)) 408 409 #define SVC_STAT(xprt) \ 410 (*(xprt)->xp_ops->xp_stat)(xprt) 411 #define svc_stat(xprt) \ 412 (*(xprt)->xp_ops->xp_stat)(xprt) 413 414 #define SVC_GETARGS(xprt, xargs, argsp) \ 415 (*(xprt)->xp_ops->xp_getargs)((xprt), (xargs), (argsp)) 416 #define svc_getargs(xprt, xargs, argsp) \ 417 (*(xprt)->xp_ops->xp_getargs)((xprt), (xargs), (argsp)) 418 419 #define SVC_REPLY(xprt, msg) \ 420 (*(xprt)->xp_ops->xp_reply) ((xprt), (msg)) 421 #define svc_reply(xprt, msg) \ 422 (*(xprt)->xp_ops->xp_reply) ((xprt), (msg)) 423 424 #define SVC_FREEARGS(xprt, xargs, argsp) \ 425 (*(xprt)->xp_ops->xp_freeargs)((xprt), (xargs), (argsp)) 426 #define svc_freeargs(xprt, xargs, argsp) \ 427 (*(xprt)->xp_ops->xp_freeargs)((xprt), (xargs), (argsp)) 428 429 #define SVC_DESTROY(xprt) \ 430 (*(xprt)->xp_ops->xp_destroy)(xprt) 431 #define svc_destroy(xprt) \ 432 (*(xprt)->xp_ops->xp_destroy)(xprt) 433 434 #define SVC_CONTROL(xprt, rq, in) \ 435 (*(xprt)->xp_ops2->xp_control)((xprt), (rq), (in)) 436 437 #endif 438 439 #define SVC_EXT(xprt) \ 440 ((SVCXPRT_EXT *) xprt->xp_p3) 441 442 #define SVC_AUTH(xprt) \ 443 (SVC_EXT(xprt)->xp_auth) 444 445 /* 446 * Operations defined on an SVCAUTH handle 447 */ 448 #ifdef _KERNEL 449 #define SVCAUTH_WRAP(auth, mp) \ 450 ((auth)->svc_ah_ops->svc_ah_wrap(auth, mp)) 451 #define SVCAUTH_UNWRAP(auth, mp) \ 452 ((auth)->svc_ah_ops->svc_ah_unwrap(auth, mp)) 453 #define SVCAUTH_RELEASE(auth) \ 454 ((auth)->svc_ah_ops->svc_ah_release(auth)) 455 #else 456 #define SVCAUTH_WRAP(auth, xdrs, xfunc, xwhere) \ 457 ((auth)->svc_ah_ops->svc_ah_wrap(auth, xdrs, xfunc, xwhere)) 458 #define SVCAUTH_UNWRAP(auth, xdrs, xfunc, xwhere) \ 459 ((auth)->svc_ah_ops->svc_ah_unwrap(auth, xdrs, xfunc, xwhere)) 460 #endif 461 462 /* 463 * Service registration 464 * 465 * svc_reg(xprt, prog, vers, dispatch, nconf) 466 * const SVCXPRT *xprt; 467 * const rpcprog_t prog; 468 * const rpcvers_t vers; 469 * const void (*dispatch)(); 470 * const struct netconfig *nconf; 471 */ 472 473 __BEGIN_DECLS 474 extern bool_t svc_reg(SVCXPRT *, const rpcprog_t, const rpcvers_t, 475 void (*)(struct svc_req *, SVCXPRT *), 476 const struct netconfig *); 477 __END_DECLS 478 479 /* 480 * Service un-registration 481 * 482 * svc_unreg(prog, vers) 483 * const rpcprog_t prog; 484 * const rpcvers_t vers; 485 */ 486 487 __BEGIN_DECLS 488 #ifdef _KERNEL 489 extern void svc_unreg(SVCPOOL *, const rpcprog_t, const rpcvers_t); 490 #else 491 extern void svc_unreg(const rpcprog_t, const rpcvers_t); 492 #endif 493 __END_DECLS 494 495 /* 496 * Transport registration. 497 * 498 * xprt_register(xprt) 499 * SVCXPRT *xprt; 500 */ 501 __BEGIN_DECLS 502 extern void xprt_register(SVCXPRT *); 503 __END_DECLS 504 505 /* 506 * Transport un-register 507 * 508 * xprt_unregister(xprt) 509 * SVCXPRT *xprt; 510 */ 511 __BEGIN_DECLS 512 extern void xprt_unregister(SVCXPRT *); 513 extern void __xprt_unregister_unlocked(SVCXPRT *); 514 __END_DECLS 515 516 #ifdef _KERNEL 517 518 /* 519 * Called when a transport has pending requests. 520 */ 521 __BEGIN_DECLS 522 extern void xprt_active(SVCXPRT *); 523 extern void xprt_inactive(SVCXPRT *); 524 extern void xprt_inactive_locked(SVCXPRT *); 525 __END_DECLS 526 527 #endif 528 529 /* 530 * When the service routine is called, it must first check to see if it 531 * knows about the procedure; if not, it should call svcerr_noproc 532 * and return. If so, it should deserialize its arguments via 533 * SVC_GETARGS (defined above). If the deserialization does not work, 534 * svcerr_decode should be called followed by a return. Successful 535 * decoding of the arguments should be followed the execution of the 536 * procedure's code and a call to svc_sendreply. 537 * 538 * Also, if the service refuses to execute the procedure due to too- 539 * weak authentication parameters, svcerr_weakauth should be called. 540 * Note: do not confuse access-control failure with weak authentication! 541 * 542 * NB: In pure implementations of rpc, the caller always waits for a reply 543 * msg. This message is sent when svc_sendreply is called. 544 * Therefore pure service implementations should always call 545 * svc_sendreply even if the function logically returns void; use 546 * xdr.h - xdr_void for the xdr routine. HOWEVER, tcp based rpc allows 547 * for the abuse of pure rpc via batched calling or pipelining. In the 548 * case of a batched call, svc_sendreply should NOT be called since 549 * this would send a return message, which is what batching tries to avoid. 550 * It is the service/protocol writer's responsibility to know which calls are 551 * batched and which are not. Warning: responding to batch calls may 552 * deadlock the caller and server processes! 553 */ 554 555 __BEGIN_DECLS 556 #ifdef _KERNEL 557 extern bool_t svc_sendreply(struct svc_req *, xdrproc_t, void *); 558 extern bool_t svc_sendreply_mbuf(struct svc_req *, struct mbuf *); 559 extern void svcerr_decode(struct svc_req *); 560 extern void svcerr_weakauth(struct svc_req *); 561 extern void svcerr_noproc(struct svc_req *); 562 extern void svcerr_progvers(struct svc_req *, rpcvers_t, rpcvers_t); 563 extern void svcerr_auth(struct svc_req *, enum auth_stat); 564 extern void svcerr_noprog(struct svc_req *); 565 extern void svcerr_systemerr(struct svc_req *); 566 #else 567 extern bool_t svc_sendreply(SVCXPRT *, xdrproc_t, void *); 568 extern void svcerr_decode(SVCXPRT *); 569 extern void svcerr_weakauth(SVCXPRT *); 570 extern void svcerr_noproc(SVCXPRT *); 571 extern void svcerr_progvers(SVCXPRT *, rpcvers_t, rpcvers_t); 572 extern void svcerr_auth(SVCXPRT *, enum auth_stat); 573 extern void svcerr_noprog(SVCXPRT *); 574 extern void svcerr_systemerr(SVCXPRT *); 575 #endif 576 extern int rpc_reg(rpcprog_t, rpcvers_t, rpcproc_t, 577 char *(*)(char *), xdrproc_t, xdrproc_t, 578 char *); 579 __END_DECLS 580 581 /* 582 * Lowest level dispatching -OR- who owns this process anyway. 583 * Somebody has to wait for incoming requests and then call the correct 584 * service routine. The routine svc_run does infinite waiting; i.e., 585 * svc_run never returns. 586 * Since another (co-existant) package may wish to selectively wait for 587 * incoming calls or other events outside of the rpc architecture, the 588 * routine svc_getreq is provided. It must be passed readfds, the 589 * "in-place" results of a select system call (see select, section 2). 590 */ 591 592 #ifndef _KERNEL 593 /* 594 * Global keeper of rpc service descriptors in use 595 * dynamic; must be inspected before each call to select 596 */ 597 extern int svc_maxfd; 598 #ifdef FD_SETSIZE 599 extern fd_set svc_fdset; 600 #define svc_fds svc_fdset.fds_bits[0] /* compatibility */ 601 #else 602 extern int svc_fds; 603 #endif /* def FD_SETSIZE */ 604 #endif 605 606 /* 607 * a small program implemented by the svc_rpc implementation itself; 608 * also see clnt.h for protocol numbers. 609 */ 610 __BEGIN_DECLS 611 extern void rpctest_service(void); 612 __END_DECLS 613 614 __BEGIN_DECLS 615 extern SVCXPRT *svc_xprt_alloc(void); 616 extern void svc_xprt_free(SVCXPRT *); 617 #ifndef _KERNEL 618 extern void svc_getreq(int); 619 extern void svc_getreqset(fd_set *); 620 extern void svc_getreq_common(int); 621 struct pollfd; 622 extern void svc_getreq_poll(struct pollfd *, int); 623 extern void svc_run(void); 624 extern void svc_exit(void); 625 #else 626 extern void svc_run(SVCPOOL *); 627 extern void svc_exit(SVCPOOL *); 628 extern bool_t svc_getargs(struct svc_req *, xdrproc_t, void *); 629 extern bool_t svc_freeargs(struct svc_req *, xdrproc_t, void *); 630 extern void svc_freereq(struct svc_req *); 631 632 #endif 633 __END_DECLS 634 635 /* 636 * Socket to use on svcxxx_create call to get default socket 637 */ 638 #define RPC_ANYSOCK -1 639 #define RPC_ANYFD RPC_ANYSOCK 640 641 /* 642 * These are the existing service side transport implementations 643 */ 644 645 __BEGIN_DECLS 646 647 #ifdef _KERNEL 648 649 /* 650 * Create a new service pool. 651 */ 652 extern SVCPOOL* svcpool_create(const char *name, 653 struct sysctl_oid_list *sysctl_base); 654 655 /* 656 * Destroy a service pool, including all registered transports. 657 */ 658 extern void svcpool_destroy(SVCPOOL *pool); 659 660 /* 661 * Transport independent svc_create routine. 662 */ 663 extern int svc_create(SVCPOOL *, void (*)(struct svc_req *, SVCXPRT *), 664 const rpcprog_t, const rpcvers_t, const char *); 665 /* 666 * void (*dispatch)(); -- dispatch routine 667 * const rpcprog_t prognum; -- program number 668 * const rpcvers_t versnum; -- version number 669 * const char *nettype; -- network type 670 */ 671 672 673 /* 674 * Generic server creation routine. It takes a netconfig structure 675 * instead of a nettype. 676 */ 677 678 extern SVCXPRT *svc_tp_create(SVCPOOL *, void (*)(struct svc_req *, SVCXPRT *), 679 const rpcprog_t, const rpcvers_t, const char *uaddr, 680 const struct netconfig *); 681 /* 682 * void (*dispatch)(); -- dispatch routine 683 * const rpcprog_t prognum; -- program number 684 * const rpcvers_t versnum; -- version number 685 * const char *uaddr; -- universal address of service 686 * const struct netconfig *nconf; -- netconfig structure 687 */ 688 689 extern SVCXPRT *svc_dg_create(SVCPOOL *, struct socket *, 690 const size_t, const size_t); 691 /* 692 * struct socket *; -- open connection 693 * const size_t sendsize; -- max send size 694 * const size_t recvsize; -- max recv size 695 */ 696 697 extern SVCXPRT *svc_vc_create(SVCPOOL *, struct socket *, 698 const size_t, const size_t); 699 /* 700 * struct socket *; -- open connection 701 * const size_t sendsize; -- max send size 702 * const size_t recvsize; -- max recv size 703 */ 704 705 /* 706 * Generic TLI create routine 707 */ 708 extern SVCXPRT *svc_tli_create(SVCPOOL *, struct socket *, 709 const struct netconfig *, const struct t_bind *, const size_t, const size_t); 710 /* 711 * struct socket * so; -- connection end point 712 * const struct netconfig *nconf; -- netconfig structure for network 713 * const struct t_bind *bindaddr; -- local bind address 714 * const size_t sendsz; -- max sendsize 715 * const size_t recvsz; -- max recvsize 716 */ 717 718 #else /* !_KERNEL */ 719 720 /* 721 * Transport independent svc_create routine. 722 */ 723 extern int svc_create(void (*)(struct svc_req *, SVCXPRT *), 724 const rpcprog_t, const rpcvers_t, const char *); 725 /* 726 * void (*dispatch)(); -- dispatch routine 727 * const rpcprog_t prognum; -- program number 728 * const rpcvers_t versnum; -- version number 729 * const char *nettype; -- network type 730 */ 731 732 733 /* 734 * Generic server creation routine. It takes a netconfig structure 735 * instead of a nettype. 736 */ 737 738 extern SVCXPRT *svc_tp_create(void (*)(struct svc_req *, SVCXPRT *), 739 const rpcprog_t, const rpcvers_t, 740 const struct netconfig *); 741 /* 742 * void (*dispatch)(); -- dispatch routine 743 * const rpcprog_t prognum; -- program number 744 * const rpcvers_t versnum; -- version number 745 * const struct netconfig *nconf; -- netconfig structure 746 */ 747 748 /* 749 * Generic TLI create routine 750 */ 751 extern SVCXPRT *svc_tli_create(const int, const struct netconfig *, 752 const struct t_bind *, const u_int, 753 const u_int); 754 /* 755 * const int fd; -- connection end point 756 * const struct netconfig *nconf; -- netconfig structure for network 757 * const struct t_bind *bindaddr; -- local bind address 758 * const u_int sendsz; -- max sendsize 759 * const u_int recvsz; -- max recvsize 760 */ 761 762 /* 763 * Connectionless and connectionful create routines 764 */ 765 766 extern SVCXPRT *svc_vc_create(const int, const u_int, const u_int); 767 /* 768 * const int fd; -- open connection end point 769 * const u_int sendsize; -- max send size 770 * const u_int recvsize; -- max recv size 771 */ 772 773 /* 774 * Added for compatibility to old rpc 4.0. Obsoleted by svc_vc_create(). 775 */ 776 extern SVCXPRT *svcunix_create(int, u_int, u_int, char *); 777 778 extern SVCXPRT *svc_dg_create(const int, const u_int, const u_int); 779 /* 780 * const int fd; -- open connection 781 * const u_int sendsize; -- max send size 782 * const u_int recvsize; -- max recv size 783 */ 784 785 786 /* 787 * the routine takes any *open* connection 788 * descriptor as its first input and is used for open connections. 789 */ 790 extern SVCXPRT *svc_fd_create(const int, const u_int, const u_int); 791 /* 792 * const int fd; -- open connection end point 793 * const u_int sendsize; -- max send size 794 * const u_int recvsize; -- max recv size 795 */ 796 797 /* 798 * Added for compatibility to old rpc 4.0. Obsoleted by svc_fd_create(). 799 */ 800 extern SVCXPRT *svcunixfd_create(int, u_int, u_int); 801 802 /* 803 * Memory based rpc (for speed check and testing) 804 */ 805 extern SVCXPRT *svc_raw_create(void); 806 807 /* 808 * svc_dg_enable_cache() enables the cache on dg transports. 809 */ 810 int svc_dg_enablecache(SVCXPRT *, const u_int); 811 812 int __rpc_get_local_uid(SVCXPRT *_transp, uid_t *_uid); 813 814 #endif /* !_KERNEL */ 815 816 __END_DECLS 817 818 #ifndef _KERNEL 819 /* for backward compatibility */ 820 #include <rpc/svc_soc.h> 821 #endif 822 823 #endif /* !_RPC_SVC_H */ 824