block: seperate bio/request unplug and sync bits
[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         int count[2];
42         int starved[2];
43         int elvpriv;
44         mempool_t *rq_pool;
45         wait_queue_head_t wait[2];
46 };
47
48 /*
49  * request command types
50  */
51 enum rq_cmd_type_bits {
52         REQ_TYPE_FS             = 1,    /* fs request */
53         REQ_TYPE_BLOCK_PC,              /* scsi command */
54         REQ_TYPE_SENSE,                 /* sense request */
55         REQ_TYPE_PM_SUSPEND,            /* suspend request */
56         REQ_TYPE_PM_RESUME,             /* resume request */
57         REQ_TYPE_PM_SHUTDOWN,           /* shutdown 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         REQ_LB_OP_EJECT = 0x40,         /* eject request */
80         REQ_LB_OP_FLUSH = 0x41,         /* flush request */
81         REQ_LB_OP_DISCARD = 0x42,       /* discard sectors */
82 };
83
84 /*
85  * request type modified bits. first two bits match BIO_RW* bits, important
86  */
87 enum rq_flag_bits {
88         __REQ_RW,               /* not set, read. set, write */
89         __REQ_FAILFAST_DEV,     /* no driver retries of device errors */
90         __REQ_FAILFAST_TRANSPORT, /* no driver retries of transport errors */
91         __REQ_FAILFAST_DRIVER,  /* no driver retries of driver errors */
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_UNPLUG,           /* unplug queue on submission */
112         __REQ_NR_BITS,          /* stops here */
113 };
114
115 #define REQ_RW          (1 << __REQ_RW)
116 #define REQ_FAILFAST_DEV        (1 << __REQ_FAILFAST_DEV)
117 #define REQ_FAILFAST_TRANSPORT  (1 << __REQ_FAILFAST_TRANSPORT)
118 #define REQ_FAILFAST_DRIVER     (1 << __REQ_FAILFAST_DRIVER)
119 #define REQ_DISCARD     (1 << __REQ_DISCARD)
120 #define REQ_SORTED      (1 << __REQ_SORTED)
121 #define REQ_SOFTBARRIER (1 << __REQ_SOFTBARRIER)
122 #define REQ_HARDBARRIER (1 << __REQ_HARDBARRIER)
123 #define REQ_FUA         (1 << __REQ_FUA)
124 #define REQ_NOMERGE     (1 << __REQ_NOMERGE)
125 #define REQ_STARTED     (1 << __REQ_STARTED)
126 #define REQ_DONTPREP    (1 << __REQ_DONTPREP)
127 #define REQ_QUEUED      (1 << __REQ_QUEUED)
128 #define REQ_ELVPRIV     (1 << __REQ_ELVPRIV)
129 #define REQ_FAILED      (1 << __REQ_FAILED)
130 #define REQ_QUIET       (1 << __REQ_QUIET)
131 #define REQ_PREEMPT     (1 << __REQ_PREEMPT)
132 #define REQ_ORDERED_COLOR       (1 << __REQ_ORDERED_COLOR)
133 #define REQ_RW_SYNC     (1 << __REQ_RW_SYNC)
134 #define REQ_ALLOCED     (1 << __REQ_ALLOCED)
135 #define REQ_RW_META     (1 << __REQ_RW_META)
136 #define REQ_COPY_USER   (1 << __REQ_COPY_USER)
137 #define REQ_INTEGRITY   (1 << __REQ_INTEGRITY)
138 #define REQ_UNPLUG      (1 << __REQ_UNPLUG)
139
140 #define BLK_MAX_CDB     16
141
142 /*
143  * try to put the fields that are referenced together in the same cacheline.
144  * if you modify this structure, be sure to check block/blk-core.c:rq_init()
145  * as well!
146  */
147 struct request {
148         struct list_head queuelist;
149         struct call_single_data csd;
150         int cpu;
151
152         struct request_queue *q;
153
154         unsigned int cmd_flags;
155         enum rq_cmd_type_bits cmd_type;
156         unsigned long atomic_flags;
157
158         /* Maintain bio traversal state for part by part I/O submission.
159          * hard_* are block layer internals, no driver should touch them!
160          */
161
162         sector_t sector;                /* next sector to submit */
163         sector_t hard_sector;           /* next sector to complete */
164         unsigned long nr_sectors;       /* no. of sectors left to submit */
165         unsigned long hard_nr_sectors;  /* no. of sectors left to complete */
166         /* no. of sectors left to submit in the current segment */
167         unsigned int current_nr_sectors;
168
169         /* no. of sectors left to complete in the current segment */
170         unsigned int hard_cur_sectors;
171
172         struct bio *bio;
173         struct bio *biotail;
174
175         struct hlist_node hash; /* merge hash */
176         /*
177          * The rb_node is only used inside the io scheduler, requests
178          * are pruned when moved to the dispatch queue. So let the
179          * completion_data share space with the rb_node.
180          */
181         union {
182                 struct rb_node rb_node; /* sort/lookup */
183                 void *completion_data;
184         };
185
186         /*
187          * two pointers are available for the IO schedulers, if they need
188          * more they have to dynamically allocate it.
189          */
190         void *elevator_private;
191         void *elevator_private2;
192
193         struct gendisk *rq_disk;
194         unsigned long start_time;
195
196         /* Number of scatter-gather DMA addr+len pairs after
197          * physical address coalescing is performed.
198          */
199         unsigned short nr_phys_segments;
200
201         unsigned short ioprio;
202
203         void *special;
204         char *buffer;
205
206         int tag;
207         int errors;
208
209         int ref_count;
210
211         /*
212          * when request is used as a packet command carrier
213          */
214         unsigned short cmd_len;
215         unsigned char __cmd[BLK_MAX_CDB];
216         unsigned char *cmd;
217
218         unsigned int data_len;
219         unsigned int extra_len; /* length of alignment and padding */
220         unsigned int sense_len;
221         void *data;
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;
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_READFULL     3       /* read queue has been filled */
442 #define QUEUE_FLAG_WRITEFULL    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
455 static inline int queue_is_locked(struct request_queue *q)
456 {
457 #ifdef CONFIG_SMP
458         spinlock_t *lock = q->queue_lock;
459         return lock && spin_is_locked(lock);
460 #else
461         return 1;
462 #endif
463 }
464
465 static inline void queue_flag_set_unlocked(unsigned int flag,
466                                            struct request_queue *q)
467 {
468         __set_bit(flag, &q->queue_flags);
469 }
470
471 static inline int queue_flag_test_and_clear(unsigned int flag,
472                                             struct request_queue *q)
473 {
474         WARN_ON_ONCE(!queue_is_locked(q));
475
476         if (test_bit(flag, &q->queue_flags)) {
477                 __clear_bit(flag, &q->queue_flags);
478                 return 1;
479         }
480
481         return 0;
482 }
483
484 static inline int queue_flag_test_and_set(unsigned int flag,
485                                           struct request_queue *q)
486 {
487         WARN_ON_ONCE(!queue_is_locked(q));
488
489         if (!test_bit(flag, &q->queue_flags)) {
490                 __set_bit(flag, &q->queue_flags);
491                 return 0;
492         }
493
494         return 1;
495 }
496
497 static inline void queue_flag_set(unsigned int flag, struct request_queue *q)
498 {
499         WARN_ON_ONCE(!queue_is_locked(q));
500         __set_bit(flag, &q->queue_flags);
501 }
502
503 static inline void queue_flag_clear_unlocked(unsigned int flag,
504                                              struct request_queue *q)
505 {
506         __clear_bit(flag, &q->queue_flags);
507 }
508
509 static inline void queue_flag_clear(unsigned int flag, struct request_queue *q)
510 {
511         WARN_ON_ONCE(!queue_is_locked(q));
512         __clear_bit(flag, &q->queue_flags);
513 }
514
515 enum {
516         /*
517          * Hardbarrier is supported with one of the following methods.
518          *
519          * NONE         : hardbarrier unsupported
520          * DRAIN        : ordering by draining is enough
521          * DRAIN_FLUSH  : ordering by draining w/ pre and post flushes
522          * DRAIN_FUA    : ordering by draining w/ pre flush and FUA write
523          * TAG          : ordering by tag is enough
524          * TAG_FLUSH    : ordering by tag w/ pre and post flushes
525          * TAG_FUA      : ordering by tag w/ pre flush and FUA write
526          */
527         QUEUE_ORDERED_BY_DRAIN          = 0x01,
528         QUEUE_ORDERED_BY_TAG            = 0x02,
529         QUEUE_ORDERED_DO_PREFLUSH       = 0x10,
530         QUEUE_ORDERED_DO_BAR            = 0x20,
531         QUEUE_ORDERED_DO_POSTFLUSH      = 0x40,
532         QUEUE_ORDERED_DO_FUA            = 0x80,
533
534         QUEUE_ORDERED_NONE              = 0x00,
535
536         QUEUE_ORDERED_DRAIN             = QUEUE_ORDERED_BY_DRAIN |
537                                           QUEUE_ORDERED_DO_BAR,
538         QUEUE_ORDERED_DRAIN_FLUSH       = QUEUE_ORDERED_DRAIN |
539                                           QUEUE_ORDERED_DO_PREFLUSH |
540                                           QUEUE_ORDERED_DO_POSTFLUSH,
541         QUEUE_ORDERED_DRAIN_FUA         = QUEUE_ORDERED_DRAIN |
542                                           QUEUE_ORDERED_DO_PREFLUSH |
543                                           QUEUE_ORDERED_DO_FUA,
544
545         QUEUE_ORDERED_TAG               = QUEUE_ORDERED_BY_TAG |
546                                           QUEUE_ORDERED_DO_BAR,
547         QUEUE_ORDERED_TAG_FLUSH         = QUEUE_ORDERED_TAG |
548                                           QUEUE_ORDERED_DO_PREFLUSH |
549                                           QUEUE_ORDERED_DO_POSTFLUSH,
550         QUEUE_ORDERED_TAG_FUA           = QUEUE_ORDERED_TAG |
551                                           QUEUE_ORDERED_DO_PREFLUSH |
552                                           QUEUE_ORDERED_DO_FUA,
553
554         /*
555          * Ordered operation sequence
556          */
557         QUEUE_ORDSEQ_STARTED    = 0x01, /* flushing in progress */
558         QUEUE_ORDSEQ_DRAIN      = 0x02, /* waiting for the queue to be drained */
559         QUEUE_ORDSEQ_PREFLUSH   = 0x04, /* pre-flushing in progress */
560         QUEUE_ORDSEQ_BAR        = 0x08, /* original barrier req in progress */
561         QUEUE_ORDSEQ_POSTFLUSH  = 0x10, /* post-flushing in progress */
562         QUEUE_ORDSEQ_DONE       = 0x20,
563 };
564
565 #define blk_queue_plugged(q)    test_bit(QUEUE_FLAG_PLUGGED, &(q)->queue_flags)
566 #define blk_queue_tagged(q)     test_bit(QUEUE_FLAG_QUEUED, &(q)->queue_flags)
567 #define blk_queue_stopped(q)    test_bit(QUEUE_FLAG_STOPPED, &(q)->queue_flags)
568 #define blk_queue_nomerges(q)   test_bit(QUEUE_FLAG_NOMERGES, &(q)->queue_flags)
569 #define blk_queue_nonrot(q)     test_bit(QUEUE_FLAG_NONROT, &(q)->queue_flags)
570 #define blk_queue_flushing(q)   ((q)->ordseq)
571 #define blk_queue_stackable(q)  \
572         test_bit(QUEUE_FLAG_STACKABLE, &(q)->queue_flags)
573
574 #define blk_fs_request(rq)      ((rq)->cmd_type == REQ_TYPE_FS)
575 #define blk_pc_request(rq)      ((rq)->cmd_type == REQ_TYPE_BLOCK_PC)
576 #define blk_special_request(rq) ((rq)->cmd_type == REQ_TYPE_SPECIAL)
577 #define blk_sense_request(rq)   ((rq)->cmd_type == REQ_TYPE_SENSE)
578
579 #define blk_failfast_dev(rq)    ((rq)->cmd_flags & REQ_FAILFAST_DEV)
580 #define blk_failfast_transport(rq) ((rq)->cmd_flags & REQ_FAILFAST_TRANSPORT)
581 #define blk_failfast_driver(rq) ((rq)->cmd_flags & REQ_FAILFAST_DRIVER)
582 #define blk_noretry_request(rq) (blk_failfast_dev(rq) ||        \
583                                  blk_failfast_transport(rq) ||  \
584                                  blk_failfast_driver(rq))
585 #define blk_rq_started(rq)      ((rq)->cmd_flags & REQ_STARTED)
586
587 #define blk_account_rq(rq)      (blk_rq_started(rq) && (blk_fs_request(rq) || blk_discard_rq(rq))) 
588
589 #define blk_pm_suspend_request(rq)      ((rq)->cmd_type == REQ_TYPE_PM_SUSPEND)
590 #define blk_pm_resume_request(rq)       ((rq)->cmd_type == REQ_TYPE_PM_RESUME)
591 #define blk_pm_request(rq)      \
592         (blk_pm_suspend_request(rq) || blk_pm_resume_request(rq))
593
594 #define blk_rq_cpu_valid(rq)    ((rq)->cpu != -1)
595 #define blk_sorted_rq(rq)       ((rq)->cmd_flags & REQ_SORTED)
596 #define blk_barrier_rq(rq)      ((rq)->cmd_flags & REQ_HARDBARRIER)
597 #define blk_fua_rq(rq)          ((rq)->cmd_flags & REQ_FUA)
598 #define blk_discard_rq(rq)      ((rq)->cmd_flags & REQ_DISCARD)
599 #define blk_bidi_rq(rq)         ((rq)->next_rq != NULL)
600 /* rq->queuelist of dequeued request must be list_empty() */
601 #define blk_queued_rq(rq)       (!list_empty(&(rq)->queuelist))
602
603 #define list_entry_rq(ptr)      list_entry((ptr), struct request, queuelist)
604
605 #define rq_data_dir(rq)         ((rq)->cmd_flags & 1)
606
607 /*
608  * We regard a request as sync, if it's a READ or a SYNC write.
609  */
610 #define rq_is_sync(rq)          (rq_data_dir((rq)) == READ || (rq)->cmd_flags & REQ_RW_SYNC)
611 #define rq_is_meta(rq)          ((rq)->cmd_flags & REQ_RW_META)
612
613 static inline int blk_queue_full(struct request_queue *q, int rw)
614 {
615         if (rw == READ)
616                 return test_bit(QUEUE_FLAG_READFULL, &q->queue_flags);
617         return test_bit(QUEUE_FLAG_WRITEFULL, &q->queue_flags);
618 }
619
620 static inline void blk_set_queue_full(struct request_queue *q, int rw)
621 {
622         if (rw == READ)
623                 queue_flag_set(QUEUE_FLAG_READFULL, q);
624         else
625                 queue_flag_set(QUEUE_FLAG_WRITEFULL, q);
626 }
627
628 static inline void blk_clear_queue_full(struct request_queue *q, int rw)
629 {
630         if (rw == READ)
631                 queue_flag_clear(QUEUE_FLAG_READFULL, q);
632         else
633                 queue_flag_clear(QUEUE_FLAG_WRITEFULL, q);
634 }
635
636
637 /*
638  * mergeable request must not have _NOMERGE or _BARRIER bit set, nor may
639  * it already be started by driver.
640  */
641 #define RQ_NOMERGE_FLAGS        \
642         (REQ_NOMERGE | REQ_STARTED | REQ_HARDBARRIER | REQ_SOFTBARRIER)
643 #define rq_mergeable(rq)        \
644         (!((rq)->cmd_flags & RQ_NOMERGE_FLAGS) && \
645          (blk_discard_rq(rq) || blk_fs_request((rq))))
646
647 /*
648  * q->prep_rq_fn return values
649  */
650 #define BLKPREP_OK              0       /* serve it */
651 #define BLKPREP_KILL            1       /* fatal error, kill */
652 #define BLKPREP_DEFER           2       /* leave on queue */
653
654 extern unsigned long blk_max_low_pfn, blk_max_pfn;
655
656 /*
657  * standard bounce addresses:
658  *
659  * BLK_BOUNCE_HIGH      : bounce all highmem pages
660  * BLK_BOUNCE_ANY       : don't bounce anything
661  * BLK_BOUNCE_ISA       : bounce pages above ISA DMA boundary
662  */
663
664 #if BITS_PER_LONG == 32
665 #define BLK_BOUNCE_HIGH         ((u64)blk_max_low_pfn << PAGE_SHIFT)
666 #else
667 #define BLK_BOUNCE_HIGH         -1ULL
668 #endif
669 #define BLK_BOUNCE_ANY          (-1ULL)
670 #define BLK_BOUNCE_ISA          (ISA_DMA_THRESHOLD)
671
672 /*
673  * default timeout for SG_IO if none specified
674  */
675 #define BLK_DEFAULT_SG_TIMEOUT  (60 * HZ)
676 #define BLK_MIN_SG_TIMEOUT      (7 * HZ)
677
678 #ifdef CONFIG_BOUNCE
679 extern int init_emergency_isa_pool(void);
680 extern void blk_queue_bounce(struct request_queue *q, struct bio **bio);
681 #else
682 static inline int init_emergency_isa_pool(void)
683 {
684         return 0;
685 }
686 static inline void blk_queue_bounce(struct request_queue *q, struct bio **bio)
687 {
688 }
689 #endif /* CONFIG_MMU */
690
691 struct rq_map_data {
692         struct page **pages;
693         int page_order;
694         int nr_entries;
695         unsigned long offset;
696         int null_mapped;
697 };
698
699 struct req_iterator {
700         int i;
701         struct bio *bio;
702 };
703
704 /* This should not be used directly - use rq_for_each_segment */
705 #define __rq_for_each_bio(_bio, rq)     \
706         if ((rq->bio))                  \
707                 for (_bio = (rq)->bio; _bio; _bio = _bio->bi_next)
708
709 #define rq_for_each_segment(bvl, _rq, _iter)                    \
710         __rq_for_each_bio(_iter.bio, _rq)                       \
711                 bio_for_each_segment(bvl, _iter.bio, _iter.i)
712
713 #define rq_iter_last(rq, _iter)                                 \
714                 (_iter.bio->bi_next == NULL && _iter.i == _iter.bio->bi_vcnt-1)
715
716 extern int blk_register_queue(struct gendisk *disk);
717 extern void blk_unregister_queue(struct gendisk *disk);
718 extern void register_disk(struct gendisk *dev);
719 extern void generic_make_request(struct bio *bio);
720 extern void blk_rq_init(struct request_queue *q, struct request *rq);
721 extern void blk_put_request(struct request *);
722 extern void __blk_put_request(struct request_queue *, struct request *);
723 extern struct request *blk_get_request(struct request_queue *, int, gfp_t);
724 extern void blk_insert_request(struct request_queue *, struct request *, int, void *);
725 extern void blk_requeue_request(struct request_queue *, struct request *);
726 extern int blk_rq_check_limits(struct request_queue *q, struct request *rq);
727 extern int blk_lld_busy(struct request_queue *q);
728 extern int blk_insert_cloned_request(struct request_queue *q,
729                                      struct request *rq);
730 extern void blk_plug_device(struct request_queue *);
731 extern void blk_plug_device_unlocked(struct request_queue *);
732 extern int blk_remove_plug(struct request_queue *);
733 extern void blk_recount_segments(struct request_queue *, struct bio *);
734 extern int scsi_cmd_ioctl(struct request_queue *, struct gendisk *, fmode_t,
735                           unsigned int, void __user *);
736 extern int sg_scsi_ioctl(struct request_queue *, struct gendisk *, fmode_t,
737                          struct scsi_ioctl_command __user *);
738
739 /*
740  * Temporary export, until SCSI gets fixed up.
741  */
742 extern int blk_rq_append_bio(struct request_queue *q, struct request *rq,
743                              struct bio *bio);
744
745 /*
746  * A queue has just exitted congestion.  Note this in the global counter of
747  * congested queues, and wake up anyone who was waiting for requests to be
748  * put back.
749  */
750 static inline void blk_clear_queue_congested(struct request_queue *q, int rw)
751 {
752         clear_bdi_congested(&q->backing_dev_info, rw);
753 }
754
755 /*
756  * A queue has just entered congestion.  Flag that in the queue's VM-visible
757  * state flags and increment the global gounter of congested queues.
758  */
759 static inline void blk_set_queue_congested(struct request_queue *q, int rw)
760 {
761         set_bdi_congested(&q->backing_dev_info, rw);
762 }
763
764 extern void blk_start_queue(struct request_queue *q);
765 extern void blk_stop_queue(struct request_queue *q);
766 extern void blk_sync_queue(struct request_queue *q);
767 extern void __blk_stop_queue(struct request_queue *q);
768 extern void __blk_run_queue(struct request_queue *);
769 extern void blk_run_queue(struct request_queue *);
770 extern void blk_start_queueing(struct request_queue *);
771 extern int blk_rq_map_user(struct request_queue *, struct request *,
772                            struct rq_map_data *, void __user *, unsigned long,
773                            gfp_t);
774 extern int blk_rq_unmap_user(struct bio *);
775 extern int blk_rq_map_kern(struct request_queue *, struct request *, void *, unsigned int, gfp_t);
776 extern int blk_rq_map_user_iov(struct request_queue *, struct request *,
777                                struct rq_map_data *, struct sg_iovec *, int,
778                                unsigned int, gfp_t);
779 extern int blk_execute_rq(struct request_queue *, struct gendisk *,
780                           struct request *, int);
781 extern void blk_execute_rq_nowait(struct request_queue *, struct gendisk *,
782                                   struct request *, int, rq_end_io_fn *);
783 extern void blk_unplug(struct request_queue *q);
784
785 static inline struct request_queue *bdev_get_queue(struct block_device *bdev)
786 {
787         return bdev->bd_disk->queue;
788 }
789
790 static inline void blk_run_backing_dev(struct backing_dev_info *bdi,
791                                        struct page *page)
792 {
793         if (bdi && bdi->unplug_io_fn)
794                 bdi->unplug_io_fn(bdi, page);
795 }
796
797 static inline void blk_run_address_space(struct address_space *mapping)
798 {
799         if (mapping)
800                 blk_run_backing_dev(mapping->backing_dev_info, NULL);
801 }
802
803 extern void blkdev_dequeue_request(struct request *req);
804
805 /*
806  * blk_end_request() and friends.
807  * __blk_end_request() and end_request() must be called with
808  * the request queue spinlock acquired.
809  *
810  * Several drivers define their own end_request and call
811  * blk_end_request() for parts of the original function.
812  * This prevents code duplication in drivers.
813  */
814 extern int blk_end_request(struct request *rq, int error,
815                                 unsigned int nr_bytes);
816 extern int __blk_end_request(struct request *rq, int error,
817                                 unsigned int nr_bytes);
818 extern int blk_end_bidi_request(struct request *rq, int error,
819                                 unsigned int nr_bytes, unsigned int bidi_bytes);
820 extern void end_request(struct request *, int);
821 extern int blk_end_request_callback(struct request *rq, int error,
822                                 unsigned int nr_bytes,
823                                 int (drv_callback)(struct request *));
824 extern void blk_complete_request(struct request *);
825 extern void __blk_complete_request(struct request *);
826 extern void blk_abort_request(struct request *);
827 extern void blk_abort_queue(struct request_queue *);
828 extern void blk_update_request(struct request *rq, int error,
829                                unsigned int nr_bytes);
830
831 /*
832  * blk_end_request() takes bytes instead of sectors as a complete size.
833  * blk_rq_bytes() returns bytes left to complete in the entire request.
834  * blk_rq_cur_bytes() returns bytes left to complete in the current segment.
835  */
836 extern unsigned int blk_rq_bytes(struct request *rq);
837 extern unsigned int blk_rq_cur_bytes(struct request *rq);
838
839 /*
840  * Access functions for manipulating queue properties
841  */
842 extern struct request_queue *blk_init_queue_node(request_fn_proc *rfn,
843                                         spinlock_t *lock, int node_id);
844 extern struct request_queue *blk_init_queue(request_fn_proc *, spinlock_t *);
845 extern void blk_cleanup_queue(struct request_queue *);
846 extern void blk_queue_make_request(struct request_queue *, make_request_fn *);
847 extern void blk_queue_bounce_limit(struct request_queue *, u64);
848 extern void blk_queue_max_sectors(struct request_queue *, unsigned int);
849 extern void blk_queue_max_phys_segments(struct request_queue *, unsigned short);
850 extern void blk_queue_max_hw_segments(struct request_queue *, unsigned short);
851 extern void blk_queue_max_segment_size(struct request_queue *, unsigned int);
852 extern void blk_queue_hardsect_size(struct request_queue *, unsigned short);
853 extern void blk_queue_stack_limits(struct request_queue *t, struct request_queue *b);
854 extern void blk_queue_dma_pad(struct request_queue *, unsigned int);
855 extern void blk_queue_update_dma_pad(struct request_queue *, unsigned int);
856 extern int blk_queue_dma_drain(struct request_queue *q,
857                                dma_drain_needed_fn *dma_drain_needed,
858                                void *buf, unsigned int size);
859 extern void blk_queue_lld_busy(struct request_queue *q, lld_busy_fn *fn);
860 extern void blk_queue_segment_boundary(struct request_queue *, unsigned long);
861 extern void blk_queue_prep_rq(struct request_queue *, prep_rq_fn *pfn);
862 extern void blk_queue_merge_bvec(struct request_queue *, merge_bvec_fn *);
863 extern void blk_queue_dma_alignment(struct request_queue *, int);
864 extern void blk_queue_update_dma_alignment(struct request_queue *, int);
865 extern void blk_queue_softirq_done(struct request_queue *, softirq_done_fn *);
866 extern void blk_queue_set_discard(struct request_queue *, prepare_discard_fn *);
867 extern void blk_queue_rq_timed_out(struct request_queue *, rq_timed_out_fn *);
868 extern void blk_queue_rq_timeout(struct request_queue *, unsigned int);
869 extern struct backing_dev_info *blk_get_backing_dev_info(struct block_device *bdev);
870 extern int blk_queue_ordered(struct request_queue *, unsigned, prepare_flush_fn *);
871 extern bool blk_do_ordered(struct request_queue *, struct request **);
872 extern unsigned blk_ordered_cur_seq(struct request_queue *);
873 extern unsigned blk_ordered_req_seq(struct request *);
874 extern bool blk_ordered_complete_seq(struct request_queue *, unsigned, int);
875
876 extern int blk_rq_map_sg(struct request_queue *, struct request *, struct scatterlist *);
877 extern void blk_dump_rq_flags(struct request *, char *);
878 extern void generic_unplug_device(struct request_queue *);
879 extern long nr_blockdev_pages(void);
880
881 int blk_get_queue(struct request_queue *);
882 struct request_queue *blk_alloc_queue(gfp_t);
883 struct request_queue *blk_alloc_queue_node(gfp_t, int);
884 extern void blk_put_queue(struct request_queue *);
885
886 /*
887  * tag stuff
888  */
889 #define blk_rq_tagged(rq)               ((rq)->cmd_flags & REQ_QUEUED)
890 extern int blk_queue_start_tag(struct request_queue *, struct request *);
891 extern struct request *blk_queue_find_tag(struct request_queue *, int);
892 extern void blk_queue_end_tag(struct request_queue *, struct request *);
893 extern int blk_queue_init_tags(struct request_queue *, int, struct blk_queue_tag *);
894 extern void blk_queue_free_tags(struct request_queue *);
895 extern int blk_queue_resize_tags(struct request_queue *, int);
896 extern void blk_queue_invalidate_tags(struct request_queue *);
897 extern struct blk_queue_tag *blk_init_tags(int);
898 extern void blk_free_tags(struct blk_queue_tag *);
899
900 static inline struct request *blk_map_queue_find_tag(struct blk_queue_tag *bqt,
901                                                 int tag)
902 {
903         if (unlikely(bqt == NULL || tag >= bqt->real_max_depth))
904                 return NULL;
905         return bqt->tag_index[tag];
906 }
907
908 extern int blkdev_issue_flush(struct block_device *, sector_t *);
909 extern int blkdev_issue_discard(struct block_device *,
910                                 sector_t sector, sector_t nr_sects, gfp_t);
911
912 static inline int sb_issue_discard(struct super_block *sb,
913                                    sector_t block, sector_t nr_blocks)
914 {
915         block <<= (sb->s_blocksize_bits - 9);
916         nr_blocks <<= (sb->s_blocksize_bits - 9);
917         return blkdev_issue_discard(sb->s_bdev, block, nr_blocks, GFP_KERNEL);
918 }
919
920 /*
921 * command filter functions
922 */
923 extern int blk_verify_command(struct blk_cmd_filter *filter,
924                               unsigned char *cmd, fmode_t has_write_perm);
925 extern void blk_unregister_filter(struct gendisk *disk);
926 extern void blk_set_cmd_filter_defaults(struct blk_cmd_filter *filter);
927
928 #define MAX_PHYS_SEGMENTS 128
929 #define MAX_HW_SEGMENTS 128
930 #define SAFE_MAX_SECTORS 255
931 #define BLK_DEF_MAX_SECTORS 1024
932
933 #define MAX_SEGMENT_SIZE        65536
934
935 #define BLK_SEG_BOUNDARY_MASK   0xFFFFFFFFUL
936
937 #define blkdev_entry_to_request(entry) list_entry((entry), struct request, queuelist)
938
939 static inline int queue_hardsect_size(struct request_queue *q)
940 {
941         int retval = 512;
942
943         if (q && q->hardsect_size)
944                 retval = q->hardsect_size;
945
946         return retval;
947 }
948
949 static inline int bdev_hardsect_size(struct block_device *bdev)
950 {
951         return queue_hardsect_size(bdev_get_queue(bdev));
952 }
953
954 static inline int queue_dma_alignment(struct request_queue *q)
955 {
956         return q ? q->dma_alignment : 511;
957 }
958
959 static inline int blk_rq_aligned(struct request_queue *q, void *addr,
960                                  unsigned int len)
961 {
962         unsigned int alignment = queue_dma_alignment(q) | q->dma_pad_mask;
963         return !((unsigned long)addr & alignment) && !(len & alignment);
964 }
965
966 /* assumes size > 256 */
967 static inline unsigned int blksize_bits(unsigned int size)
968 {
969         unsigned int bits = 8;
970         do {
971                 bits++;
972                 size >>= 1;
973         } while (size > 256);
974         return bits;
975 }
976
977 static inline unsigned int block_size(struct block_device *bdev)
978 {
979         return bdev->bd_block_size;
980 }
981
982 typedef struct {struct page *v;} Sector;
983
984 unsigned char *read_dev_sector(struct block_device *, sector_t, Sector *);
985
986 static inline void put_dev_sector(Sector p)
987 {
988         page_cache_release(p.v);
989 }
990
991 struct work_struct;
992 int kblockd_schedule_work(struct request_queue *q, struct work_struct *work);
993
994 #define MODULE_ALIAS_BLOCKDEV(major,minor) \
995         MODULE_ALIAS("block-major-" __stringify(major) "-" __stringify(minor))
996 #define MODULE_ALIAS_BLOCKDEV_MAJOR(major) \
997         MODULE_ALIAS("block-major-" __stringify(major) "-*")
998
999 #if defined(CONFIG_BLK_DEV_INTEGRITY)
1000
1001 #define INTEGRITY_FLAG_READ     2       /* verify data integrity on read */
1002 #define INTEGRITY_FLAG_WRITE    4       /* generate data integrity on write */
1003
1004 struct blk_integrity_exchg {
1005         void                    *prot_buf;
1006         void                    *data_buf;
1007         sector_t                sector;
1008         unsigned int            data_size;
1009         unsigned short          sector_size;
1010         const char              *disk_name;
1011 };
1012
1013 typedef void (integrity_gen_fn) (struct blk_integrity_exchg *);
1014 typedef int (integrity_vrfy_fn) (struct blk_integrity_exchg *);
1015 typedef void (integrity_set_tag_fn) (void *, void *, unsigned int);
1016 typedef void (integrity_get_tag_fn) (void *, void *, unsigned int);
1017
1018 struct blk_integrity {
1019         integrity_gen_fn        *generate_fn;
1020         integrity_vrfy_fn       *verify_fn;
1021         integrity_set_tag_fn    *set_tag_fn;
1022         integrity_get_tag_fn    *get_tag_fn;
1023
1024         unsigned short          flags;
1025         unsigned short          tuple_size;
1026         unsigned short          sector_size;
1027         unsigned short          tag_size;
1028
1029         const char              *name;
1030
1031         struct kobject          kobj;
1032 };
1033
1034 extern int blk_integrity_register(struct gendisk *, struct blk_integrity *);
1035 extern void blk_integrity_unregister(struct gendisk *);
1036 extern int blk_integrity_compare(struct gendisk *, struct gendisk *);
1037 extern int blk_rq_map_integrity_sg(struct request *, struct scatterlist *);
1038 extern int blk_rq_count_integrity_sg(struct request *);
1039
1040 static inline
1041 struct blk_integrity *bdev_get_integrity(struct block_device *bdev)
1042 {
1043         return bdev->bd_disk->integrity;
1044 }
1045
1046 static inline struct blk_integrity *blk_get_integrity(struct gendisk *disk)
1047 {
1048         return disk->integrity;
1049 }
1050
1051 static inline int blk_integrity_rq(struct request *rq)
1052 {
1053         if (rq->bio == NULL)
1054                 return 0;
1055
1056         return bio_integrity(rq->bio);
1057 }
1058
1059 #else /* CONFIG_BLK_DEV_INTEGRITY */
1060
1061 #define blk_integrity_rq(rq)                    (0)
1062 #define blk_rq_count_integrity_sg(a)            (0)
1063 #define blk_rq_map_integrity_sg(a, b)           (0)
1064 #define bdev_get_integrity(a)                   (0)
1065 #define blk_get_integrity(a)                    (0)
1066 #define blk_integrity_compare(a, b)             (0)
1067 #define blk_integrity_register(a, b)            (0)
1068 #define blk_integrity_unregister(a)             do { } while (0);
1069
1070 #endif /* CONFIG_BLK_DEV_INTEGRITY */
1071
1072 struct block_device_operations {
1073         int (*open) (struct block_device *, fmode_t);
1074         int (*release) (struct gendisk *, fmode_t);
1075         int (*locked_ioctl) (struct block_device *, fmode_t, unsigned, unsigned long);
1076         int (*ioctl) (struct block_device *, fmode_t, unsigned, unsigned long);
1077         int (*compat_ioctl) (struct block_device *, fmode_t, unsigned, unsigned long);
1078         int (*direct_access) (struct block_device *, sector_t,
1079                                                 void **, unsigned long *);
1080         int (*media_changed) (struct gendisk *);
1081         int (*revalidate_disk) (struct gendisk *);
1082         int (*getgeo)(struct block_device *, struct hd_geometry *);
1083         struct module *owner;
1084 };
1085
1086 extern int __blkdev_driver_ioctl(struct block_device *, fmode_t, unsigned int,
1087                                  unsigned long);
1088 #else /* CONFIG_BLOCK */
1089 /*
1090  * stubs for when the block layer is configured out
1091  */
1092 #define buffer_heads_over_limit 0
1093
1094 static inline long nr_blockdev_pages(void)
1095 {
1096         return 0;
1097 }
1098
1099 #endif /* CONFIG_BLOCK */
1100
1101 #endif