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