blob: cf61ecd148e01239c1458eab668e152524faa23b [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * linux/include/linux/sunrpc/svc.h
3 *
4 * RPC server declarations.
5 *
6 * Copyright (C) 1995, 1996 Olaf Kirch <okir@monad.swb.de>
7 */
8
9
10#ifndef SUNRPC_SVC_H
11#define SUNRPC_SVC_H
12
13#include <linux/in.h>
Chuck Lever73df0db2007-02-12 00:53:35 -080014#include <linux/in6.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070015#include <linux/sunrpc/types.h>
16#include <linux/sunrpc/xdr.h>
Greg Banks7adae482006-10-04 02:15:47 -070017#include <linux/sunrpc/auth.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070018#include <linux/sunrpc/svcauth.h>
19#include <linux/wait.h>
20#include <linux/mm.h>
21
Greg Banksa7455442006-10-02 02:17:59 -070022/*
23 * This is the RPC server thread function prototype
24 */
Jeff Layton9867d762008-06-10 08:40:38 -040025typedef int (*svc_thread_fn)(void *);
Greg Banks3262c812006-10-02 02:17:58 -070026
Greg Banks03cf6c92009-01-13 21:26:36 +110027/* statistics for svc_pool structures */
28struct svc_pool_stats {
29 unsigned long packets;
30 unsigned long sockets_queued;
31 unsigned long threads_woken;
Greg Banks03cf6c92009-01-13 21:26:36 +110032 unsigned long threads_timedout;
33};
34
Greg Banks3262c812006-10-02 02:17:58 -070035/*
36 *
37 * RPC service thread pool.
38 *
39 * Pool of threads and temporary sockets. Generally there is only
40 * a single one of these per RPC service, but on NUMA machines those
41 * services that can benefit from it (i.e. nfs but not lockd) will
42 * have one pool per NUMA node. This optimisation reduces cross-
43 * node traffic on multi-node NUMA NFS servers.
44 */
45struct svc_pool {
46 unsigned int sp_id; /* pool id; also node id on NUMA */
47 spinlock_t sp_lock; /* protects all fields */
48 struct list_head sp_threads; /* idle server threads */
49 struct list_head sp_sockets; /* pending sockets */
50 unsigned int sp_nrthreads; /* # of threads in pool */
Greg Banksa7455442006-10-02 02:17:59 -070051 struct list_head sp_all_threads; /* all server threads */
Greg Banks03cf6c92009-01-13 21:26:36 +110052 struct svc_pool_stats sp_stats; /* statistics on pool operation */
Andriy Skulysh35525b72013-01-07 00:12:15 +020053 int sp_task_pending;/* has pending task */
Greg Banks3262c812006-10-02 02:17:58 -070054} ____cacheline_aligned_in_smp;
55
Linus Torvalds1da177e2005-04-16 15:20:36 -070056/*
57 * RPC service.
58 *
59 * An RPC service is a ``daemon,'' possibly multithreaded, which
60 * receives and processes incoming RPC messages.
61 * It has one or more transport sockets associated with it, and maintains
62 * a list of idle threads waiting for input.
63 *
64 * We currently do not support more than one RPC program per daemon.
65 */
66struct svc_serv {
Linus Torvalds1da177e2005-04-16 15:20:36 -070067 struct svc_program * sv_program; /* RPC program */
68 struct svc_stat * sv_stats; /* RPC statistics */
69 spinlock_t sv_lock;
70 unsigned int sv_nrthreads; /* # of server threads */
Jeff Laytonc9233eb2008-10-20 11:51:57 -040071 unsigned int sv_maxconn; /* max connections allowed or
72 * '0' causing max to be based
73 * on number of threads. */
74
NeilBrownc6b0a9f2006-10-06 00:44:05 -070075 unsigned int sv_max_payload; /* datagram payload size */
76 unsigned int sv_max_mesg; /* max_payload + 1 page for overheads */
Linus Torvalds1da177e2005-04-16 15:20:36 -070077 unsigned int sv_xdrsize; /* XDR buffer size */
Linus Torvalds1da177e2005-04-16 15:20:36 -070078 struct list_head sv_permsocks; /* all permanent sockets */
79 struct list_head sv_tempsocks; /* all temporary sockets */
80 int sv_tmpcnt; /* count of temporary sockets */
Greg Banks36bdfc82006-10-02 02:17:54 -070081 struct timer_list sv_temptimer; /* timer for aging temporary sockets */
Linus Torvalds1da177e2005-04-16 15:20:36 -070082
83 char * sv_name; /* service name */
NeilBrownbc591cc2006-10-02 02:17:44 -070084
Greg Banks3262c812006-10-02 02:17:58 -070085 unsigned int sv_nrpools; /* number of thread pools */
86 struct svc_pool * sv_pools; /* array of thread pools */
87
Stanislav Kinsbursky5ecebb72012-01-13 14:03:04 +040088 void (*sv_shutdown)(struct svc_serv *serv,
89 struct net *net);
NeilBrownbc591cc2006-10-02 02:17:44 -070090 /* Callback to use when last thread
91 * exits.
92 */
Greg Banksa7455442006-10-02 02:17:59 -070093
94 struct module * sv_module; /* optional module to count when
95 * adding threads */
96 svc_thread_fn sv_function; /* main function for threads */
Trond Myklebust9e00abc2011-07-13 19:20:49 -040097#if defined(CONFIG_SUNRPC_BACKCHANNEL)
Ricardo Labiaga56632b52009-04-01 09:22:58 -040098 struct list_head sv_cb_list; /* queue for callback requests
99 * that arrive over the same
100 * connection */
101 spinlock_t sv_cb_lock; /* protects the svc_cb_list */
102 wait_queue_head_t sv_cb_waitq; /* sleep here if there are no
103 * entries in the svc_cb_list */
Andy Adamson4a19de02011-01-06 02:04:35 +0000104 struct svc_xprt *sv_bc_xprt; /* callback on fore channel */
Trond Myklebust9e00abc2011-07-13 19:20:49 -0400105#endif /* CONFIG_SUNRPC_BACKCHANNEL */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700106};
107
108/*
Greg Banks9a24ab52006-10-02 02:17:58 -0700109 * We use sv_nrthreads as a reference count. svc_destroy() drops
110 * this refcount, so we need to bump it up around operations that
111 * change the number of threads. Horrible, but there it is.
112 * Should be called with the BKL held.
113 */
114static inline void svc_get(struct svc_serv *serv)
115{
116 serv->sv_nrthreads++;
117}
118
119/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120 * Maximum payload size supported by a kernel RPC server.
121 * This is use to determine the max number of pages nfsd is
122 * willing to return in a single READ operation.
Greg Banks7adae482006-10-04 02:15:47 -0700123 *
124 * These happen to all be powers of 2, which is not strictly
125 * necessary but helps enforce the real limitation, which is
126 * that they should be multiples of PAGE_CACHE_SIZE.
127 *
128 * For UDP transports, a block plus NFS,RPC, and UDP headers
129 * has to fit into the IP datagram limit of 64K. The largest
130 * feasible number for all known page sizes is probably 48K,
131 * but we choose 32K here. This is the same as the historical
132 * Linux limit; someone who cares more about NFS/UDP performance
133 * can test a larger number.
134 *
135 * For TCP transports we have more freedom. A size of 1MB is
136 * chosen to match the client limit. Other OSes are known to
137 * have larger limits, but those numbers are probably beyond
138 * the point of diminishing returns.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700139 */
Greg Banks7adae482006-10-04 02:15:47 -0700140#define RPCSVC_MAXPAYLOAD (1*1024*1024u)
141#define RPCSVC_MAXPAYLOAD_TCP RPCSVC_MAXPAYLOAD
142#define RPCSVC_MAXPAYLOAD_UDP (32*1024u)
143
144extern u32 svc_max_payload(const struct svc_rqst *rqstp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700145
146/*
147 * RPC Requsts and replies are stored in one or more pages.
148 * We maintain an array of pages for each server thread.
149 * Requests are copied into these pages as they arrive. Remaining
150 * pages are available to write the reply into.
151 *
152 * Pages are sent using ->sendpage so each server thread needs to
153 * allocate more to replace those used in sending. To help keep track
154 * of these pages we have a receive list where all pages initialy live,
155 * and a send list where pages are moved to when there are to be part
156 * of a reply.
157 *
158 * We use xdr_buf for holding responses as it fits well with NFS
159 * read responses (that have a header, and some data pages, and possibly
160 * a tail) and means we can share some client side routines.
161 *
162 * The xdr_buf.head kvec always points to the first page in the rq_*pages
163 * list. The xdr_buf.pages pointer points to the second page on that
164 * list. xdr_buf.tail points to the end of the first page.
165 * This assumes that the non-page part of an rpc reply will fit
166 * in a page - NFSd ensures this. lockd also has no trouble.
167 *
168 * Each request/reply pair can have at most one "payload", plus two pages,
169 * one for the request, and one for the reply.
NeilBrown250f3912007-01-26 00:56:59 -0800170 * We using ->sendfile to return read data, we might need one extra page
171 * if the request is not page-aligned. So add another '1'.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700172 */
NeilBrown250f3912007-01-26 00:56:59 -0800173#define RPCSVC_MAXPAGES ((RPCSVC_MAXPAYLOAD+PAGE_SIZE-1)/PAGE_SIZE \
174 + 2 + 1)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700175
Alexey Dobriyan76994312006-09-26 22:28:46 -0700176static inline u32 svc_getnl(struct kvec *iov)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700177{
Alexey Dobriyan76994312006-09-26 22:28:46 -0700178 __be32 val, *vp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700179 vp = iov->iov_base;
180 val = *vp++;
181 iov->iov_base = (void*)vp;
Alexey Dobriyan76994312006-09-26 22:28:46 -0700182 iov->iov_len -= sizeof(__be32);
183 return ntohl(val);
184}
185
186static inline void svc_putnl(struct kvec *iov, u32 val)
187{
188 __be32 *vp = iov->iov_base + iov->iov_len;
189 *vp = htonl(val);
190 iov->iov_len += sizeof(__be32);
191}
192
193static inline __be32 svc_getu32(struct kvec *iov)
194{
195 __be32 val, *vp;
196 vp = iov->iov_base;
197 val = *vp++;
198 iov->iov_base = (void*)vp;
199 iov->iov_len -= sizeof(__be32);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700200 return val;
201}
202
203static inline void svc_ungetu32(struct kvec *iov)
204{
Alexey Dobriyan76994312006-09-26 22:28:46 -0700205 __be32 *vp = (__be32 *)iov->iov_base;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700206 iov->iov_base = (void *)(vp - 1);
207 iov->iov_len += sizeof(*vp);
208}
209
Alexey Dobriyan76994312006-09-26 22:28:46 -0700210static inline void svc_putu32(struct kvec *iov, __be32 val)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700211{
Alexey Dobriyan76994312006-09-26 22:28:46 -0700212 __be32 *vp = iov->iov_base + iov->iov_len;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700213 *vp = val;
Alexey Dobriyan76994312006-09-26 22:28:46 -0700214 iov->iov_len += sizeof(__be32);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700215}
216
Linus Torvalds1da177e2005-04-16 15:20:36 -0700217/*
218 * The context of a single thread, including the request currently being
219 * processed.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220 */
221struct svc_rqst {
222 struct list_head rq_list; /* idle list */
Greg Banksa7455442006-10-02 02:17:59 -0700223 struct list_head rq_all; /* all threads list */
Tom Tucker57b1d3b2007-12-30 21:08:22 -0600224 struct svc_xprt * rq_xprt; /* transport ptr */
Mi Jinlong849a1cf2011-08-30 17:18:41 +0800225
Chuck Lever27459f02007-02-12 00:53:34 -0800226 struct sockaddr_storage rq_addr; /* peer address */
227 size_t rq_addrlen;
Mi Jinlong849a1cf2011-08-30 17:18:41 +0800228 struct sockaddr_storage rq_daddr; /* dest addr of request
229 * - reply from here */
230 size_t rq_daddrlen;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700231
232 struct svc_serv * rq_server; /* RPC service definition */
Greg Banks3262c812006-10-02 02:17:58 -0700233 struct svc_pool * rq_pool; /* thread pool */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234 struct svc_procedure * rq_procinfo; /* procedure info */
235 struct auth_ops * rq_authop; /* authentication flavour */
236 struct svc_cred rq_cred; /* auth info */
Tom Tucker5148bf42007-12-30 21:07:25 -0600237 void * rq_xprt_ctxt; /* transport specific context ptr */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700238 struct svc_deferred_req*rq_deferred; /* deferred request we are replaying */
Kinglong Meef15a5cf2014-06-10 18:29:39 +0800239 bool rq_usedeferral; /* use deferral */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700240
Tom Tucker260c1d12007-12-30 21:08:29 -0600241 size_t rq_xprt_hlen; /* xprt header len */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700242 struct xdr_buf rq_arg;
243 struct xdr_buf rq_res;
NeilBrown44524352006-10-04 02:15:46 -0700244 struct page * rq_pages[RPCSVC_MAXPAGES];
245 struct page * *rq_respages; /* points into rq_pages */
J. Bruce Fieldsafc59402012-12-10 18:01:37 -0500246 struct page * *rq_next_page; /* next reply page to use */
J. Bruce Fields2825a7f2013-08-26 16:04:46 -0400247 struct page * *rq_page_end; /* one past the last page */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700248
NeilBrown3cc03b12006-10-04 02:15:47 -0700249 struct kvec rq_vec[RPCSVC_MAXPAGES]; /* generally useful.. */
250
Alexey Dobriyand8ed0292006-09-26 22:29:38 -0700251 __be32 rq_xid; /* transmission id */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700252 u32 rq_prog; /* program number */
253 u32 rq_vers; /* program version */
254 u32 rq_proc; /* procedure number */
255 u32 rq_prot; /* IP protocol */
256 unsigned short
257 rq_secure : 1; /* secure port */
NeilBrownef11ce22014-05-12 11:22:47 +1000258 unsigned short rq_local : 1; /* local request */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700259
Linus Torvalds1da177e2005-04-16 15:20:36 -0700260 void * rq_argp; /* decoded arguments */
261 void * rq_resp; /* xdr'd results */
262 void * rq_auth_data; /* flavor-specific data */
J. Bruce Fieldsa5cddc82014-05-12 18:10:58 -0400263 int rq_auth_slack; /* extra space xdr code
264 * should leave in head
265 * for krb5i, krb5p.
266 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700267 int rq_reserved; /* space on socket outq
268 * reserved for this request
269 */
270
271 struct cache_req rq_chandle; /* handle passed to caches for
272 * request delaying
273 */
J. Bruce Fields9e701c62011-01-02 21:56:36 -0500274 bool rq_dropme;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700275 /* Catering to nfsd */
276 struct auth_domain * rq_client; /* RPC peer info */
J. Bruce Fields3ab4d8b2007-07-17 04:04:46 -0700277 struct auth_domain * rq_gssclient; /* "gss/"-style peer info */
J. Bruce Fields10910062011-01-24 12:11:02 -0500278 int rq_cachetype;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700279 struct svc_cacherep * rq_cacherep; /* cache info */
Kinglong Meef15a5cf2014-06-10 18:29:39 +0800280 bool rq_splice_ok; /* turned off in gss privacy
J. Bruce Fields5c04c462006-06-30 01:56:19 -0700281 * to prevent encrypting page
282 * cache pages */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700283 wait_queue_head_t rq_wait; /* synchronization */
Greg Banksa7455442006-10-02 02:17:59 -0700284 struct task_struct *rq_task; /* service thread */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700285};
286
Stanislav Kinsbursky9695c702012-07-25 16:57:06 +0400287#define SVC_NET(svc_rqst) (svc_rqst->rq_xprt->xpt_net)
288
Linus Torvalds1da177e2005-04-16 15:20:36 -0700289/*
Chuck Lever27459f02007-02-12 00:53:34 -0800290 * Rigorous type checking on sockaddr type conversions
291 */
Chuck Lever5344b122008-08-27 16:57:46 -0400292static inline struct sockaddr_in *svc_addr_in(const struct svc_rqst *rqst)
Chuck Lever27459f02007-02-12 00:53:34 -0800293{
294 return (struct sockaddr_in *) &rqst->rq_addr;
295}
296
Chuck Lever5344b122008-08-27 16:57:46 -0400297static inline struct sockaddr_in6 *svc_addr_in6(const struct svc_rqst *rqst)
Chuck Lever95756482007-02-12 00:53:38 -0800298{
299 return (struct sockaddr_in6 *) &rqst->rq_addr;
300}
301
Chuck Lever5344b122008-08-27 16:57:46 -0400302static inline struct sockaddr *svc_addr(const struct svc_rqst *rqst)
Chuck Lever27459f02007-02-12 00:53:34 -0800303{
304 return (struct sockaddr *) &rqst->rq_addr;
305}
306
Mi Jinlong849a1cf2011-08-30 17:18:41 +0800307static inline struct sockaddr_in *svc_daddr_in(const struct svc_rqst *rqst)
308{
309 return (struct sockaddr_in *) &rqst->rq_daddr;
310}
311
312static inline struct sockaddr_in6 *svc_daddr_in6(const struct svc_rqst *rqst)
313{
314 return (struct sockaddr_in6 *) &rqst->rq_daddr;
315}
316
317static inline struct sockaddr *svc_daddr(const struct svc_rqst *rqst)
318{
319 return (struct sockaddr *) &rqst->rq_daddr;
320}
321
Chuck Lever27459f02007-02-12 00:53:34 -0800322/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700323 * Check buffer bounds after decoding arguments
324 */
325static inline int
Alexey Dobriyand8ed0292006-09-26 22:29:38 -0700326xdr_argsize_check(struct svc_rqst *rqstp, __be32 *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700327{
328 char *cp = (char *)p;
329 struct kvec *vec = &rqstp->rq_arg.head[0];
NeilBrown0ba75362005-11-07 01:00:26 -0800330 return cp >= (char*)vec->iov_base
331 && cp <= (char*)vec->iov_base + vec->iov_len;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700332}
333
334static inline int
Alexey Dobriyand8ed0292006-09-26 22:29:38 -0700335xdr_ressize_check(struct svc_rqst *rqstp, __be32 *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700336{
337 struct kvec *vec = &rqstp->rq_res.head[0];
338 char *cp = (char*)p;
339
340 vec->iov_len = cp - (char*)vec->iov_base;
341
342 return vec->iov_len <= PAGE_SIZE;
343}
344
NeilBrown44524352006-10-04 02:15:46 -0700345static inline void svc_free_res_pages(struct svc_rqst *rqstp)
Andreas Gruenbachera257cdd2005-06-22 17:16:26 +0000346{
J. Bruce Fieldsafc59402012-12-10 18:01:37 -0500347 while (rqstp->rq_next_page != rqstp->rq_respages) {
348 struct page **pp = --rqstp->rq_next_page;
NeilBrown44524352006-10-04 02:15:46 -0700349 if (*pp) {
350 put_page(*pp);
351 *pp = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352 }
353 }
354}
355
Linus Torvalds1da177e2005-04-16 15:20:36 -0700356struct svc_deferred_req {
357 u32 prot; /* protocol (UDP or TCP) */
Tom Tucker8c7b0172007-12-30 21:08:10 -0600358 struct svc_xprt *xprt;
Chuck Lever24422222007-02-12 00:53:33 -0800359 struct sockaddr_storage addr; /* where reply must go */
360 size_t addrlen;
Mi Jinlong849a1cf2011-08-30 17:18:41 +0800361 struct sockaddr_storage daddr; /* where reply must come from */
362 size_t daddrlen;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700363 struct cache_deferred_req handle;
Tom Tucker260c1d12007-12-30 21:08:29 -0600364 size_t xprt_hlen;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700365 int argslen;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -0700366 __be32 args[0];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700367};
368
369/*
Andreas Gruenbacher9ba02632005-06-22 17:16:24 +0000370 * List of RPC programs on the same transport endpoint
Linus Torvalds1da177e2005-04-16 15:20:36 -0700371 */
372struct svc_program {
Andreas Gruenbacher9ba02632005-06-22 17:16:24 +0000373 struct svc_program * pg_next; /* other programs (same xprt) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700374 u32 pg_prog; /* program number */
375 unsigned int pg_lovers; /* lowest version */
Weng Meiling28303ca2013-11-30 17:56:44 +0800376 unsigned int pg_hivers; /* highest version */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700377 unsigned int pg_nvers; /* number of versions */
378 struct svc_version ** pg_vers; /* version array */
379 char * pg_name; /* service name */
380 char * pg_class; /* class name: services sharing authentication */
381 struct svc_stat * pg_stats; /* rpc statistics */
382 int (*pg_authenticate)(struct svc_rqst *);
383};
384
385/*
386 * RPC program version
387 */
388struct svc_version {
389 u32 vs_vers; /* version number */
390 u32 vs_nproc; /* number of procedures */
391 struct svc_procedure * vs_proc; /* per-procedure info */
392 u32 vs_xdrsize; /* xdrsize needed for this version */
393
Kinglong Mee7e55b592013-12-31 13:17:20 +0800394 unsigned int vs_hidden : 1, /* Don't register with portmapper.
Olaf Kirchbc5fea42006-10-04 02:16:05 -0700395 * Only used for nfsacl so far. */
Kinglong Mee7e55b592013-12-31 13:17:20 +0800396 vs_rpcb_optnl:1;/* Don't care the result of register.
397 * Only used for nfsv4. */
Olaf Kirchbc5fea42006-10-04 02:16:05 -0700398
Linus Torvalds1da177e2005-04-16 15:20:36 -0700399 /* Override dispatch function (e.g. when caching replies).
400 * A return value of 0 means drop the request.
401 * vs_dispatch == NULL means use default dispatcher.
402 */
Alexey Dobriyand8ed0292006-09-26 22:29:38 -0700403 int (*vs_dispatch)(struct svc_rqst *, __be32 *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700404};
405
406/*
407 * RPC procedure info
408 */
Al Viro7111c662006-10-19 23:28:45 -0700409typedef __be32 (*svc_procfunc)(struct svc_rqst *, void *argp, void *resp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700410struct svc_procedure {
411 svc_procfunc pc_func; /* process the request */
412 kxdrproc_t pc_decode; /* XDR decode args */
413 kxdrproc_t pc_encode; /* XDR encode result */
414 kxdrproc_t pc_release; /* XDR free result */
415 unsigned int pc_argsize; /* argument struct size */
416 unsigned int pc_ressize; /* result struct size */
417 unsigned int pc_count; /* call count */
418 unsigned int pc_cachetype; /* cache info (NFS) */
419 unsigned int pc_xdrressize; /* maximum size of XDR reply */
420};
421
422/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700423 * Function prototypes.
424 */
Stanislav Kinsburskybb2224d2012-01-31 15:08:05 +0400425int svc_rpcb_setup(struct svc_serv *serv, struct net *net);
Stanislav Kinsbursky5ecebb72012-01-13 14:03:04 +0400426void svc_rpcb_cleanup(struct svc_serv *serv, struct net *net);
Stanislav Kinsbursky9793f7c2012-05-02 16:08:38 +0400427int svc_bind(struct svc_serv *serv, struct net *net);
Chuck Lever49a90722009-03-18 20:46:29 -0400428struct svc_serv *svc_create(struct svc_program *, unsigned int,
Stanislav Kinsbursky5ecebb72012-01-13 14:03:04 +0400429 void (*shutdown)(struct svc_serv *, struct net *net));
Jeff Layton0113ab32008-01-29 10:30:54 -0500430struct svc_rqst *svc_prepare_thread(struct svc_serv *serv,
Eric Dumazet11fd1652011-07-28 20:04:09 +0200431 struct svc_pool *pool, int node);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700432void svc_exit_thread(struct svc_rqst *);
Greg Banksa7455442006-10-02 02:17:59 -0700433struct svc_serv * svc_create_pooled(struct svc_program *, unsigned int,
Stanislav Kinsbursky5ecebb72012-01-13 14:03:04 +0400434 void (*shutdown)(struct svc_serv *, struct net *net),
Chuck Levere851db52008-06-30 18:45:30 -0400435 svc_thread_fn, struct module *);
Greg Banksa7455442006-10-02 02:17:59 -0700436int svc_set_num_threads(struct svc_serv *, struct svc_pool *, int);
Greg Banks03cf6c92009-01-13 21:26:36 +1100437int svc_pool_stats_open(struct svc_serv *serv, struct file *file);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700438void svc_destroy(struct svc_serv *);
Stanislav Kinsburskybb2224d2012-01-31 15:08:05 +0400439void svc_shutdown_net(struct svc_serv *, struct net *);
NeilBrown6fb2b472006-10-02 02:17:50 -0700440int svc_process(struct svc_rqst *);
Ricardo Labiaga4d6bbb62009-04-01 09:23:07 -0400441int bc_svc_process(struct svc_serv *, struct rpc_rqst *,
442 struct svc_rqst *);
Stanislav Kinsbursky5247fab2012-01-13 14:02:48 +0400443int svc_register(const struct svc_serv *, struct net *, const int,
Chuck Lever4b62e582009-03-18 20:46:06 -0400444 const unsigned short, const unsigned short);
Chuck Levera26cfad2008-08-18 19:34:16 -0400445
Linus Torvalds1da177e2005-04-16 15:20:36 -0700446void svc_wake_up(struct svc_serv *);
447void svc_reserve(struct svc_rqst *rqstp, int space);
Greg Banksbfd24162006-10-02 02:18:01 -0700448struct svc_pool * svc_pool_for_cpu(struct svc_serv *serv, int cpu);
Chuck Leverad06e4b2007-02-12 00:53:32 -0800449char * svc_print_addr(struct svc_rqst *, char *, size_t);
450
451#define RPC_MAX_ADDRBUFLEN (63U)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700452
Jeff Laytoncd123012007-05-09 02:34:50 -0700453/*
454 * When we want to reduce the size of the reserved space in the response
455 * buffer, we need to take into account the size of any checksum data that
456 * may be at the end of the packet. This is difficult to determine exactly
457 * for all cases without actually generating the checksum, so we just use a
458 * static value.
459 */
J. Bruce Fieldsfbb78782008-02-07 23:10:21 -0500460static inline void svc_reserve_auth(struct svc_rqst *rqstp, int space)
Jeff Laytoncd123012007-05-09 02:34:50 -0700461{
J. Bruce Fieldsa5cddc82014-05-12 18:10:58 -0400462 svc_reserve(rqstp, space + rqstp->rq_auth_slack);
Jeff Laytoncd123012007-05-09 02:34:50 -0700463}
464
Linus Torvalds1da177e2005-04-16 15:20:36 -0700465#endif /* SUNRPC_SVC_H */