include/linux/blkdev.h

   1 #ifndef _LINUX_BLKDEV_H
   2 #define _LINUX_BLKDEV_H
   3
   4 #ifdef CONFIG_BLOCK
   5
   6 #include <linux/sched.h>
   7 #include <linux/major.h>
   8 #include <linux/genhd.h>
   9 #include <linux/list.h>
  10 #include <linux/timer.h>
  11 #include <linux/workqueue.h>
  12 #include <linux/pagemap.h>
  13 #include <linux/backing-dev.h>
  14 #include <linux/wait.h>
  15 #include <linux/mempool.h>
  16 #include <linux/bio.h>
  17 #include <linux/module.h>
  18 #include <linux/stringify.h>
  19 #include <linux/bsg.h>
  20
  21 #include <asm/scatterlist.h>
  22
  23 struct scsi_ioctl_command;
  24
  25 struct request_queue;
  26 struct elevator_queue;
  27 typedef struct elevator_queue elevator_t;
  28 struct request_pm_state;
  29 struct blk_trace;
  30 struct request;
  31 struct sg_io_hdr;
  32
  33 #define BLKDEV_MIN_RQ   4
  34 #define BLKDEV_MAX_RQ   128     /* Default maximum */
  35
  36 struct request;
  37 typedef void (rq_end_io_fn)(struct request *, int);
  38
  39 struct request_list {
  40         int count[2];
  41         int starved[2];
  42         int elvpriv;
  43         mempool_t *rq_pool;
  44         wait_queue_head_t wait[2];
  45 };
  46
  47 /*
  48  * request command types
  49  */
  50 enum rq_cmd_type_bits {
  51         REQ_TYPE_FS             = 1,    /* fs request */
  52         REQ_TYPE_BLOCK_PC,              /* scsi command */
  53         REQ_TYPE_SENSE,                 /* sense request */
  54         REQ_TYPE_PM_SUSPEND,            /* suspend request */
  55         REQ_TYPE_PM_RESUME,             /* resume request */
  56         REQ_TYPE_PM_SHUTDOWN,           /* shutdown request */
  57         REQ_TYPE_FLUSH,                 /* flush request */
  58         REQ_TYPE_SPECIAL,               /* driver defined type */
  59         REQ_TYPE_LINUX_BLOCK,           /* generic block layer message */
  60         /*
  61          * for ATA/ATAPI devices. this really doesn't belong here, ide should
  62          * use REQ_TYPE_SPECIAL and use rq->cmd[0] with the range of driver
  63          * private REQ_LB opcodes to differentiate what type of request this is
  64          */
  65         REQ_TYPE_ATA_TASKFILE,
  66         REQ_TYPE_ATA_PC,
  67 };
  68
  69 /*
  70  * For request of type REQ_TYPE_LINUX_BLOCK, rq->cmd[0] is the opcode being
  71  * sent down (similar to how REQ_TYPE_BLOCK_PC means that ->cmd[] holds a
  72  * SCSI cdb.
  73  *
  74  * 0x00 -> 0x3f are driver private, to be used for whatever purpose they need,
  75  * typically to differentiate REQ_TYPE_SPECIAL requests.
  76  *
  77  */
  78 enum {
  79         /*
  80          * just examples for now
  81          */
  82         REQ_LB_OP_EJECT = 0x40,         /* eject request */
  83         REQ_LB_OP_FLUSH = 0x41,         /* flush device */
  84 };
  85
  86 /*
  87  * request type modified bits. first two bits match BIO_RW* bits, important
  88  */
  89 enum rq_flag_bits {
  90         __REQ_RW,               /* not set, read. set, write */
  91         __REQ_FAILFAST,         /* no low level driver retries */
  92         __REQ_DISCARD,          /* request to discard sectors */
  93         __REQ_SORTED,           /* elevator knows about this request */
  94         __REQ_SOFTBARRIER,      /* may not be passed by ioscheduler */
  95         __REQ_HARDBARRIER,      /* may not be passed by drive either */
  96         __REQ_FUA,              /* forced unit access */
  97         __REQ_NOMERGE,          /* don't touch this for merging */
  98         __REQ_STARTED,          /* drive already may have started this one */
  99         __REQ_DONTPREP,         /* don't call prep for this one */
 100         __REQ_QUEUED,           /* uses queueing */
 101         __REQ_ELVPRIV,          /* elevator private data attached */
 102         __REQ_FAILED,           /* set if the request failed */
 103         __REQ_QUIET,            /* don't worry about errors */
 104         __REQ_PREEMPT,          /* set for "ide_preempt" requests */
 105         __REQ_ORDERED_COLOR,    /* is before or after barrier */
 106         __REQ_RW_SYNC,          /* request is sync (O_DIRECT) */
 107         __REQ_ALLOCED,          /* request came from our alloc pool */
 108         __REQ_RW_META,          /* metadata io request */
 109         __REQ_COPY_USER,        /* contains copies of user pages */
 110         __REQ_INTEGRITY,        /* integrity metadata has been remapped */
 111         __REQ_NR_BITS,          /* stops here */
 112 };
 113
 114 #define REQ_RW          (1 << __REQ_RW)
 115 #define REQ_DISCARD     (1 << __REQ_DISCARD)
 116 #define REQ_FAILFAST    (1 << __REQ_FAILFAST)
 117 #define REQ_SORTED      (1 << __REQ_SORTED)
 118 #define REQ_SOFTBARRIER (1 << __REQ_SOFTBARRIER)
 119 #define REQ_HARDBARRIER (1 << __REQ_HARDBARRIER)
 120 #define REQ_FUA         (1 << __REQ_FUA)
 121 #define REQ_NOMERGE     (1 << __REQ_NOMERGE)
 122 #define REQ_STARTED     (1 << __REQ_STARTED)
 123 #define REQ_DONTPREP    (1 << __REQ_DONTPREP)
 124 #define REQ_QUEUED      (1 << __REQ_QUEUED)
 125 #define REQ_ELVPRIV     (1 << __REQ_ELVPRIV)
 126 #define REQ_FAILED      (1 << __REQ_FAILED)
 127 #define REQ_QUIET       (1 << __REQ_QUIET)
 128 #define REQ_PREEMPT     (1 << __REQ_PREEMPT)
 129 #define REQ_ORDERED_COLOR       (1 << __REQ_ORDERED_COLOR)
 130 #define REQ_RW_SYNC     (1 << __REQ_RW_SYNC)
 131 #define REQ_ALLOCED     (1 << __REQ_ALLOCED)
 132 #define REQ_RW_META     (1 << __REQ_RW_META)
 133 #define REQ_COPY_USER   (1 << __REQ_COPY_USER)
 134 #define REQ_INTEGRITY   (1 << __REQ_INTEGRITY)
 135
 136 #define BLK_MAX_CDB     16
 137
 138 /*
 139  * try to put the fields that are referenced together in the same cacheline.
 140  * if you modify this structure, be sure to check block/blk-core.c:rq_init()
 141  * as well!
 142  */
 143 struct request {
 144         struct list_head queuelist;
 145         struct list_head donelist;
 146
 147         struct request_queue *q;
 148
 149         unsigned int cmd_flags;
 150         enum rq_cmd_type_bits cmd_type;
 151
 152         /* Maintain bio traversal state for part by part I/O submission.
 153          * hard_* are block layer internals, no driver should touch them!
 154          */
 155
 156         sector_t sector;                /* next sector to submit */
 157         sector_t hard_sector;           /* next sector to complete */
 158         unsigned long nr_sectors;       /* no. of sectors left to submit */
 159         unsigned long hard_nr_sectors;  /* no. of sectors left to complete */
 160         /* no. of sectors left to submit in the current segment */
 161         unsigned int current_nr_sectors;
 162
 163         /* no. of sectors left to complete in the current segment */
 164         unsigned int hard_cur_sectors;
 165
 166         struct bio *bio;
 167         struct bio *biotail;
 168
 169         struct hlist_node hash; /* merge hash */
 170         /*
 171          * The rb_node is only used inside the io scheduler, requests
 172          * are pruned when moved to the dispatch queue. So let the
 173          * completion_data share space with the rb_node.
 174          */
 175         union {
 176                 struct rb_node rb_node; /* sort/lookup */
 177                 void *completion_data;
 178         };
 179
 180         /*
 181          * two pointers are available for the IO schedulers, if they need
 182          * more they have to dynamically allocate it.
 183          */
 184         void *elevator_private;
 185         void *elevator_private2;
 186
 187         struct gendisk *rq_disk;
 188         unsigned long start_time;
 189
 190         /* Number of scatter-gather DMA addr+len pairs after
 191          * physical address coalescing is performed.
 192          */
 193         unsigned short nr_phys_segments;
 194
 195         /* Number of scatter-gather addr+len pairs after
 196          * physical and DMA remapping hardware coalescing is performed.
 197          * This is the number of scatter-gather entries the driver
 198          * will actually have to deal with after DMA mapping is done.
 199          */
 200         unsigned short nr_hw_segments;
 201
 202         unsigned short ioprio;
 203
 204         void *special;
 205         char *buffer;
 206
 207         int tag;
 208         int errors;
 209
 210         int ref_count;
 211
 212         /*
 213          * when request is used as a packet command carrier
 214          */
 215         unsigned short cmd_len;
 216         unsigned char __cmd[BLK_MAX_CDB];
 217         unsigned char *cmd;
 218
 219         unsigned int data_len;
 220         unsigned int extra_len; /* length of alignment and padding */
 221         unsigned int sense_len;
 222         void *data;
 223         void *sense;
 224
 225         unsigned int timeout;
 226         int retries;
 227
 228         /*
 229          * completion callback.
 230          */
 231         rq_end_io_fn *end_io;
 232         void *end_io_data;
 233
 234         /* for bidi */
 235         struct request *next_rq;
 236 };
 237
 238 /*
 239  * State information carried for REQ_TYPE_PM_SUSPEND and REQ_TYPE_PM_RESUME
 240  * requests. Some step values could eventually be made generic.
 241  */
 242 struct request_pm_state
 243 {
 244         /* PM state machine step value, currently driver specific */
 245         int     pm_step;
 246         /* requested PM state value (S1, S2, S3, S4, ...) */
 247         u32     pm_state;
 248         void*   data;           /* for driver use */
 249 };
 250
 251 #include <linux/elevator.h>
 252
 253 typedef void (request_fn_proc) (struct request_queue *q);
 254 typedef int (make_request_fn) (struct request_queue *q, struct bio *bio);
 255 typedef int (prep_rq_fn) (struct request_queue *, struct request *);
 256 typedef void (unplug_fn) (struct request_queue *);
 257 typedef int (prepare_discard_fn) (struct request_queue *, struct request *);
 258
 259 struct bio_vec;
 260 struct bvec_merge_data {
 261         struct block_device *bi_bdev;
 262         sector_t bi_sector;
 263         unsigned bi_size;
 264         unsigned long bi_rw;
 265 };
 266 typedef int (merge_bvec_fn) (struct request_queue *, struct bvec_merge_data *,
 267                              struct bio_vec *);
 268 typedef void (prepare_flush_fn) (struct request_queue *, struct request *);
 269 typedef void (softirq_done_fn)(struct request *);
 270 typedef int (dma_drain_needed_fn)(struct request *);
 271
 272 enum blk_queue_state {
 273         Queue_down,
 274         Queue_up,
 275 };
 276
 277 struct blk_queue_tag {
 278         struct request **tag_index;     /* map of busy tags */
 279         unsigned long *tag_map;         /* bit map of free/busy tags */
 280         int busy;                       /* current depth */
 281         int max_depth;                  /* what we will send to device */
 282         int real_max_depth;             /* what the array can hold */
 283         atomic_t refcnt;                /* map can be shared */
 284 };
 285
 286 #define BLK_SCSI_MAX_CMDS       (256)
 287 #define BLK_SCSI_CMD_PER_LONG   (BLK_SCSI_MAX_CMDS / (sizeof(long) * 8))
 288
 289 struct blk_cmd_filter {
 290         unsigned long read_ok[BLK_SCSI_CMD_PER_LONG];
 291         unsigned long write_ok[BLK_SCSI_CMD_PER_LONG];
 292         struct kobject kobj;
 293 };
 294
 295 struct request_queue
 296 {
 297         /*
 298          * Together with queue_head for cacheline sharing
 299          */
 300         struct list_head        queue_head;
 301         struct request          *last_merge;
 302         elevator_t              *elevator;
 303
 304         /*
 305          * the queue request freelist, one for reads and one for writes
 306          */
 307         struct request_list     rq;
 308
 309         request_fn_proc         *request_fn;
 310         make_request_fn         *make_request_fn;
 311         prep_rq_fn              *prep_rq_fn;
 312         unplug_fn               *unplug_fn;
 313         prepare_discard_fn      *prepare_discard_fn;
 314         merge_bvec_fn           *merge_bvec_fn;
 315         prepare_flush_fn        *prepare_flush_fn;
 316         softirq_done_fn         *softirq_done_fn;
 317         dma_drain_needed_fn     *dma_drain_needed;
 318
 319         /*
 320          * Dispatch queue sorting
 321          */
 322         sector_t                end_sector;
 323         struct request          *boundary_rq;
 324
 325         /*
 326          * Auto-unplugging state
 327          */
 328         struct timer_list       unplug_timer;
 329         int                     unplug_thresh;  /* After this many requests */
 330         unsigned long           unplug_delay;   /* After this many jiffies */
 331         struct work_struct      unplug_work;
 332
 333         struct backing_dev_info backing_dev_info;
 334
 335         /*
 336          * The queue owner gets to use this for whatever they like.
 337          * ll_rw_blk doesn't touch it.
 338          */
 339         void                    *queuedata;
 340
 341         /*
 342          * queue needs bounce pages for pages above this limit
 343          */
 344         unsigned long           bounce_pfn;
 345         gfp_t                   bounce_gfp;
 346
 347         /*
 348          * various queue flags, see QUEUE_* below
 349          */
 350         unsigned long           queue_flags;
 351
 352         /*
 353          * protects queue structures from reentrancy. ->__queue_lock should
 354          * _never_ be used directly, it is queue private. always use
 355          * ->queue_lock.
 356          */
 357         spinlock_t              __queue_lock;
 358         spinlock_t              *queue_lock;
 359
 360         /*
 361          * queue kobject
 362          */
 363         struct kobject kobj;
 364
 365         /*
 366          * queue settings
 367          */
 368         unsigned long           nr_requests;    /* Max # of requests */
 369         unsigned int            nr_congestion_on;
 370         unsigned int            nr_congestion_off;
 371         unsigned int            nr_batching;
 372
 373         unsigned int            max_sectors;
 374         unsigned int            max_hw_sectors;
 375         unsigned short          max_phys_segments;
 376         unsigned short          max_hw_segments;
 377         unsigned short          hardsect_size;
 378         unsigned int            max_segment_size;
 379
 380         unsigned long           seg_boundary_mask;
 381         void                    *dma_drain_buffer;
 382         unsigned int            dma_drain_size;
 383         unsigned int            dma_pad_mask;
 384         unsigned int            dma_alignment;
 385
 386         struct blk_queue_tag    *queue_tags;
 387         struct list_head        tag_busy_list;
 388
 389         unsigned int            nr_sorted;
 390         unsigned int            in_flight;
 391
 392         /*
 393          * sg stuff
 394          */
 395         unsigned int            sg_timeout;
 396         unsigned int            sg_reserved_size;
 397         int                     node;
 398 #ifdef CONFIG_BLK_DEV_IO_TRACE
 399         struct blk_trace        *blk_trace;
 400 #endif
 401         /*
 402          * reserved for flush operations
 403          */
 404         unsigned int            ordered, next_ordered, ordseq;
 405         int                     orderr, ordcolor;
 406         struct request          pre_flush_rq, bar_rq, post_flush_rq;
 407         struct request          *orig_bar_rq;
 408
 409         struct mutex            sysfs_lock;
 410
 411 #if defined(CONFIG_BLK_DEV_BSG)
 412         struct bsg_class_device bsg_dev;
 413 #endif
 414         struct blk_cmd_filter cmd_filter;
 415 };
 416
 417 #define QUEUE_FLAG_CLUSTER      0       /* cluster several segments into 1 */
 418 #define QUEUE_FLAG_QUEUED       1       /* uses generic tag queueing */
 419 #define QUEUE_FLAG_STOPPED      2       /* queue is stopped */
 420 #define QUEUE_FLAG_READFULL     3       /* read queue has been filled */
 421 #define QUEUE_FLAG_WRITEFULL    4       /* write queue has been filled */
 422 #define QUEUE_FLAG_DEAD         5       /* queue being torn down */
 423 #define QUEUE_FLAG_REENTER      6       /* Re-entrancy avoidance */
 424 #define QUEUE_FLAG_PLUGGED      7       /* queue is plugged */
 425 #define QUEUE_FLAG_ELVSWITCH    8       /* don't use elevator, just do FIFO */
 426 #define QUEUE_FLAG_BIDI         9       /* queue supports bidi requests */
 427 #define QUEUE_FLAG_NOMERGES    10       /* disable merge attempts */
 428
 429 static inline int queue_is_locked(struct request_queue *q)
 430 {
 431 #ifdef CONFIG_SMP
 432         spinlock_t *lock = q->queue_lock;
 433         return lock && spin_is_locked(lock);
 434 #else
 435         return 1;
 436 #endif
 437 }
 438
 439 static inline void queue_flag_set_unlocked(unsigned int flag,
 440                                            struct request_queue *q)
 441 {
 442         __set_bit(flag, &q->queue_flags);
 443 }
 444
 445 static inline int queue_flag_test_and_clear(unsigned int flag,
 446                                             struct request_queue *q)
 447 {
 448         WARN_ON_ONCE(!queue_is_locked(q));
 449
 450         if (test_bit(flag, &q->queue_flags)) {
 451                 __clear_bit(flag, &q->queue_flags);
 452                 return 1;
 453         }
 454
 455         return 0;
 456 }
 457
 458 static inline int queue_flag_test_and_set(unsigned int flag,
 459                                           struct request_queue *q)
 460 {
 461         WARN_ON_ONCE(!queue_is_locked(q));
 462
 463         if (!test_bit(flag, &q->queue_flags)) {
 464                 __set_bit(flag, &q->queue_flags);
 465                 return 0;
 466         }
 467
 468         return 1;
 469 }
 470
 471 static inline void queue_flag_set(unsigned int flag, struct request_queue *q)
 472 {
 473         WARN_ON_ONCE(!queue_is_locked(q));
 474         __set_bit(flag, &q->queue_flags);
 475 }
 476
 477 static inline void queue_flag_clear_unlocked(unsigned int flag,
 478                                              struct request_queue *q)
 479 {
 480         __clear_bit(flag, &q->queue_flags);
 481 }
 482
 483 static inline void queue_flag_clear(unsigned int flag, struct request_queue *q)
 484 {
 485         WARN_ON_ONCE(!queue_is_locked(q));
 486         __clear_bit(flag, &q->queue_flags);
 487 }
 488
 489 enum {
 490         /*
 491          * Hardbarrier is supported with one of the following methods.
 492          *
 493          * NONE         : hardbarrier unsupported
 494          * DRAIN        : ordering by draining is enough
 495          * DRAIN_FLUSH  : ordering by draining w/ pre and post flushes
 496          * DRAIN_FUA    : ordering by draining w/ pre flush and FUA write
 497          * TAG          : ordering by tag is enough
 498          * TAG_FLUSH    : ordering by tag w/ pre and post flushes
 499          * TAG_FUA      : ordering by tag w/ pre flush and FUA write
 500          */
 501         QUEUE_ORDERED_NONE      = 0x00,
 502         QUEUE_ORDERED_DRAIN     = 0x01,
 503         QUEUE_ORDERED_TAG       = 0x02,
 504
 505         QUEUE_ORDERED_PREFLUSH  = 0x10,
 506         QUEUE_ORDERED_POSTFLUSH = 0x20,
 507         QUEUE_ORDERED_FUA       = 0x40,
 508
 509         QUEUE_ORDERED_DRAIN_FLUSH = QUEUE_ORDERED_DRAIN |
 510                         QUEUE_ORDERED_PREFLUSH | QUEUE_ORDERED_POSTFLUSH,
 511         QUEUE_ORDERED_DRAIN_FUA = QUEUE_ORDERED_DRAIN |
 512                         QUEUE_ORDERED_PREFLUSH | QUEUE_ORDERED_FUA,
 513         QUEUE_ORDERED_TAG_FLUSH = QUEUE_ORDERED_TAG |
 514                         QUEUE_ORDERED_PREFLUSH | QUEUE_ORDERED_POSTFLUSH,
 515         QUEUE_ORDERED_TAG_FUA   = QUEUE_ORDERED_TAG |
 516                         QUEUE_ORDERED_PREFLUSH | QUEUE_ORDERED_FUA,
 517
 518         /*
 519          * Ordered operation sequence
 520          */
 521         QUEUE_ORDSEQ_STARTED    = 0x01, /* flushing in progress */
 522         QUEUE_ORDSEQ_DRAIN      = 0x02, /* waiting for the queue to be drained */
 523         QUEUE_ORDSEQ_PREFLUSH   = 0x04, /* pre-flushing in progress */
 524         QUEUE_ORDSEQ_BAR        = 0x08, /* original barrier req in progress */
 525         QUEUE_ORDSEQ_POSTFLUSH  = 0x10, /* post-flushing in progress */
 526         QUEUE_ORDSEQ_DONE       = 0x20,
 527 };
 528
 529 #define blk_queue_plugged(q)    test_bit(QUEUE_FLAG_PLUGGED, &(q)->queue_flags)
 530 #define blk_queue_tagged(q)     test_bit(QUEUE_FLAG_QUEUED, &(q)->queue_flags)
 531 #define blk_queue_stopped(q)    test_bit(QUEUE_FLAG_STOPPED, &(q)->queue_flags)
 532 #define blk_queue_nomerges(q)   test_bit(QUEUE_FLAG_NOMERGES, &(q)->queue_flags)
 533 #define blk_queue_flushing(q)   ((q)->ordseq)
 534
 535 #define blk_fs_request(rq)      ((rq)->cmd_type == REQ_TYPE_FS)
 536 #define blk_pc_request(rq)      ((rq)->cmd_type == REQ_TYPE_BLOCK_PC)
 537 #define blk_special_request(rq) ((rq)->cmd_type == REQ_TYPE_SPECIAL)
 538 #define blk_sense_request(rq)   ((rq)->cmd_type == REQ_TYPE_SENSE)
 539
 540 #define blk_noretry_request(rq) ((rq)->cmd_flags & REQ_FAILFAST)
 541 #define blk_rq_started(rq)      ((rq)->cmd_flags & REQ_STARTED)
 542
 543 #define blk_account_rq(rq)      (blk_rq_started(rq) && blk_fs_request(rq))
 544
 545 #define blk_pm_suspend_request(rq)      ((rq)->cmd_type == REQ_TYPE_PM_SUSPEND)
 546 #define blk_pm_resume_request(rq)       ((rq)->cmd_type == REQ_TYPE_PM_RESUME)
 547 #define blk_pm_request(rq)      \
 548         (blk_pm_suspend_request(rq) || blk_pm_resume_request(rq))
 549
 550 #define blk_sorted_rq(rq)       ((rq)->cmd_flags & REQ_SORTED)
 551 #define blk_barrier_rq(rq)      ((rq)->cmd_flags & REQ_HARDBARRIER)
 552 #define blk_fua_rq(rq)          ((rq)->cmd_flags & REQ_FUA)
 553 #define blk_discard_rq(rq)      ((rq)->cmd_flags & REQ_DISCARD)
 554 #define blk_bidi_rq(rq)         ((rq)->next_rq != NULL)
 555 #define blk_empty_barrier(rq)   (blk_barrier_rq(rq) && blk_fs_request(rq) && !(rq)->hard_nr_sectors)
 556 /* rq->queuelist of dequeued request must be list_empty() */
 557 #define blk_queued_rq(rq)       (!list_empty(&(rq)->queuelist))
 558
 559 #define list_entry_rq(ptr)      list_entry((ptr), struct request, queuelist)
 560
 561 #define rq_data_dir(rq)         ((rq)->cmd_flags & 1)
 562
 563 /*
 564  * We regard a request as sync, if it's a READ or a SYNC write.
 565  */
 566 #define rq_is_sync(rq)          (rq_data_dir((rq)) == READ || (rq)->cmd_flags & REQ_RW_SYNC)
 567 #define rq_is_meta(rq)          ((rq)->cmd_flags & REQ_RW_META)
 568
 569 static inline int blk_queue_full(struct request_queue *q, int rw)
 570 {
 571         if (rw == READ)
 572                 return test_bit(QUEUE_FLAG_READFULL, &q->queue_flags);
 573         return test_bit(QUEUE_FLAG_WRITEFULL, &q->queue_flags);
 574 }
 575
 576 static inline void blk_set_queue_full(struct request_queue *q, int rw)
 577 {
 578         if (rw == READ)
 579                 queue_flag_set(QUEUE_FLAG_READFULL, q);
 580         else
 581                 queue_flag_set(QUEUE_FLAG_WRITEFULL, q);
 582 }
 583
 584 static inline void blk_clear_queue_full(struct request_queue *q, int rw)
 585 {
 586         if (rw == READ)
 587                 queue_flag_clear(QUEUE_FLAG_READFULL, q);
 588         else
 589                 queue_flag_clear(QUEUE_FLAG_WRITEFULL, q);
 590 }
 591
 592
 593 /*
 594  * mergeable request must not have _NOMERGE or _BARRIER bit set, nor may
 595  * it already be started by driver.
 596  */
 597 #define RQ_NOMERGE_FLAGS        \
 598         (REQ_NOMERGE | REQ_STARTED | REQ_HARDBARRIER | REQ_SOFTBARRIER)
 599 #define rq_mergeable(rq)        \
 600         (!((rq)->cmd_flags & RQ_NOMERGE_FLAGS) && blk_fs_request((rq)))
 601
 602 /*
 603  * q->prep_rq_fn return values
 604  */
 605 #define BLKPREP_OK              0       /* serve it */
 606 #define BLKPREP_KILL            1       /* fatal error, kill */
 607 #define BLKPREP_DEFER           2       /* leave on queue */
 608
 609 extern unsigned long blk_max_low_pfn, blk_max_pfn;
 610
 611 /*
 612  * standard bounce addresses:
 613  *
 614  * BLK_BOUNCE_HIGH      : bounce all highmem pages
 615  * BLK_BOUNCE_ANY       : don't bounce anything
 616  * BLK_BOUNCE_ISA       : bounce pages above ISA DMA boundary
 617  */
 618
 619 #if BITS_PER_LONG == 32
 620 #define BLK_BOUNCE_HIGH         ((u64)blk_max_low_pfn << PAGE_SHIFT)
 621 #else
 622 #define BLK_BOUNCE_HIGH         -1ULL
 623 #endif
 624 #define BLK_BOUNCE_ANY          (-1ULL)
 625 #define BLK_BOUNCE_ISA          (ISA_DMA_THRESHOLD)
 626
 627 /*
 628  * default timeout for SG_IO if none specified
 629  */
 630 #define BLK_DEFAULT_SG_TIMEOUT  (60 * HZ)
 631
 632 #ifdef CONFIG_BOUNCE
 633 extern int init_emergency_isa_pool(void);
 634 extern void blk_queue_bounce(struct request_queue *q, struct bio **bio);
 635 #else
 636 static inline int init_emergency_isa_pool(void)
 637 {
 638         return 0;
 639 }
 640 static inline void blk_queue_bounce(struct request_queue *q, struct bio **bio)
 641 {
 642 }
 643 #endif /* CONFIG_MMU */
 644
 645 struct req_iterator {
 646         int i;
 647         struct bio *bio;
 648 };
 649
 650 /* This should not be used directly - use rq_for_each_segment */
 651 #define __rq_for_each_bio(_bio, rq)     \
 652         if ((rq->bio))                  \
 653                 for (_bio = (rq)->bio; _bio; _bio = _bio->bi_next)
 654
 655 #define rq_for_each_segment(bvl, _rq, _iter)                    \
 656         __rq_for_each_bio(_iter.bio, _rq)                       \
 657                 bio_for_each_segment(bvl, _iter.bio, _iter.i)
 658
 659 #define rq_iter_last(rq, _iter)                                 \
 660                 (_iter.bio->bi_next == NULL && _iter.i == _iter.bio->bi_vcnt-1)
 661
 662 extern int blk_register_queue(struct gendisk *disk);
 663 extern void blk_unregister_queue(struct gendisk *disk);
 664 extern void register_disk(struct gendisk *dev);
 665 extern void generic_make_request(struct bio *bio);
 666 extern void blk_rq_init(struct request_queue *q, struct request *rq);
 667 extern void blk_put_request(struct request *);
 668 extern void __blk_put_request(struct request_queue *, struct request *);
 669 extern struct request *blk_get_request(struct request_queue *, int, gfp_t);
 670 extern void blk_insert_request(struct request_queue *, struct request *, int, void *);
 671 extern void blk_requeue_request(struct request_queue *, struct request *);
 672 extern void blk_plug_device(struct request_queue *);
 673 extern void blk_plug_device_unlocked(struct request_queue *);
 674 extern int blk_remove_plug(struct request_queue *);
 675 extern void blk_recount_segments(struct request_queue *, struct bio *);
 676 extern int scsi_cmd_ioctl(struct file *, struct request_queue *,
 677                           struct gendisk *, unsigned int, void __user *);
 678 extern int sg_scsi_ioctl(struct file *, struct request_queue *,
 679                 struct gendisk *, struct scsi_ioctl_command __user *);
 680
 681 /*
 682  * Temporary export, until SCSI gets fixed up.
 683  */
 684 extern int blk_rq_append_bio(struct request_queue *q, struct request *rq,
 685                              struct bio *bio);
 686
 687 /*
 688  * A queue has just exitted congestion.  Note this in the global counter of
 689  * congested queues, and wake up anyone who was waiting for requests to be
 690  * put back.
 691  */
 692 static inline void blk_clear_queue_congested(struct request_queue *q, int rw)
 693 {
 694         clear_bdi_congested(&q->backing_dev_info, rw);
 695 }
 696
 697 /*
 698  * A queue has just entered congestion.  Flag that in the queue's VM-visible
 699  * state flags and increment the global gounter of congested queues.
 700  */
 701 static inline void blk_set_queue_congested(struct request_queue *q, int rw)
 702 {
 703         set_bdi_congested(&q->backing_dev_info, rw);
 704 }
 705
 706 extern void blk_start_queue(struct request_queue *q);
 707 extern void blk_stop_queue(struct request_queue *q);
 708 extern void blk_sync_queue(struct request_queue *q);
 709 extern void __blk_stop_queue(struct request_queue *q);
 710 extern void __blk_run_queue(struct request_queue *);
 711 extern void blk_run_queue(struct request_queue *);
 712 extern void blk_start_queueing(struct request_queue *);
 713 extern int blk_rq_map_user(struct request_queue *, struct request *, void __user *, unsigned long);
 714 extern int blk_rq_unmap_user(struct bio *);
 715 extern int blk_rq_map_kern(struct request_queue *, struct request *, void *, unsigned int, gfp_t);
 716 extern int blk_rq_map_user_iov(struct request_queue *, struct request *,
 717                                struct sg_iovec *, int, unsigned int);
 718 extern int blk_execute_rq(struct request_queue *, struct gendisk *,
 719                           struct request *, int);
 720 extern void blk_execute_rq_nowait(struct request_queue *, struct gendisk *,
 721                                   struct request *, int, rq_end_io_fn *);
 722 extern void blk_unplug(struct request_queue *q);
 723
 724 static inline struct request_queue *bdev_get_queue(struct block_device *bdev)
 725 {
 726         return bdev->bd_disk->queue;
 727 }
 728
 729 static inline void blk_run_backing_dev(struct backing_dev_info *bdi,
 730                                        struct page *page)
 731 {
 732         if (bdi && bdi->unplug_io_fn)
 733                 bdi->unplug_io_fn(bdi, page);
 734 }
 735
 736 static inline void blk_run_address_space(struct address_space *mapping)
 737 {
 738         if (mapping)
 739                 blk_run_backing_dev(mapping->backing_dev_info, NULL);
 740 }
 741
 742 /*
 743  * blk_end_request() and friends.
 744  * __blk_end_request() and end_request() must be called with
 745  * the request queue spinlock acquired.
 746  *
 747  * Several drivers define their own end_request and call
 748  * blk_end_request() for parts of the original function.
 749  * This prevents code duplication in drivers.
 750  */
 751 extern int blk_end_request(struct request *rq, int error,
 752                                 unsigned int nr_bytes);
 753 extern int __blk_end_request(struct request *rq, int error,
 754                                 unsigned int nr_bytes);
 755 extern int blk_end_bidi_request(struct request *rq, int error,
 756                                 unsigned int nr_bytes, unsigned int bidi_bytes);
 757 extern void end_request(struct request *, int);
 758 extern void end_queued_request(struct request *, int);
 759 extern void end_dequeued_request(struct request *, int);
 760 extern int blk_end_request_callback(struct request *rq, int error,
 761                                 unsigned int nr_bytes,
 762                                 int (drv_callback)(struct request *));
 763 extern void blk_complete_request(struct request *);
 764
 765 /*
 766  * blk_end_request() takes bytes instead of sectors as a complete size.
 767  * blk_rq_bytes() returns bytes left to complete in the entire request.
 768  * blk_rq_cur_bytes() returns bytes left to complete in the current segment.
 769  */
 770 extern unsigned int blk_rq_bytes(struct request *rq);
 771 extern unsigned int blk_rq_cur_bytes(struct request *rq);
 772
 773 static inline void blkdev_dequeue_request(struct request *req)
 774 {
 775         elv_dequeue_request(req->q, req);
 776 }
 777
 778 /*
 779  * Access functions for manipulating queue properties
 780  */
 781 extern struct request_queue *blk_init_queue_node(request_fn_proc *rfn,
 782                                         spinlock_t *lock, int node_id);
 783 extern struct request_queue *blk_init_queue(request_fn_proc *, spinlock_t *);
 784 extern void blk_cleanup_queue(struct request_queue *);
 785 extern void blk_queue_make_request(struct request_queue *, make_request_fn *);
 786 extern void blk_queue_bounce_limit(struct request_queue *, u64);
 787 extern void blk_queue_max_sectors(struct request_queue *, unsigned int);
 788 extern void blk_queue_max_phys_segments(struct request_queue *, unsigned short);
 789 extern void blk_queue_max_hw_segments(struct request_queue *, unsigned short);
 790 extern void blk_queue_max_segment_size(struct request_queue *, unsigned int);
 791 extern void blk_queue_hardsect_size(struct request_queue *, unsigned short);
 792 extern void blk_queue_stack_limits(struct request_queue *t, struct request_queue *b);
 793 extern void blk_queue_dma_pad(struct request_queue *, unsigned int);
 794 extern void blk_queue_update_dma_pad(struct request_queue *, unsigned int);
 795 extern int blk_queue_dma_drain(struct request_queue *q,
 796                                dma_drain_needed_fn *dma_drain_needed,
 797                                void *buf, unsigned int size);
 798 extern void blk_queue_segment_boundary(struct request_queue *, unsigned long);
 799 extern void blk_queue_prep_rq(struct request_queue *, prep_rq_fn *pfn);
 800 extern void blk_queue_merge_bvec(struct request_queue *, merge_bvec_fn *);
 801 extern void blk_queue_dma_alignment(struct request_queue *, int);
 802 extern void blk_queue_update_dma_alignment(struct request_queue *, int);
 803 extern void blk_queue_softirq_done(struct request_queue *, softirq_done_fn *);
 804 extern void blk_queue_set_discard(struct request_queue *, prepare_discard_fn *);
 805 extern struct backing_dev_info *blk_get_backing_dev_info(struct block_device *bdev);
 806 extern int blk_queue_ordered(struct request_queue *, unsigned, prepare_flush_fn *);
 807 extern int blk_do_ordered(struct request_queue *, struct request **);
 808 extern unsigned blk_ordered_cur_seq(struct request_queue *);
 809 extern unsigned blk_ordered_req_seq(struct request *);
 810 extern void blk_ordered_complete_seq(struct request_queue *, unsigned, int);
 811
 812 extern int blk_rq_map_sg(struct request_queue *, struct request *, struct scatterlist *);
 813 extern void blk_dump_rq_flags(struct request *, char *);
 814 extern void generic_unplug_device(struct request_queue *);
 815 extern void __generic_unplug_device(struct request_queue *);
 816 extern long nr_blockdev_pages(void);
 817
 818 int blk_get_queue(struct request_queue *);
 819 struct request_queue *blk_alloc_queue(gfp_t);
 820 struct request_queue *blk_alloc_queue_node(gfp_t, int);
 821 extern void blk_put_queue(struct request_queue *);
 822
 823 /*
 824  * tag stuff
 825  */
 826 #define blk_rq_tagged(rq)               ((rq)->cmd_flags & REQ_QUEUED)
 827 extern int blk_queue_start_tag(struct request_queue *, struct request *);
 828 extern struct request *blk_queue_find_tag(struct request_queue *, int);
 829 extern void blk_queue_end_tag(struct request_queue *, struct request *);
 830 extern int blk_queue_init_tags(struct request_queue *, int, struct blk_queue_tag *);
 831 extern void blk_queue_free_tags(struct request_queue *);
 832 extern int blk_queue_resize_tags(struct request_queue *, int);
 833 extern void blk_queue_invalidate_tags(struct request_queue *);
 834 extern struct blk_queue_tag *blk_init_tags(int);
 835 extern void blk_free_tags(struct blk_queue_tag *);
 836
 837 static inline struct request *blk_map_queue_find_tag(struct blk_queue_tag *bqt,
 838                                                 int tag)
 839 {
 840         if (unlikely(bqt == NULL || tag >= bqt->real_max_depth))
 841                 return NULL;
 842         return bqt->tag_index[tag];
 843 }
 844
 845 extern int blkdev_issue_flush(struct block_device *, sector_t *);
 846 extern int blkdev_issue_discard(struct block_device *, sector_t sector,
 847                                 unsigned nr_sects);
 848
 849 static inline int sb_issue_discard(struct super_block *sb,
 850                                    sector_t block, unsigned nr_blocks)
 851 {
 852         block <<= (sb->s_blocksize_bits - 9);
 853         nr_blocks <<= (sb->s_blocksize_bits - 9);
 854         return blkdev_issue_discard(sb->s_bdev, block, nr_blocks);
 855 }
 856
 857 /*
 858 * command filter functions
 859 */
 860 extern int blk_verify_command(struct blk_cmd_filter *filter,
 861                               unsigned char *cmd, int has_write_perm);
 862 extern void blk_set_cmd_filter_defaults(struct blk_cmd_filter *filter);
 863
 864 #define MAX_PHYS_SEGMENTS 128
 865 #define MAX_HW_SEGMENTS 128
 866 #define SAFE_MAX_SECTORS 255
 867 #define BLK_DEF_MAX_SECTORS 1024
 868
 869 #define MAX_SEGMENT_SIZE        65536
 870
 871 #define blkdev_entry_to_request(entry) list_entry((entry), struct request, queuelist)
 872
 873 static inline int queue_hardsect_size(struct request_queue *q)
 874 {
 875         int retval = 512;
 876
 877         if (q && q->hardsect_size)
 878                 retval = q->hardsect_size;
 879
 880         return retval;
 881 }
 882
 883 static inline int bdev_hardsect_size(struct block_device *bdev)
 884 {
 885         return queue_hardsect_size(bdev_get_queue(bdev));
 886 }
 887
 888 static inline int queue_dma_alignment(struct request_queue *q)
 889 {
 890         return q ? q->dma_alignment : 511;
 891 }
 892
 893 /* assumes size > 256 */
 894 static inline unsigned int blksize_bits(unsigned int size)
 895 {
 896         unsigned int bits = 8;
 897         do {
 898                 bits++;
 899                 size >>= 1;
 900         } while (size > 256);
 901         return bits;
 902 }
 903
 904 static inline unsigned int block_size(struct block_device *bdev)
 905 {
 906         return bdev->bd_block_size;
 907 }
 908
 909 typedef struct {struct page *v;} Sector;
 910
 911 unsigned char *read_dev_sector(struct block_device *, sector_t, Sector *);
 912
 913 static inline void put_dev_sector(Sector p)
 914 {
 915         page_cache_release(p.v);
 916 }
 917
 918 struct work_struct;
 919 int kblockd_schedule_work(struct work_struct *work);
 920 void kblockd_flush_work(struct work_struct *work);
 921
 922 #define MODULE_ALIAS_BLOCKDEV(major,minor) \
 923         MODULE_ALIAS("block-major-" __stringify(major) "-" __stringify(minor))
 924 #define MODULE_ALIAS_BLOCKDEV_MAJOR(major) \
 925         MODULE_ALIAS("block-major-" __stringify(major) "-*")
 926
 927 #if defined(CONFIG_BLK_DEV_INTEGRITY)
 928
 929 #define INTEGRITY_FLAG_READ     2       /* verify data integrity on read */
 930 #define INTEGRITY_FLAG_WRITE    4       /* generate data integrity on write */
 931
 932 struct blk_integrity_exchg {
 933         void                    *prot_buf;
 934         void                    *data_buf;
 935         sector_t                sector;
 936         unsigned int            data_size;
 937         unsigned short          sector_size;
 938         const char              *disk_name;
 939 };
 940
 941 typedef void (integrity_gen_fn) (struct blk_integrity_exchg *);
 942 typedef int (integrity_vrfy_fn) (struct blk_integrity_exchg *);
 943 typedef void (integrity_set_tag_fn) (void *, void *, unsigned int);
 944 typedef void (integrity_get_tag_fn) (void *, void *, unsigned int);
 945
 946 struct blk_integrity {
 947         integrity_gen_fn        *generate_fn;
 948         integrity_vrfy_fn       *verify_fn;
 949         integrity_set_tag_fn    *set_tag_fn;
 950         integrity_get_tag_fn    *get_tag_fn;
 951
 952         unsigned short          flags;
 953         unsigned short          tuple_size;
 954         unsigned short          sector_size;
 955         unsigned short          tag_size;
 956
 957         const char              *name;
 958
 959         struct kobject          kobj;
 960 };
 961
 962 extern int blk_integrity_register(struct gendisk *, struct blk_integrity *);
 963 extern void blk_integrity_unregister(struct gendisk *);
 964 extern int blk_integrity_compare(struct block_device *, struct block_device *);
 965 extern int blk_rq_map_integrity_sg(struct request *, struct scatterlist *);
 966 extern int blk_rq_count_integrity_sg(struct request *);
 967
 968 static inline unsigned short blk_integrity_tuple_size(struct blk_integrity *bi)
 969 {
 970         if (bi)
 971                 return bi->tuple_size;
 972
 973         return 0;
 974 }
 975
 976 static inline struct blk_integrity *bdev_get_integrity(struct block_device *bdev)
 977 {
 978         return bdev->bd_disk->integrity;
 979 }
 980
 981 static inline unsigned int bdev_get_tag_size(struct block_device *bdev)
 982 {
 983         struct blk_integrity *bi = bdev_get_integrity(bdev);
 984
 985         if (bi)
 986                 return bi->tag_size;
 987
 988         return 0;
 989 }
 990
 991 static inline int bdev_integrity_enabled(struct block_device *bdev, int rw)
 992 {
 993         struct blk_integrity *bi = bdev_get_integrity(bdev);
 994
 995         if (bi == NULL)
 996                 return 0;
 997
 998         if (rw == READ && bi->verify_fn != NULL &&
 999             (bi->flags & INTEGRITY_FLAG_READ))
1000                 return 1;
1001
1002         if (rw == WRITE && bi->generate_fn != NULL &&
1003             (bi->flags & INTEGRITY_FLAG_WRITE))
1004                 return 1;
1005
1006         return 0;
1007 }
1008
1009 static inline int blk_integrity_rq(struct request *rq)
1010 {
1011         if (rq->bio == NULL)
1012                 return 0;
1013
1014         return bio_integrity(rq->bio);
1015 }
1016
1017 #else /* CONFIG_BLK_DEV_INTEGRITY */
1018
1019 #define blk_integrity_rq(rq)                    (0)
1020 #define blk_rq_count_integrity_sg(a)            (0)
1021 #define blk_rq_map_integrity_sg(a, b)           (0)
1022 #define bdev_get_integrity(a)                   (0)
1023 #define bdev_get_tag_size(a)                    (0)
1024 #define blk_integrity_compare(a, b)             (0)
1025 #define blk_integrity_register(a, b)            (0)
1026 #define blk_integrity_unregister(a)             do { } while (0);
1027
1028 #endif /* CONFIG_BLK_DEV_INTEGRITY */
1029
1030 #else /* CONFIG_BLOCK */
1031 /*
1032  * stubs for when the block layer is configured out
1033  */
1034 #define buffer_heads_over_limit 0
1035
1036 static inline long nr_blockdev_pages(void)
1037 {
1038         return 0;
1039 }
1040
1041 #endif /* CONFIG_BLOCK */
1042
1043 #endif