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