sys/rpc/svc.h

   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$
  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
  90 enum xprt_stat {
  91         XPRT_DIED,
  92         XPRT_MOREREQS,
  93         XPRT_IDLE
  94 };
  95
  96 struct __rpc_svcxprt;
  97 struct mbuf;
  98
  99 struct 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         /* send reply */
 107         bool_t  (*xp_reply)(struct __rpc_svcxprt *, struct rpc_msg *,
 108             struct sockaddr *, struct mbuf *);
 109         /* destroy this struct */
 110         void    (*xp_destroy)(struct __rpc_svcxprt *);
 111         /* catch-all function */
 112         bool_t  (*xp_control)(struct __rpc_svcxprt *, const u_int, void *);
 113 #else
 114         /* receive incoming requests */
 115         bool_t  (*xp_recv)(struct __rpc_svcxprt *, struct rpc_msg *);
 116         /* get transport status */
 117         enum xprt_stat (*xp_stat)(struct __rpc_svcxprt *);
 118         /* get arguments */
 119         bool_t  (*xp_getargs)(struct __rpc_svcxprt *, xdrproc_t, void *);
 120         /* send reply */
 121         bool_t  (*xp_reply)(struct __rpc_svcxprt *, struct rpc_msg *);
 122         /* free mem allocated for args */
 123         bool_t  (*xp_freeargs)(struct __rpc_svcxprt *, xdrproc_t, void *);
 124         /* destroy this struct */
 125         void    (*xp_destroy)(struct __rpc_svcxprt *);
 126 #endif
 127 };
 128
 129 #ifndef _KERNEL
 130 struct xp_ops2 {
 131         /* catch-all function */
 132         bool_t  (*xp_control)(struct __rpc_svcxprt *, const u_int, void *);
 133 };
 134 #endif
 135
 136 #ifdef _KERNEL
 137 struct __rpc_svcpool;
 138 struct __rpc_svcthread;
 139 #endif
 140
 141 /*
 142  * Server side transport handle. In the kernel, transports have a
 143  * reference count which tracks the number of currently assigned
 144  * worker threads plus one for the service pool's reference.
 145  */
 146 typedef struct __rpc_svcxprt {
 147 #ifdef _KERNEL
 148         volatile u_int  xp_refs;
 149         struct sx       xp_lock;
 150         struct __rpc_svcpool *xp_pool;  /* owning pool (see below) */
 151         TAILQ_ENTRY(__rpc_svcxprt) xp_link;
 152         TAILQ_ENTRY(__rpc_svcxprt) xp_alink;
 153         bool_t          xp_registered;  /* xprt_register has been called */
 154         bool_t          xp_active;      /* xprt_active has been called */
 155         struct __rpc_svcthread *xp_thread; /* assigned service thread */
 156         struct socket*  xp_socket;
 157         const struct xp_ops *xp_ops;
 158         char            *xp_netid;      /* network token */
 159         struct sockaddr_storage xp_ltaddr; /* local transport address */
 160         struct sockaddr_storage xp_rtaddr; /* remote transport address */
 161         void            *xp_p1;         /* private: for use by svc ops */
 162         void            *xp_p2;         /* private: for use by svc ops */
 163         void            *xp_p3;         /* private: for use by svc lib */
 164         int             xp_type;        /* transport type */
 165         int             xp_idletimeout; /* idle time before closing */
 166         time_t          xp_lastactive;  /* time of last RPC */
 167         u_int64_t       xp_sockref;     /* set by nfsv4 to identify socket */
 168         int             xp_upcallset;   /* socket upcall is set up */
 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         int                     st_idle; /* thread is on idle list */
 282         struct cv               st_cond; /* sleeping for work */
 283         LIST_ENTRY(__rpc_svcthread) st_link; /* all threads list */
 284         LIST_ENTRY(__rpc_svcthread) st_ilink; /* idle threads list */
 285         LIST_ENTRY(__rpc_svcthread) st_alink; /* application thread list */
 286 } SVCTHREAD;
 287 LIST_HEAD(svcthread_list, __rpc_svcthread);
 288
 289 /*
 290  * In the kernel, we can't use global variables to store lists of
 291  * transports etc. since otherwise we could not have two unrelated RPC
 292  * services running, each on its own thread. We solve this by
 293  * importing a tiny part of a Solaris kernel concept, SVCPOOL.
 294  *
 295  * A service pool contains a set of transports and service callbacks
 296  * for a set of related RPC services. The pool handle should be passed
 297  * when creating new transports etc. Future work may include extending
 298  * this to support something similar to the Solaris multi-threaded RPC
 299  * server.
 300  */
 301 TAILQ_HEAD(svcxprt_list, __rpc_svcxprt);
 302 enum svcpool_state {
 303         SVCPOOL_INIT,           /* svc_run not called yet */
 304         SVCPOOL_ACTIVE,         /* normal running state */
 305         SVCPOOL_THREADWANTED,   /* new service thread requested */
 306         SVCPOOL_THREADSTARTING, /* new service thread started */
 307         SVCPOOL_CLOSING         /* svc_exit called */
 308 };
 309 typedef SVCTHREAD *pool_assign_fn(SVCTHREAD *, struct svc_req *);
 310 typedef void pool_done_fn(SVCTHREAD *, struct svc_req *);
 311 typedef struct __rpc_svcpool {
 312         struct mtx      sp_lock;        /* protect the transport lists */
 313         const char      *sp_name;       /* pool name (e.g. "nfsd", "NLM" */
 314         enum svcpool_state sp_state;    /* current pool state */
 315         struct proc     *sp_proc;       /* process which is in svc_run */
 316         struct svcxprt_list sp_xlist;   /* all transports in the pool */
 317         struct svcxprt_list sp_active;  /* transports needing service */
 318         struct svc_callout_list sp_callouts; /* (prog,vers)->dispatch list */
 319         struct svcthread_list sp_threads; /* service threads */
 320         struct svcthread_list sp_idlethreads; /* idle service threads */
 321         int             sp_minthreads;  /* minimum service thread count */
 322         int             sp_maxthreads;  /* maximum service thread count */
 323         int             sp_threadcount; /* current service thread count */
 324         time_t          sp_lastcreatetime; /* when we last started a thread */
 325         time_t          sp_lastidlecheck;  /* when we last checked idle transports */
 326
 327         /*
 328          * Hooks to allow an application to control request to thread
 329          * placement.
 330          */
 331         pool_assign_fn  *sp_assign;
 332         pool_done_fn    *sp_done;
 333
 334         /*
 335          * These variables are used to put an upper bound on the
 336          * amount of memory used by RPC requests which are queued
 337          * waiting for execution.
 338          */
 339         unsigned int    sp_space_low;
 340         unsigned int    sp_space_high;
 341         unsigned int    sp_space_used;
 342         unsigned int    sp_space_used_highest;
 343         bool_t          sp_space_throttled;
 344         int             sp_space_throttle_count;
 345
 346         struct replay_cache *sp_rcache; /* optional replay cache */
 347         struct sysctl_ctx_list sp_sysctl;
 348 } SVCPOOL;
 349
 350 #else
 351
 352 /*
 353  * Service request
 354  */
 355 struct svc_req {
 356         uint32_t        rq_prog;        /* service program number */
 357         uint32_t        rq_vers;        /* service protocol version */
 358         uint32_t        rq_proc;        /* the desired procedure */
 359         struct opaque_auth rq_cred;     /* raw creds from the wire */
 360         void            *rq_clntcred;   /* read only cooked cred */
 361         SVCXPRT         *rq_xprt;       /* associated transport */
 362 };
 363
 364 /*
 365  *  Approved way of getting address of caller
 366  */
 367 #define svc_getrpccaller(x) (&(x)->xp_rtaddr)
 368
 369 #endif
 370
 371 /*
 372  * Operations defined on an SVCXPRT handle
 373  *
 374  * SVCXPRT              *xprt;
 375  * struct rpc_msg       *msg;
 376  * xdrproc_t             xargs;
 377  * void *                argsp;
 378  */
 379 #ifdef _KERNEL
 380
 381 #define SVC_ACQUIRE(xprt)                       \
 382         refcount_acquire(&(xprt)->xp_refs)
 383
 384 #define SVC_RELEASE(xprt)                       \
 385         if (refcount_release(&(xprt)->xp_refs)) \
 386                 SVC_DESTROY(xprt)
 387
 388 #define SVC_RECV(xprt, msg, addr, args)                 \
 389         (*(xprt)->xp_ops->xp_recv)((xprt), (msg), (addr), (args))
 390
 391 #define SVC_STAT(xprt)                                  \
 392         (*(xprt)->xp_ops->xp_stat)(xprt)
 393
 394 #define SVC_REPLY(xprt, msg, addr, m)                   \
 395         (*(xprt)->xp_ops->xp_reply) ((xprt), (msg), (addr), (m))
 396
 397 #define SVC_DESTROY(xprt)                               \
 398         (*(xprt)->xp_ops->xp_destroy)(xprt)
 399
 400 #define SVC_CONTROL(xprt, rq, in)                       \
 401         (*(xprt)->xp_ops->xp_control)((xprt), (rq), (in))
 402
 403 #else
 404
 405 #define SVC_RECV(xprt, msg)                             \
 406         (*(xprt)->xp_ops->xp_recv)((xprt), (msg))
 407 #define svc_recv(xprt, msg)                             \
 408         (*(xprt)->xp_ops->xp_recv)((xprt), (msg))
 409
 410 #define SVC_STAT(xprt)                                  \
 411         (*(xprt)->xp_ops->xp_stat)(xprt)
 412 #define svc_stat(xprt)                                  \
 413         (*(xprt)->xp_ops->xp_stat)(xprt)
 414
 415 #define SVC_GETARGS(xprt, xargs, argsp)                 \
 416         (*(xprt)->xp_ops->xp_getargs)((xprt), (xargs), (argsp))
 417 #define svc_getargs(xprt, xargs, argsp)                 \
 418         (*(xprt)->xp_ops->xp_getargs)((xprt), (xargs), (argsp))
 419
 420 #define SVC_REPLY(xprt, msg)                            \
 421         (*(xprt)->xp_ops->xp_reply) ((xprt), (msg))
 422 #define svc_reply(xprt, msg)                            \
 423         (*(xprt)->xp_ops->xp_reply) ((xprt), (msg))
 424
 425 #define SVC_FREEARGS(xprt, xargs, argsp)                \
 426         (*(xprt)->xp_ops->xp_freeargs)((xprt), (xargs), (argsp))
 427 #define svc_freeargs(xprt, xargs, argsp)                \
 428         (*(xprt)->xp_ops->xp_freeargs)((xprt), (xargs), (argsp))
 429
 430 #define SVC_DESTROY(xprt)                               \
 431         (*(xprt)->xp_ops->xp_destroy)(xprt)
 432 #define svc_destroy(xprt)                               \
 433         (*(xprt)->xp_ops->xp_destroy)(xprt)
 434
 435 #define SVC_CONTROL(xprt, rq, in)                       \
 436         (*(xprt)->xp_ops2->xp_control)((xprt), (rq), (in))
 437
 438 #endif
 439
 440 #define SVC_EXT(xprt)                                   \
 441         ((SVCXPRT_EXT *) xprt->xp_p3)
 442
 443 #define SVC_AUTH(xprt)                                  \
 444         (SVC_EXT(xprt)->xp_auth)
 445
 446 /*
 447  * Operations defined on an SVCAUTH handle
 448  */
 449 #ifdef _KERNEL
 450 #define SVCAUTH_WRAP(auth, mp)          \
 451         ((auth)->svc_ah_ops->svc_ah_wrap(auth, mp))
 452 #define SVCAUTH_UNWRAP(auth, mp)        \
 453         ((auth)->svc_ah_ops->svc_ah_unwrap(auth, mp))
 454 #define SVCAUTH_RELEASE(auth)   \
 455         ((auth)->svc_ah_ops->svc_ah_release(auth))
 456 #else
 457 #define SVCAUTH_WRAP(auth, xdrs, xfunc, xwhere)         \
 458         ((auth)->svc_ah_ops->svc_ah_wrap(auth, xdrs, xfunc, xwhere))
 459 #define SVCAUTH_UNWRAP(auth, xdrs, xfunc, xwhere)       \
 460         ((auth)->svc_ah_ops->svc_ah_unwrap(auth, xdrs, xfunc, xwhere))
 461 #endif
 462
 463 /*
 464  * Service registration
 465  *
 466  * svc_reg(xprt, prog, vers, dispatch, nconf)
 467  *      const SVCXPRT *xprt;
 468  *      const rpcprog_t prog;
 469  *      const rpcvers_t vers;
 470  *      const void (*dispatch)();
 471  *      const struct netconfig *nconf;
 472  */
 473
 474 __BEGIN_DECLS
 475 extern bool_t   svc_reg(SVCXPRT *, const rpcprog_t, const rpcvers_t,
 476                         void (*)(struct svc_req *, SVCXPRT *),
 477                         const struct netconfig *);
 478 __END_DECLS
 479
 480 /*
 481  * Service un-registration
 482  *
 483  * svc_unreg(prog, vers)
 484  *      const rpcprog_t prog;
 485  *      const rpcvers_t vers;
 486  */
 487
 488 __BEGIN_DECLS
 489 #ifdef _KERNEL
 490 extern void     svc_unreg(SVCPOOL *, const rpcprog_t, const rpcvers_t);
 491 #else
 492 extern void     svc_unreg(const rpcprog_t, const rpcvers_t);
 493 #endif
 494 __END_DECLS
 495
 496 /*
 497  * Transport registration.
 498  *
 499  * xprt_register(xprt)
 500  *      SVCXPRT *xprt;
 501  */
 502 __BEGIN_DECLS
 503 extern void     xprt_register(SVCXPRT *);
 504 __END_DECLS
 505
 506 /*
 507  * Transport un-register
 508  *
 509  * xprt_unregister(xprt)
 510  *      SVCXPRT *xprt;
 511  */
 512 __BEGIN_DECLS
 513 extern void     xprt_unregister(SVCXPRT *);
 514 extern void     __xprt_unregister_unlocked(SVCXPRT *);
 515 __END_DECLS
 516
 517 #ifdef _KERNEL
 518
 519 /*
 520  * Called when a transport has pending requests.
 521  */
 522 __BEGIN_DECLS
 523 extern void     xprt_active(SVCXPRT *);
 524 extern void     xprt_inactive(SVCXPRT *);
 525 extern void     xprt_inactive_locked(SVCXPRT *);
 526 extern void     xprt_inactive_self(SVCXPRT *);
 527 __END_DECLS
 528
 529 #endif
 530
 531 /*
 532  * When the service routine is called, it must first check to see if it
 533  * knows about the procedure;  if not, it should call svcerr_noproc
 534  * and return.  If so, it should deserialize its arguments via
 535  * SVC_GETARGS (defined above).  If the deserialization does not work,
 536  * svcerr_decode should be called followed by a return.  Successful
 537  * decoding of the arguments should be followed the execution of the
 538  * procedure's code and a call to svc_sendreply.
 539  *
 540  * Also, if the service refuses to execute the procedure due to too-
 541  * weak authentication parameters, svcerr_weakauth should be called.
 542  * Note: do not confuse access-control failure with weak authentication!
 543  *
 544  * NB: In pure implementations of rpc, the caller always waits for a reply
 545  * msg.  This message is sent when svc_sendreply is called.
 546  * Therefore pure service implementations should always call
 547  * svc_sendreply even if the function logically returns void;  use
 548  * xdr.h - xdr_void for the xdr routine.  HOWEVER, tcp based rpc allows
 549  * for the abuse of pure rpc via batched calling or pipelining.  In the
 550  * case of a batched call, svc_sendreply should NOT be called since
 551  * this would send a return message, which is what batching tries to avoid.
 552  * It is the service/protocol writer's responsibility to know which calls are
 553  * batched and which are not.  Warning: responding to batch calls may
 554  * deadlock the caller and server processes!
 555  */
 556
 557 __BEGIN_DECLS
 558 #ifdef _KERNEL
 559 extern bool_t   svc_sendreply(struct svc_req *, xdrproc_t, void *);
 560 extern bool_t   svc_sendreply_mbuf(struct svc_req *, struct mbuf *);
 561 extern void     svcerr_decode(struct svc_req *);
 562 extern void     svcerr_weakauth(struct svc_req *);
 563 extern void     svcerr_noproc(struct svc_req *);
 564 extern void     svcerr_progvers(struct svc_req *, rpcvers_t, rpcvers_t);
 565 extern void     svcerr_auth(struct svc_req *, enum auth_stat);
 566 extern void     svcerr_noprog(struct svc_req *);
 567 extern void     svcerr_systemerr(struct svc_req *);
 568 #else
 569 extern bool_t   svc_sendreply(SVCXPRT *, xdrproc_t, void *);
 570 extern void     svcerr_decode(SVCXPRT *);
 571 extern void     svcerr_weakauth(SVCXPRT *);
 572 extern void     svcerr_noproc(SVCXPRT *);
 573 extern void     svcerr_progvers(SVCXPRT *, rpcvers_t, rpcvers_t);
 574 extern void     svcerr_auth(SVCXPRT *, enum auth_stat);
 575 extern void     svcerr_noprog(SVCXPRT *);
 576 extern void     svcerr_systemerr(SVCXPRT *);
 577 #endif
 578 extern int      rpc_reg(rpcprog_t, rpcvers_t, rpcproc_t,
 579                         char *(*)(char *), xdrproc_t, xdrproc_t,
 580                         char *);
 581 __END_DECLS
 582
 583 /*
 584  * Lowest level dispatching -OR- who owns this process anyway.
 585  * Somebody has to wait for incoming requests and then call the correct
 586  * service routine.  The routine svc_run does infinite waiting; i.e.,
 587  * svc_run never returns.
 588  * Since another (co-existant) package may wish to selectively wait for
 589  * incoming calls or other events outside of the rpc architecture, the
 590  * routine svc_getreq is provided.  It must be passed readfds, the
 591  * "in-place" results of a select system call (see select, section 2).
 592  */
 593
 594 #ifndef _KERNEL
 595 /*
 596  * Global keeper of rpc service descriptors in use
 597  * dynamic; must be inspected before each call to select
 598  */
 599 extern int svc_maxfd;
 600 #ifdef FD_SETSIZE
 601 extern fd_set svc_fdset;
 602 #define svc_fds svc_fdset.fds_bits[0]   /* compatibility */
 603 #else
 604 extern int svc_fds;
 605 #endif /* def FD_SETSIZE */
 606 #endif
 607
 608 /*
 609  * a small program implemented by the svc_rpc implementation itself;
 610  * also see clnt.h for protocol numbers.
 611  */
 612 __BEGIN_DECLS
 613 extern void rpctest_service(void);
 614 __END_DECLS
 615
 616 __BEGIN_DECLS
 617 extern SVCXPRT *svc_xprt_alloc(void);
 618 extern void     svc_xprt_free(SVCXPRT *);
 619 #ifndef _KERNEL
 620 extern void     svc_getreq(int);
 621 extern void     svc_getreqset(fd_set *);
 622 extern void     svc_getreq_common(int);
 623 struct pollfd;
 624 extern void     svc_getreq_poll(struct pollfd *, int);
 625 extern void     svc_run(void);
 626 extern void     svc_exit(void);
 627 #else
 628 extern void     svc_run(SVCPOOL *);
 629 extern void     svc_exit(SVCPOOL *);
 630 extern bool_t   svc_getargs(struct svc_req *, xdrproc_t, void *);
 631 extern bool_t   svc_freeargs(struct svc_req *, xdrproc_t, void *);
 632 extern void     svc_freereq(struct svc_req *);
 633
 634 #endif
 635 __END_DECLS
 636
 637 /*
 638  * Socket to use on svcxxx_create call to get default socket
 639  */
 640 #define RPC_ANYSOCK     -1
 641 #define RPC_ANYFD       RPC_ANYSOCK
 642
 643 /*
 644  * These are the existing service side transport implementations
 645  */
 646
 647 __BEGIN_DECLS
 648
 649 #ifdef _KERNEL
 650
 651 /*
 652  * Create a new service pool.
 653  */
 654 extern SVCPOOL* svcpool_create(const char *name,
 655     struct sysctl_oid_list *sysctl_base);
 656
 657 /*
 658  * Destroy a service pool, including all registered transports.
 659  */
 660 extern void svcpool_destroy(SVCPOOL *pool);
 661
 662 /*
 663  * Transport independent svc_create routine.
 664  */
 665 extern int svc_create(SVCPOOL *, void (*)(struct svc_req *, SVCXPRT *),
 666     const rpcprog_t, const rpcvers_t, const char *);
 667 /*
 668  *      void (*dispatch)();             -- dispatch routine
 669  *      const rpcprog_t prognum;        -- program number
 670  *      const rpcvers_t versnum;        -- version number
 671  *      const char *nettype;            -- network type
 672  */
 673
 674
 675 /*
 676  * Generic server creation routine. It takes a netconfig structure
 677  * instead of a nettype.
 678  */
 679
 680 extern SVCXPRT *svc_tp_create(SVCPOOL *, void (*)(struct svc_req *, SVCXPRT *),
 681     const rpcprog_t, const rpcvers_t, const char *uaddr,
 682     const struct netconfig *);
 683         /*
 684          * void (*dispatch)();            -- dispatch routine
 685          * const rpcprog_t prognum;       -- program number
 686          * const rpcvers_t versnum;       -- version number
 687          * const char *uaddr;             -- universal address of service
 688          * const struct netconfig *nconf; -- netconfig structure
 689          */
 690
 691 extern SVCXPRT *svc_dg_create(SVCPOOL *, struct socket *,
 692     const size_t, const size_t);
 693         /*
 694          * struct socket *;                             -- open connection
 695          * const size_t sendsize;                        -- max send size
 696          * const size_t recvsize;                        -- max recv size
 697          */
 698
 699 extern SVCXPRT *svc_vc_create(SVCPOOL *, struct socket *,
 700     const size_t, const size_t);
 701         /*
 702          * struct socket *;                             -- open connection
 703          * const size_t sendsize;                        -- max send size
 704          * const size_t recvsize;                        -- max recv size
 705          */
 706
 707 extern SVCXPRT *svc_vc_create_backchannel(SVCPOOL *);
 708
 709 /*
 710  * Generic TLI create routine
 711  */
 712 extern SVCXPRT *svc_tli_create(SVCPOOL *, struct socket *,
 713     const struct netconfig *, const struct t_bind *, const size_t, const size_t);
 714 /*
 715  *      struct socket * so;             -- connection end point
 716  *      const struct netconfig *nconf;  -- netconfig structure for network
 717  *      const struct t_bind *bindaddr;  -- local bind address
 718  *      const size_t sendsz;             -- max sendsize
 719  *      const size_t recvsz;             -- max recvsize
 720  */
 721
 722 #else /* !_KERNEL */
 723
 724 /*
 725  * Transport independent svc_create routine.
 726  */
 727 extern int svc_create(void (*)(struct svc_req *, SVCXPRT *),
 728                            const rpcprog_t, const rpcvers_t, const char *);
 729 /*
 730  *      void (*dispatch)();             -- dispatch routine
 731  *      const rpcprog_t prognum;        -- program number
 732  *      const rpcvers_t versnum;        -- version number
 733  *      const char *nettype;            -- network type
 734  */
 735
 736
 737 /*
 738  * Generic server creation routine. It takes a netconfig structure
 739  * instead of a nettype.
 740  */
 741
 742 extern SVCXPRT *svc_tp_create(void (*)(struct svc_req *, SVCXPRT *),
 743                                    const rpcprog_t, const rpcvers_t,
 744                                    const struct netconfig *);
 745         /*
 746          * void (*dispatch)();            -- dispatch routine
 747          * const rpcprog_t prognum;       -- program number
 748          * const rpcvers_t versnum;       -- version number
 749          * const struct netconfig *nconf; -- netconfig structure
 750          */
 751
 752 /*
 753  * Generic TLI create routine
 754  */
 755 extern SVCXPRT *svc_tli_create(const int, const struct netconfig *,
 756                                const struct t_bind *, const u_int,
 757                                const u_int);
 758 /*
 759  *      const int fd;                   -- connection end point
 760  *      const struct netconfig *nconf;  -- netconfig structure for network
 761  *      const struct t_bind *bindaddr;  -- local bind address
 762  *      const u_int sendsz;             -- max sendsize
 763  *      const u_int recvsz;             -- max recvsize
 764  */
 765
 766 /*
 767  * Connectionless and connectionful create routines
 768  */
 769
 770 extern SVCXPRT *svc_vc_create(const int, const u_int, const u_int);
 771 /*
 772  *      const int fd;                           -- open connection end point
 773  *      const u_int sendsize;                   -- max send size
 774  *      const u_int recvsize;                   -- max recv size
 775  */
 776
 777 /*
 778  * Added for compatibility to old rpc 4.0. Obsoleted by svc_vc_create().
 779  */
 780 extern SVCXPRT *svcunix_create(int, u_int, u_int, char *);
 781
 782 extern SVCXPRT *svc_dg_create(const int, const u_int, const u_int);
 783         /*
 784          * const int fd;                                -- open connection
 785          * const u_int sendsize;                        -- max send size
 786          * const u_int recvsize;                        -- max recv size
 787          */
 788
 789
 790 /*
 791  * the routine takes any *open* connection
 792  * descriptor as its first input and is used for open connections.
 793  */
 794 extern SVCXPRT *svc_fd_create(const int, const u_int, const u_int);
 795 /*
 796  *      const int fd;                           -- open connection end point
 797  *      const u_int sendsize;                   -- max send size
 798  *      const u_int recvsize;                   -- max recv size
 799  */
 800
 801 /*
 802  * Added for compatibility to old rpc 4.0. Obsoleted by svc_fd_create().
 803  */
 804 extern SVCXPRT *svcunixfd_create(int, u_int, u_int);
 805
 806 /*
 807  * Memory based rpc (for speed check and testing)
 808  */
 809 extern SVCXPRT *svc_raw_create(void);
 810
 811 /*
 812  * svc_dg_enable_cache() enables the cache on dg transports.
 813  */
 814 int svc_dg_enablecache(SVCXPRT *, const u_int);
 815
 816 int __rpc_get_local_uid(SVCXPRT *_transp, uid_t *_uid);
 817
 818 #endif  /* !_KERNEL */
 819
 820 __END_DECLS
 821
 822 #ifndef _KERNEL
 823 /* for backward compatibility */
 824 #include <rpc/svc_soc.h>
 825 #endif
 826
 827 #endif /* !_RPC_SVC_H */