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 uint64_t xp_sslsec; /* Userland SSL * */ 155ab0c29afSRick Macklem uint64_t xp_sslusec; 156ab0c29afSRick Macklem uint64_t xp_sslrefno; 157564ed8e8SRick Macklem int xp_sslproc; /* Which upcall daemon being used */ 158ab0c29afSRick Macklem int xp_ngrps; /* Cred. from TLS cert. */ 159ab0c29afSRick Macklem uid_t xp_uid; 160ab0c29afSRick Macklem gid_t *xp_gidp; 161a16ff32fSJohn Baldwin int xp_doneddp; 162dfdcada3SDoug Rabson } SVCXPRT; 163dfdcada3SDoug Rabson 164a9148abdSDoug Rabson /* 165a9148abdSDoug Rabson * Interface to server-side authentication flavors. 166a9148abdSDoug Rabson */ 167a9148abdSDoug Rabson typedef struct __rpc_svcauth { 16820d728b5SMark Johnston const struct svc_auth_ops { 169a9148abdSDoug Rabson int (*svc_ah_wrap)(struct __rpc_svcauth *, struct mbuf **); 170a9148abdSDoug Rabson int (*svc_ah_unwrap)(struct __rpc_svcauth *, struct mbuf **); 171a9148abdSDoug Rabson void (*svc_ah_release)(struct __rpc_svcauth *); 172a9148abdSDoug Rabson } *svc_ah_ops; 173a9148abdSDoug Rabson void *svc_ah_private; 174a9148abdSDoug Rabson } SVCAUTH; 175a9148abdSDoug Rabson 176a9148abdSDoug Rabson /* 177a9148abdSDoug Rabson * Server transport extensions (accessed via xp_p3). 178a9148abdSDoug Rabson */ 179a9148abdSDoug Rabson typedef struct __rpc_svcxprt_ext { 180a9148abdSDoug Rabson int xp_flags; /* versquiet */ 181a9148abdSDoug Rabson SVCAUTH xp_auth; /* interface to auth methods */ 182a9148abdSDoug Rabson } SVCXPRT_EXT; 183a9148abdSDoug Rabson 184dfdcada3SDoug Rabson /* 185dfdcada3SDoug Rabson * The services list 186dfdcada3SDoug Rabson * Each entry represents a set of procedures (an rpc program). 187dfdcada3SDoug Rabson * The dispatch routine takes request structs and runs the 1886244c6e7SPedro F. Giffuni * appropriate procedure. 189dfdcada3SDoug Rabson */ 190dfdcada3SDoug Rabson struct svc_callout { 191dfdcada3SDoug Rabson TAILQ_ENTRY(svc_callout) sc_link; 192dfdcada3SDoug Rabson rpcprog_t sc_prog; 193dfdcada3SDoug Rabson rpcvers_t sc_vers; 194dfdcada3SDoug Rabson char *sc_netid; 195dfdcada3SDoug Rabson void (*sc_dispatch)(struct svc_req *, SVCXPRT *); 196dfdcada3SDoug Rabson }; 197dfdcada3SDoug Rabson TAILQ_HEAD(svc_callout_list, svc_callout); 198dfdcada3SDoug Rabson 199d473bac7SAlexander Motin /* 200d473bac7SAlexander Motin * The services connection loss list 201d473bac7SAlexander Motin * The dispatch routine takes request structs and runs the 2026244c6e7SPedro F. Giffuni * appropriate procedure. 203d473bac7SAlexander Motin */ 204d473bac7SAlexander Motin struct svc_loss_callout { 205d473bac7SAlexander Motin TAILQ_ENTRY(svc_loss_callout) slc_link; 206d473bac7SAlexander Motin void (*slc_dispatch)(SVCXPRT *); 207d473bac7SAlexander Motin }; 208d473bac7SAlexander Motin TAILQ_HEAD(svc_loss_callout_list, svc_loss_callout); 209d473bac7SAlexander Motin 210a9148abdSDoug Rabson /* 211a9148abdSDoug Rabson * Service request 212a9148abdSDoug Rabson */ 213a9148abdSDoug Rabson struct svc_req { 214a9148abdSDoug Rabson STAILQ_ENTRY(svc_req) rq_link; /* list of requests for a thread */ 215a9148abdSDoug Rabson struct __rpc_svcthread *rq_thread; /* thread which is to execute this */ 216a9148abdSDoug Rabson uint32_t rq_xid; /* RPC transaction ID */ 217a9148abdSDoug Rabson uint32_t rq_prog; /* service program number */ 218a9148abdSDoug Rabson uint32_t rq_vers; /* service protocol version */ 219a9148abdSDoug Rabson uint32_t rq_proc; /* the desired procedure */ 220a9148abdSDoug Rabson size_t rq_size; /* space used by request */ 221a9148abdSDoug Rabson struct mbuf *rq_args; /* XDR-encoded procedure arguments */ 222a9148abdSDoug Rabson struct opaque_auth rq_cred; /* raw creds from the wire */ 223a9148abdSDoug Rabson struct opaque_auth rq_verf; /* verifier for the reply */ 224a9148abdSDoug Rabson void *rq_clntcred; /* read only cooked cred */ 225a9148abdSDoug Rabson SVCAUTH rq_auth; /* interface to auth methods */ 226a9148abdSDoug Rabson SVCXPRT *rq_xprt; /* associated transport */ 227a9148abdSDoug Rabson struct sockaddr *rq_addr; /* reply address or NULL if connected */ 228a9148abdSDoug Rabson void *rq_p1; /* application workspace */ 229a9148abdSDoug Rabson int rq_p2; /* application workspace */ 230a9148abdSDoug Rabson uint64_t rq_p3; /* application workspace */ 231d473bac7SAlexander Motin uint32_t rq_reply_seq; /* reply socket sequence # */ 232a9148abdSDoug Rabson char rq_credarea[3*MAX_AUTH_BYTES]; 233a9148abdSDoug Rabson }; 234a9148abdSDoug Rabson STAILQ_HEAD(svc_reqlist, svc_req); 235a9148abdSDoug Rabson 236a9148abdSDoug Rabson #define svc_getrpccaller(rq) \ 237a9148abdSDoug Rabson ((rq)->rq_addr ? (rq)->rq_addr : \ 238a9148abdSDoug Rabson (struct sockaddr *) &(rq)->rq_xprt->xp_rtaddr) 239a9148abdSDoug Rabson 240a9148abdSDoug Rabson /* 241a9148abdSDoug Rabson * This structure is used to manage a thread which is executing 242a9148abdSDoug Rabson * requests from a service pool. A service thread is in one of three 243a9148abdSDoug Rabson * states: 244a9148abdSDoug Rabson * 245a9148abdSDoug Rabson * SVCTHREAD_SLEEPING waiting for a request to process 246a9148abdSDoug Rabson * SVCTHREAD_ACTIVE processing a request 247a9148abdSDoug Rabson * SVCTHREAD_EXITING exiting after finishing current request 248a9148abdSDoug Rabson * 249a9148abdSDoug Rabson * Threads which have no work to process sleep on the pool's sp_active 250a9148abdSDoug Rabson * list. When a transport becomes active, it is assigned a service 251a9148abdSDoug Rabson * thread to read and execute pending RPCs. 252a9148abdSDoug Rabson */ 253a9148abdSDoug Rabson typedef struct __rpc_svcthread { 254b776fb2dSAlexander Motin struct mtx_padalign st_lock; /* protects st_reqs field */ 255f8fb069dSAlexander Motin struct __rpc_svcpool *st_pool; 256a9148abdSDoug Rabson SVCXPRT *st_xprt; /* transport we are processing */ 257a9148abdSDoug Rabson struct svc_reqlist st_reqs; /* RPC requests to execute */ 258a9148abdSDoug Rabson struct cv st_cond; /* sleeping for work */ 259a9148abdSDoug Rabson LIST_ENTRY(__rpc_svcthread) st_ilink; /* idle threads list */ 260a9148abdSDoug Rabson LIST_ENTRY(__rpc_svcthread) st_alink; /* application thread list */ 261f8fb069dSAlexander Motin int st_p2; /* application workspace */ 262f8fb069dSAlexander Motin uint64_t st_p3; /* application workspace */ 263a9148abdSDoug Rabson } SVCTHREAD; 264a9148abdSDoug Rabson LIST_HEAD(svcthread_list, __rpc_svcthread); 265a9148abdSDoug Rabson 266dfdcada3SDoug Rabson /* 267b563304cSAlexander Motin * A thread group contain all information needed to assign subset of 268b563304cSAlexander Motin * transports to subset of threads. On systems with many CPUs and many 269b563304cSAlexander Motin * threads that allows to reduce lock congestion and improve performance. 270b563304cSAlexander Motin * Hundreds of threads on dozens of CPUs sharing the single pool lock do 271b563304cSAlexander Motin * not scale well otherwise. 272b563304cSAlexander Motin */ 273b563304cSAlexander Motin TAILQ_HEAD(svcxprt_list, __rpc_svcxprt); 274b563304cSAlexander Motin enum svcpool_state { 275b563304cSAlexander Motin SVCPOOL_INIT, /* svc_run not called yet */ 276b563304cSAlexander Motin SVCPOOL_ACTIVE, /* normal running state */ 277b563304cSAlexander Motin SVCPOOL_THREADWANTED, /* new service thread requested */ 278b563304cSAlexander Motin SVCPOOL_THREADSTARTING, /* new service thread started */ 279b563304cSAlexander Motin SVCPOOL_CLOSING /* svc_exit called */ 280b563304cSAlexander Motin }; 281b563304cSAlexander Motin typedef struct __rpc_svcgroup { 282b563304cSAlexander Motin struct mtx_padalign sg_lock; /* protect the thread/req lists */ 283b563304cSAlexander Motin struct __rpc_svcpool *sg_pool; 284b563304cSAlexander Motin enum svcpool_state sg_state; /* current pool state */ 285b563304cSAlexander Motin struct svcxprt_list sg_xlist; /* all transports in the group */ 286b563304cSAlexander Motin struct svcxprt_list sg_active; /* transports needing service */ 287b563304cSAlexander Motin struct svcthread_list sg_idlethreads; /* idle service threads */ 288b563304cSAlexander Motin 289b563304cSAlexander Motin int sg_minthreads; /* minimum service thread count */ 290b563304cSAlexander Motin int sg_maxthreads; /* maximum service thread count */ 291b563304cSAlexander Motin int sg_threadcount; /* current service thread count */ 292b563304cSAlexander Motin time_t sg_lastcreatetime; /* when we last started a thread */ 293b563304cSAlexander Motin time_t sg_lastidlecheck; /* when we last checked idle transports */ 294b563304cSAlexander Motin } SVCGROUP; 295b563304cSAlexander Motin 296b563304cSAlexander Motin /* 297dfdcada3SDoug Rabson * In the kernel, we can't use global variables to store lists of 298dfdcada3SDoug Rabson * transports etc. since otherwise we could not have two unrelated RPC 299dfdcada3SDoug Rabson * services running, each on its own thread. We solve this by 300dfdcada3SDoug Rabson * importing a tiny part of a Solaris kernel concept, SVCPOOL. 301dfdcada3SDoug Rabson * 302dfdcada3SDoug Rabson * A service pool contains a set of transports and service callbacks 303dfdcada3SDoug Rabson * for a set of related RPC services. The pool handle should be passed 304dfdcada3SDoug Rabson * when creating new transports etc. Future work may include extending 305dfdcada3SDoug Rabson * this to support something similar to the Solaris multi-threaded RPC 306dfdcada3SDoug Rabson * server. 307dfdcada3SDoug Rabson */ 308a9148abdSDoug Rabson typedef SVCTHREAD *pool_assign_fn(SVCTHREAD *, struct svc_req *); 309a9148abdSDoug Rabson typedef void pool_done_fn(SVCTHREAD *, struct svc_req *); 310b563304cSAlexander Motin #define SVC_MAXGROUPS 16 311dfdcada3SDoug Rabson typedef struct __rpc_svcpool { 312c809a67aSAlexander Motin struct mtx_padalign sp_lock; /* protect the transport lists */ 313a9148abdSDoug Rabson const char *sp_name; /* pool name (e.g. "nfsd", "NLM" */ 314a9148abdSDoug Rabson enum svcpool_state sp_state; /* current pool state */ 315a9148abdSDoug Rabson struct proc *sp_proc; /* process which is in svc_run */ 316dfdcada3SDoug Rabson struct svc_callout_list sp_callouts; /* (prog,vers)->dispatch list */ 317d473bac7SAlexander Motin struct svc_loss_callout_list sp_lcallouts; /* loss->dispatch list */ 318a9148abdSDoug Rabson int sp_minthreads; /* minimum service thread count */ 319a9148abdSDoug Rabson int sp_maxthreads; /* maximum service thread count */ 320a9148abdSDoug Rabson 321a9148abdSDoug Rabson /* 322a9148abdSDoug Rabson * Hooks to allow an application to control request to thread 323a9148abdSDoug Rabson * placement. 324a9148abdSDoug Rabson */ 325a9148abdSDoug Rabson pool_assign_fn *sp_assign; 326a9148abdSDoug Rabson pool_done_fn *sp_done; 327a9148abdSDoug Rabson 328a9148abdSDoug Rabson /* 329a9148abdSDoug Rabson * These variables are used to put an upper bound on the 330a9148abdSDoug Rabson * amount of memory used by RPC requests which are queued 331a9148abdSDoug Rabson * waiting for execution. 332a9148abdSDoug Rabson */ 3333c42b5bfSGarrett Wollman unsigned long sp_space_low; 3343c42b5bfSGarrett Wollman unsigned long sp_space_high; 3353c42b5bfSGarrett Wollman unsigned long sp_space_used; 3363c42b5bfSGarrett Wollman unsigned long sp_space_used_highest; 337a9148abdSDoug Rabson bool_t sp_space_throttled; 338a9148abdSDoug Rabson int sp_space_throttle_count; 339a9148abdSDoug Rabson 340a9148abdSDoug Rabson struct replay_cache *sp_rcache; /* optional replay cache */ 341a9148abdSDoug Rabson struct sysctl_ctx_list sp_sysctl; 342b563304cSAlexander Motin 343b563304cSAlexander Motin int sp_groupcount; /* Number of groups in the pool. */ 344b563304cSAlexander Motin int sp_nextgroup; /* Next group to assign port. */ 345b563304cSAlexander Motin SVCGROUP sp_groups[SVC_MAXGROUPS]; /* Thread/port groups. */ 346dfdcada3SDoug Rabson } SVCPOOL; 347dfdcada3SDoug Rabson 348dfdcada3SDoug Rabson /* 349dfdcada3SDoug Rabson * Operations defined on an SVCXPRT handle 350dfdcada3SDoug Rabson * 351dfdcada3SDoug Rabson * SVCXPRT *xprt; 352dfdcada3SDoug Rabson * struct rpc_msg *msg; 353dfdcada3SDoug Rabson * xdrproc_t xargs; 354dfdcada3SDoug Rabson * void * argsp; 355dfdcada3SDoug Rabson */ 356a9148abdSDoug Rabson #define SVC_ACQUIRE(xprt) \ 357a9148abdSDoug Rabson refcount_acquire(&(xprt)->xp_refs) 358a9148abdSDoug Rabson 359a9148abdSDoug Rabson #define SVC_RELEASE(xprt) \ 360a9148abdSDoug Rabson if (refcount_release(&(xprt)->xp_refs)) \ 361a9148abdSDoug Rabson SVC_DESTROY(xprt) 362a9148abdSDoug Rabson 363a9148abdSDoug Rabson #define SVC_RECV(xprt, msg, addr, args) \ 364a9148abdSDoug Rabson (*(xprt)->xp_ops->xp_recv)((xprt), (msg), (addr), (args)) 365a9148abdSDoug Rabson 366a9148abdSDoug Rabson #define SVC_STAT(xprt) \ 367a9148abdSDoug Rabson (*(xprt)->xp_ops->xp_stat)(xprt) 368a9148abdSDoug Rabson 369d473bac7SAlexander Motin #define SVC_ACK(xprt, ack) \ 3700979970aSAlexander Motin ((xprt)->xp_ops->xp_ack == NULL ? FALSE : \ 371d473bac7SAlexander Motin ((ack) == NULL ? TRUE : (*(xprt)->xp_ops->xp_ack)((xprt), (ack)))) 372d473bac7SAlexander Motin 373d473bac7SAlexander Motin #define SVC_REPLY(xprt, msg, addr, m, seq) \ 374d473bac7SAlexander Motin (*(xprt)->xp_ops->xp_reply) ((xprt), (msg), (addr), (m), (seq)) 375a9148abdSDoug Rabson 376a9148abdSDoug Rabson #define SVC_DESTROY(xprt) \ 377a9148abdSDoug Rabson (*(xprt)->xp_ops->xp_destroy)(xprt) 378a9148abdSDoug Rabson 379a9148abdSDoug Rabson #define SVC_CONTROL(xprt, rq, in) \ 380a9148abdSDoug Rabson (*(xprt)->xp_ops->xp_control)((xprt), (rq), (in)) 381a9148abdSDoug Rabson 382a9148abdSDoug Rabson #define SVC_EXT(xprt) \ 383a9148abdSDoug Rabson ((SVCXPRT_EXT *) xprt->xp_p3) 384a9148abdSDoug Rabson 385a9148abdSDoug Rabson #define SVC_AUTH(xprt) \ 386a9148abdSDoug Rabson (SVC_EXT(xprt)->xp_auth) 387a9148abdSDoug Rabson 388a9148abdSDoug Rabson /* 389a9148abdSDoug Rabson * Operations defined on an SVCAUTH handle 390a9148abdSDoug Rabson */ 391a9148abdSDoug Rabson #define SVCAUTH_WRAP(auth, mp) \ 392a9148abdSDoug Rabson ((auth)->svc_ah_ops->svc_ah_wrap(auth, mp)) 393a9148abdSDoug Rabson #define SVCAUTH_UNWRAP(auth, mp) \ 394a9148abdSDoug Rabson ((auth)->svc_ah_ops->svc_ah_unwrap(auth, mp)) 395a9148abdSDoug Rabson #define SVCAUTH_RELEASE(auth) \ 396a9148abdSDoug Rabson ((auth)->svc_ah_ops->svc_ah_release(auth)) 397dfdcada3SDoug Rabson 398dfdcada3SDoug Rabson /* 399dfdcada3SDoug Rabson * Service registration 400dfdcada3SDoug Rabson * 401dfdcada3SDoug Rabson * svc_reg(xprt, prog, vers, dispatch, nconf) 402dfdcada3SDoug Rabson * const SVCXPRT *xprt; 403dfdcada3SDoug Rabson * const rpcprog_t prog; 404dfdcada3SDoug Rabson * const rpcvers_t vers; 405dfdcada3SDoug Rabson * const void (*dispatch)(); 406dfdcada3SDoug Rabson * const struct netconfig *nconf; 407dfdcada3SDoug Rabson */ 408dfdcada3SDoug Rabson 409dfdcada3SDoug Rabson __BEGIN_DECLS 410dfdcada3SDoug Rabson extern bool_t svc_reg(SVCXPRT *, const rpcprog_t, const rpcvers_t, 411dfdcada3SDoug Rabson void (*)(struct svc_req *, SVCXPRT *), 412dfdcada3SDoug Rabson const struct netconfig *); 413dfdcada3SDoug Rabson __END_DECLS 414dfdcada3SDoug Rabson 415dfdcada3SDoug Rabson /* 416dfdcada3SDoug Rabson * Service un-registration 417dfdcada3SDoug Rabson * 418dfdcada3SDoug Rabson * svc_unreg(prog, vers) 419dfdcada3SDoug Rabson * const rpcprog_t prog; 420dfdcada3SDoug Rabson * const rpcvers_t vers; 421dfdcada3SDoug Rabson */ 422dfdcada3SDoug Rabson 423dfdcada3SDoug Rabson __BEGIN_DECLS 424dfdcada3SDoug Rabson extern void svc_unreg(SVCPOOL *, const rpcprog_t, const rpcvers_t); 425dfdcada3SDoug Rabson __END_DECLS 426dfdcada3SDoug Rabson 427dfdcada3SDoug Rabson /* 428d473bac7SAlexander Motin * Service connection loss registration 429d473bac7SAlexander Motin * 430d473bac7SAlexander Motin * svc_loss_reg(xprt, dispatch) 431d473bac7SAlexander Motin * const SVCXPRT *xprt; 432d473bac7SAlexander Motin * const void (*dispatch)(); 433d473bac7SAlexander Motin */ 434d473bac7SAlexander Motin 435d473bac7SAlexander Motin __BEGIN_DECLS 436d473bac7SAlexander Motin extern bool_t svc_loss_reg(SVCXPRT *, void (*)(SVCXPRT *)); 437d473bac7SAlexander Motin __END_DECLS 438d473bac7SAlexander Motin 439d473bac7SAlexander Motin /* 440d473bac7SAlexander Motin * Service connection loss un-registration 441d473bac7SAlexander Motin * 442d473bac7SAlexander Motin * svc_loss_unreg(xprt, dispatch) 443d473bac7SAlexander Motin * const SVCXPRT *xprt; 444d473bac7SAlexander Motin * const void (*dispatch)(); 445d473bac7SAlexander Motin */ 446d473bac7SAlexander Motin 447d473bac7SAlexander Motin __BEGIN_DECLS 448d473bac7SAlexander Motin extern void svc_loss_unreg(SVCPOOL *, void (*)(SVCXPRT *)); 449d473bac7SAlexander Motin __END_DECLS 450d473bac7SAlexander Motin 451d473bac7SAlexander Motin /* 452dfdcada3SDoug Rabson * Transport registration. 453dfdcada3SDoug Rabson * 454dfdcada3SDoug Rabson * xprt_register(xprt) 455dfdcada3SDoug Rabson * SVCXPRT *xprt; 456dfdcada3SDoug Rabson */ 457dfdcada3SDoug Rabson __BEGIN_DECLS 458dfdcada3SDoug Rabson extern void xprt_register(SVCXPRT *); 459dfdcada3SDoug Rabson __END_DECLS 460dfdcada3SDoug Rabson 461dfdcada3SDoug Rabson /* 462dfdcada3SDoug Rabson * Transport un-register 463dfdcada3SDoug Rabson * 464dfdcada3SDoug Rabson * xprt_unregister(xprt) 465dfdcada3SDoug Rabson * SVCXPRT *xprt; 466dfdcada3SDoug Rabson */ 467dfdcada3SDoug Rabson __BEGIN_DECLS 468dfdcada3SDoug Rabson extern void xprt_unregister(SVCXPRT *); 469dfdcada3SDoug Rabson extern void __xprt_unregister_unlocked(SVCXPRT *); 470dfdcada3SDoug Rabson __END_DECLS 471dfdcada3SDoug Rabson 472dfdcada3SDoug Rabson /* 473dfdcada3SDoug Rabson * Called when a transport has pending requests. 474dfdcada3SDoug Rabson */ 475dfdcada3SDoug Rabson __BEGIN_DECLS 476dfdcada3SDoug Rabson extern void xprt_active(SVCXPRT *); 477dfdcada3SDoug Rabson extern void xprt_inactive(SVCXPRT *); 478a9148abdSDoug Rabson extern void xprt_inactive_locked(SVCXPRT *); 4795c42b9dcSAlexander Motin extern void xprt_inactive_self(SVCXPRT *); 480dfdcada3SDoug Rabson __END_DECLS 481dfdcada3SDoug Rabson 482dfdcada3SDoug Rabson /* 483dfdcada3SDoug Rabson * When the service routine is called, it must first check to see if it 484dfdcada3SDoug Rabson * knows about the procedure; if not, it should call svcerr_noproc 485dfdcada3SDoug Rabson * and return. If so, it should deserialize its arguments via 486dfdcada3SDoug Rabson * SVC_GETARGS (defined above). If the deserialization does not work, 487dfdcada3SDoug Rabson * svcerr_decode should be called followed by a return. Successful 488dfdcada3SDoug Rabson * decoding of the arguments should be followed the execution of the 489dfdcada3SDoug Rabson * procedure's code and a call to svc_sendreply. 490dfdcada3SDoug Rabson * 491dfdcada3SDoug Rabson * Also, if the service refuses to execute the procedure due to too- 492dfdcada3SDoug Rabson * weak authentication parameters, svcerr_weakauth should be called. 493dfdcada3SDoug Rabson * Note: do not confuse access-control failure with weak authentication! 494dfdcada3SDoug Rabson * 495dfdcada3SDoug Rabson * NB: In pure implementations of rpc, the caller always waits for a reply 496dfdcada3SDoug Rabson * msg. This message is sent when svc_sendreply is called. 497dfdcada3SDoug Rabson * Therefore pure service implementations should always call 498dfdcada3SDoug Rabson * svc_sendreply even if the function logically returns void; use 499dfdcada3SDoug Rabson * xdr.h - xdr_void for the xdr routine. HOWEVER, tcp based rpc allows 500dfdcada3SDoug Rabson * for the abuse of pure rpc via batched calling or pipelining. In the 501dfdcada3SDoug Rabson * case of a batched call, svc_sendreply should NOT be called since 502dfdcada3SDoug Rabson * this would send a return message, which is what batching tries to avoid. 503dfdcada3SDoug Rabson * It is the service/protocol writer's responsibility to know which calls are 504dfdcada3SDoug Rabson * batched and which are not. Warning: responding to batch calls may 505dfdcada3SDoug Rabson * deadlock the caller and server processes! 506dfdcada3SDoug Rabson */ 507dfdcada3SDoug Rabson 508dfdcada3SDoug Rabson __BEGIN_DECLS 509a9148abdSDoug Rabson extern bool_t svc_sendreply(struct svc_req *, xdrproc_t, void *); 510a9148abdSDoug Rabson extern bool_t svc_sendreply_mbuf(struct svc_req *, struct mbuf *); 511a9148abdSDoug Rabson extern void svcerr_decode(struct svc_req *); 512a9148abdSDoug Rabson extern void svcerr_weakauth(struct svc_req *); 513a9148abdSDoug Rabson extern void svcerr_noproc(struct svc_req *); 514a9148abdSDoug Rabson extern void svcerr_progvers(struct svc_req *, rpcvers_t, rpcvers_t); 515a9148abdSDoug Rabson extern void svcerr_auth(struct svc_req *, enum auth_stat); 516a9148abdSDoug Rabson extern void svcerr_noprog(struct svc_req *); 517a9148abdSDoug Rabson extern void svcerr_systemerr(struct svc_req *); 518dfdcada3SDoug Rabson extern int rpc_reg(rpcprog_t, rpcvers_t, rpcproc_t, 519dfdcada3SDoug Rabson char *(*)(char *), xdrproc_t, xdrproc_t, 520dfdcada3SDoug Rabson char *); 521dfdcada3SDoug Rabson __END_DECLS 522dfdcada3SDoug Rabson 523dfdcada3SDoug Rabson /* 524dfdcada3SDoug Rabson * Lowest level dispatching -OR- who owns this process anyway. 525dfdcada3SDoug Rabson * Somebody has to wait for incoming requests and then call the correct 526dfdcada3SDoug Rabson * service routine. The routine svc_run does infinite waiting; i.e., 527dfdcada3SDoug Rabson * svc_run never returns. 528631504fbSGordon Bergling * Since another (co-existent) package may wish to selectively wait for 529dfdcada3SDoug Rabson * incoming calls or other events outside of the rpc architecture, the 530dfdcada3SDoug Rabson * routine svc_getreq is provided. It must be passed readfds, the 531dfdcada3SDoug Rabson * "in-place" results of a select system call (see select, section 2). 532dfdcada3SDoug Rabson */ 533dfdcada3SDoug Rabson 534dfdcada3SDoug Rabson /* 535dfdcada3SDoug Rabson * a small program implemented by the svc_rpc implementation itself; 536dfdcada3SDoug Rabson * also see clnt.h for protocol numbers. 537dfdcada3SDoug Rabson */ 538dfdcada3SDoug Rabson __BEGIN_DECLS 539dfdcada3SDoug Rabson extern void rpctest_service(void); 540dfdcada3SDoug Rabson __END_DECLS 541dfdcada3SDoug Rabson 542dfdcada3SDoug Rabson __BEGIN_DECLS 543a9148abdSDoug Rabson extern SVCXPRT *svc_xprt_alloc(void); 544a9148abdSDoug Rabson extern void svc_xprt_free(SVCXPRT *); 545dfdcada3SDoug Rabson extern void svc_run(SVCPOOL *); 546dfdcada3SDoug Rabson extern void svc_exit(SVCPOOL *); 547a9148abdSDoug Rabson extern bool_t svc_getargs(struct svc_req *, xdrproc_t, void *); 548a9148abdSDoug Rabson extern bool_t svc_freeargs(struct svc_req *, xdrproc_t, void *); 549a9148abdSDoug Rabson extern void svc_freereq(struct svc_req *); 550dfdcada3SDoug Rabson __END_DECLS 551dfdcada3SDoug Rabson 552dfdcada3SDoug Rabson /* 553dfdcada3SDoug Rabson * Socket to use on svcxxx_create call to get default socket 554dfdcada3SDoug Rabson */ 555dfdcada3SDoug Rabson #define RPC_ANYSOCK -1 556dfdcada3SDoug Rabson #define RPC_ANYFD RPC_ANYSOCK 557dfdcada3SDoug Rabson 558dfdcada3SDoug Rabson /* 559dfdcada3SDoug Rabson * These are the existing service side transport implementations 560dfdcada3SDoug Rabson */ 561dfdcada3SDoug Rabson 562dfdcada3SDoug Rabson __BEGIN_DECLS 563dfdcada3SDoug Rabson 564dfdcada3SDoug Rabson /* 565dfdcada3SDoug Rabson * Create a new service pool. 566dfdcada3SDoug Rabson */ 567a9148abdSDoug Rabson extern SVCPOOL* svcpool_create(const char *name, 568a9148abdSDoug Rabson struct sysctl_oid_list *sysctl_base); 569dfdcada3SDoug Rabson 570dfdcada3SDoug Rabson /* 571dfdcada3SDoug Rabson * Destroy a service pool, including all registered transports. 572dfdcada3SDoug Rabson */ 573dfdcada3SDoug Rabson extern void svcpool_destroy(SVCPOOL *pool); 574dfdcada3SDoug Rabson 575dfdcada3SDoug Rabson /* 57690f90687SAndriy Gapon * Close a service pool. Similar to svcpool_destroy(), but it does not 57790f90687SAndriy Gapon * free the data structures. As such, the pool can be used again. 57890f90687SAndriy Gapon */ 57990f90687SAndriy Gapon extern void svcpool_close(SVCPOOL *pool); 58090f90687SAndriy Gapon 58190f90687SAndriy Gapon /* 582dfdcada3SDoug Rabson * Generic server creation routine. It takes a netconfig structure 583dfdcada3SDoug Rabson * instead of a nettype. 584dfdcada3SDoug Rabson */ 585dfdcada3SDoug Rabson 586dfdcada3SDoug Rabson extern SVCXPRT *svc_tp_create(SVCPOOL *, void (*)(struct svc_req *, SVCXPRT *), 587dfdcada3SDoug Rabson const rpcprog_t, const rpcvers_t, const char *uaddr, 588dfdcada3SDoug Rabson const struct netconfig *); 589dfdcada3SDoug Rabson /* 590dfdcada3SDoug Rabson * void (*dispatch)(); -- dispatch routine 591dfdcada3SDoug Rabson * const rpcprog_t prognum; -- program number 592dfdcada3SDoug Rabson * const rpcvers_t versnum; -- version number 593dfdcada3SDoug Rabson * const char *uaddr; -- universal address of service 594dfdcada3SDoug Rabson * const struct netconfig *nconf; -- netconfig structure 595dfdcada3SDoug Rabson */ 596dfdcada3SDoug Rabson 597dfdcada3SDoug Rabson extern SVCXPRT *svc_dg_create(SVCPOOL *, struct socket *, 598dfdcada3SDoug Rabson const size_t, const size_t); 599dfdcada3SDoug Rabson /* 600dfdcada3SDoug Rabson * struct socket *; -- open connection 601dfdcada3SDoug Rabson * const size_t sendsize; -- max send size 602dfdcada3SDoug Rabson * const size_t recvsize; -- max recv size 603dfdcada3SDoug Rabson */ 604dfdcada3SDoug Rabson 605dfdcada3SDoug Rabson extern SVCXPRT *svc_vc_create(SVCPOOL *, struct socket *, 606dfdcada3SDoug Rabson const size_t, const size_t); 607dfdcada3SDoug Rabson /* 608dfdcada3SDoug Rabson * struct socket *; -- open connection 609dfdcada3SDoug Rabson * const size_t sendsize; -- max send size 610dfdcada3SDoug Rabson * const size_t recvsize; -- max recv size 611dfdcada3SDoug Rabson */ 612dfdcada3SDoug Rabson 613e2adc47dSRick Macklem extern SVCXPRT *svc_vc_create_backchannel(SVCPOOL *); 614e2adc47dSRick Macklem 615c59e4cc3SRick Macklem extern void *clnt_bck_create(struct socket *, const rpcprog_t, const rpcvers_t); 616c59e4cc3SRick Macklem /* 617c59e4cc3SRick Macklem * struct socket *; -- server transport socket 618c59e4cc3SRick Macklem * const rpcprog_t prog; -- RPC program number 619c59e4cc3SRick Macklem * const rpcvers_t vers; -- RPC program version 620c59e4cc3SRick Macklem */ 621c59e4cc3SRick Macklem 622dfdcada3SDoug Rabson /* 623dfdcada3SDoug Rabson * Generic TLI create routine 624dfdcada3SDoug Rabson */ 625*d052fcbdSGleb Smirnoff extern SVCXPRT *svc_tli_create(SVCPOOL *, const struct netconfig *, 626*d052fcbdSGleb Smirnoff const struct t_bind *, const size_t, const size_t); 627dfdcada3SDoug Rabson /* 628dfdcada3SDoug Rabson * const struct netconfig *nconf; -- netconfig structure for network 629dfdcada3SDoug Rabson * const struct t_bind *bindaddr; -- local bind address 630dfdcada3SDoug Rabson * const size_t sendsz; -- max sendsize 631dfdcada3SDoug Rabson * const size_t recvsz; -- max recvsize 632dfdcada3SDoug Rabson */ 633dfdcada3SDoug Rabson __END_DECLS 634dfdcada3SDoug Rabson 635dfdcada3SDoug Rabson #endif /* !_RPC_SVC_H */ 636