1dfdcada3SDoug Rabson /* $NetBSD: svc.h,v 1.17 2000/06/02 22:57:56 fvdl Exp $ */ 2dfdcada3SDoug Rabson 32e322d37SHiroki Sato /*- 451369649SPedro F. Giffuni * SPDX-License-Identifier: BSD-3-Clause 551369649SPedro F. Giffuni * 62e322d37SHiroki Sato * Copyright (c) 2009, Sun Microsystems, Inc. 72e322d37SHiroki Sato * All rights reserved. 8dfdcada3SDoug Rabson * 92e322d37SHiroki Sato * Redistribution and use in source and binary forms, with or without 102e322d37SHiroki Sato * modification, are permitted provided that the following conditions are met: 112e322d37SHiroki Sato * - Redistributions of source code must retain the above copyright notice, 122e322d37SHiroki Sato * this list of conditions and the following disclaimer. 132e322d37SHiroki Sato * - Redistributions in binary form must reproduce the above copyright notice, 142e322d37SHiroki Sato * this list of conditions and the following disclaimer in the documentation 152e322d37SHiroki Sato * and/or other materials provided with the distribution. 162e322d37SHiroki Sato * - Neither the name of Sun Microsystems, Inc. nor the names of its 172e322d37SHiroki Sato * contributors may be used to endorse or promote products derived 182e322d37SHiroki Sato * from this software without specific prior written permission. 19dfdcada3SDoug Rabson * 202e322d37SHiroki Sato * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 212e322d37SHiroki Sato * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 222e322d37SHiroki Sato * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 232e322d37SHiroki Sato * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE 242e322d37SHiroki Sato * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 252e322d37SHiroki Sato * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 262e322d37SHiroki Sato * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 272e322d37SHiroki Sato * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 282e322d37SHiroki Sato * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 292e322d37SHiroki Sato * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 302e322d37SHiroki Sato * POSSIBILITY OF SUCH DAMAGE. 31dfdcada3SDoug Rabson */ 32dfdcada3SDoug Rabson 33dfdcada3SDoug Rabson /* 34dfdcada3SDoug Rabson * svc.h, Server-side remote procedure call interface. 35dfdcada3SDoug Rabson * 36dfdcada3SDoug Rabson * Copyright (C) 1986-1993 by Sun Microsystems, Inc. 37dfdcada3SDoug Rabson */ 38dfdcada3SDoug Rabson 39dfdcada3SDoug Rabson #ifndef _RPC_SVC_H 40dfdcada3SDoug Rabson #define _RPC_SVC_H 41dfdcada3SDoug Rabson #include <sys/cdefs.h> 42dfdcada3SDoug Rabson 43dfdcada3SDoug Rabson #include <sys/queue.h> 44dfdcada3SDoug Rabson #include <sys/_lock.h> 45dfdcada3SDoug Rabson #include <sys/_mutex.h> 46a9148abdSDoug Rabson #include <sys/_sx.h> 47a9148abdSDoug Rabson #include <sys/condvar.h> 48a9148abdSDoug Rabson #include <sys/sysctl.h> 49dfdcada3SDoug Rabson 50dfdcada3SDoug Rabson /* 51dfdcada3SDoug Rabson * This interface must manage two items concerning remote procedure calling: 52dfdcada3SDoug Rabson * 53dfdcada3SDoug Rabson * 1) An arbitrary number of transport connections upon which rpc requests 54dfdcada3SDoug Rabson * are received. The two most notable transports are TCP and UDP; they are 55dfdcada3SDoug Rabson * created and registered by routines in svc_tcp.c and svc_udp.c, respectively; 56dfdcada3SDoug Rabson * they in turn call xprt_register and xprt_unregister. 57dfdcada3SDoug Rabson * 58dfdcada3SDoug Rabson * 2) An arbitrary number of locally registered services. Services are 59dfdcada3SDoug Rabson * described by the following four data: program number, version number, 60dfdcada3SDoug Rabson * "service dispatch" function, a transport handle, and a boolean that 61dfdcada3SDoug Rabson * indicates whether or not the exported program should be registered with a 62dfdcada3SDoug Rabson * local binder service; if true the program's number and version and the 63dfdcada3SDoug Rabson * port number from the transport handle are registered with the binder. 64dfdcada3SDoug Rabson * These data are registered with the rpc svc system via svc_register. 65dfdcada3SDoug Rabson * 66dfdcada3SDoug Rabson * A service's dispatch function is called whenever an rpc request comes in 67dfdcada3SDoug Rabson * on a transport. The request's program and version numbers must match 68dfdcada3SDoug Rabson * those of the registered service. The dispatch function is passed two 69dfdcada3SDoug Rabson * parameters, struct svc_req * and SVCXPRT *, defined below. 70dfdcada3SDoug Rabson */ 71dfdcada3SDoug Rabson 72dfdcada3SDoug Rabson /* 73dfdcada3SDoug Rabson * Service control requests 74dfdcada3SDoug Rabson */ 75dfdcada3SDoug Rabson #define SVCGET_VERSQUIET 1 76dfdcada3SDoug Rabson #define SVCSET_VERSQUIET 2 77dfdcada3SDoug Rabson #define SVCGET_CONNMAXREC 3 78dfdcada3SDoug Rabson #define SVCSET_CONNMAXREC 4 79dfdcada3SDoug Rabson 80dfdcada3SDoug Rabson /* 81dfdcada3SDoug Rabson * Operations for rpc_control(). 82dfdcada3SDoug Rabson */ 83dfdcada3SDoug Rabson #define RPC_SVC_CONNMAXREC_SET 0 /* set max rec size, enable nonblock */ 84dfdcada3SDoug Rabson #define RPC_SVC_CONNMAXREC_GET 1 85dfdcada3SDoug Rabson 86dfdcada3SDoug Rabson enum xprt_stat { 87dfdcada3SDoug Rabson XPRT_DIED, 88dfdcada3SDoug Rabson XPRT_MOREREQS, 89dfdcada3SDoug Rabson XPRT_IDLE 90dfdcada3SDoug Rabson }; 91dfdcada3SDoug Rabson 92dfdcada3SDoug Rabson struct __rpc_svcxprt; 93a9148abdSDoug Rabson struct mbuf; 94dfdcada3SDoug Rabson 95dfdcada3SDoug Rabson struct xp_ops { 96a9148abdSDoug Rabson /* receive incoming requests */ 97a9148abdSDoug Rabson bool_t (*xp_recv)(struct __rpc_svcxprt *, struct rpc_msg *, 98a9148abdSDoug Rabson struct sockaddr **, struct mbuf **); 99a9148abdSDoug Rabson /* get transport status */ 100a9148abdSDoug Rabson enum xprt_stat (*xp_stat)(struct __rpc_svcxprt *); 101d473bac7SAlexander Motin /* get transport acknowledge sequence */ 102d473bac7SAlexander Motin bool_t (*xp_ack)(struct __rpc_svcxprt *, uint32_t *); 103a9148abdSDoug Rabson /* send reply */ 104a9148abdSDoug Rabson bool_t (*xp_reply)(struct __rpc_svcxprt *, struct rpc_msg *, 105d473bac7SAlexander Motin struct sockaddr *, struct mbuf *, uint32_t *); 106a9148abdSDoug Rabson /* destroy this struct */ 107a9148abdSDoug Rabson void (*xp_destroy)(struct __rpc_svcxprt *); 108a9148abdSDoug Rabson /* catch-all function */ 109a9148abdSDoug Rabson bool_t (*xp_control)(struct __rpc_svcxprt *, const u_int, void *); 110dfdcada3SDoug Rabson }; 111dfdcada3SDoug Rabson 112dfdcada3SDoug Rabson struct __rpc_svcpool; 113b563304cSAlexander Motin struct __rpc_svcgroup; 114a9148abdSDoug Rabson struct __rpc_svcthread; 115dfdcada3SDoug Rabson 116dfdcada3SDoug Rabson /* 117a9148abdSDoug Rabson * Server side transport handle. In the kernel, transports have a 118a9148abdSDoug Rabson * reference count which tracks the number of currently assigned 119a9148abdSDoug Rabson * worker threads plus one for the service pool's reference. 120c59e4cc3SRick Macklem * For NFSv4.1 sessions, a reference is also held for a backchannel. 121e1a907a2SRick Macklem * xp_p2 - Points to the CLIENT structure for the RPC server end 122e1a907a2SRick Macklem * (the client end for callbacks). 123e1a907a2SRick Macklem * Points to the private structure (cl_private) for the 124e1a907a2SRick Macklem * CLIENT structure for the RPC client end (the server 125e1a907a2SRick Macklem * end for callbacks). 126dfdcada3SDoug Rabson */ 127dfdcada3SDoug Rabson typedef struct __rpc_svcxprt { 128a9148abdSDoug Rabson volatile u_int xp_refs; 129a9148abdSDoug Rabson struct sx xp_lock; 130dfdcada3SDoug Rabson struct __rpc_svcpool *xp_pool; /* owning pool (see below) */ 131b563304cSAlexander Motin struct __rpc_svcgroup *xp_group; /* owning group (see below) */ 132dfdcada3SDoug Rabson TAILQ_ENTRY(__rpc_svcxprt) xp_link; 133dfdcada3SDoug Rabson TAILQ_ENTRY(__rpc_svcxprt) xp_alink; 134dfdcada3SDoug Rabson bool_t xp_registered; /* xprt_register has been called */ 135dfdcada3SDoug Rabson bool_t xp_active; /* xprt_active has been called */ 136a9148abdSDoug Rabson struct __rpc_svcthread *xp_thread; /* assigned service thread */ 137dfdcada3SDoug Rabson struct socket* xp_socket; 138dfdcada3SDoug Rabson const struct xp_ops *xp_ops; 139dfdcada3SDoug Rabson char *xp_netid; /* network token */ 140a9148abdSDoug Rabson struct sockaddr_storage xp_ltaddr; /* local transport address */ 141a9148abdSDoug Rabson struct sockaddr_storage xp_rtaddr; /* remote transport address */ 142dfdcada3SDoug Rabson void *xp_p1; /* private: for use by svc ops */ 143dfdcada3SDoug Rabson void *xp_p2; /* private: for use by svc ops */ 144dfdcada3SDoug Rabson void *xp_p3; /* private: for use by svc lib */ 145dfdcada3SDoug Rabson int xp_type; /* transport type */ 146a9148abdSDoug Rabson int xp_idletimeout; /* idle time before closing */ 147a9148abdSDoug Rabson time_t xp_lastactive; /* time of last RPC */ 148bcd0e31dSJohn Baldwin uint64_t xp_sockref; /* set by nfsv4 to identify socket */ 149a4fa5e6dSRick Macklem int xp_upcallset; /* socket upcall is set up */ 150c809a67aSAlexander Motin uint32_t xp_snd_cnt; /* # of bytes to send to socket */ 151c809a67aSAlexander Motin uint32_t xp_snt_cnt; /* # of bytes sent to socket */ 152ab0c29afSRick Macklem bool_t xp_dontrcv; /* Do not receive on the socket */ 153ab0c29afSRick Macklem uint32_t xp_tls; /* RPC-over-TLS on socket */ 154ab0c29afSRick Macklem int xp_ngrps; /* Cred. from TLS cert. */ 155ab0c29afSRick Macklem uid_t xp_uid; 156ab0c29afSRick Macklem gid_t *xp_gidp; 157a16ff32fSJohn Baldwin int xp_doneddp; 158dfdcada3SDoug Rabson } SVCXPRT; 159dfdcada3SDoug Rabson 160a9148abdSDoug Rabson /* 161a9148abdSDoug Rabson * Interface to server-side authentication flavors. 162a9148abdSDoug Rabson */ 163a9148abdSDoug Rabson typedef struct __rpc_svcauth { 16420d728b5SMark Johnston const struct svc_auth_ops { 165a9148abdSDoug Rabson int (*svc_ah_wrap)(struct __rpc_svcauth *, struct mbuf **); 166a9148abdSDoug Rabson int (*svc_ah_unwrap)(struct __rpc_svcauth *, struct mbuf **); 167a9148abdSDoug Rabson void (*svc_ah_release)(struct __rpc_svcauth *); 168a9148abdSDoug Rabson } *svc_ah_ops; 169a9148abdSDoug Rabson void *svc_ah_private; 170a9148abdSDoug Rabson } SVCAUTH; 171a9148abdSDoug Rabson 172a9148abdSDoug Rabson /* 173a9148abdSDoug Rabson * Server transport extensions (accessed via xp_p3). 174a9148abdSDoug Rabson */ 175a9148abdSDoug Rabson typedef struct __rpc_svcxprt_ext { 176a9148abdSDoug Rabson int xp_flags; /* versquiet */ 177a9148abdSDoug Rabson SVCAUTH xp_auth; /* interface to auth methods */ 178a9148abdSDoug Rabson } SVCXPRT_EXT; 179a9148abdSDoug Rabson 180dfdcada3SDoug Rabson /* 181dfdcada3SDoug Rabson * The services list 182dfdcada3SDoug Rabson * Each entry represents a set of procedures (an rpc program). 183dfdcada3SDoug Rabson * The dispatch routine takes request structs and runs the 1846244c6e7SPedro F. Giffuni * appropriate procedure. 185dfdcada3SDoug Rabson */ 186dfdcada3SDoug Rabson struct svc_callout { 187dfdcada3SDoug Rabson TAILQ_ENTRY(svc_callout) sc_link; 188dfdcada3SDoug Rabson rpcprog_t sc_prog; 189dfdcada3SDoug Rabson rpcvers_t sc_vers; 190dfdcada3SDoug Rabson char *sc_netid; 191dfdcada3SDoug Rabson void (*sc_dispatch)(struct svc_req *, SVCXPRT *); 192dfdcada3SDoug Rabson }; 193dfdcada3SDoug Rabson TAILQ_HEAD(svc_callout_list, svc_callout); 194dfdcada3SDoug Rabson 195d473bac7SAlexander Motin /* 196d473bac7SAlexander Motin * The services connection loss list 197d473bac7SAlexander Motin * The dispatch routine takes request structs and runs the 1986244c6e7SPedro F. Giffuni * appropriate procedure. 199d473bac7SAlexander Motin */ 200d473bac7SAlexander Motin struct svc_loss_callout { 201d473bac7SAlexander Motin TAILQ_ENTRY(svc_loss_callout) slc_link; 202d473bac7SAlexander Motin void (*slc_dispatch)(SVCXPRT *); 203d473bac7SAlexander Motin }; 204d473bac7SAlexander Motin TAILQ_HEAD(svc_loss_callout_list, svc_loss_callout); 205d473bac7SAlexander Motin 206a9148abdSDoug Rabson /* 207a9148abdSDoug Rabson * Service request 208a9148abdSDoug Rabson */ 209a9148abdSDoug Rabson struct svc_req { 210a9148abdSDoug Rabson STAILQ_ENTRY(svc_req) rq_link; /* list of requests for a thread */ 211a9148abdSDoug Rabson struct __rpc_svcthread *rq_thread; /* thread which is to execute this */ 212a9148abdSDoug Rabson uint32_t rq_xid; /* RPC transaction ID */ 213a9148abdSDoug Rabson uint32_t rq_prog; /* service program number */ 214a9148abdSDoug Rabson uint32_t rq_vers; /* service protocol version */ 215a9148abdSDoug Rabson uint32_t rq_proc; /* the desired procedure */ 216a9148abdSDoug Rabson size_t rq_size; /* space used by request */ 217a9148abdSDoug Rabson struct mbuf *rq_args; /* XDR-encoded procedure arguments */ 218a9148abdSDoug Rabson struct opaque_auth rq_cred; /* raw creds from the wire */ 219a9148abdSDoug Rabson struct opaque_auth rq_verf; /* verifier for the reply */ 220a9148abdSDoug Rabson void *rq_clntcred; /* read only cooked cred */ 221a9148abdSDoug Rabson SVCAUTH rq_auth; /* interface to auth methods */ 222a9148abdSDoug Rabson SVCXPRT *rq_xprt; /* associated transport */ 223a9148abdSDoug Rabson struct sockaddr *rq_addr; /* reply address or NULL if connected */ 224a9148abdSDoug Rabson void *rq_p1; /* application workspace */ 225a9148abdSDoug Rabson int rq_p2; /* application workspace */ 226a9148abdSDoug Rabson uint64_t rq_p3; /* application workspace */ 227d473bac7SAlexander Motin uint32_t rq_reply_seq; /* reply socket sequence # */ 228a9148abdSDoug Rabson char rq_credarea[3*MAX_AUTH_BYTES]; 229a9148abdSDoug Rabson }; 230a9148abdSDoug Rabson STAILQ_HEAD(svc_reqlist, svc_req); 231a9148abdSDoug Rabson 232a9148abdSDoug Rabson #define svc_getrpccaller(rq) \ 233a9148abdSDoug Rabson ((rq)->rq_addr ? (rq)->rq_addr : \ 234a9148abdSDoug Rabson (struct sockaddr *) &(rq)->rq_xprt->xp_rtaddr) 235a9148abdSDoug Rabson 236a9148abdSDoug Rabson /* 237a9148abdSDoug Rabson * This structure is used to manage a thread which is executing 238a9148abdSDoug Rabson * requests from a service pool. A service thread is in one of three 239a9148abdSDoug Rabson * states: 240a9148abdSDoug Rabson * 241a9148abdSDoug Rabson * SVCTHREAD_SLEEPING waiting for a request to process 242a9148abdSDoug Rabson * SVCTHREAD_ACTIVE processing a request 243a9148abdSDoug Rabson * SVCTHREAD_EXITING exiting after finishing current request 244a9148abdSDoug Rabson * 245a9148abdSDoug Rabson * Threads which have no work to process sleep on the pool's sp_active 246a9148abdSDoug Rabson * list. When a transport becomes active, it is assigned a service 247a9148abdSDoug Rabson * thread to read and execute pending RPCs. 248a9148abdSDoug Rabson */ 249a9148abdSDoug Rabson typedef struct __rpc_svcthread { 250b776fb2dSAlexander Motin struct mtx_padalign st_lock; /* protects st_reqs field */ 251f8fb069dSAlexander Motin struct __rpc_svcpool *st_pool; 252a9148abdSDoug Rabson SVCXPRT *st_xprt; /* transport we are processing */ 253a9148abdSDoug Rabson struct svc_reqlist st_reqs; /* RPC requests to execute */ 254a9148abdSDoug Rabson struct cv st_cond; /* sleeping for work */ 255a9148abdSDoug Rabson LIST_ENTRY(__rpc_svcthread) st_ilink; /* idle threads list */ 256a9148abdSDoug Rabson LIST_ENTRY(__rpc_svcthread) st_alink; /* application thread list */ 257f8fb069dSAlexander Motin int st_p2; /* application workspace */ 258f8fb069dSAlexander Motin uint64_t st_p3; /* application workspace */ 259a9148abdSDoug Rabson } SVCTHREAD; 260a9148abdSDoug Rabson LIST_HEAD(svcthread_list, __rpc_svcthread); 261a9148abdSDoug Rabson 262dfdcada3SDoug Rabson /* 263b563304cSAlexander Motin * A thread group contain all information needed to assign subset of 264b563304cSAlexander Motin * transports to subset of threads. On systems with many CPUs and many 265b563304cSAlexander Motin * threads that allows to reduce lock congestion and improve performance. 266b563304cSAlexander Motin * Hundreds of threads on dozens of CPUs sharing the single pool lock do 267b563304cSAlexander Motin * not scale well otherwise. 268b563304cSAlexander Motin */ 269b563304cSAlexander Motin TAILQ_HEAD(svcxprt_list, __rpc_svcxprt); 270b563304cSAlexander Motin enum svcpool_state { 271b563304cSAlexander Motin SVCPOOL_INIT, /* svc_run not called yet */ 272b563304cSAlexander Motin SVCPOOL_ACTIVE, /* normal running state */ 273b563304cSAlexander Motin SVCPOOL_THREADWANTED, /* new service thread requested */ 274b563304cSAlexander Motin SVCPOOL_THREADSTARTING, /* new service thread started */ 275b563304cSAlexander Motin SVCPOOL_CLOSING /* svc_exit called */ 276b563304cSAlexander Motin }; 277b563304cSAlexander Motin typedef struct __rpc_svcgroup { 278b563304cSAlexander Motin struct mtx_padalign sg_lock; /* protect the thread/req lists */ 279b563304cSAlexander Motin struct __rpc_svcpool *sg_pool; 280b563304cSAlexander Motin enum svcpool_state sg_state; /* current pool state */ 281b563304cSAlexander Motin struct svcxprt_list sg_xlist; /* all transports in the group */ 282b563304cSAlexander Motin struct svcxprt_list sg_active; /* transports needing service */ 283b563304cSAlexander Motin struct svcthread_list sg_idlethreads; /* idle service threads */ 284b563304cSAlexander Motin 285b563304cSAlexander Motin int sg_minthreads; /* minimum service thread count */ 286b563304cSAlexander Motin int sg_maxthreads; /* maximum service thread count */ 287b563304cSAlexander Motin int sg_threadcount; /* current service thread count */ 288b563304cSAlexander Motin time_t sg_lastcreatetime; /* when we last started a thread */ 289b563304cSAlexander Motin time_t sg_lastidlecheck; /* when we last checked idle transports */ 290b563304cSAlexander Motin } SVCGROUP; 291b563304cSAlexander Motin 292b563304cSAlexander Motin /* 293dfdcada3SDoug Rabson * In the kernel, we can't use global variables to store lists of 294dfdcada3SDoug Rabson * transports etc. since otherwise we could not have two unrelated RPC 295dfdcada3SDoug Rabson * services running, each on its own thread. We solve this by 296dfdcada3SDoug Rabson * importing a tiny part of a Solaris kernel concept, SVCPOOL. 297dfdcada3SDoug Rabson * 298dfdcada3SDoug Rabson * A service pool contains a set of transports and service callbacks 299dfdcada3SDoug Rabson * for a set of related RPC services. The pool handle should be passed 300dfdcada3SDoug Rabson * when creating new transports etc. Future work may include extending 301dfdcada3SDoug Rabson * this to support something similar to the Solaris multi-threaded RPC 302dfdcada3SDoug Rabson * server. 303dfdcada3SDoug Rabson */ 304a9148abdSDoug Rabson typedef SVCTHREAD *pool_assign_fn(SVCTHREAD *, struct svc_req *); 305a9148abdSDoug Rabson typedef void pool_done_fn(SVCTHREAD *, struct svc_req *); 306b563304cSAlexander Motin #define SVC_MAXGROUPS 16 307dfdcada3SDoug Rabson typedef struct __rpc_svcpool { 308c809a67aSAlexander Motin struct mtx_padalign sp_lock; /* protect the transport lists */ 309a9148abdSDoug Rabson const char *sp_name; /* pool name (e.g. "nfsd", "NLM" */ 310a9148abdSDoug Rabson enum svcpool_state sp_state; /* current pool state */ 311a9148abdSDoug Rabson struct proc *sp_proc; /* process which is in svc_run */ 312dfdcada3SDoug Rabson struct svc_callout_list sp_callouts; /* (prog,vers)->dispatch list */ 313d473bac7SAlexander Motin struct svc_loss_callout_list sp_lcallouts; /* loss->dispatch list */ 314a9148abdSDoug Rabson int sp_minthreads; /* minimum service thread count */ 315a9148abdSDoug Rabson int sp_maxthreads; /* maximum service thread count */ 316a9148abdSDoug Rabson 317a9148abdSDoug Rabson /* 318a9148abdSDoug Rabson * Hooks to allow an application to control request to thread 319a9148abdSDoug Rabson * placement. 320a9148abdSDoug Rabson */ 321a9148abdSDoug Rabson pool_assign_fn *sp_assign; 322a9148abdSDoug Rabson pool_done_fn *sp_done; 323a9148abdSDoug Rabson 324a9148abdSDoug Rabson /* 325a9148abdSDoug Rabson * These variables are used to put an upper bound on the 326a9148abdSDoug Rabson * amount of memory used by RPC requests which are queued 327a9148abdSDoug Rabson * waiting for execution. 328a9148abdSDoug Rabson */ 3293c42b5bfSGarrett Wollman unsigned long sp_space_low; 3303c42b5bfSGarrett Wollman unsigned long sp_space_high; 3313c42b5bfSGarrett Wollman unsigned long sp_space_used; 3323c42b5bfSGarrett Wollman unsigned long sp_space_used_highest; 333a9148abdSDoug Rabson bool_t sp_space_throttled; 334a9148abdSDoug Rabson int sp_space_throttle_count; 335a9148abdSDoug Rabson 336a9148abdSDoug Rabson struct replay_cache *sp_rcache; /* optional replay cache */ 337a9148abdSDoug Rabson struct sysctl_ctx_list sp_sysctl; 338b563304cSAlexander Motin 339b563304cSAlexander Motin int sp_groupcount; /* Number of groups in the pool. */ 340b563304cSAlexander Motin int sp_nextgroup; /* Next group to assign port. */ 341b563304cSAlexander Motin SVCGROUP sp_groups[SVC_MAXGROUPS]; /* Thread/port groups. */ 342dfdcada3SDoug Rabson } SVCPOOL; 343dfdcada3SDoug Rabson 344dfdcada3SDoug Rabson /* 345dfdcada3SDoug Rabson * Operations defined on an SVCXPRT handle 346dfdcada3SDoug Rabson * 347dfdcada3SDoug Rabson * SVCXPRT *xprt; 348dfdcada3SDoug Rabson * struct rpc_msg *msg; 349dfdcada3SDoug Rabson * xdrproc_t xargs; 350dfdcada3SDoug Rabson * void * argsp; 351dfdcada3SDoug Rabson */ 352a9148abdSDoug Rabson #define SVC_ACQUIRE(xprt) \ 353a9148abdSDoug Rabson refcount_acquire(&(xprt)->xp_refs) 354a9148abdSDoug Rabson 355a9148abdSDoug Rabson #define SVC_RELEASE(xprt) \ 356a9148abdSDoug Rabson if (refcount_release(&(xprt)->xp_refs)) \ 357a9148abdSDoug Rabson SVC_DESTROY(xprt) 358a9148abdSDoug Rabson 359a9148abdSDoug Rabson #define SVC_RECV(xprt, msg, addr, args) \ 360a9148abdSDoug Rabson (*(xprt)->xp_ops->xp_recv)((xprt), (msg), (addr), (args)) 361a9148abdSDoug Rabson 362a9148abdSDoug Rabson #define SVC_STAT(xprt) \ 363a9148abdSDoug Rabson (*(xprt)->xp_ops->xp_stat)(xprt) 364a9148abdSDoug Rabson 365d473bac7SAlexander Motin #define SVC_ACK(xprt, ack) \ 3660979970aSAlexander Motin ((xprt)->xp_ops->xp_ack == NULL ? FALSE : \ 367d473bac7SAlexander Motin ((ack) == NULL ? TRUE : (*(xprt)->xp_ops->xp_ack)((xprt), (ack)))) 368d473bac7SAlexander Motin 369d473bac7SAlexander Motin #define SVC_REPLY(xprt, msg, addr, m, seq) \ 370d473bac7SAlexander Motin (*(xprt)->xp_ops->xp_reply) ((xprt), (msg), (addr), (m), (seq)) 371a9148abdSDoug Rabson 372a9148abdSDoug Rabson #define SVC_DESTROY(xprt) \ 373a9148abdSDoug Rabson (*(xprt)->xp_ops->xp_destroy)(xprt) 374a9148abdSDoug Rabson 375a9148abdSDoug Rabson #define SVC_CONTROL(xprt, rq, in) \ 376a9148abdSDoug Rabson (*(xprt)->xp_ops->xp_control)((xprt), (rq), (in)) 377a9148abdSDoug Rabson 378a9148abdSDoug Rabson #define SVC_EXT(xprt) \ 379a9148abdSDoug Rabson ((SVCXPRT_EXT *) xprt->xp_p3) 380a9148abdSDoug Rabson 381a9148abdSDoug Rabson #define SVC_AUTH(xprt) \ 382a9148abdSDoug Rabson (SVC_EXT(xprt)->xp_auth) 383a9148abdSDoug Rabson 384a9148abdSDoug Rabson /* 385a9148abdSDoug Rabson * Operations defined on an SVCAUTH handle 386a9148abdSDoug Rabson */ 387a9148abdSDoug Rabson #define SVCAUTH_WRAP(auth, mp) \ 388a9148abdSDoug Rabson ((auth)->svc_ah_ops->svc_ah_wrap(auth, mp)) 389a9148abdSDoug Rabson #define SVCAUTH_UNWRAP(auth, mp) \ 390a9148abdSDoug Rabson ((auth)->svc_ah_ops->svc_ah_unwrap(auth, mp)) 391a9148abdSDoug Rabson #define SVCAUTH_RELEASE(auth) \ 392a9148abdSDoug Rabson ((auth)->svc_ah_ops->svc_ah_release(auth)) 393dfdcada3SDoug Rabson 394dfdcada3SDoug Rabson /* 395dfdcada3SDoug Rabson * Service registration 396dfdcada3SDoug Rabson * 397dfdcada3SDoug Rabson * svc_reg(xprt, prog, vers, dispatch, nconf) 398dfdcada3SDoug Rabson * const SVCXPRT *xprt; 399dfdcada3SDoug Rabson * const rpcprog_t prog; 400dfdcada3SDoug Rabson * const rpcvers_t vers; 401dfdcada3SDoug Rabson * const void (*dispatch)(); 402dfdcada3SDoug Rabson * const struct netconfig *nconf; 403dfdcada3SDoug Rabson */ 404dfdcada3SDoug Rabson 405dfdcada3SDoug Rabson __BEGIN_DECLS 406dfdcada3SDoug Rabson extern bool_t svc_reg(SVCXPRT *, const rpcprog_t, const rpcvers_t, 407dfdcada3SDoug Rabson void (*)(struct svc_req *, SVCXPRT *), 408dfdcada3SDoug Rabson const struct netconfig *); 409dfdcada3SDoug Rabson __END_DECLS 410dfdcada3SDoug Rabson 411dfdcada3SDoug Rabson /* 412dfdcada3SDoug Rabson * Service un-registration 413dfdcada3SDoug Rabson * 414dfdcada3SDoug Rabson * svc_unreg(prog, vers) 415dfdcada3SDoug Rabson * const rpcprog_t prog; 416dfdcada3SDoug Rabson * const rpcvers_t vers; 417dfdcada3SDoug Rabson */ 418dfdcada3SDoug Rabson 419dfdcada3SDoug Rabson __BEGIN_DECLS 420dfdcada3SDoug Rabson extern void svc_unreg(SVCPOOL *, const rpcprog_t, const rpcvers_t); 421dfdcada3SDoug Rabson __END_DECLS 422dfdcada3SDoug Rabson 423dfdcada3SDoug Rabson /* 424d473bac7SAlexander Motin * Service connection loss registration 425d473bac7SAlexander Motin * 426d473bac7SAlexander Motin * svc_loss_reg(xprt, dispatch) 427d473bac7SAlexander Motin * const SVCXPRT *xprt; 428d473bac7SAlexander Motin * const void (*dispatch)(); 429d473bac7SAlexander Motin */ 430d473bac7SAlexander Motin 431d473bac7SAlexander Motin __BEGIN_DECLS 432d473bac7SAlexander Motin extern bool_t svc_loss_reg(SVCXPRT *, void (*)(SVCXPRT *)); 433d473bac7SAlexander Motin __END_DECLS 434d473bac7SAlexander Motin 435d473bac7SAlexander Motin /* 436d473bac7SAlexander Motin * Service connection loss un-registration 437d473bac7SAlexander Motin * 438d473bac7SAlexander Motin * svc_loss_unreg(xprt, dispatch) 439d473bac7SAlexander Motin * const SVCXPRT *xprt; 440d473bac7SAlexander Motin * const void (*dispatch)(); 441d473bac7SAlexander Motin */ 442d473bac7SAlexander Motin 443d473bac7SAlexander Motin __BEGIN_DECLS 444d473bac7SAlexander Motin extern void svc_loss_unreg(SVCPOOL *, void (*)(SVCXPRT *)); 445d473bac7SAlexander Motin __END_DECLS 446d473bac7SAlexander Motin 447d473bac7SAlexander Motin /* 448dfdcada3SDoug Rabson * Transport registration. 449dfdcada3SDoug Rabson * 450dfdcada3SDoug Rabson * xprt_register(xprt) 451dfdcada3SDoug Rabson * SVCXPRT *xprt; 452dfdcada3SDoug Rabson */ 453dfdcada3SDoug Rabson __BEGIN_DECLS 454dfdcada3SDoug Rabson extern void xprt_register(SVCXPRT *); 455dfdcada3SDoug Rabson __END_DECLS 456dfdcada3SDoug Rabson 457dfdcada3SDoug Rabson /* 458dfdcada3SDoug Rabson * Transport un-register 459dfdcada3SDoug Rabson * 460dfdcada3SDoug Rabson * xprt_unregister(xprt) 461dfdcada3SDoug Rabson * SVCXPRT *xprt; 462dfdcada3SDoug Rabson */ 463dfdcada3SDoug Rabson __BEGIN_DECLS 464dfdcada3SDoug Rabson extern void xprt_unregister(SVCXPRT *); 465dfdcada3SDoug Rabson extern void __xprt_unregister_unlocked(SVCXPRT *); 466dfdcada3SDoug Rabson __END_DECLS 467dfdcada3SDoug Rabson 468dfdcada3SDoug Rabson /* 469dfdcada3SDoug Rabson * Called when a transport has pending requests. 470dfdcada3SDoug Rabson */ 471dfdcada3SDoug Rabson __BEGIN_DECLS 472dfdcada3SDoug Rabson extern void xprt_active(SVCXPRT *); 473dfdcada3SDoug Rabson extern void xprt_inactive(SVCXPRT *); 474a9148abdSDoug Rabson extern void xprt_inactive_locked(SVCXPRT *); 4755c42b9dcSAlexander Motin extern void xprt_inactive_self(SVCXPRT *); 476dfdcada3SDoug Rabson __END_DECLS 477dfdcada3SDoug Rabson 478dfdcada3SDoug Rabson /* 479dfdcada3SDoug Rabson * When the service routine is called, it must first check to see if it 480dfdcada3SDoug Rabson * knows about the procedure; if not, it should call svcerr_noproc 481dfdcada3SDoug Rabson * and return. If so, it should deserialize its arguments via 482dfdcada3SDoug Rabson * SVC_GETARGS (defined above). If the deserialization does not work, 483dfdcada3SDoug Rabson * svcerr_decode should be called followed by a return. Successful 484dfdcada3SDoug Rabson * decoding of the arguments should be followed the execution of the 485dfdcada3SDoug Rabson * procedure's code and a call to svc_sendreply. 486dfdcada3SDoug Rabson * 487dfdcada3SDoug Rabson * Also, if the service refuses to execute the procedure due to too- 488dfdcada3SDoug Rabson * weak authentication parameters, svcerr_weakauth should be called. 489dfdcada3SDoug Rabson * Note: do not confuse access-control failure with weak authentication! 490dfdcada3SDoug Rabson * 491dfdcada3SDoug Rabson * NB: In pure implementations of rpc, the caller always waits for a reply 492dfdcada3SDoug Rabson * msg. This message is sent when svc_sendreply is called. 493dfdcada3SDoug Rabson * Therefore pure service implementations should always call 494dfdcada3SDoug Rabson * svc_sendreply even if the function logically returns void; use 495dfdcada3SDoug Rabson * xdr.h - xdr_void for the xdr routine. HOWEVER, tcp based rpc allows 496dfdcada3SDoug Rabson * for the abuse of pure rpc via batched calling or pipelining. In the 497dfdcada3SDoug Rabson * case of a batched call, svc_sendreply should NOT be called since 498dfdcada3SDoug Rabson * this would send a return message, which is what batching tries to avoid. 499dfdcada3SDoug Rabson * It is the service/protocol writer's responsibility to know which calls are 500dfdcada3SDoug Rabson * batched and which are not. Warning: responding to batch calls may 501dfdcada3SDoug Rabson * deadlock the caller and server processes! 502dfdcada3SDoug Rabson */ 503dfdcada3SDoug Rabson 504dfdcada3SDoug Rabson __BEGIN_DECLS 505a9148abdSDoug Rabson extern bool_t svc_sendreply(struct svc_req *, xdrproc_t, void *); 506a9148abdSDoug Rabson extern bool_t svc_sendreply_mbuf(struct svc_req *, struct mbuf *); 507a9148abdSDoug Rabson extern void svcerr_decode(struct svc_req *); 508a9148abdSDoug Rabson extern void svcerr_weakauth(struct svc_req *); 509a9148abdSDoug Rabson extern void svcerr_noproc(struct svc_req *); 510a9148abdSDoug Rabson extern void svcerr_progvers(struct svc_req *, rpcvers_t, rpcvers_t); 511a9148abdSDoug Rabson extern void svcerr_auth(struct svc_req *, enum auth_stat); 512a9148abdSDoug Rabson extern void svcerr_noprog(struct svc_req *); 513a9148abdSDoug Rabson extern void svcerr_systemerr(struct svc_req *); 514dfdcada3SDoug Rabson extern int rpc_reg(rpcprog_t, rpcvers_t, rpcproc_t, 515dfdcada3SDoug Rabson char *(*)(char *), xdrproc_t, xdrproc_t, 516dfdcada3SDoug Rabson char *); 517dfdcada3SDoug Rabson __END_DECLS 518dfdcada3SDoug Rabson 519dfdcada3SDoug Rabson /* 520dfdcada3SDoug Rabson * Lowest level dispatching -OR- who owns this process anyway. 521dfdcada3SDoug Rabson * Somebody has to wait for incoming requests and then call the correct 522dfdcada3SDoug Rabson * service routine. The routine svc_run does infinite waiting; i.e., 523dfdcada3SDoug Rabson * svc_run never returns. 524631504fbSGordon Bergling * Since another (co-existent) package may wish to selectively wait for 525dfdcada3SDoug Rabson * incoming calls or other events outside of the rpc architecture, the 526dfdcada3SDoug Rabson * routine svc_getreq is provided. It must be passed readfds, the 527dfdcada3SDoug Rabson * "in-place" results of a select system call (see select, section 2). 528dfdcada3SDoug Rabson */ 529dfdcada3SDoug Rabson 530dfdcada3SDoug Rabson /* 531dfdcada3SDoug Rabson * a small program implemented by the svc_rpc implementation itself; 532dfdcada3SDoug Rabson * also see clnt.h for protocol numbers. 533dfdcada3SDoug Rabson */ 534dfdcada3SDoug Rabson __BEGIN_DECLS 535dfdcada3SDoug Rabson extern void rpctest_service(void); 536dfdcada3SDoug Rabson __END_DECLS 537dfdcada3SDoug Rabson 538dfdcada3SDoug Rabson __BEGIN_DECLS 539a9148abdSDoug Rabson extern SVCXPRT *svc_xprt_alloc(void); 540a9148abdSDoug Rabson extern void svc_xprt_free(SVCXPRT *); 541dfdcada3SDoug Rabson extern void svc_run(SVCPOOL *); 542dfdcada3SDoug Rabson extern void svc_exit(SVCPOOL *); 543a9148abdSDoug Rabson extern bool_t svc_getargs(struct svc_req *, xdrproc_t, void *); 544a9148abdSDoug Rabson extern bool_t svc_freeargs(struct svc_req *, xdrproc_t, void *); 545a9148abdSDoug Rabson extern void svc_freereq(struct svc_req *); 546dfdcada3SDoug Rabson __END_DECLS 547dfdcada3SDoug Rabson 548dfdcada3SDoug Rabson /* 549dfdcada3SDoug Rabson * Socket to use on svcxxx_create call to get default socket 550dfdcada3SDoug Rabson */ 551dfdcada3SDoug Rabson #define RPC_ANYSOCK -1 552dfdcada3SDoug Rabson #define RPC_ANYFD RPC_ANYSOCK 553dfdcada3SDoug Rabson 554dfdcada3SDoug Rabson /* 555dfdcada3SDoug Rabson * These are the existing service side transport implementations 556dfdcada3SDoug Rabson */ 557dfdcada3SDoug Rabson 558dfdcada3SDoug Rabson __BEGIN_DECLS 559dfdcada3SDoug Rabson 560dfdcada3SDoug Rabson /* 561dfdcada3SDoug Rabson * Create a new service pool. 562dfdcada3SDoug Rabson */ 563a9148abdSDoug Rabson extern SVCPOOL* svcpool_create(const char *name, 564a9148abdSDoug Rabson struct sysctl_oid_list *sysctl_base); 565dfdcada3SDoug Rabson 566dfdcada3SDoug Rabson /* 567dfdcada3SDoug Rabson * Destroy a service pool, including all registered transports. 568dfdcada3SDoug Rabson */ 569dfdcada3SDoug Rabson extern void svcpool_destroy(SVCPOOL *pool); 570dfdcada3SDoug Rabson 571dfdcada3SDoug Rabson /* 57290f90687SAndriy Gapon * Close a service pool. Similar to svcpool_destroy(), but it does not 57390f90687SAndriy Gapon * free the data structures. As such, the pool can be used again. 57490f90687SAndriy Gapon */ 57590f90687SAndriy Gapon extern void svcpool_close(SVCPOOL *pool); 57690f90687SAndriy Gapon 57790f90687SAndriy Gapon /* 578dfdcada3SDoug Rabson * Generic server creation routine. It takes a netconfig structure 579dfdcada3SDoug Rabson * instead of a nettype. 580dfdcada3SDoug Rabson */ 581dfdcada3SDoug Rabson 582dfdcada3SDoug Rabson extern SVCXPRT *svc_tp_create(SVCPOOL *, void (*)(struct svc_req *, SVCXPRT *), 583dfdcada3SDoug Rabson const rpcprog_t, const rpcvers_t, const char *uaddr, 584dfdcada3SDoug Rabson const struct netconfig *); 585dfdcada3SDoug Rabson /* 586dfdcada3SDoug Rabson * void (*dispatch)(); -- dispatch routine 587dfdcada3SDoug Rabson * const rpcprog_t prognum; -- program number 588dfdcada3SDoug Rabson * const rpcvers_t versnum; -- version number 589dfdcada3SDoug Rabson * const char *uaddr; -- universal address of service 590dfdcada3SDoug Rabson * const struct netconfig *nconf; -- netconfig structure 591dfdcada3SDoug Rabson */ 592dfdcada3SDoug Rabson 593dfdcada3SDoug Rabson extern SVCXPRT *svc_dg_create(SVCPOOL *, struct socket *, 594dfdcada3SDoug Rabson const size_t, const size_t); 595dfdcada3SDoug Rabson /* 596dfdcada3SDoug Rabson * struct socket *; -- open connection 597dfdcada3SDoug Rabson * const size_t sendsize; -- max send size 598dfdcada3SDoug Rabson * const size_t recvsize; -- max recv size 599dfdcada3SDoug Rabson */ 600dfdcada3SDoug Rabson 601dfdcada3SDoug Rabson extern SVCXPRT *svc_vc_create(SVCPOOL *, struct socket *, 602dfdcada3SDoug Rabson const size_t, const size_t); 603dfdcada3SDoug Rabson /* 604dfdcada3SDoug Rabson * struct socket *; -- open connection 605dfdcada3SDoug Rabson * const size_t sendsize; -- max send size 606dfdcada3SDoug Rabson * const size_t recvsize; -- max recv size 607dfdcada3SDoug Rabson */ 608dfdcada3SDoug Rabson 609e2adc47dSRick Macklem extern SVCXPRT *svc_vc_create_backchannel(SVCPOOL *); 610e2adc47dSRick Macklem 611c59e4cc3SRick Macklem extern void *clnt_bck_create(struct socket *, const rpcprog_t, const rpcvers_t); 612c59e4cc3SRick Macklem /* 613c59e4cc3SRick Macklem * struct socket *; -- server transport socket 614c59e4cc3SRick Macklem * const rpcprog_t prog; -- RPC program number 615c59e4cc3SRick Macklem * const rpcvers_t vers; -- RPC program version 616c59e4cc3SRick Macklem */ 617c59e4cc3SRick Macklem 618dfdcada3SDoug Rabson /* 619dfdcada3SDoug Rabson * Generic TLI create routine 620dfdcada3SDoug Rabson */ 621*d052fcbdSGleb Smirnoff extern SVCXPRT *svc_tli_create(SVCPOOL *, const struct netconfig *, 622*d052fcbdSGleb Smirnoff const struct t_bind *, const size_t, const size_t); 623dfdcada3SDoug Rabson /* 624dfdcada3SDoug Rabson * const struct netconfig *nconf; -- netconfig structure for network 625dfdcada3SDoug Rabson * const struct t_bind *bindaddr; -- local bind address 626dfdcada3SDoug Rabson * const size_t sendsz; -- max sendsize 627dfdcada3SDoug Rabson * const size_t recvsz; -- max recvsize 628dfdcada3SDoug Rabson */ 629dfdcada3SDoug Rabson __END_DECLS 630dfdcada3SDoug Rabson 631dfdcada3SDoug Rabson #endif /* !_RPC_SVC_H */ 632