]> Git Repo - linux.git/blob - net/sunrpc/svc.c
nfsd41: allow non-reclaim open-by-fh's in 4.1
[linux.git] / net / sunrpc / svc.c
1 /*
2  * linux/net/sunrpc/svc.c
3  *
4  * High-level RPC service routines
5  *
6  * Copyright (C) 1995, 1996 Olaf Kirch <[email protected]>
7  *
8  * Multiple threads pools and NUMAisation
9  * Copyright (c) 2006 Silicon Graphics, Inc.
10  * by Greg Banks <[email protected]>
11  */
12
13 #include <linux/linkage.h>
14 #include <linux/sched.h>
15 #include <linux/errno.h>
16 #include <linux/net.h>
17 #include <linux/in.h>
18 #include <linux/mm.h>
19 #include <linux/interrupt.h>
20 #include <linux/module.h>
21 #include <linux/kthread.h>
22 #include <linux/slab.h>
23
24 #include <linux/sunrpc/types.h>
25 #include <linux/sunrpc/xdr.h>
26 #include <linux/sunrpc/stats.h>
27 #include <linux/sunrpc/svcsock.h>
28 #include <linux/sunrpc/clnt.h>
29 #include <linux/sunrpc/bc_xprt.h>
30
31 #define RPCDBG_FACILITY RPCDBG_SVCDSP
32
33 static void svc_unregister(const struct svc_serv *serv);
34
35 #define svc_serv_is_pooled(serv)    ((serv)->sv_function)
36
37 /*
38  * Mode for mapping cpus to pools.
39  */
40 enum {
41         SVC_POOL_AUTO = -1,     /* choose one of the others */
42         SVC_POOL_GLOBAL,        /* no mapping, just a single global pool
43                                  * (legacy & UP mode) */
44         SVC_POOL_PERCPU,        /* one pool per cpu */
45         SVC_POOL_PERNODE        /* one pool per numa node */
46 };
47 #define SVC_POOL_DEFAULT        SVC_POOL_GLOBAL
48
49 /*
50  * Structure for mapping cpus to pools and vice versa.
51  * Setup once during sunrpc initialisation.
52  */
53 static struct svc_pool_map {
54         int count;                      /* How many svc_servs use us */
55         int mode;                       /* Note: int not enum to avoid
56                                          * warnings about "enumeration value
57                                          * not handled in switch" */
58         unsigned int npools;
59         unsigned int *pool_to;          /* maps pool id to cpu or node */
60         unsigned int *to_pool;          /* maps cpu or node to pool id */
61 } svc_pool_map = {
62         .count = 0,
63         .mode = SVC_POOL_DEFAULT
64 };
65 static DEFINE_MUTEX(svc_pool_map_mutex);/* protects svc_pool_map.count only */
66
67 static int
68 param_set_pool_mode(const char *val, struct kernel_param *kp)
69 {
70         int *ip = (int *)kp->arg;
71         struct svc_pool_map *m = &svc_pool_map;
72         int err;
73
74         mutex_lock(&svc_pool_map_mutex);
75
76         err = -EBUSY;
77         if (m->count)
78                 goto out;
79
80         err = 0;
81         if (!strncmp(val, "auto", 4))
82                 *ip = SVC_POOL_AUTO;
83         else if (!strncmp(val, "global", 6))
84                 *ip = SVC_POOL_GLOBAL;
85         else if (!strncmp(val, "percpu", 6))
86                 *ip = SVC_POOL_PERCPU;
87         else if (!strncmp(val, "pernode", 7))
88                 *ip = SVC_POOL_PERNODE;
89         else
90                 err = -EINVAL;
91
92 out:
93         mutex_unlock(&svc_pool_map_mutex);
94         return err;
95 }
96
97 static int
98 param_get_pool_mode(char *buf, struct kernel_param *kp)
99 {
100         int *ip = (int *)kp->arg;
101
102         switch (*ip)
103         {
104         case SVC_POOL_AUTO:
105                 return strlcpy(buf, "auto", 20);
106         case SVC_POOL_GLOBAL:
107                 return strlcpy(buf, "global", 20);
108         case SVC_POOL_PERCPU:
109                 return strlcpy(buf, "percpu", 20);
110         case SVC_POOL_PERNODE:
111                 return strlcpy(buf, "pernode", 20);
112         default:
113                 return sprintf(buf, "%d", *ip);
114         }
115 }
116
117 module_param_call(pool_mode, param_set_pool_mode, param_get_pool_mode,
118                  &svc_pool_map.mode, 0644);
119
120 /*
121  * Detect best pool mapping mode heuristically,
122  * according to the machine's topology.
123  */
124 static int
125 svc_pool_map_choose_mode(void)
126 {
127         unsigned int node;
128
129         if (nr_online_nodes > 1) {
130                 /*
131                  * Actually have multiple NUMA nodes,
132                  * so split pools on NUMA node boundaries
133                  */
134                 return SVC_POOL_PERNODE;
135         }
136
137         node = first_online_node;
138         if (nr_cpus_node(node) > 2) {
139                 /*
140                  * Non-trivial SMP, or CONFIG_NUMA on
141                  * non-NUMA hardware, e.g. with a generic
142                  * x86_64 kernel on Xeons.  In this case we
143                  * want to divide the pools on cpu boundaries.
144                  */
145                 return SVC_POOL_PERCPU;
146         }
147
148         /* default: one global pool */
149         return SVC_POOL_GLOBAL;
150 }
151
152 /*
153  * Allocate the to_pool[] and pool_to[] arrays.
154  * Returns 0 on success or an errno.
155  */
156 static int
157 svc_pool_map_alloc_arrays(struct svc_pool_map *m, unsigned int maxpools)
158 {
159         m->to_pool = kcalloc(maxpools, sizeof(unsigned int), GFP_KERNEL);
160         if (!m->to_pool)
161                 goto fail;
162         m->pool_to = kcalloc(maxpools, sizeof(unsigned int), GFP_KERNEL);
163         if (!m->pool_to)
164                 goto fail_free;
165
166         return 0;
167
168 fail_free:
169         kfree(m->to_pool);
170 fail:
171         return -ENOMEM;
172 }
173
174 /*
175  * Initialise the pool map for SVC_POOL_PERCPU mode.
176  * Returns number of pools or <0 on error.
177  */
178 static int
179 svc_pool_map_init_percpu(struct svc_pool_map *m)
180 {
181         unsigned int maxpools = nr_cpu_ids;
182         unsigned int pidx = 0;
183         unsigned int cpu;
184         int err;
185
186         err = svc_pool_map_alloc_arrays(m, maxpools);
187         if (err)
188                 return err;
189
190         for_each_online_cpu(cpu) {
191                 BUG_ON(pidx > maxpools);
192                 m->to_pool[cpu] = pidx;
193                 m->pool_to[pidx] = cpu;
194                 pidx++;
195         }
196         /* cpus brought online later all get mapped to pool0, sorry */
197
198         return pidx;
199 };
200
201
202 /*
203  * Initialise the pool map for SVC_POOL_PERNODE mode.
204  * Returns number of pools or <0 on error.
205  */
206 static int
207 svc_pool_map_init_pernode(struct svc_pool_map *m)
208 {
209         unsigned int maxpools = nr_node_ids;
210         unsigned int pidx = 0;
211         unsigned int node;
212         int err;
213
214         err = svc_pool_map_alloc_arrays(m, maxpools);
215         if (err)
216                 return err;
217
218         for_each_node_with_cpus(node) {
219                 /* some architectures (e.g. SN2) have cpuless nodes */
220                 BUG_ON(pidx > maxpools);
221                 m->to_pool[node] = pidx;
222                 m->pool_to[pidx] = node;
223                 pidx++;
224         }
225         /* nodes brought online later all get mapped to pool0, sorry */
226
227         return pidx;
228 }
229
230
231 /*
232  * Add a reference to the global map of cpus to pools (and
233  * vice versa).  Initialise the map if we're the first user.
234  * Returns the number of pools.
235  */
236 static unsigned int
237 svc_pool_map_get(void)
238 {
239         struct svc_pool_map *m = &svc_pool_map;
240         int npools = -1;
241
242         mutex_lock(&svc_pool_map_mutex);
243
244         if (m->count++) {
245                 mutex_unlock(&svc_pool_map_mutex);
246                 return m->npools;
247         }
248
249         if (m->mode == SVC_POOL_AUTO)
250                 m->mode = svc_pool_map_choose_mode();
251
252         switch (m->mode) {
253         case SVC_POOL_PERCPU:
254                 npools = svc_pool_map_init_percpu(m);
255                 break;
256         case SVC_POOL_PERNODE:
257                 npools = svc_pool_map_init_pernode(m);
258                 break;
259         }
260
261         if (npools < 0) {
262                 /* default, or memory allocation failure */
263                 npools = 1;
264                 m->mode = SVC_POOL_GLOBAL;
265         }
266         m->npools = npools;
267
268         mutex_unlock(&svc_pool_map_mutex);
269         return m->npools;
270 }
271
272
273 /*
274  * Drop a reference to the global map of cpus to pools.
275  * When the last reference is dropped, the map data is
276  * freed; this allows the sysadmin to change the pool
277  * mode using the pool_mode module option without
278  * rebooting or re-loading sunrpc.ko.
279  */
280 static void
281 svc_pool_map_put(void)
282 {
283         struct svc_pool_map *m = &svc_pool_map;
284
285         mutex_lock(&svc_pool_map_mutex);
286
287         if (!--m->count) {
288                 m->mode = SVC_POOL_DEFAULT;
289                 kfree(m->to_pool);
290                 kfree(m->pool_to);
291                 m->npools = 0;
292         }
293
294         mutex_unlock(&svc_pool_map_mutex);
295 }
296
297
298 static int svc_pool_map_get_node(unsigned int pidx)
299 {
300         const struct svc_pool_map *m = &svc_pool_map;
301
302         if (m->count) {
303                 if (m->mode == SVC_POOL_PERCPU)
304                         return cpu_to_node(m->pool_to[pidx]);
305                 if (m->mode == SVC_POOL_PERNODE)
306                         return m->pool_to[pidx];
307         }
308         return NUMA_NO_NODE;
309 }
310 /*
311  * Set the given thread's cpus_allowed mask so that it
312  * will only run on cpus in the given pool.
313  */
314 static inline void
315 svc_pool_map_set_cpumask(struct task_struct *task, unsigned int pidx)
316 {
317         struct svc_pool_map *m = &svc_pool_map;
318         unsigned int node = m->pool_to[pidx];
319
320         /*
321          * The caller checks for sv_nrpools > 1, which
322          * implies that we've been initialized.
323          */
324         BUG_ON(m->count == 0);
325
326         switch (m->mode) {
327         case SVC_POOL_PERCPU:
328         {
329                 set_cpus_allowed_ptr(task, cpumask_of(node));
330                 break;
331         }
332         case SVC_POOL_PERNODE:
333         {
334                 set_cpus_allowed_ptr(task, cpumask_of_node(node));
335                 break;
336         }
337         }
338 }
339
340 /*
341  * Use the mapping mode to choose a pool for a given CPU.
342  * Used when enqueueing an incoming RPC.  Always returns
343  * a non-NULL pool pointer.
344  */
345 struct svc_pool *
346 svc_pool_for_cpu(struct svc_serv *serv, int cpu)
347 {
348         struct svc_pool_map *m = &svc_pool_map;
349         unsigned int pidx = 0;
350
351         /*
352          * An uninitialised map happens in a pure client when
353          * lockd is brought up, so silently treat it the
354          * same as SVC_POOL_GLOBAL.
355          */
356         if (svc_serv_is_pooled(serv)) {
357                 switch (m->mode) {
358                 case SVC_POOL_PERCPU:
359                         pidx = m->to_pool[cpu];
360                         break;
361                 case SVC_POOL_PERNODE:
362                         pidx = m->to_pool[cpu_to_node(cpu)];
363                         break;
364                 }
365         }
366         return &serv->sv_pools[pidx % serv->sv_nrpools];
367 }
368
369 static int svc_rpcb_setup(struct svc_serv *serv)
370 {
371         int err;
372
373         err = rpcb_create_local();
374         if (err)
375                 return err;
376
377         /* Remove any stale portmap registrations */
378         svc_unregister(serv);
379         return 0;
380 }
381
382 void svc_rpcb_cleanup(struct svc_serv *serv)
383 {
384         svc_unregister(serv);
385         rpcb_put_local();
386 }
387 EXPORT_SYMBOL_GPL(svc_rpcb_cleanup);
388
389 static int svc_uses_rpcbind(struct svc_serv *serv)
390 {
391         struct svc_program      *progp;
392         unsigned int            i;
393
394         for (progp = serv->sv_program; progp; progp = progp->pg_next) {
395                 for (i = 0; i < progp->pg_nvers; i++) {
396                         if (progp->pg_vers[i] == NULL)
397                                 continue;
398                         if (progp->pg_vers[i]->vs_hidden == 0)
399                                 return 1;
400                 }
401         }
402
403         return 0;
404 }
405
406 /*
407  * Create an RPC service
408  */
409 static struct svc_serv *
410 __svc_create(struct svc_program *prog, unsigned int bufsize, int npools,
411              void (*shutdown)(struct svc_serv *serv))
412 {
413         struct svc_serv *serv;
414         unsigned int vers;
415         unsigned int xdrsize;
416         unsigned int i;
417
418         if (!(serv = kzalloc(sizeof(*serv), GFP_KERNEL)))
419                 return NULL;
420         serv->sv_name      = prog->pg_name;
421         serv->sv_program   = prog;
422         serv->sv_nrthreads = 1;
423         serv->sv_stats     = prog->pg_stats;
424         if (bufsize > RPCSVC_MAXPAYLOAD)
425                 bufsize = RPCSVC_MAXPAYLOAD;
426         serv->sv_max_payload = bufsize? bufsize : 4096;
427         serv->sv_max_mesg  = roundup(serv->sv_max_payload + PAGE_SIZE, PAGE_SIZE);
428         serv->sv_shutdown  = shutdown;
429         xdrsize = 0;
430         while (prog) {
431                 prog->pg_lovers = prog->pg_nvers-1;
432                 for (vers=0; vers<prog->pg_nvers ; vers++)
433                         if (prog->pg_vers[vers]) {
434                                 prog->pg_hivers = vers;
435                                 if (prog->pg_lovers > vers)
436                                         prog->pg_lovers = vers;
437                                 if (prog->pg_vers[vers]->vs_xdrsize > xdrsize)
438                                         xdrsize = prog->pg_vers[vers]->vs_xdrsize;
439                         }
440                 prog = prog->pg_next;
441         }
442         serv->sv_xdrsize   = xdrsize;
443         INIT_LIST_HEAD(&serv->sv_tempsocks);
444         INIT_LIST_HEAD(&serv->sv_permsocks);
445         init_timer(&serv->sv_temptimer);
446         spin_lock_init(&serv->sv_lock);
447
448         serv->sv_nrpools = npools;
449         serv->sv_pools =
450                 kcalloc(serv->sv_nrpools, sizeof(struct svc_pool),
451                         GFP_KERNEL);
452         if (!serv->sv_pools) {
453                 kfree(serv);
454                 return NULL;
455         }
456
457         for (i = 0; i < serv->sv_nrpools; i++) {
458                 struct svc_pool *pool = &serv->sv_pools[i];
459
460                 dprintk("svc: initialising pool %u for %s\n",
461                                 i, serv->sv_name);
462
463                 pool->sp_id = i;
464                 INIT_LIST_HEAD(&pool->sp_threads);
465                 INIT_LIST_HEAD(&pool->sp_sockets);
466                 INIT_LIST_HEAD(&pool->sp_all_threads);
467                 spin_lock_init(&pool->sp_lock);
468         }
469
470         if (svc_uses_rpcbind(serv)) {
471                 if (svc_rpcb_setup(serv) < 0) {
472                         kfree(serv->sv_pools);
473                         kfree(serv);
474                         return NULL;
475                 }
476                 if (!serv->sv_shutdown)
477                         serv->sv_shutdown = svc_rpcb_cleanup;
478         }
479
480         return serv;
481 }
482
483 struct svc_serv *
484 svc_create(struct svc_program *prog, unsigned int bufsize,
485            void (*shutdown)(struct svc_serv *serv))
486 {
487         return __svc_create(prog, bufsize, /*npools*/1, shutdown);
488 }
489 EXPORT_SYMBOL_GPL(svc_create);
490
491 struct svc_serv *
492 svc_create_pooled(struct svc_program *prog, unsigned int bufsize,
493                   void (*shutdown)(struct svc_serv *serv),
494                   svc_thread_fn func, struct module *mod)
495 {
496         struct svc_serv *serv;
497         unsigned int npools = svc_pool_map_get();
498
499         serv = __svc_create(prog, bufsize, npools, shutdown);
500
501         if (serv != NULL) {
502                 serv->sv_function = func;
503                 serv->sv_module = mod;
504         }
505
506         return serv;
507 }
508 EXPORT_SYMBOL_GPL(svc_create_pooled);
509
510 /*
511  * Destroy an RPC service. Should be called with appropriate locking to
512  * protect the sv_nrthreads, sv_permsocks and sv_tempsocks.
513  */
514 void
515 svc_destroy(struct svc_serv *serv)
516 {
517         dprintk("svc: svc_destroy(%s, %d)\n",
518                                 serv->sv_program->pg_name,
519                                 serv->sv_nrthreads);
520
521         if (serv->sv_nrthreads) {
522                 if (--(serv->sv_nrthreads) != 0) {
523                         svc_sock_update_bufs(serv);
524                         return;
525                 }
526         } else
527                 printk("svc_destroy: no threads for serv=%p!\n", serv);
528
529         del_timer_sync(&serv->sv_temptimer);
530         /*
531          * The set of xprts (contained in the sv_tempsocks and
532          * sv_permsocks lists) is now constant, since it is modified
533          * only by accepting new sockets (done by service threads in
534          * svc_recv) or aging old ones (done by sv_temptimer), or
535          * configuration changes (excluded by whatever locking the
536          * caller is using--nfsd_mutex in the case of nfsd).  So it's
537          * safe to traverse those lists and shut everything down:
538          */
539         svc_close_all(serv);
540
541         if (serv->sv_shutdown)
542                 serv->sv_shutdown(serv);
543
544         cache_clean_deferred(serv);
545
546         if (svc_serv_is_pooled(serv))
547                 svc_pool_map_put();
548
549         kfree(serv->sv_pools);
550         kfree(serv);
551 }
552 EXPORT_SYMBOL_GPL(svc_destroy);
553
554 /*
555  * Allocate an RPC server's buffer space.
556  * We allocate pages and place them in rq_argpages.
557  */
558 static int
559 svc_init_buffer(struct svc_rqst *rqstp, unsigned int size, int node)
560 {
561         unsigned int pages, arghi;
562
563         /* bc_xprt uses fore channel allocated buffers */
564         if (svc_is_backchannel(rqstp))
565                 return 1;
566
567         pages = size / PAGE_SIZE + 1; /* extra page as we hold both request and reply.
568                                        * We assume one is at most one page
569                                        */
570         arghi = 0;
571         BUG_ON(pages > RPCSVC_MAXPAGES);
572         while (pages) {
573                 struct page *p = alloc_pages_node(node, GFP_KERNEL, 0);
574                 if (!p)
575                         break;
576                 rqstp->rq_pages[arghi++] = p;
577                 pages--;
578         }
579         return pages == 0;
580 }
581
582 /*
583  * Release an RPC server buffer
584  */
585 static void
586 svc_release_buffer(struct svc_rqst *rqstp)
587 {
588         unsigned int i;
589
590         for (i = 0; i < ARRAY_SIZE(rqstp->rq_pages); i++)
591                 if (rqstp->rq_pages[i])
592                         put_page(rqstp->rq_pages[i]);
593 }
594
595 struct svc_rqst *
596 svc_prepare_thread(struct svc_serv *serv, struct svc_pool *pool, int node)
597 {
598         struct svc_rqst *rqstp;
599
600         rqstp = kzalloc_node(sizeof(*rqstp), GFP_KERNEL, node);
601         if (!rqstp)
602                 goto out_enomem;
603
604         init_waitqueue_head(&rqstp->rq_wait);
605
606         serv->sv_nrthreads++;
607         spin_lock_bh(&pool->sp_lock);
608         pool->sp_nrthreads++;
609         list_add(&rqstp->rq_all, &pool->sp_all_threads);
610         spin_unlock_bh(&pool->sp_lock);
611         rqstp->rq_server = serv;
612         rqstp->rq_pool = pool;
613
614         rqstp->rq_argp = kmalloc_node(serv->sv_xdrsize, GFP_KERNEL, node);
615         if (!rqstp->rq_argp)
616                 goto out_thread;
617
618         rqstp->rq_resp = kmalloc_node(serv->sv_xdrsize, GFP_KERNEL, node);
619         if (!rqstp->rq_resp)
620                 goto out_thread;
621
622         if (!svc_init_buffer(rqstp, serv->sv_max_mesg, node))
623                 goto out_thread;
624
625         return rqstp;
626 out_thread:
627         svc_exit_thread(rqstp);
628 out_enomem:
629         return ERR_PTR(-ENOMEM);
630 }
631 EXPORT_SYMBOL_GPL(svc_prepare_thread);
632
633 /*
634  * Choose a pool in which to create a new thread, for svc_set_num_threads
635  */
636 static inline struct svc_pool *
637 choose_pool(struct svc_serv *serv, struct svc_pool *pool, unsigned int *state)
638 {
639         if (pool != NULL)
640                 return pool;
641
642         return &serv->sv_pools[(*state)++ % serv->sv_nrpools];
643 }
644
645 /*
646  * Choose a thread to kill, for svc_set_num_threads
647  */
648 static inline struct task_struct *
649 choose_victim(struct svc_serv *serv, struct svc_pool *pool, unsigned int *state)
650 {
651         unsigned int i;
652         struct task_struct *task = NULL;
653
654         if (pool != NULL) {
655                 spin_lock_bh(&pool->sp_lock);
656         } else {
657                 /* choose a pool in round-robin fashion */
658                 for (i = 0; i < serv->sv_nrpools; i++) {
659                         pool = &serv->sv_pools[--(*state) % serv->sv_nrpools];
660                         spin_lock_bh(&pool->sp_lock);
661                         if (!list_empty(&pool->sp_all_threads))
662                                 goto found_pool;
663                         spin_unlock_bh(&pool->sp_lock);
664                 }
665                 return NULL;
666         }
667
668 found_pool:
669         if (!list_empty(&pool->sp_all_threads)) {
670                 struct svc_rqst *rqstp;
671
672                 /*
673                  * Remove from the pool->sp_all_threads list
674                  * so we don't try to kill it again.
675                  */
676                 rqstp = list_entry(pool->sp_all_threads.next, struct svc_rqst, rq_all);
677                 list_del_init(&rqstp->rq_all);
678                 task = rqstp->rq_task;
679         }
680         spin_unlock_bh(&pool->sp_lock);
681
682         return task;
683 }
684
685 /*
686  * Create or destroy enough new threads to make the number
687  * of threads the given number.  If `pool' is non-NULL, applies
688  * only to threads in that pool, otherwise round-robins between
689  * all pools.  Must be called with a svc_get() reference and
690  * the BKL or another lock to protect access to svc_serv fields.
691  *
692  * Destroying threads relies on the service threads filling in
693  * rqstp->rq_task, which only the nfs ones do.  Assumes the serv
694  * has been created using svc_create_pooled().
695  *
696  * Based on code that used to be in nfsd_svc() but tweaked
697  * to be pool-aware.
698  */
699 int
700 svc_set_num_threads(struct svc_serv *serv, struct svc_pool *pool, int nrservs)
701 {
702         struct svc_rqst *rqstp;
703         struct task_struct *task;
704         struct svc_pool *chosen_pool;
705         int error = 0;
706         unsigned int state = serv->sv_nrthreads-1;
707         int node;
708
709         if (pool == NULL) {
710                 /* The -1 assumes caller has done a svc_get() */
711                 nrservs -= (serv->sv_nrthreads-1);
712         } else {
713                 spin_lock_bh(&pool->sp_lock);
714                 nrservs -= pool->sp_nrthreads;
715                 spin_unlock_bh(&pool->sp_lock);
716         }
717
718         /* create new threads */
719         while (nrservs > 0) {
720                 nrservs--;
721                 chosen_pool = choose_pool(serv, pool, &state);
722
723                 node = svc_pool_map_get_node(chosen_pool->sp_id);
724                 rqstp = svc_prepare_thread(serv, chosen_pool, node);
725                 if (IS_ERR(rqstp)) {
726                         error = PTR_ERR(rqstp);
727                         break;
728                 }
729
730                 __module_get(serv->sv_module);
731                 task = kthread_create_on_node(serv->sv_function, rqstp,
732                                               node, serv->sv_name);
733                 if (IS_ERR(task)) {
734                         error = PTR_ERR(task);
735                         module_put(serv->sv_module);
736                         svc_exit_thread(rqstp);
737                         break;
738                 }
739
740                 rqstp->rq_task = task;
741                 if (serv->sv_nrpools > 1)
742                         svc_pool_map_set_cpumask(task, chosen_pool->sp_id);
743
744                 svc_sock_update_bufs(serv);
745                 wake_up_process(task);
746         }
747         /* destroy old threads */
748         while (nrservs < 0 &&
749                (task = choose_victim(serv, pool, &state)) != NULL) {
750                 send_sig(SIGINT, task, 1);
751                 nrservs++;
752         }
753
754         return error;
755 }
756 EXPORT_SYMBOL_GPL(svc_set_num_threads);
757
758 /*
759  * Called from a server thread as it's exiting. Caller must hold the BKL or
760  * the "service mutex", whichever is appropriate for the service.
761  */
762 void
763 svc_exit_thread(struct svc_rqst *rqstp)
764 {
765         struct svc_serv *serv = rqstp->rq_server;
766         struct svc_pool *pool = rqstp->rq_pool;
767
768         svc_release_buffer(rqstp);
769         kfree(rqstp->rq_resp);
770         kfree(rqstp->rq_argp);
771         kfree(rqstp->rq_auth_data);
772
773         spin_lock_bh(&pool->sp_lock);
774         pool->sp_nrthreads--;
775         list_del(&rqstp->rq_all);
776         spin_unlock_bh(&pool->sp_lock);
777
778         kfree(rqstp);
779
780         /* Release the server */
781         if (serv)
782                 svc_destroy(serv);
783 }
784 EXPORT_SYMBOL_GPL(svc_exit_thread);
785
786 /*
787  * Register an "inet" protocol family netid with the local
788  * rpcbind daemon via an rpcbind v4 SET request.
789  *
790  * No netconfig infrastructure is available in the kernel, so
791  * we map IP_ protocol numbers to netids by hand.
792  *
793  * Returns zero on success; a negative errno value is returned
794  * if any error occurs.
795  */
796 static int __svc_rpcb_register4(const u32 program, const u32 version,
797                                 const unsigned short protocol,
798                                 const unsigned short port)
799 {
800         const struct sockaddr_in sin = {
801                 .sin_family             = AF_INET,
802                 .sin_addr.s_addr        = htonl(INADDR_ANY),
803                 .sin_port               = htons(port),
804         };
805         const char *netid;
806         int error;
807
808         switch (protocol) {
809         case IPPROTO_UDP:
810                 netid = RPCBIND_NETID_UDP;
811                 break;
812         case IPPROTO_TCP:
813                 netid = RPCBIND_NETID_TCP;
814                 break;
815         default:
816                 return -ENOPROTOOPT;
817         }
818
819         error = rpcb_v4_register(program, version,
820                                         (const struct sockaddr *)&sin, netid);
821
822         /*
823          * User space didn't support rpcbind v4, so retry this
824          * registration request with the legacy rpcbind v2 protocol.
825          */
826         if (error == -EPROTONOSUPPORT)
827                 error = rpcb_register(program, version, protocol, port);
828
829         return error;
830 }
831
832 #if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
833 /*
834  * Register an "inet6" protocol family netid with the local
835  * rpcbind daemon via an rpcbind v4 SET request.
836  *
837  * No netconfig infrastructure is available in the kernel, so
838  * we map IP_ protocol numbers to netids by hand.
839  *
840  * Returns zero on success; a negative errno value is returned
841  * if any error occurs.
842  */
843 static int __svc_rpcb_register6(const u32 program, const u32 version,
844                                 const unsigned short protocol,
845                                 const unsigned short port)
846 {
847         const struct sockaddr_in6 sin6 = {
848                 .sin6_family            = AF_INET6,
849                 .sin6_addr              = IN6ADDR_ANY_INIT,
850                 .sin6_port              = htons(port),
851         };
852         const char *netid;
853         int error;
854
855         switch (protocol) {
856         case IPPROTO_UDP:
857                 netid = RPCBIND_NETID_UDP6;
858                 break;
859         case IPPROTO_TCP:
860                 netid = RPCBIND_NETID_TCP6;
861                 break;
862         default:
863                 return -ENOPROTOOPT;
864         }
865
866         error = rpcb_v4_register(program, version,
867                                         (const struct sockaddr *)&sin6, netid);
868
869         /*
870          * User space didn't support rpcbind version 4, so we won't
871          * use a PF_INET6 listener.
872          */
873         if (error == -EPROTONOSUPPORT)
874                 error = -EAFNOSUPPORT;
875
876         return error;
877 }
878 #endif  /* defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE) */
879
880 /*
881  * Register a kernel RPC service via rpcbind version 4.
882  *
883  * Returns zero on success; a negative errno value is returned
884  * if any error occurs.
885  */
886 static int __svc_register(const char *progname,
887                           const u32 program, const u32 version,
888                           const int family,
889                           const unsigned short protocol,
890                           const unsigned short port)
891 {
892         int error = -EAFNOSUPPORT;
893
894         switch (family) {
895         case PF_INET:
896                 error = __svc_rpcb_register4(program, version,
897                                                 protocol, port);
898                 break;
899 #if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
900         case PF_INET6:
901                 error = __svc_rpcb_register6(program, version,
902                                                 protocol, port);
903 #endif  /* defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE) */
904         }
905
906         if (error < 0)
907                 printk(KERN_WARNING "svc: failed to register %sv%u RPC "
908                         "service (errno %d).\n", progname, version, -error);
909         return error;
910 }
911
912 /**
913  * svc_register - register an RPC service with the local portmapper
914  * @serv: svc_serv struct for the service to register
915  * @family: protocol family of service's listener socket
916  * @proto: transport protocol number to advertise
917  * @port: port to advertise
918  *
919  * Service is registered for any address in the passed-in protocol family
920  */
921 int svc_register(const struct svc_serv *serv, const int family,
922                  const unsigned short proto, const unsigned short port)
923 {
924         struct svc_program      *progp;
925         unsigned int            i;
926         int                     error = 0;
927
928         BUG_ON(proto == 0 && port == 0);
929
930         for (progp = serv->sv_program; progp; progp = progp->pg_next) {
931                 for (i = 0; i < progp->pg_nvers; i++) {
932                         if (progp->pg_vers[i] == NULL)
933                                 continue;
934
935                         dprintk("svc: svc_register(%sv%d, %s, %u, %u)%s\n",
936                                         progp->pg_name,
937                                         i,
938                                         proto == IPPROTO_UDP?  "udp" : "tcp",
939                                         port,
940                                         family,
941                                         progp->pg_vers[i]->vs_hidden?
942                                                 " (but not telling portmap)" : "");
943
944                         if (progp->pg_vers[i]->vs_hidden)
945                                 continue;
946
947                         error = __svc_register(progp->pg_name, progp->pg_prog,
948                                                 i, family, proto, port);
949                         if (error < 0)
950                                 break;
951                 }
952         }
953
954         return error;
955 }
956
957 /*
958  * If user space is running rpcbind, it should take the v4 UNSET
959  * and clear everything for this [program, version].  If user space
960  * is running portmap, it will reject the v4 UNSET, but won't have
961  * any "inet6" entries anyway.  So a PMAP_UNSET should be sufficient
962  * in this case to clear all existing entries for [program, version].
963  */
964 static void __svc_unregister(const u32 program, const u32 version,
965                              const char *progname)
966 {
967         int error;
968
969         error = rpcb_v4_register(program, version, NULL, "");
970
971         /*
972          * User space didn't support rpcbind v4, so retry this
973          * request with the legacy rpcbind v2 protocol.
974          */
975         if (error == -EPROTONOSUPPORT)
976                 error = rpcb_register(program, version, 0, 0);
977
978         dprintk("svc: %s(%sv%u), error %d\n",
979                         __func__, progname, version, error);
980 }
981
982 /*
983  * All netids, bind addresses and ports registered for [program, version]
984  * are removed from the local rpcbind database (if the service is not
985  * hidden) to make way for a new instance of the service.
986  *
987  * The result of unregistration is reported via dprintk for those who want
988  * verification of the result, but is otherwise not important.
989  */
990 static void svc_unregister(const struct svc_serv *serv)
991 {
992         struct svc_program *progp;
993         unsigned long flags;
994         unsigned int i;
995
996         clear_thread_flag(TIF_SIGPENDING);
997
998         for (progp = serv->sv_program; progp; progp = progp->pg_next) {
999                 for (i = 0; i < progp->pg_nvers; i++) {
1000                         if (progp->pg_vers[i] == NULL)
1001                                 continue;
1002                         if (progp->pg_vers[i]->vs_hidden)
1003                                 continue;
1004
1005                         dprintk("svc: attempting to unregister %sv%u\n",
1006                                 progp->pg_name, i);
1007                         __svc_unregister(progp->pg_prog, i, progp->pg_name);
1008                 }
1009         }
1010
1011         spin_lock_irqsave(&current->sighand->siglock, flags);
1012         recalc_sigpending();
1013         spin_unlock_irqrestore(&current->sighand->siglock, flags);
1014 }
1015
1016 /*
1017  * Printk the given error with the address of the client that caused it.
1018  */
1019 static __printf(2, 3)
1020 int svc_printk(struct svc_rqst *rqstp, const char *fmt, ...)
1021 {
1022         va_list args;
1023         int     r;
1024         char    buf[RPC_MAX_ADDRBUFLEN];
1025
1026         if (!net_ratelimit())
1027                 return 0;
1028
1029         printk(KERN_WARNING "svc: %s: ",
1030                 svc_print_addr(rqstp, buf, sizeof(buf)));
1031
1032         va_start(args, fmt);
1033         r = vprintk(fmt, args);
1034         va_end(args);
1035
1036         return r;
1037 }
1038
1039 /*
1040  * Common routine for processing the RPC request.
1041  */
1042 static int
1043 svc_process_common(struct svc_rqst *rqstp, struct kvec *argv, struct kvec *resv)
1044 {
1045         struct svc_program      *progp;
1046         struct svc_version      *versp = NULL;  /* compiler food */
1047         struct svc_procedure    *procp = NULL;
1048         struct svc_serv         *serv = rqstp->rq_server;
1049         kxdrproc_t              xdr;
1050         __be32                  *statp;
1051         u32                     prog, vers, proc;
1052         __be32                  auth_stat, rpc_stat;
1053         int                     auth_res;
1054         __be32                  *reply_statp;
1055
1056         rpc_stat = rpc_success;
1057
1058         if (argv->iov_len < 6*4)
1059                 goto err_short_len;
1060
1061         /* Will be turned off only in gss privacy case: */
1062         rqstp->rq_splice_ok = 1;
1063         /* Will be turned off only when NFSv4 Sessions are used */
1064         rqstp->rq_usedeferral = 1;
1065         rqstp->rq_dropme = false;
1066
1067         /* Setup reply header */
1068         rqstp->rq_xprt->xpt_ops->xpo_prep_reply_hdr(rqstp);
1069
1070         svc_putu32(resv, rqstp->rq_xid);
1071
1072         vers = svc_getnl(argv);
1073
1074         /* First words of reply: */
1075         svc_putnl(resv, 1);             /* REPLY */
1076
1077         if (vers != 2)          /* RPC version number */
1078                 goto err_bad_rpc;
1079
1080         /* Save position in case we later decide to reject: */
1081         reply_statp = resv->iov_base + resv->iov_len;
1082
1083         svc_putnl(resv, 0);             /* ACCEPT */
1084
1085         rqstp->rq_prog = prog = svc_getnl(argv);        /* program number */
1086         rqstp->rq_vers = vers = svc_getnl(argv);        /* version number */
1087         rqstp->rq_proc = proc = svc_getnl(argv);        /* procedure number */
1088
1089         progp = serv->sv_program;
1090
1091         for (progp = serv->sv_program; progp; progp = progp->pg_next)
1092                 if (prog == progp->pg_prog)
1093                         break;
1094
1095         /*
1096          * Decode auth data, and add verifier to reply buffer.
1097          * We do this before anything else in order to get a decent
1098          * auth verifier.
1099          */
1100         auth_res = svc_authenticate(rqstp, &auth_stat);
1101         /* Also give the program a chance to reject this call: */
1102         if (auth_res == SVC_OK && progp) {
1103                 auth_stat = rpc_autherr_badcred;
1104                 auth_res = progp->pg_authenticate(rqstp);
1105         }
1106         switch (auth_res) {
1107         case SVC_OK:
1108                 break;
1109         case SVC_GARBAGE:
1110                 goto err_garbage;
1111         case SVC_SYSERR:
1112                 rpc_stat = rpc_system_err;
1113                 goto err_bad;
1114         case SVC_DENIED:
1115                 goto err_bad_auth;
1116         case SVC_CLOSE:
1117                 if (test_bit(XPT_TEMP, &rqstp->rq_xprt->xpt_flags))
1118                         svc_close_xprt(rqstp->rq_xprt);
1119         case SVC_DROP:
1120                 goto dropit;
1121         case SVC_COMPLETE:
1122                 goto sendit;
1123         }
1124
1125         if (progp == NULL)
1126                 goto err_bad_prog;
1127
1128         if (vers >= progp->pg_nvers ||
1129           !(versp = progp->pg_vers[vers]))
1130                 goto err_bad_vers;
1131
1132         procp = versp->vs_proc + proc;
1133         if (proc >= versp->vs_nproc || !procp->pc_func)
1134                 goto err_bad_proc;
1135         rqstp->rq_procinfo = procp;
1136
1137         /* Syntactic check complete */
1138         serv->sv_stats->rpccnt++;
1139
1140         /* Build the reply header. */
1141         statp = resv->iov_base +resv->iov_len;
1142         svc_putnl(resv, RPC_SUCCESS);
1143
1144         /* Bump per-procedure stats counter */
1145         procp->pc_count++;
1146
1147         /* Initialize storage for argp and resp */
1148         memset(rqstp->rq_argp, 0, procp->pc_argsize);
1149         memset(rqstp->rq_resp, 0, procp->pc_ressize);
1150
1151         /* un-reserve some of the out-queue now that we have a
1152          * better idea of reply size
1153          */
1154         if (procp->pc_xdrressize)
1155                 svc_reserve_auth(rqstp, procp->pc_xdrressize<<2);
1156
1157         /* Call the function that processes the request. */
1158         if (!versp->vs_dispatch) {
1159                 /* Decode arguments */
1160                 xdr = procp->pc_decode;
1161                 if (xdr && !xdr(rqstp, argv->iov_base, rqstp->rq_argp))
1162                         goto err_garbage;
1163
1164                 *statp = procp->pc_func(rqstp, rqstp->rq_argp, rqstp->rq_resp);
1165
1166                 /* Encode reply */
1167                 if (rqstp->rq_dropme) {
1168                         if (procp->pc_release)
1169                                 procp->pc_release(rqstp, NULL, rqstp->rq_resp);
1170                         goto dropit;
1171                 }
1172                 if (*statp == rpc_success &&
1173                     (xdr = procp->pc_encode) &&
1174                     !xdr(rqstp, resv->iov_base+resv->iov_len, rqstp->rq_resp)) {
1175                         dprintk("svc: failed to encode reply\n");
1176                         /* serv->sv_stats->rpcsystemerr++; */
1177                         *statp = rpc_system_err;
1178                 }
1179         } else {
1180                 dprintk("svc: calling dispatcher\n");
1181                 if (!versp->vs_dispatch(rqstp, statp)) {
1182                         /* Release reply info */
1183                         if (procp->pc_release)
1184                                 procp->pc_release(rqstp, NULL, rqstp->rq_resp);
1185                         goto dropit;
1186                 }
1187         }
1188
1189         /* Check RPC status result */
1190         if (*statp != rpc_success)
1191                 resv->iov_len = ((void*)statp)  - resv->iov_base + 4;
1192
1193         /* Release reply info */
1194         if (procp->pc_release)
1195                 procp->pc_release(rqstp, NULL, rqstp->rq_resp);
1196
1197         if (procp->pc_encode == NULL)
1198                 goto dropit;
1199
1200  sendit:
1201         if (svc_authorise(rqstp))
1202                 goto dropit;
1203         return 1;               /* Caller can now send it */
1204
1205  dropit:
1206         svc_authorise(rqstp);   /* doesn't hurt to call this twice */
1207         dprintk("svc: svc_process dropit\n");
1208         return 0;
1209
1210 err_short_len:
1211         svc_printk(rqstp, "short len %Zd, dropping request\n",
1212                         argv->iov_len);
1213
1214         goto dropit;                    /* drop request */
1215
1216 err_bad_rpc:
1217         serv->sv_stats->rpcbadfmt++;
1218         svc_putnl(resv, 1);     /* REJECT */
1219         svc_putnl(resv, 0);     /* RPC_MISMATCH */
1220         svc_putnl(resv, 2);     /* Only RPCv2 supported */
1221         svc_putnl(resv, 2);
1222         goto sendit;
1223
1224 err_bad_auth:
1225         dprintk("svc: authentication failed (%d)\n", ntohl(auth_stat));
1226         serv->sv_stats->rpcbadauth++;
1227         /* Restore write pointer to location of accept status: */
1228         xdr_ressize_check(rqstp, reply_statp);
1229         svc_putnl(resv, 1);     /* REJECT */
1230         svc_putnl(resv, 1);     /* AUTH_ERROR */
1231         svc_putnl(resv, ntohl(auth_stat));      /* status */
1232         goto sendit;
1233
1234 err_bad_prog:
1235         dprintk("svc: unknown program %d\n", prog);
1236         serv->sv_stats->rpcbadfmt++;
1237         svc_putnl(resv, RPC_PROG_UNAVAIL);
1238         goto sendit;
1239
1240 err_bad_vers:
1241         svc_printk(rqstp, "unknown version (%d for prog %d, %s)\n",
1242                        vers, prog, progp->pg_name);
1243
1244         serv->sv_stats->rpcbadfmt++;
1245         svc_putnl(resv, RPC_PROG_MISMATCH);
1246         svc_putnl(resv, progp->pg_lovers);
1247         svc_putnl(resv, progp->pg_hivers);
1248         goto sendit;
1249
1250 err_bad_proc:
1251         svc_printk(rqstp, "unknown procedure (%d)\n", proc);
1252
1253         serv->sv_stats->rpcbadfmt++;
1254         svc_putnl(resv, RPC_PROC_UNAVAIL);
1255         goto sendit;
1256
1257 err_garbage:
1258         svc_printk(rqstp, "failed to decode args\n");
1259
1260         rpc_stat = rpc_garbage_args;
1261 err_bad:
1262         serv->sv_stats->rpcbadfmt++;
1263         svc_putnl(resv, ntohl(rpc_stat));
1264         goto sendit;
1265 }
1266 EXPORT_SYMBOL_GPL(svc_process);
1267
1268 /*
1269  * Process the RPC request.
1270  */
1271 int
1272 svc_process(struct svc_rqst *rqstp)
1273 {
1274         struct kvec             *argv = &rqstp->rq_arg.head[0];
1275         struct kvec             *resv = &rqstp->rq_res.head[0];
1276         struct svc_serv         *serv = rqstp->rq_server;
1277         u32                     dir;
1278
1279         /*
1280          * Setup response xdr_buf.
1281          * Initially it has just one page
1282          */
1283         rqstp->rq_resused = 1;
1284         resv->iov_base = page_address(rqstp->rq_respages[0]);
1285         resv->iov_len = 0;
1286         rqstp->rq_res.pages = rqstp->rq_respages + 1;
1287         rqstp->rq_res.len = 0;
1288         rqstp->rq_res.page_base = 0;
1289         rqstp->rq_res.page_len = 0;
1290         rqstp->rq_res.buflen = PAGE_SIZE;
1291         rqstp->rq_res.tail[0].iov_base = NULL;
1292         rqstp->rq_res.tail[0].iov_len = 0;
1293
1294         rqstp->rq_xid = svc_getu32(argv);
1295
1296         dir  = svc_getnl(argv);
1297         if (dir != 0) {
1298                 /* direction != CALL */
1299                 svc_printk(rqstp, "bad direction %d, dropping request\n", dir);
1300                 serv->sv_stats->rpcbadfmt++;
1301                 svc_drop(rqstp);
1302                 return 0;
1303         }
1304
1305         /* Returns 1 for send, 0 for drop */
1306         if (svc_process_common(rqstp, argv, resv))
1307                 return svc_send(rqstp);
1308         else {
1309                 svc_drop(rqstp);
1310                 return 0;
1311         }
1312 }
1313
1314 #if defined(CONFIG_SUNRPC_BACKCHANNEL)
1315 /*
1316  * Process a backchannel RPC request that arrived over an existing
1317  * outbound connection
1318  */
1319 int
1320 bc_svc_process(struct svc_serv *serv, struct rpc_rqst *req,
1321                struct svc_rqst *rqstp)
1322 {
1323         struct kvec     *argv = &rqstp->rq_arg.head[0];
1324         struct kvec     *resv = &rqstp->rq_res.head[0];
1325
1326         /* Build the svc_rqst used by the common processing routine */
1327         rqstp->rq_xprt = serv->sv_bc_xprt;
1328         rqstp->rq_xid = req->rq_xid;
1329         rqstp->rq_prot = req->rq_xprt->prot;
1330         rqstp->rq_server = serv;
1331
1332         rqstp->rq_addrlen = sizeof(req->rq_xprt->addr);
1333         memcpy(&rqstp->rq_addr, &req->rq_xprt->addr, rqstp->rq_addrlen);
1334         memcpy(&rqstp->rq_arg, &req->rq_rcv_buf, sizeof(rqstp->rq_arg));
1335         memcpy(&rqstp->rq_res, &req->rq_snd_buf, sizeof(rqstp->rq_res));
1336
1337         /* reset result send buffer "put" position */
1338         resv->iov_len = 0;
1339
1340         if (rqstp->rq_prot != IPPROTO_TCP) {
1341                 printk(KERN_ERR "No support for Non-TCP transports!\n");
1342                 BUG();
1343         }
1344
1345         /*
1346          * Skip the next two words because they've already been
1347          * processed in the trasport
1348          */
1349         svc_getu32(argv);       /* XID */
1350         svc_getnl(argv);        /* CALLDIR */
1351
1352         /* Returns 1 for send, 0 for drop */
1353         if (svc_process_common(rqstp, argv, resv)) {
1354                 memcpy(&req->rq_snd_buf, &rqstp->rq_res,
1355                                                 sizeof(req->rq_snd_buf));
1356                 return bc_send(req);
1357         } else {
1358                 /* Nothing to do to drop request */
1359                 return 0;
1360         }
1361 }
1362 EXPORT_SYMBOL_GPL(bc_svc_process);
1363 #endif /* CONFIG_SUNRPC_BACKCHANNEL */
1364
1365 /*
1366  * Return (transport-specific) limit on the rpc payload.
1367  */
1368 u32 svc_max_payload(const struct svc_rqst *rqstp)
1369 {
1370         u32 max = rqstp->rq_xprt->xpt_class->xcl_max_payload;
1371
1372         if (rqstp->rq_server->sv_max_payload < max)
1373                 max = rqstp->rq_server->sv_max_payload;
1374         return max;
1375 }
1376 EXPORT_SYMBOL_GPL(svc_max_payload);
This page took 0.108871 seconds and 4 git commands to generate.