Merge git://git.infradead.org/~dedekind/ubi-2.6
[linux-2.6] / 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 <okir@monad.swb.de>
7  *
8  * Multiple threads pools and NUMAisation
9  * Copyright (c) 2006 Silicon Graphics, Inc.
10  * by Greg Banks <gnb@melbourne.sgi.com>
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/sched.h>
22
23 #include <linux/sunrpc/types.h>
24 #include <linux/sunrpc/xdr.h>
25 #include <linux/sunrpc/stats.h>
26 #include <linux/sunrpc/svcsock.h>
27 #include <linux/sunrpc/clnt.h>
28
29 #define RPCDBG_FACILITY RPCDBG_SVCDSP
30
31 #define svc_serv_is_pooled(serv)    ((serv)->sv_function)
32
33 /*
34  * Mode for mapping cpus to pools.
35  */
36 enum {
37         SVC_POOL_AUTO = -1,     /* choose one of the others */
38         SVC_POOL_GLOBAL,        /* no mapping, just a single global pool
39                                  * (legacy & UP mode) */
40         SVC_POOL_PERCPU,        /* one pool per cpu */
41         SVC_POOL_PERNODE        /* one pool per numa node */
42 };
43 #define SVC_POOL_DEFAULT        SVC_POOL_GLOBAL
44
45 /*
46  * Structure for mapping cpus to pools and vice versa.
47  * Setup once during sunrpc initialisation.
48  */
49 static struct svc_pool_map {
50         int count;                      /* How many svc_servs use us */
51         int mode;                       /* Note: int not enum to avoid
52                                          * warnings about "enumeration value
53                                          * not handled in switch" */
54         unsigned int npools;
55         unsigned int *pool_to;          /* maps pool id to cpu or node */
56         unsigned int *to_pool;          /* maps cpu or node to pool id */
57 } svc_pool_map = {
58         .count = 0,
59         .mode = SVC_POOL_DEFAULT
60 };
61 static DEFINE_MUTEX(svc_pool_map_mutex);/* protects svc_pool_map.count only */
62
63 static int
64 param_set_pool_mode(const char *val, struct kernel_param *kp)
65 {
66         int *ip = (int *)kp->arg;
67         struct svc_pool_map *m = &svc_pool_map;
68         int err;
69
70         mutex_lock(&svc_pool_map_mutex);
71
72         err = -EBUSY;
73         if (m->count)
74                 goto out;
75
76         err = 0;
77         if (!strncmp(val, "auto", 4))
78                 *ip = SVC_POOL_AUTO;
79         else if (!strncmp(val, "global", 6))
80                 *ip = SVC_POOL_GLOBAL;
81         else if (!strncmp(val, "percpu", 6))
82                 *ip = SVC_POOL_PERCPU;
83         else if (!strncmp(val, "pernode", 7))
84                 *ip = SVC_POOL_PERNODE;
85         else
86                 err = -EINVAL;
87
88 out:
89         mutex_unlock(&svc_pool_map_mutex);
90         return err;
91 }
92
93 static int
94 param_get_pool_mode(char *buf, struct kernel_param *kp)
95 {
96         int *ip = (int *)kp->arg;
97
98         switch (*ip)
99         {
100         case SVC_POOL_AUTO:
101                 return strlcpy(buf, "auto", 20);
102         case SVC_POOL_GLOBAL:
103                 return strlcpy(buf, "global", 20);
104         case SVC_POOL_PERCPU:
105                 return strlcpy(buf, "percpu", 20);
106         case SVC_POOL_PERNODE:
107                 return strlcpy(buf, "pernode", 20);
108         default:
109                 return sprintf(buf, "%d", *ip);
110         }
111 }
112
113 module_param_call(pool_mode, param_set_pool_mode, param_get_pool_mode,
114                  &svc_pool_map.mode, 0644);
115
116 /*
117  * Detect best pool mapping mode heuristically,
118  * according to the machine's topology.
119  */
120 static int
121 svc_pool_map_choose_mode(void)
122 {
123         unsigned int node;
124
125         if (num_online_nodes() > 1) {
126                 /*
127                  * Actually have multiple NUMA nodes,
128                  * so split pools on NUMA node boundaries
129                  */
130                 return SVC_POOL_PERNODE;
131         }
132
133         node = any_online_node(node_online_map);
134         if (nr_cpus_node(node) > 2) {
135                 /*
136                  * Non-trivial SMP, or CONFIG_NUMA on
137                  * non-NUMA hardware, e.g. with a generic
138                  * x86_64 kernel on Xeons.  In this case we
139                  * want to divide the pools on cpu boundaries.
140                  */
141                 return SVC_POOL_PERCPU;
142         }
143
144         /* default: one global pool */
145         return SVC_POOL_GLOBAL;
146 }
147
148 /*
149  * Allocate the to_pool[] and pool_to[] arrays.
150  * Returns 0 on success or an errno.
151  */
152 static int
153 svc_pool_map_alloc_arrays(struct svc_pool_map *m, unsigned int maxpools)
154 {
155         m->to_pool = kcalloc(maxpools, sizeof(unsigned int), GFP_KERNEL);
156         if (!m->to_pool)
157                 goto fail;
158         m->pool_to = kcalloc(maxpools, sizeof(unsigned int), GFP_KERNEL);
159         if (!m->pool_to)
160                 goto fail_free;
161
162         return 0;
163
164 fail_free:
165         kfree(m->to_pool);
166 fail:
167         return -ENOMEM;
168 }
169
170 /*
171  * Initialise the pool map for SVC_POOL_PERCPU mode.
172  * Returns number of pools or <0 on error.
173  */
174 static int
175 svc_pool_map_init_percpu(struct svc_pool_map *m)
176 {
177         unsigned int maxpools = nr_cpu_ids;
178         unsigned int pidx = 0;
179         unsigned int cpu;
180         int err;
181
182         err = svc_pool_map_alloc_arrays(m, maxpools);
183         if (err)
184                 return err;
185
186         for_each_online_cpu(cpu) {
187                 BUG_ON(pidx > maxpools);
188                 m->to_pool[cpu] = pidx;
189                 m->pool_to[pidx] = cpu;
190                 pidx++;
191         }
192         /* cpus brought online later all get mapped to pool0, sorry */
193
194         return pidx;
195 };
196
197
198 /*
199  * Initialise the pool map for SVC_POOL_PERNODE mode.
200  * Returns number of pools or <0 on error.
201  */
202 static int
203 svc_pool_map_init_pernode(struct svc_pool_map *m)
204 {
205         unsigned int maxpools = nr_node_ids;
206         unsigned int pidx = 0;
207         unsigned int node;
208         int err;
209
210         err = svc_pool_map_alloc_arrays(m, maxpools);
211         if (err)
212                 return err;
213
214         for_each_node_with_cpus(node) {
215                 /* some architectures (e.g. SN2) have cpuless nodes */
216                 BUG_ON(pidx > maxpools);
217                 m->to_pool[node] = pidx;
218                 m->pool_to[pidx] = node;
219                 pidx++;
220         }
221         /* nodes brought online later all get mapped to pool0, sorry */
222
223         return pidx;
224 }
225
226
227 /*
228  * Add a reference to the global map of cpus to pools (and
229  * vice versa).  Initialise the map if we're the first user.
230  * Returns the number of pools.
231  */
232 static unsigned int
233 svc_pool_map_get(void)
234 {
235         struct svc_pool_map *m = &svc_pool_map;
236         int npools = -1;
237
238         mutex_lock(&svc_pool_map_mutex);
239
240         if (m->count++) {
241                 mutex_unlock(&svc_pool_map_mutex);
242                 return m->npools;
243         }
244
245         if (m->mode == SVC_POOL_AUTO)
246                 m->mode = svc_pool_map_choose_mode();
247
248         switch (m->mode) {
249         case SVC_POOL_PERCPU:
250                 npools = svc_pool_map_init_percpu(m);
251                 break;
252         case SVC_POOL_PERNODE:
253                 npools = svc_pool_map_init_pernode(m);
254                 break;
255         }
256
257         if (npools < 0) {
258                 /* default, or memory allocation failure */
259                 npools = 1;
260                 m->mode = SVC_POOL_GLOBAL;
261         }
262         m->npools = npools;
263
264         mutex_unlock(&svc_pool_map_mutex);
265         return m->npools;
266 }
267
268
269 /*
270  * Drop a reference to the global map of cpus to pools.
271  * When the last reference is dropped, the map data is
272  * freed; this allows the sysadmin to change the pool
273  * mode using the pool_mode module option without
274  * rebooting or re-loading sunrpc.ko.
275  */
276 static void
277 svc_pool_map_put(void)
278 {
279         struct svc_pool_map *m = &svc_pool_map;
280
281         mutex_lock(&svc_pool_map_mutex);
282
283         if (!--m->count) {
284                 m->mode = SVC_POOL_DEFAULT;
285                 kfree(m->to_pool);
286                 kfree(m->pool_to);
287                 m->npools = 0;
288         }
289
290         mutex_unlock(&svc_pool_map_mutex);
291 }
292
293
294 /*
295  * Set the current thread's cpus_allowed mask so that it
296  * will only run on cpus in the given pool.
297  *
298  * Returns 1 and fills in oldmask iff a cpumask was applied.
299  */
300 static inline int
301 svc_pool_map_set_cpumask(unsigned int pidx, cpumask_t *oldmask)
302 {
303         struct svc_pool_map *m = &svc_pool_map;
304
305         /*
306          * The caller checks for sv_nrpools > 1, which
307          * implies that we've been initialized.
308          */
309         BUG_ON(m->count == 0);
310
311         switch (m->mode)
312         {
313         default:
314                 return 0;
315         case SVC_POOL_PERCPU:
316         {
317                 unsigned int cpu = m->pool_to[pidx];
318
319                 *oldmask = current->cpus_allowed;
320                 set_cpus_allowed_ptr(current, &cpumask_of_cpu(cpu));
321                 return 1;
322         }
323         case SVC_POOL_PERNODE:
324         {
325                 unsigned int node = m->pool_to[pidx];
326                 node_to_cpumask_ptr(nodecpumask, node);
327
328                 *oldmask = current->cpus_allowed;
329                 set_cpus_allowed_ptr(current, nodecpumask);
330                 return 1;
331         }
332         }
333 }
334
335 /*
336  * Use the mapping mode to choose a pool for a given CPU.
337  * Used when enqueueing an incoming RPC.  Always returns
338  * a non-NULL pool pointer.
339  */
340 struct svc_pool *
341 svc_pool_for_cpu(struct svc_serv *serv, int cpu)
342 {
343         struct svc_pool_map *m = &svc_pool_map;
344         unsigned int pidx = 0;
345
346         /*
347          * An uninitialised map happens in a pure client when
348          * lockd is brought up, so silently treat it the
349          * same as SVC_POOL_GLOBAL.
350          */
351         if (svc_serv_is_pooled(serv)) {
352                 switch (m->mode) {
353                 case SVC_POOL_PERCPU:
354                         pidx = m->to_pool[cpu];
355                         break;
356                 case SVC_POOL_PERNODE:
357                         pidx = m->to_pool[cpu_to_node(cpu)];
358                         break;
359                 }
360         }
361         return &serv->sv_pools[pidx % serv->sv_nrpools];
362 }
363
364
365 /*
366  * Create an RPC service
367  */
368 static struct svc_serv *
369 __svc_create(struct svc_program *prog, unsigned int bufsize, int npools,
370            void (*shutdown)(struct svc_serv *serv))
371 {
372         struct svc_serv *serv;
373         unsigned int vers;
374         unsigned int xdrsize;
375         unsigned int i;
376
377         if (!(serv = kzalloc(sizeof(*serv), GFP_KERNEL)))
378                 return NULL;
379         serv->sv_name      = prog->pg_name;
380         serv->sv_program   = prog;
381         serv->sv_nrthreads = 1;
382         serv->sv_stats     = prog->pg_stats;
383         if (bufsize > RPCSVC_MAXPAYLOAD)
384                 bufsize = RPCSVC_MAXPAYLOAD;
385         serv->sv_max_payload = bufsize? bufsize : 4096;
386         serv->sv_max_mesg  = roundup(serv->sv_max_payload + PAGE_SIZE, PAGE_SIZE);
387         serv->sv_shutdown  = shutdown;
388         xdrsize = 0;
389         while (prog) {
390                 prog->pg_lovers = prog->pg_nvers-1;
391                 for (vers=0; vers<prog->pg_nvers ; vers++)
392                         if (prog->pg_vers[vers]) {
393                                 prog->pg_hivers = vers;
394                                 if (prog->pg_lovers > vers)
395                                         prog->pg_lovers = vers;
396                                 if (prog->pg_vers[vers]->vs_xdrsize > xdrsize)
397                                         xdrsize = prog->pg_vers[vers]->vs_xdrsize;
398                         }
399                 prog = prog->pg_next;
400         }
401         serv->sv_xdrsize   = xdrsize;
402         INIT_LIST_HEAD(&serv->sv_tempsocks);
403         INIT_LIST_HEAD(&serv->sv_permsocks);
404         init_timer(&serv->sv_temptimer);
405         spin_lock_init(&serv->sv_lock);
406
407         serv->sv_nrpools = npools;
408         serv->sv_pools =
409                 kcalloc(serv->sv_nrpools, sizeof(struct svc_pool),
410                         GFP_KERNEL);
411         if (!serv->sv_pools) {
412                 kfree(serv);
413                 return NULL;
414         }
415
416         for (i = 0; i < serv->sv_nrpools; i++) {
417                 struct svc_pool *pool = &serv->sv_pools[i];
418
419                 dprintk("svc: initialising pool %u for %s\n",
420                                 i, serv->sv_name);
421
422                 pool->sp_id = i;
423                 INIT_LIST_HEAD(&pool->sp_threads);
424                 INIT_LIST_HEAD(&pool->sp_sockets);
425                 INIT_LIST_HEAD(&pool->sp_all_threads);
426                 spin_lock_init(&pool->sp_lock);
427         }
428
429
430         /* Remove any stale portmap registrations */
431         svc_register(serv, 0, 0);
432
433         return serv;
434 }
435
436 struct svc_serv *
437 svc_create(struct svc_program *prog, unsigned int bufsize,
438                 void (*shutdown)(struct svc_serv *serv))
439 {
440         return __svc_create(prog, bufsize, /*npools*/1, shutdown);
441 }
442 EXPORT_SYMBOL(svc_create);
443
444 struct svc_serv *
445 svc_create_pooled(struct svc_program *prog, unsigned int bufsize,
446                 void (*shutdown)(struct svc_serv *serv),
447                   svc_thread_fn func, int sig, struct module *mod)
448 {
449         struct svc_serv *serv;
450         unsigned int npools = svc_pool_map_get();
451
452         serv = __svc_create(prog, bufsize, npools, shutdown);
453
454         if (serv != NULL) {
455                 serv->sv_function = func;
456                 serv->sv_kill_signal = sig;
457                 serv->sv_module = mod;
458         }
459
460         return serv;
461 }
462 EXPORT_SYMBOL(svc_create_pooled);
463
464 /*
465  * Destroy an RPC service.  Should be called with the BKL held
466  */
467 void
468 svc_destroy(struct svc_serv *serv)
469 {
470         dprintk("svc: svc_destroy(%s, %d)\n",
471                                 serv->sv_program->pg_name,
472                                 serv->sv_nrthreads);
473
474         if (serv->sv_nrthreads) {
475                 if (--(serv->sv_nrthreads) != 0) {
476                         svc_sock_update_bufs(serv);
477                         return;
478                 }
479         } else
480                 printk("svc_destroy: no threads for serv=%p!\n", serv);
481
482         del_timer_sync(&serv->sv_temptimer);
483
484         svc_close_all(&serv->sv_tempsocks);
485
486         if (serv->sv_shutdown)
487                 serv->sv_shutdown(serv);
488
489         svc_close_all(&serv->sv_permsocks);
490
491         BUG_ON(!list_empty(&serv->sv_permsocks));
492         BUG_ON(!list_empty(&serv->sv_tempsocks));
493
494         cache_clean_deferred(serv);
495
496         if (svc_serv_is_pooled(serv))
497                 svc_pool_map_put();
498
499         /* Unregister service with the portmapper */
500         svc_register(serv, 0, 0);
501         kfree(serv->sv_pools);
502         kfree(serv);
503 }
504 EXPORT_SYMBOL(svc_destroy);
505
506 /*
507  * Allocate an RPC server's buffer space.
508  * We allocate pages and place them in rq_argpages.
509  */
510 static int
511 svc_init_buffer(struct svc_rqst *rqstp, unsigned int size)
512 {
513         int pages;
514         int arghi;
515
516         pages = size / PAGE_SIZE + 1; /* extra page as we hold both request and reply.
517                                        * We assume one is at most one page
518                                        */
519         arghi = 0;
520         BUG_ON(pages > RPCSVC_MAXPAGES);
521         while (pages) {
522                 struct page *p = alloc_page(GFP_KERNEL);
523                 if (!p)
524                         break;
525                 rqstp->rq_pages[arghi++] = p;
526                 pages--;
527         }
528         return ! pages;
529 }
530
531 /*
532  * Release an RPC server buffer
533  */
534 static void
535 svc_release_buffer(struct svc_rqst *rqstp)
536 {
537         int i;
538         for (i=0; i<ARRAY_SIZE(rqstp->rq_pages); i++)
539                 if (rqstp->rq_pages[i])
540                         put_page(rqstp->rq_pages[i]);
541 }
542
543 struct svc_rqst *
544 svc_prepare_thread(struct svc_serv *serv, struct svc_pool *pool)
545 {
546         struct svc_rqst *rqstp;
547
548         rqstp = kzalloc(sizeof(*rqstp), GFP_KERNEL);
549         if (!rqstp)
550                 goto out_enomem;
551
552         init_waitqueue_head(&rqstp->rq_wait);
553
554         serv->sv_nrthreads++;
555         spin_lock_bh(&pool->sp_lock);
556         pool->sp_nrthreads++;
557         list_add(&rqstp->rq_all, &pool->sp_all_threads);
558         spin_unlock_bh(&pool->sp_lock);
559         rqstp->rq_server = serv;
560         rqstp->rq_pool = pool;
561
562         rqstp->rq_argp = kmalloc(serv->sv_xdrsize, GFP_KERNEL);
563         if (!rqstp->rq_argp)
564                 goto out_thread;
565
566         rqstp->rq_resp = kmalloc(serv->sv_xdrsize, GFP_KERNEL);
567         if (!rqstp->rq_resp)
568                 goto out_thread;
569
570         if (!svc_init_buffer(rqstp, serv->sv_max_mesg))
571                 goto out_thread;
572
573         return rqstp;
574 out_thread:
575         svc_exit_thread(rqstp);
576 out_enomem:
577         return ERR_PTR(-ENOMEM);
578 }
579 EXPORT_SYMBOL(svc_prepare_thread);
580
581 /*
582  * Create a thread in the given pool.  Caller must hold BKL.
583  * On a NUMA or SMP machine, with a multi-pool serv, the thread
584  * will be restricted to run on the cpus belonging to the pool.
585  */
586 static int
587 __svc_create_thread(svc_thread_fn func, struct svc_serv *serv,
588                     struct svc_pool *pool)
589 {
590         struct svc_rqst *rqstp;
591         int             error = -ENOMEM;
592         int             have_oldmask = 0;
593         cpumask_t       oldmask;
594
595         rqstp = svc_prepare_thread(serv, pool);
596         if (IS_ERR(rqstp)) {
597                 error = PTR_ERR(rqstp);
598                 goto out;
599         }
600
601         if (serv->sv_nrpools > 1)
602                 have_oldmask = svc_pool_map_set_cpumask(pool->sp_id, &oldmask);
603
604         error = kernel_thread((int (*)(void *)) func, rqstp, 0);
605
606         if (have_oldmask)
607                 set_cpus_allowed(current, oldmask);
608
609         if (error < 0)
610                 goto out_thread;
611         svc_sock_update_bufs(serv);
612         error = 0;
613 out:
614         return error;
615
616 out_thread:
617         svc_exit_thread(rqstp);
618         goto out;
619 }
620
621 /*
622  * Create a thread in the default pool.  Caller must hold BKL.
623  */
624 int
625 svc_create_thread(svc_thread_fn func, struct svc_serv *serv)
626 {
627         return __svc_create_thread(func, serv, &serv->sv_pools[0]);
628 }
629 EXPORT_SYMBOL(svc_create_thread);
630
631 /*
632  * Choose a pool in which to create a new thread, for svc_set_num_threads
633  */
634 static inline struct svc_pool *
635 choose_pool(struct svc_serv *serv, struct svc_pool *pool, unsigned int *state)
636 {
637         if (pool != NULL)
638                 return pool;
639
640         return &serv->sv_pools[(*state)++ % serv->sv_nrpools];
641 }
642
643 /*
644  * Choose a thread to kill, for svc_set_num_threads
645  */
646 static inline struct task_struct *
647 choose_victim(struct svc_serv *serv, struct svc_pool *pool, unsigned int *state)
648 {
649         unsigned int i;
650         struct task_struct *task = NULL;
651
652         if (pool != NULL) {
653                 spin_lock_bh(&pool->sp_lock);
654         } else {
655                 /* choose a pool in round-robin fashion */
656                 for (i = 0; i < serv->sv_nrpools; i++) {
657                         pool = &serv->sv_pools[--(*state) % serv->sv_nrpools];
658                         spin_lock_bh(&pool->sp_lock);
659                         if (!list_empty(&pool->sp_all_threads))
660                                 goto found_pool;
661                         spin_unlock_bh(&pool->sp_lock);
662                 }
663                 return NULL;
664         }
665
666 found_pool:
667         if (!list_empty(&pool->sp_all_threads)) {
668                 struct svc_rqst *rqstp;
669
670                 /*
671                  * Remove from the pool->sp_all_threads list
672                  * so we don't try to kill it again.
673                  */
674                 rqstp = list_entry(pool->sp_all_threads.next, struct svc_rqst, rq_all);
675                 list_del_init(&rqstp->rq_all);
676                 task = rqstp->rq_task;
677         }
678         spin_unlock_bh(&pool->sp_lock);
679
680         return task;
681 }
682
683 /*
684  * Create or destroy enough new threads to make the number
685  * of threads the given number.  If `pool' is non-NULL, applies
686  * only to threads in that pool, otherwise round-robins between
687  * all pools.  Must be called with a svc_get() reference and
688  * the BKL held.
689  *
690  * Destroying threads relies on the service threads filling in
691  * rqstp->rq_task, which only the nfs ones do.  Assumes the serv
692  * has been created using svc_create_pooled().
693  *
694  * Based on code that used to be in nfsd_svc() but tweaked
695  * to be pool-aware.
696  */
697 int
698 svc_set_num_threads(struct svc_serv *serv, struct svc_pool *pool, int nrservs)
699 {
700         struct task_struct *victim;
701         int error = 0;
702         unsigned int state = serv->sv_nrthreads-1;
703
704         if (pool == NULL) {
705                 /* The -1 assumes caller has done a svc_get() */
706                 nrservs -= (serv->sv_nrthreads-1);
707         } else {
708                 spin_lock_bh(&pool->sp_lock);
709                 nrservs -= pool->sp_nrthreads;
710                 spin_unlock_bh(&pool->sp_lock);
711         }
712
713         /* create new threads */
714         while (nrservs > 0) {
715                 nrservs--;
716                 __module_get(serv->sv_module);
717                 error = __svc_create_thread(serv->sv_function, serv,
718                                             choose_pool(serv, pool, &state));
719                 if (error < 0) {
720                         module_put(serv->sv_module);
721                         break;
722                 }
723         }
724         /* destroy old threads */
725         while (nrservs < 0 &&
726                (victim = choose_victim(serv, pool, &state)) != NULL) {
727                 send_sig(serv->sv_kill_signal, victim, 1);
728                 nrservs++;
729         }
730
731         return error;
732 }
733 EXPORT_SYMBOL(svc_set_num_threads);
734
735 /*
736  * Called from a server thread as it's exiting.  Caller must hold BKL.
737  */
738 void
739 svc_exit_thread(struct svc_rqst *rqstp)
740 {
741         struct svc_serv *serv = rqstp->rq_server;
742         struct svc_pool *pool = rqstp->rq_pool;
743
744         svc_release_buffer(rqstp);
745         kfree(rqstp->rq_resp);
746         kfree(rqstp->rq_argp);
747         kfree(rqstp->rq_auth_data);
748
749         spin_lock_bh(&pool->sp_lock);
750         pool->sp_nrthreads--;
751         list_del(&rqstp->rq_all);
752         spin_unlock_bh(&pool->sp_lock);
753
754         kfree(rqstp);
755
756         /* Release the server */
757         if (serv)
758                 svc_destroy(serv);
759 }
760 EXPORT_SYMBOL(svc_exit_thread);
761
762 /*
763  * Register an RPC service with the local portmapper.
764  * To unregister a service, call this routine with
765  * proto and port == 0.
766  */
767 int
768 svc_register(struct svc_serv *serv, int proto, unsigned short port)
769 {
770         struct svc_program      *progp;
771         unsigned long           flags;
772         unsigned int            i;
773         int                     error = 0, dummy;
774
775         if (!port)
776                 clear_thread_flag(TIF_SIGPENDING);
777
778         for (progp = serv->sv_program; progp; progp = progp->pg_next) {
779                 for (i = 0; i < progp->pg_nvers; i++) {
780                         if (progp->pg_vers[i] == NULL)
781                                 continue;
782
783                         dprintk("svc: svc_register(%s, %s, %d, %d)%s\n",
784                                         progp->pg_name,
785                                         proto == IPPROTO_UDP?  "udp" : "tcp",
786                                         port,
787                                         i,
788                                         progp->pg_vers[i]->vs_hidden?
789                                                 " (but not telling portmap)" : "");
790
791                         if (progp->pg_vers[i]->vs_hidden)
792                                 continue;
793
794                         error = rpcb_register(progp->pg_prog, i, proto, port, &dummy);
795                         if (error < 0)
796                                 break;
797                         if (port && !dummy) {
798                                 error = -EACCES;
799                                 break;
800                         }
801                 }
802         }
803
804         if (!port) {
805                 spin_lock_irqsave(&current->sighand->siglock, flags);
806                 recalc_sigpending();
807                 spin_unlock_irqrestore(&current->sighand->siglock, flags);
808         }
809
810         return error;
811 }
812
813 /*
814  * Printk the given error with the address of the client that caused it.
815  */
816 static int
817 __attribute__ ((format (printf, 2, 3)))
818 svc_printk(struct svc_rqst *rqstp, const char *fmt, ...)
819 {
820         va_list args;
821         int     r;
822         char    buf[RPC_MAX_ADDRBUFLEN];
823
824         if (!net_ratelimit())
825                 return 0;
826
827         printk(KERN_WARNING "svc: %s: ",
828                 svc_print_addr(rqstp, buf, sizeof(buf)));
829
830         va_start(args, fmt);
831         r = vprintk(fmt, args);
832         va_end(args);
833
834         return r;
835 }
836
837 /*
838  * Process the RPC request.
839  */
840 int
841 svc_process(struct svc_rqst *rqstp)
842 {
843         struct svc_program      *progp;
844         struct svc_version      *versp = NULL;  /* compiler food */
845         struct svc_procedure    *procp = NULL;
846         struct kvec *           argv = &rqstp->rq_arg.head[0];
847         struct kvec *           resv = &rqstp->rq_res.head[0];
848         struct svc_serv         *serv = rqstp->rq_server;
849         kxdrproc_t              xdr;
850         __be32                  *statp;
851         u32                     dir, prog, vers, proc;
852         __be32                  auth_stat, rpc_stat;
853         int                     auth_res;
854         __be32                  *reply_statp;
855
856         rpc_stat = rpc_success;
857
858         if (argv->iov_len < 6*4)
859                 goto err_short_len;
860
861         /* setup response xdr_buf.
862          * Initially it has just one page
863          */
864         rqstp->rq_resused = 1;
865         resv->iov_base = page_address(rqstp->rq_respages[0]);
866         resv->iov_len = 0;
867         rqstp->rq_res.pages = rqstp->rq_respages + 1;
868         rqstp->rq_res.len = 0;
869         rqstp->rq_res.page_base = 0;
870         rqstp->rq_res.page_len = 0;
871         rqstp->rq_res.buflen = PAGE_SIZE;
872         rqstp->rq_res.tail[0].iov_base = NULL;
873         rqstp->rq_res.tail[0].iov_len = 0;
874         /* Will be turned off only in gss privacy case: */
875         rqstp->rq_splice_ok = 1;
876
877         /* Setup reply header */
878         rqstp->rq_xprt->xpt_ops->xpo_prep_reply_hdr(rqstp);
879
880         rqstp->rq_xid = svc_getu32(argv);
881         svc_putu32(resv, rqstp->rq_xid);
882
883         dir  = svc_getnl(argv);
884         vers = svc_getnl(argv);
885
886         /* First words of reply: */
887         svc_putnl(resv, 1);             /* REPLY */
888
889         if (dir != 0)           /* direction != CALL */
890                 goto err_bad_dir;
891         if (vers != 2)          /* RPC version number */
892                 goto err_bad_rpc;
893
894         /* Save position in case we later decide to reject: */
895         reply_statp = resv->iov_base + resv->iov_len;
896
897         svc_putnl(resv, 0);             /* ACCEPT */
898
899         rqstp->rq_prog = prog = svc_getnl(argv);        /* program number */
900         rqstp->rq_vers = vers = svc_getnl(argv);        /* version number */
901         rqstp->rq_proc = proc = svc_getnl(argv);        /* procedure number */
902
903         progp = serv->sv_program;
904
905         for (progp = serv->sv_program; progp; progp = progp->pg_next)
906                 if (prog == progp->pg_prog)
907                         break;
908
909         /*
910          * Decode auth data, and add verifier to reply buffer.
911          * We do this before anything else in order to get a decent
912          * auth verifier.
913          */
914         auth_res = svc_authenticate(rqstp, &auth_stat);
915         /* Also give the program a chance to reject this call: */
916         if (auth_res == SVC_OK && progp) {
917                 auth_stat = rpc_autherr_badcred;
918                 auth_res = progp->pg_authenticate(rqstp);
919         }
920         switch (auth_res) {
921         case SVC_OK:
922                 break;
923         case SVC_GARBAGE:
924                 rpc_stat = rpc_garbage_args;
925                 goto err_bad;
926         case SVC_SYSERR:
927                 rpc_stat = rpc_system_err;
928                 goto err_bad;
929         case SVC_DENIED:
930                 goto err_bad_auth;
931         case SVC_DROP:
932                 goto dropit;
933         case SVC_COMPLETE:
934                 goto sendit;
935         }
936
937         if (progp == NULL)
938                 goto err_bad_prog;
939
940         if (vers >= progp->pg_nvers ||
941           !(versp = progp->pg_vers[vers]))
942                 goto err_bad_vers;
943
944         procp = versp->vs_proc + proc;
945         if (proc >= versp->vs_nproc || !procp->pc_func)
946                 goto err_bad_proc;
947         rqstp->rq_server   = serv;
948         rqstp->rq_procinfo = procp;
949
950         /* Syntactic check complete */
951         serv->sv_stats->rpccnt++;
952
953         /* Build the reply header. */
954         statp = resv->iov_base +resv->iov_len;
955         svc_putnl(resv, RPC_SUCCESS);
956
957         /* Bump per-procedure stats counter */
958         procp->pc_count++;
959
960         /* Initialize storage for argp and resp */
961         memset(rqstp->rq_argp, 0, procp->pc_argsize);
962         memset(rqstp->rq_resp, 0, procp->pc_ressize);
963
964         /* un-reserve some of the out-queue now that we have a
965          * better idea of reply size
966          */
967         if (procp->pc_xdrressize)
968                 svc_reserve_auth(rqstp, procp->pc_xdrressize<<2);
969
970         /* Call the function that processes the request. */
971         if (!versp->vs_dispatch) {
972                 /* Decode arguments */
973                 xdr = procp->pc_decode;
974                 if (xdr && !xdr(rqstp, argv->iov_base, rqstp->rq_argp))
975                         goto err_garbage;
976
977                 *statp = procp->pc_func(rqstp, rqstp->rq_argp, rqstp->rq_resp);
978
979                 /* Encode reply */
980                 if (*statp == rpc_drop_reply) {
981                         if (procp->pc_release)
982                                 procp->pc_release(rqstp, NULL, rqstp->rq_resp);
983                         goto dropit;
984                 }
985                 if (*statp == rpc_success && (xdr = procp->pc_encode)
986                  && !xdr(rqstp, resv->iov_base+resv->iov_len, rqstp->rq_resp)) {
987                         dprintk("svc: failed to encode reply\n");
988                         /* serv->sv_stats->rpcsystemerr++; */
989                         *statp = rpc_system_err;
990                 }
991         } else {
992                 dprintk("svc: calling dispatcher\n");
993                 if (!versp->vs_dispatch(rqstp, statp)) {
994                         /* Release reply info */
995                         if (procp->pc_release)
996                                 procp->pc_release(rqstp, NULL, rqstp->rq_resp);
997                         goto dropit;
998                 }
999         }
1000
1001         /* Check RPC status result */
1002         if (*statp != rpc_success)
1003                 resv->iov_len = ((void*)statp)  - resv->iov_base + 4;
1004
1005         /* Release reply info */
1006         if (procp->pc_release)
1007                 procp->pc_release(rqstp, NULL, rqstp->rq_resp);
1008
1009         if (procp->pc_encode == NULL)
1010                 goto dropit;
1011
1012  sendit:
1013         if (svc_authorise(rqstp))
1014                 goto dropit;
1015         return svc_send(rqstp);
1016
1017  dropit:
1018         svc_authorise(rqstp);   /* doesn't hurt to call this twice */
1019         dprintk("svc: svc_process dropit\n");
1020         svc_drop(rqstp);
1021         return 0;
1022
1023 err_short_len:
1024         svc_printk(rqstp, "short len %Zd, dropping request\n",
1025                         argv->iov_len);
1026
1027         goto dropit;                    /* drop request */
1028
1029 err_bad_dir:
1030         svc_printk(rqstp, "bad direction %d, dropping request\n", dir);
1031
1032         serv->sv_stats->rpcbadfmt++;
1033         goto dropit;                    /* drop request */
1034
1035 err_bad_rpc:
1036         serv->sv_stats->rpcbadfmt++;
1037         svc_putnl(resv, 1);     /* REJECT */
1038         svc_putnl(resv, 0);     /* RPC_MISMATCH */
1039         svc_putnl(resv, 2);     /* Only RPCv2 supported */
1040         svc_putnl(resv, 2);
1041         goto sendit;
1042
1043 err_bad_auth:
1044         dprintk("svc: authentication failed (%d)\n", ntohl(auth_stat));
1045         serv->sv_stats->rpcbadauth++;
1046         /* Restore write pointer to location of accept status: */
1047         xdr_ressize_check(rqstp, reply_statp);
1048         svc_putnl(resv, 1);     /* REJECT */
1049         svc_putnl(resv, 1);     /* AUTH_ERROR */
1050         svc_putnl(resv, ntohl(auth_stat));      /* status */
1051         goto sendit;
1052
1053 err_bad_prog:
1054         dprintk("svc: unknown program %d\n", prog);
1055         serv->sv_stats->rpcbadfmt++;
1056         svc_putnl(resv, RPC_PROG_UNAVAIL);
1057         goto sendit;
1058
1059 err_bad_vers:
1060         svc_printk(rqstp, "unknown version (%d for prog %d, %s)\n",
1061                        vers, prog, progp->pg_name);
1062
1063         serv->sv_stats->rpcbadfmt++;
1064         svc_putnl(resv, RPC_PROG_MISMATCH);
1065         svc_putnl(resv, progp->pg_lovers);
1066         svc_putnl(resv, progp->pg_hivers);
1067         goto sendit;
1068
1069 err_bad_proc:
1070         svc_printk(rqstp, "unknown procedure (%d)\n", proc);
1071
1072         serv->sv_stats->rpcbadfmt++;
1073         svc_putnl(resv, RPC_PROC_UNAVAIL);
1074         goto sendit;
1075
1076 err_garbage:
1077         svc_printk(rqstp, "failed to decode args\n");
1078
1079         rpc_stat = rpc_garbage_args;
1080 err_bad:
1081         serv->sv_stats->rpcbadfmt++;
1082         svc_putnl(resv, ntohl(rpc_stat));
1083         goto sendit;
1084 }
1085 EXPORT_SYMBOL(svc_process);
1086
1087 /*
1088  * Return (transport-specific) limit on the rpc payload.
1089  */
1090 u32 svc_max_payload(const struct svc_rqst *rqstp)
1091 {
1092         u32 max = rqstp->rq_xprt->xpt_class->xcl_max_payload;
1093
1094         if (rqstp->rq_server->sv_max_payload < max)
1095                 max = rqstp->rq_server->sv_max_payload;
1096         return max;
1097 }
1098 EXPORT_SYMBOL_GPL(svc_max_payload);