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