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