net/sunrpc/svc.c

   1 /*
   2  * linux/net/sunrpc/svc.c
   3  *
   4  * High-level RPC service routines
   5  *
   6  * Copyright (C) 1995, 1996 Olaf Kirch <okir@monad.swb.de>
   7  *
   8  * Multiple threads pools and NUMAisation
   9  * Copyright (c) 2006 Silicon Graphics, Inc.
  10  * by Greg Banks <gnb@melbourne.sgi.com>
  11  */
  12
  13 #include <linux/linkage.h>
  14 #include <linux/sched.h>
  15 #include <linux/errno.h>
  16 #include <linux/net.h>
  17 #include <linux/in.h>
  18 #include <linux/mm.h>
  19 #include <linux/interrupt.h>
  20 #include <linux/module.h>
  21 #include <linux/kthread.h>
  22 #include <linux/slab.h>
  23
  24 #include <linux/sunrpc/types.h>
  25 #include <linux/sunrpc/xdr.h>
  26 #include <linux/sunrpc/stats.h>
  27 #include <linux/sunrpc/svcsock.h>
  28 #include <linux/sunrpc/clnt.h>
  29 #include <linux/sunrpc/bc_xprt.h>
  30
  31 #define RPCDBG_FACILITY RPCDBG_SVCDSP
  32
  33 static void svc_unregister(const struct svc_serv *serv);
  34
  35 #define svc_serv_is_pooled(serv)    ((serv)->sv_function)
  36
  37 /*
  38  * Mode for mapping cpus to pools.
  39  */
  40 enum {
  41         SVC_POOL_AUTO = -1,     /* choose one of the others */
  42         SVC_POOL_GLOBAL,        /* no mapping, just a single global pool
  43                                  * (legacy & UP mode) */
  44         SVC_POOL_PERCPU,        /* one pool per cpu */
  45         SVC_POOL_PERNODE        /* one pool per numa node */
  46 };
  47 #define SVC_POOL_DEFAULT        SVC_POOL_GLOBAL
  48
  49 /*
  50  * Structure for mapping cpus to pools and vice versa.
  51  * Setup once during sunrpc initialisation.
  52  */
  53 static struct svc_pool_map {
  54         int count;                      /* How many svc_servs use us */
  55         int mode;                       /* Note: int not enum to avoid
  56                                          * warnings about "enumeration value
  57                                          * not handled in switch" */
  58         unsigned int npools;
  59         unsigned int *pool_to;          /* maps pool id to cpu or node */
  60         unsigned int *to_pool;          /* maps cpu or node to pool id */
  61 } svc_pool_map = {
  62         .count = 0,
  63         .mode = SVC_POOL_DEFAULT
  64 };
  65 static DEFINE_MUTEX(svc_pool_map_mutex);/* protects svc_pool_map.count only */
  66
  67 static int
  68 param_set_pool_mode(const char *val, struct kernel_param *kp)
  69 {
  70         int *ip = (int *)kp->arg;
  71         struct svc_pool_map *m = &svc_pool_map;
  72         int err;
  73
  74         mutex_lock(&svc_pool_map_mutex);
  75
  76         err = -EBUSY;
  77         if (m->count)
  78                 goto out;
  79
  80         err = 0;
  81         if (!strncmp(val, "auto", 4))
  82                 *ip = SVC_POOL_AUTO;
  83         else if (!strncmp(val, "global", 6))
  84                 *ip = SVC_POOL_GLOBAL;
  85         else if (!strncmp(val, "percpu", 6))
  86                 *ip = SVC_POOL_PERCPU;
  87         else if (!strncmp(val, "pernode", 7))
  88                 *ip = SVC_POOL_PERNODE;
  89         else
  90                 err = -EINVAL;
  91
  92 out:
  93         mutex_unlock(&svc_pool_map_mutex);
  94         return err;
  95 }
  96
  97 static int
  98 param_get_pool_mode(char *buf, struct kernel_param *kp)
  99 {
 100         int *ip = (int *)kp->arg;
 101
 102         switch (*ip)
 103         {
 104         case SVC_POOL_AUTO:
 105                 return strlcpy(buf, "auto", 20);
 106         case SVC_POOL_GLOBAL:
 107                 return strlcpy(buf, "global", 20);
 108         case SVC_POOL_PERCPU:
 109                 return strlcpy(buf, "percpu", 20);
 110         case SVC_POOL_PERNODE:
 111                 return strlcpy(buf, "pernode", 20);
 112         default:
 113                 return sprintf(buf, "%d", *ip);
 114         }
 115 }
 116
 117 module_param_call(pool_mode, param_set_pool_mode, param_get_pool_mode,
 118                  &svc_pool_map.mode, 0644);
 119
 120 /*
 121  * Detect best pool mapping mode heuristically,
 122  * according to the machine's topology.
 123  */
 124 static int
 125 svc_pool_map_choose_mode(void)
 126 {
 127         unsigned int node;
 128
 129         if (nr_online_nodes > 1) {
 130                 /*
 131                  * Actually have multiple NUMA nodes,
 132                  * so split pools on NUMA node boundaries
 133                  */
 134                 return SVC_POOL_PERNODE;
 135         }
 136
 137         node = first_online_node;
 138         if (nr_cpus_node(node) > 2) {
 139                 /*
 140                  * Non-trivial SMP, or CONFIG_NUMA on
 141                  * non-NUMA hardware, e.g. with a generic
 142                  * x86_64 kernel on Xeons.  In this case we
 143                  * want to divide the pools on cpu boundaries.
 144                  */
 145                 return SVC_POOL_PERCPU;
 146         }
 147
 148         /* default: one global pool */
 149         return SVC_POOL_GLOBAL;
 150 }
 151
 152 /*
 153  * Allocate the to_pool[] and pool_to[] arrays.
 154  * Returns 0 on success or an errno.
 155  */
 156 static int
 157 svc_pool_map_alloc_arrays(struct svc_pool_map *m, unsigned int maxpools)
 158 {
 159         m->to_pool = kcalloc(maxpools, sizeof(unsigned int), GFP_KERNEL);
 160         if (!m->to_pool)
 161                 goto fail;
 162         m->pool_to = kcalloc(maxpools, sizeof(unsigned int), GFP_KERNEL);
 163         if (!m->pool_to)
 164                 goto fail_free;
 165
 166         return 0;
 167
 168 fail_free:
 169         kfree(m->to_pool);
 170 fail:
 171         return -ENOMEM;
 172 }
 173
 174 /*
 175  * Initialise the pool map for SVC_POOL_PERCPU mode.
 176  * Returns number of pools or <0 on error.
 177  */
 178 static int
 179 svc_pool_map_init_percpu(struct svc_pool_map *m)
 180 {
 181         unsigned int maxpools = nr_cpu_ids;
 182         unsigned int pidx = 0;
 183         unsigned int cpu;
 184         int err;
 185
 186         err = svc_pool_map_alloc_arrays(m, maxpools);
 187         if (err)
 188                 return err;
 189
 190         for_each_online_cpu(cpu) {
 191                 BUG_ON(pidx > maxpools);
 192                 m->to_pool[cpu] = pidx;
 193                 m->pool_to[pidx] = cpu;
 194                 pidx++;
 195         }
 196         /* cpus brought online later all get mapped to pool0, sorry */
 197
 198         return pidx;
 199 };
 200
 201
 202 /*
 203  * Initialise the pool map for SVC_POOL_PERNODE mode.
 204  * Returns number of pools or <0 on error.
 205  */
 206 static int
 207 svc_pool_map_init_pernode(struct svc_pool_map *m)
 208 {
 209         unsigned int maxpools = nr_node_ids;
 210         unsigned int pidx = 0;
 211         unsigned int node;
 212         int err;
 213
 214         err = svc_pool_map_alloc_arrays(m, maxpools);
 215         if (err)
 216                 return err;
 217
 218         for_each_node_with_cpus(node) {
 219                 /* some architectures (e.g. SN2) have cpuless nodes */
 220                 BUG_ON(pidx > maxpools);
 221                 m->to_pool[node] = pidx;
 222                 m->pool_to[pidx] = node;
 223                 pidx++;
 224         }
 225         /* nodes brought online later all get mapped to pool0, sorry */
 226
 227         return pidx;
 228 }
 229
 230
 231 /*
 232  * Add a reference to the global map of cpus to pools (and
 233  * vice versa).  Initialise the map if we're the first user.
 234  * Returns the number of pools.
 235  */
 236 static unsigned int
 237 svc_pool_map_get(void)
 238 {
 239         struct svc_pool_map *m = &svc_pool_map;
 240         int npools = -1;
 241
 242         mutex_lock(&svc_pool_map_mutex);
 243
 244         if (m->count++) {
 245                 mutex_unlock(&svc_pool_map_mutex);
 246                 return m->npools;
 247         }
 248
 249         if (m->mode == SVC_POOL_AUTO)
 250                 m->mode = svc_pool_map_choose_mode();
 251
 252         switch (m->mode) {
 253         case SVC_POOL_PERCPU:
 254                 npools = svc_pool_map_init_percpu(m);
 255                 break;
 256         case SVC_POOL_PERNODE:
 257                 npools = svc_pool_map_init_pernode(m);
 258                 break;
 259         }
 260
 261         if (npools < 0) {
 262                 /* default, or memory allocation failure */
 263                 npools = 1;
 264                 m->mode = SVC_POOL_GLOBAL;
 265         }
 266         m->npools = npools;
 267
 268         mutex_unlock(&svc_pool_map_mutex);
 269         return m->npools;
 270 }
 271
 272
 273 /*
 274  * Drop a reference to the global map of cpus to pools.
 275  * When the last reference is dropped, the map data is
 276  * freed; this allows the sysadmin to change the pool
 277  * mode using the pool_mode module option without
 278  * rebooting or re-loading sunrpc.ko.
 279  */
 280 static void
 281 svc_pool_map_put(void)
 282 {
 283         struct svc_pool_map *m = &svc_pool_map;
 284
 285         mutex_lock(&svc_pool_map_mutex);
 286
 287         if (!--m->count) {
 288                 m->mode = SVC_POOL_DEFAULT;
 289                 kfree(m->to_pool);
 290                 kfree(m->pool_to);
 291                 m->npools = 0;
 292         }
 293
 294         mutex_unlock(&svc_pool_map_mutex);
 295 }
 296
 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         BUG_ON(m->count == 0);
 313
 314         switch (m->mode) {
 315         case SVC_POOL_PERCPU:
 316         {
 317                 set_cpus_allowed_ptr(task, cpumask_of(node));
 318                 break;
 319         }
 320         case SVC_POOL_PERNODE:
 321         {
 322                 set_cpus_allowed_ptr(task, cpumask_of_node(node));
 323                 break;
 324         }
 325         }
 326 }
 327
 328 /*
 329  * Use the mapping mode to choose a pool for a given CPU.
 330  * Used when enqueueing an incoming RPC.  Always returns
 331  * a non-NULL pool pointer.
 332  */
 333 struct svc_pool *
 334 svc_pool_for_cpu(struct svc_serv *serv, int cpu)
 335 {
 336         struct svc_pool_map *m = &svc_pool_map;
 337         unsigned int pidx = 0;
 338
 339         /*
 340          * An uninitialised map happens in a pure client when
 341          * lockd is brought up, so silently treat it the
 342          * same as SVC_POOL_GLOBAL.
 343          */
 344         if (svc_serv_is_pooled(serv)) {
 345                 switch (m->mode) {
 346                 case SVC_POOL_PERCPU:
 347                         pidx = m->to_pool[cpu];
 348                         break;
 349                 case SVC_POOL_PERNODE:
 350                         pidx = m->to_pool[cpu_to_node(cpu)];
 351                         break;
 352                 }
 353         }
 354         return &serv->sv_pools[pidx % serv->sv_nrpools];
 355 }
 356
 357 static int svc_rpcb_setup(struct svc_serv *serv)
 358 {
 359         int err;
 360
 361         err = rpcb_create_local();
 362         if (err)
 363                 return err;
 364
 365         /* Remove any stale portmap registrations */
 366         svc_unregister(serv);
 367         return 0;
 368 }
 369
 370 static void svc_rpcb_cleanup(struct svc_serv *serv)
 371 {
 372         svc_unregister(serv);
 373         rpcb_put_local();
 374 }
 375
 376 static int svc_uses_rpcbind(struct svc_serv *serv)
 377 {
 378         struct svc_program      *progp;
 379         unsigned int            i;
 380
 381         for (progp = serv->sv_program; progp; progp = progp->pg_next) {
 382                 for (i = 0; i < progp->pg_nvers; i++) {
 383                         if (progp->pg_vers[i] == NULL)
 384                                 continue;
 385                         if (progp->pg_vers[i]->vs_hidden == 0)
 386                                 return 1;
 387                 }
 388         }
 389
 390         return 0;
 391 }
 392
 393 /*
 394  * Create an RPC service
 395  */
 396 static struct svc_serv *
 397 __svc_create(struct svc_program *prog, unsigned int bufsize, int npools,
 398              void (*shutdown)(struct svc_serv *serv))
 399 {
 400         struct svc_serv *serv;
 401         unsigned int vers;
 402         unsigned int xdrsize;
 403         unsigned int i;
 404
 405         if (!(serv = kzalloc(sizeof(*serv), GFP_KERNEL)))
 406                 return NULL;
 407         serv->sv_name      = prog->pg_name;
 408         serv->sv_program   = prog;
 409         serv->sv_nrthreads = 1;
 410         serv->sv_stats     = prog->pg_stats;
 411         if (bufsize > RPCSVC_MAXPAYLOAD)
 412                 bufsize = RPCSVC_MAXPAYLOAD;
 413         serv->sv_max_payload = bufsize? bufsize : 4096;
 414         serv->sv_max_mesg  = roundup(serv->sv_max_payload + PAGE_SIZE, PAGE_SIZE);
 415         serv->sv_shutdown  = shutdown;
 416         xdrsize = 0;
 417         while (prog) {
 418                 prog->pg_lovers = prog->pg_nvers-1;
 419                 for (vers=0; vers<prog->pg_nvers ; vers++)
 420                         if (prog->pg_vers[vers]) {
 421                                 prog->pg_hivers = vers;
 422                                 if (prog->pg_lovers > vers)
 423                                         prog->pg_lovers = vers;
 424                                 if (prog->pg_vers[vers]->vs_xdrsize > xdrsize)
 425                                         xdrsize = prog->pg_vers[vers]->vs_xdrsize;
 426                         }
 427                 prog = prog->pg_next;
 428         }
 429         serv->sv_xdrsize   = xdrsize;
 430         INIT_LIST_HEAD(&serv->sv_tempsocks);
 431         INIT_LIST_HEAD(&serv->sv_permsocks);
 432         init_timer(&serv->sv_temptimer);
 433         spin_lock_init(&serv->sv_lock);
 434
 435         serv->sv_nrpools = npools;
 436         serv->sv_pools =
 437                 kcalloc(serv->sv_nrpools, sizeof(struct svc_pool),
 438                         GFP_KERNEL);
 439         if (!serv->sv_pools) {
 440                 kfree(serv);
 441                 return NULL;
 442         }
 443
 444         for (i = 0; i < serv->sv_nrpools; i++) {
 445                 struct svc_pool *pool = &serv->sv_pools[i];
 446
 447                 dprintk("svc: initialising pool %u for %s\n",
 448                                 i, serv->sv_name);
 449
 450                 pool->sp_id = i;
 451                 INIT_LIST_HEAD(&pool->sp_threads);
 452                 INIT_LIST_HEAD(&pool->sp_sockets);
 453                 INIT_LIST_HEAD(&pool->sp_all_threads);
 454                 spin_lock_init(&pool->sp_lock);
 455         }
 456
 457         if (svc_uses_rpcbind(serv)) {
 458                 if (svc_rpcb_setup(serv) < 0) {
 459                         kfree(serv->sv_pools);
 460                         kfree(serv);
 461                         return NULL;
 462                 }
 463                 if (!serv->sv_shutdown)
 464                         serv->sv_shutdown = svc_rpcb_cleanup;
 465         }
 466
 467         return serv;
 468 }
 469
 470 struct svc_serv *
 471 svc_create(struct svc_program *prog, unsigned int bufsize,
 472            void (*shutdown)(struct svc_serv *serv))
 473 {
 474         return __svc_create(prog, bufsize, /*npools*/1, shutdown);
 475 }
 476 EXPORT_SYMBOL_GPL(svc_create);
 477
 478 struct svc_serv *
 479 svc_create_pooled(struct svc_program *prog, unsigned int bufsize,
 480                   void (*shutdown)(struct svc_serv *serv),
 481                   svc_thread_fn func, struct module *mod)
 482 {
 483         struct svc_serv *serv;
 484         unsigned int npools = svc_pool_map_get();
 485
 486         serv = __svc_create(prog, bufsize, npools, shutdown);
 487
 488         if (serv != NULL) {
 489                 serv->sv_function = func;
 490                 serv->sv_module = mod;
 491         }
 492
 493         return serv;
 494 }
 495 EXPORT_SYMBOL_GPL(svc_create_pooled);
 496
 497 /*
 498  * Destroy an RPC service. Should be called with appropriate locking to
 499  * protect the sv_nrthreads, sv_permsocks and sv_tempsocks.
 500  */
 501 void
 502 svc_destroy(struct svc_serv *serv)
 503 {
 504         dprintk("svc: svc_destroy(%s, %d)\n",
 505                                 serv->sv_program->pg_name,
 506                                 serv->sv_nrthreads);
 507
 508         if (serv->sv_nrthreads) {
 509                 if (--(serv->sv_nrthreads) != 0) {
 510                         svc_sock_update_bufs(serv);
 511                         return;
 512                 }
 513         } else
 514                 printk("svc_destroy: no threads for serv=%p!\n", serv);
 515
 516         del_timer_sync(&serv->sv_temptimer);
 517
 518         svc_close_all(&serv->sv_tempsocks);
 519
 520         if (serv->sv_shutdown)
 521                 serv->sv_shutdown(serv);
 522
 523         svc_close_all(&serv->sv_permsocks);
 524
 525         BUG_ON(!list_empty(&serv->sv_permsocks));
 526         BUG_ON(!list_empty(&serv->sv_tempsocks));
 527
 528         cache_clean_deferred(serv);
 529
 530         if (svc_serv_is_pooled(serv))
 531                 svc_pool_map_put();
 532
 533         svc_unregister(serv);
 534         kfree(serv->sv_pools);
 535         kfree(serv);
 536 }
 537 EXPORT_SYMBOL_GPL(svc_destroy);
 538
 539 /*
 540  * Allocate an RPC server's buffer space.
 541  * We allocate pages and place them in rq_argpages.
 542  */
 543 static int
 544 svc_init_buffer(struct svc_rqst *rqstp, unsigned int size)
 545 {
 546         unsigned int pages, arghi;
 547
 548         /* bc_xprt uses fore channel allocated buffers */
 549         if (svc_is_backchannel(rqstp))
 550                 return 1;
 551
 552         pages = size / PAGE_SIZE + 1; /* extra page as we hold both request and reply.
 553                                        * We assume one is at most one page
 554                                        */
 555         arghi = 0;
 556         BUG_ON(pages > RPCSVC_MAXPAGES);
 557         while (pages) {
 558                 struct page *p = alloc_page(GFP_KERNEL);
 559                 if (!p)
 560                         break;
 561                 rqstp->rq_pages[arghi++] = p;
 562                 pages--;
 563         }
 564         return pages == 0;
 565 }
 566
 567 /*
 568  * Release an RPC server buffer
 569  */
 570 static void
 571 svc_release_buffer(struct svc_rqst *rqstp)
 572 {
 573         unsigned int i;
 574
 575         for (i = 0; i < ARRAY_SIZE(rqstp->rq_pages); i++)
 576                 if (rqstp->rq_pages[i])
 577                         put_page(rqstp->rq_pages[i]);
 578 }
 579
 580 struct svc_rqst *
 581 svc_prepare_thread(struct svc_serv *serv, struct svc_pool *pool)
 582 {
 583         struct svc_rqst *rqstp;
 584
 585         rqstp = kzalloc(sizeof(*rqstp), GFP_KERNEL);
 586         if (!rqstp)
 587                 goto out_enomem;
 588
 589         init_waitqueue_head(&rqstp->rq_wait);
 590
 591         serv->sv_nrthreads++;
 592         spin_lock_bh(&pool->sp_lock);
 593         pool->sp_nrthreads++;
 594         list_add(&rqstp->rq_all, &pool->sp_all_threads);
 595         spin_unlock_bh(&pool->sp_lock);
 596         rqstp->rq_server = serv;
 597         rqstp->rq_pool = pool;
 598
 599         rqstp->rq_argp = kmalloc(serv->sv_xdrsize, GFP_KERNEL);
 600         if (!rqstp->rq_argp)
 601                 goto out_thread;
 602
 603         rqstp->rq_resp = kmalloc(serv->sv_xdrsize, GFP_KERNEL);
 604         if (!rqstp->rq_resp)
 605                 goto out_thread;
 606
 607         if (!svc_init_buffer(rqstp, serv->sv_max_mesg))
 608                 goto out_thread;
 609
 610         return rqstp;
 611 out_thread:
 612         svc_exit_thread(rqstp);
 613 out_enomem:
 614         return ERR_PTR(-ENOMEM);
 615 }
 616 EXPORT_SYMBOL_GPL(svc_prepare_thread);
 617
 618 /*
 619  * Choose a pool in which to create a new thread, for svc_set_num_threads
 620  */
 621 static inline struct svc_pool *
 622 choose_pool(struct svc_serv *serv, struct svc_pool *pool, unsigned int *state)
 623 {
 624         if (pool != NULL)
 625                 return pool;
 626
 627         return &serv->sv_pools[(*state)++ % serv->sv_nrpools];
 628 }
 629
 630 /*
 631  * Choose a thread to kill, for svc_set_num_threads
 632  */
 633 static inline struct task_struct *
 634 choose_victim(struct svc_serv *serv, struct svc_pool *pool, unsigned int *state)
 635 {
 636         unsigned int i;
 637         struct task_struct *task = NULL;
 638
 639         if (pool != NULL) {
 640                 spin_lock_bh(&pool->sp_lock);
 641         } else {
 642                 /* choose a pool in round-robin fashion */
 643                 for (i = 0; i < serv->sv_nrpools; i++) {
 644                         pool = &serv->sv_pools[--(*state) % serv->sv_nrpools];
 645                         spin_lock_bh(&pool->sp_lock);
 646                         if (!list_empty(&pool->sp_all_threads))
 647                                 goto found_pool;
 648                         spin_unlock_bh(&pool->sp_lock);
 649                 }
 650                 return NULL;
 651         }
 652
 653 found_pool:
 654         if (!list_empty(&pool->sp_all_threads)) {
 655                 struct svc_rqst *rqstp;
 656
 657                 /*
 658                  * Remove from the pool->sp_all_threads list
 659                  * so we don't try to kill it again.
 660                  */
 661                 rqstp = list_entry(pool->sp_all_threads.next, struct svc_rqst, rq_all);
 662                 list_del_init(&rqstp->rq_all);
 663                 task = rqstp->rq_task;
 664         }
 665         spin_unlock_bh(&pool->sp_lock);
 666
 667         return task;
 668 }
 669
 670 /*
 671  * Create or destroy enough new threads to make the number
 672  * of threads the given number.  If `pool' is non-NULL, applies
 673  * only to threads in that pool, otherwise round-robins between
 674  * all pools.  Must be called with a svc_get() reference and
 675  * the BKL or another lock to protect access to svc_serv fields.
 676  *
 677  * Destroying threads relies on the service threads filling in
 678  * rqstp->rq_task, which only the nfs ones do.  Assumes the serv
 679  * has been created using svc_create_pooled().
 680  *
 681  * Based on code that used to be in nfsd_svc() but tweaked
 682  * to be pool-aware.
 683  */
 684 int
 685 svc_set_num_threads(struct svc_serv *serv, struct svc_pool *pool, int nrservs)
 686 {
 687         struct svc_rqst *rqstp;
 688         struct task_struct *task;
 689         struct svc_pool *chosen_pool;
 690         int error = 0;
 691         unsigned int state = serv->sv_nrthreads-1;
 692
 693         if (pool == NULL) {
 694                 /* The -1 assumes caller has done a svc_get() */
 695                 nrservs -= (serv->sv_nrthreads-1);
 696         } else {
 697                 spin_lock_bh(&pool->sp_lock);
 698                 nrservs -= pool->sp_nrthreads;
 699                 spin_unlock_bh(&pool->sp_lock);
 700         }
 701
 702         /* create new threads */
 703         while (nrservs > 0) {
 704                 nrservs--;
 705                 chosen_pool = choose_pool(serv, pool, &state);
 706
 707                 rqstp = svc_prepare_thread(serv, chosen_pool);
 708                 if (IS_ERR(rqstp)) {
 709                         error = PTR_ERR(rqstp);
 710                         break;
 711                 }
 712
 713                 __module_get(serv->sv_module);
 714                 task = kthread_create(serv->sv_function, rqstp, serv->sv_name);
 715                 if (IS_ERR(task)) {
 716                         error = PTR_ERR(task);
 717                         module_put(serv->sv_module);
 718                         svc_exit_thread(rqstp);
 719                         break;
 720                 }
 721
 722                 rqstp->rq_task = task;
 723                 if (serv->sv_nrpools > 1)
 724                         svc_pool_map_set_cpumask(task, chosen_pool->sp_id);
 725
 726                 svc_sock_update_bufs(serv);
 727                 wake_up_process(task);
 728         }
 729         /* destroy old threads */
 730         while (nrservs < 0 &&
 731                (task = choose_victim(serv, pool, &state)) != NULL) {
 732                 send_sig(SIGINT, task, 1);
 733                 nrservs++;
 734         }
 735
 736         return error;
 737 }
 738 EXPORT_SYMBOL_GPL(svc_set_num_threads);
 739
 740 /*
 741  * Called from a server thread as it's exiting. Caller must hold the BKL or
 742  * the "service mutex", whichever is appropriate for the service.
 743  */
 744 void
 745 svc_exit_thread(struct svc_rqst *rqstp)
 746 {
 747         struct svc_serv *serv = rqstp->rq_server;
 748         struct svc_pool *pool = rqstp->rq_pool;
 749
 750         svc_release_buffer(rqstp);
 751         kfree(rqstp->rq_resp);
 752         kfree(rqstp->rq_argp);
 753         kfree(rqstp->rq_auth_data);
 754
 755         spin_lock_bh(&pool->sp_lock);
 756         pool->sp_nrthreads--;
 757         list_del(&rqstp->rq_all);
 758         spin_unlock_bh(&pool->sp_lock);
 759
 760         kfree(rqstp);
 761
 762         /* Release the server */
 763         if (serv)
 764                 svc_destroy(serv);
 765 }
 766 EXPORT_SYMBOL_GPL(svc_exit_thread);
 767
 768 /*
 769  * Register an "inet" protocol family netid with the local
 770  * rpcbind daemon via an rpcbind v4 SET request.
 771  *
 772  * No netconfig infrastructure is available in the kernel, so
 773  * we map IP_ protocol numbers to netids by hand.
 774  *
 775  * Returns zero on success; a negative errno value is returned
 776  * if any error occurs.
 777  */
 778 static int __svc_rpcb_register4(const u32 program, const u32 version,
 779                                 const unsigned short protocol,
 780                                 const unsigned short port)
 781 {
 782         const struct sockaddr_in sin = {
 783                 .sin_family             = AF_INET,
 784                 .sin_addr.s_addr        = htonl(INADDR_ANY),
 785                 .sin_port               = htons(port),
 786         };
 787         const char *netid;
 788         int error;
 789
 790         switch (protocol) {
 791         case IPPROTO_UDP:
 792                 netid = RPCBIND_NETID_UDP;
 793                 break;
 794         case IPPROTO_TCP:
 795                 netid = RPCBIND_NETID_TCP;
 796                 break;
 797         default:
 798                 return -ENOPROTOOPT;
 799         }
 800
 801         error = rpcb_v4_register(program, version,
 802                                         (const struct sockaddr *)&sin, netid);
 803
 804         /*
 805          * User space didn't support rpcbind v4, so retry this
 806          * registration request with the legacy rpcbind v2 protocol.
 807          */
 808         if (error == -EPROTONOSUPPORT)
 809                 error = rpcb_register(program, version, protocol, port);
 810
 811         return error;
 812 }
 813
 814 #if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
 815 /*
 816  * Register an "inet6" protocol family netid with the local
 817  * rpcbind daemon via an rpcbind v4 SET request.
 818  *
 819  * No netconfig infrastructure is available in the kernel, so
 820  * we map IP_ protocol numbers to netids by hand.
 821  *
 822  * Returns zero on success; a negative errno value is returned
 823  * if any error occurs.
 824  */
 825 static int __svc_rpcb_register6(const u32 program, const u32 version,
 826                                 const unsigned short protocol,
 827                                 const unsigned short port)
 828 {
 829         const struct sockaddr_in6 sin6 = {
 830                 .sin6_family            = AF_INET6,
 831                 .sin6_addr              = IN6ADDR_ANY_INIT,
 832                 .sin6_port              = htons(port),
 833         };
 834         const char *netid;
 835         int error;
 836
 837         switch (protocol) {
 838         case IPPROTO_UDP:
 839                 netid = RPCBIND_NETID_UDP6;
 840                 break;
 841         case IPPROTO_TCP:
 842                 netid = RPCBIND_NETID_TCP6;
 843                 break;
 844         default:
 845                 return -ENOPROTOOPT;
 846         }
 847
 848         error = rpcb_v4_register(program, version,
 849                                         (const struct sockaddr *)&sin6, netid);
 850
 851         /*
 852          * User space didn't support rpcbind version 4, so we won't
 853          * use a PF_INET6 listener.
 854          */
 855         if (error == -EPROTONOSUPPORT)
 856                 error = -EAFNOSUPPORT;
 857
 858         return error;
 859 }
 860 #endif  /* defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE) */
 861
 862 /*
 863  * Register a kernel RPC service via rpcbind version 4.
 864  *
 865  * Returns zero on success; a negative errno value is returned
 866  * if any error occurs.
 867  */
 868 static int __svc_register(const char *progname,
 869                           const u32 program, const u32 version,
 870                           const int family,
 871                           const unsigned short protocol,
 872                           const unsigned short port)
 873 {
 874         int error = -EAFNOSUPPORT;
 875
 876         switch (family) {
 877         case PF_INET:
 878                 error = __svc_rpcb_register4(program, version,
 879                                                 protocol, port);
 880                 break;
 881 #if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
 882         case PF_INET6:
 883                 error = __svc_rpcb_register6(program, version,
 884                                                 protocol, port);
 885 #endif  /* defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE) */
 886         }
 887
 888         if (error < 0)
 889                 printk(KERN_WARNING "svc: failed to register %sv%u RPC "
 890                         "service (errno %d).\n", progname, version, -error);
 891         return error;
 892 }
 893
 894 /**
 895  * svc_register - register an RPC service with the local portmapper
 896  * @serv: svc_serv struct for the service to register
 897  * @family: protocol family of service's listener socket
 898  * @proto: transport protocol number to advertise
 899  * @port: port to advertise
 900  *
 901  * Service is registered for any address in the passed-in protocol family
 902  */
 903 int svc_register(const struct svc_serv *serv, const int family,
 904                  const unsigned short proto, const unsigned short port)
 905 {
 906         struct svc_program      *progp;
 907         unsigned int            i;
 908         int                     error = 0;
 909
 910         BUG_ON(proto == 0 && port == 0);
 911
 912         for (progp = serv->sv_program; progp; progp = progp->pg_next) {
 913                 for (i = 0; i < progp->pg_nvers; i++) {
 914                         if (progp->pg_vers[i] == NULL)
 915                                 continue;
 916
 917                         dprintk("svc: svc_register(%sv%d, %s, %u, %u)%s\n",
 918                                         progp->pg_name,
 919                                         i,
 920                                         proto == IPPROTO_UDP?  "udp" : "tcp",
 921                                         port,
 922                                         family,
 923                                         progp->pg_vers[i]->vs_hidden?
 924                                                 " (but not telling portmap)" : "");
 925
 926                         if (progp->pg_vers[i]->vs_hidden)
 927                                 continue;
 928
 929                         error = __svc_register(progp->pg_name, progp->pg_prog,
 930                                                 i, family, proto, port);
 931                         if (error < 0)
 932                                 break;
 933                 }
 934         }
 935
 936         return error;
 937 }
 938
 939 /*
 940  * If user space is running rpcbind, it should take the v4 UNSET
 941  * and clear everything for this [program, version].  If user space
 942  * is running portmap, it will reject the v4 UNSET, but won't have
 943  * any "inet6" entries anyway.  So a PMAP_UNSET should be sufficient
 944  * in this case to clear all existing entries for [program, version].
 945  */
 946 static void __svc_unregister(const u32 program, const u32 version,
 947                              const char *progname)
 948 {
 949         int error;
 950
 951         error = rpcb_v4_register(program, version, NULL, "");
 952
 953         /*
 954          * User space didn't support rpcbind v4, so retry this
 955          * request with the legacy rpcbind v2 protocol.
 956          */
 957         if (error == -EPROTONOSUPPORT)
 958                 error = rpcb_register(program, version, 0, 0);
 959
 960         dprintk("svc: %s(%sv%u), error %d\n",
 961                         __func__, progname, version, error);
 962 }
 963
 964 /*
 965  * All netids, bind addresses and ports registered for [program, version]
 966  * are removed from the local rpcbind database (if the service is not
 967  * hidden) to make way for a new instance of the service.
 968  *
 969  * The result of unregistration is reported via dprintk for those who want
 970  * verification of the result, but is otherwise not important.
 971  */
 972 static void svc_unregister(const struct svc_serv *serv)
 973 {
 974         struct svc_program *progp;
 975         unsigned long flags;
 976         unsigned int i;
 977
 978         clear_thread_flag(TIF_SIGPENDING);
 979
 980         for (progp = serv->sv_program; progp; progp = progp->pg_next) {
 981                 for (i = 0; i < progp->pg_nvers; i++) {
 982                         if (progp->pg_vers[i] == NULL)
 983                                 continue;
 984                         if (progp->pg_vers[i]->vs_hidden)
 985                                 continue;
 986
 987                         dprintk("svc: attempting to unregister %sv%u\n",
 988                                 progp->pg_name, i);
 989                         __svc_unregister(progp->pg_prog, i, progp->pg_name);
 990                 }
 991         }
 992
 993         spin_lock_irqsave(&current->sighand->siglock, flags);
 994         recalc_sigpending();
 995         spin_unlock_irqrestore(&current->sighand->siglock, flags);
 996 }
 997
 998 /*
 999  * Printk the given error with the address of the client that caused it.
1000  */
1001 static int
1002 __attribute__ ((format (printf, 2, 3)))
1003 svc_printk(struct svc_rqst *rqstp, const char *fmt, ...)
1004 {
1005         va_list args;
1006         int     r;
1007         char    buf[RPC_MAX_ADDRBUFLEN];
1008
1009         if (!net_ratelimit())
1010                 return 0;
1011
1012         printk(KERN_WARNING "svc: %s: ",
1013                 svc_print_addr(rqstp, buf, sizeof(buf)));
1014
1015         va_start(args, fmt);
1016         r = vprintk(fmt, args);
1017         va_end(args);
1018
1019         return r;
1020 }
1021
1022 /*
1023  * Common routine for processing the RPC request.
1024  */
1025 static int
1026 svc_process_common(struct svc_rqst *rqstp, struct kvec *argv, struct kvec *resv)
1027 {
1028         struct svc_program      *progp;
1029         struct svc_version      *versp = NULL;  /* compiler food */
1030         struct svc_procedure    *procp = NULL;
1031         struct svc_serv         *serv = rqstp->rq_server;
1032         kxdrproc_t              xdr;
1033         __be32                  *statp;
1034         u32                     prog, vers, proc;
1035         __be32                  auth_stat, rpc_stat;
1036         int                     auth_res;
1037         __be32                  *reply_statp;
1038
1039         rpc_stat = rpc_success;
1040
1041         if (argv->iov_len < 6*4)
1042                 goto err_short_len;
1043
1044         /* Will be turned off only in gss privacy case: */
1045         rqstp->rq_splice_ok = 1;
1046         /* Will be turned off only when NFSv4 Sessions are used */
1047         rqstp->rq_usedeferral = 1;
1048         rqstp->rq_dropme = false;
1049
1050         /* Setup reply header */
1051         rqstp->rq_xprt->xpt_ops->xpo_prep_reply_hdr(rqstp);
1052
1053         svc_putu32(resv, rqstp->rq_xid);
1054
1055         vers = svc_getnl(argv);
1056
1057         /* First words of reply: */
1058         svc_putnl(resv, 1);             /* REPLY */
1059
1060         if (vers != 2)          /* RPC version number */
1061                 goto err_bad_rpc;
1062
1063         /* Save position in case we later decide to reject: */
1064         reply_statp = resv->iov_base + resv->iov_len;
1065
1066         svc_putnl(resv, 0);             /* ACCEPT */
1067
1068         rqstp->rq_prog = prog = svc_getnl(argv);        /* program number */
1069         rqstp->rq_vers = vers = svc_getnl(argv);        /* version number */
1070         rqstp->rq_proc = proc = svc_getnl(argv);        /* procedure number */
1071
1072         progp = serv->sv_program;
1073
1074         for (progp = serv->sv_program; progp; progp = progp->pg_next)
1075                 if (prog == progp->pg_prog)
1076                         break;
1077
1078         /*
1079          * Decode auth data, and add verifier to reply buffer.
1080          * We do this before anything else in order to get a decent
1081          * auth verifier.
1082          */
1083         auth_res = svc_authenticate(rqstp, &auth_stat);
1084         /* Also give the program a chance to reject this call: */
1085         if (auth_res == SVC_OK && progp) {
1086                 auth_stat = rpc_autherr_badcred;
1087                 auth_res = progp->pg_authenticate(rqstp);
1088         }
1089         switch (auth_res) {
1090         case SVC_OK:
1091                 break;
1092         case SVC_GARBAGE:
1093                 goto err_garbage;
1094         case SVC_SYSERR:
1095                 rpc_stat = rpc_system_err;
1096                 goto err_bad;
1097         case SVC_DENIED:
1098                 goto err_bad_auth;
1099         case SVC_CLOSE:
1100                 if (test_bit(XPT_TEMP, &rqstp->rq_xprt->xpt_flags))
1101                         svc_close_xprt(rqstp->rq_xprt);
1102         case SVC_DROP:
1103                 goto dropit;
1104         case SVC_COMPLETE:
1105                 goto sendit;
1106         }
1107
1108         if (progp == NULL)
1109                 goto err_bad_prog;
1110
1111         if (vers >= progp->pg_nvers ||
1112           !(versp = progp->pg_vers[vers]))
1113                 goto err_bad_vers;
1114
1115         procp = versp->vs_proc + proc;
1116         if (proc >= versp->vs_nproc || !procp->pc_func)
1117                 goto err_bad_proc;
1118         rqstp->rq_procinfo = procp;
1119
1120         /* Syntactic check complete */
1121         serv->sv_stats->rpccnt++;
1122
1123         /* Build the reply header. */
1124         statp = resv->iov_base +resv->iov_len;
1125         svc_putnl(resv, RPC_SUCCESS);
1126
1127         /* Bump per-procedure stats counter */
1128         procp->pc_count++;
1129
1130         /* Initialize storage for argp and resp */
1131         memset(rqstp->rq_argp, 0, procp->pc_argsize);
1132         memset(rqstp->rq_resp, 0, procp->pc_ressize);
1133
1134         /* un-reserve some of the out-queue now that we have a
1135          * better idea of reply size
1136          */
1137         if (procp->pc_xdrressize)
1138                 svc_reserve_auth(rqstp, procp->pc_xdrressize<<2);
1139
1140         /* Call the function that processes the request. */
1141         if (!versp->vs_dispatch) {
1142                 /* Decode arguments */
1143                 xdr = procp->pc_decode;
1144                 if (xdr && !xdr(rqstp, argv->iov_base, rqstp->rq_argp))
1145                         goto err_garbage;
1146
1147                 *statp = procp->pc_func(rqstp, rqstp->rq_argp, rqstp->rq_resp);
1148
1149                 /* Encode reply */
1150                 if (rqstp->rq_dropme) {
1151                         if (procp->pc_release)
1152                                 procp->pc_release(rqstp, NULL, rqstp->rq_resp);
1153                         goto dropit;
1154                 }
1155                 if (*statp == rpc_success &&
1156                     (xdr = procp->pc_encode) &&
1157                     !xdr(rqstp, resv->iov_base+resv->iov_len, rqstp->rq_resp)) {
1158                         dprintk("svc: failed to encode reply\n");
1159                         /* serv->sv_stats->rpcsystemerr++; */
1160                         *statp = rpc_system_err;
1161                 }
1162         } else {
1163                 dprintk("svc: calling dispatcher\n");
1164                 if (!versp->vs_dispatch(rqstp, statp)) {
1165                         /* Release reply info */
1166                         if (procp->pc_release)
1167                                 procp->pc_release(rqstp, NULL, rqstp->rq_resp);
1168                         goto dropit;
1169                 }
1170         }
1171
1172         /* Check RPC status result */
1173         if (*statp != rpc_success)
1174                 resv->iov_len = ((void*)statp)  - resv->iov_base + 4;
1175
1176         /* Release reply info */
1177         if (procp->pc_release)
1178                 procp->pc_release(rqstp, NULL, rqstp->rq_resp);
1179
1180         if (procp->pc_encode == NULL)
1181                 goto dropit;
1182
1183  sendit:
1184         if (svc_authorise(rqstp))
1185                 goto dropit;
1186         return 1;               /* Caller can now send it */
1187
1188  dropit:
1189         svc_authorise(rqstp);   /* doesn't hurt to call this twice */
1190         dprintk("svc: svc_process dropit\n");
1191         return 0;
1192
1193 err_short_len:
1194         svc_printk(rqstp, "short len %Zd, dropping request\n",
1195                         argv->iov_len);
1196
1197         goto dropit;                    /* drop request */
1198
1199 err_bad_rpc:
1200         serv->sv_stats->rpcbadfmt++;
1201         svc_putnl(resv, 1);     /* REJECT */
1202         svc_putnl(resv, 0);     /* RPC_MISMATCH */
1203         svc_putnl(resv, 2);     /* Only RPCv2 supported */
1204         svc_putnl(resv, 2);
1205         goto sendit;
1206
1207 err_bad_auth:
1208         dprintk("svc: authentication failed (%d)\n", ntohl(auth_stat));
1209         serv->sv_stats->rpcbadauth++;
1210         /* Restore write pointer to location of accept status: */
1211         xdr_ressize_check(rqstp, reply_statp);
1212         svc_putnl(resv, 1);     /* REJECT */
1213         svc_putnl(resv, 1);     /* AUTH_ERROR */
1214         svc_putnl(resv, ntohl(auth_stat));      /* status */
1215         goto sendit;
1216
1217 err_bad_prog:
1218         dprintk("svc: unknown program %d\n", prog);
1219         serv->sv_stats->rpcbadfmt++;
1220         svc_putnl(resv, RPC_PROG_UNAVAIL);
1221         goto sendit;
1222
1223 err_bad_vers:
1224         svc_printk(rqstp, "unknown version (%d for prog %d, %s)\n",
1225                        vers, prog, progp->pg_name);
1226
1227         serv->sv_stats->rpcbadfmt++;
1228         svc_putnl(resv, RPC_PROG_MISMATCH);
1229         svc_putnl(resv, progp->pg_lovers);
1230         svc_putnl(resv, progp->pg_hivers);
1231         goto sendit;
1232
1233 err_bad_proc:
1234         svc_printk(rqstp, "unknown procedure (%d)\n", proc);
1235
1236         serv->sv_stats->rpcbadfmt++;
1237         svc_putnl(resv, RPC_PROC_UNAVAIL);
1238         goto sendit;
1239
1240 err_garbage:
1241         svc_printk(rqstp, "failed to decode args\n");
1242
1243         rpc_stat = rpc_garbage_args;
1244 err_bad:
1245         serv->sv_stats->rpcbadfmt++;
1246         svc_putnl(resv, ntohl(rpc_stat));
1247         goto sendit;
1248 }
1249 EXPORT_SYMBOL_GPL(svc_process);
1250
1251 /*
1252  * Process the RPC request.
1253  */
1254 int
1255 svc_process(struct svc_rqst *rqstp)
1256 {
1257         struct kvec             *argv = &rqstp->rq_arg.head[0];
1258         struct kvec             *resv = &rqstp->rq_res.head[0];
1259         struct svc_serv         *serv = rqstp->rq_server;
1260         u32                     dir;
1261
1262         /*
1263          * Setup response xdr_buf.
1264          * Initially it has just one page
1265          */
1266         rqstp->rq_resused = 1;
1267         resv->iov_base = page_address(rqstp->rq_respages[0]);
1268         resv->iov_len = 0;
1269         rqstp->rq_res.pages = rqstp->rq_respages + 1;
1270         rqstp->rq_res.len = 0;
1271         rqstp->rq_res.page_base = 0;
1272         rqstp->rq_res.page_len = 0;
1273         rqstp->rq_res.buflen = PAGE_SIZE;
1274         rqstp->rq_res.tail[0].iov_base = NULL;
1275         rqstp->rq_res.tail[0].iov_len = 0;
1276
1277         rqstp->rq_xid = svc_getu32(argv);
1278
1279         dir  = svc_getnl(argv);
1280         if (dir != 0) {
1281                 /* direction != CALL */
1282                 svc_printk(rqstp, "bad direction %d, dropping request\n", dir);
1283                 serv->sv_stats->rpcbadfmt++;
1284                 svc_drop(rqstp);
1285                 return 0;
1286         }
1287
1288         /* Returns 1 for send, 0 for drop */
1289         if (svc_process_common(rqstp, argv, resv))
1290                 return svc_send(rqstp);
1291         else {
1292                 svc_drop(rqstp);
1293                 return 0;
1294         }
1295 }
1296
1297 #if defined(CONFIG_SUNRPC_BACKCHANNEL)
1298 /*
1299  * Process a backchannel RPC request that arrived over an existing
1300  * outbound connection
1301  */
1302 int
1303 bc_svc_process(struct svc_serv *serv, struct rpc_rqst *req,
1304                struct svc_rqst *rqstp)
1305 {
1306         struct kvec     *argv = &rqstp->rq_arg.head[0];
1307         struct kvec     *resv = &rqstp->rq_res.head[0];
1308
1309         /* Build the svc_rqst used by the common processing routine */
1310         rqstp->rq_xprt = serv->sv_bc_xprt;
1311         rqstp->rq_xid = req->rq_xid;
1312         rqstp->rq_prot = req->rq_xprt->prot;
1313         rqstp->rq_server = serv;
1314
1315         rqstp->rq_addrlen = sizeof(req->rq_xprt->addr);
1316         memcpy(&rqstp->rq_addr, &req->rq_xprt->addr, rqstp->rq_addrlen);
1317         memcpy(&rqstp->rq_arg, &req->rq_rcv_buf, sizeof(rqstp->rq_arg));
1318         memcpy(&rqstp->rq_res, &req->rq_snd_buf, sizeof(rqstp->rq_res));
1319
1320         /* reset result send buffer "put" position */
1321         resv->iov_len = 0;
1322
1323         if (rqstp->rq_prot != IPPROTO_TCP) {
1324                 printk(KERN_ERR "No support for Non-TCP transports!\n");
1325                 BUG();
1326         }
1327
1328         /*
1329          * Skip the next two words because they've already been
1330          * processed in the trasport
1331          */
1332         svc_getu32(argv);       /* XID */
1333         svc_getnl(argv);        /* CALLDIR */
1334
1335         /* Returns 1 for send, 0 for drop */
1336         if (svc_process_common(rqstp, argv, resv)) {
1337                 memcpy(&req->rq_snd_buf, &rqstp->rq_res,
1338                                                 sizeof(req->rq_snd_buf));
1339                 return bc_send(req);
1340         } else {
1341                 /* Nothing to do to drop request */
1342                 return 0;
1343         }
1344 }
1345 EXPORT_SYMBOL_GPL(bc_svc_process);
1346 #endif /* CONFIG_SUNRPC_BACKCHANNEL */
1347
1348 /*
1349  * Return (transport-specific) limit on the rpc payload.
1350  */
1351 u32 svc_max_payload(const struct svc_rqst *rqstp)
1352 {
1353         u32 max = rqstp->rq_xprt->xpt_class->xcl_max_payload;
1354
1355         if (rqstp->rq_server->sv_max_payload < max)
1356                 max = rqstp->rq_server->sv_max_payload;
1357         return max;
1358 }
1359 EXPORT_SYMBOL_GPL(svc_max_payload);