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>
23 * An RPC service is a ``daemon,'' possibly multithreaded, which
24 * receives and processes incoming RPC messages.
25 * It has one or more transport sockets associated with it, and maintains
26 * a list of idle threads waiting for input.
28 * We currently do not support more than one RPC program per daemon.
31 struct list_head sv_threads; /* idle server threads */
32 struct list_head sv_sockets; /* pending sockets */
33 struct svc_program * sv_program; /* RPC program */
34 struct svc_stat * sv_stats; /* RPC statistics */
36 unsigned int sv_nrthreads; /* # of server threads */
37 unsigned int sv_bufsz; /* datagram buffer size */
38 unsigned int sv_xdrsize; /* XDR buffer size */
40 struct list_head sv_permsocks; /* all permanent sockets */
41 struct list_head sv_tempsocks; /* all temporary sockets */
42 int sv_tmpcnt; /* count of temporary sockets */
43 struct timer_list sv_temptimer; /* timer for aging temporary sockets */
45 char * sv_name; /* service name */
47 void (*sv_shutdown)(struct svc_serv *serv);
48 /* Callback to use when last thread
54 * Maximum payload size supported by a kernel RPC server.
55 * This is use to determine the max number of pages nfsd is
56 * willing to return in a single READ operation.
58 #define RPCSVC_MAXPAYLOAD (64*1024u)
61 * RPC Requsts and replies are stored in one or more pages.
62 * We maintain an array of pages for each server thread.
63 * Requests are copied into these pages as they arrive. Remaining
64 * pages are available to write the reply into.
66 * Pages are sent using ->sendpage so each server thread needs to
67 * allocate more to replace those used in sending. To help keep track
68 * of these pages we have a receive list where all pages initialy live,
69 * and a send list where pages are moved to when there are to be part
72 * We use xdr_buf for holding responses as it fits well with NFS
73 * read responses (that have a header, and some data pages, and possibly
74 * a tail) and means we can share some client side routines.
76 * The xdr_buf.head kvec always points to the first page in the rq_*pages
77 * list. The xdr_buf.pages pointer points to the second page on that
78 * list. xdr_buf.tail points to the end of the first page.
79 * This assumes that the non-page part of an rpc reply will fit
80 * in a page - NFSd ensures this. lockd also has no trouble.
82 * Each request/reply pair can have at most one "payload", plus two pages,
83 * one for the request, and one for the reply.
85 #define RPCSVC_MAXPAGES ((RPCSVC_MAXPAYLOAD+PAGE_SIZE-1)/PAGE_SIZE + 2)
87 static inline u32 svc_getnl(struct kvec *iov)
92 iov->iov_base = (void*)vp;
93 iov->iov_len -= sizeof(__be32);
97 static inline void svc_putnl(struct kvec *iov, u32 val)
99 __be32 *vp = iov->iov_base + iov->iov_len;
101 iov->iov_len += sizeof(__be32);
104 static inline __be32 svc_getu32(struct kvec *iov)
109 iov->iov_base = (void*)vp;
110 iov->iov_len -= sizeof(__be32);
114 static inline void svc_ungetu32(struct kvec *iov)
116 __be32 *vp = (__be32 *)iov->iov_base;
117 iov->iov_base = (void *)(vp - 1);
118 iov->iov_len += sizeof(*vp);
121 static inline void svc_putu32(struct kvec *iov, __be32 val)
123 __be32 *vp = iov->iov_base + iov->iov_len;
125 iov->iov_len += sizeof(__be32);
130 * The context of a single thread, including the request currently being
132 * NOTE: First two items must be prev/next.
135 struct list_head rq_list; /* idle list */
136 struct svc_sock * rq_sock; /* socket */
137 struct sockaddr_in rq_addr; /* peer address */
140 struct svc_serv * rq_server; /* RPC service definition */
141 struct svc_procedure * rq_procinfo; /* procedure info */
142 struct auth_ops * rq_authop; /* authentication flavour */
143 struct svc_cred rq_cred; /* auth info */
144 struct sk_buff * rq_skbuff; /* fast recv inet buffer */
145 struct svc_deferred_req*rq_deferred; /* deferred request we are replaying */
147 struct xdr_buf rq_arg;
148 struct xdr_buf rq_res;
149 struct page * rq_argpages[RPCSVC_MAXPAGES];
150 struct page * rq_respages[RPCSVC_MAXPAGES];
152 short rq_argused; /* pages used for argument */
153 short rq_arghi; /* pages available in argument page list */
154 short rq_resused; /* pages used for result */
156 __be32 rq_xid; /* transmission id */
157 u32 rq_prog; /* program number */
158 u32 rq_vers; /* program version */
159 u32 rq_proc; /* procedure number */
160 u32 rq_prot; /* IP protocol */
162 rq_secure : 1; /* secure port */
165 __be32 rq_daddr; /* dest addr of request - reply from here */
167 void * rq_argp; /* decoded arguments */
168 void * rq_resp; /* xdr'd results */
169 void * rq_auth_data; /* flavor-specific data */
171 int rq_reserved; /* space on socket outq
172 * reserved for this request
175 struct cache_req rq_chandle; /* handle passed to caches for
178 /* Catering to nfsd */
179 struct auth_domain * rq_client; /* RPC peer info */
180 struct svc_cacherep * rq_cacherep; /* cache info */
181 struct knfsd_fh * rq_reffh; /* Referrence filehandle, used to
182 * determine what device number
183 * to report (real or virtual)
185 int rq_sendfile_ok; /* turned off in gss privacy
186 * to prevent encrypting page
188 wait_queue_head_t rq_wait; /* synchronization */
192 * Check buffer bounds after decoding arguments
195 xdr_argsize_check(struct svc_rqst *rqstp, __be32 *p)
197 char *cp = (char *)p;
198 struct kvec *vec = &rqstp->rq_arg.head[0];
199 return cp >= (char*)vec->iov_base
200 && cp <= (char*)vec->iov_base + vec->iov_len;
204 xdr_ressize_check(struct svc_rqst *rqstp, __be32 *p)
206 struct kvec *vec = &rqstp->rq_res.head[0];
209 vec->iov_len = cp - (char*)vec->iov_base;
211 return vec->iov_len <= PAGE_SIZE;
214 static inline struct page *
215 svc_take_res_page(struct svc_rqst *rqstp)
217 if (rqstp->rq_arghi <= rqstp->rq_argused)
220 rqstp->rq_respages[rqstp->rq_resused] =
221 rqstp->rq_argpages[rqstp->rq_arghi];
222 return rqstp->rq_respages[rqstp->rq_resused++];
225 static inline void svc_take_page(struct svc_rqst *rqstp)
227 if (rqstp->rq_arghi <= rqstp->rq_argused) {
232 rqstp->rq_respages[rqstp->rq_resused] =
233 rqstp->rq_argpages[rqstp->rq_arghi];
237 static inline void svc_pushback_allpages(struct svc_rqst *rqstp)
239 while (rqstp->rq_resused) {
240 if (rqstp->rq_respages[--rqstp->rq_resused] == NULL)
242 rqstp->rq_argpages[rqstp->rq_arghi++] =
243 rqstp->rq_respages[rqstp->rq_resused];
244 rqstp->rq_respages[rqstp->rq_resused] = NULL;
248 static inline void svc_pushback_unused_pages(struct svc_rqst *rqstp)
250 while (rqstp->rq_resused &&
251 rqstp->rq_res.pages != &rqstp->rq_respages[rqstp->rq_resused]) {
253 if (rqstp->rq_respages[--rqstp->rq_resused] != NULL) {
254 rqstp->rq_argpages[rqstp->rq_arghi++] =
255 rqstp->rq_respages[rqstp->rq_resused];
256 rqstp->rq_respages[rqstp->rq_resused] = NULL;
261 static inline void svc_free_allpages(struct svc_rqst *rqstp)
263 while (rqstp->rq_resused) {
264 if (rqstp->rq_respages[--rqstp->rq_resused] == NULL)
266 put_page(rqstp->rq_respages[rqstp->rq_resused]);
267 rqstp->rq_respages[rqstp->rq_resused] = NULL;
271 struct svc_deferred_req {
272 u32 prot; /* protocol (UDP or TCP) */
273 struct sockaddr_in addr;
274 struct svc_sock *svsk; /* where reply must go */
275 __be32 daddr; /* where reply must come from */
276 struct cache_deferred_req handle;
282 * List of RPC programs on the same transport endpoint
285 struct svc_program * pg_next; /* other programs (same xprt) */
286 u32 pg_prog; /* program number */
287 unsigned int pg_lovers; /* lowest version */
288 unsigned int pg_hivers; /* lowest version */
289 unsigned int pg_nvers; /* number of versions */
290 struct svc_version ** pg_vers; /* version array */
291 char * pg_name; /* service name */
292 char * pg_class; /* class name: services sharing authentication */
293 struct svc_stat * pg_stats; /* rpc statistics */
294 int (*pg_authenticate)(struct svc_rqst *);
298 * RPC program version
301 u32 vs_vers; /* version number */
302 u32 vs_nproc; /* number of procedures */
303 struct svc_procedure * vs_proc; /* per-procedure info */
304 u32 vs_xdrsize; /* xdrsize needed for this version */
306 /* Override dispatch function (e.g. when caching replies).
307 * A return value of 0 means drop the request.
308 * vs_dispatch == NULL means use default dispatcher.
310 int (*vs_dispatch)(struct svc_rqst *, __be32 *);
316 typedef int (*svc_procfunc)(struct svc_rqst *, void *argp, void *resp);
317 struct svc_procedure {
318 svc_procfunc pc_func; /* process the request */
319 kxdrproc_t pc_decode; /* XDR decode args */
320 kxdrproc_t pc_encode; /* XDR encode result */
321 kxdrproc_t pc_release; /* XDR free result */
322 unsigned int pc_argsize; /* argument struct size */
323 unsigned int pc_ressize; /* result struct size */
324 unsigned int pc_count; /* call count */
325 unsigned int pc_cachetype; /* cache info (NFS) */
326 unsigned int pc_xdrressize; /* maximum size of XDR reply */
330 * This is the RPC server thread function prototype
332 typedef void (*svc_thread_fn)(struct svc_rqst *);
335 * Function prototypes.
337 struct svc_serv * svc_create(struct svc_program *, unsigned int,
338 void (*shutdown)(struct svc_serv*));
339 int svc_create_thread(svc_thread_fn, struct svc_serv *);
340 void svc_exit_thread(struct svc_rqst *);
341 void svc_destroy(struct svc_serv *);
342 int svc_process(struct svc_rqst *);
343 int svc_register(struct svc_serv *, int, unsigned short);
344 void svc_wake_up(struct svc_serv *);
345 void svc_reserve(struct svc_rqst *rqstp, int space);
347 #endif /* SUNRPC_SVC_H */