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/sunrpc/types.h>
15 #include <linux/sunrpc/xdr.h>
16 #include <linux/sunrpc/svcauth.h>
17 #include <linux/wait.h>
21 * This is the RPC server thread function prototype
23 typedef void (*svc_thread_fn
)(struct svc_rqst
*);
27 * RPC service thread pool.
29 * Pool of threads and temporary sockets. Generally there is only
30 * a single one of these per RPC service, but on NUMA machines those
31 * services that can benefit from it (i.e. nfs but not lockd) will
32 * have one pool per NUMA node. This optimisation reduces cross-
33 * node traffic on multi-node NUMA NFS servers.
36 unsigned int sp_id
; /* pool id; also node id on NUMA */
37 spinlock_t sp_lock
; /* protects all fields */
38 struct list_head sp_threads
; /* idle server threads */
39 struct list_head sp_sockets
; /* pending sockets */
40 unsigned int sp_nrthreads
; /* # of threads in pool */
41 struct list_head sp_all_threads
; /* all server threads */
42 } ____cacheline_aligned_in_smp
;
47 * An RPC service is a ``daemon,'' possibly multithreaded, which
48 * receives and processes incoming RPC messages.
49 * It has one or more transport sockets associated with it, and maintains
50 * a list of idle threads waiting for input.
52 * We currently do not support more than one RPC program per daemon.
55 struct svc_program
* sv_program
; /* RPC program */
56 struct svc_stat
* sv_stats
; /* RPC statistics */
58 unsigned int sv_nrthreads
; /* # of server threads */
59 unsigned int sv_bufsz
; /* datagram buffer size */
60 unsigned int sv_xdrsize
; /* XDR buffer size */
62 struct list_head sv_permsocks
; /* all permanent sockets */
63 struct list_head sv_tempsocks
; /* all temporary sockets */
64 int sv_tmpcnt
; /* count of temporary sockets */
65 struct timer_list sv_temptimer
; /* timer for aging temporary sockets */
67 char * sv_name
; /* service name */
69 unsigned int sv_nrpools
; /* number of thread pools */
70 struct svc_pool
* sv_pools
; /* array of thread pools */
72 void (*sv_shutdown
)(struct svc_serv
*serv
);
73 /* Callback to use when last thread
77 struct module
* sv_module
; /* optional module to count when
79 svc_thread_fn sv_function
; /* main function for threads */
80 int sv_kill_signal
; /* signal to kill threads */
84 * We use sv_nrthreads as a reference count. svc_destroy() drops
85 * this refcount, so we need to bump it up around operations that
86 * change the number of threads. Horrible, but there it is.
87 * Should be called with the BKL held.
89 static inline void svc_get(struct svc_serv
*serv
)
95 * Maximum payload size supported by a kernel RPC server.
96 * This is use to determine the max number of pages nfsd is
97 * willing to return in a single READ operation.
99 #define RPCSVC_MAXPAYLOAD (64*1024u)
102 * RPC Requsts and replies are stored in one or more pages.
103 * We maintain an array of pages for each server thread.
104 * Requests are copied into these pages as they arrive. Remaining
105 * pages are available to write the reply into.
107 * Pages are sent using ->sendpage so each server thread needs to
108 * allocate more to replace those used in sending. To help keep track
109 * of these pages we have a receive list where all pages initialy live,
110 * and a send list where pages are moved to when there are to be part
113 * We use xdr_buf for holding responses as it fits well with NFS
114 * read responses (that have a header, and some data pages, and possibly
115 * a tail) and means we can share some client side routines.
117 * The xdr_buf.head kvec always points to the first page in the rq_*pages
118 * list. The xdr_buf.pages pointer points to the second page on that
119 * list. xdr_buf.tail points to the end of the first page.
120 * This assumes that the non-page part of an rpc reply will fit
121 * in a page - NFSd ensures this. lockd also has no trouble.
123 * Each request/reply pair can have at most one "payload", plus two pages,
124 * one for the request, and one for the reply.
126 #define RPCSVC_MAXPAGES ((RPCSVC_MAXPAYLOAD+PAGE_SIZE-1)/PAGE_SIZE + 2)
128 static inline u32
svc_getnl(struct kvec
*iov
)
133 iov
->iov_base
= (void*)vp
;
134 iov
->iov_len
-= sizeof(__be32
);
138 static inline void svc_putnl(struct kvec
*iov
, u32 val
)
140 __be32
*vp
= iov
->iov_base
+ iov
->iov_len
;
142 iov
->iov_len
+= sizeof(__be32
);
145 static inline __be32
svc_getu32(struct kvec
*iov
)
150 iov
->iov_base
= (void*)vp
;
151 iov
->iov_len
-= sizeof(__be32
);
155 static inline void svc_ungetu32(struct kvec
*iov
)
157 __be32
*vp
= (__be32
*)iov
->iov_base
;
158 iov
->iov_base
= (void *)(vp
- 1);
159 iov
->iov_len
+= sizeof(*vp
);
162 static inline void svc_putu32(struct kvec
*iov
, __be32 val
)
164 __be32
*vp
= iov
->iov_base
+ iov
->iov_len
;
166 iov
->iov_len
+= sizeof(__be32
);
171 * The context of a single thread, including the request currently being
175 struct list_head rq_list
; /* idle list */
176 struct list_head rq_all
; /* all threads list */
177 struct svc_sock
* rq_sock
; /* socket */
178 struct sockaddr_in rq_addr
; /* peer address */
181 struct svc_serv
* rq_server
; /* RPC service definition */
182 struct svc_pool
* rq_pool
; /* thread pool */
183 struct svc_procedure
* rq_procinfo
; /* procedure info */
184 struct auth_ops
* rq_authop
; /* authentication flavour */
185 struct svc_cred rq_cred
; /* auth info */
186 struct sk_buff
* rq_skbuff
; /* fast recv inet buffer */
187 struct svc_deferred_req
*rq_deferred
; /* deferred request we are replaying */
189 struct xdr_buf rq_arg
;
190 struct xdr_buf rq_res
;
191 struct page
* rq_pages
[RPCSVC_MAXPAGES
];
192 struct page
* *rq_respages
; /* points into rq_pages */
193 int rq_resused
; /* number of pages used for result */
195 __be32 rq_xid
; /* transmission id */
196 u32 rq_prog
; /* program number */
197 u32 rq_vers
; /* program version */
198 u32 rq_proc
; /* procedure number */
199 u32 rq_prot
; /* IP protocol */
201 rq_secure
: 1; /* secure port */
204 __be32 rq_daddr
; /* dest addr of request - reply from here */
206 void * rq_argp
; /* decoded arguments */
207 void * rq_resp
; /* xdr'd results */
208 void * rq_auth_data
; /* flavor-specific data */
210 int rq_reserved
; /* space on socket outq
211 * reserved for this request
214 struct cache_req rq_chandle
; /* handle passed to caches for
217 /* Catering to nfsd */
218 struct auth_domain
* rq_client
; /* RPC peer info */
219 struct svc_cacherep
* rq_cacherep
; /* cache info */
220 struct knfsd_fh
* rq_reffh
; /* Referrence filehandle, used to
221 * determine what device number
222 * to report (real or virtual)
224 int rq_sendfile_ok
; /* turned off in gss privacy
225 * to prevent encrypting page
227 wait_queue_head_t rq_wait
; /* synchronization */
228 struct task_struct
*rq_task
; /* service thread */
232 * Check buffer bounds after decoding arguments
235 xdr_argsize_check(struct svc_rqst
*rqstp
, __be32
*p
)
237 char *cp
= (char *)p
;
238 struct kvec
*vec
= &rqstp
->rq_arg
.head
[0];
239 return cp
>= (char*)vec
->iov_base
240 && cp
<= (char*)vec
->iov_base
+ vec
->iov_len
;
244 xdr_ressize_check(struct svc_rqst
*rqstp
, __be32
*p
)
246 struct kvec
*vec
= &rqstp
->rq_res
.head
[0];
249 vec
->iov_len
= cp
- (char*)vec
->iov_base
;
251 return vec
->iov_len
<= PAGE_SIZE
;
254 static inline void svc_free_res_pages(struct svc_rqst
*rqstp
)
256 while (rqstp
->rq_resused
) {
257 struct page
**pp
= (rqstp
->rq_respages
+
258 --rqstp
->rq_resused
);
266 struct svc_deferred_req
{
267 u32 prot
; /* protocol (UDP or TCP) */
268 struct sockaddr_in addr
;
269 struct svc_sock
*svsk
; /* where reply must go */
270 __be32 daddr
; /* where reply must come from */
271 struct cache_deferred_req handle
;
277 * List of RPC programs on the same transport endpoint
280 struct svc_program
* pg_next
; /* other programs (same xprt) */
281 u32 pg_prog
; /* program number */
282 unsigned int pg_lovers
; /* lowest version */
283 unsigned int pg_hivers
; /* lowest version */
284 unsigned int pg_nvers
; /* number of versions */
285 struct svc_version
** pg_vers
; /* version array */
286 char * pg_name
; /* service name */
287 char * pg_class
; /* class name: services sharing authentication */
288 struct svc_stat
* pg_stats
; /* rpc statistics */
289 int (*pg_authenticate
)(struct svc_rqst
*);
293 * RPC program version
296 u32 vs_vers
; /* version number */
297 u32 vs_nproc
; /* number of procedures */
298 struct svc_procedure
* vs_proc
; /* per-procedure info */
299 u32 vs_xdrsize
; /* xdrsize needed for this version */
301 /* Override dispatch function (e.g. when caching replies).
302 * A return value of 0 means drop the request.
303 * vs_dispatch == NULL means use default dispatcher.
305 int (*vs_dispatch
)(struct svc_rqst
*, __be32
*);
311 typedef int (*svc_procfunc
)(struct svc_rqst
*, void *argp
, void *resp
);
312 struct svc_procedure
{
313 svc_procfunc pc_func
; /* process the request */
314 kxdrproc_t pc_decode
; /* XDR decode args */
315 kxdrproc_t pc_encode
; /* XDR encode result */
316 kxdrproc_t pc_release
; /* XDR free result */
317 unsigned int pc_argsize
; /* argument struct size */
318 unsigned int pc_ressize
; /* result struct size */
319 unsigned int pc_count
; /* call count */
320 unsigned int pc_cachetype
; /* cache info (NFS) */
321 unsigned int pc_xdrressize
; /* maximum size of XDR reply */
325 * Function prototypes.
327 struct svc_serv
* svc_create(struct svc_program
*, unsigned int,
328 void (*shutdown
)(struct svc_serv
*));
329 int svc_create_thread(svc_thread_fn
, struct svc_serv
*);
330 void svc_exit_thread(struct svc_rqst
*);
331 struct svc_serv
* svc_create_pooled(struct svc_program
*, unsigned int,
332 void (*shutdown
)(struct svc_serv
*),
333 svc_thread_fn
, int sig
, struct module
*);
334 int svc_set_num_threads(struct svc_serv
*, struct svc_pool
*, int);
335 void svc_destroy(struct svc_serv
*);
336 int svc_process(struct svc_rqst
*);
337 int svc_register(struct svc_serv
*, int, unsigned short);
338 void svc_wake_up(struct svc_serv
*);
339 void svc_reserve(struct svc_rqst
*rqstp
, int space
);
340 struct svc_pool
* svc_pool_for_cpu(struct svc_serv
*serv
, int cpu
);
342 #endif /* SUNRPC_SVC_H */