2 * linux/include/linux/sunrpc/svc.h
4 * RPC server declarations.
6 * Copyright (C) 1995, 1996 Olaf Kirch <okir@monad.swb.de>
14 #include <linux/in6.h>
15 #include <linux/sunrpc/types.h>
16 #include <linux/sunrpc/xdr.h>
17 #include <linux/sunrpc/auth.h>
18 #include <linux/sunrpc/svcauth.h>
19 #include <linux/wait.h>
23 * This is the RPC server thread function prototype
25 typedef int (*svc_thread_fn
)(void *);
27 /* statistics for svc_pool structures */
28 struct svc_pool_stats
{
29 unsigned long packets
;
30 unsigned long sockets_queued
;
31 unsigned long threads_woken
;
32 unsigned long overloads_avoided
;
33 unsigned long threads_timedout
;
38 * RPC service thread pool.
40 * Pool of threads and temporary sockets. Generally there is only
41 * a single one of these per RPC service, but on NUMA machines those
42 * services that can benefit from it (i.e. nfs but not lockd) will
43 * have one pool per NUMA node. This optimisation reduces cross-
44 * node traffic on multi-node NUMA NFS servers.
47 unsigned int sp_id
; /* pool id; also node id on NUMA */
48 spinlock_t sp_lock
; /* protects all fields */
49 struct list_head sp_threads
; /* idle server threads */
50 struct list_head sp_sockets
; /* pending sockets */
51 unsigned int sp_nrthreads
; /* # of threads in pool */
52 struct list_head sp_all_threads
; /* all server threads */
53 int sp_nwaking
; /* number of threads woken but not yet active */
54 struct svc_pool_stats sp_stats
; /* statistics on pool operation */
55 } ____cacheline_aligned_in_smp
;
60 * An RPC service is a ``daemon,'' possibly multithreaded, which
61 * receives and processes incoming RPC messages.
62 * It has one or more transport sockets associated with it, and maintains
63 * a list of idle threads waiting for input.
65 * We currently do not support more than one RPC program per daemon.
68 struct svc_program
* sv_program
; /* RPC program */
69 struct svc_stat
* sv_stats
; /* RPC statistics */
71 unsigned int sv_nrthreads
; /* # of server threads */
72 unsigned int sv_maxconn
; /* max connections allowed or
73 * '0' causing max to be based
74 * on number of threads. */
76 unsigned int sv_max_payload
; /* datagram payload size */
77 unsigned int sv_max_mesg
; /* max_payload + 1 page for overheads */
78 unsigned int sv_xdrsize
; /* XDR buffer size */
79 struct list_head sv_permsocks
; /* all permanent sockets */
80 struct list_head sv_tempsocks
; /* all temporary sockets */
81 int sv_tmpcnt
; /* count of temporary sockets */
82 struct timer_list sv_temptimer
; /* timer for aging temporary sockets */
83 sa_family_t sv_family
; /* listener's address family */
85 char * sv_name
; /* service name */
87 unsigned int sv_nrpools
; /* number of thread pools */
88 struct svc_pool
* sv_pools
; /* array of thread pools */
90 void (*sv_shutdown
)(struct svc_serv
*serv
);
91 /* Callback to use when last thread
95 struct module
* sv_module
; /* optional module to count when
97 svc_thread_fn sv_function
; /* main function for threads */
101 * We use sv_nrthreads as a reference count. svc_destroy() drops
102 * this refcount, so we need to bump it up around operations that
103 * change the number of threads. Horrible, but there it is.
104 * Should be called with the BKL held.
106 static inline void svc_get(struct svc_serv
*serv
)
108 serv
->sv_nrthreads
++;
112 * Maximum payload size supported by a kernel RPC server.
113 * This is use to determine the max number of pages nfsd is
114 * willing to return in a single READ operation.
116 * These happen to all be powers of 2, which is not strictly
117 * necessary but helps enforce the real limitation, which is
118 * that they should be multiples of PAGE_CACHE_SIZE.
120 * For UDP transports, a block plus NFS,RPC, and UDP headers
121 * has to fit into the IP datagram limit of 64K. The largest
122 * feasible number for all known page sizes is probably 48K,
123 * but we choose 32K here. This is the same as the historical
124 * Linux limit; someone who cares more about NFS/UDP performance
125 * can test a larger number.
127 * For TCP transports we have more freedom. A size of 1MB is
128 * chosen to match the client limit. Other OSes are known to
129 * have larger limits, but those numbers are probably beyond
130 * the point of diminishing returns.
132 #define RPCSVC_MAXPAYLOAD (1*1024*1024u)
133 #define RPCSVC_MAXPAYLOAD_TCP RPCSVC_MAXPAYLOAD
134 #define RPCSVC_MAXPAYLOAD_UDP (32*1024u)
136 extern u32
svc_max_payload(const struct svc_rqst
*rqstp
);
139 * RPC Requsts and replies are stored in one or more pages.
140 * We maintain an array of pages for each server thread.
141 * Requests are copied into these pages as they arrive. Remaining
142 * pages are available to write the reply into.
144 * Pages are sent using ->sendpage so each server thread needs to
145 * allocate more to replace those used in sending. To help keep track
146 * of these pages we have a receive list where all pages initialy live,
147 * and a send list where pages are moved to when there are to be part
150 * We use xdr_buf for holding responses as it fits well with NFS
151 * read responses (that have a header, and some data pages, and possibly
152 * a tail) and means we can share some client side routines.
154 * The xdr_buf.head kvec always points to the first page in the rq_*pages
155 * list. The xdr_buf.pages pointer points to the second page on that
156 * list. xdr_buf.tail points to the end of the first page.
157 * This assumes that the non-page part of an rpc reply will fit
158 * in a page - NFSd ensures this. lockd also has no trouble.
160 * Each request/reply pair can have at most one "payload", plus two pages,
161 * one for the request, and one for the reply.
162 * We using ->sendfile to return read data, we might need one extra page
163 * if the request is not page-aligned. So add another '1'.
165 #define RPCSVC_MAXPAGES ((RPCSVC_MAXPAYLOAD+PAGE_SIZE-1)/PAGE_SIZE \
168 static inline u32
svc_getnl(struct kvec
*iov
)
173 iov
->iov_base
= (void*)vp
;
174 iov
->iov_len
-= sizeof(__be32
);
178 static inline void svc_putnl(struct kvec
*iov
, u32 val
)
180 __be32
*vp
= iov
->iov_base
+ iov
->iov_len
;
182 iov
->iov_len
+= sizeof(__be32
);
185 static inline __be32
svc_getu32(struct kvec
*iov
)
190 iov
->iov_base
= (void*)vp
;
191 iov
->iov_len
-= sizeof(__be32
);
195 static inline void svc_ungetu32(struct kvec
*iov
)
197 __be32
*vp
= (__be32
*)iov
->iov_base
;
198 iov
->iov_base
= (void *)(vp
- 1);
199 iov
->iov_len
+= sizeof(*vp
);
202 static inline void svc_putu32(struct kvec
*iov
, __be32 val
)
204 __be32
*vp
= iov
->iov_base
+ iov
->iov_len
;
206 iov
->iov_len
+= sizeof(__be32
);
211 struct in6_addr addr6
;
215 * The context of a single thread, including the request currently being
219 struct list_head rq_list
; /* idle list */
220 struct list_head rq_all
; /* all threads list */
221 struct svc_xprt
* rq_xprt
; /* transport ptr */
222 struct sockaddr_storage rq_addr
; /* peer address */
225 struct svc_serv
* rq_server
; /* RPC service definition */
226 struct svc_pool
* rq_pool
; /* thread pool */
227 struct svc_procedure
* rq_procinfo
; /* procedure info */
228 struct auth_ops
* rq_authop
; /* authentication flavour */
229 u32 rq_flavor
; /* pseudoflavor */
230 struct svc_cred rq_cred
; /* auth info */
231 void * rq_xprt_ctxt
; /* transport specific context ptr */
232 struct svc_deferred_req
*rq_deferred
; /* deferred request we are replaying */
234 size_t rq_xprt_hlen
; /* xprt header len */
235 struct xdr_buf rq_arg
;
236 struct xdr_buf rq_res
;
237 struct page
* rq_pages
[RPCSVC_MAXPAGES
];
238 struct page
* *rq_respages
; /* points into rq_pages */
239 int rq_resused
; /* number of pages used for result */
241 struct kvec rq_vec
[RPCSVC_MAXPAGES
]; /* generally useful.. */
243 __be32 rq_xid
; /* transmission id */
244 u32 rq_prog
; /* program number */
245 u32 rq_vers
; /* program version */
246 u32 rq_proc
; /* procedure number */
247 u32 rq_prot
; /* IP protocol */
249 rq_secure
: 1; /* secure port */
251 union svc_addr_u rq_daddr
; /* dest addr of request
252 * - reply from here */
254 void * rq_argp
; /* decoded arguments */
255 void * rq_resp
; /* xdr'd results */
256 void * rq_auth_data
; /* flavor-specific data */
258 int rq_reserved
; /* space on socket outq
259 * reserved for this request
262 struct cache_req rq_chandle
; /* handle passed to caches for
265 /* Catering to nfsd */
266 struct auth_domain
* rq_client
; /* RPC peer info */
267 struct auth_domain
* rq_gssclient
; /* "gss/"-style peer info */
268 struct svc_cacherep
* rq_cacherep
; /* cache info */
269 struct knfsd_fh
* rq_reffh
; /* Referrence filehandle, used to
270 * determine what device number
271 * to report (real or virtual)
273 int rq_splice_ok
; /* turned off in gss privacy
274 * to prevent encrypting page
276 wait_queue_head_t rq_wait
; /* synchronization */
277 struct task_struct
*rq_task
; /* service thread */
278 int rq_waking
; /* 1 if thread is being woken */
282 * Rigorous type checking on sockaddr type conversions
284 static inline struct sockaddr_in
*svc_addr_in(const struct svc_rqst
*rqst
)
286 return (struct sockaddr_in
*) &rqst
->rq_addr
;
289 static inline struct sockaddr_in6
*svc_addr_in6(const struct svc_rqst
*rqst
)
291 return (struct sockaddr_in6
*) &rqst
->rq_addr
;
294 static inline struct sockaddr
*svc_addr(const struct svc_rqst
*rqst
)
296 return (struct sockaddr
*) &rqst
->rq_addr
;
300 * Check buffer bounds after decoding arguments
303 xdr_argsize_check(struct svc_rqst
*rqstp
, __be32
*p
)
305 char *cp
= (char *)p
;
306 struct kvec
*vec
= &rqstp
->rq_arg
.head
[0];
307 return cp
>= (char*)vec
->iov_base
308 && cp
<= (char*)vec
->iov_base
+ vec
->iov_len
;
312 xdr_ressize_check(struct svc_rqst
*rqstp
, __be32
*p
)
314 struct kvec
*vec
= &rqstp
->rq_res
.head
[0];
317 vec
->iov_len
= cp
- (char*)vec
->iov_base
;
319 return vec
->iov_len
<= PAGE_SIZE
;
322 static inline void svc_free_res_pages(struct svc_rqst
*rqstp
)
324 while (rqstp
->rq_resused
) {
325 struct page
**pp
= (rqstp
->rq_respages
+
326 --rqstp
->rq_resused
);
334 struct svc_deferred_req
{
335 u32 prot
; /* protocol (UDP or TCP) */
336 struct svc_xprt
*xprt
;
337 struct sockaddr_storage addr
; /* where reply must go */
339 union svc_addr_u daddr
; /* where reply must come from */
340 struct cache_deferred_req handle
;
347 * List of RPC programs on the same transport endpoint
350 struct svc_program
* pg_next
; /* other programs (same xprt) */
351 u32 pg_prog
; /* program number */
352 unsigned int pg_lovers
; /* lowest version */
353 unsigned int pg_hivers
; /* lowest version */
354 unsigned int pg_nvers
; /* number of versions */
355 struct svc_version
** pg_vers
; /* version array */
356 char * pg_name
; /* service name */
357 char * pg_class
; /* class name: services sharing authentication */
358 struct svc_stat
* pg_stats
; /* rpc statistics */
359 int (*pg_authenticate
)(struct svc_rqst
*);
363 * RPC program version
366 u32 vs_vers
; /* version number */
367 u32 vs_nproc
; /* number of procedures */
368 struct svc_procedure
* vs_proc
; /* per-procedure info */
369 u32 vs_xdrsize
; /* xdrsize needed for this version */
371 unsigned int vs_hidden
: 1; /* Don't register with portmapper.
372 * Only used for nfsacl so far. */
374 /* Override dispatch function (e.g. when caching replies).
375 * A return value of 0 means drop the request.
376 * vs_dispatch == NULL means use default dispatcher.
378 int (*vs_dispatch
)(struct svc_rqst
*, __be32
*);
384 typedef __be32 (*svc_procfunc
)(struct svc_rqst
*, void *argp
, void *resp
);
385 struct svc_procedure
{
386 svc_procfunc pc_func
; /* process the request */
387 kxdrproc_t pc_decode
; /* XDR decode args */
388 kxdrproc_t pc_encode
; /* XDR encode result */
389 kxdrproc_t pc_release
; /* XDR free result */
390 unsigned int pc_argsize
; /* argument struct size */
391 unsigned int pc_ressize
; /* result struct size */
392 unsigned int pc_count
; /* call count */
393 unsigned int pc_cachetype
; /* cache info (NFS) */
394 unsigned int pc_xdrressize
; /* maximum size of XDR reply */
398 * Function prototypes.
400 struct svc_serv
*svc_create(struct svc_program
*, unsigned int, sa_family_t
,
401 void (*shutdown
)(struct svc_serv
*));
402 struct svc_rqst
*svc_prepare_thread(struct svc_serv
*serv
,
403 struct svc_pool
*pool
);
404 void svc_exit_thread(struct svc_rqst
*);
405 struct svc_serv
* svc_create_pooled(struct svc_program
*, unsigned int,
406 sa_family_t
, void (*shutdown
)(struct svc_serv
*),
407 svc_thread_fn
, struct module
*);
408 int svc_set_num_threads(struct svc_serv
*, struct svc_pool
*, int);
409 int svc_pool_stats_open(struct svc_serv
*serv
, struct file
*file
);
410 void svc_destroy(struct svc_serv
*);
411 int svc_process(struct svc_rqst
*);
412 int svc_register(const struct svc_serv
*, const unsigned short,
413 const unsigned short);
415 void svc_wake_up(struct svc_serv
*);
416 void svc_reserve(struct svc_rqst
*rqstp
, int space
);
417 struct svc_pool
* svc_pool_for_cpu(struct svc_serv
*serv
, int cpu
);
418 char * svc_print_addr(struct svc_rqst
*, char *, size_t);
420 #define RPC_MAX_ADDRBUFLEN (63U)
423 * When we want to reduce the size of the reserved space in the response
424 * buffer, we need to take into account the size of any checksum data that
425 * may be at the end of the packet. This is difficult to determine exactly
426 * for all cases without actually generating the checksum, so we just use a
429 static inline void svc_reserve_auth(struct svc_rqst
*rqstp
, int space
)
433 if (rqstp
->rq_authop
->flavour
)
434 added_space
= RPC_MAX_AUTH_SIZE
;
435 svc_reserve(rqstp
, space
+ added_space
);
438 #endif /* SUNRPC_SVC_H */