The Design and Implementation of the FreeBSD Operating System, Second Edition
Now available: The Design and Implementation of the FreeBSD Operating System (Second Edition)


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]

FreeBSD/Linux Kernel Cross Reference
sys/rpc/svc.h

Version: -  FREEBSD  -  FREEBSD-13-STABLE  -  FREEBSD-13-0  -  FREEBSD-12-STABLE  -  FREEBSD-12-0  -  FREEBSD-11-STABLE  -  FREEBSD-11-0  -  FREEBSD-10-STABLE  -  FREEBSD-10-0  -  FREEBSD-9-STABLE  -  FREEBSD-9-0  -  FREEBSD-8-STABLE  -  FREEBSD-8-0  -  FREEBSD-7-STABLE  -  FREEBSD-7-0  -  FREEBSD-6-STABLE  -  FREEBSD-6-0  -  FREEBSD-5-STABLE  -  FREEBSD-5-0  -  FREEBSD-4-STABLE  -  FREEBSD-3-STABLE  -  FREEBSD22  -  l41  -  OPENBSD  -  linux-2.6  -  MK84  -  PLAN9  -  xnu-8792 
SearchContext: -  none  -  3  -  10 

    1 /*      $NetBSD: svc.h,v 1.17 2000/06/02 22:57:56 fvdl Exp $    */
    2 
    3 /*
    4  * Sun RPC is a product of Sun Microsystems, Inc. and is provided for
    5  * unrestricted use provided that this legend is included on all tape
    6  * media and as a part of the software program in whole or part.  Users
    7  * may copy or modify Sun RPC without charge, but are not authorized
    8  * to license or distribute it to anyone else except as part of a product or
    9  * program developed by the user.
   10  *
   11  * SUN RPC IS PROVIDED AS IS WITH NO WARRANTIES OF ANY KIND INCLUDING THE
   12  * WARRANTIES OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
   13  * PURPOSE, OR ARISING FROM A COURSE OF DEALING, USAGE OR TRADE PRACTICE.
   14  *
   15  * Sun RPC is provided with no support and without any obligation on the
   16  * part of Sun Microsystems, Inc. to assist in its use, correction,
   17  * modification or enhancement.
   18  *
   19  * SUN MICROSYSTEMS, INC. SHALL HAVE NO LIABILITY WITH RESPECT TO THE
   20  * INFRINGEMENT OF COPYRIGHTS, TRADE SECRETS OR ANY PATENTS BY SUN RPC
   21  * OR ANY PART THEREOF.
   22  *
   23  * In no event will Sun Microsystems, Inc. be liable for any lost revenue
   24  * or profits or other special, indirect and consequential damages, even if
   25  * Sun has been advised of the possibility of such damages.
   26  *
   27  * Sun Microsystems, Inc.
   28  * 2550 Garcia Avenue
   29  * Mountain View, California  94043
   30  *
   31  *      from: @(#)svc.h 1.35 88/12/17 SMI
   32  *      from: @(#)svc.h      1.27    94/04/25 SMI
   33  * $FreeBSD: releng/8.4/sys/rpc/svc.h 199583 2009-11-20 15:27:52Z jhb $
   34  */
   35 
   36 /*
   37  * svc.h, Server-side remote procedure call interface.
   38  *
   39  * Copyright (C) 1986-1993 by Sun Microsystems, Inc.
   40  */
   41 
   42 #ifndef _RPC_SVC_H
   43 #define _RPC_SVC_H
   44 #include <sys/cdefs.h>
   45 
   46 #ifdef _KERNEL
   47 #include <sys/queue.h>
   48 #include <sys/_lock.h>
   49 #include <sys/_mutex.h>
   50 #include <sys/_sx.h>
   51 #include <sys/condvar.h>
   52 #include <sys/sysctl.h>
   53 #endif
   54 
   55 /*
   56  * This interface must manage two items concerning remote procedure calling:
   57  *
   58  * 1) An arbitrary number of transport connections upon which rpc requests
   59  * are received.  The two most notable transports are TCP and UDP;  they are
   60  * created and registered by routines in svc_tcp.c and svc_udp.c, respectively;
   61  * they in turn call xprt_register and xprt_unregister.
   62  *
   63  * 2) An arbitrary number of locally registered services.  Services are
   64  * described by the following four data: program number, version number,
   65  * "service dispatch" function, a transport handle, and a boolean that
   66  * indicates whether or not the exported program should be registered with a
   67  * local binder service;  if true the program's number and version and the
   68  * port number from the transport handle are registered with the binder.
   69  * These data are registered with the rpc svc system via svc_register.
   70  *
   71  * A service's dispatch function is called whenever an rpc request comes in
   72  * on a transport.  The request's program and version numbers must match
   73  * those of the registered service.  The dispatch function is passed two
   74  * parameters, struct svc_req * and SVCXPRT *, defined below.
   75  */
   76 
   77 /*
   78  *      Service control requests
   79  */
   80 #define SVCGET_VERSQUIET        1
   81 #define SVCSET_VERSQUIET        2
   82 #define SVCGET_CONNMAXREC       3
   83 #define SVCSET_CONNMAXREC       4
   84 
   85 /*
   86  * Operations for rpc_control().
   87  */
   88 #define RPC_SVC_CONNMAXREC_SET  0       /* set max rec size, enable nonblock */
   89 #define RPC_SVC_CONNMAXREC_GET  1
   90 
   91 enum xprt_stat {
   92         XPRT_DIED,
   93         XPRT_MOREREQS,
   94         XPRT_IDLE
   95 };
   96 
   97 struct __rpc_svcxprt;
   98 struct mbuf;
   99 
  100 struct xp_ops {
  101 #ifdef _KERNEL
  102         /* receive incoming requests */
  103         bool_t  (*xp_recv)(struct __rpc_svcxprt *, struct rpc_msg *,
  104             struct sockaddr **, struct mbuf **);
  105         /* get transport status */
  106         enum xprt_stat (*xp_stat)(struct __rpc_svcxprt *);
  107         /* send reply */
  108         bool_t  (*xp_reply)(struct __rpc_svcxprt *, struct rpc_msg *,
  109             struct sockaddr *, struct mbuf *);
  110         /* destroy this struct */
  111         void    (*xp_destroy)(struct __rpc_svcxprt *);
  112         /* catch-all function */
  113         bool_t  (*xp_control)(struct __rpc_svcxprt *, const u_int, void *);
  114 #else
  115         /* receive incoming requests */
  116         bool_t  (*xp_recv)(struct __rpc_svcxprt *, struct rpc_msg *);
  117         /* get transport status */
  118         enum xprt_stat (*xp_stat)(struct __rpc_svcxprt *);
  119         /* get arguments */
  120         bool_t  (*xp_getargs)(struct __rpc_svcxprt *, xdrproc_t, void *);
  121         /* send reply */
  122         bool_t  (*xp_reply)(struct __rpc_svcxprt *, struct rpc_msg *);
  123         /* free mem allocated for args */
  124         bool_t  (*xp_freeargs)(struct __rpc_svcxprt *, xdrproc_t, void *);
  125         /* destroy this struct */
  126         void    (*xp_destroy)(struct __rpc_svcxprt *);
  127 #endif
  128 };
  129 
  130 #ifndef _KERNEL
  131 struct xp_ops2 {
  132         /* catch-all function */
  133         bool_t  (*xp_control)(struct __rpc_svcxprt *, const u_int, void *);
  134 };
  135 #endif
  136 
  137 #ifdef _KERNEL
  138 struct __rpc_svcpool;
  139 struct __rpc_svcthread;
  140 #endif
  141 
  142 /*
  143  * Server side transport handle. In the kernel, transports have a
  144  * reference count which tracks the number of currently assigned
  145  * worker threads plus one for the service pool's reference.
  146  */
  147 typedef struct __rpc_svcxprt {
  148 #ifdef _KERNEL
  149         volatile u_int  xp_refs;
  150         struct sx       xp_lock;
  151         struct __rpc_svcpool *xp_pool;  /* owning pool (see below) */
  152         TAILQ_ENTRY(__rpc_svcxprt) xp_link;
  153         TAILQ_ENTRY(__rpc_svcxprt) xp_alink;
  154         bool_t          xp_registered;  /* xprt_register has been called */
  155         bool_t          xp_active;      /* xprt_active has been called */
  156         struct __rpc_svcthread *xp_thread; /* assigned service thread */
  157         struct socket*  xp_socket;
  158         const struct xp_ops *xp_ops;
  159         char            *xp_netid;      /* network token */
  160         struct sockaddr_storage xp_ltaddr; /* local transport address */
  161         struct sockaddr_storage xp_rtaddr; /* remote transport address */
  162         void            *xp_p1;         /* private: for use by svc ops */
  163         void            *xp_p2;         /* private: for use by svc ops */
  164         void            *xp_p3;         /* private: for use by svc lib */
  165         int             xp_type;        /* transport type */
  166         int             xp_idletimeout; /* idle time before closing */
  167         time_t          xp_lastactive;  /* time of last RPC */
  168         u_int64_t       xp_sockref;     /* set by nfsv4 to identify socket */
  169         int             xp_upcallset;   /* socket upcall is set up */
  170 #else
  171         int             xp_fd;
  172         u_short         xp_port;         /* associated port number */
  173         const struct xp_ops *xp_ops;
  174         int             xp_addrlen;      /* length of remote address */
  175         struct sockaddr_in xp_raddr;     /* remote addr. (backward ABI compat) */
  176         /* XXX - fvdl stick this here for ABI backward compat reasons */
  177         const struct xp_ops2 *xp_ops2;
  178         char            *xp_tp;          /* transport provider device name */
  179         char            *xp_netid;       /* network token */
  180         struct netbuf   xp_ltaddr;       /* local transport address */
  181         struct netbuf   xp_rtaddr;       /* remote transport address */
  182         struct opaque_auth xp_verf;      /* raw response verifier */
  183         void            *xp_p1;          /* private: for use by svc ops */
  184         void            *xp_p2;          /* private: for use by svc ops */
  185         void            *xp_p3;          /* private: for use by svc lib */
  186         int             xp_type;         /* transport type */
  187 #endif
  188 } SVCXPRT;
  189 
  190 /*
  191  * Interface to server-side authentication flavors.
  192  */
  193 typedef struct __rpc_svcauth {
  194         struct svc_auth_ops {
  195 #ifdef _KERNEL
  196                 int   (*svc_ah_wrap)(struct __rpc_svcauth *,  struct mbuf **);
  197                 int   (*svc_ah_unwrap)(struct __rpc_svcauth *, struct mbuf **);
  198                 void  (*svc_ah_release)(struct __rpc_svcauth *);
  199 #else
  200                 int   (*svc_ah_wrap)(struct __rpc_svcauth *, XDR *,
  201                     xdrproc_t, caddr_t);
  202                 int   (*svc_ah_unwrap)(struct __rpc_svcauth *, XDR *,
  203                     xdrproc_t, caddr_t);
  204 #endif
  205         } *svc_ah_ops;
  206         void *svc_ah_private;
  207 } SVCAUTH;
  208 
  209 /*
  210  * Server transport extensions (accessed via xp_p3).
  211  */
  212 typedef struct __rpc_svcxprt_ext {
  213         int             xp_flags;       /* versquiet */
  214         SVCAUTH         xp_auth;        /* interface to auth methods */
  215 } SVCXPRT_EXT;
  216 
  217 #ifdef _KERNEL
  218 
  219 /*
  220  * The services list
  221  * Each entry represents a set of procedures (an rpc program).
  222  * The dispatch routine takes request structs and runs the
  223  * apropriate procedure.
  224  */
  225 struct svc_callout {
  226         TAILQ_ENTRY(svc_callout) sc_link;
  227         rpcprog_t           sc_prog;
  228         rpcvers_t           sc_vers;
  229         char               *sc_netid;
  230         void                (*sc_dispatch)(struct svc_req *, SVCXPRT *);
  231 };
  232 TAILQ_HEAD(svc_callout_list, svc_callout);
  233 
  234 struct __rpc_svcthread;
  235 
  236 /*
  237  * Service request
  238  */
  239 struct svc_req {
  240         STAILQ_ENTRY(svc_req) rq_link;  /* list of requests for a thread */
  241         struct __rpc_svcthread *rq_thread; /* thread which is to execute this */
  242         uint32_t        rq_xid;         /* RPC transaction ID */
  243         uint32_t        rq_prog;        /* service program number */
  244         uint32_t        rq_vers;        /* service protocol version */
  245         uint32_t        rq_proc;        /* the desired procedure */
  246         size_t          rq_size;        /* space used by request */
  247         struct mbuf     *rq_args;       /* XDR-encoded procedure arguments */
  248         struct opaque_auth rq_cred;     /* raw creds from the wire */
  249         struct opaque_auth rq_verf;     /* verifier for the reply */
  250         void            *rq_clntcred;   /* read only cooked cred */
  251         SVCAUTH         rq_auth;        /* interface to auth methods */
  252         SVCXPRT         *rq_xprt;       /* associated transport */
  253         struct sockaddr *rq_addr;       /* reply address or NULL if connected */
  254         void            *rq_p1;         /* application workspace */
  255         int             rq_p2;          /* application workspace */
  256         uint64_t        rq_p3;          /* application workspace */
  257         char            rq_credarea[3*MAX_AUTH_BYTES];
  258 };
  259 STAILQ_HEAD(svc_reqlist, svc_req);
  260 
  261 #define svc_getrpccaller(rq)                                    \
  262         ((rq)->rq_addr ? (rq)->rq_addr :                        \
  263             (struct sockaddr *) &(rq)->rq_xprt->xp_rtaddr)
  264 
  265 /*
  266  * This structure is used to manage a thread which is executing
  267  * requests from a service pool. A service thread is in one of three
  268  * states:
  269  *
  270  *      SVCTHREAD_SLEEPING      waiting for a request to process
  271  *      SVCTHREAD_ACTIVE        processing a request
  272  *      SVCTHREAD_EXITING       exiting after finishing current request
  273  *
  274  * Threads which have no work to process sleep on the pool's sp_active
  275  * list. When a transport becomes active, it is assigned a service
  276  * thread to read and execute pending RPCs.
  277  */
  278 typedef struct __rpc_svcthread {
  279         SVCXPRT                 *st_xprt; /* transport we are processing */
  280         struct svc_reqlist      st_reqs;  /* RPC requests to execute */
  281         int                     st_reqcount; /* number of queued reqs */
  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 __END_DECLS
  527 
  528 #endif
  529 
  530 /*
  531  * When the service routine is called, it must first check to see if it
  532  * knows about the procedure;  if not, it should call svcerr_noproc
  533  * and return.  If so, it should deserialize its arguments via
  534  * SVC_GETARGS (defined above).  If the deserialization does not work,
  535  * svcerr_decode should be called followed by a return.  Successful
  536  * decoding of the arguments should be followed the execution of the
  537  * procedure's code and a call to svc_sendreply.
  538  *
  539  * Also, if the service refuses to execute the procedure due to too-
  540  * weak authentication parameters, svcerr_weakauth should be called.
  541  * Note: do not confuse access-control failure with weak authentication!
  542  *
  543  * NB: In pure implementations of rpc, the caller always waits for a reply
  544  * msg.  This message is sent when svc_sendreply is called.
  545  * Therefore pure service implementations should always call
  546  * svc_sendreply even if the function logically returns void;  use
  547  * xdr.h - xdr_void for the xdr routine.  HOWEVER, tcp based rpc allows
  548  * for the abuse of pure rpc via batched calling or pipelining.  In the
  549  * case of a batched call, svc_sendreply should NOT be called since
  550  * this would send a return message, which is what batching tries to avoid.
  551  * It is the service/protocol writer's responsibility to know which calls are
  552  * batched and which are not.  Warning: responding to batch calls may
  553  * deadlock the caller and server processes!
  554  */
  555 
  556 __BEGIN_DECLS
  557 #ifdef _KERNEL
  558 extern bool_t   svc_sendreply(struct svc_req *, xdrproc_t, void *);
  559 extern bool_t   svc_sendreply_mbuf(struct svc_req *, struct mbuf *);
  560 extern void     svcerr_decode(struct svc_req *);
  561 extern void     svcerr_weakauth(struct svc_req *);
  562 extern void     svcerr_noproc(struct svc_req *);
  563 extern void     svcerr_progvers(struct svc_req *, rpcvers_t, rpcvers_t);
  564 extern void     svcerr_auth(struct svc_req *, enum auth_stat);
  565 extern void     svcerr_noprog(struct svc_req *);
  566 extern void     svcerr_systemerr(struct svc_req *);
  567 #else
  568 extern bool_t   svc_sendreply(SVCXPRT *, xdrproc_t, void *);
  569 extern void     svcerr_decode(SVCXPRT *);
  570 extern void     svcerr_weakauth(SVCXPRT *);
  571 extern void     svcerr_noproc(SVCXPRT *);
  572 extern void     svcerr_progvers(SVCXPRT *, rpcvers_t, rpcvers_t);
  573 extern void     svcerr_auth(SVCXPRT *, enum auth_stat);
  574 extern void     svcerr_noprog(SVCXPRT *);
  575 extern void     svcerr_systemerr(SVCXPRT *);
  576 #endif
  577 extern int      rpc_reg(rpcprog_t, rpcvers_t, rpcproc_t,
  578                         char *(*)(char *), xdrproc_t, xdrproc_t,
  579                         char *);
  580 __END_DECLS
  581 
  582 /*
  583  * Lowest level dispatching -OR- who owns this process anyway.
  584  * Somebody has to wait for incoming requests and then call the correct
  585  * service routine.  The routine svc_run does infinite waiting; i.e.,
  586  * svc_run never returns.
  587  * Since another (co-existant) package may wish to selectively wait for
  588  * incoming calls or other events outside of the rpc architecture, the
  589  * routine svc_getreq is provided.  It must be passed readfds, the
  590  * "in-place" results of a select system call (see select, section 2).
  591  */
  592 
  593 #ifndef _KERNEL
  594 /*
  595  * Global keeper of rpc service descriptors in use
  596  * dynamic; must be inspected before each call to select
  597  */
  598 extern int svc_maxfd;
  599 #ifdef FD_SETSIZE
  600 extern fd_set svc_fdset;
  601 #define svc_fds svc_fdset.fds_bits[0]   /* compatibility */
  602 #else
  603 extern int svc_fds;
  604 #endif /* def FD_SETSIZE */
  605 #endif
  606 
  607 /*
  608  * a small program implemented by the svc_rpc implementation itself;
  609  * also see clnt.h for protocol numbers.
  610  */
  611 __BEGIN_DECLS
  612 extern void rpctest_service(void);
  613 __END_DECLS
  614 
  615 __BEGIN_DECLS
  616 extern SVCXPRT *svc_xprt_alloc(void);
  617 extern void     svc_xprt_free(SVCXPRT *);
  618 #ifndef _KERNEL
  619 extern void     svc_getreq(int);
  620 extern void     svc_getreqset(fd_set *);
  621 extern void     svc_getreq_common(int);
  622 struct pollfd;
  623 extern void     svc_getreq_poll(struct pollfd *, int);
  624 extern void     svc_run(void);
  625 extern void     svc_exit(void);
  626 #else
  627 extern void     svc_run(SVCPOOL *);
  628 extern void     svc_exit(SVCPOOL *);
  629 extern bool_t   svc_getargs(struct svc_req *, xdrproc_t, void *);
  630 extern bool_t   svc_freeargs(struct svc_req *, xdrproc_t, void *);
  631 extern void     svc_freereq(struct svc_req *);
  632 
  633 #endif
  634 __END_DECLS
  635 
  636 /*
  637  * Socket to use on svcxxx_create call to get default socket
  638  */
  639 #define RPC_ANYSOCK     -1
  640 #define RPC_ANYFD       RPC_ANYSOCK
  641 
  642 /*
  643  * These are the existing service side transport implementations
  644  */
  645 
  646 __BEGIN_DECLS
  647 
  648 #ifdef _KERNEL
  649 
  650 /*
  651  * Create a new service pool.
  652  */
  653 extern SVCPOOL* svcpool_create(const char *name,
  654     struct sysctl_oid_list *sysctl_base);
  655 
  656 /*
  657  * Destroy a service pool, including all registered transports.
  658  */
  659 extern void svcpool_destroy(SVCPOOL *pool);
  660 
  661 /*
  662  * Transport independent svc_create routine.
  663  */
  664 extern int svc_create(SVCPOOL *, void (*)(struct svc_req *, SVCXPRT *),
  665     const rpcprog_t, const rpcvers_t, const char *);
  666 /*
  667  *      void (*dispatch)();             -- dispatch routine
  668  *      const rpcprog_t prognum;        -- program number
  669  *      const rpcvers_t versnum;        -- version number
  670  *      const char *nettype;            -- network type
  671  */
  672 
  673 
  674 /*
  675  * Generic server creation routine. It takes a netconfig structure
  676  * instead of a nettype.
  677  */
  678 
  679 extern SVCXPRT *svc_tp_create(SVCPOOL *, void (*)(struct svc_req *, SVCXPRT *),
  680     const rpcprog_t, const rpcvers_t, const char *uaddr,
  681     const struct netconfig *);
  682         /*
  683          * void (*dispatch)();            -- dispatch routine
  684          * const rpcprog_t prognum;       -- program number
  685          * const rpcvers_t versnum;       -- version number
  686          * const char *uaddr;             -- universal address of service
  687          * const struct netconfig *nconf; -- netconfig structure
  688          */
  689 
  690 extern SVCXPRT *svc_dg_create(SVCPOOL *, struct socket *,
  691     const size_t, const size_t);
  692         /*
  693          * struct socket *;                             -- open connection
  694          * const size_t sendsize;                        -- max send size
  695          * const size_t recvsize;                        -- max recv size
  696          */
  697 
  698 extern SVCXPRT *svc_vc_create(SVCPOOL *, struct socket *,
  699     const size_t, const size_t);
  700         /*
  701          * struct socket *;                             -- open connection
  702          * const size_t sendsize;                        -- max send size
  703          * const size_t recvsize;                        -- max recv size
  704          */
  705 
  706 /*
  707  * Generic TLI create routine
  708  */
  709 extern SVCXPRT *svc_tli_create(SVCPOOL *, struct socket *,
  710     const struct netconfig *, const struct t_bind *, const size_t, const size_t);
  711 /*
  712  *      struct socket * so;             -- connection end point
  713  *      const struct netconfig *nconf;  -- netconfig structure for network
  714  *      const struct t_bind *bindaddr;  -- local bind address
  715  *      const size_t sendsz;             -- max sendsize
  716  *      const size_t recvsz;             -- max recvsize
  717  */
  718 
  719 #else /* !_KERNEL */
  720 
  721 /*
  722  * Transport independent svc_create routine.
  723  */
  724 extern int svc_create(void (*)(struct svc_req *, SVCXPRT *),
  725                            const rpcprog_t, const rpcvers_t, const char *);
  726 /*
  727  *      void (*dispatch)();             -- dispatch routine
  728  *      const rpcprog_t prognum;        -- program number
  729  *      const rpcvers_t versnum;        -- version number
  730  *      const char *nettype;            -- network type
  731  */
  732 
  733 
  734 /*
  735  * Generic server creation routine. It takes a netconfig structure
  736  * instead of a nettype.
  737  */
  738 
  739 extern SVCXPRT *svc_tp_create(void (*)(struct svc_req *, SVCXPRT *),
  740                                    const rpcprog_t, const rpcvers_t,
  741                                    const struct netconfig *);
  742         /*
  743          * void (*dispatch)();            -- dispatch routine
  744          * const rpcprog_t prognum;       -- program number
  745          * const rpcvers_t versnum;       -- version number
  746          * const struct netconfig *nconf; -- netconfig structure
  747          */
  748 
  749 /*
  750  * Generic TLI create routine
  751  */
  752 extern SVCXPRT *svc_tli_create(const int, const struct netconfig *,
  753                                const struct t_bind *, const u_int,
  754                                const u_int);
  755 /*
  756  *      const int fd;                   -- connection end point
  757  *      const struct netconfig *nconf;  -- netconfig structure for network
  758  *      const struct t_bind *bindaddr;  -- local bind address
  759  *      const u_int sendsz;             -- max sendsize
  760  *      const u_int recvsz;             -- max recvsize
  761  */
  762 
  763 /*
  764  * Connectionless and connectionful create routines
  765  */
  766 
  767 extern SVCXPRT *svc_vc_create(const int, const u_int, const u_int);
  768 /*
  769  *      const int fd;                           -- open connection end point
  770  *      const u_int sendsize;                   -- max send size
  771  *      const u_int recvsize;                   -- max recv size
  772  */
  773 
  774 /*
  775  * Added for compatibility to old rpc 4.0. Obsoleted by svc_vc_create().
  776  */
  777 extern SVCXPRT *svcunix_create(int, u_int, u_int, char *);
  778 
  779 extern SVCXPRT *svc_dg_create(const int, const u_int, const u_int);
  780         /*
  781          * const int fd;                                -- open connection
  782          * const u_int sendsize;                        -- max send size
  783          * const u_int recvsize;                        -- max recv size
  784          */
  785 
  786 
  787 /*
  788  * the routine takes any *open* connection
  789  * descriptor as its first input and is used for open connections.
  790  */
  791 extern SVCXPRT *svc_fd_create(const int, const u_int, const u_int);
  792 /*
  793  *      const int fd;                           -- open connection end point
  794  *      const u_int sendsize;                   -- max send size
  795  *      const u_int recvsize;                   -- max recv size
  796  */
  797 
  798 /*
  799  * Added for compatibility to old rpc 4.0. Obsoleted by svc_fd_create().
  800  */
  801 extern SVCXPRT *svcunixfd_create(int, u_int, u_int);
  802 
  803 /*
  804  * Memory based rpc (for speed check and testing)
  805  */
  806 extern SVCXPRT *svc_raw_create(void);
  807 
  808 /*
  809  * svc_dg_enable_cache() enables the cache on dg transports.
  810  */
  811 int svc_dg_enablecache(SVCXPRT *, const u_int);
  812 
  813 int __rpc_get_local_uid(SVCXPRT *_transp, uid_t *_uid);
  814 
  815 #endif  /* !_KERNEL */
  816 
  817 __END_DECLS
  818 
  819 #ifndef _KERNEL
  820 /* for backward compatibility */
  821 #include <rpc/svc_soc.h>
  822 #endif
  823 
  824 #endif /* !_RPC_SVC_H */

Cache object: 2755ea14a5d7ec810460682f964654df


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]


This page is part of the FreeBSD/Linux Linux Kernel Cross-Reference, and was automatically generated using a modified version of the LXR engine.