drivers/block/elevator.c

   1 /*
   2  *  linux/drivers/block/elevator.c
   3  *
   4  *  Block device elevator/IO-scheduler.
   5  *
   6  *  Copyright (C) 2000 Andrea Arcangeli <andrea@suse.de> SuSE
   7  *
   8  * 30042000 Jens Axboe <axboe@suse.de> :
   9  *
  10  * Split the elevator a bit so that it is possible to choose a different
  11  * one or even write a new "plug in". There are three pieces:
  12  * - elevator_fn, inserts a new request in the queue list
  13  * - elevator_merge_fn, decides whether a new buffer can be merged with
  14  *   an existing request
  15  * - elevator_dequeue_fn, called when a request is taken off the active list
  16  *
  17  * 20082000 Dave Jones <davej@suse.de> :
  18  * Removed tests for max-bomb-segments, which was breaking elvtune
  19  *  when run without -bN
  20  *
  21  * Jens:
  22  * - Rework again to work with bio instead of buffer_heads
  23  * - loose bi_dev comparisons, partition handling is right now
  24  * - completely modularize elevator setup and teardown
  25  *
  26  */
  27 #include <linux/kernel.h>
  28 #include <linux/fs.h>
  29 #include <linux/blkdev.h>
  30 #include <linux/elevator.h>
  31 #include <linux/bio.h>
  32 #include <linux/config.h>
  33 #include <linux/module.h>
  34 #include <linux/slab.h>
  35 #include <linux/init.h>
  36 #include <linux/compiler.h>
  37
  38 #include <asm/uaccess.h>
  39
  40 static spinlock_t elv_list_lock = SPIN_LOCK_UNLOCKED;
  41 static LIST_HEAD(elv_list);
  42
  43 /*
  44  * can we safely merge with this request?
  45  */
  46 inline int elv_rq_merge_ok(struct request *rq, struct bio *bio)
  47 {
  48         if (!rq_mergeable(rq))
  49                 return 0;
  50
  51         /*
  52          * different data direction or already started, don't merge
  53          */
  54         if (bio_data_dir(bio) != rq_data_dir(rq))
  55                 return 0;
  56
  57         /*
  58          * same device and no special stuff set, merge is ok
  59          */
  60         if (rq->rq_disk == bio->bi_bdev->bd_disk &&
  61             !rq->waiting && !rq->special)
  62                 return 1;
  63
  64         return 0;
  65 }
  66 EXPORT_SYMBOL(elv_rq_merge_ok);
  67
  68 inline int elv_try_merge(struct request *__rq, struct bio *bio)
  69 {
  70         int ret = ELEVATOR_NO_MERGE;
  71
  72         /*
  73          * we can merge and sequence is ok, check if it's possible
  74          */
  75         if (elv_rq_merge_ok(__rq, bio)) {
  76                 if (__rq->sector + __rq->nr_sectors == bio->bi_sector)
  77                         ret = ELEVATOR_BACK_MERGE;
  78                 else if (__rq->sector - bio_sectors(bio) == bio->bi_sector)
  79                         ret = ELEVATOR_FRONT_MERGE;
  80         }
  81
  82         return ret;
  83 }
  84 EXPORT_SYMBOL(elv_try_merge);
  85
  86 inline int elv_try_last_merge(request_queue_t *q, struct bio *bio)
  87 {
  88         if (q->last_merge)
  89                 return elv_try_merge(q->last_merge, bio);
  90
  91         return ELEVATOR_NO_MERGE;
  92 }
  93 EXPORT_SYMBOL(elv_try_last_merge);
  94
  95 struct elevator_type *elevator_find(const char *name)
  96 {
  97         struct elevator_type *e = NULL;
  98         struct list_head *entry;
  99
 100         spin_lock_irq(&elv_list_lock);
 101         list_for_each(entry, &elv_list) {
 102                 struct elevator_type *__e;
 103
 104                 __e = list_entry(entry, struct elevator_type, list);
 105
 106                 if (!strcmp(__e->elevator_name, name)) {
 107                         e = __e;
 108                         break;
 109                 }
 110         }
 111         spin_unlock_irq(&elv_list_lock);
 112
 113         return e;
 114 }
 115
 116 static void elevator_put(struct elevator_type *e)
 117 {
 118         module_put(e->elevator_owner);
 119 }
 120
 121 static struct elevator_type *elevator_get(const char *name)
 122 {
 123         struct elevator_type *e = elevator_find(name);
 124
 125         if (!e)
 126                 return NULL;
 127         if (!try_module_get(e->elevator_owner))
 128                 return NULL;
 129
 130         return e;
 131 }
 132
 133 static int elevator_attach(request_queue_t *q, struct elevator_type *e,
 134                            struct elevator_queue *eq)
 135 {
 136         int ret = 0;
 137
 138         memset(eq, 0, sizeof(*eq));
 139         eq->ops = &e->ops;
 140         eq->elevator_type = e;
 141
 142         INIT_LIST_HEAD(&q->queue_head);
 143         q->last_merge = NULL;
 144         q->elevator = eq;
 145
 146         if (eq->ops->elevator_init_fn)
 147                 ret = eq->ops->elevator_init_fn(q, eq);
 148
 149         return ret;
 150 }
 151
 152 static char chosen_elevator[16];
 153
 154 static void elevator_setup_default(void)
 155 {
 156         /*
 157          * check if default is set and exists
 158          */
 159         if (chosen_elevator[0] && elevator_find(chosen_elevator))
 160                 return;
 161
 162 #if defined(CONFIG_IOSCHED_AS)
 163         strcpy(chosen_elevator, "anticipatory");
 164 #elif defined(CONFIG_IOSCHED_DEADLINE)
 165         strcpy(chosen_elevator, "deadline");
 166 #elif defined(CONFIG_IOSCHED_CFQ)
 167         strcpy(chosen_elevator, "cfq");
 168 #elif defined(CONFIG_IOSCHED_NOOP)
 169         strcpy(chosen_elevator, "noop");
 170 #else
 171 #error "You must build at least 1 IO scheduler into the kernel"
 172 #endif
 173         printk(KERN_INFO "elevator: using %s as default io scheduler\n",
 174                                                         chosen_elevator);
 175 }
 176
 177 static int __init elevator_setup(char *str)
 178 {
 179         strncpy(chosen_elevator, str, sizeof(chosen_elevator) - 1);
 180         return 0;
 181 }
 182
 183 __setup("elevator=", elevator_setup);
 184
 185 int elevator_init(request_queue_t *q, char *name)
 186 {
 187         struct elevator_type *e = NULL;
 188         struct elevator_queue *eq;
 189         int ret = 0;
 190
 191         elevator_setup_default();
 192
 193         if (!name)
 194                 name = chosen_elevator;
 195
 196         e = elevator_get(name);
 197         if (!e)
 198                 return -EINVAL;
 199
 200         eq = kmalloc(sizeof(struct elevator_queue), GFP_KERNEL);
 201         if (!eq) {
 202                 elevator_put(e->elevator_type);
 203                 return -ENOMEM;
 204         }
 205
 206         ret = elevator_attach(q, e, eq);
 207         if (ret) {
 208                 kfree(eq);
 209                 elevator_put(e->elevator_type);
 210         }
 211
 212         return ret;
 213 }
 214
 215 void elevator_exit(elevator_t *e)
 216 {
 217         if (e->ops->elevator_exit_fn)
 218                 e->ops->elevator_exit_fn(e);
 219
 220         elevator_put(e->elevator_type);
 221         e->elevator_type = NULL;
 222         kfree(e);
 223 }
 224
 225 int elevator_global_init(void)
 226 {
 227         return 0;
 228 }
 229
 230 int elv_merge(request_queue_t *q, struct request **req, struct bio *bio)
 231 {
 232         elevator_t *e = q->elevator;
 233
 234         if (e->ops->elevator_merge_fn)
 235                 return e->ops->elevator_merge_fn(q, req, bio);
 236
 237         return ELEVATOR_NO_MERGE;
 238 }
 239
 240 void elv_merged_request(request_queue_t *q, struct request *rq)
 241 {
 242         elevator_t *e = q->elevator;
 243
 244         if (e->ops->elevator_merged_fn)
 245                 e->ops->elevator_merged_fn(q, rq);
 246 }
 247
 248 void elv_merge_requests(request_queue_t *q, struct request *rq,
 249                              struct request *next)
 250 {
 251         elevator_t *e = q->elevator;
 252
 253         if (q->last_merge == next)
 254                 q->last_merge = NULL;
 255
 256         if (e->ops->elevator_merge_req_fn)
 257                 e->ops->elevator_merge_req_fn(q, rq, next);
 258 }
 259
 260 void elv_requeue_request(request_queue_t *q, struct request *rq)
 261 {
 262         /*
 263          * it already went through dequeue, we need to decrement the
 264          * in_flight count again
 265          */
 266         if (blk_account_rq(rq))
 267                 q->in_flight--;
 268
 269         /*
 270          * if iosched has an explicit requeue hook, then use that. otherwise
 271          * just put the request at the front of the queue
 272          */
 273         if (q->elevator->ops->elevator_requeue_req_fn)
 274                 q->elevator->ops->elevator_requeue_req_fn(q, rq);
 275         else
 276                 __elv_add_request(q, rq, ELEVATOR_INSERT_FRONT, 0);
 277 }
 278
 279 void __elv_add_request(request_queue_t *q, struct request *rq, int where,
 280                        int plug)
 281 {
 282         /*
 283          * barriers implicitly indicate back insertion
 284          */
 285         if (rq->flags & (REQ_SOFTBARRIER | REQ_HARDBARRIER) &&
 286             where == ELEVATOR_INSERT_SORT)
 287                 where = ELEVATOR_INSERT_BACK;
 288
 289         if (plug)
 290                 blk_plug_device(q);
 291
 292         rq->q = q;
 293
 294         if (!test_bit(QUEUE_FLAG_DRAIN, &q->queue_flags)) {
 295                 q->elevator->ops->elevator_add_req_fn(q, rq, where);
 296
 297                 if (blk_queue_plugged(q)) {
 298                         int nrq = q->rq.count[READ] + q->rq.count[WRITE]
 299                                   - q->in_flight;
 300
 301                         if (nrq == q->unplug_thresh)
 302                                 __generic_unplug_device(q);
 303                 }
 304         } else
 305                 /*
 306                  * if drain is set, store the request "locally". when the drain
 307                  * is finished, the requests will be handed ordered to the io
 308                  * scheduler
 309                  */
 310                 list_add_tail(&rq->queuelist, &q->drain_list);
 311 }
 312
 313 void elv_add_request(request_queue_t *q, struct request *rq, int where,
 314                      int plug)
 315 {
 316         unsigned long flags;
 317
 318         spin_lock_irqsave(q->queue_lock, flags);
 319         __elv_add_request(q, rq, where, plug);
 320         spin_unlock_irqrestore(q->queue_lock, flags);
 321 }
 322
 323 static inline struct request *__elv_next_request(request_queue_t *q)
 324 {
 325         return q->elevator->ops->elevator_next_req_fn(q);
 326 }
 327
 328 struct request *elv_next_request(request_queue_t *q)
 329 {
 330         struct request *rq;
 331         int ret;
 332
 333         while ((rq = __elv_next_request(q)) != NULL) {
 334                 /*
 335                  * just mark as started even if we don't start it, a request
 336                  * that has been delayed should not be passed by new incoming
 337                  * requests
 338                  */
 339                 rq->flags |= REQ_STARTED;
 340
 341                 if (rq == q->last_merge)
 342                         q->last_merge = NULL;
 343
 344                 if ((rq->flags & REQ_DONTPREP) || !q->prep_rq_fn)
 345                         break;
 346
 347                 ret = q->prep_rq_fn(q, rq);
 348                 if (ret == BLKPREP_OK) {
 349                         break;
 350                 } else if (ret == BLKPREP_DEFER) {
 351                         rq = NULL;
 352                         break;
 353                 } else if (ret == BLKPREP_KILL) {
 354                         int nr_bytes = rq->hard_nr_sectors << 9;
 355
 356                         if (!nr_bytes)
 357                                 nr_bytes = rq->data_len;
 358
 359                         blkdev_dequeue_request(rq);
 360                         rq->flags |= REQ_QUIET;
 361                         end_that_request_chunk(rq, 0, nr_bytes);
 362                         end_that_request_last(rq);
 363                 } else {
 364                         printk(KERN_ERR "%s: bad return=%d\n", __FUNCTION__,
 365                                                                 ret);
 366                         break;
 367                 }
 368         }
 369
 370         return rq;
 371 }
 372
 373 void elv_remove_request(request_queue_t *q, struct request *rq)
 374 {
 375         elevator_t *e = q->elevator;
 376
 377         /*
 378          * the time frame between a request being removed from the lists
 379          * and to it is freed is accounted as io that is in progress at
 380          * the driver side. note that we only account requests that the
 381          * driver has seen (REQ_STARTED set), to avoid false accounting
 382          * for request-request merges
 383          */
 384         if (blk_account_rq(rq))
 385                 q->in_flight++;
 386
 387         /*
 388          * the main clearing point for q->last_merge is on retrieval of
 389          * request by driver (it calls elv_next_request()), but it _can_
 390          * also happen here if a request is added to the queue but later
 391          * deleted without ever being given to driver (merged with another
 392          * request).
 393          */
 394         if (rq == q->last_merge)
 395                 q->last_merge = NULL;
 396
 397         if (e->ops->elevator_remove_req_fn)
 398                 e->ops->elevator_remove_req_fn(q, rq);
 399 }
 400
 401 int elv_queue_empty(request_queue_t *q)
 402 {
 403         elevator_t *e = q->elevator;
 404
 405         if (e->ops->elevator_queue_empty_fn)
 406                 return e->ops->elevator_queue_empty_fn(q);
 407
 408         return list_empty(&q->queue_head);
 409 }
 410
 411 struct request *elv_latter_request(request_queue_t *q, struct request *rq)
 412 {
 413         struct list_head *next;
 414
 415         elevator_t *e = q->elevator;
 416
 417         if (e->ops->elevator_latter_req_fn)
 418                 return e->ops->elevator_latter_req_fn(q, rq);
 419
 420         next = rq->queuelist.next;
 421         if (next != &q->queue_head && next != &rq->queuelist)
 422                 return list_entry_rq(next);
 423
 424         return NULL;
 425 }
 426
 427 struct request *elv_former_request(request_queue_t *q, struct request *rq)
 428 {
 429         struct list_head *prev;
 430
 431         elevator_t *e = q->elevator;
 432
 433         if (e->ops->elevator_former_req_fn)
 434                 return e->ops->elevator_former_req_fn(q, rq);
 435
 436         prev = rq->queuelist.prev;
 437         if (prev != &q->queue_head && prev != &rq->queuelist)
 438                 return list_entry_rq(prev);
 439
 440         return NULL;
 441 }
 442
 443 int elv_set_request(request_queue_t *q, struct request *rq, int gfp_mask)
 444 {
 445         elevator_t *e = q->elevator;
 446
 447         if (e->ops->elevator_set_req_fn)
 448                 return e->ops->elevator_set_req_fn(q, rq, gfp_mask);
 449
 450         rq->elevator_private = NULL;
 451         return 0;
 452 }
 453
 454 void elv_put_request(request_queue_t *q, struct request *rq)
 455 {
 456         elevator_t *e = q->elevator;
 457
 458         if (e->ops->elevator_put_req_fn)
 459                 e->ops->elevator_put_req_fn(q, rq);
 460 }
 461
 462 int elv_may_queue(request_queue_t *q, int rw)
 463 {
 464         elevator_t *e = q->elevator;
 465
 466         if (e->ops->elevator_may_queue_fn)
 467                 return e->ops->elevator_may_queue_fn(q, rw);
 468
 469         return ELV_MQUEUE_MAY;
 470 }
 471
 472 void elv_completed_request(request_queue_t *q, struct request *rq)
 473 {
 474         elevator_t *e = q->elevator;
 475
 476         /*
 477          * request is released from the driver, io must be done
 478          */
 479         if (blk_account_rq(rq))
 480                 q->in_flight--;
 481
 482         if (e->ops->elevator_completed_req_fn)
 483                 e->ops->elevator_completed_req_fn(q, rq);
 484 }
 485
 486 int elv_register_queue(struct request_queue *q)
 487 {
 488         elevator_t *e = q->elevator;
 489
 490         e->kobj.parent = kobject_get(&q->kobj);
 491         if (!e->kobj.parent)
 492                 return -EBUSY;
 493
 494         snprintf(e->kobj.name, KOBJ_NAME_LEN, "%s", "iosched");
 495         e->kobj.ktype = e->elevator_type->elevator_ktype;
 496
 497         return kobject_register(&e->kobj);
 498 }
 499
 500 void elv_unregister_queue(struct request_queue *q)
 501 {
 502         if (q) {
 503                 elevator_t *e = q->elevator;
 504                 kobject_unregister(&e->kobj);
 505                 kobject_put(&q->kobj);
 506         }
 507 }
 508
 509 int elv_register(struct elevator_type *e)
 510 {
 511         if (elevator_find(e->elevator_name))
 512                 BUG();
 513
 514         spin_lock_irq(&elv_list_lock);
 515         list_add_tail(&e->list, &elv_list);
 516         spin_unlock_irq(&elv_list_lock);
 517
 518         printk(KERN_INFO "io scheduler %s registered\n", e->elevator_name);
 519         return 0;
 520 }
 521 EXPORT_SYMBOL_GPL(elv_register);
 522
 523 void elv_unregister(struct elevator_type *e)
 524 {
 525         spin_lock_irq(&elv_list_lock);
 526         list_del_init(&e->list);
 527         spin_unlock_irq(&elv_list_lock);
 528 }
 529 EXPORT_SYMBOL_GPL(elv_unregister);
 530
 531 /*
 532  * switch to new_e io scheduler. be careful not to introduce deadlocks -
 533  * we don't free the old io scheduler, before we have allocated what we
 534  * need for the new one. this way we have a chance of going back to the old
 535  * one, if the new one fails init for some reason. we also do an intermediate
 536  * switch to noop to ensure safety with stack-allocated requests, since they
 537  * don't originate from the block layer allocator. noop is safe here, because
 538  * it never needs to touch the elevator itself for completion events. DRAIN
 539  * flags will make sure we don't touch it for additions either.
 540  */
 541 static void elevator_switch(request_queue_t *q, struct elevator_type *new_e)
 542 {
 543         elevator_t *e = kmalloc(sizeof(elevator_t), GFP_KERNEL);
 544         struct elevator_type *noop_elevator = NULL;
 545         elevator_t *old_elevator;
 546
 547         if (!e)
 548                 goto error;
 549
 550         /*
 551          * first step, drain requests from the block freelist
 552          */
 553         blk_wait_queue_drained(q, 0);
 554
 555         /*
 556          * unregister old elevator data
 557          */
 558         elv_unregister_queue(q);
 559         old_elevator = q->elevator;
 560
 561         /*
 562          * next step, switch to noop since it uses no private rq structures
 563          * and doesn't allocate any memory for anything. then wait for any
 564          * non-fs requests in-flight
 565          */
 566         noop_elevator = elevator_get("noop");
 567         spin_lock_irq(q->queue_lock);
 568         elevator_attach(q, noop_elevator, e);
 569         spin_unlock_irq(q->queue_lock);
 570
 571         blk_wait_queue_drained(q, 1);
 572
 573         /*
 574          * attach and start new elevator
 575          */
 576         if (elevator_attach(q, new_e, e))
 577                 goto fail;
 578
 579         if (elv_register_queue(q))
 580                 goto fail_register;
 581
 582         /*
 583          * finally exit old elevator and start queue again
 584          */
 585         elevator_exit(old_elevator);
 586         blk_finish_queue_drain(q);
 587         elevator_put(noop_elevator);
 588         return;
 589
 590 fail_register:
 591         /*
 592          * switch failed, exit the new io scheduler and reattach the old
 593          * one again (along with re-adding the sysfs dir)
 594          */
 595         elevator_exit(e);
 596 fail:
 597         q->elevator = old_elevator;
 598         elv_register_queue(q);
 599         blk_finish_queue_drain(q);
 600 error:
 601         if (noop_elevator)
 602                 elevator_put(noop_elevator);
 603         elevator_put(new_e);
 604         printk(KERN_ERR "elevator: switch to %s failed\n",new_e->elevator_name);
 605 }
 606
 607 ssize_t elv_iosched_store(request_queue_t *q, const char *name, size_t count)
 608 {
 609         char elevator_name[ELV_NAME_MAX];
 610         struct elevator_type *e;
 611
 612         memset(elevator_name, 0, sizeof(elevator_name));
 613         strncpy(elevator_name, name, sizeof(elevator_name));
 614
 615         if (elevator_name[strlen(elevator_name) - 1] == '\n')
 616                 elevator_name[strlen(elevator_name) - 1] = '\0';
 617
 618         e = elevator_get(elevator_name);
 619         if (!e) {
 620                 printk(KERN_ERR "elevator: type %s not found\n", elevator_name);
 621                 return -EINVAL;
 622         }
 623
 624         if (!strcmp(elevator_name, q->elevator->elevator_type->elevator_name))
 625                 return count;
 626
 627         elevator_switch(q, e);
 628         return count;
 629 }
 630
 631 ssize_t elv_iosched_show(request_queue_t *q, char *name)
 632 {
 633         elevator_t *e = q->elevator;
 634         struct elevator_type *elv = e->elevator_type;
 635         struct list_head *entry;
 636         int len = 0;
 637
 638         spin_lock_irq(q->queue_lock);
 639         list_for_each(entry, &elv_list) {
 640                 struct elevator_type *__e;
 641
 642                 __e = list_entry(entry, struct elevator_type, list);
 643                 if (!strcmp(elv->elevator_name, __e->elevator_name))
 644                         len += sprintf(name+len, "[%s] ", elv->elevator_name);
 645                 else
 646                         len += sprintf(name+len, "%s ", __e->elevator_name);
 647         }
 648         spin_unlock_irq(q->queue_lock);
 649
 650         len += sprintf(len+name, "\n");
 651         return len;
 652 }
 653
 654 module_init(elevator_global_init);
 655
 656 EXPORT_SYMBOL(elv_add_request);
 657 EXPORT_SYMBOL(__elv_add_request);
 658 EXPORT_SYMBOL(elv_requeue_request);
 659 EXPORT_SYMBOL(elv_next_request);
 660 EXPORT_SYMBOL(elv_remove_request);
 661 EXPORT_SYMBOL(elv_queue_empty);
 662 EXPORT_SYMBOL(elv_completed_request);
 663 EXPORT_SYMBOL(elevator_exit);
 664 EXPORT_SYMBOL(elevator_init);