]> git.proxmox.com Git - mirror_ubuntu-jammy-kernel.git/blame - net/sunrpc/svc.c
SUNRPC: Use unsigned index when looping over arrays
[mirror_ubuntu-jammy-kernel.git] / net / sunrpc / svc.c
CommitLineData
1da177e4
LT
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>
bfd24160
GB
7 *
8 * Multiple threads pools and NUMAisation
9 * Copyright (c) 2006 Silicon Graphics, Inc.
10 * by Greg Banks <gnb@melbourne.sgi.com>
1da177e4
LT
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>
a7455442
GB
19#include <linux/interrupt.h>
20#include <linux/module.h>
df3825c5 21#include <linux/sched.h>
1da177e4
LT
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
1da177e4 30
42a7fc4a
GB
31#define svc_serv_is_pooled(serv) ((serv)->sv_function)
32
bfd24160
GB
33/*
34 * Mode for mapping cpus to pools.
35 */
36enum {
42a7fc4a 37 SVC_POOL_AUTO = -1, /* choose one of the others */
bfd24160
GB
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};
42a7fc4a 43#define SVC_POOL_DEFAULT SVC_POOL_GLOBAL
bfd24160
GB
44
45/*
46 * Structure for mapping cpus to pools and vice versa.
47 * Setup once during sunrpc initialisation.
48 */
49static struct svc_pool_map {
42a7fc4a 50 int count; /* How many svc_servs use us */
bfd24160
GB
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 = {
42a7fc4a
GB
58 .count = 0,
59 .mode = SVC_POOL_DEFAULT
bfd24160 60};
42a7fc4a
GB
61static DEFINE_MUTEX(svc_pool_map_mutex);/* protects svc_pool_map.count only */
62
63static int
64param_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
88out:
89 mutex_unlock(&svc_pool_map_mutex);
90 return err;
91}
92
93static int
94param_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}
bfd24160 112
42a7fc4a
GB
113module_param_call(pool_mode, param_set_pool_mode, param_get_pool_mode,
114 &svc_pool_map.mode, 0644);
bfd24160
GB
115
116/*
117 * Detect best pool mapping mode heuristically,
118 * according to the machine's topology.
119 */
120static int
121svc_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 */
152static int
153svc_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
164fail_free:
165 kfree(m->to_pool);
166fail:
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 */
174static int
175svc_pool_map_init_percpu(struct svc_pool_map *m)
176{
53b8a315 177 unsigned int maxpools = nr_cpu_ids;
bfd24160
GB
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 */
202static int
203svc_pool_map_init_pernode(struct svc_pool_map *m)
204{
74c7aa8b 205 unsigned int maxpools = nr_node_ids;
bfd24160
GB
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/*
42a7fc4a
GB
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.
bfd24160
GB
231 */
232static unsigned int
42a7fc4a 233svc_pool_map_get(void)
bfd24160
GB
234{
235 struct svc_pool_map *m = &svc_pool_map;
236 int npools = -1;
237
42a7fc4a
GB
238 mutex_lock(&svc_pool_map_mutex);
239
240 if (m->count++) {
241 mutex_unlock(&svc_pool_map_mutex);
bfd24160 242 return m->npools;
42a7fc4a 243 }
bfd24160 244
42a7fc4a
GB
245 if (m->mode == SVC_POOL_AUTO)
246 m->mode = svc_pool_map_choose_mode();
bfd24160
GB
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
42a7fc4a 264 mutex_unlock(&svc_pool_map_mutex);
bfd24160
GB
265 return m->npools;
266}
267
42a7fc4a
GB
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 */
276static void
277svc_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
bfd24160
GB
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 */
300static inline int
301svc_pool_map_set_cpumask(unsigned int pidx, cpumask_t *oldmask)
302{
303 struct svc_pool_map *m = &svc_pool_map;
bfd24160
GB
304
305 /*
306 * The caller checks for sv_nrpools > 1, which
42a7fc4a 307 * implies that we've been initialized.
bfd24160 308 */
42a7fc4a 309 BUG_ON(m->count == 0);
bfd24160
GB
310
311 switch (m->mode)
312 {
313 default:
314 return 0;
315 case SVC_POOL_PERCPU:
c5f59f08
MT
316 {
317 unsigned int cpu = m->pool_to[pidx];
318
bfd24160 319 *oldmask = current->cpus_allowed;
c5f59f08 320 set_cpus_allowed_ptr(current, &cpumask_of_cpu(cpu));
bfd24160 321 return 1;
c5f59f08 322 }
bfd24160 323 case SVC_POOL_PERNODE:
c5f59f08
MT
324 {
325 unsigned int node = m->pool_to[pidx];
326 node_to_cpumask_ptr(nodecpumask, node);
327
bfd24160 328 *oldmask = current->cpus_allowed;
c5f59f08 329 set_cpus_allowed_ptr(current, nodecpumask);
bfd24160
GB
330 return 1;
331 }
c5f59f08 332 }
bfd24160
GB
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 */
340struct svc_pool *
341svc_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 /*
42a7fc4a 347 * An uninitialised map happens in a pure client when
bfd24160
GB
348 * lockd is brought up, so silently treat it the
349 * same as SVC_POOL_GLOBAL.
350 */
42a7fc4a
GB
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 }
bfd24160
GB
360 }
361 return &serv->sv_pools[pidx % serv->sv_nrpools];
362}
363
364
1da177e4
LT
365/*
366 * Create an RPC service
367 */
a7455442
GB
368static struct svc_serv *
369__svc_create(struct svc_program *prog, unsigned int bufsize, int npools,
bc591ccf 370 void (*shutdown)(struct svc_serv *serv))
1da177e4
LT
371{
372 struct svc_serv *serv;
ea339d46 373 unsigned int vers;
1da177e4 374 unsigned int xdrsize;
3262c816 375 unsigned int i;
1da177e4 376
0da974f4 377 if (!(serv = kzalloc(sizeof(*serv), GFP_KERNEL)))
1da177e4 378 return NULL;
9ba02638 379 serv->sv_name = prog->pg_name;
1da177e4
LT
380 serv->sv_program = prog;
381 serv->sv_nrthreads = 1;
382 serv->sv_stats = prog->pg_stats;
c6b0a9f8
N
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);
bc591ccf 387 serv->sv_shutdown = shutdown;
1da177e4 388 xdrsize = 0;
9ba02638
AG
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 }
1da177e4 401 serv->sv_xdrsize = xdrsize;
1da177e4
LT
402 INIT_LIST_HEAD(&serv->sv_tempsocks);
403 INIT_LIST_HEAD(&serv->sv_permsocks);
36bdfc8b 404 init_timer(&serv->sv_temptimer);
1da177e4
LT
405 spin_lock_init(&serv->sv_lock);
406
a7455442 407 serv->sv_nrpools = npools;
3262c816 408 serv->sv_pools =
cd861280 409 kcalloc(serv->sv_nrpools, sizeof(struct svc_pool),
3262c816
GB
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
46121cf7 419 dprintk("svc: initialising pool %u for %s\n",
3262c816
GB
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);
a7455442 425 INIT_LIST_HEAD(&pool->sp_all_threads);
3262c816
GB
426 spin_lock_init(&pool->sp_lock);
427 }
428
429
1da177e4
LT
430 /* Remove any stale portmap registrations */
431 svc_register(serv, 0, 0);
432
433 return serv;
434}
435
a7455442
GB
436struct svc_serv *
437svc_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}
d2f7e79e 442EXPORT_SYMBOL(svc_create);
a7455442
GB
443
444struct svc_serv *
445svc_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;
42a7fc4a 450 unsigned int npools = svc_pool_map_get();
a7455442 451
bfd24160 452 serv = __svc_create(prog, bufsize, npools, shutdown);
a7455442
GB
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}
d2f7e79e 462EXPORT_SYMBOL(svc_create_pooled);
a7455442 463
1da177e4 464/*
3262c816 465 * Destroy an RPC service. Should be called with the BKL held
1da177e4
LT
466 */
467void
468svc_destroy(struct svc_serv *serv)
469{
46121cf7 470 dprintk("svc: svc_destroy(%s, %d)\n",
1da177e4
LT
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
36bdfc8b
GB
482 del_timer_sync(&serv->sv_temptimer);
483
7a182083 484 svc_close_all(&serv->sv_tempsocks);
cda1fd4a 485
bc591ccf
N
486 if (serv->sv_shutdown)
487 serv->sv_shutdown(serv);
488
7a182083 489 svc_close_all(&serv->sv_permsocks);
cda1fd4a
N
490
491 BUG_ON(!list_empty(&serv->sv_permsocks));
492 BUG_ON(!list_empty(&serv->sv_tempsocks));
cca5172a 493
1da177e4
LT
494 cache_clean_deferred(serv);
495
42a7fc4a
GB
496 if (svc_serv_is_pooled(serv))
497 svc_pool_map_put();
498
1da177e4
LT
499 /* Unregister service with the portmapper */
500 svc_register(serv, 0, 0);
3262c816 501 kfree(serv->sv_pools);
1da177e4
LT
502 kfree(serv);
503}
d2f7e79e 504EXPORT_SYMBOL(svc_destroy);
1da177e4
LT
505
506/*
507 * Allocate an RPC server's buffer space.
508 * We allocate pages and place them in rq_argpages.
509 */
510static int
511svc_init_buffer(struct svc_rqst *rqstp, unsigned int size)
512{
513 int pages;
514 int arghi;
cca5172a 515
c6b0a9f8
N
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 */
1da177e4 519 arghi = 0;
09a62660 520 BUG_ON(pages > RPCSVC_MAXPAGES);
1da177e4
LT
521 while (pages) {
522 struct page *p = alloc_page(GFP_KERNEL);
523 if (!p)
524 break;
44524359 525 rqstp->rq_pages[arghi++] = p;
1da177e4
LT
526 pages--;
527 }
1da177e4
LT
528 return ! pages;
529}
530
531/*
532 * Release an RPC server buffer
533 */
534static void
535svc_release_buffer(struct svc_rqst *rqstp)
536{
50c8bb13
CL
537 unsigned int i;
538
539 for (i = 0; i < ARRAY_SIZE(rqstp->rq_pages); i++)
44524359
N
540 if (rqstp->rq_pages[i])
541 put_page(rqstp->rq_pages[i]);
1da177e4
LT
542}
543
0113ab34
JL
544struct svc_rqst *
545svc_prepare_thread(struct svc_serv *serv, struct svc_pool *pool)
1da177e4
LT
546{
547 struct svc_rqst *rqstp;
1da177e4 548
0da974f4 549 rqstp = kzalloc(sizeof(*rqstp), GFP_KERNEL);
1da177e4 550 if (!rqstp)
0113ab34 551 goto out_enomem;
1da177e4 552
1da177e4
LT
553 init_waitqueue_head(&rqstp->rq_wait);
554
1da177e4 555 serv->sv_nrthreads++;
3262c816
GB
556 spin_lock_bh(&pool->sp_lock);
557 pool->sp_nrthreads++;
a7455442 558 list_add(&rqstp->rq_all, &pool->sp_all_threads);
3262c816 559 spin_unlock_bh(&pool->sp_lock);
1da177e4 560 rqstp->rq_server = serv;
3262c816 561 rqstp->rq_pool = pool;
bfd24160 562
0113ab34
JL
563 rqstp->rq_argp = kmalloc(serv->sv_xdrsize, GFP_KERNEL);
564 if (!rqstp->rq_argp)
565 goto out_thread;
566
567 rqstp->rq_resp = kmalloc(serv->sv_xdrsize, GFP_KERNEL);
568 if (!rqstp->rq_resp)
569 goto out_thread;
570
571 if (!svc_init_buffer(rqstp, serv->sv_max_mesg))
572 goto out_thread;
573
574 return rqstp;
575out_thread:
576 svc_exit_thread(rqstp);
577out_enomem:
578 return ERR_PTR(-ENOMEM);
579}
580EXPORT_SYMBOL(svc_prepare_thread);
581
582/*
583 * Create a thread in the given pool. Caller must hold BKL.
584 * On a NUMA or SMP machine, with a multi-pool serv, the thread
585 * will be restricted to run on the cpus belonging to the pool.
586 */
587static int
588__svc_create_thread(svc_thread_fn func, struct svc_serv *serv,
589 struct svc_pool *pool)
590{
591 struct svc_rqst *rqstp;
592 int error = -ENOMEM;
593 int have_oldmask = 0;
c3bb257d 594 cpumask_t uninitialized_var(oldmask);
0113ab34
JL
595
596 rqstp = svc_prepare_thread(serv, pool);
597 if (IS_ERR(rqstp)) {
598 error = PTR_ERR(rqstp);
599 goto out;
600 }
601
bfd24160
GB
602 if (serv->sv_nrpools > 1)
603 have_oldmask = svc_pool_map_set_cpumask(pool->sp_id, &oldmask);
604
1da177e4 605 error = kernel_thread((int (*)(void *)) func, rqstp, 0);
bfd24160
GB
606
607 if (have_oldmask)
608 set_cpus_allowed(current, oldmask);
609
1da177e4
LT
610 if (error < 0)
611 goto out_thread;
612 svc_sock_update_bufs(serv);
613 error = 0;
614out:
615 return error;
616
617out_thread:
618 svc_exit_thread(rqstp);
619 goto out;
620}
621
a7455442
GB
622/*
623 * Choose a pool in which to create a new thread, for svc_set_num_threads
624 */
625static inline struct svc_pool *
626choose_pool(struct svc_serv *serv, struct svc_pool *pool, unsigned int *state)
627{
628 if (pool != NULL)
629 return pool;
630
cca5172a 631 return &serv->sv_pools[(*state)++ % serv->sv_nrpools];
a7455442
GB
632}
633
634/*
635 * Choose a thread to kill, for svc_set_num_threads
636 */
637static inline struct task_struct *
638choose_victim(struct svc_serv *serv, struct svc_pool *pool, unsigned int *state)
639{
640 unsigned int i;
641 struct task_struct *task = NULL;
642
643 if (pool != NULL) {
644 spin_lock_bh(&pool->sp_lock);
645 } else {
646 /* choose a pool in round-robin fashion */
cca5172a
YH
647 for (i = 0; i < serv->sv_nrpools; i++) {
648 pool = &serv->sv_pools[--(*state) % serv->sv_nrpools];
a7455442 649 spin_lock_bh(&pool->sp_lock);
cca5172a
YH
650 if (!list_empty(&pool->sp_all_threads))
651 goto found_pool;
a7455442 652 spin_unlock_bh(&pool->sp_lock);
cca5172a 653 }
a7455442
GB
654 return NULL;
655 }
656
657found_pool:
658 if (!list_empty(&pool->sp_all_threads)) {
659 struct svc_rqst *rqstp;
660
661 /*
662 * Remove from the pool->sp_all_threads list
663 * so we don't try to kill it again.
664 */
665 rqstp = list_entry(pool->sp_all_threads.next, struct svc_rqst, rq_all);
666 list_del_init(&rqstp->rq_all);
667 task = rqstp->rq_task;
cca5172a 668 }
a7455442
GB
669 spin_unlock_bh(&pool->sp_lock);
670
671 return task;
672}
673
674/*
675 * Create or destroy enough new threads to make the number
676 * of threads the given number. If `pool' is non-NULL, applies
677 * only to threads in that pool, otherwise round-robins between
678 * all pools. Must be called with a svc_get() reference and
679 * the BKL held.
680 *
681 * Destroying threads relies on the service threads filling in
682 * rqstp->rq_task, which only the nfs ones do. Assumes the serv
683 * has been created using svc_create_pooled().
684 *
685 * Based on code that used to be in nfsd_svc() but tweaked
686 * to be pool-aware.
687 */
688int
689svc_set_num_threads(struct svc_serv *serv, struct svc_pool *pool, int nrservs)
690{
691 struct task_struct *victim;
692 int error = 0;
693 unsigned int state = serv->sv_nrthreads-1;
694
695 if (pool == NULL) {
696 /* The -1 assumes caller has done a svc_get() */
697 nrservs -= (serv->sv_nrthreads-1);
698 } else {
699 spin_lock_bh(&pool->sp_lock);
700 nrservs -= pool->sp_nrthreads;
701 spin_unlock_bh(&pool->sp_lock);
702 }
703
704 /* create new threads */
705 while (nrservs > 0) {
706 nrservs--;
707 __module_get(serv->sv_module);
708 error = __svc_create_thread(serv->sv_function, serv,
709 choose_pool(serv, pool, &state));
710 if (error < 0) {
711 module_put(serv->sv_module);
712 break;
713 }
714 }
715 /* destroy old threads */
716 while (nrservs < 0 &&
717 (victim = choose_victim(serv, pool, &state)) != NULL) {
718 send_sig(serv->sv_kill_signal, victim, 1);
719 nrservs++;
720 }
721
722 return error;
723}
d2f7e79e 724EXPORT_SYMBOL(svc_set_num_threads);
a7455442 725
3262c816
GB
726/*
727 * Called from a server thread as it's exiting. Caller must hold BKL.
1da177e4
LT
728 */
729void
730svc_exit_thread(struct svc_rqst *rqstp)
731{
732 struct svc_serv *serv = rqstp->rq_server;
3262c816 733 struct svc_pool *pool = rqstp->rq_pool;
1da177e4
LT
734
735 svc_release_buffer(rqstp);
a51482bd
JJ
736 kfree(rqstp->rq_resp);
737 kfree(rqstp->rq_argp);
738 kfree(rqstp->rq_auth_data);
3262c816
GB
739
740 spin_lock_bh(&pool->sp_lock);
741 pool->sp_nrthreads--;
a7455442 742 list_del(&rqstp->rq_all);
3262c816
GB
743 spin_unlock_bh(&pool->sp_lock);
744
1da177e4
LT
745 kfree(rqstp);
746
747 /* Release the server */
748 if (serv)
749 svc_destroy(serv);
750}
d2f7e79e 751EXPORT_SYMBOL(svc_exit_thread);
1da177e4
LT
752
753/*
754 * Register an RPC service with the local portmapper.
cca5172a 755 * To unregister a service, call this routine with
1da177e4
LT
756 * proto and port == 0.
757 */
758int
759svc_register(struct svc_serv *serv, int proto, unsigned short port)
760{
761 struct svc_program *progp;
762 unsigned long flags;
ea339d46
CL
763 unsigned int i;
764 int error = 0, dummy;
1da177e4 765
1da177e4
LT
766 if (!port)
767 clear_thread_flag(TIF_SIGPENDING);
768
bc5fea42
OK
769 for (progp = serv->sv_program; progp; progp = progp->pg_next) {
770 for (i = 0; i < progp->pg_nvers; i++) {
771 if (progp->pg_vers[i] == NULL)
772 continue;
773
46121cf7 774 dprintk("svc: svc_register(%s, %s, %d, %d)%s\n",
bc5fea42
OK
775 progp->pg_name,
776 proto == IPPROTO_UDP? "udp" : "tcp",
777 port,
778 i,
779 progp->pg_vers[i]->vs_hidden?
780 " (but not telling portmap)" : "");
781
782 if (progp->pg_vers[i]->vs_hidden)
783 continue;
784
26080014 785 error = rpcb_register(progp->pg_prog, i, proto, port, &dummy);
bc5fea42
OK
786 if (error < 0)
787 break;
788 if (port && !dummy) {
789 error = -EACCES;
790 break;
791 }
1da177e4
LT
792 }
793 }
794
795 if (!port) {
796 spin_lock_irqsave(&current->sighand->siglock, flags);
797 recalc_sigpending();
798 spin_unlock_irqrestore(&current->sighand->siglock, flags);
799 }
800
801 return error;
802}
803
354ecbb9
DDAG
804/*
805 * Printk the given error with the address of the client that caused it.
806 */
807static int
808__attribute__ ((format (printf, 2, 3)))
809svc_printk(struct svc_rqst *rqstp, const char *fmt, ...)
810{
811 va_list args;
812 int r;
813 char buf[RPC_MAX_ADDRBUFLEN];
814
815 if (!net_ratelimit())
816 return 0;
817
818 printk(KERN_WARNING "svc: %s: ",
819 svc_print_addr(rqstp, buf, sizeof(buf)));
820
821 va_start(args, fmt);
822 r = vprintk(fmt, args);
823 va_end(args);
824
825 return r;
826}
827
1da177e4
LT
828/*
829 * Process the RPC request.
830 */
831int
6fb2b47f 832svc_process(struct svc_rqst *rqstp)
1da177e4
LT
833{
834 struct svc_program *progp;
835 struct svc_version *versp = NULL; /* compiler food */
836 struct svc_procedure *procp = NULL;
837 struct kvec * argv = &rqstp->rq_arg.head[0];
838 struct kvec * resv = &rqstp->rq_res.head[0];
6fb2b47f 839 struct svc_serv *serv = rqstp->rq_server;
1da177e4 840 kxdrproc_t xdr;
d8ed029d
AD
841 __be32 *statp;
842 u32 dir, prog, vers, proc;
843 __be32 auth_stat, rpc_stat;
1da177e4 844 int auth_res;
8f8e05c5 845 __be32 *reply_statp;
1da177e4
LT
846
847 rpc_stat = rpc_success;
848
849 if (argv->iov_len < 6*4)
850 goto err_short_len;
851
852 /* setup response xdr_buf.
cca5172a 853 * Initially it has just one page
1da177e4 854 */
44524359 855 rqstp->rq_resused = 1;
1da177e4
LT
856 resv->iov_base = page_address(rqstp->rq_respages[0]);
857 resv->iov_len = 0;
44524359 858 rqstp->rq_res.pages = rqstp->rq_respages + 1;
1da177e4
LT
859 rqstp->rq_res.len = 0;
860 rqstp->rq_res.page_base = 0;
861 rqstp->rq_res.page_len = 0;
334ccfd5 862 rqstp->rq_res.buflen = PAGE_SIZE;
7c9fdcfb 863 rqstp->rq_res.tail[0].iov_base = NULL;
1da177e4 864 rqstp->rq_res.tail[0].iov_len = 0;
5c04c46a 865 /* Will be turned off only in gss privacy case: */
cf8208d0 866 rqstp->rq_splice_ok = 1;
e831fe65
TT
867
868 /* Setup reply header */
869 rqstp->rq_xprt->xpt_ops->xpo_prep_reply_hdr(rqstp);
1da177e4
LT
870
871 rqstp->rq_xid = svc_getu32(argv);
872 svc_putu32(resv, rqstp->rq_xid);
873
76994313
AD
874 dir = svc_getnl(argv);
875 vers = svc_getnl(argv);
1da177e4
LT
876
877 /* First words of reply: */
76994313 878 svc_putnl(resv, 1); /* REPLY */
1da177e4
LT
879
880 if (dir != 0) /* direction != CALL */
881 goto err_bad_dir;
882 if (vers != 2) /* RPC version number */
883 goto err_bad_rpc;
884
885 /* Save position in case we later decide to reject: */
8f8e05c5 886 reply_statp = resv->iov_base + resv->iov_len;
1da177e4 887
76994313 888 svc_putnl(resv, 0); /* ACCEPT */
1da177e4 889
76994313
AD
890 rqstp->rq_prog = prog = svc_getnl(argv); /* program number */
891 rqstp->rq_vers = vers = svc_getnl(argv); /* version number */
892 rqstp->rq_proc = proc = svc_getnl(argv); /* procedure number */
1da177e4
LT
893
894 progp = serv->sv_program;
80d188a6
N
895
896 for (progp = serv->sv_program; progp; progp = progp->pg_next)
897 if (prog == progp->pg_prog)
898 break;
899
1da177e4
LT
900 /*
901 * Decode auth data, and add verifier to reply buffer.
902 * We do this before anything else in order to get a decent
903 * auth verifier.
904 */
905 auth_res = svc_authenticate(rqstp, &auth_stat);
906 /* Also give the program a chance to reject this call: */
80d188a6 907 if (auth_res == SVC_OK && progp) {
1da177e4
LT
908 auth_stat = rpc_autherr_badcred;
909 auth_res = progp->pg_authenticate(rqstp);
910 }
911 switch (auth_res) {
912 case SVC_OK:
913 break;
914 case SVC_GARBAGE:
dd35210e 915 goto err_garbage;
1da177e4
LT
916 case SVC_SYSERR:
917 rpc_stat = rpc_system_err;
918 goto err_bad;
919 case SVC_DENIED:
920 goto err_bad_auth;
921 case SVC_DROP:
922 goto dropit;
923 case SVC_COMPLETE:
924 goto sendit;
925 }
80d188a6 926
9ba02638 927 if (progp == NULL)
1da177e4
LT
928 goto err_bad_prog;
929
930 if (vers >= progp->pg_nvers ||
931 !(versp = progp->pg_vers[vers]))
932 goto err_bad_vers;
933
934 procp = versp->vs_proc + proc;
935 if (proc >= versp->vs_nproc || !procp->pc_func)
936 goto err_bad_proc;
937 rqstp->rq_server = serv;
938 rqstp->rq_procinfo = procp;
939
940 /* Syntactic check complete */
941 serv->sv_stats->rpccnt++;
942
943 /* Build the reply header. */
944 statp = resv->iov_base +resv->iov_len;
76994313 945 svc_putnl(resv, RPC_SUCCESS);
1da177e4
LT
946
947 /* Bump per-procedure stats counter */
948 procp->pc_count++;
949
950 /* Initialize storage for argp and resp */
951 memset(rqstp->rq_argp, 0, procp->pc_argsize);
952 memset(rqstp->rq_resp, 0, procp->pc_ressize);
953
cca5172a 954 /* un-reserve some of the out-queue now that we have a
1da177e4
LT
955 * better idea of reply size
956 */
957 if (procp->pc_xdrressize)
cd123012 958 svc_reserve_auth(rqstp, procp->pc_xdrressize<<2);
1da177e4
LT
959
960 /* Call the function that processes the request. */
961 if (!versp->vs_dispatch) {
962 /* Decode arguments */
963 xdr = procp->pc_decode;
964 if (xdr && !xdr(rqstp, argv->iov_base, rqstp->rq_argp))
965 goto err_garbage;
966
967 *statp = procp->pc_func(rqstp, rqstp->rq_argp, rqstp->rq_resp);
968
969 /* Encode reply */
d343fce1
N
970 if (*statp == rpc_drop_reply) {
971 if (procp->pc_release)
972 procp->pc_release(rqstp, NULL, rqstp->rq_resp);
973 goto dropit;
974 }
1da177e4
LT
975 if (*statp == rpc_success && (xdr = procp->pc_encode)
976 && !xdr(rqstp, resv->iov_base+resv->iov_len, rqstp->rq_resp)) {
977 dprintk("svc: failed to encode reply\n");
978 /* serv->sv_stats->rpcsystemerr++; */
979 *statp = rpc_system_err;
980 }
981 } else {
982 dprintk("svc: calling dispatcher\n");
983 if (!versp->vs_dispatch(rqstp, statp)) {
984 /* Release reply info */
985 if (procp->pc_release)
986 procp->pc_release(rqstp, NULL, rqstp->rq_resp);
987 goto dropit;
988 }
989 }
990
991 /* Check RPC status result */
992 if (*statp != rpc_success)
993 resv->iov_len = ((void*)statp) - resv->iov_base + 4;
994
995 /* Release reply info */
996 if (procp->pc_release)
997 procp->pc_release(rqstp, NULL, rqstp->rq_resp);
998
999 if (procp->pc_encode == NULL)
1000 goto dropit;
1001
1002 sendit:
1003 if (svc_authorise(rqstp))
1004 goto dropit;
1005 return svc_send(rqstp);
1006
1007 dropit:
1008 svc_authorise(rqstp); /* doesn't hurt to call this twice */
1009 dprintk("svc: svc_process dropit\n");
1010 svc_drop(rqstp);
1011 return 0;
1012
1013err_short_len:
354ecbb9
DDAG
1014 svc_printk(rqstp, "short len %Zd, dropping request\n",
1015 argv->iov_len);
34e9a63b 1016
1da177e4
LT
1017 goto dropit; /* drop request */
1018
1019err_bad_dir:
354ecbb9 1020 svc_printk(rqstp, "bad direction %d, dropping request\n", dir);
34e9a63b 1021
1da177e4
LT
1022 serv->sv_stats->rpcbadfmt++;
1023 goto dropit; /* drop request */
1024
1025err_bad_rpc:
1026 serv->sv_stats->rpcbadfmt++;
76994313
AD
1027 svc_putnl(resv, 1); /* REJECT */
1028 svc_putnl(resv, 0); /* RPC_MISMATCH */
1029 svc_putnl(resv, 2); /* Only RPCv2 supported */
1030 svc_putnl(resv, 2);
1da177e4
LT
1031 goto sendit;
1032
1033err_bad_auth:
1034 dprintk("svc: authentication failed (%d)\n", ntohl(auth_stat));
1035 serv->sv_stats->rpcbadauth++;
1036 /* Restore write pointer to location of accept status: */
8f8e05c5 1037 xdr_ressize_check(rqstp, reply_statp);
76994313
AD
1038 svc_putnl(resv, 1); /* REJECT */
1039 svc_putnl(resv, 1); /* AUTH_ERROR */
1040 svc_putnl(resv, ntohl(auth_stat)); /* status */
1da177e4
LT
1041 goto sendit;
1042
1043err_bad_prog:
9ba02638 1044 dprintk("svc: unknown program %d\n", prog);
1da177e4 1045 serv->sv_stats->rpcbadfmt++;
76994313 1046 svc_putnl(resv, RPC_PROG_UNAVAIL);
1da177e4
LT
1047 goto sendit;
1048
1049err_bad_vers:
354ecbb9 1050 svc_printk(rqstp, "unknown version (%d for prog %d, %s)\n",
34e9a63b
N
1051 vers, prog, progp->pg_name);
1052
1da177e4 1053 serv->sv_stats->rpcbadfmt++;
76994313
AD
1054 svc_putnl(resv, RPC_PROG_MISMATCH);
1055 svc_putnl(resv, progp->pg_lovers);
1056 svc_putnl(resv, progp->pg_hivers);
1da177e4
LT
1057 goto sendit;
1058
1059err_bad_proc:
354ecbb9 1060 svc_printk(rqstp, "unknown procedure (%d)\n", proc);
34e9a63b 1061
1da177e4 1062 serv->sv_stats->rpcbadfmt++;
76994313 1063 svc_putnl(resv, RPC_PROC_UNAVAIL);
1da177e4
LT
1064 goto sendit;
1065
1066err_garbage:
354ecbb9 1067 svc_printk(rqstp, "failed to decode args\n");
34e9a63b 1068
1da177e4
LT
1069 rpc_stat = rpc_garbage_args;
1070err_bad:
1071 serv->sv_stats->rpcbadfmt++;
76994313 1072 svc_putnl(resv, ntohl(rpc_stat));
1da177e4
LT
1073 goto sendit;
1074}
d2f7e79e 1075EXPORT_SYMBOL(svc_process);
7adae489
GB
1076
1077/*
1078 * Return (transport-specific) limit on the rpc payload.
1079 */
1080u32 svc_max_payload(const struct svc_rqst *rqstp)
1081{
49023155 1082 u32 max = rqstp->rq_xprt->xpt_class->xcl_max_payload;
7adae489 1083
c6b0a9f8
N
1084 if (rqstp->rq_server->sv_max_payload < max)
1085 max = rqstp->rq_server->sv_max_payload;
7adae489
GB
1086 return max;
1087}
1088EXPORT_SYMBOL_GPL(svc_max_payload);