NR_CPUS: Replace NR_CPUS in speedstep-centrino.c
[linux-2.6.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 <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
22 #include <linux/sunrpc/types.h>
23 #include <linux/sunrpc/xdr.h>
24 #include <linux/sunrpc/stats.h>
25 #include <linux/sunrpc/svcsock.h>
26 #include <linux/sunrpc/clnt.h>
27
28 #define RPCDBG_FACILITY RPCDBG_SVCDSP
29
30 #define svc_serv_is_pooled(serv)    ((serv)->sv_function)
31
32 /*
33  * Mode for mapping cpus to pools.
34  */
35 enum {
36         SVC_POOL_AUTO = -1,     /* choose one of the others */
37         SVC_POOL_GLOBAL,        /* no mapping, just a single global pool
38                                  * (legacy & UP mode) */
39         SVC_POOL_PERCPU,        /* one pool per cpu */
40         SVC_POOL_PERNODE        /* one pool per numa node */
41 };
42 #define SVC_POOL_DEFAULT        SVC_POOL_GLOBAL
43
44 /*
45  * Structure for mapping cpus to pools and vice versa.
46  * Setup once during sunrpc initialisation.
47  */
48 static struct svc_pool_map {
49         int count;                      /* How many svc_servs use us */
50         int mode;                       /* Note: int not enum to avoid
51                                          * warnings about "enumeration value
52                                          * not handled in switch" */
53         unsigned int npools;
54         unsigned int *pool_to;          /* maps pool id to cpu or node */
55         unsigned int *to_pool;          /* maps cpu or node to pool id */
56 } svc_pool_map = {
57         .count = 0,
58         .mode = SVC_POOL_DEFAULT
59 };
60 static DEFINE_MUTEX(svc_pool_map_mutex);/* protects svc_pool_map.count only */
61
62 static int
63 param_set_pool_mode(const char *val, struct kernel_param *kp)
64 {
65         int *ip = (int *)kp->arg;
66         struct svc_pool_map *m = &svc_pool_map;
67         int err;
68
69         mutex_lock(&svc_pool_map_mutex);
70
71         err = -EBUSY;
72         if (m->count)
73                 goto out;
74
75         err = 0;
76         if (!strncmp(val, "auto", 4))
77                 *ip = SVC_POOL_AUTO;
78         else if (!strncmp(val, "global", 6))
79                 *ip = SVC_POOL_GLOBAL;
80         else if (!strncmp(val, "percpu", 6))
81                 *ip = SVC_POOL_PERCPU;
82         else if (!strncmp(val, "pernode", 7))
83                 *ip = SVC_POOL_PERNODE;
84         else
85                 err = -EINVAL;
86
87 out:
88         mutex_unlock(&svc_pool_map_mutex);
89         return err;
90 }
91
92 static int
93 param_get_pool_mode(char *buf, struct kernel_param *kp)
94 {
95         int *ip = (int *)kp->arg;
96
97         switch (*ip)
98         {
99         case SVC_POOL_AUTO:
100                 return strlcpy(buf, "auto", 20);
101         case SVC_POOL_GLOBAL:
102                 return strlcpy(buf, "global", 20);
103         case SVC_POOL_PERCPU:
104                 return strlcpy(buf, "percpu", 20);
105         case SVC_POOL_PERNODE:
106                 return strlcpy(buf, "pernode", 20);
107         default:
108                 return sprintf(buf, "%d", *ip);
109         }
110 }
111
112 module_param_call(pool_mode, param_set_pool_mode, param_get_pool_mode,
113                  &svc_pool_map.mode, 0644);
114
115 /*
116  * Detect best pool mapping mode heuristically,
117  * according to the machine's topology.
118  */
119 static int
120 svc_pool_map_choose_mode(void)
121 {
122         unsigned int node;
123
124         if (num_online_nodes() > 1) {
125                 /*
126                  * Actually have multiple NUMA nodes,
127                  * so split pools on NUMA node boundaries
128                  */
129                 return SVC_POOL_PERNODE;
130         }
131
132         node = any_online_node(node_online_map);
133         if (nr_cpus_node(node) > 2) {
134                 /*
135                  * Non-trivial SMP, or CONFIG_NUMA on
136                  * non-NUMA hardware, e.g. with a generic
137                  * x86_64 kernel on Xeons.  In this case we
138                  * want to divide the pools on cpu boundaries.
139                  */
140                 return SVC_POOL_PERCPU;
141         }
142
143         /* default: one global pool */
144         return SVC_POOL_GLOBAL;
145 }
146
147 /*
148  * Allocate the to_pool[] and pool_to[] arrays.
149  * Returns 0 on success or an errno.
150  */
151 static int
152 svc_pool_map_alloc_arrays(struct svc_pool_map *m, unsigned int maxpools)
153 {
154         m->to_pool = kcalloc(maxpools, sizeof(unsigned int), GFP_KERNEL);
155         if (!m->to_pool)
156                 goto fail;
157         m->pool_to = kcalloc(maxpools, sizeof(unsigned int), GFP_KERNEL);
158         if (!m->pool_to)
159                 goto fail_free;
160
161         return 0;
162
163 fail_free:
164         kfree(m->to_pool);
165 fail:
166         return -ENOMEM;
167 }
168
169 /*
170  * Initialise the pool map for SVC_POOL_PERCPU mode.
171  * Returns number of pools or <0 on error.
172  */
173 static int
174 svc_pool_map_init_percpu(struct svc_pool_map *m)
175 {
176         unsigned int maxpools = nr_cpu_ids;
177         unsigned int pidx = 0;
178         unsigned int cpu;
179         int err;
180
181         err = svc_pool_map_alloc_arrays(m, maxpools);
182         if (err)
183                 return err;
184
185         for_each_online_cpu(cpu) {
186                 BUG_ON(pidx > maxpools);
187                 m->to_pool[cpu] = pidx;
188                 m->pool_to[pidx] = cpu;
189                 pidx++;
190         }
191         /* cpus brought online later all get mapped to pool0, sorry */
192
193         return pidx;
194 };
195
196
197 /*
198  * Initialise the pool map for SVC_POOL_PERNODE mode.
199  * Returns number of pools or <0 on error.
200  */
201 static int
202 svc_pool_map_init_pernode(struct svc_pool_map *m)
203 {
204         unsigned int maxpools = nr_node_ids;
205         unsigned int pidx = 0;
206         unsigned int node;
207         int err;
208
209         err = svc_pool_map_alloc_arrays(m, maxpools);
210         if (err)
211                 return err;
212
213         for_each_node_with_cpus(node) {
214                 /* some architectures (e.g. SN2) have cpuless nodes */
215                 BUG_ON(pidx > maxpools);
216                 m->to_pool[node] = pidx;
217                 m->pool_to[pidx] = node;
218                 pidx++;
219         }
220         /* nodes brought online later all get mapped to pool0, sorry */
221
222         return pidx;
223 }
224
225
226 /*
227  * Add a reference to the global map of cpus to pools (and
228  * vice versa).  Initialise the map if we're the first user.
229  * Returns the number of pools.
230  */
231 static unsigned int
232 svc_pool_map_get(void)
233 {
234         struct svc_pool_map *m = &svc_pool_map;
235         int npools = -1;
236
237         mutex_lock(&svc_pool_map_mutex);
238
239         if (m->count++) {
240                 mutex_unlock(&svc_pool_map_mutex);
241                 return m->npools;
242         }
243
244         if (m->mode == SVC_POOL_AUTO)
245                 m->mode = svc_pool_map_choose_mode();
246
247         switch (m->mode) {
248         case SVC_POOL_PERCPU:
249                 npools = svc_pool_map_init_percpu(m);
250                 break;
251         case SVC_POOL_PERNODE:
252                 npools = svc_pool_map_init_pernode(m);
253                 break;
254         }
255
256         if (npools < 0) {
257                 /* default, or memory allocation failure */
258                 npools = 1;
259                 m->mode = SVC_POOL_GLOBAL;
260         }
261         m->npools = npools;
262
263         mutex_unlock(&svc_pool_map_mutex);
264         return m->npools;
265 }
266
267
268 /*
269  * Drop a reference to the global map of cpus to pools.
270  * When the last reference is dropped, the map data is
271  * freed; this allows the sysadmin to change the pool
272  * mode using the pool_mode module option without
273  * rebooting or re-loading sunrpc.ko.
274  */
275 static void
276 svc_pool_map_put(void)
277 {
278         struct svc_pool_map *m = &svc_pool_map;
279
280         mutex_lock(&svc_pool_map_mutex);
281
282         if (!--m->count) {
283                 m->mode = SVC_POOL_DEFAULT;
284                 kfree(m->to_pool);
285                 kfree(m->pool_to);
286                 m->npools = 0;
287         }
288
289         mutex_unlock(&svc_pool_map_mutex);
290 }
291
292
293 /*
294  * Set the current thread's cpus_allowed mask so that it
295  * will only run on cpus in the given pool.
296  *
297  * Returns 1 and fills in oldmask iff a cpumask was applied.
298  */
299 static inline int
300 svc_pool_map_set_cpumask(unsigned int pidx, cpumask_t *oldmask)
301 {
302         struct svc_pool_map *m = &svc_pool_map;
303
304         /*
305          * The caller checks for sv_nrpools > 1, which
306          * implies that we've been initialized.
307          */
308         BUG_ON(m->count == 0);
309
310         switch (m->mode)
311         {
312         default:
313                 return 0;
314         case SVC_POOL_PERCPU:
315         {
316                 unsigned int cpu = m->pool_to[pidx];
317                 cpumask_of_cpu_ptr(cpumask, cpu);
318
319                 *oldmask = current->cpus_allowed;
320                 set_cpus_allowed_ptr(current, cpumask);
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         unsigned int pages, arghi;
514
515         pages = size / PAGE_SIZE + 1; /* extra page as we hold both request and reply.
516                                        * We assume one is at most one page
517                                        */
518         arghi = 0;
519         BUG_ON(pages > RPCSVC_MAXPAGES);
520         while (pages) {
521                 struct page *p = alloc_page(GFP_KERNEL);
522                 if (!p)
523                         break;
524                 rqstp->rq_pages[arghi++] = p;
525                 pages--;
526         }
527         return pages == 0;
528 }
529
530 /*
531  * Release an RPC server buffer
532  */
533 static void
534 svc_release_buffer(struct svc_rqst *rqstp)
535 {
536         unsigned int i;
537
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       uninitialized_var(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_ptr(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  * Choose a pool in which to create a new thread, for svc_set_num_threads
623  */
624 static inline struct svc_pool *
625 choose_pool(struct svc_serv *serv, struct svc_pool *pool, unsigned int *state)
626 {
627         if (pool != NULL)
628                 return pool;
629
630         return &serv->sv_pools[(*state)++ % serv->sv_nrpools];
631 }
632
633 /*
634  * Choose a thread to kill, for svc_set_num_threads
635  */
636 static inline struct task_struct *
637 choose_victim(struct svc_serv *serv, struct svc_pool *pool, unsigned int *state)
638 {
639         unsigned int i;
640         struct task_struct *task = NULL;
641
642         if (pool != NULL) {
643                 spin_lock_bh(&pool->sp_lock);
644         } else {
645                 /* choose a pool in round-robin fashion */
646                 for (i = 0; i < serv->sv_nrpools; i++) {
647                         pool = &serv->sv_pools[--(*state) % serv->sv_nrpools];
648                         spin_lock_bh(&pool->sp_lock);
649                         if (!list_empty(&pool->sp_all_threads))
650                                 goto found_pool;
651                         spin_unlock_bh(&pool->sp_lock);
652                 }
653                 return NULL;
654         }
655
656 found_pool:
657         if (!list_empty(&pool->sp_all_threads)) {
658                 struct svc_rqst *rqstp;
659
660                 /*
661                  * Remove from the pool->sp_all_threads list
662                  * so we don't try to kill it again.
663                  */
664                 rqstp = list_entry(pool->sp_all_threads.next, struct svc_rqst, rq_all);
665                 list_del_init(&rqstp->rq_all);
666                 task = rqstp->rq_task;
667         }
668         spin_unlock_bh(&pool->sp_lock);
669
670         return task;
671 }
672
673 /*
674  * Create or destroy enough new threads to make the number
675  * of threads the given number.  If `pool' is non-NULL, applies
676  * only to threads in that pool, otherwise round-robins between
677  * all pools.  Must be called with a svc_get() reference and
678  * the BKL held.
679  *
680  * Destroying threads relies on the service threads filling in
681  * rqstp->rq_task, which only the nfs ones do.  Assumes the serv
682  * has been created using svc_create_pooled().
683  *
684  * Based on code that used to be in nfsd_svc() but tweaked
685  * to be pool-aware.
686  */
687 int
688 svc_set_num_threads(struct svc_serv *serv, struct svc_pool *pool, int nrservs)
689 {
690         struct task_struct *victim;
691         int error = 0;
692         unsigned int state = serv->sv_nrthreads-1;
693
694         if (pool == NULL) {
695                 /* The -1 assumes caller has done a svc_get() */
696                 nrservs -= (serv->sv_nrthreads-1);
697         } else {
698                 spin_lock_bh(&pool->sp_lock);
699                 nrservs -= pool->sp_nrthreads;
700                 spin_unlock_bh(&pool->sp_lock);
701         }
702
703         /* create new threads */
704         while (nrservs > 0) {
705                 nrservs--;
706                 __module_get(serv->sv_module);
707                 error = __svc_create_thread(serv->sv_function, serv,
708                                             choose_pool(serv, pool, &state));
709                 if (error < 0) {
710                         module_put(serv->sv_module);
711                         break;
712                 }
713         }
714         /* destroy old threads */
715         while (nrservs < 0 &&
716                (victim = choose_victim(serv, pool, &state)) != NULL) {
717                 send_sig(serv->sv_kill_signal, victim, 1);
718                 nrservs++;
719         }
720
721         return error;
722 }
723 EXPORT_SYMBOL(svc_set_num_threads);
724
725 /*
726  * Called from a server thread as it's exiting.  Caller must hold BKL.
727  */
728 void
729 svc_exit_thread(struct svc_rqst *rqstp)
730 {
731         struct svc_serv *serv = rqstp->rq_server;
732         struct svc_pool *pool = rqstp->rq_pool;
733
734         svc_release_buffer(rqstp);
735         kfree(rqstp->rq_resp);
736         kfree(rqstp->rq_argp);
737         kfree(rqstp->rq_auth_data);
738
739         spin_lock_bh(&pool->sp_lock);
740         pool->sp_nrthreads--;
741         list_del(&rqstp->rq_all);
742         spin_unlock_bh(&pool->sp_lock);
743
744         kfree(rqstp);
745
746         /* Release the server */
747         if (serv)
748                 svc_destroy(serv);
749 }
750 EXPORT_SYMBOL(svc_exit_thread);
751
752 /*
753  * Register an RPC service with the local portmapper.
754  * To unregister a service, call this routine with
755  * proto and port == 0.
756  */
757 int
758 svc_register(struct svc_serv *serv, int proto, unsigned short port)
759 {
760         struct svc_program      *progp;
761         unsigned long           flags;
762         unsigned int            i;
763         int                     error = 0, dummy;
764
765         if (!port)
766                 clear_thread_flag(TIF_SIGPENDING);
767
768         for (progp = serv->sv_program; progp; progp = progp->pg_next) {
769                 for (i = 0; i < progp->pg_nvers; i++) {
770                         if (progp->pg_vers[i] == NULL)
771                                 continue;
772
773                         dprintk("svc: svc_register(%s, %s, %d, %d)%s\n",
774                                         progp->pg_name,
775                                         proto == IPPROTO_UDP?  "udp" : "tcp",
776                                         port,
777                                         i,
778                                         progp->pg_vers[i]->vs_hidden?
779                                                 " (but not telling portmap)" : "");
780
781                         if (progp->pg_vers[i]->vs_hidden)
782                                 continue;
783
784                         error = rpcb_register(progp->pg_prog, i, proto, port, &dummy);
785                         if (error < 0)
786                                 break;
787                         if (port && !dummy) {
788                                 error = -EACCES;
789                                 break;
790                         }
791                 }
792         }
793
794         if (!port) {
795                 spin_lock_irqsave(&current->sighand->siglock, flags);
796                 recalc_sigpending();
797                 spin_unlock_irqrestore(&current->sighand->siglock, flags);
798         }
799
800         return error;
801 }
802
803 /*
804  * Printk the given error with the address of the client that caused it.
805  */
806 static int
807 __attribute__ ((format (printf, 2, 3)))
808 svc_printk(struct svc_rqst *rqstp, const char *fmt, ...)
809 {
810         va_list args;
811         int     r;
812         char    buf[RPC_MAX_ADDRBUFLEN];
813
814         if (!net_ratelimit())
815                 return 0;
816
817         printk(KERN_WARNING "svc: %s: ",
818                 svc_print_addr(rqstp, buf, sizeof(buf)));
819
820         va_start(args, fmt);
821         r = vprintk(fmt, args);
822         va_end(args);
823
824         return r;
825 }
826
827 /*
828  * Process the RPC request.
829  */
830 int
831 svc_process(struct svc_rqst *rqstp)
832 {
833         struct svc_program      *progp;
834         struct svc_version      *versp = NULL;  /* compiler food */
835         struct svc_procedure    *procp = NULL;
836         struct kvec *           argv = &rqstp->rq_arg.head[0];
837         struct kvec *           resv = &rqstp->rq_res.head[0];
838         struct svc_serv         *serv = rqstp->rq_server;
839         kxdrproc_t              xdr;
840         __be32                  *statp;
841         u32                     dir, prog, vers, proc;
842         __be32                  auth_stat, rpc_stat;
843         int                     auth_res;
844         __be32                  *reply_statp;
845
846         rpc_stat = rpc_success;
847
848         if (argv->iov_len < 6*4)
849                 goto err_short_len;
850
851         /* setup response xdr_buf.
852          * Initially it has just one page
853          */
854         rqstp->rq_resused = 1;
855         resv->iov_base = page_address(rqstp->rq_respages[0]);
856         resv->iov_len = 0;
857         rqstp->rq_res.pages = rqstp->rq_respages + 1;
858         rqstp->rq_res.len = 0;
859         rqstp->rq_res.page_base = 0;
860         rqstp->rq_res.page_len = 0;
861         rqstp->rq_res.buflen = PAGE_SIZE;
862         rqstp->rq_res.tail[0].iov_base = NULL;
863         rqstp->rq_res.tail[0].iov_len = 0;
864         /* Will be turned off only in gss privacy case: */
865         rqstp->rq_splice_ok = 1;
866
867         /* Setup reply header */
868         rqstp->rq_xprt->xpt_ops->xpo_prep_reply_hdr(rqstp);
869
870         rqstp->rq_xid = svc_getu32(argv);
871         svc_putu32(resv, rqstp->rq_xid);
872
873         dir  = svc_getnl(argv);
874         vers = svc_getnl(argv);
875
876         /* First words of reply: */
877         svc_putnl(resv, 1);             /* REPLY */
878
879         if (dir != 0)           /* direction != CALL */
880                 goto err_bad_dir;
881         if (vers != 2)          /* RPC version number */
882                 goto err_bad_rpc;
883
884         /* Save position in case we later decide to reject: */
885         reply_statp = resv->iov_base + resv->iov_len;
886
887         svc_putnl(resv, 0);             /* ACCEPT */
888
889         rqstp->rq_prog = prog = svc_getnl(argv);        /* program number */
890         rqstp->rq_vers = vers = svc_getnl(argv);        /* version number */
891         rqstp->rq_proc = proc = svc_getnl(argv);        /* procedure number */
892
893         progp = serv->sv_program;
894
895         for (progp = serv->sv_program; progp; progp = progp->pg_next)
896                 if (prog == progp->pg_prog)
897                         break;
898
899         /*
900          * Decode auth data, and add verifier to reply buffer.
901          * We do this before anything else in order to get a decent
902          * auth verifier.
903          */
904         auth_res = svc_authenticate(rqstp, &auth_stat);
905         /* Also give the program a chance to reject this call: */
906         if (auth_res == SVC_OK && progp) {
907                 auth_stat = rpc_autherr_badcred;
908                 auth_res = progp->pg_authenticate(rqstp);
909         }
910         switch (auth_res) {
911         case SVC_OK:
912                 break;
913         case SVC_GARBAGE:
914                 goto err_garbage;
915         case SVC_SYSERR:
916                 rpc_stat = rpc_system_err;
917                 goto err_bad;
918         case SVC_DENIED:
919                 goto err_bad_auth;
920         case SVC_DROP:
921                 goto dropit;
922         case SVC_COMPLETE:
923                 goto sendit;
924         }
925
926         if (progp == NULL)
927                 goto err_bad_prog;
928
929         if (vers >= progp->pg_nvers ||
930           !(versp = progp->pg_vers[vers]))
931                 goto err_bad_vers;
932
933         procp = versp->vs_proc + proc;
934         if (proc >= versp->vs_nproc || !procp->pc_func)
935                 goto err_bad_proc;
936         rqstp->rq_server   = serv;
937         rqstp->rq_procinfo = procp;
938
939         /* Syntactic check complete */
940         serv->sv_stats->rpccnt++;
941
942         /* Build the reply header. */
943         statp = resv->iov_base +resv->iov_len;
944         svc_putnl(resv, RPC_SUCCESS);
945
946         /* Bump per-procedure stats counter */
947         procp->pc_count++;
948
949         /* Initialize storage for argp and resp */
950         memset(rqstp->rq_argp, 0, procp->pc_argsize);
951         memset(rqstp->rq_resp, 0, procp->pc_ressize);
952
953         /* un-reserve some of the out-queue now that we have a
954          * better idea of reply size
955          */
956         if (procp->pc_xdrressize)
957                 svc_reserve_auth(rqstp, procp->pc_xdrressize<<2);
958
959         /* Call the function that processes the request. */
960         if (!versp->vs_dispatch) {
961                 /* Decode arguments */
962                 xdr = procp->pc_decode;
963                 if (xdr && !xdr(rqstp, argv->iov_base, rqstp->rq_argp))
964                         goto err_garbage;
965
966                 *statp = procp->pc_func(rqstp, rqstp->rq_argp, rqstp->rq_resp);
967
968                 /* Encode reply */
969                 if (*statp == rpc_drop_reply) {
970                         if (procp->pc_release)
971                                 procp->pc_release(rqstp, NULL, rqstp->rq_resp);
972                         goto dropit;
973                 }
974                 if (*statp == rpc_success && (xdr = procp->pc_encode)
975                  && !xdr(rqstp, resv->iov_base+resv->iov_len, rqstp->rq_resp)) {
976                         dprintk("svc: failed to encode reply\n");
977                         /* serv->sv_stats->rpcsystemerr++; */
978                         *statp = rpc_system_err;
979                 }
980         } else {
981                 dprintk("svc: calling dispatcher\n");
982                 if (!versp->vs_dispatch(rqstp, statp)) {
983                         /* Release reply info */
984                         if (procp->pc_release)
985                                 procp->pc_release(rqstp, NULL, rqstp->rq_resp);
986                         goto dropit;
987                 }
988         }
989
990         /* Check RPC status result */
991         if (*statp != rpc_success)
992                 resv->iov_len = ((void*)statp)  - resv->iov_base + 4;
993
994         /* Release reply info */
995         if (procp->pc_release)
996                 procp->pc_release(rqstp, NULL, rqstp->rq_resp);
997
998         if (procp->pc_encode == NULL)
999                 goto dropit;
1000
1001  sendit:
1002         if (svc_authorise(rqstp))
1003                 goto dropit;
1004         return svc_send(rqstp);
1005
1006  dropit:
1007         svc_authorise(rqstp);   /* doesn't hurt to call this twice */
1008         dprintk("svc: svc_process dropit\n");
1009         svc_drop(rqstp);
1010         return 0;
1011
1012 err_short_len:
1013         svc_printk(rqstp, "short len %Zd, dropping request\n",
1014                         argv->iov_len);
1015
1016         goto dropit;                    /* drop request */
1017
1018 err_bad_dir:
1019         svc_printk(rqstp, "bad direction %d, dropping request\n", dir);
1020
1021         serv->sv_stats->rpcbadfmt++;
1022         goto dropit;                    /* drop request */
1023
1024 err_bad_rpc:
1025         serv->sv_stats->rpcbadfmt++;
1026         svc_putnl(resv, 1);     /* REJECT */
1027         svc_putnl(resv, 0);     /* RPC_MISMATCH */
1028         svc_putnl(resv, 2);     /* Only RPCv2 supported */
1029         svc_putnl(resv, 2);
1030         goto sendit;
1031
1032 err_bad_auth:
1033         dprintk("svc: authentication failed (%d)\n", ntohl(auth_stat));
1034         serv->sv_stats->rpcbadauth++;
1035         /* Restore write pointer to location of accept status: */
1036         xdr_ressize_check(rqstp, reply_statp);
1037         svc_putnl(resv, 1);     /* REJECT */
1038         svc_putnl(resv, 1);     /* AUTH_ERROR */
1039         svc_putnl(resv, ntohl(auth_stat));      /* status */
1040         goto sendit;
1041
1042 err_bad_prog:
1043         dprintk("svc: unknown program %d\n", prog);
1044         serv->sv_stats->rpcbadfmt++;
1045         svc_putnl(resv, RPC_PROG_UNAVAIL);
1046         goto sendit;
1047
1048 err_bad_vers:
1049         svc_printk(rqstp, "unknown version (%d for prog %d, %s)\n",
1050                        vers, prog, progp->pg_name);
1051
1052         serv->sv_stats->rpcbadfmt++;
1053         svc_putnl(resv, RPC_PROG_MISMATCH);
1054         svc_putnl(resv, progp->pg_lovers);
1055         svc_putnl(resv, progp->pg_hivers);
1056         goto sendit;
1057
1058 err_bad_proc:
1059         svc_printk(rqstp, "unknown procedure (%d)\n", proc);
1060
1061         serv->sv_stats->rpcbadfmt++;
1062         svc_putnl(resv, RPC_PROC_UNAVAIL);
1063         goto sendit;
1064
1065 err_garbage:
1066         svc_printk(rqstp, "failed to decode args\n");
1067
1068         rpc_stat = rpc_garbage_args;
1069 err_bad:
1070         serv->sv_stats->rpcbadfmt++;
1071         svc_putnl(resv, ntohl(rpc_stat));
1072         goto sendit;
1073 }
1074 EXPORT_SYMBOL(svc_process);
1075
1076 /*
1077  * Return (transport-specific) limit on the rpc payload.
1078  */
1079 u32 svc_max_payload(const struct svc_rqst *rqstp)
1080 {
1081         u32 max = rqstp->rq_xprt->xpt_class->xcl_max_payload;
1082
1083         if (rqstp->rq_server->sv_max_payload < max)
1084                 max = rqstp->rq_server->sv_max_payload;
1085         return max;
1086 }
1087 EXPORT_SYMBOL_GPL(svc_max_payload);