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 * Pages are sent using ->sendpage so each server thread needs to
61 * allocate more to replace those used in sending. To help keep track
62 * of these pages we have a receive list where all pages initialy live,
63 * and a send list where pages are moved to when there are to be part
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 kvec 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 * Each request/reply pair can have at most one "payload", plus two pages,
77 * one for the request, and one for the reply.
79 #define RPCSVC_MAXPAGES ((RPCSVC_MAXPAYLOAD+PAGE_SIZE-1)/PAGE_SIZE + 2)
81 static inline u32 svc_getu32(struct kvec *iov)
86 iov->iov_base = (void*)vp;
87 iov->iov_len -= sizeof(u32);
90 static inline void svc_putu32(struct kvec *iov, u32 val)
92 u32 *vp = iov->iov_base + iov->iov_len;
94 iov->iov_len += sizeof(u32);
99 * The context of a single thread, including the request currently being
101 * NOTE: First two items must be prev/next.
104 struct list_head rq_list; /* idle list */
105 struct svc_sock * rq_sock; /* socket */
106 struct sockaddr_in rq_addr; /* peer address */
109 struct svc_serv * rq_server; /* RPC service definition */
110 struct svc_procedure * rq_procinfo; /* procedure info */
111 struct auth_ops * rq_authop; /* authentication flavour */
112 struct svc_cred rq_cred; /* auth info */
113 struct sk_buff * rq_skbuff; /* fast recv inet buffer */
114 struct svc_deferred_req*rq_deferred; /* deferred request we are replaying */
116 struct xdr_buf rq_arg;
117 struct xdr_buf rq_res;
118 struct page * rq_argpages[RPCSVC_MAXPAGES];
119 struct page * rq_respages[RPCSVC_MAXPAGES];
121 short rq_argused; /* pages used for argument */
122 short rq_arghi; /* pages available in argument page list */
123 short rq_resused; /* pages used for result */
125 u32 rq_xid; /* transmission id */
126 u32 rq_prog; /* program number */
127 u32 rq_vers; /* program version */
128 u32 rq_proc; /* procedure number */
129 u32 rq_prot; /* IP protocol */
131 rq_secure : 1; /* secure port */
134 __u32 rq_daddr; /* dest addr of request - reply from here */
136 void * rq_argp; /* decoded arguments */
137 void * rq_resp; /* xdr'd results */
138 void * rq_auth_data; /* flavor-specific data */
140 int rq_reserved; /* space on socket outq
141 * reserved for this request
144 struct cache_req rq_chandle; /* handle passed to caches for
147 /* Catering to nfsd */
148 struct auth_domain * rq_client; /* RPC peer info */
149 struct svc_cacherep * rq_cacherep; /* cache info */
150 struct knfsd_fh * rq_reffh; /* Referrence filehandle, used to
151 * determine what device number
152 * to report (real or virtual)
155 wait_queue_head_t rq_wait; /* synchronization */
159 * Check buffer bounds after decoding arguments
162 xdr_argsize_check(struct svc_rqst *rqstp, u32 *p)
164 char *cp = (char *)p;
165 struct kvec *vec = &rqstp->rq_arg.head[0];
166 return cp - (char*)vec->iov_base <= vec->iov_len;
170 xdr_ressize_check(struct svc_rqst *rqstp, u32 *p)
172 struct kvec *vec = &rqstp->rq_res.head[0];
175 vec->iov_len = cp - (char*)vec->iov_base;
177 return vec->iov_len <= PAGE_SIZE;
180 static inline int svc_take_page(struct svc_rqst *rqstp)
182 if (rqstp->rq_arghi <= rqstp->rq_argused)
185 rqstp->rq_respages[rqstp->rq_resused] =
186 rqstp->rq_argpages[rqstp->rq_arghi];
191 static inline void svc_pushback_allpages(struct svc_rqst *rqstp)
193 while (rqstp->rq_resused) {
194 if (rqstp->rq_respages[--rqstp->rq_resused] == NULL)
196 rqstp->rq_argpages[rqstp->rq_arghi++] =
197 rqstp->rq_respages[rqstp->rq_resused];
198 rqstp->rq_respages[rqstp->rq_resused] = NULL;
202 static inline void svc_pushback_unused_pages(struct svc_rqst *rqstp)
204 while (rqstp->rq_resused &&
205 rqstp->rq_res.pages != &rqstp->rq_respages[rqstp->rq_resused]) {
207 if (rqstp->rq_respages[--rqstp->rq_resused] != NULL) {
208 rqstp->rq_argpages[rqstp->rq_arghi++] =
209 rqstp->rq_respages[rqstp->rq_resused];
210 rqstp->rq_respages[rqstp->rq_resused] = NULL;
215 static inline void svc_free_allpages(struct svc_rqst *rqstp)
217 while (rqstp->rq_resused) {
218 if (rqstp->rq_respages[--rqstp->rq_resused] == NULL)
220 put_page(rqstp->rq_respages[rqstp->rq_resused]);
221 rqstp->rq_respages[rqstp->rq_resused] = NULL;
225 struct svc_deferred_req {
226 u32 prot; /* protocol (UDP or TCP) */
227 struct sockaddr_in addr;
228 struct svc_sock *svsk; /* where reply must go */
229 struct cache_deferred_req handle;
238 u32 pg_prog; /* program number */
239 unsigned int pg_lovers; /* lowest version */
240 unsigned int pg_hivers; /* lowest version */
241 unsigned int pg_nvers; /* number of versions */
242 struct svc_version ** pg_vers; /* version array */
243 char * pg_name; /* service name */
244 char * pg_class; /* class name: services sharing authentication */
245 struct svc_stat * pg_stats; /* rpc statistics */
249 * RPC program version
252 u32 vs_vers; /* version number */
253 u32 vs_nproc; /* number of procedures */
254 struct svc_procedure * vs_proc; /* per-procedure info */
255 u32 vs_xdrsize; /* xdrsize needed for this version */
257 /* Override dispatch function (e.g. when caching replies).
258 * A return value of 0 means drop the request.
259 * vs_dispatch == NULL means use default dispatcher.
261 int (*vs_dispatch)(struct svc_rqst *, u32 *);
267 typedef int (*svc_procfunc)(struct svc_rqst *, void *argp, void *resp);
268 struct svc_procedure {
269 svc_procfunc pc_func; /* process the request */
270 kxdrproc_t pc_decode; /* XDR decode args */
271 kxdrproc_t pc_encode; /* XDR encode result */
272 kxdrproc_t pc_release; /* XDR free result */
273 unsigned int pc_argsize; /* argument struct size */
274 unsigned int pc_ressize; /* result struct size */
275 unsigned int pc_count; /* call count */
276 unsigned int pc_cachetype; /* cache info (NFS) */
277 unsigned int pc_xdrressize; /* maximum size of XDR reply */
281 * This is the RPC server thread function prototype
283 typedef void (*svc_thread_fn)(struct svc_rqst *);
286 * Function prototypes.
288 struct svc_serv * svc_create(struct svc_program *, unsigned int);
289 int svc_create_thread(svc_thread_fn, struct svc_serv *);
290 void svc_exit_thread(struct svc_rqst *);
291 void svc_destroy(struct svc_serv *);
292 int svc_process(struct svc_serv *, struct svc_rqst *);
293 int svc_register(struct svc_serv *, int, unsigned short);
294 void svc_wake_up(struct svc_serv *);
295 void svc_reserve(struct svc_rqst *rqstp, int space);
297 #endif /* SUNRPC_SVC_H */