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