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 /*
  41  * can we safely merge with this request?
  42  */
  43 inline int elv_rq_merge_ok(struct request *rq, struct bio *bio)
  44 {
  45         if (!rq_mergeable(rq))
  46                 return 0;
  47
  48         /*
  49          * different data direction or already started, don't merge
  50          */
  51         if (bio_data_dir(bio) != rq_data_dir(rq))
  52                 return 0;
  53
  54         /*
  55          * same device and no special stuff set, merge is ok
  56          */
  57         if (rq->rq_disk == bio->bi_bdev->bd_disk &&
  58             !rq->waiting && !rq->special)
  59                 return 1;
  60
  61         return 0;
  62 }
  63
  64 inline int elv_try_merge(struct request *__rq, struct bio *bio)
  65 {
  66         int ret = ELEVATOR_NO_MERGE;
  67
  68         /*
  69          * we can merge and sequence is ok, check if it's possible
  70          */
  71         if (elv_rq_merge_ok(__rq, bio)) {
  72                 if (__rq->sector + __rq->nr_sectors == bio->bi_sector)
  73                         ret = ELEVATOR_BACK_MERGE;
  74                 else if (__rq->sector - bio_sectors(bio) == bio->bi_sector)
  75                         ret = ELEVATOR_FRONT_MERGE;
  76         }
  77
  78         return ret;
  79 }
  80
  81 inline int elv_try_last_merge(request_queue_t *q, struct bio *bio)
  82 {
  83         if (q->last_merge)
  84                 return elv_try_merge(q->last_merge, bio);
  85
  86         return ELEVATOR_NO_MERGE;
  87 }
  88
  89 /*
  90  * general block -> elevator interface starts here
  91  */
  92 int elevator_init(request_queue_t *q, elevator_t *type)
  93 {
  94         elevator_t *e = &q->elevator;
  95
  96         memcpy(e, type, sizeof(*e));
  97
  98         INIT_LIST_HEAD(&q->queue_head);
  99         q->last_merge = NULL;
 100
 101         if (e->elevator_init_fn)
 102                 return e->elevator_init_fn(q, e);
 103
 104         return 0;
 105 }
 106
 107 void elevator_exit(request_queue_t *q)
 108 {
 109         elevator_t *e = &q->elevator;
 110
 111         if (e->elevator_exit_fn)
 112                 e->elevator_exit_fn(q, e);
 113 }
 114
 115 int elevator_global_init(void)
 116 {
 117         return 0;
 118 }
 119
 120 int elv_merge(request_queue_t *q, struct request **req, struct bio *bio)
 121 {
 122         elevator_t *e = &q->elevator;
 123
 124         if (e->elevator_merge_fn)
 125                 return e->elevator_merge_fn(q, req, bio);
 126
 127         return ELEVATOR_NO_MERGE;
 128 }
 129
 130 void elv_merged_request(request_queue_t *q, struct request *rq)
 131 {
 132         elevator_t *e = &q->elevator;
 133
 134         if (e->elevator_merged_fn)
 135                 e->elevator_merged_fn(q, rq);
 136 }
 137
 138 void elv_merge_requests(request_queue_t *q, struct request *rq,
 139                              struct request *next)
 140 {
 141         elevator_t *e = &q->elevator;
 142
 143         if (q->last_merge == next)
 144                 q->last_merge = NULL;
 145
 146         if (e->elevator_merge_req_fn)
 147                 e->elevator_merge_req_fn(q, rq, next);
 148 }
 149
 150 void elv_requeue_request(request_queue_t *q, struct request *rq)
 151 {
 152         /*
 153          * it already went through dequeue, we need to decrement the
 154          * in_flight count again
 155          */
 156         if (blk_account_rq(rq))
 157                 q->in_flight--;
 158
 159         /*
 160          * if iosched has an explicit requeue hook, then use that. otherwise
 161          * just put the request at the front of the queue
 162          */
 163         if (q->elevator.elevator_requeue_req_fn)
 164                 q->elevator.elevator_requeue_req_fn(q, rq);
 165         else
 166                 __elv_add_request(q, rq, ELEVATOR_INSERT_FRONT, 0);
 167 }
 168
 169 void __elv_add_request(request_queue_t *q, struct request *rq, int where,
 170                        int plug)
 171 {
 172         if (plug)
 173                 blk_plug_device(q);
 174
 175         rq->q = q;
 176         q->elevator.elevator_add_req_fn(q, rq, where);
 177 }
 178
 179 void elv_add_request(request_queue_t *q, struct request *rq, int where,
 180                      int plug)
 181 {
 182         unsigned long flags;
 183
 184         spin_lock_irqsave(q->queue_lock, flags);
 185         __elv_add_request(q, rq, where, plug);
 186         spin_unlock_irqrestore(q->queue_lock, flags);
 187 }
 188
 189 static inline struct request *__elv_next_request(request_queue_t *q)
 190 {
 191         return q->elevator.elevator_next_req_fn(q);
 192 }
 193
 194 struct request *elv_next_request(request_queue_t *q)
 195 {
 196         struct request *rq;
 197         int ret;
 198
 199         while ((rq = __elv_next_request(q))) {
 200                 /*
 201                  * just mark as started even if we don't start it, a request
 202                  * that has been delayed should not be passed by new incoming
 203                  * requests
 204                  */
 205                 rq->flags |= REQ_STARTED;
 206
 207                 if (rq == q->last_merge)
 208                         q->last_merge = NULL;
 209
 210                 if ((rq->flags & REQ_DONTPREP) || !q->prep_rq_fn)
 211                         break;
 212
 213                 ret = q->prep_rq_fn(q, rq);
 214                 if (ret == BLKPREP_OK) {
 215                         break;
 216                 } else if (ret == BLKPREP_DEFER) {
 217                         rq = NULL;
 218                         break;
 219                 } else if (ret == BLKPREP_KILL) {
 220                         int nr_bytes = rq->hard_nr_sectors << 9;
 221
 222                         if (!nr_bytes)
 223                                 nr_bytes = rq->data_len;
 224
 225                         blkdev_dequeue_request(rq);
 226                         rq->flags |= REQ_QUIET;
 227                         end_that_request_chunk(rq, 0, nr_bytes);
 228                         end_that_request_last(rq);
 229                 } else {
 230                         printk("%s: bad return=%d\n", __FUNCTION__, ret);
 231                         break;
 232                 }
 233         }
 234
 235         return rq;
 236 }
 237
 238 void elv_remove_request(request_queue_t *q, struct request *rq)
 239 {
 240         elevator_t *e = &q->elevator;
 241
 242         /*
 243          * the time frame between a request being removed from the lists
 244          * and to it is freed is accounted as io that is in progress at
 245          * the driver side. note that we only account requests that the
 246          * driver has seen (REQ_STARTED set), to avoid false accounting
 247          * for request-request merges
 248          */
 249         if (blk_account_rq(rq))
 250                 q->in_flight++;
 251
 252         /*
 253          * the main clearing point for q->last_merge is on retrieval of
 254          * request by driver (it calls elv_next_request()), but it _can_
 255          * also happen here if a request is added to the queue but later
 256          * deleted without ever being given to driver (merged with another
 257          * request).
 258          */
 259         if (rq == q->last_merge)
 260                 q->last_merge = NULL;
 261
 262         if (e->elevator_remove_req_fn)
 263                 e->elevator_remove_req_fn(q, rq);
 264 }
 265
 266 int elv_queue_empty(request_queue_t *q)
 267 {
 268         elevator_t *e = &q->elevator;
 269
 270         if (e->elevator_queue_empty_fn)
 271                 return e->elevator_queue_empty_fn(q);
 272
 273         return list_empty(&q->queue_head);
 274 }
 275
 276 struct request *elv_latter_request(request_queue_t *q, struct request *rq)
 277 {
 278         struct list_head *next;
 279
 280         elevator_t *e = &q->elevator;
 281
 282         if (e->elevator_latter_req_fn)
 283                 return e->elevator_latter_req_fn(q, rq);
 284
 285         next = rq->queuelist.next;
 286         if (next != &q->queue_head && next != &rq->queuelist)
 287                 return list_entry_rq(next);
 288
 289         return NULL;
 290 }
 291
 292 struct request *elv_former_request(request_queue_t *q, struct request *rq)
 293 {
 294         struct list_head *prev;
 295
 296         elevator_t *e = &q->elevator;
 297
 298         if (e->elevator_former_req_fn)
 299                 return e->elevator_former_req_fn(q, rq);
 300
 301         prev = rq->queuelist.prev;
 302         if (prev != &q->queue_head && prev != &rq->queuelist)
 303                 return list_entry_rq(prev);
 304
 305         return NULL;
 306 }
 307
 308 int elv_set_request(request_queue_t *q, struct request *rq, int gfp_mask)
 309 {
 310         elevator_t *e = &q->elevator;
 311
 312         if (e->elevator_set_req_fn)
 313                 return e->elevator_set_req_fn(q, rq, gfp_mask);
 314
 315         rq->elevator_private = NULL;
 316         return 0;
 317 }
 318
 319 void elv_put_request(request_queue_t *q, struct request *rq)
 320 {
 321         elevator_t *e = &q->elevator;
 322
 323         if (e->elevator_put_req_fn)
 324                 e->elevator_put_req_fn(q, rq);
 325 }
 326
 327 int elv_may_queue(request_queue_t *q, int rw)
 328 {
 329         elevator_t *e = &q->elevator;
 330
 331         if (e->elevator_may_queue_fn)
 332                 return e->elevator_may_queue_fn(q, rw);
 333
 334         return 0;
 335 }
 336
 337 void elv_completed_request(request_queue_t *q, struct request *rq)
 338 {
 339         elevator_t *e = &q->elevator;
 340
 341         /*
 342          * request is released from the driver, io must be done
 343          */
 344         if (blk_account_rq(rq))
 345                 q->in_flight--;
 346
 347         if (e->elevator_completed_req_fn)
 348                 e->elevator_completed_req_fn(q, rq);
 349 }
 350
 351 int elv_register_queue(struct request_queue *q)
 352 {
 353         elevator_t *e;
 354
 355         e = &q->elevator;
 356
 357         e->kobj.parent = kobject_get(&q->kobj);
 358         if (!e->kobj.parent)
 359                 return -EBUSY;
 360
 361         snprintf(e->kobj.name, KOBJ_NAME_LEN, "%s", "iosched");
 362         e->kobj.ktype = e->elevator_ktype;
 363
 364         return kobject_register(&e->kobj);
 365 }
 366
 367 void elv_unregister_queue(struct request_queue *q)
 368 {
 369         if (q) {
 370                 elevator_t * e = &q->elevator;
 371                 kobject_unregister(&e->kobj);
 372                 kobject_put(&q->kobj);
 373         }
 374 }
 375
 376 module_init(elevator_global_init);
 377
 378 EXPORT_SYMBOL(elv_add_request);
 379 EXPORT_SYMBOL(__elv_add_request);
 380 EXPORT_SYMBOL(elv_requeue_request);
 381 EXPORT_SYMBOL(elv_next_request);
 382 EXPORT_SYMBOL(elv_remove_request);
 383 EXPORT_SYMBOL(elv_queue_empty);
 384 EXPORT_SYMBOL(elv_completed_request);
 385 EXPORT_SYMBOL(elevator_exit);
 386 EXPORT_SYMBOL(elevator_init);