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