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