net/sunrpc/sched.c

   1 /*
   2  * linux/net/sunrpc/sched.c
   3  *
   4  * Scheduling for synchronous and asynchronous RPC requests.
   5  *
   6  * Copyright (C) 1996 Olaf Kirch, <okir@monad.swb.de>
   7  *
   8  * TCP NFS related read + write fixes
   9  * (C) 1999 Dave Airlie, University of Limerick, Ireland <airlied@linux.ie>
  10  */
  11
  12 #include <linux/module.h>
  13
  14 #include <linux/sched.h>
  15 #include <linux/interrupt.h>
  16 #include <linux/slab.h>
  17 #include <linux/mempool.h>
  18 #include <linux/smp.h>
  19 #include <linux/spinlock.h>
  20 #include <linux/mutex.h>
  21
  22 #include <linux/sunrpc/clnt.h>
  23
  24 #include "sunrpc.h"
  25
  26 #ifdef RPC_DEBUG
  27 #define RPCDBG_FACILITY         RPCDBG_SCHED
  28 #endif
  29
  30 /*
  31  * RPC slabs and memory pools
  32  */
  33 #define RPC_BUFFER_MAXSIZE      (2048)
  34 #define RPC_BUFFER_POOLSIZE     (8)
  35 #define RPC_TASK_POOLSIZE       (8)
  36 static struct kmem_cache        *rpc_task_slabp __read_mostly;
  37 static struct kmem_cache        *rpc_buffer_slabp __read_mostly;
  38 static mempool_t        *rpc_task_mempool __read_mostly;
  39 static mempool_t        *rpc_buffer_mempool __read_mostly;
  40
  41 static void                     rpc_async_schedule(struct work_struct *);
  42 static void                      rpc_release_task(struct rpc_task *task);
  43 static void __rpc_queue_timer_fn(unsigned long ptr);
  44
  45 /*
  46  * RPC tasks sit here while waiting for conditions to improve.
  47  */
  48 static struct rpc_wait_queue delay_queue;
  49
  50 /*
  51  * rpciod-related stuff
  52  */
  53 struct workqueue_struct *rpciod_workqueue;
  54
  55 /*
  56  * Disable the timer for a given RPC task. Should be called with
  57  * queue->lock and bh_disabled in order to avoid races within
  58  * rpc_run_timer().
  59  */
  60 static void
  61 __rpc_disable_timer(struct rpc_wait_queue *queue, struct rpc_task *task)
  62 {
  63         if (task->tk_timeout == 0)
  64                 return;
  65         dprintk("RPC: %5u disabling timer\n", task->tk_pid);
  66         task->tk_timeout = 0;
  67         list_del(&task->u.tk_wait.timer_list);
  68         if (list_empty(&queue->timer_list.list))
  69                 del_timer(&queue->timer_list.timer);
  70 }
  71
  72 static void
  73 rpc_set_queue_timer(struct rpc_wait_queue *queue, unsigned long expires)
  74 {
  75         queue->timer_list.expires = expires;
  76         mod_timer(&queue->timer_list.timer, expires);
  77 }
  78
  79 /*
  80  * Set up a timer for the current task.
  81  */
  82 static void
  83 __rpc_add_timer(struct rpc_wait_queue *queue, struct rpc_task *task)
  84 {
  85         if (!task->tk_timeout)
  86                 return;
  87
  88         dprintk("RPC: %5u setting alarm for %lu ms\n",
  89                         task->tk_pid, task->tk_timeout * 1000 / HZ);
  90
  91         task->u.tk_wait.expires = jiffies + task->tk_timeout;
  92         if (list_empty(&queue->timer_list.list) || time_before(task->u.tk_wait.expires, queue->timer_list.expires))
  93                 rpc_set_queue_timer(queue, task->u.tk_wait.expires);
  94         list_add(&task->u.tk_wait.timer_list, &queue->timer_list.list);
  95 }
  96
  97 /*
  98  * Add new request to a priority queue.
  99  */
 100 static void __rpc_add_wait_queue_priority(struct rpc_wait_queue *queue, struct rpc_task *task)
 101 {
 102         struct list_head *q;
 103         struct rpc_task *t;
 104
 105         INIT_LIST_HEAD(&task->u.tk_wait.links);
 106         q = &queue->tasks[task->tk_priority];
 107         if (unlikely(task->tk_priority > queue->maxpriority))
 108                 q = &queue->tasks[queue->maxpriority];
 109         list_for_each_entry(t, q, u.tk_wait.list) {
 110                 if (t->tk_owner == task->tk_owner) {
 111                         list_add_tail(&task->u.tk_wait.list, &t->u.tk_wait.links);
 112                         return;
 113                 }
 114         }
 115         list_add_tail(&task->u.tk_wait.list, q);
 116 }
 117
 118 /*
 119  * Add new request to wait queue.
 120  *
 121  * Swapper tasks always get inserted at the head of the queue.
 122  * This should avoid many nasty memory deadlocks and hopefully
 123  * improve overall performance.
 124  * Everyone else gets appended to the queue to ensure proper FIFO behavior.
 125  */
 126 static void __rpc_add_wait_queue(struct rpc_wait_queue *queue, struct rpc_task *task)
 127 {
 128         BUG_ON (RPC_IS_QUEUED(task));
 129
 130         if (RPC_IS_PRIORITY(queue))
 131                 __rpc_add_wait_queue_priority(queue, task);
 132         else if (RPC_IS_SWAPPER(task))
 133                 list_add(&task->u.tk_wait.list, &queue->tasks[0]);
 134         else
 135                 list_add_tail(&task->u.tk_wait.list, &queue->tasks[0]);
 136         task->tk_waitqueue = queue;
 137         queue->qlen++;
 138         rpc_set_queued(task);
 139
 140         dprintk("RPC: %5u added to queue %p \"%s\"\n",
 141                         task->tk_pid, queue, rpc_qname(queue));
 142 }
 143
 144 /*
 145  * Remove request from a priority queue.
 146  */
 147 static void __rpc_remove_wait_queue_priority(struct rpc_task *task)
 148 {
 149         struct rpc_task *t;
 150
 151         if (!list_empty(&task->u.tk_wait.links)) {
 152                 t = list_entry(task->u.tk_wait.links.next, struct rpc_task, u.tk_wait.list);
 153                 list_move(&t->u.tk_wait.list, &task->u.tk_wait.list);
 154                 list_splice_init(&task->u.tk_wait.links, &t->u.tk_wait.links);
 155         }
 156 }
 157
 158 /*
 159  * Remove request from queue.
 160  * Note: must be called with spin lock held.
 161  */
 162 static void __rpc_remove_wait_queue(struct rpc_wait_queue *queue, struct rpc_task *task)
 163 {
 164         __rpc_disable_timer(queue, task);
 165         if (RPC_IS_PRIORITY(queue))
 166                 __rpc_remove_wait_queue_priority(task);
 167         list_del(&task->u.tk_wait.list);
 168         queue->qlen--;
 169         dprintk("RPC: %5u removed from queue %p \"%s\"\n",
 170                         task->tk_pid, queue, rpc_qname(queue));
 171 }
 172
 173 static inline void rpc_set_waitqueue_priority(struct rpc_wait_queue *queue, int priority)
 174 {
 175         queue->priority = priority;
 176         queue->count = 1 << (priority * 2);
 177 }
 178
 179 static inline void rpc_set_waitqueue_owner(struct rpc_wait_queue *queue, pid_t pid)
 180 {
 181         queue->owner = pid;
 182         queue->nr = RPC_BATCH_COUNT;
 183 }
 184
 185 static inline void rpc_reset_waitqueue_priority(struct rpc_wait_queue *queue)
 186 {
 187         rpc_set_waitqueue_priority(queue, queue->maxpriority);
 188         rpc_set_waitqueue_owner(queue, 0);
 189 }
 190
 191 static void __rpc_init_priority_wait_queue(struct rpc_wait_queue *queue, const char *qname, unsigned char nr_queues)
 192 {
 193         int i;
 194
 195         spin_lock_init(&queue->lock);
 196         for (i = 0; i < ARRAY_SIZE(queue->tasks); i++)
 197                 INIT_LIST_HEAD(&queue->tasks[i]);
 198         queue->maxpriority = nr_queues - 1;
 199         rpc_reset_waitqueue_priority(queue);
 200         queue->qlen = 0;
 201         setup_timer(&queue->timer_list.timer, __rpc_queue_timer_fn, (unsigned long)queue);
 202         INIT_LIST_HEAD(&queue->timer_list.list);
 203 #ifdef RPC_DEBUG
 204         queue->name = qname;
 205 #endif
 206 }
 207
 208 void rpc_init_priority_wait_queue(struct rpc_wait_queue *queue, const char *qname)
 209 {
 210         __rpc_init_priority_wait_queue(queue, qname, RPC_NR_PRIORITY);
 211 }
 212 EXPORT_SYMBOL_GPL(rpc_init_priority_wait_queue);
 213
 214 void rpc_init_wait_queue(struct rpc_wait_queue *queue, const char *qname)
 215 {
 216         __rpc_init_priority_wait_queue(queue, qname, 1);
 217 }
 218 EXPORT_SYMBOL_GPL(rpc_init_wait_queue);
 219
 220 void rpc_destroy_wait_queue(struct rpc_wait_queue *queue)
 221 {
 222         del_timer_sync(&queue->timer_list.timer);
 223 }
 224 EXPORT_SYMBOL_GPL(rpc_destroy_wait_queue);
 225
 226 static int rpc_wait_bit_killable(void *word)
 227 {
 228         if (fatal_signal_pending(current))
 229                 return -ERESTARTSYS;
 230         schedule();
 231         return 0;
 232 }
 233
 234 #ifdef RPC_DEBUG
 235 static void rpc_task_set_debuginfo(struct rpc_task *task)
 236 {
 237         static atomic_t rpc_pid;
 238
 239         task->tk_pid = atomic_inc_return(&rpc_pid);
 240 }
 241 #else
 242 static inline void rpc_task_set_debuginfo(struct rpc_task *task)
 243 {
 244 }
 245 #endif
 246
 247 static void rpc_set_active(struct rpc_task *task)
 248 {
 249         struct rpc_clnt *clnt;
 250         if (test_and_set_bit(RPC_TASK_ACTIVE, &task->tk_runstate) != 0)
 251                 return;
 252         rpc_task_set_debuginfo(task);
 253         /* Add to global list of all tasks */
 254         clnt = task->tk_client;
 255         if (clnt != NULL) {
 256                 spin_lock(&clnt->cl_lock);
 257                 list_add_tail(&task->tk_task, &clnt->cl_tasks);
 258                 spin_unlock(&clnt->cl_lock);
 259         }
 260 }
 261
 262 /*
 263  * Mark an RPC call as having completed by clearing the 'active' bit
 264  */
 265 static void rpc_mark_complete_task(struct rpc_task *task)
 266 {
 267         smp_mb__before_clear_bit();
 268         clear_bit(RPC_TASK_ACTIVE, &task->tk_runstate);
 269         smp_mb__after_clear_bit();
 270         wake_up_bit(&task->tk_runstate, RPC_TASK_ACTIVE);
 271 }
 272
 273 /*
 274  * Allow callers to wait for completion of an RPC call
 275  */
 276 int __rpc_wait_for_completion_task(struct rpc_task *task, int (*action)(void *))
 277 {
 278         if (action == NULL)
 279                 action = rpc_wait_bit_killable;
 280         return wait_on_bit(&task->tk_runstate, RPC_TASK_ACTIVE,
 281                         action, TASK_KILLABLE);
 282 }
 283 EXPORT_SYMBOL_GPL(__rpc_wait_for_completion_task);
 284
 285 /*
 286  * Make an RPC task runnable.
 287  *
 288  * Note: If the task is ASYNC, this must be called with
 289  * the spinlock held to protect the wait queue operation.
 290  */
 291 static void rpc_make_runnable(struct rpc_task *task)
 292 {
 293         rpc_clear_queued(task);
 294         if (rpc_test_and_set_running(task))
 295                 return;
 296         if (RPC_IS_ASYNC(task)) {
 297                 int status;
 298
 299                 INIT_WORK(&task->u.tk_work, rpc_async_schedule);
 300                 status = queue_work(rpciod_workqueue, &task->u.tk_work);
 301                 if (status < 0) {
 302                         printk(KERN_WARNING "RPC: failed to add task to queue: error: %d!\n", status);
 303                         task->tk_status = status;
 304                         return;
 305                 }
 306         } else
 307                 wake_up_bit(&task->tk_runstate, RPC_TASK_QUEUED);
 308 }
 309
 310 /*
 311  * Prepare for sleeping on a wait queue.
 312  * By always appending tasks to the list we ensure FIFO behavior.
 313  * NB: An RPC task will only receive interrupt-driven events as long
 314  * as it's on a wait queue.
 315  */
 316 static void __rpc_sleep_on(struct rpc_wait_queue *q, struct rpc_task *task,
 317                         rpc_action action)
 318 {
 319         dprintk("RPC: %5u sleep_on(queue \"%s\" time %lu)\n",
 320                         task->tk_pid, rpc_qname(q), jiffies);
 321
 322         if (!RPC_IS_ASYNC(task) && !RPC_IS_ACTIVATED(task)) {
 323                 printk(KERN_ERR "RPC: Inactive synchronous task put to sleep!\n");
 324                 return;
 325         }
 326
 327         __rpc_add_wait_queue(q, task);
 328
 329         BUG_ON(task->tk_callback != NULL);
 330         task->tk_callback = action;
 331         __rpc_add_timer(q, task);
 332 }
 333
 334 void rpc_sleep_on(struct rpc_wait_queue *q, struct rpc_task *task,
 335                                 rpc_action action)
 336 {
 337         /* Mark the task as being activated if so needed */
 338         rpc_set_active(task);
 339
 340         /*
 341          * Protect the queue operations.
 342          */
 343         spin_lock_bh(&q->lock);
 344         __rpc_sleep_on(q, task, action);
 345         spin_unlock_bh(&q->lock);
 346 }
 347 EXPORT_SYMBOL_GPL(rpc_sleep_on);
 348
 349 /**
 350  * __rpc_do_wake_up_task - wake up a single rpc_task
 351  * @queue: wait queue
 352  * @task: task to be woken up
 353  *
 354  * Caller must hold queue->lock, and have cleared the task queued flag.
 355  */
 356 static void __rpc_do_wake_up_task(struct rpc_wait_queue *queue, struct rpc_task *task)
 357 {
 358         dprintk("RPC: %5u __rpc_wake_up_task (now %lu)\n",
 359                         task->tk_pid, jiffies);
 360
 361         /* Has the task been executed yet? If not, we cannot wake it up! */
 362         if (!RPC_IS_ACTIVATED(task)) {
 363                 printk(KERN_ERR "RPC: Inactive task (%p) being woken up!\n", task);
 364                 return;
 365         }
 366
 367         __rpc_remove_wait_queue(queue, task);
 368
 369         rpc_make_runnable(task);
 370
 371         dprintk("RPC:       __rpc_wake_up_task done\n");
 372 }
 373
 374 /*
 375  * Wake up a queued task while the queue lock is being held
 376  */
 377 static void rpc_wake_up_task_queue_locked(struct rpc_wait_queue *queue, struct rpc_task *task)
 378 {
 379         if (RPC_IS_QUEUED(task) && task->tk_waitqueue == queue)
 380                 __rpc_do_wake_up_task(queue, task);
 381 }
 382
 383 /*
 384  * Tests whether rpc queue is empty
 385  */
 386 int rpc_queue_empty(struct rpc_wait_queue *queue)
 387 {
 388         int res;
 389
 390         spin_lock_bh(&queue->lock);
 391         res = queue->qlen;
 392         spin_unlock_bh(&queue->lock);
 393         return (res == 0);
 394 }
 395 EXPORT_SYMBOL_GPL(rpc_queue_empty);
 396
 397 /*
 398  * Wake up a task on a specific queue
 399  */
 400 void rpc_wake_up_queued_task(struct rpc_wait_queue *queue, struct rpc_task *task)
 401 {
 402         spin_lock_bh(&queue->lock);
 403         rpc_wake_up_task_queue_locked(queue, task);
 404         spin_unlock_bh(&queue->lock);
 405 }
 406 EXPORT_SYMBOL_GPL(rpc_wake_up_queued_task);
 407
 408 /*
 409  * Wake up the specified task
 410  */
 411 static void rpc_wake_up_task(struct rpc_task *task)
 412 {
 413         rpc_wake_up_queued_task(task->tk_waitqueue, task);
 414 }
 415
 416 /*
 417  * Wake up the next task on a priority queue.
 418  */
 419 static struct rpc_task * __rpc_wake_up_next_priority(struct rpc_wait_queue *queue)
 420 {
 421         struct list_head *q;
 422         struct rpc_task *task;
 423
 424         /*
 425          * Service a batch of tasks from a single owner.
 426          */
 427         q = &queue->tasks[queue->priority];
 428         if (!list_empty(q)) {
 429                 task = list_entry(q->next, struct rpc_task, u.tk_wait.list);
 430                 if (queue->owner == task->tk_owner) {
 431                         if (--queue->nr)
 432                                 goto out;
 433                         list_move_tail(&task->u.tk_wait.list, q);
 434                 }
 435                 /*
 436                  * Check if we need to switch queues.
 437                  */
 438                 if (--queue->count)
 439                         goto new_owner;
 440         }
 441
 442         /*
 443          * Service the next queue.
 444          */
 445         do {
 446                 if (q == &queue->tasks[0])
 447                         q = &queue->tasks[queue->maxpriority];
 448                 else
 449                         q = q - 1;
 450                 if (!list_empty(q)) {
 451                         task = list_entry(q->next, struct rpc_task, u.tk_wait.list);
 452                         goto new_queue;
 453                 }
 454         } while (q != &queue->tasks[queue->priority]);
 455
 456         rpc_reset_waitqueue_priority(queue);
 457         return NULL;
 458
 459 new_queue:
 460         rpc_set_waitqueue_priority(queue, (unsigned int)(q - &queue->tasks[0]));
 461 new_owner:
 462         rpc_set_waitqueue_owner(queue, task->tk_owner);
 463 out:
 464         rpc_wake_up_task_queue_locked(queue, task);
 465         return task;
 466 }
 467
 468 /*
 469  * Wake up the next task on the wait queue.
 470  */
 471 struct rpc_task * rpc_wake_up_next(struct rpc_wait_queue *queue)
 472 {
 473         struct rpc_task *task = NULL;
 474
 475         dprintk("RPC:       wake_up_next(%p \"%s\")\n",
 476                         queue, rpc_qname(queue));
 477         spin_lock_bh(&queue->lock);
 478         if (RPC_IS_PRIORITY(queue))
 479                 task = __rpc_wake_up_next_priority(queue);
 480         else {
 481                 task_for_first(task, &queue->tasks[0])
 482                         rpc_wake_up_task_queue_locked(queue, task);
 483         }
 484         spin_unlock_bh(&queue->lock);
 485
 486         return task;
 487 }
 488 EXPORT_SYMBOL_GPL(rpc_wake_up_next);
 489
 490 /**
 491  * rpc_wake_up - wake up all rpc_tasks
 492  * @queue: rpc_wait_queue on which the tasks are sleeping
 493  *
 494  * Grabs queue->lock
 495  */
 496 void rpc_wake_up(struct rpc_wait_queue *queue)
 497 {
 498         struct rpc_task *task, *next;
 499         struct list_head *head;
 500
 501         spin_lock_bh(&queue->lock);
 502         head = &queue->tasks[queue->maxpriority];
 503         for (;;) {
 504                 list_for_each_entry_safe(task, next, head, u.tk_wait.list)
 505                         rpc_wake_up_task_queue_locked(queue, task);
 506                 if (head == &queue->tasks[0])
 507                         break;
 508                 head--;
 509         }
 510         spin_unlock_bh(&queue->lock);
 511 }
 512 EXPORT_SYMBOL_GPL(rpc_wake_up);
 513
 514 /**
 515  * rpc_wake_up_status - wake up all rpc_tasks and set their status value.
 516  * @queue: rpc_wait_queue on which the tasks are sleeping
 517  * @status: status value to set
 518  *
 519  * Grabs queue->lock
 520  */
 521 void rpc_wake_up_status(struct rpc_wait_queue *queue, int status)
 522 {
 523         struct rpc_task *task, *next;
 524         struct list_head *head;
 525
 526         spin_lock_bh(&queue->lock);
 527         head = &queue->tasks[queue->maxpriority];
 528         for (;;) {
 529                 list_for_each_entry_safe(task, next, head, u.tk_wait.list) {
 530                         task->tk_status = status;
 531                         rpc_wake_up_task_queue_locked(queue, task);
 532                 }
 533                 if (head == &queue->tasks[0])
 534                         break;
 535                 head--;
 536         }
 537         spin_unlock_bh(&queue->lock);
 538 }
 539 EXPORT_SYMBOL_GPL(rpc_wake_up_status);
 540
 541 static void __rpc_queue_timer_fn(unsigned long ptr)
 542 {
 543         struct rpc_wait_queue *queue = (struct rpc_wait_queue *)ptr;
 544         struct rpc_task *task, *n;
 545         unsigned long expires, now, timeo;
 546
 547         spin_lock(&queue->lock);
 548         expires = now = jiffies;
 549         list_for_each_entry_safe(task, n, &queue->timer_list.list, u.tk_wait.timer_list) {
 550                 timeo = task->u.tk_wait.expires;
 551                 if (time_after_eq(now, timeo)) {
 552                         dprintk("RPC: %5u timeout\n", task->tk_pid);
 553                         task->tk_status = -ETIMEDOUT;
 554                         rpc_wake_up_task_queue_locked(queue, task);
 555                         continue;
 556                 }
 557                 if (expires == now || time_after(expires, timeo))
 558                         expires = timeo;
 559         }
 560         if (!list_empty(&queue->timer_list.list))
 561                 rpc_set_queue_timer(queue, expires);
 562         spin_unlock(&queue->lock);
 563 }
 564
 565 static void __rpc_atrun(struct rpc_task *task)
 566 {
 567         task->tk_status = 0;
 568 }
 569
 570 /*
 571  * Run a task at a later time
 572  */
 573 void rpc_delay(struct rpc_task *task, unsigned long delay)
 574 {
 575         task->tk_timeout = delay;
 576         rpc_sleep_on(&delay_queue, task, __rpc_atrun);
 577 }
 578 EXPORT_SYMBOL_GPL(rpc_delay);
 579
 580 /*
 581  * Helper to call task->tk_ops->rpc_call_prepare
 582  */
 583 void rpc_prepare_task(struct rpc_task *task)
 584 {
 585         task->tk_ops->rpc_call_prepare(task, task->tk_calldata);
 586 }
 587
 588 /*
 589  * Helper that calls task->tk_ops->rpc_call_done if it exists
 590  */
 591 void rpc_exit_task(struct rpc_task *task)
 592 {
 593         task->tk_action = NULL;
 594         if (task->tk_ops->rpc_call_done != NULL) {
 595                 task->tk_ops->rpc_call_done(task, task->tk_calldata);
 596                 if (task->tk_action != NULL) {
 597                         WARN_ON(RPC_ASSASSINATED(task));
 598                         /* Always release the RPC slot and buffer memory */
 599                         xprt_release(task);
 600                 }
 601         }
 602 }
 603 EXPORT_SYMBOL_GPL(rpc_exit_task);
 604
 605 void rpc_release_calldata(const struct rpc_call_ops *ops, void *calldata)
 606 {
 607         if (ops->rpc_release != NULL)
 608                 ops->rpc_release(calldata);
 609 }
 610
 611 /*
 612  * This is the RPC `scheduler' (or rather, the finite state machine).
 613  */
 614 static void __rpc_execute(struct rpc_task *task)
 615 {
 616         struct rpc_wait_queue *queue;
 617         int task_is_async = RPC_IS_ASYNC(task);
 618         int status = 0;
 619
 620         dprintk("RPC: %5u __rpc_execute flags=0x%x\n",
 621                         task->tk_pid, task->tk_flags);
 622
 623         BUG_ON(RPC_IS_QUEUED(task));
 624
 625         for (;;) {
 626                 void (*do_action)(struct rpc_task *);
 627
 628                 /*
 629                  * Execute any pending callback first.
 630                  */
 631                 do_action = task->tk_callback;
 632                 task->tk_callback = NULL;
 633                 if (do_action == NULL) {
 634                         /*
 635                          * Perform the next FSM step.
 636                          * tk_action may be NULL if the task has been killed.
 637                          * In particular, note that rpc_killall_tasks may
 638                          * do this at any time, so beware when dereferencing.
 639                          */
 640                         do_action = task->tk_action;
 641                         if (do_action == NULL)
 642                                 break;
 643                 }
 644                 do_action(task);
 645
 646                 /*
 647                  * Lockless check for whether task is sleeping or not.
 648                  */
 649                 if (!RPC_IS_QUEUED(task))
 650                         continue;
 651                 /*
 652                  * The queue->lock protects against races with
 653                  * rpc_make_runnable().
 654                  *
 655                  * Note that once we clear RPC_TASK_RUNNING on an asynchronous
 656                  * rpc_task, rpc_make_runnable() can assign it to a
 657                  * different workqueue. We therefore cannot assume that the
 658                  * rpc_task pointer may still be dereferenced.
 659                  */
 660                 queue = task->tk_waitqueue;
 661                 spin_lock_bh(&queue->lock);
 662                 if (!RPC_IS_QUEUED(task)) {
 663                         spin_unlock_bh(&queue->lock);
 664                         continue;
 665                 }
 666                 rpc_clear_running(task);
 667                 spin_unlock_bh(&queue->lock);
 668                 if (task_is_async)
 669                         return;
 670
 671                 /* sync task: sleep here */
 672                 dprintk("RPC: %5u sync task going to sleep\n", task->tk_pid);
 673                 status = out_of_line_wait_on_bit(&task->tk_runstate,
 674                                 RPC_TASK_QUEUED, rpc_wait_bit_killable,
 675                                 TASK_KILLABLE);
 676                 if (status == -ERESTARTSYS) {
 677                         /*
 678                          * When a sync task receives a signal, it exits with
 679                          * -ERESTARTSYS. In order to catch any callbacks that
 680                          * clean up after sleeping on some queue, we don't
 681                          * break the loop here, but go around once more.
 682                          */
 683                         dprintk("RPC: %5u got signal\n", task->tk_pid);
 684                         task->tk_flags |= RPC_TASK_KILLED;
 685                         rpc_exit(task, -ERESTARTSYS);
 686                         rpc_wake_up_task(task);
 687                 }
 688                 rpc_set_running(task);
 689                 dprintk("RPC: %5u sync task resuming\n", task->tk_pid);
 690         }
 691
 692         dprintk("RPC: %5u return %d, status %d\n", task->tk_pid, status,
 693                         task->tk_status);
 694         /* Release all resources associated with the task */
 695         rpc_release_task(task);
 696 }
 697
 698 /*
 699  * User-visible entry point to the scheduler.
 700  *
 701  * This may be called recursively if e.g. an async NFS task updates
 702  * the attributes and finds that dirty pages must be flushed.
 703  * NOTE: Upon exit of this function the task is guaranteed to be
 704  *       released. In particular note that tk_release() will have
 705  *       been called, so your task memory may have been freed.
 706  */
 707 void rpc_execute(struct rpc_task *task)
 708 {
 709         rpc_set_active(task);
 710         rpc_set_running(task);
 711         __rpc_execute(task);
 712 }
 713
 714 static void rpc_async_schedule(struct work_struct *work)
 715 {
 716         __rpc_execute(container_of(work, struct rpc_task, u.tk_work));
 717 }
 718
 719 /**
 720  * rpc_malloc - allocate an RPC buffer
 721  * @task: RPC task that will use this buffer
 722  * @size: requested byte size
 723  *
 724  * To prevent rpciod from hanging, this allocator never sleeps,
 725  * returning NULL if the request cannot be serviced immediately.
 726  * The caller can arrange to sleep in a way that is safe for rpciod.
 727  *
 728  * Most requests are 'small' (under 2KiB) and can be serviced from a
 729  * mempool, ensuring that NFS reads and writes can always proceed,
 730  * and that there is good locality of reference for these buffers.
 731  *
 732  * In order to avoid memory starvation triggering more writebacks of
 733  * NFS requests, we avoid using GFP_KERNEL.
 734  */
 735 void *rpc_malloc(struct rpc_task *task, size_t size)
 736 {
 737         struct rpc_buffer *buf;
 738         gfp_t gfp = RPC_IS_SWAPPER(task) ? GFP_ATOMIC : GFP_NOWAIT;
 739
 740         size += sizeof(struct rpc_buffer);
 741         if (size <= RPC_BUFFER_MAXSIZE)
 742                 buf = mempool_alloc(rpc_buffer_mempool, gfp);
 743         else
 744                 buf = kmalloc(size, gfp);
 745
 746         if (!buf)
 747                 return NULL;
 748
 749         buf->len = size;
 750         dprintk("RPC: %5u allocated buffer of size %zu at %p\n",
 751                         task->tk_pid, size, buf);
 752         return &buf->data;
 753 }
 754 EXPORT_SYMBOL_GPL(rpc_malloc);
 755
 756 /**
 757  * rpc_free - free buffer allocated via rpc_malloc
 758  * @buffer: buffer to free
 759  *
 760  */
 761 void rpc_free(void *buffer)
 762 {
 763         size_t size;
 764         struct rpc_buffer *buf;
 765
 766         if (!buffer)
 767                 return;
 768
 769         buf = container_of(buffer, struct rpc_buffer, data);
 770         size = buf->len;
 771
 772         dprintk("RPC:       freeing buffer of size %zu at %p\n",
 773                         size, buf);
 774
 775         if (size <= RPC_BUFFER_MAXSIZE)
 776                 mempool_free(buf, rpc_buffer_mempool);
 777         else
 778                 kfree(buf);
 779 }
 780 EXPORT_SYMBOL_GPL(rpc_free);
 781
 782 /*
 783  * Creation and deletion of RPC task structures
 784  */
 785 static void rpc_init_task(struct rpc_task *task, const struct rpc_task_setup *task_setup_data)
 786 {
 787         memset(task, 0, sizeof(*task));
 788         atomic_set(&task->tk_count, 1);
 789         task->tk_flags  = task_setup_data->flags;
 790         task->tk_ops = task_setup_data->callback_ops;
 791         task->tk_calldata = task_setup_data->callback_data;
 792         INIT_LIST_HEAD(&task->tk_task);
 793
 794         /* Initialize retry counters */
 795         task->tk_garb_retry = 2;
 796         task->tk_cred_retry = 2;
 797
 798         task->tk_priority = task_setup_data->priority - RPC_PRIORITY_LOW;
 799         task->tk_owner = current->tgid;
 800
 801         /* Initialize workqueue for async tasks */
 802         task->tk_workqueue = task_setup_data->workqueue;
 803
 804         task->tk_client = task_setup_data->rpc_client;
 805         if (task->tk_client != NULL) {
 806                 kref_get(&task->tk_client->cl_kref);
 807                 if (task->tk_client->cl_softrtry)
 808                         task->tk_flags |= RPC_TASK_SOFT;
 809         }
 810
 811         if (task->tk_ops->rpc_call_prepare != NULL)
 812                 task->tk_action = rpc_prepare_task;
 813
 814         if (task_setup_data->rpc_message != NULL) {
 815                 task->tk_msg.rpc_proc = task_setup_data->rpc_message->rpc_proc;
 816                 task->tk_msg.rpc_argp = task_setup_data->rpc_message->rpc_argp;
 817                 task->tk_msg.rpc_resp = task_setup_data->rpc_message->rpc_resp;
 818                 /* Bind the user cred */
 819                 rpcauth_bindcred(task, task_setup_data->rpc_message->rpc_cred, task_setup_data->flags);
 820                 if (task->tk_action == NULL)
 821                         rpc_call_start(task);
 822         }
 823
 824         /* starting timestamp */
 825         task->tk_start = ktime_get();
 826
 827         dprintk("RPC:       new task initialized, procpid %u\n",
 828                                 task_pid_nr(current));
 829 }
 830
 831 static struct rpc_task *
 832 rpc_alloc_task(void)
 833 {
 834         return (struct rpc_task *)mempool_alloc(rpc_task_mempool, GFP_NOFS);
 835 }
 836
 837 /*
 838  * Create a new task for the specified client.
 839  */
 840 struct rpc_task *rpc_new_task(const struct rpc_task_setup *setup_data)
 841 {
 842         struct rpc_task *task = setup_data->task;
 843         unsigned short flags = 0;
 844
 845         if (task == NULL) {
 846                 task = rpc_alloc_task();
 847                 if (task == NULL) {
 848                         rpc_release_calldata(setup_data->callback_ops,
 849                                         setup_data->callback_data);
 850                         return ERR_PTR(-ENOMEM);
 851                 }
 852                 flags = RPC_TASK_DYNAMIC;
 853         }
 854
 855         rpc_init_task(task, setup_data);
 856         if (task->tk_status < 0) {
 857                 int err = task->tk_status;
 858                 rpc_put_task(task);
 859                 return ERR_PTR(err);
 860         }
 861
 862         task->tk_flags |= flags;
 863         dprintk("RPC:       allocated task %p\n", task);
 864         return task;
 865 }
 866
 867 static void rpc_free_task(struct rpc_task *task)
 868 {
 869         const struct rpc_call_ops *tk_ops = task->tk_ops;
 870         void *calldata = task->tk_calldata;
 871
 872         if (task->tk_flags & RPC_TASK_DYNAMIC) {
 873                 dprintk("RPC: %5u freeing task\n", task->tk_pid);
 874                 mempool_free(task, rpc_task_mempool);
 875         }
 876         rpc_release_calldata(tk_ops, calldata);
 877 }
 878
 879 static void rpc_async_release(struct work_struct *work)
 880 {
 881         rpc_free_task(container_of(work, struct rpc_task, u.tk_work));
 882 }
 883
 884 void rpc_put_task(struct rpc_task *task)
 885 {
 886         if (!atomic_dec_and_test(&task->tk_count))
 887                 return;
 888         /* Release resources */
 889         if (task->tk_rqstp)
 890                 xprt_release(task);
 891         if (task->tk_msg.rpc_cred)
 892                 rpcauth_unbindcred(task);
 893         if (task->tk_client) {
 894                 rpc_release_client(task->tk_client);
 895                 task->tk_client = NULL;
 896         }
 897         if (task->tk_workqueue != NULL) {
 898                 INIT_WORK(&task->u.tk_work, rpc_async_release);
 899                 queue_work(task->tk_workqueue, &task->u.tk_work);
 900         } else
 901                 rpc_free_task(task);
 902 }
 903 EXPORT_SYMBOL_GPL(rpc_put_task);
 904
 905 static void rpc_release_task(struct rpc_task *task)
 906 {
 907         dprintk("RPC: %5u release task\n", task->tk_pid);
 908
 909         if (!list_empty(&task->tk_task)) {
 910                 struct rpc_clnt *clnt = task->tk_client;
 911                 /* Remove from client task list */
 912                 spin_lock(&clnt->cl_lock);
 913                 list_del(&task->tk_task);
 914                 spin_unlock(&clnt->cl_lock);
 915         }
 916         BUG_ON (RPC_IS_QUEUED(task));
 917
 918         /* Wake up anyone who is waiting for task completion */
 919         rpc_mark_complete_task(task);
 920
 921         rpc_put_task(task);
 922 }
 923
 924 /*
 925  * Kill all tasks for the given client.
 926  * XXX: kill their descendants as well?
 927  */
 928 void rpc_killall_tasks(struct rpc_clnt *clnt)
 929 {
 930         struct rpc_task *rovr;
 931
 932
 933         if (list_empty(&clnt->cl_tasks))
 934                 return;
 935         dprintk("RPC:       killing all tasks for client %p\n", clnt);
 936         /*
 937          * Spin lock all_tasks to prevent changes...
 938          */
 939         spin_lock(&clnt->cl_lock);
 940         list_for_each_entry(rovr, &clnt->cl_tasks, tk_task) {
 941                 if (! RPC_IS_ACTIVATED(rovr))
 942                         continue;
 943                 if (!(rovr->tk_flags & RPC_TASK_KILLED)) {
 944                         rovr->tk_flags |= RPC_TASK_KILLED;
 945                         rpc_exit(rovr, -EIO);
 946                         rpc_wake_up_task(rovr);
 947                 }
 948         }
 949         spin_unlock(&clnt->cl_lock);
 950 }
 951 EXPORT_SYMBOL_GPL(rpc_killall_tasks);
 952
 953 int rpciod_up(void)
 954 {
 955         return try_module_get(THIS_MODULE) ? 0 : -EINVAL;
 956 }
 957
 958 void rpciod_down(void)
 959 {
 960         module_put(THIS_MODULE);
 961 }
 962
 963 /*
 964  * Start up the rpciod workqueue.
 965  */
 966 static int rpciod_start(void)
 967 {
 968         struct workqueue_struct *wq;
 969
 970         /*
 971          * Create the rpciod thread and wait for it to start.
 972          */
 973         dprintk("RPC:       creating workqueue rpciod\n");
 974         wq = create_workqueue("rpciod");
 975         rpciod_workqueue = wq;
 976         return rpciod_workqueue != NULL;
 977 }
 978
 979 static void rpciod_stop(void)
 980 {
 981         struct workqueue_struct *wq = NULL;
 982
 983         if (rpciod_workqueue == NULL)
 984                 return;
 985         dprintk("RPC:       destroying workqueue rpciod\n");
 986
 987         wq = rpciod_workqueue;
 988         rpciod_workqueue = NULL;
 989         destroy_workqueue(wq);
 990 }
 991
 992 void
 993 rpc_destroy_mempool(void)
 994 {
 995         rpciod_stop();
 996         if (rpc_buffer_mempool)
 997                 mempool_destroy(rpc_buffer_mempool);
 998         if (rpc_task_mempool)
 999                 mempool_destroy(rpc_task_mempool);
1000         if (rpc_task_slabp)
1001                 kmem_cache_destroy(rpc_task_slabp);
1002         if (rpc_buffer_slabp)
1003                 kmem_cache_destroy(rpc_buffer_slabp);
1004         rpc_destroy_wait_queue(&delay_queue);
1005 }
1006
1007 int
1008 rpc_init_mempool(void)
1009 {
1010         /*
1011          * The following is not strictly a mempool initialisation,
1012          * but there is no harm in doing it here
1013          */
1014         rpc_init_wait_queue(&delay_queue, "delayq");
1015         if (!rpciod_start())
1016                 goto err_nomem;
1017
1018         rpc_task_slabp = kmem_cache_create("rpc_tasks",
1019                                              sizeof(struct rpc_task),
1020                                              0, SLAB_HWCACHE_ALIGN,
1021                                              NULL);
1022         if (!rpc_task_slabp)
1023                 goto err_nomem;
1024         rpc_buffer_slabp = kmem_cache_create("rpc_buffers",
1025                                              RPC_BUFFER_MAXSIZE,
1026                                              0, SLAB_HWCACHE_ALIGN,
1027                                              NULL);
1028         if (!rpc_buffer_slabp)
1029                 goto err_nomem;
1030         rpc_task_mempool = mempool_create_slab_pool(RPC_TASK_POOLSIZE,
1031                                                     rpc_task_slabp);
1032         if (!rpc_task_mempool)
1033                 goto err_nomem;
1034         rpc_buffer_mempool = mempool_create_slab_pool(RPC_BUFFER_POOLSIZE,
1035                                                       rpc_buffer_slabp);
1036         if (!rpc_buffer_mempool)
1037                 goto err_nomem;
1038         return 0;
1039 err_nomem:
1040         rpc_destroy_mempool();
1041         return -ENOMEM;
1042 }