1
2
3
4
5
6
7
8
9
10
11#ifndef SUNRPC_SVC_H
12#define SUNRPC_SVC_H
13
14#include <linux/in.h>
15#include <linux/in6.h>
16#include <linux/sunrpc/types.h>
17#include <linux/sunrpc/xdr.h>
18#include <linux/sunrpc/auth.h>
19#include <linux/sunrpc/svcauth.h>
20#include <linux/wait.h>
21#include <linux/mm.h>
22
23
24struct svc_pool_stats {
25 atomic_long_t packets;
26 unsigned long sockets_queued;
27 atomic_long_t threads_woken;
28 atomic_long_t threads_timedout;
29};
30
31
32
33
34
35
36
37
38
39
40
41struct svc_pool {
42 unsigned int sp_id;
43 spinlock_t sp_lock;
44 struct list_head sp_sockets;
45 unsigned int sp_nrthreads;
46 struct list_head sp_all_threads;
47 struct svc_pool_stats sp_stats;
48#define SP_TASK_PENDING (0)
49
50#define SP_CONGESTED (1)
51 unsigned long sp_flags;
52} ____cacheline_aligned_in_smp;
53
54struct svc_serv;
55
56struct svc_serv_ops {
57
58 void (*svo_shutdown)(struct svc_serv *, struct net *);
59
60
61 int (*svo_function)(void *);
62
63
64 void (*svo_enqueue_xprt)(struct svc_xprt *);
65
66
67 int (*svo_setup)(struct svc_serv *, struct svc_pool *, int);
68
69
70 struct module *svo_module;
71};
72
73
74
75
76
77
78
79
80
81
82
83struct svc_serv {
84 struct svc_program * sv_program;
85 struct svc_stat * sv_stats;
86 spinlock_t sv_lock;
87 unsigned int sv_nrthreads;
88 unsigned int sv_maxconn;
89
90
91
92 unsigned int sv_max_payload;
93 unsigned int sv_max_mesg;
94 unsigned int sv_xdrsize;
95 struct list_head sv_permsocks;
96 struct list_head sv_tempsocks;
97 int sv_tmpcnt;
98 struct timer_list sv_temptimer;
99
100 char * sv_name;
101
102 unsigned int sv_nrpools;
103 struct svc_pool * sv_pools;
104 const struct svc_serv_ops *sv_ops;
105#if defined(CONFIG_SUNRPC_BACKCHANNEL)
106 struct list_head sv_cb_list;
107
108
109 spinlock_t sv_cb_lock;
110 wait_queue_head_t sv_cb_waitq;
111
112 bool sv_bc_enabled;
113#endif
114};
115
116
117
118
119
120
121
122static inline void svc_get(struct svc_serv *serv)
123{
124 serv->sv_nrthreads++;
125}
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148#define RPCSVC_MAXPAYLOAD (1*1024*1024u)
149#define RPCSVC_MAXPAYLOAD_TCP RPCSVC_MAXPAYLOAD
150#define RPCSVC_MAXPAYLOAD_UDP (32*1024u)
151
152extern u32 svc_max_payload(const struct svc_rqst *rqstp);
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181#define RPCSVC_MAXPAGES ((RPCSVC_MAXPAYLOAD+PAGE_SIZE-1)/PAGE_SIZE \
182 + 2 + 1)
183
184static inline u32 svc_getnl(struct kvec *iov)
185{
186 __be32 val, *vp;
187 vp = iov->iov_base;
188 val = *vp++;
189 iov->iov_base = (void*)vp;
190 iov->iov_len -= sizeof(__be32);
191 return ntohl(val);
192}
193
194static inline void svc_putnl(struct kvec *iov, u32 val)
195{
196 __be32 *vp = iov->iov_base + iov->iov_len;
197 *vp = htonl(val);
198 iov->iov_len += sizeof(__be32);
199}
200
201static inline __be32 svc_getu32(struct kvec *iov)
202{
203 __be32 val, *vp;
204 vp = iov->iov_base;
205 val = *vp++;
206 iov->iov_base = (void*)vp;
207 iov->iov_len -= sizeof(__be32);
208 return val;
209}
210
211static inline void svc_ungetu32(struct kvec *iov)
212{
213 __be32 *vp = (__be32 *)iov->iov_base;
214 iov->iov_base = (void *)(vp - 1);
215 iov->iov_len += sizeof(*vp);
216}
217
218static inline void svc_putu32(struct kvec *iov, __be32 val)
219{
220 __be32 *vp = iov->iov_base + iov->iov_len;
221 *vp = val;
222 iov->iov_len += sizeof(__be32);
223}
224
225
226
227
228
229struct svc_rqst {
230 struct list_head rq_all;
231 struct rcu_head rq_rcu_head;
232 struct svc_xprt * rq_xprt;
233
234 struct sockaddr_storage rq_addr;
235 size_t rq_addrlen;
236 struct sockaddr_storage rq_daddr;
237
238 size_t rq_daddrlen;
239
240 struct svc_serv * rq_server;
241 struct svc_pool * rq_pool;
242 const struct svc_procedure *rq_procinfo;
243 struct auth_ops * rq_authop;
244 struct svc_cred rq_cred;
245 void * rq_xprt_ctxt;
246 struct svc_deferred_req*rq_deferred;
247
248 size_t rq_xprt_hlen;
249 struct xdr_buf rq_arg;
250 struct xdr_stream rq_arg_stream;
251 struct xdr_stream rq_res_stream;
252 struct page *rq_scratch_page;
253 struct xdr_buf rq_res;
254 struct page *rq_pages[RPCSVC_MAXPAGES + 1];
255 struct page * *rq_respages;
256 struct page * *rq_next_page;
257 struct page * *rq_page_end;
258
259 struct kvec rq_vec[RPCSVC_MAXPAGES];
260 struct bio_vec rq_bvec[RPCSVC_MAXPAGES];
261
262 __be32 rq_xid;
263 u32 rq_prog;
264 u32 rq_vers;
265 u32 rq_proc;
266 u32 rq_prot;
267 int rq_cachetype;
268#define RQ_SECURE (0)
269#define RQ_LOCAL (1)
270#define RQ_USEDEFERRAL (2)
271#define RQ_DROPME (3)
272#define RQ_SPLICE_OK (4)
273
274
275#define RQ_VICTIM (5)
276#define RQ_BUSY (6)
277#define RQ_DATA (7)
278#define RQ_AUTHERR (8)
279 unsigned long rq_flags;
280 ktime_t rq_qtime;
281
282 void * rq_argp;
283 void * rq_resp;
284 void * rq_auth_data;
285 int rq_auth_slack;
286
287
288
289 int rq_reserved;
290
291
292 ktime_t rq_stime;
293
294 struct cache_req rq_chandle;
295
296
297
298 struct auth_domain * rq_client;
299 struct auth_domain * rq_gssclient;
300 struct svc_cacherep * rq_cacherep;
301 struct task_struct *rq_task;
302 spinlock_t rq_lock;
303 struct net *rq_bc_net;
304
305
306 void ** rq_lease_breaker;
307};
308
309#define SVC_NET(rqst) (rqst->rq_xprt ? rqst->rq_xprt->xpt_net : rqst->rq_bc_net)
310
311
312
313
314static inline struct sockaddr_in *svc_addr_in(const struct svc_rqst *rqst)
315{
316 return (struct sockaddr_in *) &rqst->rq_addr;
317}
318
319static inline struct sockaddr_in6 *svc_addr_in6(const struct svc_rqst *rqst)
320{
321 return (struct sockaddr_in6 *) &rqst->rq_addr;
322}
323
324static inline struct sockaddr *svc_addr(const struct svc_rqst *rqst)
325{
326 return (struct sockaddr *) &rqst->rq_addr;
327}
328
329static inline struct sockaddr_in *svc_daddr_in(const struct svc_rqst *rqst)
330{
331 return (struct sockaddr_in *) &rqst->rq_daddr;
332}
333
334static inline struct sockaddr_in6 *svc_daddr_in6(const struct svc_rqst *rqst)
335{
336 return (struct sockaddr_in6 *) &rqst->rq_daddr;
337}
338
339static inline struct sockaddr *svc_daddr(const struct svc_rqst *rqst)
340{
341 return (struct sockaddr *) &rqst->rq_daddr;
342}
343
344
345
346
347static inline int
348xdr_argsize_check(struct svc_rqst *rqstp, __be32 *p)
349{
350 char *cp = (char *)p;
351 struct kvec *vec = &rqstp->rq_arg.head[0];
352 return cp >= (char*)vec->iov_base
353 && cp <= (char*)vec->iov_base + vec->iov_len;
354}
355
356static inline int
357xdr_ressize_check(struct svc_rqst *rqstp, __be32 *p)
358{
359 struct kvec *vec = &rqstp->rq_res.head[0];
360 char *cp = (char*)p;
361
362 vec->iov_len = cp - (char*)vec->iov_base;
363
364 return vec->iov_len <= PAGE_SIZE;
365}
366
367static inline void svc_free_res_pages(struct svc_rqst *rqstp)
368{
369 while (rqstp->rq_next_page != rqstp->rq_respages) {
370 struct page **pp = --rqstp->rq_next_page;
371 if (*pp) {
372 put_page(*pp);
373 *pp = NULL;
374 }
375 }
376}
377
378struct svc_deferred_req {
379 u32 prot;
380 struct svc_xprt *xprt;
381 struct sockaddr_storage addr;
382 size_t addrlen;
383 struct sockaddr_storage daddr;
384 size_t daddrlen;
385 struct cache_deferred_req handle;
386 size_t xprt_hlen;
387 int argslen;
388 __be32 args[];
389};
390
391struct svc_process_info {
392 union {
393 int (*dispatch)(struct svc_rqst *, __be32 *);
394 struct {
395 unsigned int lovers;
396 unsigned int hivers;
397 } mismatch;
398 };
399};
400
401
402
403
404struct svc_program {
405 struct svc_program * pg_next;
406 u32 pg_prog;
407 unsigned int pg_lovers;
408 unsigned int pg_hivers;
409 unsigned int pg_nvers;
410 const struct svc_version **pg_vers;
411 char * pg_name;
412 char * pg_class;
413 struct svc_stat * pg_stats;
414 int (*pg_authenticate)(struct svc_rqst *);
415 __be32 (*pg_init_request)(struct svc_rqst *,
416 const struct svc_program *,
417 struct svc_process_info *);
418 int (*pg_rpcbind_set)(struct net *net,
419 const struct svc_program *,
420 u32 version, int family,
421 unsigned short proto,
422 unsigned short port);
423};
424
425
426
427
428struct svc_version {
429 u32 vs_vers;
430 u32 vs_nproc;
431 const struct svc_procedure *vs_proc;
432 unsigned int *vs_count;
433 u32 vs_xdrsize;
434
435
436 bool vs_hidden;
437
438
439 bool vs_rpcb_optnl;
440
441
442 bool vs_need_cong_ctrl;
443
444
445
446
447
448 int (*vs_dispatch)(struct svc_rqst *, __be32 *);
449};
450
451
452
453
454struct svc_procedure {
455
456 __be32 (*pc_func)(struct svc_rqst *);
457
458 int (*pc_decode)(struct svc_rqst *, __be32 *data);
459
460 int (*pc_encode)(struct svc_rqst *, __be32 *data);
461
462 void (*pc_release)(struct svc_rqst *);
463 unsigned int pc_argsize;
464 unsigned int pc_ressize;
465 unsigned int pc_cachetype;
466 unsigned int pc_xdrressize;
467 const char * pc_name;
468};
469
470
471
472
473enum {
474 SVC_POOL_AUTO = -1,
475 SVC_POOL_GLOBAL,
476
477 SVC_POOL_PERCPU,
478 SVC_POOL_PERNODE
479};
480
481struct svc_pool_map {
482 int count;
483 int mode;
484
485
486 unsigned int npools;
487 unsigned int *pool_to;
488 unsigned int *to_pool;
489};
490
491extern struct svc_pool_map svc_pool_map;
492
493
494
495
496int svc_rpcb_setup(struct svc_serv *serv, struct net *net);
497void svc_rpcb_cleanup(struct svc_serv *serv, struct net *net);
498int svc_bind(struct svc_serv *serv, struct net *net);
499struct svc_serv *svc_create(struct svc_program *, unsigned int,
500 const struct svc_serv_ops *);
501struct svc_rqst *svc_rqst_alloc(struct svc_serv *serv,
502 struct svc_pool *pool, int node);
503struct svc_rqst *svc_prepare_thread(struct svc_serv *serv,
504 struct svc_pool *pool, int node);
505void svc_rqst_free(struct svc_rqst *);
506void svc_exit_thread(struct svc_rqst *);
507unsigned int svc_pool_map_get(void);
508void svc_pool_map_put(void);
509struct svc_serv * svc_create_pooled(struct svc_program *, unsigned int,
510 const struct svc_serv_ops *);
511int svc_set_num_threads(struct svc_serv *, struct svc_pool *, int);
512int svc_set_num_threads_sync(struct svc_serv *, struct svc_pool *, int);
513int svc_pool_stats_open(struct svc_serv *serv, struct file *file);
514void svc_destroy(struct svc_serv *);
515void svc_shutdown_net(struct svc_serv *, struct net *);
516int svc_process(struct svc_rqst *);
517int bc_svc_process(struct svc_serv *, struct rpc_rqst *,
518 struct svc_rqst *);
519int svc_register(const struct svc_serv *, struct net *, const int,
520 const unsigned short, const unsigned short);
521
522void svc_wake_up(struct svc_serv *);
523void svc_reserve(struct svc_rqst *rqstp, int space);
524struct svc_pool * svc_pool_for_cpu(struct svc_serv *serv, int cpu);
525char * svc_print_addr(struct svc_rqst *, char *, size_t);
526int svc_encode_result_payload(struct svc_rqst *rqstp,
527 unsigned int offset,
528 unsigned int length);
529unsigned int svc_fill_write_vector(struct svc_rqst *rqstp,
530 struct page **pages,
531 struct kvec *first, size_t total);
532char *svc_fill_symlink_pathname(struct svc_rqst *rqstp,
533 struct kvec *first, void *p,
534 size_t total);
535__be32 svc_return_autherr(struct svc_rqst *rqstp, __be32 auth_err);
536__be32 svc_generic_init_request(struct svc_rqst *rqstp,
537 const struct svc_program *progp,
538 struct svc_process_info *procinfo);
539int svc_generic_rpcbind_set(struct net *net,
540 const struct svc_program *progp,
541 u32 version, int family,
542 unsigned short proto,
543 unsigned short port);
544int svc_rpcbind_set_version(struct net *net,
545 const struct svc_program *progp,
546 u32 version, int family,
547 unsigned short proto,
548 unsigned short port);
549
550#define RPC_MAX_ADDRBUFLEN (63U)
551
552
553
554
555
556
557
558
559static inline void svc_reserve_auth(struct svc_rqst *rqstp, int space)
560{
561 svc_reserve(rqstp, space + rqstp->rq_auth_slack);
562}
563
564
565
566
567
568
569static inline void svcxdr_init_decode(struct svc_rqst *rqstp)
570{
571 struct xdr_stream *xdr = &rqstp->rq_arg_stream;
572 struct kvec *argv = rqstp->rq_arg.head;
573
574 xdr_init_decode(xdr, &rqstp->rq_arg, argv->iov_base, NULL);
575 xdr_set_scratch_page(xdr, rqstp->rq_scratch_page);
576}
577
578
579
580
581
582
583static inline void svcxdr_init_encode(struct svc_rqst *rqstp)
584{
585 struct xdr_stream *xdr = &rqstp->rq_res_stream;
586 struct xdr_buf *buf = &rqstp->rq_res;
587 struct kvec *resv = buf->head;
588
589 xdr_reset_scratch_buffer(xdr);
590
591 xdr->buf = buf;
592 xdr->iov = resv;
593 xdr->p = resv->iov_base + resv->iov_len;
594 xdr->end = resv->iov_base + PAGE_SIZE - rqstp->rq_auth_slack;
595 buf->len = resv->iov_len;
596 xdr->page_ptr = buf->pages - 1;
597 buf->buflen = PAGE_SIZE * (1 + rqstp->rq_page_end - buf->pages);
598 buf->buflen -= rqstp->rq_auth_slack;
599 xdr->rqst = NULL;
600}
601
602#endif
603