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 */
44 char * sv_name; /* service name */
48 * Maximum payload size supported by a kernel RPC server.
49 * This is use to determine the max number of pages nfsd is
50 * willing to return in a single READ operation.
52 #define RPCSVC_MAXPAYLOAD (64*1024u)
55 * RPC Requsts and replies are stored in one or more pages.
56 * We maintain an array of pages for each server thread.
57 * Requests are copied into these pages as they arrive. Remaining
58 * pages are available to write the reply into.
60 * Currently pages are all re-used by the same server. Later we
61 * will use ->sendpage to transmit pages with reduced copying. In
62 * that case we will need to give away the page and allocate new ones.
63 * In preparation for this, we explicitly move pages off the recv
64 * list onto the transmit list, and back.
66 * We use xdr_buf for holding responses as it fits well with NFS
67 * read responses (that have a header, and some data pages, and possibly
68 * a tail) and means we can share some client side routines.
70 * The xdr_buf.head iovec always points to the first page in the rq_*pages
71 * list. The xdr_buf.pages pointer points to the second page on that
72 * list. xdr_buf.tail points to the end of the first page.
73 * This assumes that the non-page part of an rpc reply will fit
74 * in a page - NFSd ensures this. lockd also has no trouble.
76 #define RPCSVC_MAXPAGES ((RPCSVC_MAXPAYLOAD+PAGE_SIZE-1)/PAGE_SIZE + 2)
78 static inline u32 svc_getu32(struct iovec *iov)
83 iov->iov_base = (void*)vp;
84 iov->iov_len -= sizeof(u32);
87 static inline void svc_putu32(struct iovec *iov, u32 val)
89 u32 *vp = iov->iov_base + iov->iov_len;
91 iov->iov_len += sizeof(u32);
96 * The context of a single thread, including the request currently being
98 * NOTE: First two items must be prev/next.
101 struct list_head rq_list; /* idle list */
102 struct svc_sock * rq_sock; /* socket */
103 struct sockaddr_in rq_addr; /* peer address */
106 struct svc_serv * rq_server; /* RPC service definition */
107 struct svc_procedure * rq_procinfo; /* procedure info */
108 struct auth_ops * rq_authop; /* authentication flavour */
109 struct svc_cred rq_cred; /* auth info */
110 struct sk_buff * rq_skbuff; /* fast recv inet buffer */
111 struct svc_deferred_req*rq_deferred; /* deferred request we are replaying */
113 struct xdr_buf rq_arg;
114 struct xdr_buf rq_res;
115 struct page * rq_argpages[RPCSVC_MAXPAGES];
116 struct page * rq_respages[RPCSVC_MAXPAGES];
118 short rq_argused; /* pages used for argument */
119 short rq_arghi; /* pages available in argument page list */
120 short rq_resused; /* pages used for result */
122 u32 rq_xid; /* transmission id */
123 u32 rq_prog; /* program number */
124 u32 rq_vers; /* program version */
125 u32 rq_proc; /* procedure number */
126 u32 rq_prot; /* IP protocol */
128 rq_userset : 1, /* auth->setuser OK */
129 rq_secure : 1; /* secure port */
132 void * rq_argp; /* decoded arguments */
133 void * rq_resp; /* xdr'd results */
135 int rq_reserved; /* space on socket outq
136 * reserved for this request
139 struct cache_req rq_chandle; /* handle passed to caches for
142 /* Catering to nfsd */
143 struct auth_domain * rq_client; /* RPC peer info */
144 struct svc_cacherep * rq_cacherep; /* cache info */
145 struct knfsd_fh * rq_reffh; /* Referrence filehandle, used to
146 * determine what device number
147 * to report (real or virtual)
150 wait_queue_head_t rq_wait; /* synchronization */
154 * Check buffer bounds after decoding arguments
157 xdr_argsize_check(struct svc_rqst *rqstp, u32 *p)
159 char *cp = (char *)p;
160 struct iovec *vec = &rqstp->rq_arg.head[0];
161 return cp - (char*)vec->iov_base <= vec->iov_len;
165 xdr_ressize_check(struct svc_rqst *rqstp, u32 *p)
167 struct iovec *vec = &rqstp->rq_res.head[0];
170 vec->iov_len = cp - (char*)vec->iov_base;
172 return vec->iov_len <= PAGE_SIZE;
175 static inline int svc_take_page(struct svc_rqst *rqstp)
177 if (rqstp->rq_arghi <= rqstp->rq_argused)
180 rqstp->rq_respages[rqstp->rq_resused] =
181 rqstp->rq_argpages[rqstp->rq_arghi];
186 static inline void svc_pushback_allpages(struct svc_rqst *rqstp)
188 while (rqstp->rq_resused) {
189 if (rqstp->rq_respages[--rqstp->rq_resused] == NULL)
191 rqstp->rq_argpages[rqstp->rq_arghi++] =
192 rqstp->rq_respages[rqstp->rq_resused];
193 rqstp->rq_respages[rqstp->rq_resused] = NULL;
197 static inline void svc_pushback_unused_pages(struct svc_rqst *rqstp)
199 while (rqstp->rq_resused) {
200 if (rqstp->rq_respages[--rqstp->rq_resused] != NULL) {
201 rqstp->rq_argpages[rqstp->rq_arghi++] =
202 rqstp->rq_respages[rqstp->rq_resused];
203 rqstp->rq_respages[rqstp->rq_resused] = NULL;
205 if (rqstp->rq_res.pages == &rqstp->rq_respages[rqstp->rq_resused])
210 static inline void svc_free_allpages(struct svc_rqst *rqstp)
212 while (rqstp->rq_resused) {
213 if (rqstp->rq_respages[--rqstp->rq_resused] == NULL)
215 put_page(rqstp->rq_respages[rqstp->rq_resused]);
216 rqstp->rq_respages[rqstp->rq_resused] = NULL;
220 struct svc_deferred_req {
221 struct svc_serv *serv;
222 u32 prot; /* protocol (UDP or TCP) */
223 struct sockaddr_in addr;
224 struct svc_sock *svsk; /* where reply must go */
225 struct cache_deferred_req handle;
234 u32 pg_prog; /* program number */
235 unsigned int pg_lovers; /* lowest version */
236 unsigned int pg_hivers; /* lowest version */
237 unsigned int pg_nvers; /* number of versions */
238 struct svc_version ** pg_vers; /* version array */
239 char * pg_name; /* service name */
240 char * pg_class; /* class name: services sharing authentication */
241 struct svc_stat * pg_stats; /* rpc statistics */
245 * RPC program version
248 u32 vs_vers; /* version number */
249 u32 vs_nproc; /* number of procedures */
250 struct svc_procedure * vs_proc; /* per-procedure info */
251 u32 vs_xdrsize; /* xdrsize needed for this version */
253 /* Override dispatch function (e.g. when caching replies).
254 * A return value of 0 means drop the request.
255 * vs_dispatch == NULL means use default dispatcher.
257 int (*vs_dispatch)(struct svc_rqst *, u32 *);
263 typedef int (*svc_procfunc)(struct svc_rqst *, void *argp, void *resp);
264 struct svc_procedure {
265 svc_procfunc pc_func; /* process the request */
266 kxdrproc_t pc_decode; /* XDR decode args */
267 kxdrproc_t pc_encode; /* XDR encode result */
268 kxdrproc_t pc_release; /* XDR free result */
269 unsigned int pc_argsize; /* argument struct size */
270 unsigned int pc_ressize; /* result struct size */
271 unsigned int pc_count; /* call count */
272 unsigned int pc_cachetype; /* cache info (NFS) */
273 unsigned int pc_xdrressize; /* maximum size of XDR reply */
277 * This is the RPC server thread function prototype
279 typedef void (*svc_thread_fn)(struct svc_rqst *);
282 * Function prototypes.
284 struct svc_serv * svc_create(struct svc_program *, unsigned int);
285 int svc_create_thread(svc_thread_fn, struct svc_serv *);
286 void svc_exit_thread(struct svc_rqst *);
287 void svc_destroy(struct svc_serv *);
288 int svc_process(struct svc_serv *, struct svc_rqst *);
289 int svc_register(struct svc_serv *, int, unsigned short);
290 void svc_wake_up(struct svc_serv *);
291 void svc_reserve(struct svc_rqst *rqstp, int space);
293 #endif /* SUNRPC_SVC_H */