blob: b32564a1e105c4220d14d988e6530a141b46be76 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001#ifndef _LINUX_BLKDEV_H
2#define _LINUX_BLKDEV_H
3
Andrew Mortonbcfd8d32006-08-31 12:56:06 +02004#include <linux/sched.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -07005#include <linux/major.h>
6#include <linux/genhd.h>
7#include <linux/list.h>
8#include <linux/timer.h>
9#include <linux/workqueue.h>
10#include <linux/pagemap.h>
11#include <linux/backing-dev.h>
12#include <linux/wait.h>
13#include <linux/mempool.h>
14#include <linux/bio.h>
15#include <linux/module.h>
16#include <linux/stringify.h>
FUJITA Tomonorid351af02007-07-09 12:40:35 +020017#include <linux/bsg.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070018
19#include <asm/scatterlist.h>
20
David Howells93614012006-09-30 20:45:40 +020021#ifdef CONFIG_LBD
22# include <asm/div64.h>
23# define sector_div(a, b) do_div(a, b)
24#else
25# define sector_div(n, b)( \
26{ \
27 int _res; \
28 _res = (n) % (b); \
29 (n) /= (b); \
30 _res; \
31} \
32)
33#endif
34
35#ifdef CONFIG_BLOCK
36
Christoph Hellwig21b2f0c2006-03-22 17:52:04 +010037struct scsi_ioctl_command;
38
Linus Torvalds1da177e2005-04-16 15:20:36 -070039struct request_queue;
40typedef struct request_queue request_queue_t;
41struct elevator_queue;
42typedef struct elevator_queue elevator_t;
43struct request_pm_state;
Jens Axboe2056a782006-03-23 20:00:26 +010044struct blk_trace;
Jens Axboe3d6392c2007-07-09 12:38:05 +020045struct request;
46struct sg_io_hdr;
Linus Torvalds1da177e2005-04-16 15:20:36 -070047
48#define BLKDEV_MIN_RQ 4
49#define BLKDEV_MAX_RQ 128 /* Default maximum */
50
51/*
52 * This is the per-process anticipatory I/O scheduler state.
53 */
54struct as_io_context {
55 spinlock_t lock;
56
57 void (*dtor)(struct as_io_context *aic); /* destructor */
58 void (*exit)(struct as_io_context *aic); /* called on task exit */
59
60 unsigned long state;
61 atomic_t nr_queued; /* queued reads & sync writes */
62 atomic_t nr_dispatched; /* number of requests gone to the drivers */
63
64 /* IO History tracking */
65 /* Thinktime */
66 unsigned long last_end_request;
67 unsigned long ttime_total;
68 unsigned long ttime_samples;
69 unsigned long ttime_mean;
70 /* Layout pattern */
71 unsigned int seek_samples;
72 sector_t last_request_pos;
73 u64 seek_total;
74 sector_t seek_mean;
75};
76
77struct cfq_queue;
78struct cfq_io_context {
Jens Axboee2d74ac2006-03-28 08:59:01 +020079 struct rb_node rb_node;
Jens Axboe22e2c502005-06-27 10:55:12 +020080 void *key;
81
Jens Axboee2d74ac2006-03-28 08:59:01 +020082 struct cfq_queue *cfqq[2];
83
Jens Axboe22e2c502005-06-27 10:55:12 +020084 struct io_context *ioc;
85
86 unsigned long last_end_request;
Jens Axboe206dc692006-03-28 13:03:44 +020087 sector_t last_request_pos;
Jens Axboe206dc692006-03-28 13:03:44 +020088
Jens Axboe22e2c502005-06-27 10:55:12 +020089 unsigned long ttime_total;
90 unsigned long ttime_samples;
91 unsigned long ttime_mean;
92
Jens Axboe206dc692006-03-28 13:03:44 +020093 unsigned int seek_samples;
94 u64 seek_total;
95 sector_t seek_mean;
96
Al Virod9ff4182006-03-18 13:51:22 -050097 struct list_head queue_list;
98
Jens Axboee2d74ac2006-03-28 08:59:01 +020099 void (*dtor)(struct io_context *); /* destructor */
100 void (*exit)(struct io_context *); /* called on task exit */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101};
102
103/*
104 * This is the per-process I/O subsystem state. It is refcounted and
105 * kmalloc'ed. Currently all fields are modified in process io context
106 * (apart from the atomic refcount), so require no locking.
107 */
108struct io_context {
109 atomic_t refcount;
Jens Axboe22e2c502005-06-27 10:55:12 +0200110 struct task_struct *task;
111
Jens Axboefc463792006-08-29 09:05:44 +0200112 unsigned int ioprio_changed;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113
114 /*
115 * For request batching
116 */
117 unsigned long last_waited; /* Time last woken after wait for request */
118 int nr_batch_requests; /* Number of requests left in the batch */
119
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120 struct as_io_context *aic;
Jens Axboee2d74ac2006-03-28 08:59:01 +0200121 struct rb_root cic_root;
Jens Axboe4e521c22007-04-24 21:17:33 +0200122 void *ioc_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123};
124
125void put_io_context(struct io_context *ioc);
126void exit_io_context(void);
Jens Axboeb5deef92006-07-19 23:39:40 +0200127struct io_context *get_io_context(gfp_t gfp_flags, int node);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128void copy_io_context(struct io_context **pdst, struct io_context **psrc);
129void swap_io_context(struct io_context **ioc1, struct io_context **ioc2);
130
131struct request;
Tejun Heo8ffdc652006-01-06 09:49:03 +0100132typedef void (rq_end_io_fn)(struct request *, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133
134struct request_list {
135 int count[2];
136 int starved[2];
Tejun Heocb98fc82005-10-28 08:29:39 +0200137 int elvpriv;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138 mempool_t *rq_pool;
139 wait_queue_head_t wait[2];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140};
141
Jens Axboe4aff5e22006-08-10 08:44:47 +0200142/*
143 * request command types
144 */
145enum rq_cmd_type_bits {
146 REQ_TYPE_FS = 1, /* fs request */
147 REQ_TYPE_BLOCK_PC, /* scsi command */
148 REQ_TYPE_SENSE, /* sense request */
149 REQ_TYPE_PM_SUSPEND, /* suspend request */
150 REQ_TYPE_PM_RESUME, /* resume request */
151 REQ_TYPE_PM_SHUTDOWN, /* shutdown request */
152 REQ_TYPE_FLUSH, /* flush request */
153 REQ_TYPE_SPECIAL, /* driver defined type */
154 REQ_TYPE_LINUX_BLOCK, /* generic block layer message */
155 /*
156 * for ATA/ATAPI devices. this really doesn't belong here, ide should
157 * use REQ_TYPE_SPECIAL and use rq->cmd[0] with the range of driver
158 * private REQ_LB opcodes to differentiate what type of request this is
159 */
160 REQ_TYPE_ATA_CMD,
161 REQ_TYPE_ATA_TASK,
162 REQ_TYPE_ATA_TASKFILE,
Jens Axboecea28852006-10-12 15:08:45 +0200163 REQ_TYPE_ATA_PC,
Jens Axboe4aff5e22006-08-10 08:44:47 +0200164};
165
166/*
167 * For request of type REQ_TYPE_LINUX_BLOCK, rq->cmd[0] is the opcode being
168 * sent down (similar to how REQ_TYPE_BLOCK_PC means that ->cmd[] holds a
169 * SCSI cdb.
170 *
171 * 0x00 -> 0x3f are driver private, to be used for whatever purpose they need,
172 * typically to differentiate REQ_TYPE_SPECIAL requests.
173 *
174 */
175enum {
176 /*
177 * just examples for now
178 */
179 REQ_LB_OP_EJECT = 0x40, /* eject request */
180 REQ_LB_OP_FLUSH = 0x41, /* flush device */
181};
182
183/*
184 * request type modified bits. first three bits match BIO_RW* bits, important
185 */
186enum rq_flag_bits {
187 __REQ_RW, /* not set, read. set, write */
188 __REQ_FAILFAST, /* no low level driver retries */
189 __REQ_SORTED, /* elevator knows about this request */
190 __REQ_SOFTBARRIER, /* may not be passed by ioscheduler */
191 __REQ_HARDBARRIER, /* may not be passed by drive either */
192 __REQ_FUA, /* forced unit access */
193 __REQ_NOMERGE, /* don't touch this for merging */
194 __REQ_STARTED, /* drive already may have started this one */
195 __REQ_DONTPREP, /* don't call prep for this one */
196 __REQ_QUEUED, /* uses queueing */
197 __REQ_ELVPRIV, /* elevator private data attached */
198 __REQ_FAILED, /* set if the request failed */
199 __REQ_QUIET, /* don't worry about errors */
200 __REQ_PREEMPT, /* set for "ide_preempt" requests */
201 __REQ_ORDERED_COLOR, /* is before or after barrier */
202 __REQ_RW_SYNC, /* request is sync (O_DIRECT) */
Jens Axboe49171e52006-08-10 08:59:11 +0200203 __REQ_ALLOCED, /* request came from our alloc pool */
Jens Axboe5404bc72006-08-10 09:01:02 +0200204 __REQ_RW_META, /* metadata io request */
Jens Axboe4aff5e22006-08-10 08:44:47 +0200205 __REQ_NR_BITS, /* stops here */
206};
207
208#define REQ_RW (1 << __REQ_RW)
209#define REQ_FAILFAST (1 << __REQ_FAILFAST)
210#define REQ_SORTED (1 << __REQ_SORTED)
211#define REQ_SOFTBARRIER (1 << __REQ_SOFTBARRIER)
212#define REQ_HARDBARRIER (1 << __REQ_HARDBARRIER)
213#define REQ_FUA (1 << __REQ_FUA)
214#define REQ_NOMERGE (1 << __REQ_NOMERGE)
215#define REQ_STARTED (1 << __REQ_STARTED)
216#define REQ_DONTPREP (1 << __REQ_DONTPREP)
217#define REQ_QUEUED (1 << __REQ_QUEUED)
218#define REQ_ELVPRIV (1 << __REQ_ELVPRIV)
219#define REQ_FAILED (1 << __REQ_FAILED)
220#define REQ_QUIET (1 << __REQ_QUIET)
221#define REQ_PREEMPT (1 << __REQ_PREEMPT)
222#define REQ_ORDERED_COLOR (1 << __REQ_ORDERED_COLOR)
223#define REQ_RW_SYNC (1 << __REQ_RW_SYNC)
Jens Axboe49171e52006-08-10 08:59:11 +0200224#define REQ_ALLOCED (1 << __REQ_ALLOCED)
Jens Axboe5404bc72006-08-10 09:01:02 +0200225#define REQ_RW_META (1 << __REQ_RW_META)
Jens Axboe4aff5e22006-08-10 08:44:47 +0200226
Linus Torvalds1da177e2005-04-16 15:20:36 -0700227#define BLK_MAX_CDB 16
228
229/*
230 * try to put the fields that are referenced together in the same cacheline
231 */
232struct request {
Jens Axboeff856ba2006-01-09 16:02:34 +0100233 struct list_head queuelist;
234 struct list_head donelist;
235
Jens Axboee6a1c872006-08-10 09:00:21 +0200236 request_queue_t *q;
237
Jens Axboe4aff5e22006-08-10 08:44:47 +0200238 unsigned int cmd_flags;
239 enum rq_cmd_type_bits cmd_type;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700240
241 /* Maintain bio traversal state for part by part I/O submission.
242 * hard_* are block layer internals, no driver should touch them!
243 */
244
245 sector_t sector; /* next sector to submit */
Jens Axboee6a1c872006-08-10 09:00:21 +0200246 sector_t hard_sector; /* next sector to complete */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700247 unsigned long nr_sectors; /* no. of sectors left to submit */
Jens Axboee6a1c872006-08-10 09:00:21 +0200248 unsigned long hard_nr_sectors; /* no. of sectors left to complete */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700249 /* no. of sectors left to submit in the current segment */
250 unsigned int current_nr_sectors;
251
Linus Torvalds1da177e2005-04-16 15:20:36 -0700252 /* no. of sectors left to complete in the current segment */
253 unsigned int hard_cur_sectors;
254
255 struct bio *bio;
256 struct bio *biotail;
257
Jens Axboe98170642006-07-28 09:23:08 +0200258 struct hlist_node hash; /* merge hash */
Jens Axboee6a1c872006-08-10 09:00:21 +0200259 /*
260 * The rb_node is only used inside the io scheduler, requests
261 * are pruned when moved to the dispatch queue. So let the
262 * completion_data share space with the rb_node.
263 */
264 union {
265 struct rb_node rb_node; /* sort/lookup */
266 void *completion_data;
267 };
Jens Axboe98170642006-07-28 09:23:08 +0200268
Jens Axboeff7d1452006-07-12 14:04:37 +0200269 /*
270 * two pointers are available for the IO schedulers, if they need
271 * more they have to dynamically allocate it.
272 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700273 void *elevator_private;
Jens Axboeff7d1452006-07-12 14:04:37 +0200274 void *elevator_private2;
275
Jens Axboe8f34ee72006-06-13 09:02:34 +0200276 struct gendisk *rq_disk;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700277 unsigned long start_time;
278
279 /* Number of scatter-gather DMA addr+len pairs after
280 * physical address coalescing is performed.
281 */
282 unsigned short nr_phys_segments;
283
284 /* Number of scatter-gather addr+len pairs after
285 * physical and DMA remapping hardware coalescing is performed.
286 * This is the number of scatter-gather entries the driver
287 * will actually have to deal with after DMA mapping is done.
288 */
289 unsigned short nr_hw_segments;
290
Jens Axboe8f34ee72006-06-13 09:02:34 +0200291 unsigned short ioprio;
292
Linus Torvalds1da177e2005-04-16 15:20:36 -0700293 void *special;
Jens Axboe8f34ee72006-06-13 09:02:34 +0200294 char *buffer;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700295
Jens Axboecdd60262006-07-28 09:32:07 +0200296 int tag;
297 int errors;
298
299 int ref_count;
300
Linus Torvalds1da177e2005-04-16 15:20:36 -0700301 /*
302 * when request is used as a packet command carrier
303 */
304 unsigned int cmd_len;
305 unsigned char cmd[BLK_MAX_CDB];
306
307 unsigned int data_len;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700308 unsigned int sense_len;
Jens Axboe8f34ee72006-06-13 09:02:34 +0200309 void *data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700310 void *sense;
311
312 unsigned int timeout;
Mike Christie17e01f22005-11-11 05:31:37 -0600313 int retries;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700314
315 /*
Jens Axboec00895a2006-09-30 20:29:12 +0200316 * completion callback.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700317 */
318 rq_end_io_fn *end_io;
319 void *end_io_data;
FUJITA Tomonoriabae1fd2007-07-16 08:52:14 +0200320
321 /* for bidi */
322 struct request *next_rq;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700323};
324
325/*
Jens Axboe4aff5e22006-08-10 08:44:47 +0200326 * State information carried for REQ_TYPE_PM_SUSPEND and REQ_TYPE_PM_RESUME
Linus Torvalds1da177e2005-04-16 15:20:36 -0700327 * requests. Some step values could eventually be made generic.
328 */
329struct request_pm_state
330{
331 /* PM state machine step value, currently driver specific */
332 int pm_step;
333 /* requested PM state value (S1, S2, S3, S4, ...) */
334 u32 pm_state;
335 void* data; /* for driver use */
336};
337
338#include <linux/elevator.h>
339
Linus Torvalds1da177e2005-04-16 15:20:36 -0700340typedef void (request_fn_proc) (request_queue_t *q);
341typedef int (make_request_fn) (request_queue_t *q, struct bio *bio);
342typedef int (prep_rq_fn) (request_queue_t *, struct request *);
343typedef void (unplug_fn) (request_queue_t *);
344
345struct bio_vec;
346typedef int (merge_bvec_fn) (request_queue_t *, struct bio *, struct bio_vec *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700347typedef int (issue_flush_fn) (request_queue_t *, struct gendisk *, sector_t *);
Tejun Heo797e7db2006-01-06 09:51:03 +0100348typedef void (prepare_flush_fn) (request_queue_t *, struct request *);
Jens Axboeff856ba2006-01-09 16:02:34 +0100349typedef void (softirq_done_fn)(struct request *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700350
351enum blk_queue_state {
352 Queue_down,
353 Queue_up,
354};
355
Linus Torvalds1da177e2005-04-16 15:20:36 -0700356struct blk_queue_tag {
357 struct request **tag_index; /* map of busy tags */
358 unsigned long *tag_map; /* bit map of free/busy tags */
359 struct list_head busy_list; /* fifo list of busy tags */
360 int busy; /* current depth */
361 int max_depth; /* what we will send to device */
Tejun Heoba025082005-08-05 13:28:11 -0700362 int real_max_depth; /* what the array can hold */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700363 atomic_t refcnt; /* map can be shared */
364};
365
366struct request_queue
367{
368 /*
369 * Together with queue_head for cacheline sharing
370 */
371 struct list_head queue_head;
372 struct request *last_merge;
373 elevator_t *elevator;
374
375 /*
376 * the queue request freelist, one for reads and one for writes
377 */
378 struct request_list rq;
379
380 request_fn_proc *request_fn;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700381 make_request_fn *make_request_fn;
382 prep_rq_fn *prep_rq_fn;
383 unplug_fn *unplug_fn;
384 merge_bvec_fn *merge_bvec_fn;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700385 issue_flush_fn *issue_flush_fn;
386 prepare_flush_fn *prepare_flush_fn;
Jens Axboeff856ba2006-01-09 16:02:34 +0100387 softirq_done_fn *softirq_done_fn;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700388
389 /*
Tejun Heo8922e162005-10-20 16:23:44 +0200390 * Dispatch queue sorting
391 */
Jens Axboe1b47f532005-10-20 16:37:00 +0200392 sector_t end_sector;
Tejun Heo8922e162005-10-20 16:23:44 +0200393 struct request *boundary_rq;
Tejun Heo8922e162005-10-20 16:23:44 +0200394
395 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700396 * Auto-unplugging state
397 */
398 struct timer_list unplug_timer;
399 int unplug_thresh; /* After this many requests */
400 unsigned long unplug_delay; /* After this many jiffies */
401 struct work_struct unplug_work;
402
403 struct backing_dev_info backing_dev_info;
404
405 /*
406 * The queue owner gets to use this for whatever they like.
407 * ll_rw_blk doesn't touch it.
408 */
409 void *queuedata;
410
Linus Torvalds1da177e2005-04-16 15:20:36 -0700411 /*
412 * queue needs bounce pages for pages above this limit
413 */
414 unsigned long bounce_pfn;
Al Viro8267e262005-10-21 03:20:53 -0400415 gfp_t bounce_gfp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700416
417 /*
418 * various queue flags, see QUEUE_* below
419 */
420 unsigned long queue_flags;
421
422 /*
152587d2005-04-12 16:22:06 -0500423 * protects queue structures from reentrancy. ->__queue_lock should
424 * _never_ be used directly, it is queue private. always use
425 * ->queue_lock.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700426 */
152587d2005-04-12 16:22:06 -0500427 spinlock_t __queue_lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700428 spinlock_t *queue_lock;
429
430 /*
431 * queue kobject
432 */
433 struct kobject kobj;
434
435 /*
436 * queue settings
437 */
438 unsigned long nr_requests; /* Max # of requests */
439 unsigned int nr_congestion_on;
440 unsigned int nr_congestion_off;
441 unsigned int nr_batching;
442
Jens Axboe2cb2e142006-01-17 09:04:32 +0100443 unsigned int max_sectors;
444 unsigned int max_hw_sectors;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700445 unsigned short max_phys_segments;
446 unsigned short max_hw_segments;
447 unsigned short hardsect_size;
448 unsigned int max_segment_size;
449
450 unsigned long seg_boundary_mask;
451 unsigned int dma_alignment;
452
453 struct blk_queue_tag *queue_tags;
454
Tejun Heo15853af2005-11-10 08:52:05 +0100455 unsigned int nr_sorted;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700456 unsigned int in_flight;
457
458 /*
459 * sg stuff
460 */
461 unsigned int sg_timeout;
462 unsigned int sg_reserved_size;
Christoph Lameter19460892005-06-23 00:08:19 -0700463 int node;
Alexey Dobriyan6c5c9342006-09-29 01:59:40 -0700464#ifdef CONFIG_BLK_DEV_IO_TRACE
Jens Axboe2056a782006-03-23 20:00:26 +0100465 struct blk_trace *blk_trace;
Alexey Dobriyan6c5c9342006-09-29 01:59:40 -0700466#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700467 /*
468 * reserved for flush operations
469 */
Tejun Heo797e7db2006-01-06 09:51:03 +0100470 unsigned int ordered, next_ordered, ordseq;
471 int orderr, ordcolor;
472 struct request pre_flush_rq, bar_rq, post_flush_rq;
473 struct request *orig_bar_rq;
474 unsigned int bi_size;
Al Viro483f4af2006-03-18 18:34:37 -0500475
476 struct mutex sysfs_lock;
FUJITA Tomonorid351af02007-07-09 12:40:35 +0200477
478#if defined(CONFIG_BLK_DEV_BSG)
479 struct bsg_class_device bsg_dev;
480#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700481};
482
Linus Torvalds1da177e2005-04-16 15:20:36 -0700483#define QUEUE_FLAG_CLUSTER 0 /* cluster several segments into 1 */
484#define QUEUE_FLAG_QUEUED 1 /* uses generic tag queueing */
485#define QUEUE_FLAG_STOPPED 2 /* queue is stopped */
486#define QUEUE_FLAG_READFULL 3 /* write queue has been filled */
487#define QUEUE_FLAG_WRITEFULL 4 /* read queue has been filled */
488#define QUEUE_FLAG_DEAD 5 /* queue being torn down */
489#define QUEUE_FLAG_REENTER 6 /* Re-entrancy avoidance */
490#define QUEUE_FLAG_PLUGGED 7 /* queue is plugged */
Jens Axboe64521d12005-10-28 08:30:39 +0200491#define QUEUE_FLAG_ELVSWITCH 8 /* don't use elevator, just do FIFO */
FUJITA Tomonoriabae1fd2007-07-16 08:52:14 +0200492#define QUEUE_FLAG_BIDI 9 /* queue supports bidi requests */
Tejun Heo797e7db2006-01-06 09:51:03 +0100493
494enum {
495 /*
496 * Hardbarrier is supported with one of the following methods.
497 *
498 * NONE : hardbarrier unsupported
499 * DRAIN : ordering by draining is enough
500 * DRAIN_FLUSH : ordering by draining w/ pre and post flushes
501 * DRAIN_FUA : ordering by draining w/ pre flush and FUA write
502 * TAG : ordering by tag is enough
503 * TAG_FLUSH : ordering by tag w/ pre and post flushes
504 * TAG_FUA : ordering by tag w/ pre flush and FUA write
505 */
506 QUEUE_ORDERED_NONE = 0x00,
507 QUEUE_ORDERED_DRAIN = 0x01,
508 QUEUE_ORDERED_TAG = 0x02,
509
510 QUEUE_ORDERED_PREFLUSH = 0x10,
511 QUEUE_ORDERED_POSTFLUSH = 0x20,
512 QUEUE_ORDERED_FUA = 0x40,
513
514 QUEUE_ORDERED_DRAIN_FLUSH = QUEUE_ORDERED_DRAIN |
515 QUEUE_ORDERED_PREFLUSH | QUEUE_ORDERED_POSTFLUSH,
516 QUEUE_ORDERED_DRAIN_FUA = QUEUE_ORDERED_DRAIN |
517 QUEUE_ORDERED_PREFLUSH | QUEUE_ORDERED_FUA,
518 QUEUE_ORDERED_TAG_FLUSH = QUEUE_ORDERED_TAG |
519 QUEUE_ORDERED_PREFLUSH | QUEUE_ORDERED_POSTFLUSH,
520 QUEUE_ORDERED_TAG_FUA = QUEUE_ORDERED_TAG |
521 QUEUE_ORDERED_PREFLUSH | QUEUE_ORDERED_FUA,
522
523 /*
524 * Ordered operation sequence
525 */
526 QUEUE_ORDSEQ_STARTED = 0x01, /* flushing in progress */
527 QUEUE_ORDSEQ_DRAIN = 0x02, /* waiting for the queue to be drained */
528 QUEUE_ORDSEQ_PREFLUSH = 0x04, /* pre-flushing in progress */
529 QUEUE_ORDSEQ_BAR = 0x08, /* original barrier req in progress */
530 QUEUE_ORDSEQ_POSTFLUSH = 0x10, /* post-flushing in progress */
531 QUEUE_ORDSEQ_DONE = 0x20,
532};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700533
534#define blk_queue_plugged(q) test_bit(QUEUE_FLAG_PLUGGED, &(q)->queue_flags)
535#define blk_queue_tagged(q) test_bit(QUEUE_FLAG_QUEUED, &(q)->queue_flags)
536#define blk_queue_stopped(q) test_bit(QUEUE_FLAG_STOPPED, &(q)->queue_flags)
Tejun Heo797e7db2006-01-06 09:51:03 +0100537#define blk_queue_flushing(q) ((q)->ordseq)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700538
Jens Axboe4aff5e22006-08-10 08:44:47 +0200539#define blk_fs_request(rq) ((rq)->cmd_type == REQ_TYPE_FS)
540#define blk_pc_request(rq) ((rq)->cmd_type == REQ_TYPE_BLOCK_PC)
541#define blk_special_request(rq) ((rq)->cmd_type == REQ_TYPE_SPECIAL)
542#define blk_sense_request(rq) ((rq)->cmd_type == REQ_TYPE_SENSE)
543
544#define blk_noretry_request(rq) ((rq)->cmd_flags & REQ_FAILFAST)
545#define blk_rq_started(rq) ((rq)->cmd_flags & REQ_STARTED)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700546
547#define blk_account_rq(rq) (blk_rq_started(rq) && blk_fs_request(rq))
548
Jens Axboe4aff5e22006-08-10 08:44:47 +0200549#define blk_pm_suspend_request(rq) ((rq)->cmd_type == REQ_TYPE_PM_SUSPEND)
550#define blk_pm_resume_request(rq) ((rq)->cmd_type == REQ_TYPE_PM_RESUME)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700551#define blk_pm_request(rq) \
Jens Axboe4aff5e22006-08-10 08:44:47 +0200552 (blk_pm_suspend_request(rq) || blk_pm_resume_request(rq))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700553
Jens Axboe4aff5e22006-08-10 08:44:47 +0200554#define blk_sorted_rq(rq) ((rq)->cmd_flags & REQ_SORTED)
555#define blk_barrier_rq(rq) ((rq)->cmd_flags & REQ_HARDBARRIER)
556#define blk_fua_rq(rq) ((rq)->cmd_flags & REQ_FUA)
FUJITA Tomonoriabae1fd2007-07-16 08:52:14 +0200557#define blk_bidi_rq(rq) ((rq)->next_rq != NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700558
559#define list_entry_rq(ptr) list_entry((ptr), struct request, queuelist)
560
Jens Axboe4aff5e22006-08-10 08:44:47 +0200561#define rq_data_dir(rq) ((rq)->cmd_flags & 1)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700562
Jens Axboe9e2585a2006-07-28 09:26:13 +0200563/*
564 * We regard a request as sync, if it's a READ or a SYNC write.
565 */
566#define rq_is_sync(rq) (rq_data_dir((rq)) == READ || (rq)->cmd_flags & REQ_RW_SYNC)
Jens Axboe5404bc72006-08-10 09:01:02 +0200567#define rq_is_meta(rq) ((rq)->cmd_flags & REQ_RW_META)
Jens Axboe9e2585a2006-07-28 09:26:13 +0200568
Linus Torvalds1da177e2005-04-16 15:20:36 -0700569static inline int blk_queue_full(struct request_queue *q, int rw)
570{
571 if (rw == READ)
572 return test_bit(QUEUE_FLAG_READFULL, &q->queue_flags);
573 return test_bit(QUEUE_FLAG_WRITEFULL, &q->queue_flags);
574}
575
576static inline void blk_set_queue_full(struct request_queue *q, int rw)
577{
578 if (rw == READ)
579 set_bit(QUEUE_FLAG_READFULL, &q->queue_flags);
580 else
581 set_bit(QUEUE_FLAG_WRITEFULL, &q->queue_flags);
582}
583
584static inline void blk_clear_queue_full(struct request_queue *q, int rw)
585{
586 if (rw == READ)
587 clear_bit(QUEUE_FLAG_READFULL, &q->queue_flags);
588 else
589 clear_bit(QUEUE_FLAG_WRITEFULL, &q->queue_flags);
590}
591
592
593/*
594 * mergeable request must not have _NOMERGE or _BARRIER bit set, nor may
595 * it already be started by driver.
596 */
597#define RQ_NOMERGE_FLAGS \
598 (REQ_NOMERGE | REQ_STARTED | REQ_HARDBARRIER | REQ_SOFTBARRIER)
599#define rq_mergeable(rq) \
Jens Axboe4aff5e22006-08-10 08:44:47 +0200600 (!((rq)->cmd_flags & RQ_NOMERGE_FLAGS) && blk_fs_request((rq)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700601
602/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700603 * q->prep_rq_fn return values
604 */
605#define BLKPREP_OK 0 /* serve it */
606#define BLKPREP_KILL 1 /* fatal error, kill */
607#define BLKPREP_DEFER 2 /* leave on queue */
608
609extern unsigned long blk_max_low_pfn, blk_max_pfn;
610
611/*
612 * standard bounce addresses:
613 *
614 * BLK_BOUNCE_HIGH : bounce all highmem pages
615 * BLK_BOUNCE_ANY : don't bounce anything
616 * BLK_BOUNCE_ISA : bounce pages above ISA DMA boundary
617 */
618#define BLK_BOUNCE_HIGH ((u64)blk_max_low_pfn << PAGE_SHIFT)
619#define BLK_BOUNCE_ANY ((u64)blk_max_pfn << PAGE_SHIFT)
620#define BLK_BOUNCE_ISA (ISA_DMA_THRESHOLD)
621
Jens Axboe3d6392c2007-07-09 12:38:05 +0200622/*
623 * default timeout for SG_IO if none specified
624 */
625#define BLK_DEFAULT_SG_TIMEOUT (60 * HZ)
626
Linus Torvalds1da177e2005-04-16 15:20:36 -0700627#ifdef CONFIG_MMU
628extern int init_emergency_isa_pool(void);
629extern void blk_queue_bounce(request_queue_t *q, struct bio **bio);
630#else
631static inline int init_emergency_isa_pool(void)
632{
633 return 0;
634}
635static inline void blk_queue_bounce(request_queue_t *q, struct bio **bio)
636{
637}
638#endif /* CONFIG_MMU */
639
640#define rq_for_each_bio(_bio, rq) \
641 if ((rq->bio)) \
642 for (_bio = (rq)->bio; _bio; _bio = _bio->bi_next)
643
Linus Torvalds1da177e2005-04-16 15:20:36 -0700644extern int blk_register_queue(struct gendisk *disk);
645extern void blk_unregister_queue(struct gendisk *disk);
646extern void register_disk(struct gendisk *dev);
647extern void generic_make_request(struct bio *bio);
648extern void blk_put_request(struct request *);
Mike Christie6e39b692005-11-11 05:30:24 -0600649extern void __blk_put_request(request_queue_t *, struct request *);
Tejun Heo8ffdc652006-01-06 09:49:03 +0100650extern void blk_end_sync_rq(struct request *rq, int error);
Al Viro8267e262005-10-21 03:20:53 -0400651extern struct request *blk_get_request(request_queue_t *, int, gfp_t);
Tejun Heo 867d1192005-04-24 02:06:05 -0500652extern void blk_insert_request(request_queue_t *, struct request *, int, void *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700653extern void blk_requeue_request(request_queue_t *, struct request *);
654extern void blk_plug_device(request_queue_t *);
655extern int blk_remove_plug(request_queue_t *);
656extern void blk_recount_segments(request_queue_t *, struct bio *);
FUJITA Tomonori45e79a32007-07-09 12:39:20 +0200657extern int scsi_cmd_ioctl(struct file *, struct request_queue *,
658 struct gendisk *, unsigned int, void __user *);
Christoph Hellwig21b2f0c2006-03-22 17:52:04 +0100659extern int sg_scsi_ioctl(struct file *, struct request_queue *,
660 struct gendisk *, struct scsi_ioctl_command __user *);
Andrew Morton3fcfab12006-10-19 23:28:16 -0700661
662/*
Jens Axboe1aa4f242006-12-19 08:33:11 +0100663 * Temporary export, until SCSI gets fixed up.
664 */
665extern int ll_back_merge_fn(request_queue_t *, struct request *, struct bio *);
666
667/*
Andrew Morton3fcfab12006-10-19 23:28:16 -0700668 * A queue has just exitted congestion. Note this in the global counter of
669 * congested queues, and wake up anyone who was waiting for requests to be
670 * put back.
671 */
672static inline void blk_clear_queue_congested(request_queue_t *q, int rw)
673{
674 clear_bdi_congested(&q->backing_dev_info, rw);
675}
676
677/*
678 * A queue has just entered congestion. Flag that in the queue's VM-visible
679 * state flags and increment the global gounter of congested queues.
680 */
681static inline void blk_set_queue_congested(request_queue_t *q, int rw)
682{
683 set_bdi_congested(&q->backing_dev_info, rw);
684}
685
Linus Torvalds1da177e2005-04-16 15:20:36 -0700686extern void blk_start_queue(request_queue_t *q);
687extern void blk_stop_queue(request_queue_t *q);
688extern void blk_sync_queue(struct request_queue *q);
689extern void __blk_stop_queue(request_queue_t *q);
690extern void blk_run_queue(request_queue_t *);
Jens Axboedc72ef42006-07-20 14:54:05 +0200691extern void blk_start_queueing(request_queue_t *);
Mike Christie0e75f902006-12-01 10:40:55 +0100692extern int blk_rq_map_user(request_queue_t *, struct request *, void __user *, unsigned long);
Jens Axboe8e5cfc42006-12-19 11:12:46 +0100693extern int blk_rq_unmap_user(struct bio *);
Al Viro8267e262005-10-21 03:20:53 -0400694extern int blk_rq_map_kern(request_queue_t *, struct request *, void *, unsigned int, gfp_t);
Mike Christie0e75f902006-12-01 10:40:55 +0100695extern int blk_rq_map_user_iov(request_queue_t *, struct request *,
696 struct sg_iovec *, int, unsigned int);
James Bottomley 994ca9a2005-06-20 14:11:09 +0200697extern int blk_execute_rq(request_queue_t *, struct gendisk *,
698 struct request *, int);
Mike Christie6e39b692005-11-11 05:30:24 -0600699extern void blk_execute_rq_nowait(request_queue_t *, struct gendisk *,
Jens Axboe15fc8582006-01-06 10:00:50 +0100700 struct request *, int, rq_end_io_fn *);
Jens Axboe3d6392c2007-07-09 12:38:05 +0200701extern int blk_fill_sghdr_rq(request_queue_t *, struct request *,
702 struct sg_io_hdr *, int);
703extern int blk_unmap_sghdr_rq(struct request *, struct sg_io_hdr *);
704extern int blk_complete_sghdr_rq(struct request *, struct sg_io_hdr *,
705 struct bio *);
FUJITA Tomonori337ad412006-12-20 11:18:54 +0100706extern int blk_verify_command(unsigned char *, int);
Mike Christie6e39b692005-11-11 05:30:24 -0600707
Linus Torvalds1da177e2005-04-16 15:20:36 -0700708static inline request_queue_t *bdev_get_queue(struct block_device *bdev)
709{
710 return bdev->bd_disk->queue;
711}
712
713static inline void blk_run_backing_dev(struct backing_dev_info *bdi,
714 struct page *page)
715{
716 if (bdi && bdi->unplug_io_fn)
717 bdi->unplug_io_fn(bdi, page);
718}
719
720static inline void blk_run_address_space(struct address_space *mapping)
721{
722 if (mapping)
723 blk_run_backing_dev(mapping->backing_dev_info, NULL);
724}
725
726/*
727 * end_request() and friends. Must be called with the request queue spinlock
728 * acquired. All functions called within end_request() _must_be_ atomic.
729 *
730 * Several drivers define their own end_request and call
731 * end_that_request_first() and end_that_request_last()
732 * for parts of the original function. This prevents
733 * code duplication in drivers.
734 */
735extern int end_that_request_first(struct request *, int, int);
736extern int end_that_request_chunk(struct request *, int, int);
Tejun Heo8ffdc652006-01-06 09:49:03 +0100737extern void end_that_request_last(struct request *, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700738extern void end_request(struct request *req, int uptodate);
Jens Axboeff856ba2006-01-09 16:02:34 +0100739extern void blk_complete_request(struct request *);
740
Linus Torvalds1da177e2005-04-16 15:20:36 -0700741/*
742 * end_that_request_first/chunk() takes an uptodate argument. we account
743 * any value <= as an io error. 0 means -EIO for compatability reasons,
744 * any other < 0 value is the direct error type. An uptodate value of
745 * 1 indicates successful io completion
746 */
747#define end_io_error(uptodate) (unlikely((uptodate) <= 0))
748
749static inline void blkdev_dequeue_request(struct request *req)
750{
Tejun Heo8922e162005-10-20 16:23:44 +0200751 elv_dequeue_request(req->q, req);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700752}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700753
Linus Torvalds1da177e2005-04-16 15:20:36 -0700754/*
755 * Access functions for manipulating queue properties
756 */
Christoph Lameter19460892005-06-23 00:08:19 -0700757extern request_queue_t *blk_init_queue_node(request_fn_proc *rfn,
758 spinlock_t *lock, int node_id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700759extern request_queue_t *blk_init_queue(request_fn_proc *, spinlock_t *);
760extern void blk_cleanup_queue(request_queue_t *);
761extern void blk_queue_make_request(request_queue_t *, make_request_fn *);
762extern void blk_queue_bounce_limit(request_queue_t *, u64);
Jens Axboe2cb2e142006-01-17 09:04:32 +0100763extern void blk_queue_max_sectors(request_queue_t *, unsigned int);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700764extern void blk_queue_max_phys_segments(request_queue_t *, unsigned short);
765extern void blk_queue_max_hw_segments(request_queue_t *, unsigned short);
766extern void blk_queue_max_segment_size(request_queue_t *, unsigned int);
767extern void blk_queue_hardsect_size(request_queue_t *, unsigned short);
768extern void blk_queue_stack_limits(request_queue_t *t, request_queue_t *b);
769extern void blk_queue_segment_boundary(request_queue_t *, unsigned long);
770extern void blk_queue_prep_rq(request_queue_t *, prep_rq_fn *pfn);
771extern void blk_queue_merge_bvec(request_queue_t *, merge_bvec_fn *);
772extern void blk_queue_dma_alignment(request_queue_t *, int);
Jens Axboeff856ba2006-01-09 16:02:34 +0100773extern void blk_queue_softirq_done(request_queue_t *, softirq_done_fn *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700774extern struct backing_dev_info *blk_get_backing_dev_info(struct block_device *bdev);
Tejun Heo797e7db2006-01-06 09:51:03 +0100775extern int blk_queue_ordered(request_queue_t *, unsigned, prepare_flush_fn *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700776extern void blk_queue_issue_flush_fn(request_queue_t *, issue_flush_fn *);
Tejun Heo797e7db2006-01-06 09:51:03 +0100777extern int blk_do_ordered(request_queue_t *, struct request **);
778extern unsigned blk_ordered_cur_seq(request_queue_t *);
779extern unsigned blk_ordered_req_seq(struct request *);
780extern void blk_ordered_complete_seq(request_queue_t *, unsigned, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700781
782extern int blk_rq_map_sg(request_queue_t *, struct request *, struct scatterlist *);
783extern void blk_dump_rq_flags(struct request *, char *);
784extern void generic_unplug_device(request_queue_t *);
785extern void __generic_unplug_device(request_queue_t *);
786extern long nr_blockdev_pages(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700787
788int blk_get_queue(request_queue_t *);
Al Viro8267e262005-10-21 03:20:53 -0400789request_queue_t *blk_alloc_queue(gfp_t);
790request_queue_t *blk_alloc_queue_node(gfp_t, int);
Al Viro483f4af2006-03-18 18:34:37 -0500791extern void blk_put_queue(request_queue_t *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700792
793/*
794 * tag stuff
795 */
796#define blk_queue_tag_depth(q) ((q)->queue_tags->busy)
797#define blk_queue_tag_queue(q) ((q)->queue_tags->busy < (q)->queue_tags->max_depth)
Jens Axboe4aff5e22006-08-10 08:44:47 +0200798#define blk_rq_tagged(rq) ((rq)->cmd_flags & REQ_QUEUED)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700799extern int blk_queue_start_tag(request_queue_t *, struct request *);
800extern struct request *blk_queue_find_tag(request_queue_t *, int);
801extern void blk_queue_end_tag(request_queue_t *, struct request *);
802extern int blk_queue_init_tags(request_queue_t *, int, struct blk_queue_tag *);
803extern void blk_queue_free_tags(request_queue_t *);
804extern int blk_queue_resize_tags(request_queue_t *, int);
805extern void blk_queue_invalidate_tags(request_queue_t *);
James Bottomley492dfb42006-08-30 15:48:45 -0400806extern struct blk_queue_tag *blk_init_tags(int);
807extern void blk_free_tags(struct blk_queue_tag *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700808
David C Somayajuluf583f492006-10-04 08:27:25 +0200809static inline struct request *blk_map_queue_find_tag(struct blk_queue_tag *bqt,
810 int tag)
811{
812 if (unlikely(bqt == NULL || tag >= bqt->real_max_depth))
813 return NULL;
814 return bqt->tag_index[tag];
815}
816
Linus Torvalds1da177e2005-04-16 15:20:36 -0700817extern void blk_rq_bio_prep(request_queue_t *, struct request *, struct bio *);
818extern int blkdev_issue_flush(struct block_device *, sector_t *);
819
820#define MAX_PHYS_SEGMENTS 128
821#define MAX_HW_SEGMENTS 128
Mike Christiedefd94b2005-12-05 02:37:06 -0600822#define SAFE_MAX_SECTORS 255
823#define BLK_DEF_MAX_SECTORS 1024
Linus Torvalds1da177e2005-04-16 15:20:36 -0700824
825#define MAX_SEGMENT_SIZE 65536
826
827#define blkdev_entry_to_request(entry) list_entry((entry), struct request, queuelist)
828
Linus Torvalds1da177e2005-04-16 15:20:36 -0700829static inline int queue_hardsect_size(request_queue_t *q)
830{
831 int retval = 512;
832
833 if (q && q->hardsect_size)
834 retval = q->hardsect_size;
835
836 return retval;
837}
838
839static inline int bdev_hardsect_size(struct block_device *bdev)
840{
841 return queue_hardsect_size(bdev_get_queue(bdev));
842}
843
844static inline int queue_dma_alignment(request_queue_t *q)
845{
846 int retval = 511;
847
848 if (q && q->dma_alignment)
849 retval = q->dma_alignment;
850
851 return retval;
852}
853
Linus Torvalds1da177e2005-04-16 15:20:36 -0700854/* assumes size > 256 */
855static inline unsigned int blksize_bits(unsigned int size)
856{
857 unsigned int bits = 8;
858 do {
859 bits++;
860 size >>= 1;
861 } while (size > 256);
862 return bits;
863}
864
Adrian Bunk2befb9e2005-09-10 00:27:17 -0700865static inline unsigned int block_size(struct block_device *bdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700866{
867 return bdev->bd_block_size;
868}
869
870typedef struct {struct page *v;} Sector;
871
872unsigned char *read_dev_sector(struct block_device *, sector_t, Sector *);
873
874static inline void put_dev_sector(Sector p)
875{
876 page_cache_release(p.v);
877}
878
879struct work_struct;
880int kblockd_schedule_work(struct work_struct *work);
Andrew Morton19a75d82007-05-09 02:33:56 -0700881void kblockd_flush_work(struct work_struct *work);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700882
Linus Torvalds1da177e2005-04-16 15:20:36 -0700883#define MODULE_ALIAS_BLOCKDEV(major,minor) \
884 MODULE_ALIAS("block-major-" __stringify(major) "-" __stringify(minor))
885#define MODULE_ALIAS_BLOCKDEV_MAJOR(major) \
886 MODULE_ALIAS("block-major-" __stringify(major) "-*")
887
888
David Howells93614012006-09-30 20:45:40 +0200889#else /* CONFIG_BLOCK */
890/*
891 * stubs for when the block layer is configured out
892 */
893#define buffer_heads_over_limit 0
894
David Howells93614012006-09-30 20:45:40 +0200895static inline long nr_blockdev_pages(void)
896{
897 return 0;
898}
899
Andrew Mortonbcfd8d32006-08-31 12:56:06 +0200900static inline void exit_io_context(void)
901{
902}
David Howells93614012006-09-30 20:45:40 +0200903
904#endif /* CONFIG_BLOCK */
905
Linus Torvalds1da177e2005-04-16 15:20:36 -0700906#endif