GNU Linux-libre 5.10.217-gnu1
[releases.git] / net / sunrpc / svc.c
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 #define RPCDBG_FACILITY RPCDBG_SVCDSP
35
36 static void svc_unregister(const struct svc_serv *serv, struct net *net);
37
38 #define svc_serv_is_pooled(serv)    ((serv)->sv_ops->svo_function)
39
40 #define SVC_POOL_DEFAULT        SVC_POOL_GLOBAL
41
42 /*
43  * Structure for mapping cpus to pools and vice versa.
44  * Setup once during sunrpc initialisation.
45  */
46 struct svc_pool_map svc_pool_map = {
47         .mode = SVC_POOL_DEFAULT
48 };
49 EXPORT_SYMBOL_GPL(svc_pool_map);
50
51 static DEFINE_MUTEX(svc_pool_map_mutex);/* protects svc_pool_map.count only */
52
53 static int
54 param_set_pool_mode(const char *val, const struct kernel_param *kp)
55 {
56         int *ip = (int *)kp->arg;
57         struct svc_pool_map *m = &svc_pool_map;
58         int err;
59
60         mutex_lock(&svc_pool_map_mutex);
61
62         err = -EBUSY;
63         if (m->count)
64                 goto out;
65
66         err = 0;
67         if (!strncmp(val, "auto", 4))
68                 *ip = SVC_POOL_AUTO;
69         else if (!strncmp(val, "global", 6))
70                 *ip = SVC_POOL_GLOBAL;
71         else if (!strncmp(val, "percpu", 6))
72                 *ip = SVC_POOL_PERCPU;
73         else if (!strncmp(val, "pernode", 7))
74                 *ip = SVC_POOL_PERNODE;
75         else
76                 err = -EINVAL;
77
78 out:
79         mutex_unlock(&svc_pool_map_mutex);
80         return err;
81 }
82
83 static int
84 param_get_pool_mode(char *buf, const struct kernel_param *kp)
85 {
86         int *ip = (int *)kp->arg;
87
88         switch (*ip)
89         {
90         case SVC_POOL_AUTO:
91                 return strlcpy(buf, "auto\n", 20);
92         case SVC_POOL_GLOBAL:
93                 return strlcpy(buf, "global\n", 20);
94         case SVC_POOL_PERCPU:
95                 return strlcpy(buf, "percpu\n", 20);
96         case SVC_POOL_PERNODE:
97                 return strlcpy(buf, "pernode\n", 20);
98         default:
99                 return sprintf(buf, "%d\n", *ip);
100         }
101 }
102
103 module_param_call(pool_mode, param_set_pool_mode, param_get_pool_mode,
104                  &svc_pool_map.mode, 0644);
105
106 /*
107  * Detect best pool mapping mode heuristically,
108  * according to the machine's topology.
109  */
110 static int
111 svc_pool_map_choose_mode(void)
112 {
113         unsigned int node;
114
115         if (nr_online_nodes > 1) {
116                 /*
117                  * Actually have multiple NUMA nodes,
118                  * so split pools on NUMA node boundaries
119                  */
120                 return SVC_POOL_PERNODE;
121         }
122
123         node = first_online_node;
124         if (nr_cpus_node(node) > 2) {
125                 /*
126                  * Non-trivial SMP, or CONFIG_NUMA on
127                  * non-NUMA hardware, e.g. with a generic
128                  * x86_64 kernel on Xeons.  In this case we
129                  * want to divide the pools on cpu boundaries.
130                  */
131                 return SVC_POOL_PERCPU;
132         }
133
134         /* default: one global pool */
135         return SVC_POOL_GLOBAL;
136 }
137
138 /*
139  * Allocate the to_pool[] and pool_to[] arrays.
140  * Returns 0 on success or an errno.
141  */
142 static int
143 svc_pool_map_alloc_arrays(struct svc_pool_map *m, unsigned int maxpools)
144 {
145         m->to_pool = kcalloc(maxpools, sizeof(unsigned int), GFP_KERNEL);
146         if (!m->to_pool)
147                 goto fail;
148         m->pool_to = kcalloc(maxpools, sizeof(unsigned int), GFP_KERNEL);
149         if (!m->pool_to)
150                 goto fail_free;
151
152         return 0;
153
154 fail_free:
155         kfree(m->to_pool);
156         m->to_pool = NULL;
157 fail:
158         return -ENOMEM;
159 }
160
161 /*
162  * Initialise the pool map for SVC_POOL_PERCPU mode.
163  * Returns number of pools or <0 on error.
164  */
165 static int
166 svc_pool_map_init_percpu(struct svc_pool_map *m)
167 {
168         unsigned int maxpools = nr_cpu_ids;
169         unsigned int pidx = 0;
170         unsigned int cpu;
171         int err;
172
173         err = svc_pool_map_alloc_arrays(m, maxpools);
174         if (err)
175                 return err;
176
177         for_each_online_cpu(cpu) {
178                 BUG_ON(pidx >= maxpools);
179                 m->to_pool[cpu] = pidx;
180                 m->pool_to[pidx] = cpu;
181                 pidx++;
182         }
183         /* cpus brought online later all get mapped to pool0, sorry */
184
185         return pidx;
186 };
187
188
189 /*
190  * Initialise the pool map for SVC_POOL_PERNODE mode.
191  * Returns number of pools or <0 on error.
192  */
193 static int
194 svc_pool_map_init_pernode(struct svc_pool_map *m)
195 {
196         unsigned int maxpools = nr_node_ids;
197         unsigned int pidx = 0;
198         unsigned int node;
199         int err;
200
201         err = svc_pool_map_alloc_arrays(m, maxpools);
202         if (err)
203                 return err;
204
205         for_each_node_with_cpus(node) {
206                 /* some architectures (e.g. SN2) have cpuless nodes */
207                 BUG_ON(pidx > maxpools);
208                 m->to_pool[node] = pidx;
209                 m->pool_to[pidx] = node;
210                 pidx++;
211         }
212         /* nodes brought online later all get mapped to pool0, sorry */
213
214         return pidx;
215 }
216
217
218 /*
219  * Add a reference to the global map of cpus to pools (and
220  * vice versa).  Initialise the map if we're the first user.
221  * Returns the number of pools.
222  */
223 unsigned int
224 svc_pool_map_get(void)
225 {
226         struct svc_pool_map *m = &svc_pool_map;
227         int npools = -1;
228
229         mutex_lock(&svc_pool_map_mutex);
230
231         if (m->count++) {
232                 mutex_unlock(&svc_pool_map_mutex);
233                 return m->npools;
234         }
235
236         if (m->mode == SVC_POOL_AUTO)
237                 m->mode = svc_pool_map_choose_mode();
238
239         switch (m->mode) {
240         case SVC_POOL_PERCPU:
241                 npools = svc_pool_map_init_percpu(m);
242                 break;
243         case SVC_POOL_PERNODE:
244                 npools = svc_pool_map_init_pernode(m);
245                 break;
246         }
247
248         if (npools < 0) {
249                 /* default, or memory allocation failure */
250                 npools = 1;
251                 m->mode = SVC_POOL_GLOBAL;
252         }
253         m->npools = npools;
254
255         mutex_unlock(&svc_pool_map_mutex);
256         return m->npools;
257 }
258 EXPORT_SYMBOL_GPL(svc_pool_map_get);
259
260 /*
261  * Drop a reference to the global map of cpus to pools.
262  * When the last reference is dropped, the map data is
263  * freed; this allows the sysadmin to change the pool
264  * mode using the pool_mode module option without
265  * rebooting or re-loading sunrpc.ko.
266  */
267 void
268 svc_pool_map_put(void)
269 {
270         struct svc_pool_map *m = &svc_pool_map;
271
272         mutex_lock(&svc_pool_map_mutex);
273
274         if (!--m->count) {
275                 kfree(m->to_pool);
276                 m->to_pool = NULL;
277                 kfree(m->pool_to);
278                 m->pool_to = NULL;
279                 m->npools = 0;
280         }
281
282         mutex_unlock(&svc_pool_map_mutex);
283 }
284 EXPORT_SYMBOL_GPL(svc_pool_map_put);
285
286 static int svc_pool_map_get_node(unsigned int pidx)
287 {
288         const struct svc_pool_map *m = &svc_pool_map;
289
290         if (m->count) {
291                 if (m->mode == SVC_POOL_PERCPU)
292                         return cpu_to_node(m->pool_to[pidx]);
293                 if (m->mode == SVC_POOL_PERNODE)
294                         return m->pool_to[pidx];
295         }
296         return NUMA_NO_NODE;
297 }
298 /*
299  * Set the given thread's cpus_allowed mask so that it
300  * will only run on cpus in the given pool.
301  */
302 static inline void
303 svc_pool_map_set_cpumask(struct task_struct *task, unsigned int pidx)
304 {
305         struct svc_pool_map *m = &svc_pool_map;
306         unsigned int node = m->pool_to[pidx];
307
308         /*
309          * The caller checks for sv_nrpools > 1, which
310          * implies that we've been initialized.
311          */
312         WARN_ON_ONCE(m->count == 0);
313         if (m->count == 0)
314                 return;
315
316         switch (m->mode) {
317         case SVC_POOL_PERCPU:
318         {
319                 set_cpus_allowed_ptr(task, cpumask_of(node));
320                 break;
321         }
322         case SVC_POOL_PERNODE:
323         {
324                 set_cpus_allowed_ptr(task, cpumask_of_node(node));
325                 break;
326         }
327         }
328 }
329
330 /*
331  * Use the mapping mode to choose a pool for a given CPU.
332  * Used when enqueueing an incoming RPC.  Always returns
333  * a non-NULL pool pointer.
334  */
335 struct svc_pool *
336 svc_pool_for_cpu(struct svc_serv *serv, int cpu)
337 {
338         struct svc_pool_map *m = &svc_pool_map;
339         unsigned int pidx = 0;
340
341         /*
342          * An uninitialised map happens in a pure client when
343          * lockd is brought up, so silently treat it the
344          * same as SVC_POOL_GLOBAL.
345          */
346         if (svc_serv_is_pooled(serv)) {
347                 switch (m->mode) {
348                 case SVC_POOL_PERCPU:
349                         pidx = m->to_pool[cpu];
350                         break;
351                 case SVC_POOL_PERNODE:
352                         pidx = m->to_pool[cpu_to_node(cpu)];
353                         break;
354                 }
355         }
356         return &serv->sv_pools[pidx % serv->sv_nrpools];
357 }
358
359 int svc_rpcb_setup(struct svc_serv *serv, struct net *net)
360 {
361         int err;
362
363         err = rpcb_create_local(net);
364         if (err)
365                 return err;
366
367         /* Remove any stale portmap registrations */
368         svc_unregister(serv, net);
369         return 0;
370 }
371 EXPORT_SYMBOL_GPL(svc_rpcb_setup);
372
373 void svc_rpcb_cleanup(struct svc_serv *serv, struct net *net)
374 {
375         svc_unregister(serv, net);
376         rpcb_put_local(net);
377 }
378 EXPORT_SYMBOL_GPL(svc_rpcb_cleanup);
379
380 static int svc_uses_rpcbind(struct svc_serv *serv)
381 {
382         struct svc_program      *progp;
383         unsigned int            i;
384
385         for (progp = serv->sv_program; progp; progp = progp->pg_next) {
386                 for (i = 0; i < progp->pg_nvers; i++) {
387                         if (progp->pg_vers[i] == NULL)
388                                 continue;
389                         if (!progp->pg_vers[i]->vs_hidden)
390                                 return 1;
391                 }
392         }
393
394         return 0;
395 }
396
397 int svc_bind(struct svc_serv *serv, struct net *net)
398 {
399         if (!svc_uses_rpcbind(serv))
400                 return 0;
401         return svc_rpcb_setup(serv, net);
402 }
403 EXPORT_SYMBOL_GPL(svc_bind);
404
405 #if defined(CONFIG_SUNRPC_BACKCHANNEL)
406 static void
407 __svc_init_bc(struct svc_serv *serv)
408 {
409         INIT_LIST_HEAD(&serv->sv_cb_list);
410         spin_lock_init(&serv->sv_cb_lock);
411         init_waitqueue_head(&serv->sv_cb_waitq);
412 }
413 #else
414 static void
415 __svc_init_bc(struct svc_serv *serv)
416 {
417 }
418 #endif
419
420 /*
421  * Create an RPC service
422  */
423 static struct svc_serv *
424 __svc_create(struct svc_program *prog, unsigned int bufsize, int npools,
425              const struct svc_serv_ops *ops)
426 {
427         struct svc_serv *serv;
428         unsigned int vers;
429         unsigned int xdrsize;
430         unsigned int i;
431
432         if (!(serv = kzalloc(sizeof(*serv), GFP_KERNEL)))
433                 return NULL;
434         serv->sv_name      = prog->pg_name;
435         serv->sv_program   = prog;
436         serv->sv_nrthreads = 1;
437         serv->sv_stats     = prog->pg_stats;
438         if (bufsize > RPCSVC_MAXPAYLOAD)
439                 bufsize = RPCSVC_MAXPAYLOAD;
440         serv->sv_max_payload = bufsize? bufsize : 4096;
441         serv->sv_max_mesg  = roundup(serv->sv_max_payload + PAGE_SIZE, PAGE_SIZE);
442         serv->sv_ops = ops;
443         xdrsize = 0;
444         while (prog) {
445                 prog->pg_lovers = prog->pg_nvers-1;
446                 for (vers=0; vers<prog->pg_nvers ; vers++)
447                         if (prog->pg_vers[vers]) {
448                                 prog->pg_hivers = vers;
449                                 if (prog->pg_lovers > vers)
450                                         prog->pg_lovers = vers;
451                                 if (prog->pg_vers[vers]->vs_xdrsize > xdrsize)
452                                         xdrsize = prog->pg_vers[vers]->vs_xdrsize;
453                         }
454                 prog = prog->pg_next;
455         }
456         serv->sv_xdrsize   = xdrsize;
457         INIT_LIST_HEAD(&serv->sv_tempsocks);
458         INIT_LIST_HEAD(&serv->sv_permsocks);
459         timer_setup(&serv->sv_temptimer, NULL, 0);
460         spin_lock_init(&serv->sv_lock);
461
462         __svc_init_bc(serv);
463
464         serv->sv_nrpools = npools;
465         serv->sv_pools =
466                 kcalloc(serv->sv_nrpools, sizeof(struct svc_pool),
467                         GFP_KERNEL);
468         if (!serv->sv_pools) {
469                 kfree(serv);
470                 return NULL;
471         }
472
473         for (i = 0; i < serv->sv_nrpools; i++) {
474                 struct svc_pool *pool = &serv->sv_pools[i];
475
476                 dprintk("svc: initialising pool %u for %s\n",
477                                 i, serv->sv_name);
478
479                 pool->sp_id = i;
480                 INIT_LIST_HEAD(&pool->sp_sockets);
481                 INIT_LIST_HEAD(&pool->sp_all_threads);
482                 spin_lock_init(&pool->sp_lock);
483         }
484
485         return serv;
486 }
487
488 struct svc_serv *
489 svc_create(struct svc_program *prog, unsigned int bufsize,
490            const struct svc_serv_ops *ops)
491 {
492         return __svc_create(prog, bufsize, /*npools*/1, ops);
493 }
494 EXPORT_SYMBOL_GPL(svc_create);
495
496 struct svc_serv *
497 svc_create_pooled(struct svc_program *prog, unsigned int bufsize,
498                   const struct svc_serv_ops *ops)
499 {
500         struct svc_serv *serv;
501         unsigned int npools = svc_pool_map_get();
502
503         serv = __svc_create(prog, bufsize, npools, ops);
504         if (!serv)
505                 goto out_err;
506         return serv;
507 out_err:
508         svc_pool_map_put();
509         return NULL;
510 }
511 EXPORT_SYMBOL_GPL(svc_create_pooled);
512
513 void svc_shutdown_net(struct svc_serv *serv, struct net *net)
514 {
515         svc_close_net(serv, net);
516
517         if (serv->sv_ops->svo_shutdown)
518                 serv->sv_ops->svo_shutdown(serv, net);
519 }
520 EXPORT_SYMBOL_GPL(svc_shutdown_net);
521
522 /*
523  * Destroy an RPC service. Should be called with appropriate locking to
524  * protect the sv_nrthreads, sv_permsocks and sv_tempsocks.
525  */
526 void
527 svc_destroy(struct svc_serv *serv)
528 {
529         dprintk("svc: svc_destroy(%s, %d)\n",
530                                 serv->sv_program->pg_name,
531                                 serv->sv_nrthreads);
532
533         if (serv->sv_nrthreads) {
534                 if (--(serv->sv_nrthreads) != 0) {
535                         svc_sock_update_bufs(serv);
536                         return;
537                 }
538         } else
539                 printk("svc_destroy: no threads for serv=%p!\n", serv);
540
541         del_timer_sync(&serv->sv_temptimer);
542
543         /*
544          * The last user is gone and thus all sockets have to be destroyed to
545          * the point. Check this.
546          */
547         BUG_ON(!list_empty(&serv->sv_permsocks));
548         BUG_ON(!list_empty(&serv->sv_tempsocks));
549
550         cache_clean_deferred(serv);
551
552         if (svc_serv_is_pooled(serv))
553                 svc_pool_map_put();
554
555         kfree(serv->sv_pools);
556         kfree(serv);
557 }
558 EXPORT_SYMBOL_GPL(svc_destroy);
559
560 /*
561  * Allocate an RPC server's buffer space.
562  * We allocate pages and place them in rq_argpages.
563  */
564 static int
565 svc_init_buffer(struct svc_rqst *rqstp, unsigned int size, int node)
566 {
567         unsigned int pages, arghi;
568
569         /* bc_xprt uses fore channel allocated buffers */
570         if (svc_is_backchannel(rqstp))
571                 return 1;
572
573         pages = size / PAGE_SIZE + 1; /* extra page as we hold both request and reply.
574                                        * We assume one is at most one page
575                                        */
576         arghi = 0;
577         WARN_ON_ONCE(pages > RPCSVC_MAXPAGES);
578         if (pages > RPCSVC_MAXPAGES)
579                 pages = RPCSVC_MAXPAGES;
580         while (pages) {
581                 struct page *p = alloc_pages_node(node, GFP_KERNEL, 0);
582                 if (!p)
583                         break;
584                 rqstp->rq_pages[arghi++] = p;
585                 pages--;
586         }
587         return pages == 0;
588 }
589
590 /*
591  * Release an RPC server buffer
592  */
593 static void
594 svc_release_buffer(struct svc_rqst *rqstp)
595 {
596         unsigned int i;
597
598         for (i = 0; i < ARRAY_SIZE(rqstp->rq_pages); i++)
599                 if (rqstp->rq_pages[i])
600                         put_page(rqstp->rq_pages[i]);
601 }
602
603 struct svc_rqst *
604 svc_rqst_alloc(struct svc_serv *serv, struct svc_pool *pool, int node)
605 {
606         struct svc_rqst *rqstp;
607
608         rqstp = kzalloc_node(sizeof(*rqstp), GFP_KERNEL, node);
609         if (!rqstp)
610                 return rqstp;
611
612         __set_bit(RQ_BUSY, &rqstp->rq_flags);
613         spin_lock_init(&rqstp->rq_lock);
614         rqstp->rq_server = serv;
615         rqstp->rq_pool = pool;
616
617         rqstp->rq_argp = kmalloc_node(serv->sv_xdrsize, GFP_KERNEL, node);
618         if (!rqstp->rq_argp)
619                 goto out_enomem;
620
621         rqstp->rq_resp = kmalloc_node(serv->sv_xdrsize, GFP_KERNEL, node);
622         if (!rqstp->rq_resp)
623                 goto out_enomem;
624
625         if (!svc_init_buffer(rqstp, serv->sv_max_mesg, node))
626                 goto out_enomem;
627
628         return rqstp;
629 out_enomem:
630         svc_rqst_free(rqstp);
631         return NULL;
632 }
633 EXPORT_SYMBOL_GPL(svc_rqst_alloc);
634
635 struct svc_rqst *
636 svc_prepare_thread(struct svc_serv *serv, struct svc_pool *pool, int node)
637 {
638         struct svc_rqst *rqstp;
639
640         rqstp = svc_rqst_alloc(serv, pool, node);
641         if (!rqstp)
642                 return ERR_PTR(-ENOMEM);
643
644         serv->sv_nrthreads++;
645         spin_lock_bh(&pool->sp_lock);
646         pool->sp_nrthreads++;
647         list_add_rcu(&rqstp->rq_all, &pool->sp_all_threads);
648         spin_unlock_bh(&pool->sp_lock);
649         return rqstp;
650 }
651 EXPORT_SYMBOL_GPL(svc_prepare_thread);
652
653 /*
654  * Choose a pool in which to create a new thread, for svc_set_num_threads
655  */
656 static inline struct svc_pool *
657 choose_pool(struct svc_serv *serv, struct svc_pool *pool, unsigned int *state)
658 {
659         if (pool != NULL)
660                 return pool;
661
662         return &serv->sv_pools[(*state)++ % serv->sv_nrpools];
663 }
664
665 /*
666  * Choose a thread to kill, for svc_set_num_threads
667  */
668 static inline struct task_struct *
669 choose_victim(struct svc_serv *serv, struct svc_pool *pool, unsigned int *state)
670 {
671         unsigned int i;
672         struct task_struct *task = NULL;
673
674         if (pool != NULL) {
675                 spin_lock_bh(&pool->sp_lock);
676         } else {
677                 /* choose a pool in round-robin fashion */
678                 for (i = 0; i < serv->sv_nrpools; i++) {
679                         pool = &serv->sv_pools[--(*state) % serv->sv_nrpools];
680                         spin_lock_bh(&pool->sp_lock);
681                         if (!list_empty(&pool->sp_all_threads))
682                                 goto found_pool;
683                         spin_unlock_bh(&pool->sp_lock);
684                 }
685                 return NULL;
686         }
687
688 found_pool:
689         if (!list_empty(&pool->sp_all_threads)) {
690                 struct svc_rqst *rqstp;
691
692                 /*
693                  * Remove from the pool->sp_all_threads list
694                  * so we don't try to kill it again.
695                  */
696                 rqstp = list_entry(pool->sp_all_threads.next, struct svc_rqst, rq_all);
697                 set_bit(RQ_VICTIM, &rqstp->rq_flags);
698                 list_del_rcu(&rqstp->rq_all);
699                 task = rqstp->rq_task;
700         }
701         spin_unlock_bh(&pool->sp_lock);
702
703         return task;
704 }
705
706 /* create new threads */
707 static int
708 svc_start_kthreads(struct svc_serv *serv, struct svc_pool *pool, int nrservs)
709 {
710         struct svc_rqst *rqstp;
711         struct task_struct *task;
712         struct svc_pool *chosen_pool;
713         unsigned int state = serv->sv_nrthreads-1;
714         int node;
715
716         do {
717                 nrservs--;
718                 chosen_pool = choose_pool(serv, pool, &state);
719
720                 node = svc_pool_map_get_node(chosen_pool->sp_id);
721                 rqstp = svc_prepare_thread(serv, chosen_pool, node);
722                 if (IS_ERR(rqstp))
723                         return PTR_ERR(rqstp);
724
725                 __module_get(serv->sv_ops->svo_module);
726                 task = kthread_create_on_node(serv->sv_ops->svo_function, rqstp,
727                                               node, "%s", serv->sv_name);
728                 if (IS_ERR(task)) {
729                         module_put(serv->sv_ops->svo_module);
730                         svc_exit_thread(rqstp);
731                         return PTR_ERR(task);
732                 }
733
734                 rqstp->rq_task = task;
735                 if (serv->sv_nrpools > 1)
736                         svc_pool_map_set_cpumask(task, chosen_pool->sp_id);
737
738                 svc_sock_update_bufs(serv);
739                 wake_up_process(task);
740         } while (nrservs > 0);
741
742         return 0;
743 }
744
745
746 /* destroy old threads */
747 static int
748 svc_signal_kthreads(struct svc_serv *serv, struct svc_pool *pool, int nrservs)
749 {
750         struct task_struct *task;
751         unsigned int state = serv->sv_nrthreads-1;
752
753         /* destroy old threads */
754         do {
755                 task = choose_victim(serv, pool, &state);
756                 if (task == NULL)
757                         break;
758                 send_sig(SIGINT, task, 1);
759                 nrservs++;
760         } while (nrservs < 0);
761
762         return 0;
763 }
764
765 /*
766  * Create or destroy enough new threads to make the number
767  * of threads the given number.  If `pool' is non-NULL, applies
768  * only to threads in that pool, otherwise round-robins between
769  * all pools.  Caller must ensure that mutual exclusion between this and
770  * server startup or shutdown.
771  *
772  * Destroying threads relies on the service threads filling in
773  * rqstp->rq_task, which only the nfs ones do.  Assumes the serv
774  * has been created using svc_create_pooled().
775  *
776  * Based on code that used to be in nfsd_svc() but tweaked
777  * to be pool-aware.
778  */
779 int
780 svc_set_num_threads(struct svc_serv *serv, struct svc_pool *pool, int nrservs)
781 {
782         if (pool == NULL) {
783                 /* The -1 assumes caller has done a svc_get() */
784                 nrservs -= (serv->sv_nrthreads-1);
785         } else {
786                 spin_lock_bh(&pool->sp_lock);
787                 nrservs -= pool->sp_nrthreads;
788                 spin_unlock_bh(&pool->sp_lock);
789         }
790
791         if (nrservs > 0)
792                 return svc_start_kthreads(serv, pool, nrservs);
793         if (nrservs < 0)
794                 return svc_signal_kthreads(serv, pool, nrservs);
795         return 0;
796 }
797 EXPORT_SYMBOL_GPL(svc_set_num_threads);
798
799 /* destroy old threads */
800 static int
801 svc_stop_kthreads(struct svc_serv *serv, struct svc_pool *pool, int nrservs)
802 {
803         struct svc_rqst *rqstp;
804         struct task_struct *task;
805         unsigned int state = serv->sv_nrthreads-1;
806
807         /* destroy old threads */
808         do {
809                 task = choose_victim(serv, pool, &state);
810                 if (task == NULL)
811                         break;
812                 rqstp = kthread_data(task);
813                 /* Did we lose a race to svo_function threadfn? */
814                 if (kthread_stop(task) == -EINTR)
815                         svc_exit_thread(rqstp);
816                 nrservs++;
817         } while (nrservs < 0);
818         return 0;
819 }
820
821 int
822 svc_set_num_threads_sync(struct svc_serv *serv, struct svc_pool *pool, int nrservs)
823 {
824         if (pool == NULL) {
825                 /* The -1 assumes caller has done a svc_get() */
826                 nrservs -= (serv->sv_nrthreads-1);
827         } else {
828                 spin_lock_bh(&pool->sp_lock);
829                 nrservs -= pool->sp_nrthreads;
830                 spin_unlock_bh(&pool->sp_lock);
831         }
832
833         if (nrservs > 0)
834                 return svc_start_kthreads(serv, pool, nrservs);
835         if (nrservs < 0)
836                 return svc_stop_kthreads(serv, pool, nrservs);
837         return 0;
838 }
839 EXPORT_SYMBOL_GPL(svc_set_num_threads_sync);
840
841 /*
842  * Called from a server thread as it's exiting. Caller must hold the "service
843  * mutex" for the service.
844  */
845 void
846 svc_rqst_free(struct svc_rqst *rqstp)
847 {
848         svc_release_buffer(rqstp);
849         kfree(rqstp->rq_resp);
850         kfree(rqstp->rq_argp);
851         kfree(rqstp->rq_auth_data);
852         kfree_rcu(rqstp, rq_rcu_head);
853 }
854 EXPORT_SYMBOL_GPL(svc_rqst_free);
855
856 void
857 svc_exit_thread(struct svc_rqst *rqstp)
858 {
859         struct svc_serv *serv = rqstp->rq_server;
860         struct svc_pool *pool = rqstp->rq_pool;
861
862         spin_lock_bh(&pool->sp_lock);
863         pool->sp_nrthreads--;
864         if (!test_and_set_bit(RQ_VICTIM, &rqstp->rq_flags))
865                 list_del_rcu(&rqstp->rq_all);
866         spin_unlock_bh(&pool->sp_lock);
867
868         svc_rqst_free(rqstp);
869
870         /* Release the server */
871         if (serv)
872                 svc_destroy(serv);
873 }
874 EXPORT_SYMBOL_GPL(svc_exit_thread);
875
876 /*
877  * Register an "inet" protocol family netid with the local
878  * rpcbind daemon via an rpcbind v4 SET request.
879  *
880  * No netconfig infrastructure is available in the kernel, so
881  * we map IP_ protocol numbers to netids by hand.
882  *
883  * Returns zero on success; a negative errno value is returned
884  * if any error occurs.
885  */
886 static int __svc_rpcb_register4(struct net *net, const u32 program,
887                                 const u32 version,
888                                 const unsigned short protocol,
889                                 const unsigned short port)
890 {
891         const struct sockaddr_in sin = {
892                 .sin_family             = AF_INET,
893                 .sin_addr.s_addr        = htonl(INADDR_ANY),
894                 .sin_port               = htons(port),
895         };
896         const char *netid;
897         int error;
898
899         switch (protocol) {
900         case IPPROTO_UDP:
901                 netid = RPCBIND_NETID_UDP;
902                 break;
903         case IPPROTO_TCP:
904                 netid = RPCBIND_NETID_TCP;
905                 break;
906         default:
907                 return -ENOPROTOOPT;
908         }
909
910         error = rpcb_v4_register(net, program, version,
911                                         (const struct sockaddr *)&sin, netid);
912
913         /*
914          * User space didn't support rpcbind v4, so retry this
915          * registration request with the legacy rpcbind v2 protocol.
916          */
917         if (error == -EPROTONOSUPPORT)
918                 error = rpcb_register(net, program, version, protocol, port);
919
920         return error;
921 }
922
923 #if IS_ENABLED(CONFIG_IPV6)
924 /*
925  * Register an "inet6" protocol family netid with the local
926  * rpcbind daemon via an rpcbind v4 SET request.
927  *
928  * No netconfig infrastructure is available in the kernel, so
929  * we map IP_ protocol numbers to netids by hand.
930  *
931  * Returns zero on success; a negative errno value is returned
932  * if any error occurs.
933  */
934 static int __svc_rpcb_register6(struct net *net, const u32 program,
935                                 const u32 version,
936                                 const unsigned short protocol,
937                                 const unsigned short port)
938 {
939         const struct sockaddr_in6 sin6 = {
940                 .sin6_family            = AF_INET6,
941                 .sin6_addr              = IN6ADDR_ANY_INIT,
942                 .sin6_port              = htons(port),
943         };
944         const char *netid;
945         int error;
946
947         switch (protocol) {
948         case IPPROTO_UDP:
949                 netid = RPCBIND_NETID_UDP6;
950                 break;
951         case IPPROTO_TCP:
952                 netid = RPCBIND_NETID_TCP6;
953                 break;
954         default:
955                 return -ENOPROTOOPT;
956         }
957
958         error = rpcb_v4_register(net, program, version,
959                                         (const struct sockaddr *)&sin6, netid);
960
961         /*
962          * User space didn't support rpcbind version 4, so we won't
963          * use a PF_INET6 listener.
964          */
965         if (error == -EPROTONOSUPPORT)
966                 error = -EAFNOSUPPORT;
967
968         return error;
969 }
970 #endif  /* IS_ENABLED(CONFIG_IPV6) */
971
972 /*
973  * Register a kernel RPC service via rpcbind version 4.
974  *
975  * Returns zero on success; a negative errno value is returned
976  * if any error occurs.
977  */
978 static int __svc_register(struct net *net, const char *progname,
979                           const u32 program, const u32 version,
980                           const int family,
981                           const unsigned short protocol,
982                           const unsigned short port)
983 {
984         int error = -EAFNOSUPPORT;
985
986         switch (family) {
987         case PF_INET:
988                 error = __svc_rpcb_register4(net, program, version,
989                                                 protocol, port);
990                 break;
991 #if IS_ENABLED(CONFIG_IPV6)
992         case PF_INET6:
993                 error = __svc_rpcb_register6(net, program, version,
994                                                 protocol, port);
995 #endif
996         }
997
998         trace_svc_register(progname, version, family, protocol, port, error);
999         return error;
1000 }
1001
1002 int svc_rpcbind_set_version(struct net *net,
1003                             const struct svc_program *progp,
1004                             u32 version, int family,
1005                             unsigned short proto,
1006                             unsigned short port)
1007 {
1008         return __svc_register(net, progp->pg_name, progp->pg_prog,
1009                                 version, family, proto, port);
1010
1011 }
1012 EXPORT_SYMBOL_GPL(svc_rpcbind_set_version);
1013
1014 int svc_generic_rpcbind_set(struct net *net,
1015                             const struct svc_program *progp,
1016                             u32 version, int family,
1017                             unsigned short proto,
1018                             unsigned short port)
1019 {
1020         const struct svc_version *vers = progp->pg_vers[version];
1021         int error;
1022
1023         if (vers == NULL)
1024                 return 0;
1025
1026         if (vers->vs_hidden) {
1027                 trace_svc_noregister(progp->pg_name, version, proto,
1028                                      port, family, 0);
1029                 return 0;
1030         }
1031
1032         /*
1033          * Don't register a UDP port if we need congestion
1034          * control.
1035          */
1036         if (vers->vs_need_cong_ctrl && proto == IPPROTO_UDP)
1037                 return 0;
1038
1039         error = svc_rpcbind_set_version(net, progp, version,
1040                                         family, proto, port);
1041
1042         return (vers->vs_rpcb_optnl) ? 0 : error;
1043 }
1044 EXPORT_SYMBOL_GPL(svc_generic_rpcbind_set);
1045
1046 /**
1047  * svc_register - register an RPC service with the local portmapper
1048  * @serv: svc_serv struct for the service to register
1049  * @net: net namespace for the service to register
1050  * @family: protocol family of service's listener socket
1051  * @proto: transport protocol number to advertise
1052  * @port: port to advertise
1053  *
1054  * Service is registered for any address in the passed-in protocol family
1055  */
1056 int svc_register(const struct svc_serv *serv, struct net *net,
1057                  const int family, const unsigned short proto,
1058                  const unsigned short port)
1059 {
1060         struct svc_program      *progp;
1061         unsigned int            i;
1062         int                     error = 0;
1063
1064         WARN_ON_ONCE(proto == 0 && port == 0);
1065         if (proto == 0 && port == 0)
1066                 return -EINVAL;
1067
1068         for (progp = serv->sv_program; progp; progp = progp->pg_next) {
1069                 for (i = 0; i < progp->pg_nvers; i++) {
1070
1071                         error = progp->pg_rpcbind_set(net, progp, i,
1072                                         family, proto, port);
1073                         if (error < 0) {
1074                                 printk(KERN_WARNING "svc: failed to register "
1075                                         "%sv%u RPC service (errno %d).\n",
1076                                         progp->pg_name, i, -error);
1077                                 break;
1078                         }
1079                 }
1080         }
1081
1082         return error;
1083 }
1084
1085 /*
1086  * If user space is running rpcbind, it should take the v4 UNSET
1087  * and clear everything for this [program, version].  If user space
1088  * is running portmap, it will reject the v4 UNSET, but won't have
1089  * any "inet6" entries anyway.  So a PMAP_UNSET should be sufficient
1090  * in this case to clear all existing entries for [program, version].
1091  */
1092 static void __svc_unregister(struct net *net, const u32 program, const u32 version,
1093                              const char *progname)
1094 {
1095         int error;
1096
1097         error = rpcb_v4_register(net, program, version, NULL, "");
1098
1099         /*
1100          * User space didn't support rpcbind v4, so retry this
1101          * request with the legacy rpcbind v2 protocol.
1102          */
1103         if (error == -EPROTONOSUPPORT)
1104                 error = rpcb_register(net, program, version, 0, 0);
1105
1106         trace_svc_unregister(progname, version, error);
1107 }
1108
1109 /*
1110  * All netids, bind addresses and ports registered for [program, version]
1111  * are removed from the local rpcbind database (if the service is not
1112  * hidden) to make way for a new instance of the service.
1113  *
1114  * The result of unregistration is reported via dprintk for those who want
1115  * verification of the result, but is otherwise not important.
1116  */
1117 static void svc_unregister(const struct svc_serv *serv, struct net *net)
1118 {
1119         struct svc_program *progp;
1120         unsigned long flags;
1121         unsigned int i;
1122
1123         clear_thread_flag(TIF_SIGPENDING);
1124
1125         for (progp = serv->sv_program; progp; progp = progp->pg_next) {
1126                 for (i = 0; i < progp->pg_nvers; i++) {
1127                         if (progp->pg_vers[i] == NULL)
1128                                 continue;
1129                         if (progp->pg_vers[i]->vs_hidden)
1130                                 continue;
1131                         __svc_unregister(net, progp->pg_prog, i, progp->pg_name);
1132                 }
1133         }
1134
1135         spin_lock_irqsave(&current->sighand->siglock, flags);
1136         recalc_sigpending();
1137         spin_unlock_irqrestore(&current->sighand->siglock, flags);
1138 }
1139
1140 /*
1141  * dprintk the given error with the address of the client that caused it.
1142  */
1143 #if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
1144 static __printf(2, 3)
1145 void svc_printk(struct svc_rqst *rqstp, const char *fmt, ...)
1146 {
1147         struct va_format vaf;
1148         va_list args;
1149         char    buf[RPC_MAX_ADDRBUFLEN];
1150
1151         va_start(args, fmt);
1152
1153         vaf.fmt = fmt;
1154         vaf.va = &args;
1155
1156         dprintk("svc: %s: %pV", svc_print_addr(rqstp, buf, sizeof(buf)), &vaf);
1157
1158         va_end(args);
1159 }
1160 #else
1161 static __printf(2,3) void svc_printk(struct svc_rqst *rqstp, const char *fmt, ...) {}
1162 #endif
1163
1164 __be32
1165 svc_return_autherr(struct svc_rqst *rqstp, __be32 auth_err)
1166 {
1167         set_bit(RQ_AUTHERR, &rqstp->rq_flags);
1168         return auth_err;
1169 }
1170 EXPORT_SYMBOL_GPL(svc_return_autherr);
1171
1172 static __be32
1173 svc_get_autherr(struct svc_rqst *rqstp, __be32 *statp)
1174 {
1175         if (test_and_clear_bit(RQ_AUTHERR, &rqstp->rq_flags))
1176                 return *statp;
1177         return rpc_auth_ok;
1178 }
1179
1180 static int
1181 svc_generic_dispatch(struct svc_rqst *rqstp, __be32 *statp)
1182 {
1183         struct kvec *argv = &rqstp->rq_arg.head[0];
1184         struct kvec *resv = &rqstp->rq_res.head[0];
1185         const struct svc_procedure *procp = rqstp->rq_procinfo;
1186
1187         /*
1188          * Decode arguments
1189          * XXX: why do we ignore the return value?
1190          */
1191         if (procp->pc_decode &&
1192             !procp->pc_decode(rqstp, argv->iov_base)) {
1193                 *statp = rpc_garbage_args;
1194                 return 1;
1195         }
1196
1197         *statp = procp->pc_func(rqstp);
1198
1199         if (*statp == rpc_drop_reply ||
1200             test_bit(RQ_DROPME, &rqstp->rq_flags))
1201                 return 0;
1202
1203         if (test_bit(RQ_AUTHERR, &rqstp->rq_flags))
1204                 return 1;
1205
1206         if (*statp != rpc_success)
1207                 return 1;
1208
1209         /* Encode reply */
1210         if (procp->pc_encode &&
1211             !procp->pc_encode(rqstp, resv->iov_base + resv->iov_len)) {
1212                 dprintk("svc: failed to encode reply\n");
1213                 /* serv->sv_stats->rpcsystemerr++; */
1214                 *statp = rpc_system_err;
1215         }
1216         return 1;
1217 }
1218
1219 __be32
1220 svc_generic_init_request(struct svc_rqst *rqstp,
1221                 const struct svc_program *progp,
1222                 struct svc_process_info *ret)
1223 {
1224         const struct svc_version *versp = NULL; /* compiler food */
1225         const struct svc_procedure *procp = NULL;
1226
1227         if (rqstp->rq_vers >= progp->pg_nvers )
1228                 goto err_bad_vers;
1229         versp = progp->pg_vers[rqstp->rq_vers];
1230         if (!versp)
1231                 goto err_bad_vers;
1232
1233         /*
1234          * Some protocol versions (namely NFSv4) require some form of
1235          * congestion control.  (See RFC 7530 section 3.1 paragraph 2)
1236          * In other words, UDP is not allowed. We mark those when setting
1237          * up the svc_xprt, and verify that here.
1238          *
1239          * The spec is not very clear about what error should be returned
1240          * when someone tries to access a server that is listening on UDP
1241          * for lower versions. RPC_PROG_MISMATCH seems to be the closest
1242          * fit.
1243          */
1244         if (versp->vs_need_cong_ctrl && rqstp->rq_xprt &&
1245             !test_bit(XPT_CONG_CTRL, &rqstp->rq_xprt->xpt_flags))
1246                 goto err_bad_vers;
1247
1248         if (rqstp->rq_proc >= versp->vs_nproc)
1249                 goto err_bad_proc;
1250         rqstp->rq_procinfo = procp = &versp->vs_proc[rqstp->rq_proc];
1251         if (!procp)
1252                 goto err_bad_proc;
1253
1254         /* Initialize storage for argp and resp */
1255         memset(rqstp->rq_argp, 0, procp->pc_argsize);
1256         memset(rqstp->rq_resp, 0, procp->pc_ressize);
1257
1258         /* Bump per-procedure stats counter */
1259         versp->vs_count[rqstp->rq_proc]++;
1260
1261         ret->dispatch = versp->vs_dispatch;
1262         return rpc_success;
1263 err_bad_vers:
1264         ret->mismatch.lovers = progp->pg_lovers;
1265         ret->mismatch.hivers = progp->pg_hivers;
1266         return rpc_prog_mismatch;
1267 err_bad_proc:
1268         return rpc_proc_unavail;
1269 }
1270 EXPORT_SYMBOL_GPL(svc_generic_init_request);
1271
1272 /*
1273  * Common routine for processing the RPC request.
1274  */
1275 static int
1276 svc_process_common(struct svc_rqst *rqstp, struct kvec *argv, struct kvec *resv)
1277 {
1278         struct svc_program      *progp;
1279         const struct svc_procedure *procp = NULL;
1280         struct svc_serv         *serv = rqstp->rq_server;
1281         struct svc_process_info process;
1282         __be32                  *statp;
1283         u32                     prog, vers;
1284         __be32                  auth_stat, rpc_stat;
1285         int                     auth_res;
1286         __be32                  *reply_statp;
1287
1288         rpc_stat = rpc_success;
1289
1290         if (argv->iov_len < 6*4)
1291                 goto err_short_len;
1292
1293         /* Will be turned off by GSS integrity and privacy services */
1294         set_bit(RQ_SPLICE_OK, &rqstp->rq_flags);
1295         /* Will be turned off only when NFSv4 Sessions are used */
1296         set_bit(RQ_USEDEFERRAL, &rqstp->rq_flags);
1297         clear_bit(RQ_DROPME, &rqstp->rq_flags);
1298
1299         svc_putu32(resv, rqstp->rq_xid);
1300
1301         vers = svc_getnl(argv);
1302
1303         /* First words of reply: */
1304         svc_putnl(resv, 1);             /* REPLY */
1305
1306         if (vers != 2)          /* RPC version number */
1307                 goto err_bad_rpc;
1308
1309         /* Save position in case we later decide to reject: */
1310         reply_statp = resv->iov_base + resv->iov_len;
1311
1312         svc_putnl(resv, 0);             /* ACCEPT */
1313
1314         rqstp->rq_prog = prog = svc_getnl(argv);        /* program number */
1315         rqstp->rq_vers = svc_getnl(argv);       /* version number */
1316         rqstp->rq_proc = svc_getnl(argv);       /* procedure number */
1317
1318         for (progp = serv->sv_program; progp; progp = progp->pg_next)
1319                 if (prog == progp->pg_prog)
1320                         break;
1321
1322         /*
1323          * Decode auth data, and add verifier to reply buffer.
1324          * We do this before anything else in order to get a decent
1325          * auth verifier.
1326          */
1327         auth_res = svc_authenticate(rqstp, &auth_stat);
1328         /* Also give the program a chance to reject this call: */
1329         if (auth_res == SVC_OK && progp) {
1330                 auth_stat = rpc_autherr_badcred;
1331                 auth_res = progp->pg_authenticate(rqstp);
1332         }
1333         if (auth_res != SVC_OK)
1334                 trace_svc_authenticate(rqstp, auth_res, auth_stat);
1335         switch (auth_res) {
1336         case SVC_OK:
1337                 break;
1338         case SVC_GARBAGE:
1339                 goto err_garbage;
1340         case SVC_SYSERR:
1341                 rpc_stat = rpc_system_err;
1342                 goto err_bad;
1343         case SVC_DENIED:
1344                 goto err_bad_auth;
1345         case SVC_CLOSE:
1346                 goto close;
1347         case SVC_DROP:
1348                 goto dropit;
1349         case SVC_COMPLETE:
1350                 goto sendit;
1351         }
1352
1353         if (progp == NULL)
1354                 goto err_bad_prog;
1355
1356         rpc_stat = progp->pg_init_request(rqstp, progp, &process);
1357         switch (rpc_stat) {
1358         case rpc_success:
1359                 break;
1360         case rpc_prog_unavail:
1361                 goto err_bad_prog;
1362         case rpc_prog_mismatch:
1363                 goto err_bad_vers;
1364         case rpc_proc_unavail:
1365                 goto err_bad_proc;
1366         }
1367
1368         procp = rqstp->rq_procinfo;
1369         /* Should this check go into the dispatcher? */
1370         if (!procp || !procp->pc_func)
1371                 goto err_bad_proc;
1372
1373         /* Syntactic check complete */
1374         serv->sv_stats->rpccnt++;
1375         trace_svc_process(rqstp, progp->pg_name);
1376
1377         /* Build the reply header. */
1378         statp = resv->iov_base +resv->iov_len;
1379         svc_putnl(resv, RPC_SUCCESS);
1380
1381         /* un-reserve some of the out-queue now that we have a
1382          * better idea of reply size
1383          */
1384         if (procp->pc_xdrressize)
1385                 svc_reserve_auth(rqstp, procp->pc_xdrressize<<2);
1386
1387         /* Call the function that processes the request. */
1388         if (!process.dispatch) {
1389                 if (!svc_generic_dispatch(rqstp, statp))
1390                         goto release_dropit;
1391                 if (*statp == rpc_garbage_args)
1392                         goto err_garbage;
1393                 auth_stat = svc_get_autherr(rqstp, statp);
1394                 if (auth_stat != rpc_auth_ok)
1395                         goto err_release_bad_auth;
1396         } else {
1397                 dprintk("svc: calling dispatcher\n");
1398                 if (!process.dispatch(rqstp, statp))
1399                         goto release_dropit; /* Release reply info */
1400         }
1401
1402         /* Check RPC status result */
1403         if (*statp != rpc_success)
1404                 resv->iov_len = ((void*)statp)  - resv->iov_base + 4;
1405
1406         /* Release reply info */
1407         if (procp->pc_release)
1408                 procp->pc_release(rqstp);
1409
1410         if (procp->pc_encode == NULL)
1411                 goto dropit;
1412
1413  sendit:
1414         if (svc_authorise(rqstp))
1415                 goto close_xprt;
1416         return 1;               /* Caller can now send it */
1417
1418 release_dropit:
1419         if (procp->pc_release)
1420                 procp->pc_release(rqstp);
1421  dropit:
1422         svc_authorise(rqstp);   /* doesn't hurt to call this twice */
1423         dprintk("svc: svc_process dropit\n");
1424         return 0;
1425
1426  close:
1427         svc_authorise(rqstp);
1428 close_xprt:
1429         if (rqstp->rq_xprt && test_bit(XPT_TEMP, &rqstp->rq_xprt->xpt_flags))
1430                 svc_close_xprt(rqstp->rq_xprt);
1431         dprintk("svc: svc_process close\n");
1432         return 0;
1433
1434 err_short_len:
1435         svc_printk(rqstp, "short len %zd, dropping request\n",
1436                         argv->iov_len);
1437         goto close_xprt;
1438
1439 err_bad_rpc:
1440         serv->sv_stats->rpcbadfmt++;
1441         svc_putnl(resv, 1);     /* REJECT */
1442         svc_putnl(resv, 0);     /* RPC_MISMATCH */
1443         svc_putnl(resv, 2);     /* Only RPCv2 supported */
1444         svc_putnl(resv, 2);
1445         goto sendit;
1446
1447 err_release_bad_auth:
1448         if (procp->pc_release)
1449                 procp->pc_release(rqstp);
1450 err_bad_auth:
1451         dprintk("svc: authentication failed (%d)\n", ntohl(auth_stat));
1452         serv->sv_stats->rpcbadauth++;
1453         /* Restore write pointer to location of accept status: */
1454         xdr_ressize_check(rqstp, reply_statp);
1455         svc_putnl(resv, 1);     /* REJECT */
1456         svc_putnl(resv, 1);     /* AUTH_ERROR */
1457         svc_putnl(resv, ntohl(auth_stat));      /* status */
1458         goto sendit;
1459
1460 err_bad_prog:
1461         dprintk("svc: unknown program %d\n", prog);
1462         serv->sv_stats->rpcbadfmt++;
1463         svc_putnl(resv, RPC_PROG_UNAVAIL);
1464         goto sendit;
1465
1466 err_bad_vers:
1467         svc_printk(rqstp, "unknown version (%d for prog %d, %s)\n",
1468                        rqstp->rq_vers, rqstp->rq_prog, progp->pg_name);
1469
1470         serv->sv_stats->rpcbadfmt++;
1471         svc_putnl(resv, RPC_PROG_MISMATCH);
1472         svc_putnl(resv, process.mismatch.lovers);
1473         svc_putnl(resv, process.mismatch.hivers);
1474         goto sendit;
1475
1476 err_bad_proc:
1477         svc_printk(rqstp, "unknown procedure (%d)\n", rqstp->rq_proc);
1478
1479         serv->sv_stats->rpcbadfmt++;
1480         svc_putnl(resv, RPC_PROC_UNAVAIL);
1481         goto sendit;
1482
1483 err_garbage:
1484         svc_printk(rqstp, "failed to decode args\n");
1485
1486         rpc_stat = rpc_garbage_args;
1487 err_bad:
1488         serv->sv_stats->rpcbadfmt++;
1489         svc_putnl(resv, ntohl(rpc_stat));
1490         goto sendit;
1491 }
1492
1493 /*
1494  * Process the RPC request.
1495  */
1496 int
1497 svc_process(struct svc_rqst *rqstp)
1498 {
1499         struct kvec             *argv = &rqstp->rq_arg.head[0];
1500         struct kvec             *resv = &rqstp->rq_res.head[0];
1501         struct svc_serv         *serv = rqstp->rq_server;
1502         u32                     dir;
1503
1504         /*
1505          * Setup response xdr_buf.
1506          * Initially it has just one page
1507          */
1508         rqstp->rq_next_page = &rqstp->rq_respages[1];
1509         resv->iov_base = page_address(rqstp->rq_respages[0]);
1510         resv->iov_len = 0;
1511         rqstp->rq_res.pages = rqstp->rq_respages + 1;
1512         rqstp->rq_res.len = 0;
1513         rqstp->rq_res.page_base = 0;
1514         rqstp->rq_res.page_len = 0;
1515         rqstp->rq_res.buflen = PAGE_SIZE;
1516         rqstp->rq_res.tail[0].iov_base = NULL;
1517         rqstp->rq_res.tail[0].iov_len = 0;
1518
1519         dir  = svc_getnl(argv);
1520         if (dir != 0) {
1521                 /* direction != CALL */
1522                 svc_printk(rqstp, "bad direction %d, dropping request\n", dir);
1523                 serv->sv_stats->rpcbadfmt++;
1524                 goto out_drop;
1525         }
1526
1527         /* Returns 1 for send, 0 for drop */
1528         if (likely(svc_process_common(rqstp, argv, resv)))
1529                 return svc_send(rqstp);
1530
1531 out_drop:
1532         svc_drop(rqstp);
1533         return 0;
1534 }
1535 EXPORT_SYMBOL_GPL(svc_process);
1536
1537 #if defined(CONFIG_SUNRPC_BACKCHANNEL)
1538 /*
1539  * Process a backchannel RPC request that arrived over an existing
1540  * outbound connection
1541  */
1542 int
1543 bc_svc_process(struct svc_serv *serv, struct rpc_rqst *req,
1544                struct svc_rqst *rqstp)
1545 {
1546         struct kvec     *argv = &rqstp->rq_arg.head[0];
1547         struct kvec     *resv = &rqstp->rq_res.head[0];
1548         struct rpc_task *task;
1549         int proc_error;
1550         int error;
1551
1552         dprintk("svc: %s(%p)\n", __func__, req);
1553
1554         /* Build the svc_rqst used by the common processing routine */
1555         rqstp->rq_xid = req->rq_xid;
1556         rqstp->rq_prot = req->rq_xprt->prot;
1557         rqstp->rq_server = serv;
1558         rqstp->rq_bc_net = req->rq_xprt->xprt_net;
1559
1560         rqstp->rq_addrlen = sizeof(req->rq_xprt->addr);
1561         memcpy(&rqstp->rq_addr, &req->rq_xprt->addr, rqstp->rq_addrlen);
1562         memcpy(&rqstp->rq_arg, &req->rq_rcv_buf, sizeof(rqstp->rq_arg));
1563         memcpy(&rqstp->rq_res, &req->rq_snd_buf, sizeof(rqstp->rq_res));
1564
1565         /* Adjust the argument buffer length */
1566         rqstp->rq_arg.len = req->rq_private_buf.len;
1567         if (rqstp->rq_arg.len <= rqstp->rq_arg.head[0].iov_len) {
1568                 rqstp->rq_arg.head[0].iov_len = rqstp->rq_arg.len;
1569                 rqstp->rq_arg.page_len = 0;
1570         } else if (rqstp->rq_arg.len <= rqstp->rq_arg.head[0].iov_len +
1571                         rqstp->rq_arg.page_len)
1572                 rqstp->rq_arg.page_len = rqstp->rq_arg.len -
1573                         rqstp->rq_arg.head[0].iov_len;
1574         else
1575                 rqstp->rq_arg.len = rqstp->rq_arg.head[0].iov_len +
1576                         rqstp->rq_arg.page_len;
1577
1578         /* reset result send buffer "put" position */
1579         resv->iov_len = 0;
1580
1581         /*
1582          * Skip the next two words because they've already been
1583          * processed in the transport
1584          */
1585         svc_getu32(argv);       /* XID */
1586         svc_getnl(argv);        /* CALLDIR */
1587
1588         /* Parse and execute the bc call */
1589         proc_error = svc_process_common(rqstp, argv, resv);
1590
1591         atomic_dec(&req->rq_xprt->bc_slot_count);
1592         if (!proc_error) {
1593                 /* Processing error: drop the request */
1594                 xprt_free_bc_request(req);
1595                 error = -EINVAL;
1596                 goto out;
1597         }
1598         /* Finally, send the reply synchronously */
1599         memcpy(&req->rq_snd_buf, &rqstp->rq_res, sizeof(req->rq_snd_buf));
1600         task = rpc_run_bc_task(req);
1601         if (IS_ERR(task)) {
1602                 error = PTR_ERR(task);
1603                 goto out;
1604         }
1605
1606         WARN_ON_ONCE(atomic_read(&task->tk_count) != 1);
1607         error = task->tk_status;
1608         rpc_put_task(task);
1609
1610 out:
1611         dprintk("svc: %s(), error=%d\n", __func__, error);
1612         return error;
1613 }
1614 EXPORT_SYMBOL_GPL(bc_svc_process);
1615 #endif /* CONFIG_SUNRPC_BACKCHANNEL */
1616
1617 /*
1618  * Return (transport-specific) limit on the rpc payload.
1619  */
1620 u32 svc_max_payload(const struct svc_rqst *rqstp)
1621 {
1622         u32 max = rqstp->rq_xprt->xpt_class->xcl_max_payload;
1623
1624         if (rqstp->rq_server->sv_max_payload < max)
1625                 max = rqstp->rq_server->sv_max_payload;
1626         return max;
1627 }
1628 EXPORT_SYMBOL_GPL(svc_max_payload);
1629
1630 /**
1631  * svc_encode_read_payload - mark a range of bytes as a READ payload
1632  * @rqstp: svc_rqst to operate on
1633  * @offset: payload's byte offset in rqstp->rq_res
1634  * @length: size of payload, in bytes
1635  *
1636  * Returns zero on success, or a negative errno if a permanent
1637  * error occurred.
1638  */
1639 int svc_encode_read_payload(struct svc_rqst *rqstp, unsigned int offset,
1640                             unsigned int length)
1641 {
1642         return rqstp->rq_xprt->xpt_ops->xpo_read_payload(rqstp, offset, length);
1643 }
1644 EXPORT_SYMBOL_GPL(svc_encode_read_payload);
1645
1646 /**
1647  * svc_fill_write_vector - Construct data argument for VFS write call
1648  * @rqstp: svc_rqst to operate on
1649  * @pages: list of pages containing data payload
1650  * @first: buffer containing first section of write payload
1651  * @total: total number of bytes of write payload
1652  *
1653  * Fills in rqstp::rq_vec, and returns the number of elements.
1654  */
1655 unsigned int svc_fill_write_vector(struct svc_rqst *rqstp, struct page **pages,
1656                                    struct kvec *first, size_t total)
1657 {
1658         struct kvec *vec = rqstp->rq_vec;
1659         unsigned int i;
1660
1661         /* Some types of transport can present the write payload
1662          * entirely in rq_arg.pages. In this case, @first is empty.
1663          */
1664         i = 0;
1665         if (first->iov_len) {
1666                 vec[i].iov_base = first->iov_base;
1667                 vec[i].iov_len = min_t(size_t, total, first->iov_len);
1668                 total -= vec[i].iov_len;
1669                 ++i;
1670         }
1671
1672         while (total) {
1673                 vec[i].iov_base = page_address(*pages);
1674                 vec[i].iov_len = min_t(size_t, total, PAGE_SIZE);
1675                 total -= vec[i].iov_len;
1676                 ++i;
1677                 ++pages;
1678         }
1679
1680         WARN_ON_ONCE(i > ARRAY_SIZE(rqstp->rq_vec));
1681         return i;
1682 }
1683 EXPORT_SYMBOL_GPL(svc_fill_write_vector);
1684
1685 /**
1686  * svc_fill_symlink_pathname - Construct pathname argument for VFS symlink call
1687  * @rqstp: svc_rqst to operate on
1688  * @first: buffer containing first section of pathname
1689  * @p: buffer containing remaining section of pathname
1690  * @total: total length of the pathname argument
1691  *
1692  * The VFS symlink API demands a NUL-terminated pathname in mapped memory.
1693  * Returns pointer to a NUL-terminated string, or an ERR_PTR. Caller must free
1694  * the returned string.
1695  */
1696 char *svc_fill_symlink_pathname(struct svc_rqst *rqstp, struct kvec *first,
1697                                 void *p, size_t total)
1698 {
1699         size_t len, remaining;
1700         char *result, *dst;
1701
1702         result = kmalloc(total + 1, GFP_KERNEL);
1703         if (!result)
1704                 return ERR_PTR(-ESERVERFAULT);
1705
1706         dst = result;
1707         remaining = total;
1708
1709         len = min_t(size_t, total, first->iov_len);
1710         if (len) {
1711                 memcpy(dst, first->iov_base, len);
1712                 dst += len;
1713                 remaining -= len;
1714         }
1715
1716         if (remaining) {
1717                 len = min_t(size_t, remaining, PAGE_SIZE);
1718                 memcpy(dst, p, len);
1719                 dst += len;
1720         }
1721
1722         *dst = '\0';
1723
1724         /* Sanity check: Linux doesn't allow the pathname argument to
1725          * contain a NUL byte.
1726          */
1727         if (strlen(result) != total) {
1728                 kfree(result);
1729                 return ERR_PTR(-EINVAL);
1730         }
1731         return result;
1732 }
1733 EXPORT_SYMBOL_GPL(svc_fill_symlink_pathname);