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         /* Remove any stale portmap registrations */
 458         svc_unregister(serv);
 459
 460         return serv;
 461 }
 462
 463 struct svc_serv *
 464 svc_create(struct svc_program *prog, unsigned int bufsize,
 465            void (*shutdown)(struct svc_serv *serv))
 466 {
 467         return __svc_create(prog, bufsize, /*npools*/1, shutdown);
 468 }
 469 EXPORT_SYMBOL_GPL(svc_create);
 470
 471 struct svc_serv *
 472 svc_create_pooled(struct svc_program *prog, unsigned int bufsize,
 473                   void (*shutdown)(struct svc_serv *serv),
 474                   svc_thread_fn func, struct module *mod)
 475 {
 476         struct svc_serv *serv;
 477         unsigned int npools = svc_pool_map_get();
 478
 479         serv = __svc_create(prog, bufsize, npools, shutdown);
 480
 481         if (serv != NULL) {
 482                 serv->sv_function = func;
 483                 serv->sv_module = mod;
 484         }
 485
 486         return serv;
 487 }
 488 EXPORT_SYMBOL_GPL(svc_create_pooled);
 489
 490 /*
 491  * Destroy an RPC service. Should be called with appropriate locking to
 492  * protect the sv_nrthreads, sv_permsocks and sv_tempsocks.
 493  */
 494 void
 495 svc_destroy(struct svc_serv *serv)
 496 {
 497         dprintk("svc: svc_destroy(%s, %d)\n",
 498                                 serv->sv_program->pg_name,
 499                                 serv->sv_nrthreads);
 500
 501         if (serv->sv_nrthreads) {
 502                 if (--(serv->sv_nrthreads) != 0) {
 503                         svc_sock_update_bufs(serv);
 504                         return;
 505                 }
 506         } else
 507                 printk("svc_destroy: no threads for serv=%p!\n", serv);
 508
 509         del_timer_sync(&serv->sv_temptimer);
 510
 511         svc_close_all(&serv->sv_tempsocks);
 512
 513         if (serv->sv_shutdown)
 514                 serv->sv_shutdown(serv);
 515
 516         svc_close_all(&serv->sv_permsocks);
 517
 518         BUG_ON(!list_empty(&serv->sv_permsocks));
 519         BUG_ON(!list_empty(&serv->sv_tempsocks));
 520
 521         cache_clean_deferred(serv);
 522
 523         if (svc_serv_is_pooled(serv))
 524                 svc_pool_map_put();
 525
 526         svc_unregister(serv);
 527         kfree(serv->sv_pools);
 528         kfree(serv);
 529 }
 530 EXPORT_SYMBOL_GPL(svc_destroy);
 531
 532 /*
 533  * Allocate an RPC server's buffer space.
 534  * We allocate pages and place them in rq_argpages.
 535  */
 536 static int
 537 svc_init_buffer(struct svc_rqst *rqstp, unsigned int size)
 538 {
 539         unsigned int pages, arghi;
 540
 541         /* bc_xprt uses fore channel allocated buffers */
 542         if (svc_is_backchannel(rqstp))
 543                 return 1;
 544
 545         pages = size / PAGE_SIZE + 1; /* extra page as we hold both request and reply.
 546                                        * We assume one is at most one page
 547                                        */
 548         arghi = 0;
 549         BUG_ON(pages > RPCSVC_MAXPAGES);
 550         while (pages) {
 551                 struct page *p = alloc_page(GFP_KERNEL);
 552                 if (!p)
 553                         break;
 554                 rqstp->rq_pages[arghi++] = p;
 555                 pages--;
 556         }
 557         return pages == 0;
 558 }
 559
 560 /*
 561  * Release an RPC server buffer
 562  */
 563 static void
 564 svc_release_buffer(struct svc_rqst *rqstp)
 565 {
 566         unsigned int i;
 567
 568         for (i = 0; i < ARRAY_SIZE(rqstp->rq_pages); i++)
 569                 if (rqstp->rq_pages[i])
 570                         put_page(rqstp->rq_pages[i]);
 571 }
 572
 573 struct svc_rqst *
 574 svc_prepare_thread(struct svc_serv *serv, struct svc_pool *pool)
 575 {
 576         struct svc_rqst *rqstp;
 577
 578         rqstp = kzalloc(sizeof(*rqstp), GFP_KERNEL);
 579         if (!rqstp)
 580                 goto out_enomem;
 581
 582         init_waitqueue_head(&rqstp->rq_wait);
 583
 584         serv->sv_nrthreads++;
 585         spin_lock_bh(&pool->sp_lock);
 586         pool->sp_nrthreads++;
 587         list_add(&rqstp->rq_all, &pool->sp_all_threads);
 588         spin_unlock_bh(&pool->sp_lock);
 589         rqstp->rq_server = serv;
 590         rqstp->rq_pool = pool;
 591
 592         rqstp->rq_argp = kmalloc(serv->sv_xdrsize, GFP_KERNEL);
 593         if (!rqstp->rq_argp)
 594                 goto out_thread;
 595
 596         rqstp->rq_resp = kmalloc(serv->sv_xdrsize, GFP_KERNEL);
 597         if (!rqstp->rq_resp)
 598                 goto out_thread;
 599
 600         if (!svc_init_buffer(rqstp, serv->sv_max_mesg))
 601                 goto out_thread;
 602
 603         return rqstp;
 604 out_thread:
 605         svc_exit_thread(rqstp);
 606 out_enomem:
 607         return ERR_PTR(-ENOMEM);
 608 }
 609 EXPORT_SYMBOL_GPL(svc_prepare_thread);
 610
 611 /*
 612  * Choose a pool in which to create a new thread, for svc_set_num_threads
 613  */
 614 static inline struct svc_pool *
 615 choose_pool(struct svc_serv *serv, struct svc_pool *pool, unsigned int *state)
 616 {
 617         if (pool != NULL)
 618                 return pool;
 619
 620         return &serv->sv_pools[(*state)++ % serv->sv_nrpools];
 621 }
 622
 623 /*
 624  * Choose a thread to kill, for svc_set_num_threads
 625  */
 626 static inline struct task_struct *
 627 choose_victim(struct svc_serv *serv, struct svc_pool *pool, unsigned int *state)
 628 {
 629         unsigned int i;
 630         struct task_struct *task = NULL;
 631
 632         if (pool != NULL) {
 633                 spin_lock_bh(&pool->sp_lock);
 634         } else {
 635                 /* choose a pool in round-robin fashion */
 636                 for (i = 0; i < serv->sv_nrpools; i++) {
 637                         pool = &serv->sv_pools[--(*state) % serv->sv_nrpools];
 638                         spin_lock_bh(&pool->sp_lock);
 639                         if (!list_empty(&pool->sp_all_threads))
 640                                 goto found_pool;
 641                         spin_unlock_bh(&pool->sp_lock);
 642                 }
 643                 return NULL;
 644         }
 645
 646 found_pool:
 647         if (!list_empty(&pool->sp_all_threads)) {
 648                 struct svc_rqst *rqstp;
 649
 650                 /*
 651                  * Remove from the pool->sp_all_threads list
 652                  * so we don't try to kill it again.
 653                  */
 654                 rqstp = list_entry(pool->sp_all_threads.next, struct svc_rqst, rq_all);
 655                 list_del_init(&rqstp->rq_all);
 656                 task = rqstp->rq_task;
 657         }
 658         spin_unlock_bh(&pool->sp_lock);
 659
 660         return task;
 661 }
 662
 663 /*
 664  * Create or destroy enough new threads to make the number
 665  * of threads the given number.  If `pool' is non-NULL, applies
 666  * only to threads in that pool, otherwise round-robins between
 667  * all pools.  Must be called with a svc_get() reference and
 668  * the BKL or another lock to protect access to svc_serv fields.
 669  *
 670  * Destroying threads relies on the service threads filling in
 671  * rqstp->rq_task, which only the nfs ones do.  Assumes the serv
 672  * has been created using svc_create_pooled().
 673  *
 674  * Based on code that used to be in nfsd_svc() but tweaked
 675  * to be pool-aware.
 676  */
 677 int
 678 svc_set_num_threads(struct svc_serv *serv, struct svc_pool *pool, int nrservs)
 679 {
 680         struct svc_rqst *rqstp;
 681         struct task_struct *task;
 682         struct svc_pool *chosen_pool;
 683         int error = 0;
 684         unsigned int state = serv->sv_nrthreads-1;
 685
 686         if (pool == NULL) {
 687                 /* The -1 assumes caller has done a svc_get() */
 688                 nrservs -= (serv->sv_nrthreads-1);
 689         } else {
 690                 spin_lock_bh(&pool->sp_lock);
 691                 nrservs -= pool->sp_nrthreads;
 692                 spin_unlock_bh(&pool->sp_lock);
 693         }
 694
 695         /* create new threads */
 696         while (nrservs > 0) {
 697                 nrservs--;
 698                 chosen_pool = choose_pool(serv, pool, &state);
 699
 700                 rqstp = svc_prepare_thread(serv, chosen_pool);
 701                 if (IS_ERR(rqstp)) {
 702                         error = PTR_ERR(rqstp);
 703                         break;
 704                 }
 705
 706                 __module_get(serv->sv_module);
 707                 task = kthread_create(serv->sv_function, rqstp, serv->sv_name);
 708                 if (IS_ERR(task)) {
 709                         error = PTR_ERR(task);
 710                         module_put(serv->sv_module);
 711                         svc_exit_thread(rqstp);
 712                         break;
 713                 }
 714
 715                 rqstp->rq_task = task;
 716                 if (serv->sv_nrpools > 1)
 717                         svc_pool_map_set_cpumask(task, chosen_pool->sp_id);
 718
 719                 svc_sock_update_bufs(serv);
 720                 wake_up_process(task);
 721         }
 722         /* destroy old threads */
 723         while (nrservs < 0 &&
 724                (task = choose_victim(serv, pool, &state)) != NULL) {
 725                 send_sig(SIGINT, task, 1);
 726                 nrservs++;
 727         }
 728
 729         return error;
 730 }
 731 EXPORT_SYMBOL_GPL(svc_set_num_threads);
 732
 733 /*
 734  * Called from a server thread as it's exiting. Caller must hold the BKL or
 735  * the "service mutex", whichever is appropriate for the service.
 736  */
 737 void
 738 svc_exit_thread(struct svc_rqst *rqstp)
 739 {
 740         struct svc_serv *serv = rqstp->rq_server;
 741         struct svc_pool *pool = rqstp->rq_pool;
 742
 743         svc_release_buffer(rqstp);
 744         kfree(rqstp->rq_resp);
 745         kfree(rqstp->rq_argp);
 746         kfree(rqstp->rq_auth_data);
 747
 748         spin_lock_bh(&pool->sp_lock);
 749         pool->sp_nrthreads--;
 750         list_del(&rqstp->rq_all);
 751         spin_unlock_bh(&pool->sp_lock);
 752
 753         kfree(rqstp);
 754
 755         /* Release the server */
 756         if (serv)
 757                 svc_destroy(serv);
 758 }
 759 EXPORT_SYMBOL_GPL(svc_exit_thread);
 760
 761 /*
 762  * Register an "inet" protocol family netid with the local
 763  * rpcbind daemon via an rpcbind v4 SET request.
 764  *
 765  * No netconfig infrastructure is available in the kernel, so
 766  * we map IP_ protocol numbers to netids by hand.
 767  *
 768  * Returns zero on success; a negative errno value is returned
 769  * if any error occurs.
 770  */
 771 static int __svc_rpcb_register4(const u32 program, const u32 version,
 772                                 const unsigned short protocol,
 773                                 const unsigned short port)
 774 {
 775         const struct sockaddr_in sin = {
 776                 .sin_family             = AF_INET,
 777                 .sin_addr.s_addr        = htonl(INADDR_ANY),
 778                 .sin_port               = htons(port),
 779         };
 780         const char *netid;
 781         int error;
 782
 783         switch (protocol) {
 784         case IPPROTO_UDP:
 785                 netid = RPCBIND_NETID_UDP;
 786                 break;
 787         case IPPROTO_TCP:
 788                 netid = RPCBIND_NETID_TCP;
 789                 break;
 790         default:
 791                 return -ENOPROTOOPT;
 792         }
 793
 794         error = rpcb_v4_register(program, version,
 795                                         (const struct sockaddr *)&sin, netid);
 796
 797         /*
 798          * User space didn't support rpcbind v4, so retry this
 799          * registration request with the legacy rpcbind v2 protocol.
 800          */
 801         if (error == -EPROTONOSUPPORT)
 802                 error = rpcb_register(program, version, protocol, port);
 803
 804         return error;
 805 }
 806
 807 #if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
 808 /*
 809  * Register an "inet6" protocol family netid with the local
 810  * rpcbind daemon via an rpcbind v4 SET request.
 811  *
 812  * No netconfig infrastructure is available in the kernel, so
 813  * we map IP_ protocol numbers to netids by hand.
 814  *
 815  * Returns zero on success; a negative errno value is returned
 816  * if any error occurs.
 817  */
 818 static int __svc_rpcb_register6(const u32 program, const u32 version,
 819                                 const unsigned short protocol,
 820                                 const unsigned short port)
 821 {
 822         const struct sockaddr_in6 sin6 = {
 823                 .sin6_family            = AF_INET6,
 824                 .sin6_addr              = IN6ADDR_ANY_INIT,
 825                 .sin6_port              = htons(port),
 826         };
 827         const char *netid;
 828         int error;
 829
 830         switch (protocol) {
 831         case IPPROTO_UDP:
 832                 netid = RPCBIND_NETID_UDP6;
 833                 break;
 834         case IPPROTO_TCP:
 835                 netid = RPCBIND_NETID_TCP6;
 836                 break;
 837         default:
 838                 return -ENOPROTOOPT;
 839         }
 840
 841         error = rpcb_v4_register(program, version,
 842                                         (const struct sockaddr *)&sin6, netid);
 843
 844         /*
 845          * User space didn't support rpcbind version 4, so we won't
 846          * use a PF_INET6 listener.
 847          */
 848         if (error == -EPROTONOSUPPORT)
 849                 error = -EAFNOSUPPORT;
 850
 851         return error;
 852 }
 853 #endif  /* defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE) */
 854
 855 /*
 856  * Register a kernel RPC service via rpcbind version 4.
 857  *
 858  * Returns zero on success; a negative errno value is returned
 859  * if any error occurs.
 860  */
 861 static int __svc_register(const char *progname,
 862                           const u32 program, const u32 version,
 863                           const int family,
 864                           const unsigned short protocol,
 865                           const unsigned short port)
 866 {
 867         int error = -EAFNOSUPPORT;
 868
 869         switch (family) {
 870         case PF_INET:
 871                 error = __svc_rpcb_register4(program, version,
 872                                                 protocol, port);
 873                 break;
 874 #if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
 875         case PF_INET6:
 876                 error = __svc_rpcb_register6(program, version,
 877                                                 protocol, port);
 878 #endif  /* defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE) */
 879         }
 880
 881         if (error < 0)
 882                 printk(KERN_WARNING "svc: failed to register %sv%u RPC "
 883                         "service (errno %d).\n", progname, version, -error);
 884         return error;
 885 }
 886
 887 /**
 888  * svc_register - register an RPC service with the local portmapper
 889  * @serv: svc_serv struct for the service to register
 890  * @family: protocol family of service's listener socket
 891  * @proto: transport protocol number to advertise
 892  * @port: port to advertise
 893  *
 894  * Service is registered for any address in the passed-in protocol family
 895  */
 896 int svc_register(const struct svc_serv *serv, const int family,
 897                  const unsigned short proto, const unsigned short port)
 898 {
 899         struct svc_program      *progp;
 900         unsigned int            i;
 901         int                     error = 0;
 902
 903         BUG_ON(proto == 0 && port == 0);
 904
 905         for (progp = serv->sv_program; progp; progp = progp->pg_next) {
 906                 for (i = 0; i < progp->pg_nvers; i++) {
 907                         if (progp->pg_vers[i] == NULL)
 908                                 continue;
 909
 910                         dprintk("svc: svc_register(%sv%d, %s, %u, %u)%s\n",
 911                                         progp->pg_name,
 912                                         i,
 913                                         proto == IPPROTO_UDP?  "udp" : "tcp",
 914                                         port,
 915                                         family,
 916                                         progp->pg_vers[i]->vs_hidden?
 917                                                 " (but not telling portmap)" : "");
 918
 919                         if (progp->pg_vers[i]->vs_hidden)
 920                                 continue;
 921
 922                         error = __svc_register(progp->pg_name, progp->pg_prog,
 923                                                 i, family, proto, port);
 924                         if (error < 0)
 925                                 break;
 926                 }
 927         }
 928
 929         return error;
 930 }
 931
 932 /*
 933  * If user space is running rpcbind, it should take the v4 UNSET
 934  * and clear everything for this [program, version].  If user space
 935  * is running portmap, it will reject the v4 UNSET, but won't have
 936  * any "inet6" entries anyway.  So a PMAP_UNSET should be sufficient
 937  * in this case to clear all existing entries for [program, version].
 938  */
 939 static void __svc_unregister(const u32 program, const u32 version,
 940                              const char *progname)
 941 {
 942         int error;
 943
 944         error = rpcb_v4_register(program, version, NULL, "");
 945
 946         /*
 947          * User space didn't support rpcbind v4, so retry this
 948          * request with the legacy rpcbind v2 protocol.
 949          */
 950         if (error == -EPROTONOSUPPORT)
 951                 error = rpcb_register(program, version, 0, 0);
 952
 953         dprintk("svc: %s(%sv%u), error %d\n",
 954                         __func__, progname, version, error);
 955 }
 956
 957 /*
 958  * All netids, bind addresses and ports registered for [program, version]
 959  * are removed from the local rpcbind database (if the service is not
 960  * hidden) to make way for a new instance of the service.
 961  *
 962  * The result of unregistration is reported via dprintk for those who want
 963  * verification of the result, but is otherwise not important.
 964  */
 965 static void svc_unregister(const struct svc_serv *serv)
 966 {
 967         struct svc_program *progp;
 968         unsigned long flags;
 969         unsigned int i;
 970
 971         clear_thread_flag(TIF_SIGPENDING);
 972
 973         for (progp = serv->sv_program; progp; progp = progp->pg_next) {
 974                 for (i = 0; i < progp->pg_nvers; i++) {
 975                         if (progp->pg_vers[i] == NULL)
 976                                 continue;
 977                         if (progp->pg_vers[i]->vs_hidden)
 978                                 continue;
 979
 980                         dprintk("svc: attempting to unregister %sv%u\n",
 981                                 progp->pg_name, i);
 982                         __svc_unregister(progp->pg_prog, i, progp->pg_name);
 983                 }
 984         }
 985
 986         spin_lock_irqsave(&current->sighand->siglock, flags);
 987         recalc_sigpending();
 988         spin_unlock_irqrestore(&current->sighand->siglock, flags);
 989 }
 990
 991 /*
 992  * Printk the given error with the address of the client that caused it.
 993  */
 994 static int
 995 __attribute__ ((format (printf, 2, 3)))
 996 svc_printk(struct svc_rqst *rqstp, const char *fmt, ...)
 997 {
 998         va_list args;
 999         int     r;
1000         char    buf[RPC_MAX_ADDRBUFLEN];
1001
1002         if (!net_ratelimit())
1003                 return 0;
1004
1005         printk(KERN_WARNING "svc: %s: ",
1006                 svc_print_addr(rqstp, buf, sizeof(buf)));
1007
1008         va_start(args, fmt);
1009         r = vprintk(fmt, args);
1010         va_end(args);
1011
1012         return r;
1013 }
1014
1015 /*
1016  * Common routine for processing the RPC request.
1017  */
1018 static int
1019 svc_process_common(struct svc_rqst *rqstp, struct kvec *argv, struct kvec *resv)
1020 {
1021         struct svc_program      *progp;
1022         struct svc_version      *versp = NULL;  /* compiler food */
1023         struct svc_procedure    *procp = NULL;
1024         struct svc_serv         *serv = rqstp->rq_server;
1025         kxdrproc_t              xdr;
1026         __be32                  *statp;
1027         u32                     prog, vers, proc;
1028         __be32                  auth_stat, rpc_stat;
1029         int                     auth_res;
1030         __be32                  *reply_statp;
1031
1032         rpc_stat = rpc_success;
1033
1034         if (argv->iov_len < 6*4)
1035                 goto err_short_len;
1036
1037         /* Will be turned off only in gss privacy case: */
1038         rqstp->rq_splice_ok = 1;
1039         /* Will be turned off only when NFSv4 Sessions are used */
1040         rqstp->rq_usedeferral = 1;
1041         rqstp->rq_dropme = false;
1042
1043         /* Setup reply header */
1044         rqstp->rq_xprt->xpt_ops->xpo_prep_reply_hdr(rqstp);
1045
1046         svc_putu32(resv, rqstp->rq_xid);
1047
1048         vers = svc_getnl(argv);
1049
1050         /* First words of reply: */
1051         svc_putnl(resv, 1);             /* REPLY */
1052
1053         if (vers != 2)          /* RPC version number */
1054                 goto err_bad_rpc;
1055
1056         /* Save position in case we later decide to reject: */
1057         reply_statp = resv->iov_base + resv->iov_len;
1058
1059         svc_putnl(resv, 0);             /* ACCEPT */
1060
1061         rqstp->rq_prog = prog = svc_getnl(argv);        /* program number */
1062         rqstp->rq_vers = vers = svc_getnl(argv);        /* version number */
1063         rqstp->rq_proc = proc = svc_getnl(argv);        /* procedure number */
1064
1065         progp = serv->sv_program;
1066
1067         for (progp = serv->sv_program; progp; progp = progp->pg_next)
1068                 if (prog == progp->pg_prog)
1069                         break;
1070
1071         /*
1072          * Decode auth data, and add verifier to reply buffer.
1073          * We do this before anything else in order to get a decent
1074          * auth verifier.
1075          */
1076         auth_res = svc_authenticate(rqstp, &auth_stat);
1077         /* Also give the program a chance to reject this call: */
1078         if (auth_res == SVC_OK && progp) {
1079                 auth_stat = rpc_autherr_badcred;
1080                 auth_res = progp->pg_authenticate(rqstp);
1081         }
1082         switch (auth_res) {
1083         case SVC_OK:
1084                 break;
1085         case SVC_GARBAGE:
1086                 goto err_garbage;
1087         case SVC_SYSERR:
1088                 rpc_stat = rpc_system_err;
1089                 goto err_bad;
1090         case SVC_DENIED:
1091                 goto err_bad_auth;
1092         case SVC_CLOSE:
1093                 if (test_bit(XPT_TEMP, &rqstp->rq_xprt->xpt_flags))
1094                         svc_close_xprt(rqstp->rq_xprt);
1095         case SVC_DROP:
1096                 goto dropit;
1097         case SVC_COMPLETE:
1098                 goto sendit;
1099         }
1100
1101         if (progp == NULL)
1102                 goto err_bad_prog;
1103
1104         if (vers >= progp->pg_nvers ||
1105           !(versp = progp->pg_vers[vers]))
1106                 goto err_bad_vers;
1107
1108         procp = versp->vs_proc + proc;
1109         if (proc >= versp->vs_nproc || !procp->pc_func)
1110                 goto err_bad_proc;
1111         rqstp->rq_procinfo = procp;
1112
1113         /* Syntactic check complete */
1114         serv->sv_stats->rpccnt++;
1115
1116         /* Build the reply header. */
1117         statp = resv->iov_base +resv->iov_len;
1118         svc_putnl(resv, RPC_SUCCESS);
1119
1120         /* Bump per-procedure stats counter */
1121         procp->pc_count++;
1122
1123         /* Initialize storage for argp and resp */
1124         memset(rqstp->rq_argp, 0, procp->pc_argsize);
1125         memset(rqstp->rq_resp, 0, procp->pc_ressize);
1126
1127         /* un-reserve some of the out-queue now that we have a
1128          * better idea of reply size
1129          */
1130         if (procp->pc_xdrressize)
1131                 svc_reserve_auth(rqstp, procp->pc_xdrressize<<2);
1132
1133         /* Call the function that processes the request. */
1134         if (!versp->vs_dispatch) {
1135                 /* Decode arguments */
1136                 xdr = procp->pc_decode;
1137                 if (xdr && !xdr(rqstp, argv->iov_base, rqstp->rq_argp))
1138                         goto err_garbage;
1139
1140                 *statp = procp->pc_func(rqstp, rqstp->rq_argp, rqstp->rq_resp);
1141
1142                 /* Encode reply */
1143                 if (rqstp->rq_dropme) {
1144                         if (procp->pc_release)
1145                                 procp->pc_release(rqstp, NULL, rqstp->rq_resp);
1146                         goto dropit;
1147                 }
1148                 if (*statp == rpc_success &&
1149                     (xdr = procp->pc_encode) &&
1150                     !xdr(rqstp, resv->iov_base+resv->iov_len, rqstp->rq_resp)) {
1151                         dprintk("svc: failed to encode reply\n");
1152                         /* serv->sv_stats->rpcsystemerr++; */
1153                         *statp = rpc_system_err;
1154                 }
1155         } else {
1156                 dprintk("svc: calling dispatcher\n");
1157                 if (!versp->vs_dispatch(rqstp, statp)) {
1158                         /* Release reply info */
1159                         if (procp->pc_release)
1160                                 procp->pc_release(rqstp, NULL, rqstp->rq_resp);
1161                         goto dropit;
1162                 }
1163         }
1164
1165         /* Check RPC status result */
1166         if (*statp != rpc_success)
1167                 resv->iov_len = ((void*)statp)  - resv->iov_base + 4;
1168
1169         /* Release reply info */
1170         if (procp->pc_release)
1171                 procp->pc_release(rqstp, NULL, rqstp->rq_resp);
1172
1173         if (procp->pc_encode == NULL)
1174                 goto dropit;
1175
1176  sendit:
1177         if (svc_authorise(rqstp))
1178                 goto dropit;
1179         return 1;               /* Caller can now send it */
1180
1181  dropit:
1182         svc_authorise(rqstp);   /* doesn't hurt to call this twice */
1183         dprintk("svc: svc_process dropit\n");
1184         return 0;
1185
1186 err_short_len:
1187         svc_printk(rqstp, "short len %Zd, dropping request\n",
1188                         argv->iov_len);
1189
1190         goto dropit;                    /* drop request */
1191
1192 err_bad_rpc:
1193         serv->sv_stats->rpcbadfmt++;
1194         svc_putnl(resv, 1);     /* REJECT */
1195         svc_putnl(resv, 0);     /* RPC_MISMATCH */
1196         svc_putnl(resv, 2);     /* Only RPCv2 supported */
1197         svc_putnl(resv, 2);
1198         goto sendit;
1199
1200 err_bad_auth:
1201         dprintk("svc: authentication failed (%d)\n", ntohl(auth_stat));
1202         serv->sv_stats->rpcbadauth++;
1203         /* Restore write pointer to location of accept status: */
1204         xdr_ressize_check(rqstp, reply_statp);
1205         svc_putnl(resv, 1);     /* REJECT */
1206         svc_putnl(resv, 1);     /* AUTH_ERROR */
1207         svc_putnl(resv, ntohl(auth_stat));      /* status */
1208         goto sendit;
1209
1210 err_bad_prog:
1211         dprintk("svc: unknown program %d\n", prog);
1212         serv->sv_stats->rpcbadfmt++;
1213         svc_putnl(resv, RPC_PROG_UNAVAIL);
1214         goto sendit;
1215
1216 err_bad_vers:
1217         svc_printk(rqstp, "unknown version (%d for prog %d, %s)\n",
1218                        vers, prog, progp->pg_name);
1219
1220         serv->sv_stats->rpcbadfmt++;
1221         svc_putnl(resv, RPC_PROG_MISMATCH);
1222         svc_putnl(resv, progp->pg_lovers);
1223         svc_putnl(resv, progp->pg_hivers);
1224         goto sendit;
1225
1226 err_bad_proc:
1227         svc_printk(rqstp, "unknown procedure (%d)\n", proc);
1228
1229         serv->sv_stats->rpcbadfmt++;
1230         svc_putnl(resv, RPC_PROC_UNAVAIL);
1231         goto sendit;
1232
1233 err_garbage:
1234         svc_printk(rqstp, "failed to decode args\n");
1235
1236         rpc_stat = rpc_garbage_args;
1237 err_bad:
1238         serv->sv_stats->rpcbadfmt++;
1239         svc_putnl(resv, ntohl(rpc_stat));
1240         goto sendit;
1241 }
1242 EXPORT_SYMBOL_GPL(svc_process);
1243
1244 /*
1245  * Process the RPC request.
1246  */
1247 int
1248 svc_process(struct svc_rqst *rqstp)
1249 {
1250         struct kvec             *argv = &rqstp->rq_arg.head[0];
1251         struct kvec             *resv = &rqstp->rq_res.head[0];
1252         struct svc_serv         *serv = rqstp->rq_server;
1253         u32                     dir;
1254
1255         /*
1256          * Setup response xdr_buf.
1257          * Initially it has just one page
1258          */
1259         rqstp->rq_resused = 1;
1260         resv->iov_base = page_address(rqstp->rq_respages[0]);
1261         resv->iov_len = 0;
1262         rqstp->rq_res.pages = rqstp->rq_respages + 1;
1263         rqstp->rq_res.len = 0;
1264         rqstp->rq_res.page_base = 0;
1265         rqstp->rq_res.page_len = 0;
1266         rqstp->rq_res.buflen = PAGE_SIZE;
1267         rqstp->rq_res.tail[0].iov_base = NULL;
1268         rqstp->rq_res.tail[0].iov_len = 0;
1269
1270         rqstp->rq_xid = svc_getu32(argv);
1271
1272         dir  = svc_getnl(argv);
1273         if (dir != 0) {
1274                 /* direction != CALL */
1275                 svc_printk(rqstp, "bad direction %d, dropping request\n", dir);
1276                 serv->sv_stats->rpcbadfmt++;
1277                 svc_drop(rqstp);
1278                 return 0;
1279         }
1280
1281         /* Returns 1 for send, 0 for drop */
1282         if (svc_process_common(rqstp, argv, resv))
1283                 return svc_send(rqstp);
1284         else {
1285                 svc_drop(rqstp);
1286                 return 0;
1287         }
1288 }
1289
1290 #if defined(CONFIG_SUNRPC_BACKCHANNEL)
1291 /*
1292  * Process a backchannel RPC request that arrived over an existing
1293  * outbound connection
1294  */
1295 int
1296 bc_svc_process(struct svc_serv *serv, struct rpc_rqst *req,
1297                struct svc_rqst *rqstp)
1298 {
1299         struct kvec     *argv = &rqstp->rq_arg.head[0];
1300         struct kvec     *resv = &rqstp->rq_res.head[0];
1301
1302         /* Build the svc_rqst used by the common processing routine */
1303         rqstp->rq_xprt = serv->sv_bc_xprt;
1304         rqstp->rq_xid = req->rq_xid;
1305         rqstp->rq_prot = req->rq_xprt->prot;
1306         rqstp->rq_server = serv;
1307
1308         rqstp->rq_addrlen = sizeof(req->rq_xprt->addr);
1309         memcpy(&rqstp->rq_addr, &req->rq_xprt->addr, rqstp->rq_addrlen);
1310         memcpy(&rqstp->rq_arg, &req->rq_rcv_buf, sizeof(rqstp->rq_arg));
1311         memcpy(&rqstp->rq_res, &req->rq_snd_buf, sizeof(rqstp->rq_res));
1312
1313         /* reset result send buffer "put" position */
1314         resv->iov_len = 0;
1315
1316         if (rqstp->rq_prot != IPPROTO_TCP) {
1317                 printk(KERN_ERR "No support for Non-TCP transports!\n");
1318                 BUG();
1319         }
1320
1321         /*
1322          * Skip the next two words because they've already been
1323          * processed in the trasport
1324          */
1325         svc_getu32(argv);       /* XID */
1326         svc_getnl(argv);        /* CALLDIR */
1327
1328         /* Returns 1 for send, 0 for drop */
1329         if (svc_process_common(rqstp, argv, resv)) {
1330                 memcpy(&req->rq_snd_buf, &rqstp->rq_res,
1331                                                 sizeof(req->rq_snd_buf));
1332                 return bc_send(req);
1333         } else {
1334                 /* Nothing to do to drop request */
1335                 return 0;
1336         }
1337 }
1338 EXPORT_SYMBOL_GPL(bc_svc_process);
1339 #endif /* CONFIG_SUNRPC_BACKCHANNEL */
1340
1341 /*
1342  * Return (transport-specific) limit on the rpc payload.
1343  */
1344 u32 svc_max_payload(const struct svc_rqst *rqstp)
1345 {
1346         u32 max = rqstp->rq_xprt->xpt_class->xcl_max_payload;
1347
1348         if (rqstp->rq_server->sv_max_payload < max)
1349                 max = rqstp->rq_server->sv_max_payload;
1350         return max;
1351 }
1352 EXPORT_SYMBOL_GPL(svc_max_payload);