xref: /linux/net/sunrpc/svc.c (revision 7f221b340d16558919d963a2afed585d6a145fa4)
1 // SPDX-License-Identifier: GPL-2.0-only
2 /*
3  * linux/net/sunrpc/svc.c
4  *
5  * High-level RPC service routines
6  *
7  * Copyright (C) 1995, 1996 Olaf Kirch <okir@monad.swb.de>
8  *
9  * Multiple threads pools and NUMAisation
10  * Copyright (c) 2006 Silicon Graphics, Inc.
11  * by Greg Banks <gnb@melbourne.sgi.com>
12  */
13 
14 #include <linux/linkage.h>
15 #include <linux/sched/signal.h>
16 #include <linux/errno.h>
17 #include <linux/net.h>
18 #include <linux/in.h>
19 #include <linux/mm.h>
20 #include <linux/interrupt.h>
21 #include <linux/module.h>
22 #include <linux/kthread.h>
23 #include <linux/slab.h>
24 
25 #include <linux/sunrpc/types.h>
26 #include <linux/sunrpc/xdr.h>
27 #include <linux/sunrpc/stats.h>
28 #include <linux/sunrpc/svcsock.h>
29 #include <linux/sunrpc/clnt.h>
30 #include <linux/sunrpc/bc_xprt.h>
31 
32 #include <trace/events/sunrpc.h>
33 
34 #include "fail.h"
35 #include "sunrpc.h"
36 
37 #define RPCDBG_FACILITY	RPCDBG_SVCDSP
38 
39 static void svc_unregister(const struct svc_serv *serv, struct net *net);
40 
41 #define SVC_POOL_DEFAULT	SVC_POOL_GLOBAL
42 
43 /*
44  * Mode for mapping cpus to pools.
45  */
46 enum {
47 	SVC_POOL_AUTO = -1,	/* choose one of the others */
48 	SVC_POOL_GLOBAL,	/* no mapping, just a single global pool
49 				 * (legacy & UP mode) */
50 	SVC_POOL_PERCPU,	/* one pool per cpu */
51 	SVC_POOL_PERNODE	/* one pool per numa node */
52 };
53 
54 /*
55  * Structure for mapping cpus to pools and vice versa.
56  * Setup once during sunrpc initialisation.
57  */
58 
59 struct svc_pool_map {
60 	int count;			/* How many svc_servs use us */
61 	int mode;			/* Note: int not enum to avoid
62 					 * warnings about "enumeration value
63 					 * not handled in switch" */
64 	unsigned int npools;
65 	unsigned int *pool_to;		/* maps pool id to cpu or node */
66 	unsigned int *to_pool;		/* maps cpu or node to pool id */
67 };
68 
69 static struct svc_pool_map svc_pool_map = {
70 	.mode = SVC_POOL_DEFAULT
71 };
72 
73 static DEFINE_MUTEX(svc_pool_map_mutex);/* protects svc_pool_map.count only */
74 
75 static int
76 __param_set_pool_mode(const char *val, struct svc_pool_map *m)
77 {
78 	int err, mode;
79 
80 	mutex_lock(&svc_pool_map_mutex);
81 
82 	err = 0;
83 	if (!strncmp(val, "auto", 4))
84 		mode = SVC_POOL_AUTO;
85 	else if (!strncmp(val, "global", 6))
86 		mode = SVC_POOL_GLOBAL;
87 	else if (!strncmp(val, "percpu", 6))
88 		mode = SVC_POOL_PERCPU;
89 	else if (!strncmp(val, "pernode", 7))
90 		mode = SVC_POOL_PERNODE;
91 	else
92 		err = -EINVAL;
93 
94 	if (err)
95 		goto out;
96 
97 	if (m->count == 0)
98 		m->mode = mode;
99 	else if (mode != m->mode)
100 		err = -EBUSY;
101 out:
102 	mutex_unlock(&svc_pool_map_mutex);
103 	return err;
104 }
105 
106 static int
107 param_set_pool_mode(const char *val, const struct kernel_param *kp)
108 {
109 	struct svc_pool_map *m = kp->arg;
110 
111 	return __param_set_pool_mode(val, m);
112 }
113 
114 int sunrpc_set_pool_mode(const char *val)
115 {
116 	return __param_set_pool_mode(val, &svc_pool_map);
117 }
118 EXPORT_SYMBOL(sunrpc_set_pool_mode);
119 
120 /**
121  * sunrpc_get_pool_mode - get the current pool_mode for the host
122  * @buf: where to write the current pool_mode
123  * @size: size of @buf
124  *
125  * Grab the current pool_mode from the svc_pool_map and write
126  * the resulting string to @buf. Returns the number of characters
127  * written to @buf (a'la snprintf()).
128  */
129 int
130 sunrpc_get_pool_mode(char *buf, size_t size)
131 {
132 	struct svc_pool_map *m = &svc_pool_map;
133 
134 	switch (m->mode)
135 	{
136 	case SVC_POOL_AUTO:
137 		return snprintf(buf, size, "auto");
138 	case SVC_POOL_GLOBAL:
139 		return snprintf(buf, size, "global");
140 	case SVC_POOL_PERCPU:
141 		return snprintf(buf, size, "percpu");
142 	case SVC_POOL_PERNODE:
143 		return snprintf(buf, size, "pernode");
144 	default:
145 		return snprintf(buf, size, "%d", m->mode);
146 	}
147 }
148 EXPORT_SYMBOL(sunrpc_get_pool_mode);
149 
150 static int
151 param_get_pool_mode(char *buf, const struct kernel_param *kp)
152 {
153 	char str[16];
154 	int len;
155 
156 	len = sunrpc_get_pool_mode(str, ARRAY_SIZE(str));
157 
158 	/* Ensure we have room for newline and NUL */
159 	len = min_t(int, len, ARRAY_SIZE(str) - 2);
160 
161 	/* tack on the newline */
162 	str[len] = '\n';
163 	str[len + 1] = '\0';
164 
165 	return sysfs_emit(buf, "%s", str);
166 }
167 
168 module_param_call(pool_mode, param_set_pool_mode, param_get_pool_mode,
169 		  &svc_pool_map, 0644);
170 
171 /*
172  * Detect best pool mapping mode heuristically,
173  * according to the machine's topology.
174  */
175 static int
176 svc_pool_map_choose_mode(void)
177 {
178 	unsigned int node;
179 
180 	if (nr_online_nodes > 1) {
181 		/*
182 		 * Actually have multiple NUMA nodes,
183 		 * so split pools on NUMA node boundaries
184 		 */
185 		return SVC_POOL_PERNODE;
186 	}
187 
188 	node = first_online_node;
189 	if (nr_cpus_node(node) > 2) {
190 		/*
191 		 * Non-trivial SMP, or CONFIG_NUMA on
192 		 * non-NUMA hardware, e.g. with a generic
193 		 * x86_64 kernel on Xeons.  In this case we
194 		 * want to divide the pools on cpu boundaries.
195 		 */
196 		return SVC_POOL_PERCPU;
197 	}
198 
199 	/* default: one global pool */
200 	return SVC_POOL_GLOBAL;
201 }
202 
203 /*
204  * Allocate the to_pool[] and pool_to[] arrays.
205  * Returns 0 on success or an errno.
206  */
207 static int
208 svc_pool_map_alloc_arrays(struct svc_pool_map *m, unsigned int maxpools)
209 {
210 	m->to_pool = kcalloc(maxpools, sizeof(unsigned int), GFP_KERNEL);
211 	if (!m->to_pool)
212 		goto fail;
213 	m->pool_to = kcalloc(maxpools, sizeof(unsigned int), GFP_KERNEL);
214 	if (!m->pool_to)
215 		goto fail_free;
216 
217 	return 0;
218 
219 fail_free:
220 	kfree(m->to_pool);
221 	m->to_pool = NULL;
222 fail:
223 	return -ENOMEM;
224 }
225 
226 /*
227  * Initialise the pool map for SVC_POOL_PERCPU mode.
228  * Returns number of pools or <0 on error.
229  */
230 static int
231 svc_pool_map_init_percpu(struct svc_pool_map *m)
232 {
233 	unsigned int maxpools = nr_cpu_ids;
234 	unsigned int pidx = 0;
235 	unsigned int cpu;
236 	int err;
237 
238 	err = svc_pool_map_alloc_arrays(m, maxpools);
239 	if (err)
240 		return err;
241 
242 	for_each_online_cpu(cpu) {
243 		BUG_ON(pidx >= maxpools);
244 		m->to_pool[cpu] = pidx;
245 		m->pool_to[pidx] = cpu;
246 		pidx++;
247 	}
248 	/* cpus brought online later all get mapped to pool0, sorry */
249 
250 	return pidx;
251 };
252 
253 
254 /*
255  * Initialise the pool map for SVC_POOL_PERNODE mode.
256  * Returns number of pools or <0 on error.
257  */
258 static int
259 svc_pool_map_init_pernode(struct svc_pool_map *m)
260 {
261 	unsigned int maxpools = nr_node_ids;
262 	unsigned int pidx = 0;
263 	unsigned int node;
264 	int err;
265 
266 	err = svc_pool_map_alloc_arrays(m, maxpools);
267 	if (err)
268 		return err;
269 
270 	for_each_node_with_cpus(node) {
271 		/* some architectures (e.g. SN2) have cpuless nodes */
272 		BUG_ON(pidx > maxpools);
273 		m->to_pool[node] = pidx;
274 		m->pool_to[pidx] = node;
275 		pidx++;
276 	}
277 	/* nodes brought online later all get mapped to pool0, sorry */
278 
279 	return pidx;
280 }
281 
282 
283 /*
284  * Add a reference to the global map of cpus to pools (and
285  * vice versa) if pools are in use.
286  * Initialise the map if we're the first user.
287  * Returns the number of pools. If this is '1', no reference
288  * was taken.
289  */
290 static unsigned int
291 svc_pool_map_get(void)
292 {
293 	struct svc_pool_map *m = &svc_pool_map;
294 	int npools = -1;
295 
296 	mutex_lock(&svc_pool_map_mutex);
297 	if (m->count++) {
298 		mutex_unlock(&svc_pool_map_mutex);
299 		return m->npools;
300 	}
301 
302 	if (m->mode == SVC_POOL_AUTO)
303 		m->mode = svc_pool_map_choose_mode();
304 
305 	switch (m->mode) {
306 	case SVC_POOL_PERCPU:
307 		npools = svc_pool_map_init_percpu(m);
308 		break;
309 	case SVC_POOL_PERNODE:
310 		npools = svc_pool_map_init_pernode(m);
311 		break;
312 	}
313 
314 	if (npools <= 0) {
315 		/* default, or memory allocation failure */
316 		npools = 1;
317 		m->mode = SVC_POOL_GLOBAL;
318 	}
319 	m->npools = npools;
320 	mutex_unlock(&svc_pool_map_mutex);
321 	return npools;
322 }
323 
324 /*
325  * Drop a reference to the global map of cpus to pools.
326  * When the last reference is dropped, the map data is
327  * freed; this allows the sysadmin to change the pool.
328  */
329 static void
330 svc_pool_map_put(void)
331 {
332 	struct svc_pool_map *m = &svc_pool_map;
333 
334 	mutex_lock(&svc_pool_map_mutex);
335 	if (!--m->count) {
336 		kfree(m->to_pool);
337 		m->to_pool = NULL;
338 		kfree(m->pool_to);
339 		m->pool_to = NULL;
340 		m->npools = 0;
341 	}
342 	mutex_unlock(&svc_pool_map_mutex);
343 }
344 
345 static int svc_pool_map_get_node(unsigned int pidx)
346 {
347 	const struct svc_pool_map *m = &svc_pool_map;
348 
349 	if (m->count) {
350 		if (m->mode == SVC_POOL_PERCPU)
351 			return cpu_to_node(m->pool_to[pidx]);
352 		if (m->mode == SVC_POOL_PERNODE)
353 			return m->pool_to[pidx];
354 	}
355 	return numa_mem_id();
356 }
357 /*
358  * Set the given thread's cpus_allowed mask so that it
359  * will only run on cpus in the given pool.
360  */
361 static inline void
362 svc_pool_map_set_cpumask(struct task_struct *task, unsigned int pidx)
363 {
364 	struct svc_pool_map *m = &svc_pool_map;
365 	unsigned int node = m->pool_to[pidx];
366 
367 	/*
368 	 * The caller checks for sv_nrpools > 1, which
369 	 * implies that we've been initialized.
370 	 */
371 	WARN_ON_ONCE(m->count == 0);
372 	if (m->count == 0)
373 		return;
374 
375 	switch (m->mode) {
376 	case SVC_POOL_PERCPU:
377 	{
378 		set_cpus_allowed_ptr(task, cpumask_of(node));
379 		break;
380 	}
381 	case SVC_POOL_PERNODE:
382 	{
383 		set_cpus_allowed_ptr(task, cpumask_of_node(node));
384 		break;
385 	}
386 	}
387 }
388 
389 /**
390  * svc_pool_for_cpu - Select pool to run a thread on this cpu
391  * @serv: An RPC service
392  *
393  * Use the active CPU and the svc_pool_map's mode setting to
394  * select the svc thread pool to use. Once initialized, the
395  * svc_pool_map does not change.
396  *
397  * Return value:
398  *   A pointer to an svc_pool
399  */
400 struct svc_pool *svc_pool_for_cpu(struct svc_serv *serv)
401 {
402 	struct svc_pool_map *m = &svc_pool_map;
403 	int cpu = raw_smp_processor_id();
404 	unsigned int pidx = 0;
405 
406 	if (serv->sv_nrpools <= 1)
407 		return serv->sv_pools;
408 
409 	switch (m->mode) {
410 	case SVC_POOL_PERCPU:
411 		pidx = m->to_pool[cpu];
412 		break;
413 	case SVC_POOL_PERNODE:
414 		pidx = m->to_pool[cpu_to_node(cpu)];
415 		break;
416 	}
417 
418 	return &serv->sv_pools[pidx % serv->sv_nrpools];
419 }
420 
421 static int svc_rpcb_setup(struct svc_serv *serv, struct net *net)
422 {
423 	int err;
424 
425 	err = rpcb_create_local(net);
426 	if (err)
427 		return err;
428 
429 	/* Remove any stale portmap registrations */
430 	svc_unregister(serv, net);
431 	return 0;
432 }
433 
434 void svc_rpcb_cleanup(struct svc_serv *serv, struct net *net)
435 {
436 	svc_unregister(serv, net);
437 	rpcb_put_local(net);
438 }
439 
440 static int svc_uses_rpcbind(struct svc_serv *serv)
441 {
442 	unsigned int		p, i;
443 
444 	for (p = 0; p < serv->sv_nprogs; p++) {
445 		struct svc_program *progp = &serv->sv_programs[p];
446 
447 		for (i = 0; i < progp->pg_nvers; i++) {
448 			if (progp->pg_vers[i] == NULL)
449 				continue;
450 			if (!progp->pg_vers[i]->vs_hidden)
451 				return 1;
452 		}
453 	}
454 
455 	return 0;
456 }
457 
458 int svc_bind(struct svc_serv *serv, struct net *net)
459 {
460 	if (!svc_uses_rpcbind(serv))
461 		return 0;
462 	return svc_rpcb_setup(serv, net);
463 }
464 EXPORT_SYMBOL_GPL(svc_bind);
465 
466 #if defined(CONFIG_SUNRPC_BACKCHANNEL)
467 static void
468 __svc_init_bc(struct svc_serv *serv)
469 {
470 	lwq_init(&serv->sv_cb_list);
471 }
472 #else
473 static void
474 __svc_init_bc(struct svc_serv *serv)
475 {
476 }
477 #endif
478 
479 /*
480  * Create an RPC service
481  */
482 static struct svc_serv *
483 __svc_create(struct svc_program *prog, int nprogs, struct svc_stat *stats,
484 	     unsigned int bufsize, int npools, int (*threadfn)(void *data))
485 {
486 	struct svc_serv	*serv;
487 	unsigned int vers;
488 	unsigned int xdrsize;
489 	unsigned int i;
490 
491 	if (!(serv = kzalloc(sizeof(*serv), GFP_KERNEL)))
492 		return NULL;
493 	serv->sv_name      = prog->pg_name;
494 	serv->sv_programs  = prog;
495 	serv->sv_nprogs    = nprogs;
496 	serv->sv_stats     = stats;
497 	if (bufsize > RPCSVC_MAXPAYLOAD)
498 		bufsize = RPCSVC_MAXPAYLOAD;
499 	serv->sv_max_payload = bufsize? bufsize : 4096;
500 	serv->sv_max_mesg  = roundup(serv->sv_max_payload + PAGE_SIZE, PAGE_SIZE);
501 	serv->sv_threadfn = threadfn;
502 	xdrsize = 0;
503 	for (i = 0; i < nprogs; i++) {
504 		struct svc_program *progp = &prog[i];
505 
506 		progp->pg_lovers = progp->pg_nvers-1;
507 		for (vers = 0; vers < progp->pg_nvers ; vers++)
508 			if (progp->pg_vers[vers]) {
509 				progp->pg_hivers = vers;
510 				if (progp->pg_lovers > vers)
511 					progp->pg_lovers = vers;
512 				if (progp->pg_vers[vers]->vs_xdrsize > xdrsize)
513 					xdrsize = progp->pg_vers[vers]->vs_xdrsize;
514 			}
515 	}
516 	serv->sv_xdrsize   = xdrsize;
517 	INIT_LIST_HEAD(&serv->sv_tempsocks);
518 	INIT_LIST_HEAD(&serv->sv_permsocks);
519 	timer_setup(&serv->sv_temptimer, NULL, 0);
520 	spin_lock_init(&serv->sv_lock);
521 
522 	__svc_init_bc(serv);
523 
524 	serv->sv_nrpools = npools;
525 	serv->sv_pools =
526 		kcalloc(serv->sv_nrpools, sizeof(struct svc_pool),
527 			GFP_KERNEL);
528 	if (!serv->sv_pools) {
529 		kfree(serv);
530 		return NULL;
531 	}
532 
533 	for (i = 0; i < serv->sv_nrpools; i++) {
534 		struct svc_pool *pool = &serv->sv_pools[i];
535 
536 		dprintk("svc: initialising pool %u for %s\n",
537 				i, serv->sv_name);
538 
539 		pool->sp_id = i;
540 		lwq_init(&pool->sp_xprts);
541 		INIT_LIST_HEAD(&pool->sp_all_threads);
542 		init_llist_head(&pool->sp_idle_threads);
543 
544 		percpu_counter_init(&pool->sp_messages_arrived, 0, GFP_KERNEL);
545 		percpu_counter_init(&pool->sp_sockets_queued, 0, GFP_KERNEL);
546 		percpu_counter_init(&pool->sp_threads_woken, 0, GFP_KERNEL);
547 	}
548 
549 	return serv;
550 }
551 
552 /**
553  * svc_create - Create an RPC service
554  * @prog: the RPC program the new service will handle
555  * @bufsize: maximum message size for @prog
556  * @threadfn: a function to service RPC requests for @prog
557  *
558  * Returns an instantiated struct svc_serv object or NULL.
559  */
560 struct svc_serv *svc_create(struct svc_program *prog, unsigned int bufsize,
561 			    int (*threadfn)(void *data))
562 {
563 	return __svc_create(prog, 1, NULL, bufsize, 1, threadfn);
564 }
565 EXPORT_SYMBOL_GPL(svc_create);
566 
567 /**
568  * svc_create_pooled - Create an RPC service with pooled threads
569  * @prog:  Array of RPC programs the new service will handle
570  * @nprogs: Number of programs in the array
571  * @stats: the stats struct if desired
572  * @bufsize: maximum message size for @prog
573  * @threadfn: a function to service RPC requests for @prog
574  *
575  * Returns an instantiated struct svc_serv object or NULL.
576  */
577 struct svc_serv *svc_create_pooled(struct svc_program *prog,
578 				   unsigned int nprogs,
579 				   struct svc_stat *stats,
580 				   unsigned int bufsize,
581 				   int (*threadfn)(void *data))
582 {
583 	struct svc_serv *serv;
584 	unsigned int npools = svc_pool_map_get();
585 
586 	serv = __svc_create(prog, nprogs, stats, bufsize, npools, threadfn);
587 	if (!serv)
588 		goto out_err;
589 	serv->sv_is_pooled = true;
590 	return serv;
591 out_err:
592 	svc_pool_map_put();
593 	return NULL;
594 }
595 EXPORT_SYMBOL_GPL(svc_create_pooled);
596 
597 /*
598  * Destroy an RPC service. Should be called with appropriate locking to
599  * protect sv_permsocks and sv_tempsocks.
600  */
601 void
602 svc_destroy(struct svc_serv **servp)
603 {
604 	struct svc_serv *serv = *servp;
605 	unsigned int i;
606 
607 	*servp = NULL;
608 
609 	dprintk("svc: svc_destroy(%s)\n", serv->sv_programs->pg_name);
610 	timer_shutdown_sync(&serv->sv_temptimer);
611 
612 	/*
613 	 * Remaining transports at this point are not expected.
614 	 */
615 	WARN_ONCE(!list_empty(&serv->sv_permsocks),
616 		  "SVC: permsocks remain for %s\n", serv->sv_programs->pg_name);
617 	WARN_ONCE(!list_empty(&serv->sv_tempsocks),
618 		  "SVC: tempsocks remain for %s\n", serv->sv_programs->pg_name);
619 
620 	cache_clean_deferred(serv);
621 
622 	if (serv->sv_is_pooled)
623 		svc_pool_map_put();
624 
625 	for (i = 0; i < serv->sv_nrpools; i++) {
626 		struct svc_pool *pool = &serv->sv_pools[i];
627 
628 		percpu_counter_destroy(&pool->sp_messages_arrived);
629 		percpu_counter_destroy(&pool->sp_sockets_queued);
630 		percpu_counter_destroy(&pool->sp_threads_woken);
631 	}
632 	kfree(serv->sv_pools);
633 	kfree(serv);
634 }
635 EXPORT_SYMBOL_GPL(svc_destroy);
636 
637 static bool
638 svc_init_buffer(struct svc_rqst *rqstp, const struct svc_serv *serv, int node)
639 {
640 	rqstp->rq_maxpages = svc_serv_maxpages(serv);
641 
642 	/* rq_pages' last entry is NULL for historical reasons. */
643 	rqstp->rq_pages = kcalloc_node(rqstp->rq_maxpages + 1,
644 				       sizeof(struct page *),
645 				       GFP_KERNEL, node);
646 	if (!rqstp->rq_pages)
647 		return false;
648 
649 	return true;
650 }
651 
652 /*
653  * Release an RPC server buffer
654  */
655 static void
656 svc_release_buffer(struct svc_rqst *rqstp)
657 {
658 	unsigned long i;
659 
660 	for (i = 0; i < rqstp->rq_maxpages; i++)
661 		if (rqstp->rq_pages[i])
662 			put_page(rqstp->rq_pages[i]);
663 	kfree(rqstp->rq_pages);
664 }
665 
666 static void
667 svc_rqst_free(struct svc_rqst *rqstp)
668 {
669 	folio_batch_release(&rqstp->rq_fbatch);
670 	kfree(rqstp->rq_bvec);
671 	svc_release_buffer(rqstp);
672 	if (rqstp->rq_scratch_folio)
673 		folio_put(rqstp->rq_scratch_folio);
674 	kfree(rqstp->rq_resp);
675 	kfree(rqstp->rq_argp);
676 	kfree(rqstp->rq_auth_data);
677 	kfree_rcu(rqstp, rq_rcu_head);
678 }
679 
680 static struct svc_rqst *
681 svc_prepare_thread(struct svc_serv *serv, struct svc_pool *pool, int node)
682 {
683 	struct svc_rqst	*rqstp;
684 
685 	rqstp = kzalloc_node(sizeof(*rqstp), GFP_KERNEL, node);
686 	if (!rqstp)
687 		return rqstp;
688 
689 	folio_batch_init(&rqstp->rq_fbatch);
690 
691 	rqstp->rq_server = serv;
692 	rqstp->rq_pool = pool;
693 
694 	rqstp->rq_scratch_folio = __folio_alloc_node(GFP_KERNEL, 0, node);
695 	if (!rqstp->rq_scratch_folio)
696 		goto out_enomem;
697 
698 	rqstp->rq_argp = kmalloc_node(serv->sv_xdrsize, GFP_KERNEL, node);
699 	if (!rqstp->rq_argp)
700 		goto out_enomem;
701 
702 	rqstp->rq_resp = kmalloc_node(serv->sv_xdrsize, GFP_KERNEL, node);
703 	if (!rqstp->rq_resp)
704 		goto out_enomem;
705 
706 	if (!svc_init_buffer(rqstp, serv, node))
707 		goto out_enomem;
708 
709 	rqstp->rq_bvec = kcalloc_node(rqstp->rq_maxpages,
710 				      sizeof(struct bio_vec),
711 				      GFP_KERNEL, node);
712 	if (!rqstp->rq_bvec)
713 		goto out_enomem;
714 
715 	rqstp->rq_err = -EAGAIN; /* No error yet */
716 
717 	serv->sv_nrthreads += 1;
718 	pool->sp_nrthreads += 1;
719 
720 	/* Protected by whatever lock the service uses when calling
721 	 * svc_set_num_threads()
722 	 */
723 	list_add_rcu(&rqstp->rq_all, &pool->sp_all_threads);
724 
725 	return rqstp;
726 
727 out_enomem:
728 	svc_rqst_free(rqstp);
729 	return NULL;
730 }
731 
732 /**
733  * svc_pool_wake_idle_thread - Awaken an idle thread in @pool
734  * @pool: service thread pool
735  *
736  * Can be called from soft IRQ or process context. Finding an idle
737  * service thread and marking it BUSY is atomic with respect to
738  * other calls to svc_pool_wake_idle_thread().
739  *
740  */
741 void svc_pool_wake_idle_thread(struct svc_pool *pool)
742 {
743 	struct svc_rqst	*rqstp;
744 	struct llist_node *ln;
745 
746 	rcu_read_lock();
747 	ln = READ_ONCE(pool->sp_idle_threads.first);
748 	if (ln) {
749 		rqstp = llist_entry(ln, struct svc_rqst, rq_idle);
750 		WRITE_ONCE(rqstp->rq_qtime, ktime_get());
751 		if (!task_is_running(rqstp->rq_task)) {
752 			wake_up_process(rqstp->rq_task);
753 			trace_svc_pool_thread_wake(pool, rqstp->rq_task->pid);
754 			percpu_counter_inc(&pool->sp_threads_woken);
755 		} else {
756 			trace_svc_pool_thread_running(pool, rqstp->rq_task->pid);
757 		}
758 		rcu_read_unlock();
759 		return;
760 	}
761 	rcu_read_unlock();
762 	trace_svc_pool_thread_noidle(pool, 0);
763 }
764 EXPORT_SYMBOL_GPL(svc_pool_wake_idle_thread);
765 
766 /**
767  * svc_new_thread - spawn a new thread in the given pool
768  * @serv: the serv to which the pool belongs
769  * @pool: pool in which thread should be spawned
770  *
771  * Create a new thread inside @pool, which is a part of @serv.
772  * Caller must hold the service mutex.
773  *
774  * Returns 0 on success, or -errno on failure.
775  */
776 int svc_new_thread(struct svc_serv *serv, struct svc_pool *pool)
777 {
778 	struct svc_rqst	*rqstp;
779 	struct task_struct *task;
780 	int node;
781 	int err = 0;
782 
783 	node = svc_pool_map_get_node(pool->sp_id);
784 
785 	rqstp = svc_prepare_thread(serv, pool, node);
786 	if (!rqstp)
787 		return -ENOMEM;
788 	task = kthread_create_on_node(serv->sv_threadfn, rqstp,
789 				      node, "%s", serv->sv_name);
790 	if (IS_ERR(task)) {
791 		err = PTR_ERR(task);
792 		goto out;
793 	}
794 
795 	rqstp->rq_task = task;
796 	if (serv->sv_nrpools > 1)
797 		svc_pool_map_set_cpumask(task, pool->sp_id);
798 
799 	svc_sock_update_bufs(serv);
800 	wake_up_process(task);
801 
802 	/* Wait for the thread to signal initialization status */
803 	wait_var_event(&rqstp->rq_err, rqstp->rq_err != -EAGAIN);
804 	err = rqstp->rq_err;
805 out:
806 	if (err)
807 		svc_exit_thread(rqstp);
808 	return err;
809 }
810 EXPORT_SYMBOL_GPL(svc_new_thread);
811 
812 static int
813 svc_start_kthreads(struct svc_serv *serv, struct svc_pool *pool, int nrservs)
814 {
815 	int err = 0;
816 
817 	while (!err && nrservs--)
818 		err = svc_new_thread(serv, pool);
819 
820 	return err;
821 }
822 
823 static int
824 svc_stop_kthreads(struct svc_serv *serv, struct svc_pool *pool, int nrservs)
825 {
826 	do {
827 		set_bit(SP_VICTIM_REMAINS, &pool->sp_flags);
828 		set_bit(SP_NEED_VICTIM, &pool->sp_flags);
829 		svc_pool_wake_idle_thread(pool);
830 		wait_on_bit(&pool->sp_flags, SP_VICTIM_REMAINS, TASK_IDLE);
831 		nrservs++;
832 	} while (nrservs < 0);
833 	return 0;
834 }
835 
836 /**
837  * svc_set_pool_threads - adjust number of threads per pool
838  * @serv: RPC service to adjust
839  * @pool: Specific pool from which to choose threads
840  * @min_threads: min number of threads to run in @pool
841  * @max_threads: max number of threads in @pool (0 means kill all threads)
842  *
843  * Create or destroy threads in @pool to bring it into an acceptable range
844  * between @min_threads and @max_threads.
845  *
846  * If @min_threads is 0 or larger than @max_threads, then it is ignored and
847  * the pool will be set to run a static @max_threads number of threads.
848  *
849  * Caller must ensure mutual exclusion between this and server startup or
850  * shutdown.
851  *
852  * Returns zero on success or a negative errno if an error occurred while
853  * starting a thread.
854  */
855 int
856 svc_set_pool_threads(struct svc_serv *serv, struct svc_pool *pool,
857 		     unsigned int min_threads, unsigned int max_threads)
858 {
859 	int delta;
860 
861 	if (!pool)
862 		return -EINVAL;
863 
864 	/* clamp min threads to the max */
865 	if (min_threads > max_threads)
866 		min_threads = max_threads;
867 
868 	pool->sp_nrthrmin = min_threads;
869 	pool->sp_nrthrmax = max_threads;
870 
871 	/*
872 	 * When min_threads is set, then only change the number of
873 	 * threads to bring it within an acceptable range.
874 	 */
875 	if (min_threads) {
876 		if (pool->sp_nrthreads > max_threads)
877 			delta = max_threads;
878 		else if (pool->sp_nrthreads < min_threads)
879 			delta = min_threads;
880 		else
881 			return 0;
882 	} else {
883 		delta = max_threads;
884 	}
885 
886 	delta -= pool->sp_nrthreads;
887 	if (delta > 0)
888 		return svc_start_kthreads(serv, pool, delta);
889 	if (delta < 0)
890 		return svc_stop_kthreads(serv, pool, delta);
891 	return 0;
892 }
893 EXPORT_SYMBOL_GPL(svc_set_pool_threads);
894 
895 /**
896  * svc_set_num_threads - adjust number of threads in serv
897  * @serv: RPC service to adjust
898  * @min_threads: min number of threads to run per pool
899  * @nrservs: New number of threads for @serv (0 means kill all threads)
900  *
901  * Create or destroy threads in @serv to bring it to @nrservs. If there
902  * are multiple pools then the new threads or victims will be distributed
903  * evenly among them.
904  *
905  * Caller must ensure mutual exclusion between this and server startup or
906  * shutdown.
907  *
908  * Returns zero on success or a negative errno if an error occurred while
909  * starting a thread. On failure, some pools may have already been
910  * adjusted; the caller is responsible for recovery.
911  */
912 int
913 svc_set_num_threads(struct svc_serv *serv, unsigned int min_threads,
914 		    unsigned int nrservs)
915 {
916 	unsigned int base = nrservs / serv->sv_nrpools;
917 	unsigned int remain = nrservs % serv->sv_nrpools;
918 	int i, err = 0;
919 
920 	for (i = 0; i < serv->sv_nrpools; ++i) {
921 		struct svc_pool *pool = &serv->sv_pools[i];
922 		int threads = base;
923 
924 		if (remain) {
925 			++threads;
926 			--remain;
927 		}
928 
929 		err = svc_set_pool_threads(serv, pool, min_threads, threads);
930 		if (err)
931 			break;
932 	}
933 	return err;
934 }
935 EXPORT_SYMBOL_GPL(svc_set_num_threads);
936 
937 /**
938  * svc_rqst_replace_page - Replace one page in rq_pages[]
939  * @rqstp: svc_rqst with pages to replace
940  * @page: replacement page
941  *
942  * When replacing a page in rq_pages, batch the release of the
943  * replaced pages to avoid hammering the page allocator.
944  *
945  * Return values:
946  *   %true: page replaced
947  *   %false: array bounds checking failed
948  */
949 bool svc_rqst_replace_page(struct svc_rqst *rqstp, struct page *page)
950 {
951 	struct page **begin = rqstp->rq_pages;
952 	struct page **end = &rqstp->rq_pages[rqstp->rq_maxpages];
953 
954 	if (unlikely(rqstp->rq_next_page < begin || rqstp->rq_next_page > end)) {
955 		trace_svc_replace_page_err(rqstp);
956 		return false;
957 	}
958 
959 	if (*rqstp->rq_next_page) {
960 		if (!folio_batch_add(&rqstp->rq_fbatch,
961 				page_folio(*rqstp->rq_next_page)))
962 			__folio_batch_release(&rqstp->rq_fbatch);
963 	}
964 
965 	get_page(page);
966 	*(rqstp->rq_next_page++) = page;
967 	return true;
968 }
969 EXPORT_SYMBOL_GPL(svc_rqst_replace_page);
970 
971 /**
972  * svc_rqst_release_pages - Release Reply buffer pages
973  * @rqstp: RPC transaction context
974  *
975  * Release response pages that might still be in flight after
976  * svc_send, and any spliced filesystem-owned pages.
977  */
978 void svc_rqst_release_pages(struct svc_rqst *rqstp)
979 {
980 	int i, count = rqstp->rq_next_page - rqstp->rq_respages;
981 
982 	if (count) {
983 		release_pages(rqstp->rq_respages, count);
984 		for (i = 0; i < count; i++)
985 			rqstp->rq_respages[i] = NULL;
986 	}
987 }
988 
989 /**
990  * svc_exit_thread - finalise the termination of a sunrpc server thread
991  * @rqstp: the svc_rqst which represents the thread.
992  *
993  * When a thread started with svc_new_thread() exits it must call
994  * svc_exit_thread() as its last act.  This must be done with the
995  * service mutex held.  Normally this is held by a DIFFERENT thread, the
996  * one that is calling svc_set_num_threads() and which will wait for
997  * SP_VICTIM_REMAINS to be cleared before dropping the mutex.  If the
998  * thread exits for any reason other than svc_thread_should_stop()
999  * returning %true (which indicated that svc_set_num_threads() is
1000  * waiting for it to exit), then it must take the service mutex itself,
1001  * which can only safely be done using mutex_try_lock().
1002  */
1003 void
1004 svc_exit_thread(struct svc_rqst *rqstp)
1005 {
1006 	struct svc_serv	*serv = rqstp->rq_server;
1007 	struct svc_pool	*pool = rqstp->rq_pool;
1008 
1009 	list_del_rcu(&rqstp->rq_all);
1010 
1011 	pool->sp_nrthreads -= 1;
1012 	serv->sv_nrthreads -= 1;
1013 	svc_sock_update_bufs(serv);
1014 
1015 	svc_rqst_free(rqstp);
1016 
1017 	clear_and_wake_up_bit(SP_VICTIM_REMAINS, &pool->sp_flags);
1018 }
1019 EXPORT_SYMBOL_GPL(svc_exit_thread);
1020 
1021 /*
1022  * Register an "inet" protocol family netid with the local
1023  * rpcbind daemon via an rpcbind v4 SET request.
1024  *
1025  * No netconfig infrastructure is available in the kernel, so
1026  * we map IP_ protocol numbers to netids by hand.
1027  *
1028  * Returns zero on success; a negative errno value is returned
1029  * if any error occurs.
1030  */
1031 static int __svc_rpcb_register4(struct net *net, const u32 program,
1032 				const u32 version,
1033 				const unsigned short protocol,
1034 				const unsigned short port)
1035 {
1036 	const struct sockaddr_in sin = {
1037 		.sin_family		= AF_INET,
1038 		.sin_addr.s_addr	= htonl(INADDR_ANY),
1039 		.sin_port		= htons(port),
1040 	};
1041 	const char *netid;
1042 	int error;
1043 
1044 	switch (protocol) {
1045 	case IPPROTO_UDP:
1046 		netid = RPCBIND_NETID_UDP;
1047 		break;
1048 	case IPPROTO_TCP:
1049 		netid = RPCBIND_NETID_TCP;
1050 		break;
1051 	default:
1052 		return -ENOPROTOOPT;
1053 	}
1054 
1055 	error = rpcb_v4_register(net, program, version,
1056 					(const struct sockaddr *)&sin, netid);
1057 
1058 	/*
1059 	 * User space didn't support rpcbind v4, so retry this
1060 	 * registration request with the legacy rpcbind v2 protocol.
1061 	 */
1062 	if (error == -EPROTONOSUPPORT)
1063 		error = rpcb_register(net, program, version, protocol, port);
1064 
1065 	return error;
1066 }
1067 
1068 #if IS_ENABLED(CONFIG_IPV6)
1069 /*
1070  * Register an "inet6" protocol family netid with the local
1071  * rpcbind daemon via an rpcbind v4 SET request.
1072  *
1073  * No netconfig infrastructure is available in the kernel, so
1074  * we map IP_ protocol numbers to netids by hand.
1075  *
1076  * Returns zero on success; a negative errno value is returned
1077  * if any error occurs.
1078  */
1079 static int __svc_rpcb_register6(struct net *net, const u32 program,
1080 				const u32 version,
1081 				const unsigned short protocol,
1082 				const unsigned short port)
1083 {
1084 	const struct sockaddr_in6 sin6 = {
1085 		.sin6_family		= AF_INET6,
1086 		.sin6_addr		= IN6ADDR_ANY_INIT,
1087 		.sin6_port		= htons(port),
1088 	};
1089 	const char *netid;
1090 	int error;
1091 
1092 	switch (protocol) {
1093 	case IPPROTO_UDP:
1094 		netid = RPCBIND_NETID_UDP6;
1095 		break;
1096 	case IPPROTO_TCP:
1097 		netid = RPCBIND_NETID_TCP6;
1098 		break;
1099 	default:
1100 		return -ENOPROTOOPT;
1101 	}
1102 
1103 	error = rpcb_v4_register(net, program, version,
1104 					(const struct sockaddr *)&sin6, netid);
1105 
1106 	/*
1107 	 * User space didn't support rpcbind version 4, so we won't
1108 	 * use a PF_INET6 listener.
1109 	 */
1110 	if (error == -EPROTONOSUPPORT)
1111 		error = -EAFNOSUPPORT;
1112 
1113 	return error;
1114 }
1115 #endif	/* IS_ENABLED(CONFIG_IPV6) */
1116 
1117 /*
1118  * Register a kernel RPC service via rpcbind version 4.
1119  *
1120  * Returns zero on success; a negative errno value is returned
1121  * if any error occurs.
1122  */
1123 static int __svc_register(struct net *net, const char *progname,
1124 			  const u32 program, const u32 version,
1125 			  const int family,
1126 			  const unsigned short protocol,
1127 			  const unsigned short port)
1128 {
1129 	int error = -EAFNOSUPPORT;
1130 
1131 	switch (family) {
1132 	case PF_INET:
1133 		error = __svc_rpcb_register4(net, program, version,
1134 						protocol, port);
1135 		break;
1136 #if IS_ENABLED(CONFIG_IPV6)
1137 	case PF_INET6:
1138 		error = __svc_rpcb_register6(net, program, version,
1139 						protocol, port);
1140 #endif
1141 	}
1142 
1143 	trace_svc_register(progname, version, family, protocol, port, error);
1144 	return error;
1145 }
1146 
1147 static
1148 int svc_rpcbind_set_version(struct net *net,
1149 			    const struct svc_program *progp,
1150 			    u32 version, int family,
1151 			    unsigned short proto,
1152 			    unsigned short port)
1153 {
1154 	return __svc_register(net, progp->pg_name, progp->pg_prog,
1155 				version, family, proto, port);
1156 
1157 }
1158 
1159 int svc_generic_rpcbind_set(struct net *net,
1160 			    const struct svc_program *progp,
1161 			    u32 version, int family,
1162 			    unsigned short proto,
1163 			    unsigned short port)
1164 {
1165 	const struct svc_version *vers = progp->pg_vers[version];
1166 	int error;
1167 
1168 	if (vers == NULL)
1169 		return 0;
1170 
1171 	if (vers->vs_hidden) {
1172 		trace_svc_noregister(progp->pg_name, version, proto,
1173 				     port, family, 0);
1174 		return 0;
1175 	}
1176 
1177 	/*
1178 	 * Don't register a UDP port if we need congestion
1179 	 * control.
1180 	 */
1181 	if (vers->vs_need_cong_ctrl && proto == IPPROTO_UDP)
1182 		return 0;
1183 
1184 	error = svc_rpcbind_set_version(net, progp, version,
1185 					family, proto, port);
1186 
1187 	return (vers->vs_rpcb_optnl) ? 0 : error;
1188 }
1189 EXPORT_SYMBOL_GPL(svc_generic_rpcbind_set);
1190 
1191 /**
1192  * svc_register - register an RPC service with the local portmapper
1193  * @serv: svc_serv struct for the service to register
1194  * @net: net namespace for the service to register
1195  * @family: protocol family of service's listener socket
1196  * @proto: transport protocol number to advertise
1197  * @port: port to advertise
1198  *
1199  * Service is registered for any address in the passed-in protocol family
1200  */
1201 int svc_register(const struct svc_serv *serv, struct net *net,
1202 		 const int family, const unsigned short proto,
1203 		 const unsigned short port)
1204 {
1205 	unsigned int		p, i;
1206 	int			error = 0;
1207 
1208 	WARN_ON_ONCE(proto == 0 && port == 0);
1209 	if (proto == 0 && port == 0)
1210 		return -EINVAL;
1211 
1212 	for (p = 0; p < serv->sv_nprogs; p++) {
1213 		struct svc_program *progp = &serv->sv_programs[p];
1214 
1215 		for (i = 0; i < progp->pg_nvers; i++) {
1216 
1217 			error = progp->pg_rpcbind_set(net, progp, i,
1218 					family, proto, port);
1219 			if (error < 0) {
1220 				printk(KERN_WARNING "svc: failed to register "
1221 					"%sv%u RPC service (errno %d).\n",
1222 					progp->pg_name, i, -error);
1223 				break;
1224 			}
1225 		}
1226 	}
1227 
1228 	return error;
1229 }
1230 
1231 /*
1232  * If user space is running rpcbind, it should take the v4 UNSET
1233  * and clear everything for this [program, version].  If user space
1234  * is running portmap, it will reject the v4 UNSET, but won't have
1235  * any "inet6" entries anyway.  So a PMAP_UNSET should be sufficient
1236  * in this case to clear all existing entries for [program, version].
1237  */
1238 static void __svc_unregister(struct net *net, const u32 program, const u32 version,
1239 			     const char *progname)
1240 {
1241 	int error;
1242 
1243 	error = rpcb_v4_register(net, program, version, NULL, "");
1244 
1245 	/*
1246 	 * User space didn't support rpcbind v4, so retry this
1247 	 * request with the legacy rpcbind v2 protocol.
1248 	 */
1249 	if (error == -EPROTONOSUPPORT)
1250 		error = rpcb_register(net, program, version, 0, 0);
1251 
1252 	trace_svc_unregister(progname, version, error);
1253 }
1254 
1255 /*
1256  * All netids, bind addresses and ports registered for [program, version]
1257  * are removed from the local rpcbind database (if the service is not
1258  * hidden) to make way for a new instance of the service.
1259  *
1260  * The result of unregistration is reported via dprintk for those who want
1261  * verification of the result, but is otherwise not important.
1262  */
1263 static void svc_unregister(const struct svc_serv *serv, struct net *net)
1264 {
1265 	struct sighand_struct *sighand;
1266 	unsigned long flags;
1267 	unsigned int p, i;
1268 
1269 	clear_thread_flag(TIF_SIGPENDING);
1270 
1271 	for (p = 0; p < serv->sv_nprogs; p++) {
1272 		struct svc_program *progp = &serv->sv_programs[p];
1273 
1274 		for (i = 0; i < progp->pg_nvers; i++) {
1275 			if (progp->pg_vers[i] == NULL)
1276 				continue;
1277 			if (progp->pg_vers[i]->vs_hidden)
1278 				continue;
1279 			__svc_unregister(net, progp->pg_prog, i, progp->pg_name);
1280 		}
1281 	}
1282 
1283 	rcu_read_lock();
1284 	sighand = rcu_dereference(current->sighand);
1285 	spin_lock_irqsave(&sighand->siglock, flags);
1286 	recalc_sigpending();
1287 	spin_unlock_irqrestore(&sighand->siglock, flags);
1288 	rcu_read_unlock();
1289 }
1290 
1291 /*
1292  * dprintk the given error with the address of the client that caused it.
1293  */
1294 #if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
1295 static __printf(2, 3)
1296 void svc_printk(struct svc_rqst *rqstp, const char *fmt, ...)
1297 {
1298 	struct va_format vaf;
1299 	va_list args;
1300 	char 	buf[RPC_MAX_ADDRBUFLEN];
1301 
1302 	va_start(args, fmt);
1303 
1304 	vaf.fmt = fmt;
1305 	vaf.va = &args;
1306 
1307 	dprintk("svc: %s: %pV", svc_print_addr(rqstp, buf, sizeof(buf)), &vaf);
1308 
1309 	va_end(args);
1310 }
1311 #else
1312 static __printf(2,3) void svc_printk(struct svc_rqst *rqstp, const char *fmt, ...) {}
1313 #endif
1314 
1315 __be32
1316 svc_generic_init_request(struct svc_rqst *rqstp,
1317 		const struct svc_program *progp,
1318 		struct svc_process_info *ret)
1319 {
1320 	const struct svc_version *versp = NULL;	/* compiler food */
1321 	const struct svc_procedure *procp = NULL;
1322 
1323 	if (rqstp->rq_vers >= progp->pg_nvers )
1324 		goto err_bad_vers;
1325 	versp = progp->pg_vers[rqstp->rq_vers];
1326 	if (!versp)
1327 		goto err_bad_vers;
1328 
1329 	/*
1330 	 * Some protocol versions (namely NFSv4) require some form of
1331 	 * congestion control.  (See RFC 7530 section 3.1 paragraph 2)
1332 	 * In other words, UDP is not allowed. We mark those when setting
1333 	 * up the svc_xprt, and verify that here.
1334 	 *
1335 	 * The spec is not very clear about what error should be returned
1336 	 * when someone tries to access a server that is listening on UDP
1337 	 * for lower versions. RPC_PROG_MISMATCH seems to be the closest
1338 	 * fit.
1339 	 */
1340 	if (versp->vs_need_cong_ctrl && rqstp->rq_xprt &&
1341 	    !test_bit(XPT_CONG_CTRL, &rqstp->rq_xprt->xpt_flags))
1342 		goto err_bad_vers;
1343 
1344 	if (rqstp->rq_proc >= versp->vs_nproc)
1345 		goto err_bad_proc;
1346 	rqstp->rq_procinfo = procp = &versp->vs_proc[rqstp->rq_proc];
1347 
1348 	/* Initialize storage for argp and resp */
1349 	memset(rqstp->rq_argp, 0, procp->pc_argzero);
1350 	memset(rqstp->rq_resp, 0, procp->pc_ressize);
1351 
1352 	/* Bump per-procedure stats counter */
1353 	this_cpu_inc(versp->vs_count[rqstp->rq_proc]);
1354 
1355 	ret->dispatch = versp->vs_dispatch;
1356 	return rpc_success;
1357 err_bad_vers:
1358 	ret->mismatch.lovers = progp->pg_lovers;
1359 	ret->mismatch.hivers = progp->pg_hivers;
1360 	return rpc_prog_mismatch;
1361 err_bad_proc:
1362 	return rpc_proc_unavail;
1363 }
1364 EXPORT_SYMBOL_GPL(svc_generic_init_request);
1365 
1366 /*
1367  * Common routine for processing the RPC request.
1368  */
1369 static int
1370 svc_process_common(struct svc_rqst *rqstp)
1371 {
1372 	struct xdr_stream	*xdr = &rqstp->rq_res_stream;
1373 	struct svc_program	*progp = NULL;
1374 	const struct svc_procedure *procp = NULL;
1375 	struct svc_serv		*serv = rqstp->rq_server;
1376 	struct svc_process_info process;
1377 	enum svc_auth_status	auth_res;
1378 	unsigned int		aoffset;
1379 	int			pr, rc;
1380 	__be32			*p;
1381 
1382 	/* Reset the accept_stat for the RPC */
1383 	rqstp->rq_accept_statp = NULL;
1384 
1385 	/* Will be turned off only when NFSv4 Sessions are used */
1386 	set_bit(RQ_USEDEFERRAL, &rqstp->rq_flags);
1387 	clear_bit(RQ_DROPME, &rqstp->rq_flags);
1388 
1389 	/* Construct the first words of the reply: */
1390 	svcxdr_init_encode(rqstp);
1391 	xdr_stream_encode_be32(xdr, rqstp->rq_xid);
1392 	xdr_stream_encode_be32(xdr, rpc_reply);
1393 
1394 	p = xdr_inline_decode(&rqstp->rq_arg_stream, XDR_UNIT * 4);
1395 	if (unlikely(!p))
1396 		goto err_short_len;
1397 	if (*p++ != cpu_to_be32(RPC_VERSION))
1398 		goto err_bad_rpc;
1399 
1400 	xdr_stream_encode_be32(xdr, rpc_msg_accepted);
1401 
1402 	rqstp->rq_prog = be32_to_cpup(p++);
1403 	rqstp->rq_vers = be32_to_cpup(p++);
1404 	rqstp->rq_proc = be32_to_cpup(p);
1405 
1406 	for (pr = 0; pr < serv->sv_nprogs; pr++)
1407 		if (rqstp->rq_prog == serv->sv_programs[pr].pg_prog)
1408 			progp = &serv->sv_programs[pr];
1409 
1410 	/*
1411 	 * Decode auth data, and add verifier to reply buffer.
1412 	 * We do this before anything else in order to get a decent
1413 	 * auth verifier.
1414 	 */
1415 	auth_res = svc_authenticate(rqstp);
1416 	/* Also give the program a chance to reject this call: */
1417 	if (auth_res == SVC_OK && progp)
1418 		auth_res = progp->pg_authenticate(rqstp);
1419 	trace_svc_authenticate(rqstp, auth_res);
1420 	switch (auth_res) {
1421 	case SVC_OK:
1422 		break;
1423 	case SVC_GARBAGE:
1424 		rqstp->rq_auth_stat = rpc_autherr_badcred;
1425 		goto err_bad_auth;
1426 	case SVC_DENIED:
1427 		goto err_bad_auth;
1428 	case SVC_CLOSE:
1429 		goto close;
1430 	case SVC_DROP:
1431 		goto dropit;
1432 	case SVC_COMPLETE:
1433 		goto sendit;
1434 	default:
1435 		pr_warn_once("Unexpected svc_auth_status (%d)\n", auth_res);
1436 		rqstp->rq_auth_stat = rpc_autherr_failed;
1437 		goto err_bad_auth;
1438 	}
1439 
1440 	if (progp == NULL)
1441 		goto err_bad_prog;
1442 
1443 	switch (progp->pg_init_request(rqstp, progp, &process)) {
1444 	case rpc_success:
1445 		break;
1446 	case rpc_prog_unavail:
1447 		goto err_bad_prog;
1448 	case rpc_prog_mismatch:
1449 		goto err_bad_vers;
1450 	case rpc_proc_unavail:
1451 		goto err_bad_proc;
1452 	}
1453 
1454 	procp = rqstp->rq_procinfo;
1455 	/* Should this check go into the dispatcher? */
1456 	if (!procp || !procp->pc_func)
1457 		goto err_bad_proc;
1458 
1459 	/* Syntactic check complete */
1460 	if (serv->sv_stats)
1461 		serv->sv_stats->rpccnt++;
1462 	trace_svc_process(rqstp, progp->pg_name);
1463 
1464 	aoffset = xdr_stream_pos(xdr);
1465 
1466 	/* un-reserve some of the out-queue now that we have a
1467 	 * better idea of reply size
1468 	 */
1469 	if (procp->pc_xdrressize)
1470 		svc_reserve_auth(rqstp, procp->pc_xdrressize<<2);
1471 
1472 	/* Call the function that processes the request. */
1473 	rc = process.dispatch(rqstp);
1474 	xdr_finish_decode(xdr);
1475 
1476 	if (!rc)
1477 		goto dropit;
1478 	if (rqstp->rq_auth_stat != rpc_auth_ok)
1479 		goto err_bad_auth;
1480 
1481 	if (*rqstp->rq_accept_statp != rpc_success)
1482 		xdr_truncate_encode(xdr, aoffset);
1483 
1484 	if (procp->pc_encode == NULL)
1485 		goto dropit;
1486 
1487  sendit:
1488 	if (svc_authorise(rqstp))
1489 		goto close_xprt;
1490 	return 1;		/* Caller can now send it */
1491 
1492  dropit:
1493 	svc_authorise(rqstp);	/* doesn't hurt to call this twice */
1494 	dprintk("svc: svc_process dropit\n");
1495 	return 0;
1496 
1497  close:
1498 	svc_authorise(rqstp);
1499 close_xprt:
1500 	if (rqstp->rq_xprt && test_bit(XPT_TEMP, &rqstp->rq_xprt->xpt_flags))
1501 		svc_xprt_close(rqstp->rq_xprt);
1502 	dprintk("svc: svc_process close\n");
1503 	return 0;
1504 
1505 err_short_len:
1506 	svc_printk(rqstp, "short len %u, dropping request\n",
1507 		   rqstp->rq_arg.len);
1508 	goto close_xprt;
1509 
1510 err_bad_rpc:
1511 	if (serv->sv_stats)
1512 		serv->sv_stats->rpcbadfmt++;
1513 	xdr_stream_encode_u32(xdr, RPC_MSG_DENIED);
1514 	xdr_stream_encode_u32(xdr, RPC_MISMATCH);
1515 	/* Only RPCv2 supported */
1516 	xdr_stream_encode_u32(xdr, RPC_VERSION);
1517 	xdr_stream_encode_u32(xdr, RPC_VERSION);
1518 	return 1;	/* don't wrap */
1519 
1520 err_bad_auth:
1521 	dprintk("svc: authentication failed (%d)\n",
1522 		be32_to_cpu(rqstp->rq_auth_stat));
1523 	if (serv->sv_stats)
1524 		serv->sv_stats->rpcbadauth++;
1525 	/* Restore write pointer to location of reply status: */
1526 	xdr_truncate_encode(xdr, XDR_UNIT * 2);
1527 	xdr_stream_encode_u32(xdr, RPC_MSG_DENIED);
1528 	xdr_stream_encode_u32(xdr, RPC_AUTH_ERROR);
1529 	xdr_stream_encode_be32(xdr, rqstp->rq_auth_stat);
1530 	goto sendit;
1531 
1532 err_bad_prog:
1533 	dprintk("svc: unknown program %d\n", rqstp->rq_prog);
1534 	if (serv->sv_stats)
1535 		serv->sv_stats->rpcbadfmt++;
1536 	*rqstp->rq_accept_statp = rpc_prog_unavail;
1537 	goto sendit;
1538 
1539 err_bad_vers:
1540 	svc_printk(rqstp, "unknown version (%d for prog %d, %s)\n",
1541 		       rqstp->rq_vers, rqstp->rq_prog, progp->pg_name);
1542 
1543 	if (serv->sv_stats)
1544 		serv->sv_stats->rpcbadfmt++;
1545 	*rqstp->rq_accept_statp = rpc_prog_mismatch;
1546 
1547 	/*
1548 	 * svc_authenticate() has already added the verifier and
1549 	 * advanced the stream just past rq_accept_statp.
1550 	 */
1551 	xdr_stream_encode_u32(xdr, process.mismatch.lovers);
1552 	xdr_stream_encode_u32(xdr, process.mismatch.hivers);
1553 	goto sendit;
1554 
1555 err_bad_proc:
1556 	svc_printk(rqstp, "unknown procedure (%d)\n", rqstp->rq_proc);
1557 
1558 	if (serv->sv_stats)
1559 		serv->sv_stats->rpcbadfmt++;
1560 	*rqstp->rq_accept_statp = rpc_proc_unavail;
1561 	goto sendit;
1562 }
1563 
1564 /*
1565  * Drop request
1566  */
1567 static void svc_drop(struct svc_rqst *rqstp)
1568 {
1569 	trace_svc_drop(rqstp);
1570 }
1571 
1572 static void svc_release_rqst(struct svc_rqst *rqstp)
1573 {
1574 	const struct svc_procedure *procp = rqstp->rq_procinfo;
1575 
1576 	if (procp && procp->pc_release)
1577 		procp->pc_release(rqstp);
1578 }
1579 
1580 /**
1581  * svc_process - Execute one RPC transaction
1582  * @rqstp: RPC transaction context
1583  *
1584  */
1585 void svc_process(struct svc_rqst *rqstp)
1586 {
1587 	struct kvec		*resv = &rqstp->rq_res.head[0];
1588 	__be32 *p;
1589 
1590 #if IS_ENABLED(CONFIG_FAIL_SUNRPC)
1591 	if (!fail_sunrpc.ignore_server_disconnect &&
1592 	    should_fail(&fail_sunrpc.attr, 1))
1593 		svc_xprt_deferred_close(rqstp->rq_xprt);
1594 #endif
1595 
1596 	/*
1597 	 * Setup response xdr_buf.
1598 	 * Initially it has just one page
1599 	 */
1600 	rqstp->rq_next_page = &rqstp->rq_respages[1];
1601 	resv->iov_base = page_address(rqstp->rq_respages[0]);
1602 	resv->iov_len = 0;
1603 	rqstp->rq_res.pages = rqstp->rq_next_page;
1604 	rqstp->rq_res.len = 0;
1605 	rqstp->rq_res.page_base = 0;
1606 	rqstp->rq_res.page_len = 0;
1607 	rqstp->rq_res.buflen = PAGE_SIZE;
1608 	rqstp->rq_res.tail[0].iov_base = NULL;
1609 	rqstp->rq_res.tail[0].iov_len = 0;
1610 
1611 	svcxdr_init_decode(rqstp);
1612 	p = xdr_inline_decode(&rqstp->rq_arg_stream, XDR_UNIT * 2);
1613 	if (unlikely(!p))
1614 		goto out_drop;
1615 	rqstp->rq_xid = *p++;
1616 	if (unlikely(*p != rpc_call))
1617 		goto out_baddir;
1618 
1619 	if (!svc_process_common(rqstp)) {
1620 		svc_release_rqst(rqstp);
1621 		goto out_drop;
1622 	}
1623 	svc_send(rqstp);
1624 	svc_release_rqst(rqstp);
1625 	return;
1626 
1627 out_baddir:
1628 	svc_printk(rqstp, "bad direction 0x%08x, dropping request\n",
1629 		   be32_to_cpu(*p));
1630 	if (rqstp->rq_server->sv_stats)
1631 		rqstp->rq_server->sv_stats->rpcbadfmt++;
1632 out_drop:
1633 	svc_drop(rqstp);
1634 }
1635 
1636 #if defined(CONFIG_SUNRPC_BACKCHANNEL)
1637 /**
1638  * svc_process_bc - process a reverse-direction RPC request
1639  * @req: RPC request to be used for client-side processing
1640  * @rqstp: server-side execution context
1641  *
1642  */
1643 void svc_process_bc(struct rpc_rqst *req, struct svc_rqst *rqstp)
1644 {
1645 	struct rpc_timeout timeout = {
1646 		.to_increment		= 0,
1647 	};
1648 	struct rpc_task *task;
1649 	int proc_error;
1650 
1651 	/* Build the svc_rqst used by the common processing routine */
1652 	rqstp->rq_xid = req->rq_xid;
1653 	rqstp->rq_prot = req->rq_xprt->prot;
1654 	rqstp->rq_bc_net = req->rq_xprt->xprt_net;
1655 
1656 	rqstp->rq_addrlen = sizeof(req->rq_xprt->addr);
1657 	memcpy(&rqstp->rq_addr, &req->rq_xprt->addr, rqstp->rq_addrlen);
1658 	memcpy(&rqstp->rq_arg, &req->rq_rcv_buf, sizeof(rqstp->rq_arg));
1659 	memcpy(&rqstp->rq_res, &req->rq_snd_buf, sizeof(rqstp->rq_res));
1660 
1661 	/* Adjust the argument buffer length */
1662 	rqstp->rq_arg.len = req->rq_private_buf.len;
1663 	if (rqstp->rq_arg.len <= rqstp->rq_arg.head[0].iov_len) {
1664 		rqstp->rq_arg.head[0].iov_len = rqstp->rq_arg.len;
1665 		rqstp->rq_arg.page_len = 0;
1666 	} else if (rqstp->rq_arg.len <= rqstp->rq_arg.head[0].iov_len +
1667 			rqstp->rq_arg.page_len)
1668 		rqstp->rq_arg.page_len = rqstp->rq_arg.len -
1669 			rqstp->rq_arg.head[0].iov_len;
1670 	else
1671 		rqstp->rq_arg.len = rqstp->rq_arg.head[0].iov_len +
1672 			rqstp->rq_arg.page_len;
1673 
1674 	/* Reset the response buffer */
1675 	rqstp->rq_res.head[0].iov_len = 0;
1676 
1677 	/*
1678 	 * Skip the XID and calldir fields because they've already
1679 	 * been processed by the caller.
1680 	 */
1681 	svcxdr_init_decode(rqstp);
1682 	if (!xdr_inline_decode(&rqstp->rq_arg_stream, XDR_UNIT * 2))
1683 		return;
1684 
1685 	/* Parse and execute the bc call */
1686 	proc_error = svc_process_common(rqstp);
1687 
1688 	atomic_dec(&req->rq_xprt->bc_slot_count);
1689 	if (!proc_error) {
1690 		/* Processing error: drop the request */
1691 		xprt_free_bc_request(req);
1692 		svc_release_rqst(rqstp);
1693 		return;
1694 	}
1695 	/* Finally, send the reply synchronously */
1696 	if (rqstp->bc_to_initval > 0) {
1697 		timeout.to_initval = rqstp->bc_to_initval;
1698 		timeout.to_retries = rqstp->bc_to_retries;
1699 	} else {
1700 		timeout.to_initval = req->rq_xprt->timeout->to_initval;
1701 		timeout.to_retries = req->rq_xprt->timeout->to_retries;
1702 	}
1703 	timeout.to_maxval = timeout.to_initval;
1704 	memcpy(&req->rq_snd_buf, &rqstp->rq_res, sizeof(req->rq_snd_buf));
1705 	task = rpc_run_bc_task(req, &timeout);
1706 	svc_release_rqst(rqstp);
1707 
1708 	if (IS_ERR(task))
1709 		return;
1710 
1711 	WARN_ON_ONCE(atomic_read(&task->tk_count) != 1);
1712 	rpc_put_task(task);
1713 }
1714 #endif /* CONFIG_SUNRPC_BACKCHANNEL */
1715 
1716 /**
1717  * svc_max_payload - Return transport-specific limit on the RPC payload
1718  * @rqstp: RPC transaction context
1719  *
1720  * Returns the maximum number of payload bytes the current transport
1721  * allows.
1722  */
1723 u32 svc_max_payload(const struct svc_rqst *rqstp)
1724 {
1725 	u32 max = rqstp->rq_xprt->xpt_class->xcl_max_payload;
1726 
1727 	if (rqstp->rq_server->sv_max_payload < max)
1728 		max = rqstp->rq_server->sv_max_payload;
1729 	return max;
1730 }
1731 EXPORT_SYMBOL_GPL(svc_max_payload);
1732 
1733 /**
1734  * svc_proc_name - Return RPC procedure name in string form
1735  * @rqstp: svc_rqst to operate on
1736  *
1737  * Return value:
1738  *   Pointer to a NUL-terminated string
1739  */
1740 const char *svc_proc_name(const struct svc_rqst *rqstp)
1741 {
1742 	if (rqstp && rqstp->rq_procinfo)
1743 		return rqstp->rq_procinfo->pc_name;
1744 	return "unknown";
1745 }
1746 
1747 
1748 /**
1749  * svc_encode_result_payload - mark a range of bytes as a result payload
1750  * @rqstp: svc_rqst to operate on
1751  * @offset: payload's byte offset in rqstp->rq_res
1752  * @length: size of payload, in bytes
1753  *
1754  * Returns zero on success, or a negative errno if a permanent
1755  * error occurred.
1756  */
1757 int svc_encode_result_payload(struct svc_rqst *rqstp, unsigned int offset,
1758 			      unsigned int length)
1759 {
1760 	return rqstp->rq_xprt->xpt_ops->xpo_result_payload(rqstp, offset,
1761 							   length);
1762 }
1763 EXPORT_SYMBOL_GPL(svc_encode_result_payload);
1764 
1765 /**
1766  * svc_fill_symlink_pathname - Construct pathname argument for VFS symlink call
1767  * @rqstp: svc_rqst to operate on
1768  * @first: buffer containing first section of pathname
1769  * @p: buffer containing remaining section of pathname
1770  * @total: total length of the pathname argument
1771  *
1772  * The VFS symlink API demands a NUL-terminated pathname in mapped memory.
1773  * Returns pointer to a NUL-terminated string, or an ERR_PTR. Caller must free
1774  * the returned string.
1775  */
1776 char *svc_fill_symlink_pathname(struct svc_rqst *rqstp, struct kvec *first,
1777 				void *p, size_t total)
1778 {
1779 	size_t len, remaining;
1780 	char *result, *dst;
1781 
1782 	result = kmalloc(total + 1, GFP_KERNEL);
1783 	if (!result)
1784 		return ERR_PTR(-ESERVERFAULT);
1785 
1786 	dst = result;
1787 	remaining = total;
1788 
1789 	len = min_t(size_t, total, first->iov_len);
1790 	if (len) {
1791 		memcpy(dst, first->iov_base, len);
1792 		dst += len;
1793 		remaining -= len;
1794 	}
1795 
1796 	if (remaining) {
1797 		len = min_t(size_t, remaining, PAGE_SIZE);
1798 		memcpy(dst, p, len);
1799 		dst += len;
1800 	}
1801 
1802 	*dst = '\0';
1803 
1804 	/* Sanity check: Linux doesn't allow the pathname argument to
1805 	 * contain a NUL byte.
1806 	 */
1807 	if (strlen(result) != total) {
1808 		kfree(result);
1809 		return ERR_PTR(-EINVAL);
1810 	}
1811 	return result;
1812 }
1813 EXPORT_SYMBOL_GPL(svc_fill_symlink_pathname);
1814