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         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 extern SVCXPRT *svc_vc_create_backchannel(SVCPOOL *);
 706
 707 /*
 708  * Generic TLI create routine
 709  */
 710 extern SVCXPRT *svc_tli_create(SVCPOOL *, struct socket *,
 711     const struct netconfig *, const struct t_bind *, const size_t, const size_t);
 712 /*
 713  *      struct socket * so;             -- connection end point
 714  *      const struct netconfig *nconf;  -- netconfig structure for network
 715  *      const struct t_bind *bindaddr;  -- local bind address
 716  *      const size_t sendsz;             -- max sendsize
 717  *      const size_t recvsz;             -- max recvsize
 718  */
 719
 720 #else /* !_KERNEL */
 721
 722 /*
 723  * Transport independent svc_create routine.
 724  */
 725 extern int svc_create(void (*)(struct svc_req *, SVCXPRT *),
 726                            const rpcprog_t, const rpcvers_t, const char *);
 727 /*
 728  *      void (*dispatch)();             -- dispatch routine
 729  *      const rpcprog_t prognum;        -- program number
 730  *      const rpcvers_t versnum;        -- version number
 731  *      const char *nettype;            -- network type
 732  */
 733
 734
 735 /*
 736  * Generic server creation routine. It takes a netconfig structure
 737  * instead of a nettype.
 738  */
 739
 740 extern SVCXPRT *svc_tp_create(void (*)(struct svc_req *, SVCXPRT *),
 741                                    const rpcprog_t, const rpcvers_t,
 742                                    const struct netconfig *);
 743         /*
 744          * void (*dispatch)();            -- dispatch routine
 745          * const rpcprog_t prognum;       -- program number
 746          * const rpcvers_t versnum;       -- version number
 747          * const struct netconfig *nconf; -- netconfig structure
 748          */
 749
 750 /*
 751  * Generic TLI create routine
 752  */
 753 extern SVCXPRT *svc_tli_create(const int, const struct netconfig *,
 754                                const struct t_bind *, const u_int,
 755                                const u_int);
 756 /*
 757  *      const int fd;                   -- connection end point
 758  *      const struct netconfig *nconf;  -- netconfig structure for network
 759  *      const struct t_bind *bindaddr;  -- local bind address
 760  *      const u_int sendsz;             -- max sendsize
 761  *      const u_int recvsz;             -- max recvsize
 762  */
 763
 764 /*
 765  * Connectionless and connectionful create routines
 766  */
 767
 768 extern SVCXPRT *svc_vc_create(const int, const u_int, const u_int);
 769 /*
 770  *      const int fd;                           -- open connection end point
 771  *      const u_int sendsize;                   -- max send size
 772  *      const u_int recvsize;                   -- max recv size
 773  */
 774
 775 /*
 776  * Added for compatibility to old rpc 4.0. Obsoleted by svc_vc_create().
 777  */
 778 extern SVCXPRT *svcunix_create(int, u_int, u_int, char *);
 779
 780 extern SVCXPRT *svc_dg_create(const int, const u_int, const u_int);
 781         /*
 782          * const int fd;                                -- open connection
 783          * const u_int sendsize;                        -- max send size
 784          * const u_int recvsize;                        -- max recv size
 785          */
 786
 787
 788 /*
 789  * the routine takes any *open* connection
 790  * descriptor as its first input and is used for open connections.
 791  */
 792 extern SVCXPRT *svc_fd_create(const int, const u_int, const u_int);
 793 /*
 794  *      const int fd;                           -- open connection end point
 795  *      const u_int sendsize;                   -- max send size
 796  *      const u_int recvsize;                   -- max recv size
 797  */
 798
 799 /*
 800  * Added for compatibility to old rpc 4.0. Obsoleted by svc_fd_create().
 801  */
 802 extern SVCXPRT *svcunixfd_create(int, u_int, u_int);
 803
 804 /*
 805  * Memory based rpc (for speed check and testing)
 806  */
 807 extern SVCXPRT *svc_raw_create(void);
 808
 809 /*
 810  * svc_dg_enable_cache() enables the cache on dg transports.
 811  */
 812 int svc_dg_enablecache(SVCXPRT *, const u_int);
 813
 814 int __rpc_get_local_uid(SVCXPRT *_transp, uid_t *_uid);
 815
 816 #endif  /* !_KERNEL */
 817
 818 __END_DECLS
 819
 820 #ifndef _KERNEL
 821 /* for backward compatibility */
 822 #include <rpc/svc_soc.h>
 823 #endif
 824
 825 #endif /* !_RPC_SVC_H */