]> git.proxmox.com Git - mirror_ubuntu-jammy-kernel.git/blame - net/sunrpc/svc.c
knfsd: remove special handling for SIGHUP
[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>
1da177e4
LT
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
1da177e4 29
42a7fc4a
GB
30#define svc_serv_is_pooled(serv) ((serv)->sv_function)
31
bfd24160
GB
32/*
33 * Mode for mapping cpus to pools.
34 */
35enum {
42a7fc4a 36 SVC_POOL_AUTO = -1, /* choose one of the others */
bfd24160
GB
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};
42a7fc4a 42#define SVC_POOL_DEFAULT SVC_POOL_GLOBAL
bfd24160
GB
43
44/*
45 * Structure for mapping cpus to pools and vice versa.
46 * Setup once during sunrpc initialisation.
47 */
48static struct svc_pool_map {
42a7fc4a 49 int count; /* How many svc_servs use us */
bfd24160
GB
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 = {
42a7fc4a
GB
57 .count = 0,
58 .mode = SVC_POOL_DEFAULT
bfd24160 59};
42a7fc4a
GB
60static DEFINE_MUTEX(svc_pool_map_mutex);/* protects svc_pool_map.count only */
61
62static int
63param_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
87out:
88 mutex_unlock(&svc_pool_map_mutex);
89 return err;
90}
91
92static int
93param_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}
bfd24160 111
42a7fc4a
GB
112module_param_call(pool_mode, param_set_pool_mode, param_get_pool_mode,
113 &svc_pool_map.mode, 0644);
bfd24160
GB
114
115/*
116 * Detect best pool mapping mode heuristically,
117 * according to the machine's topology.
118 */
119static int
120svc_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 */
151static int
152svc_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
163fail_free:
164 kfree(m->to_pool);
165fail:
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 */
173static int
174svc_pool_map_init_percpu(struct svc_pool_map *m)
175{
53b8a315 176 unsigned int maxpools = nr_cpu_ids;
bfd24160
GB
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 */
201static int
202svc_pool_map_init_pernode(struct svc_pool_map *m)
203{
74c7aa8b 204 unsigned int maxpools = nr_node_ids;
bfd24160
GB
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/*
42a7fc4a
GB
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.
bfd24160
GB
230 */
231static unsigned int
42a7fc4a 232svc_pool_map_get(void)
bfd24160
GB
233{
234 struct svc_pool_map *m = &svc_pool_map;
235 int npools = -1;
236
42a7fc4a
GB
237 mutex_lock(&svc_pool_map_mutex);
238
239 if (m->count++) {
240 mutex_unlock(&svc_pool_map_mutex);
bfd24160 241 return m->npools;
42a7fc4a 242 }
bfd24160 243
42a7fc4a
GB
244 if (m->mode == SVC_POOL_AUTO)
245 m->mode = svc_pool_map_choose_mode();
bfd24160
GB
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
42a7fc4a 263 mutex_unlock(&svc_pool_map_mutex);
bfd24160
GB
264 return m->npools;
265}
266
42a7fc4a
GB
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 */
275static void
276svc_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
bfd24160
GB
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 */
299static inline int
300svc_pool_map_set_cpumask(unsigned int pidx, cpumask_t *oldmask)
301{
302 struct svc_pool_map *m = &svc_pool_map;
bfd24160
GB
303
304 /*
305 * The caller checks for sv_nrpools > 1, which
42a7fc4a 306 * implies that we've been initialized.
bfd24160 307 */
42a7fc4a 308 BUG_ON(m->count == 0);
bfd24160
GB
309
310 switch (m->mode)
311 {
312 default:
313 return 0;
314 case SVC_POOL_PERCPU:
c5f59f08
MT
315 {
316 unsigned int cpu = m->pool_to[pidx];
317
bfd24160 318 *oldmask = current->cpus_allowed;
c5f59f08 319 set_cpus_allowed_ptr(current, &cpumask_of_cpu(cpu));
bfd24160 320 return 1;
c5f59f08 321 }
bfd24160 322 case SVC_POOL_PERNODE:
c5f59f08
MT
323 {
324 unsigned int node = m->pool_to[pidx];
325 node_to_cpumask_ptr(nodecpumask, node);
326
bfd24160 327 *oldmask = current->cpus_allowed;
c5f59f08 328 set_cpus_allowed_ptr(current, nodecpumask);
bfd24160
GB
329 return 1;
330 }
c5f59f08 331 }
bfd24160
GB
332}
333
334/*
335 * Use the mapping mode to choose a pool for a given CPU.
336 * Used when enqueueing an incoming RPC. Always returns
337 * a non-NULL pool pointer.
338 */
339struct svc_pool *
340svc_pool_for_cpu(struct svc_serv *serv, int cpu)
341{
342 struct svc_pool_map *m = &svc_pool_map;
343 unsigned int pidx = 0;
344
345 /*
42a7fc4a 346 * An uninitialised map happens in a pure client when
bfd24160
GB
347 * lockd is brought up, so silently treat it the
348 * same as SVC_POOL_GLOBAL.
349 */
42a7fc4a
GB
350 if (svc_serv_is_pooled(serv)) {
351 switch (m->mode) {
352 case SVC_POOL_PERCPU:
353 pidx = m->to_pool[cpu];
354 break;
355 case SVC_POOL_PERNODE:
356 pidx = m->to_pool[cpu_to_node(cpu)];
357 break;
358 }
bfd24160
GB
359 }
360 return &serv->sv_pools[pidx % serv->sv_nrpools];
361}
362
363
1da177e4
LT
364/*
365 * Create an RPC service
366 */
a7455442
GB
367static struct svc_serv *
368__svc_create(struct svc_program *prog, unsigned int bufsize, int npools,
bc591ccf 369 void (*shutdown)(struct svc_serv *serv))
1da177e4
LT
370{
371 struct svc_serv *serv;
ea339d46 372 unsigned int vers;
1da177e4 373 unsigned int xdrsize;
3262c816 374 unsigned int i;
1da177e4 375
0da974f4 376 if (!(serv = kzalloc(sizeof(*serv), GFP_KERNEL)))
1da177e4 377 return NULL;
9ba02638 378 serv->sv_name = prog->pg_name;
1da177e4
LT
379 serv->sv_program = prog;
380 serv->sv_nrthreads = 1;
381 serv->sv_stats = prog->pg_stats;
c6b0a9f8
N
382 if (bufsize > RPCSVC_MAXPAYLOAD)
383 bufsize = RPCSVC_MAXPAYLOAD;
384 serv->sv_max_payload = bufsize? bufsize : 4096;
385 serv->sv_max_mesg = roundup(serv->sv_max_payload + PAGE_SIZE, PAGE_SIZE);
bc591ccf 386 serv->sv_shutdown = shutdown;
1da177e4 387 xdrsize = 0;
9ba02638
AG
388 while (prog) {
389 prog->pg_lovers = prog->pg_nvers-1;
390 for (vers=0; vers<prog->pg_nvers ; vers++)
391 if (prog->pg_vers[vers]) {
392 prog->pg_hivers = vers;
393 if (prog->pg_lovers > vers)
394 prog->pg_lovers = vers;
395 if (prog->pg_vers[vers]->vs_xdrsize > xdrsize)
396 xdrsize = prog->pg_vers[vers]->vs_xdrsize;
397 }
398 prog = prog->pg_next;
399 }
1da177e4 400 serv->sv_xdrsize = xdrsize;
1da177e4
LT
401 INIT_LIST_HEAD(&serv->sv_tempsocks);
402 INIT_LIST_HEAD(&serv->sv_permsocks);
36bdfc8b 403 init_timer(&serv->sv_temptimer);
1da177e4
LT
404 spin_lock_init(&serv->sv_lock);
405
a7455442 406 serv->sv_nrpools = npools;
3262c816 407 serv->sv_pools =
cd861280 408 kcalloc(serv->sv_nrpools, sizeof(struct svc_pool),
3262c816
GB
409 GFP_KERNEL);
410 if (!serv->sv_pools) {
411 kfree(serv);
412 return NULL;
413 }
414
415 for (i = 0; i < serv->sv_nrpools; i++) {
416 struct svc_pool *pool = &serv->sv_pools[i];
417
46121cf7 418 dprintk("svc: initialising pool %u for %s\n",
3262c816
GB
419 i, serv->sv_name);
420
421 pool->sp_id = i;
422 INIT_LIST_HEAD(&pool->sp_threads);
423 INIT_LIST_HEAD(&pool->sp_sockets);
a7455442 424 INIT_LIST_HEAD(&pool->sp_all_threads);
3262c816
GB
425 spin_lock_init(&pool->sp_lock);
426 }
427
428
1da177e4
LT
429 /* Remove any stale portmap registrations */
430 svc_register(serv, 0, 0);
431
432 return serv;
433}
434
a7455442
GB
435struct svc_serv *
436svc_create(struct svc_program *prog, unsigned int bufsize,
437 void (*shutdown)(struct svc_serv *serv))
438{
439 return __svc_create(prog, bufsize, /*npools*/1, shutdown);
440}
d2f7e79e 441EXPORT_SYMBOL(svc_create);
a7455442
GB
442
443struct svc_serv *
444svc_create_pooled(struct svc_program *prog, unsigned int bufsize,
445 void (*shutdown)(struct svc_serv *serv),
446 svc_thread_fn func, int sig, struct module *mod)
447{
448 struct svc_serv *serv;
42a7fc4a 449 unsigned int npools = svc_pool_map_get();
a7455442 450
bfd24160 451 serv = __svc_create(prog, bufsize, npools, shutdown);
a7455442
GB
452
453 if (serv != NULL) {
454 serv->sv_function = func;
455 serv->sv_kill_signal = sig;
456 serv->sv_module = mod;
457 }
458
459 return serv;
460}
d2f7e79e 461EXPORT_SYMBOL(svc_create_pooled);
a7455442 462
1da177e4 463/*
bedbdd8b
NB
464 * Destroy an RPC service. Should be called with appropriate locking to
465 * protect the sv_nrthreads, sv_permsocks and sv_tempsocks.
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{
0dc220f0 513 unsigned int pages, arghi;
cca5172a 514
c6b0a9f8
N
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 */
1da177e4 518 arghi = 0;
09a62660 519 BUG_ON(pages > RPCSVC_MAXPAGES);
1da177e4
LT
520 while (pages) {
521 struct page *p = alloc_page(GFP_KERNEL);
522 if (!p)
523 break;
44524359 524 rqstp->rq_pages[arghi++] = p;
1da177e4
LT
525 pages--;
526 }
0dc220f0 527 return pages == 0;
1da177e4
LT
528}
529
530/*
531 * Release an RPC server buffer
532 */
533static void
534svc_release_buffer(struct svc_rqst *rqstp)
535{
50c8bb13
CL
536 unsigned int i;
537
538 for (i = 0; i < ARRAY_SIZE(rqstp->rq_pages); i++)
44524359
N
539 if (rqstp->rq_pages[i])
540 put_page(rqstp->rq_pages[i]);
1da177e4
LT
541}
542
0113ab34
JL
543struct svc_rqst *
544svc_prepare_thread(struct svc_serv *serv, struct svc_pool *pool)
1da177e4
LT
545{
546 struct svc_rqst *rqstp;
1da177e4 547
0da974f4 548 rqstp = kzalloc(sizeof(*rqstp), GFP_KERNEL);
1da177e4 549 if (!rqstp)
0113ab34 550 goto out_enomem;
1da177e4 551
1da177e4
LT
552 init_waitqueue_head(&rqstp->rq_wait);
553
1da177e4 554 serv->sv_nrthreads++;
3262c816
GB
555 spin_lock_bh(&pool->sp_lock);
556 pool->sp_nrthreads++;
a7455442 557 list_add(&rqstp->rq_all, &pool->sp_all_threads);
3262c816 558 spin_unlock_bh(&pool->sp_lock);
1da177e4 559 rqstp->rq_server = serv;
3262c816 560 rqstp->rq_pool = pool;
bfd24160 561
0113ab34
JL
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;
574out_thread:
575 svc_exit_thread(rqstp);
576out_enomem:
577 return ERR_PTR(-ENOMEM);
578}
579EXPORT_SYMBOL(svc_prepare_thread);
580
581/*
bedbdd8b
NB
582 * Create a thread in the given pool. Caller must hold BKL or another lock to
583 * serialize access to the svc_serv struct. On a NUMA or SMP machine, with a
584 * multi-pool serv, the thread will be restricted to run on the cpus belonging
585 * to the pool.
0113ab34
JL
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
bedbdd8b 679 * the BKL or another lock to protect access to svc_serv fields.
a7455442
GB
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 726/*
bedbdd8b
NB
727 * Called from a server thread as it's exiting. Caller must hold the BKL or
728 * the "service mutex", whichever is appropriate for the service.
1da177e4
LT
729 */
730void
731svc_exit_thread(struct svc_rqst *rqstp)
732{
733 struct svc_serv *serv = rqstp->rq_server;
3262c816 734 struct svc_pool *pool = rqstp->rq_pool;
1da177e4
LT
735
736 svc_release_buffer(rqstp);
a51482bd
JJ
737 kfree(rqstp->rq_resp);
738 kfree(rqstp->rq_argp);
739 kfree(rqstp->rq_auth_data);
3262c816
GB
740
741 spin_lock_bh(&pool->sp_lock);
742 pool->sp_nrthreads--;
a7455442 743 list_del(&rqstp->rq_all);
3262c816
GB
744 spin_unlock_bh(&pool->sp_lock);
745
1da177e4
LT
746 kfree(rqstp);
747
748 /* Release the server */
749 if (serv)
750 svc_destroy(serv);
751}
d2f7e79e 752EXPORT_SYMBOL(svc_exit_thread);
1da177e4
LT
753
754/*
755 * Register an RPC service with the local portmapper.
cca5172a 756 * To unregister a service, call this routine with
1da177e4
LT
757 * proto and port == 0.
758 */
759int
760svc_register(struct svc_serv *serv, int proto, unsigned short port)
761{
762 struct svc_program *progp;
763 unsigned long flags;
ea339d46
CL
764 unsigned int i;
765 int error = 0, dummy;
1da177e4 766
1da177e4
LT
767 if (!port)
768 clear_thread_flag(TIF_SIGPENDING);
769
bc5fea42
OK
770 for (progp = serv->sv_program; progp; progp = progp->pg_next) {
771 for (i = 0; i < progp->pg_nvers; i++) {
772 if (progp->pg_vers[i] == NULL)
773 continue;
774
46121cf7 775 dprintk("svc: svc_register(%s, %s, %d, %d)%s\n",
bc5fea42
OK
776 progp->pg_name,
777 proto == IPPROTO_UDP? "udp" : "tcp",
778 port,
779 i,
780 progp->pg_vers[i]->vs_hidden?
781 " (but not telling portmap)" : "");
782
783 if (progp->pg_vers[i]->vs_hidden)
784 continue;
785
26080014 786 error = rpcb_register(progp->pg_prog, i, proto, port, &dummy);
bc5fea42
OK
787 if (error < 0)
788 break;
789 if (port && !dummy) {
790 error = -EACCES;
791 break;
792 }
1da177e4
LT
793 }
794 }
795
796 if (!port) {
797 spin_lock_irqsave(&current->sighand->siglock, flags);
798 recalc_sigpending();
799 spin_unlock_irqrestore(&current->sighand->siglock, flags);
800 }
801
802 return error;
803}
804
354ecbb9
DDAG
805/*
806 * Printk the given error with the address of the client that caused it.
807 */
808static int
809__attribute__ ((format (printf, 2, 3)))
810svc_printk(struct svc_rqst *rqstp, const char *fmt, ...)
811{
812 va_list args;
813 int r;
814 char buf[RPC_MAX_ADDRBUFLEN];
815
816 if (!net_ratelimit())
817 return 0;
818
819 printk(KERN_WARNING "svc: %s: ",
820 svc_print_addr(rqstp, buf, sizeof(buf)));
821
822 va_start(args, fmt);
823 r = vprintk(fmt, args);
824 va_end(args);
825
826 return r;
827}
828
1da177e4
LT
829/*
830 * Process the RPC request.
831 */
832int
6fb2b47f 833svc_process(struct svc_rqst *rqstp)
1da177e4
LT
834{
835 struct svc_program *progp;
836 struct svc_version *versp = NULL; /* compiler food */
837 struct svc_procedure *procp = NULL;
838 struct kvec * argv = &rqstp->rq_arg.head[0];
839 struct kvec * resv = &rqstp->rq_res.head[0];
6fb2b47f 840 struct svc_serv *serv = rqstp->rq_server;
1da177e4 841 kxdrproc_t xdr;
d8ed029d
AD
842 __be32 *statp;
843 u32 dir, prog, vers, proc;
844 __be32 auth_stat, rpc_stat;
1da177e4 845 int auth_res;
8f8e05c5 846 __be32 *reply_statp;
1da177e4
LT
847
848 rpc_stat = rpc_success;
849
850 if (argv->iov_len < 6*4)
851 goto err_short_len;
852
853 /* setup response xdr_buf.
cca5172a 854 * Initially it has just one page
1da177e4 855 */
44524359 856 rqstp->rq_resused = 1;
1da177e4
LT
857 resv->iov_base = page_address(rqstp->rq_respages[0]);
858 resv->iov_len = 0;
44524359 859 rqstp->rq_res.pages = rqstp->rq_respages + 1;
1da177e4
LT
860 rqstp->rq_res.len = 0;
861 rqstp->rq_res.page_base = 0;
862 rqstp->rq_res.page_len = 0;
334ccfd5 863 rqstp->rq_res.buflen = PAGE_SIZE;
7c9fdcfb 864 rqstp->rq_res.tail[0].iov_base = NULL;
1da177e4 865 rqstp->rq_res.tail[0].iov_len = 0;
5c04c46a 866 /* Will be turned off only in gss privacy case: */
cf8208d0 867 rqstp->rq_splice_ok = 1;
e831fe65
TT
868
869 /* Setup reply header */
870 rqstp->rq_xprt->xpt_ops->xpo_prep_reply_hdr(rqstp);
1da177e4
LT
871
872 rqstp->rq_xid = svc_getu32(argv);
873 svc_putu32(resv, rqstp->rq_xid);
874
76994313
AD
875 dir = svc_getnl(argv);
876 vers = svc_getnl(argv);
1da177e4
LT
877
878 /* First words of reply: */
76994313 879 svc_putnl(resv, 1); /* REPLY */
1da177e4
LT
880
881 if (dir != 0) /* direction != CALL */
882 goto err_bad_dir;
883 if (vers != 2) /* RPC version number */
884 goto err_bad_rpc;
885
886 /* Save position in case we later decide to reject: */
8f8e05c5 887 reply_statp = resv->iov_base + resv->iov_len;
1da177e4 888
76994313 889 svc_putnl(resv, 0); /* ACCEPT */
1da177e4 890
76994313
AD
891 rqstp->rq_prog = prog = svc_getnl(argv); /* program number */
892 rqstp->rq_vers = vers = svc_getnl(argv); /* version number */
893 rqstp->rq_proc = proc = svc_getnl(argv); /* procedure number */
1da177e4
LT
894
895 progp = serv->sv_program;
80d188a6
N
896
897 for (progp = serv->sv_program; progp; progp = progp->pg_next)
898 if (prog == progp->pg_prog)
899 break;
900
1da177e4
LT
901 /*
902 * Decode auth data, and add verifier to reply buffer.
903 * We do this before anything else in order to get a decent
904 * auth verifier.
905 */
906 auth_res = svc_authenticate(rqstp, &auth_stat);
907 /* Also give the program a chance to reject this call: */
80d188a6 908 if (auth_res == SVC_OK && progp) {
1da177e4
LT
909 auth_stat = rpc_autherr_badcred;
910 auth_res = progp->pg_authenticate(rqstp);
911 }
912 switch (auth_res) {
913 case SVC_OK:
914 break;
915 case SVC_GARBAGE:
dd35210e 916 goto err_garbage;
1da177e4
LT
917 case SVC_SYSERR:
918 rpc_stat = rpc_system_err;
919 goto err_bad;
920 case SVC_DENIED:
921 goto err_bad_auth;
922 case SVC_DROP:
923 goto dropit;
924 case SVC_COMPLETE:
925 goto sendit;
926 }
80d188a6 927
9ba02638 928 if (progp == NULL)
1da177e4
LT
929 goto err_bad_prog;
930
931 if (vers >= progp->pg_nvers ||
932 !(versp = progp->pg_vers[vers]))
933 goto err_bad_vers;
934
935 procp = versp->vs_proc + proc;
936 if (proc >= versp->vs_nproc || !procp->pc_func)
937 goto err_bad_proc;
938 rqstp->rq_server = serv;
939 rqstp->rq_procinfo = procp;
940
941 /* Syntactic check complete */
942 serv->sv_stats->rpccnt++;
943
944 /* Build the reply header. */
945 statp = resv->iov_base +resv->iov_len;
76994313 946 svc_putnl(resv, RPC_SUCCESS);
1da177e4
LT
947
948 /* Bump per-procedure stats counter */
949 procp->pc_count++;
950
951 /* Initialize storage for argp and resp */
952 memset(rqstp->rq_argp, 0, procp->pc_argsize);
953 memset(rqstp->rq_resp, 0, procp->pc_ressize);
954
cca5172a 955 /* un-reserve some of the out-queue now that we have a
1da177e4
LT
956 * better idea of reply size
957 */
958 if (procp->pc_xdrressize)
cd123012 959 svc_reserve_auth(rqstp, procp->pc_xdrressize<<2);
1da177e4
LT
960
961 /* Call the function that processes the request. */
962 if (!versp->vs_dispatch) {
963 /* Decode arguments */
964 xdr = procp->pc_decode;
965 if (xdr && !xdr(rqstp, argv->iov_base, rqstp->rq_argp))
966 goto err_garbage;
967
968 *statp = procp->pc_func(rqstp, rqstp->rq_argp, rqstp->rq_resp);
969
970 /* Encode reply */
d343fce1
N
971 if (*statp == rpc_drop_reply) {
972 if (procp->pc_release)
973 procp->pc_release(rqstp, NULL, rqstp->rq_resp);
974 goto dropit;
975 }
1da177e4
LT
976 if (*statp == rpc_success && (xdr = procp->pc_encode)
977 && !xdr(rqstp, resv->iov_base+resv->iov_len, rqstp->rq_resp)) {
978 dprintk("svc: failed to encode reply\n");
979 /* serv->sv_stats->rpcsystemerr++; */
980 *statp = rpc_system_err;
981 }
982 } else {
983 dprintk("svc: calling dispatcher\n");
984 if (!versp->vs_dispatch(rqstp, statp)) {
985 /* Release reply info */
986 if (procp->pc_release)
987 procp->pc_release(rqstp, NULL, rqstp->rq_resp);
988 goto dropit;
989 }
990 }
991
992 /* Check RPC status result */
993 if (*statp != rpc_success)
994 resv->iov_len = ((void*)statp) - resv->iov_base + 4;
995
996 /* Release reply info */
997 if (procp->pc_release)
998 procp->pc_release(rqstp, NULL, rqstp->rq_resp);
999
1000 if (procp->pc_encode == NULL)
1001 goto dropit;
1002
1003 sendit:
1004 if (svc_authorise(rqstp))
1005 goto dropit;
1006 return svc_send(rqstp);
1007
1008 dropit:
1009 svc_authorise(rqstp); /* doesn't hurt to call this twice */
1010 dprintk("svc: svc_process dropit\n");
1011 svc_drop(rqstp);
1012 return 0;
1013
1014err_short_len:
354ecbb9
DDAG
1015 svc_printk(rqstp, "short len %Zd, dropping request\n",
1016 argv->iov_len);
34e9a63b 1017
1da177e4
LT
1018 goto dropit; /* drop request */
1019
1020err_bad_dir:
354ecbb9 1021 svc_printk(rqstp, "bad direction %d, dropping request\n", dir);
34e9a63b 1022
1da177e4
LT
1023 serv->sv_stats->rpcbadfmt++;
1024 goto dropit; /* drop request */
1025
1026err_bad_rpc:
1027 serv->sv_stats->rpcbadfmt++;
76994313
AD
1028 svc_putnl(resv, 1); /* REJECT */
1029 svc_putnl(resv, 0); /* RPC_MISMATCH */
1030 svc_putnl(resv, 2); /* Only RPCv2 supported */
1031 svc_putnl(resv, 2);
1da177e4
LT
1032 goto sendit;
1033
1034err_bad_auth:
1035 dprintk("svc: authentication failed (%d)\n", ntohl(auth_stat));
1036 serv->sv_stats->rpcbadauth++;
1037 /* Restore write pointer to location of accept status: */
8f8e05c5 1038 xdr_ressize_check(rqstp, reply_statp);
76994313
AD
1039 svc_putnl(resv, 1); /* REJECT */
1040 svc_putnl(resv, 1); /* AUTH_ERROR */
1041 svc_putnl(resv, ntohl(auth_stat)); /* status */
1da177e4
LT
1042 goto sendit;
1043
1044err_bad_prog:
9ba02638 1045 dprintk("svc: unknown program %d\n", prog);
1da177e4 1046 serv->sv_stats->rpcbadfmt++;
76994313 1047 svc_putnl(resv, RPC_PROG_UNAVAIL);
1da177e4
LT
1048 goto sendit;
1049
1050err_bad_vers:
354ecbb9 1051 svc_printk(rqstp, "unknown version (%d for prog %d, %s)\n",
34e9a63b
N
1052 vers, prog, progp->pg_name);
1053
1da177e4 1054 serv->sv_stats->rpcbadfmt++;
76994313
AD
1055 svc_putnl(resv, RPC_PROG_MISMATCH);
1056 svc_putnl(resv, progp->pg_lovers);
1057 svc_putnl(resv, progp->pg_hivers);
1da177e4
LT
1058 goto sendit;
1059
1060err_bad_proc:
354ecbb9 1061 svc_printk(rqstp, "unknown procedure (%d)\n", proc);
34e9a63b 1062
1da177e4 1063 serv->sv_stats->rpcbadfmt++;
76994313 1064 svc_putnl(resv, RPC_PROC_UNAVAIL);
1da177e4
LT
1065 goto sendit;
1066
1067err_garbage:
354ecbb9 1068 svc_printk(rqstp, "failed to decode args\n");
34e9a63b 1069
1da177e4
LT
1070 rpc_stat = rpc_garbage_args;
1071err_bad:
1072 serv->sv_stats->rpcbadfmt++;
76994313 1073 svc_putnl(resv, ntohl(rpc_stat));
1da177e4
LT
1074 goto sendit;
1075}
d2f7e79e 1076EXPORT_SYMBOL(svc_process);
7adae489
GB
1077
1078/*
1079 * Return (transport-specific) limit on the rpc payload.
1080 */
1081u32 svc_max_payload(const struct svc_rqst *rqstp)
1082{
49023155 1083 u32 max = rqstp->rq_xprt->xpt_class->xcl_max_payload;
7adae489 1084
c6b0a9f8
N
1085 if (rqstp->rq_server->sv_max_payload < max)
1086 max = rqstp->rq_server->sv_max_payload;
7adae489
GB
1087 return max;
1088}
1089EXPORT_SYMBOL_GPL(svc_max_payload);