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