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