blob: a905c4934a5503e06ffce3f2ec81f6642f942696 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001#ifndef _LINUX_BLKDEV_H
2#define _LINUX_BLKDEV_H
3
Linus Torvalds1da177e2005-04-16 15:20:36 -07004#include <linux/major.h>
5#include <linux/genhd.h>
6#include <linux/list.h>
7#include <linux/timer.h>
8#include <linux/workqueue.h>
9#include <linux/pagemap.h>
10#include <linux/backing-dev.h>
11#include <linux/wait.h>
12#include <linux/mempool.h>
13#include <linux/bio.h>
14#include <linux/module.h>
15#include <linux/stringify.h>
16
17#include <asm/scatterlist.h>
18
Christoph Hellwig21b2f0c2006-03-22 17:52:04 +010019struct scsi_ioctl_command;
20
Linus Torvalds1da177e2005-04-16 15:20:36 -070021struct request_queue;
22typedef struct request_queue request_queue_t;
23struct elevator_queue;
24typedef struct elevator_queue elevator_t;
25struct request_pm_state;
Jens Axboe2056a782006-03-23 20:00:26 +010026struct blk_trace;
Linus Torvalds1da177e2005-04-16 15:20:36 -070027
28#define BLKDEV_MIN_RQ 4
29#define BLKDEV_MAX_RQ 128 /* Default maximum */
30
31/*
32 * This is the per-process anticipatory I/O scheduler state.
33 */
34struct as_io_context {
35 spinlock_t lock;
36
37 void (*dtor)(struct as_io_context *aic); /* destructor */
38 void (*exit)(struct as_io_context *aic); /* called on task exit */
39
40 unsigned long state;
41 atomic_t nr_queued; /* queued reads & sync writes */
42 atomic_t nr_dispatched; /* number of requests gone to the drivers */
43
44 /* IO History tracking */
45 /* Thinktime */
46 unsigned long last_end_request;
47 unsigned long ttime_total;
48 unsigned long ttime_samples;
49 unsigned long ttime_mean;
50 /* Layout pattern */
51 unsigned int seek_samples;
52 sector_t last_request_pos;
53 u64 seek_total;
54 sector_t seek_mean;
55};
56
57struct cfq_queue;
58struct cfq_io_context {
Jens Axboee2d74ac2006-03-28 08:59:01 +020059 struct rb_node rb_node;
Jens Axboe22e2c502005-06-27 10:55:12 +020060 void *key;
61
Jens Axboee2d74ac2006-03-28 08:59:01 +020062 struct cfq_queue *cfqq[2];
63
Jens Axboe22e2c502005-06-27 10:55:12 +020064 struct io_context *ioc;
65
66 unsigned long last_end_request;
Jens Axboe206dc692006-03-28 13:03:44 +020067 sector_t last_request_pos;
68 unsigned long last_queue;
69
Jens Axboe22e2c502005-06-27 10:55:12 +020070 unsigned long ttime_total;
71 unsigned long ttime_samples;
72 unsigned long ttime_mean;
73
Jens Axboe206dc692006-03-28 13:03:44 +020074 unsigned int seek_samples;
75 u64 seek_total;
76 sector_t seek_mean;
77
Al Virod9ff4182006-03-18 13:51:22 -050078 struct list_head queue_list;
79
Jens Axboee2d74ac2006-03-28 08:59:01 +020080 void (*dtor)(struct io_context *); /* destructor */
81 void (*exit)(struct io_context *); /* called on task exit */
Linus Torvalds1da177e2005-04-16 15:20:36 -070082};
83
84/*
85 * This is the per-process I/O subsystem state. It is refcounted and
86 * kmalloc'ed. Currently all fields are modified in process io context
87 * (apart from the atomic refcount), so require no locking.
88 */
89struct io_context {
90 atomic_t refcount;
Jens Axboe22e2c502005-06-27 10:55:12 +020091 struct task_struct *task;
92
93 int (*set_ioprio)(struct io_context *, unsigned int);
Linus Torvalds1da177e2005-04-16 15:20:36 -070094
95 /*
96 * For request batching
97 */
98 unsigned long last_waited; /* Time last woken after wait for request */
99 int nr_batch_requests; /* Number of requests left in the batch */
100
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101 struct as_io_context *aic;
Jens Axboee2d74ac2006-03-28 08:59:01 +0200102 struct rb_root cic_root;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700103};
104
105void put_io_context(struct io_context *ioc);
106void exit_io_context(void);
Al Viro8267e262005-10-21 03:20:53 -0400107struct io_context *current_io_context(gfp_t gfp_flags);
108struct io_context *get_io_context(gfp_t gfp_flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700109void copy_io_context(struct io_context **pdst, struct io_context **psrc);
110void swap_io_context(struct io_context **ioc1, struct io_context **ioc2);
111
112struct request;
Tejun Heo8ffdc652006-01-06 09:49:03 +0100113typedef void (rq_end_io_fn)(struct request *, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114
115struct request_list {
116 int count[2];
117 int starved[2];
Tejun Heocb98fc82005-10-28 08:29:39 +0200118 int elvpriv;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119 mempool_t *rq_pool;
120 wait_queue_head_t wait[2];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700121};
122
Jens Axboe4aff5e22006-08-10 08:44:47 +0200123/*
124 * request command types
125 */
126enum rq_cmd_type_bits {
127 REQ_TYPE_FS = 1, /* fs request */
128 REQ_TYPE_BLOCK_PC, /* scsi command */
129 REQ_TYPE_SENSE, /* sense request */
130 REQ_TYPE_PM_SUSPEND, /* suspend request */
131 REQ_TYPE_PM_RESUME, /* resume request */
132 REQ_TYPE_PM_SHUTDOWN, /* shutdown request */
133 REQ_TYPE_FLUSH, /* flush request */
134 REQ_TYPE_SPECIAL, /* driver defined type */
135 REQ_TYPE_LINUX_BLOCK, /* generic block layer message */
136 /*
137 * for ATA/ATAPI devices. this really doesn't belong here, ide should
138 * use REQ_TYPE_SPECIAL and use rq->cmd[0] with the range of driver
139 * private REQ_LB opcodes to differentiate what type of request this is
140 */
141 REQ_TYPE_ATA_CMD,
142 REQ_TYPE_ATA_TASK,
143 REQ_TYPE_ATA_TASKFILE,
144};
145
146/*
147 * For request of type REQ_TYPE_LINUX_BLOCK, rq->cmd[0] is the opcode being
148 * sent down (similar to how REQ_TYPE_BLOCK_PC means that ->cmd[] holds a
149 * SCSI cdb.
150 *
151 * 0x00 -> 0x3f are driver private, to be used for whatever purpose they need,
152 * typically to differentiate REQ_TYPE_SPECIAL requests.
153 *
154 */
155enum {
156 /*
157 * just examples for now
158 */
159 REQ_LB_OP_EJECT = 0x40, /* eject request */
160 REQ_LB_OP_FLUSH = 0x41, /* flush device */
161};
162
163/*
164 * request type modified bits. first three bits match BIO_RW* bits, important
165 */
166enum rq_flag_bits {
167 __REQ_RW, /* not set, read. set, write */
168 __REQ_FAILFAST, /* no low level driver retries */
169 __REQ_SORTED, /* elevator knows about this request */
170 __REQ_SOFTBARRIER, /* may not be passed by ioscheduler */
171 __REQ_HARDBARRIER, /* may not be passed by drive either */
172 __REQ_FUA, /* forced unit access */
173 __REQ_NOMERGE, /* don't touch this for merging */
174 __REQ_STARTED, /* drive already may have started this one */
175 __REQ_DONTPREP, /* don't call prep for this one */
176 __REQ_QUEUED, /* uses queueing */
177 __REQ_ELVPRIV, /* elevator private data attached */
178 __REQ_FAILED, /* set if the request failed */
179 __REQ_QUIET, /* don't worry about errors */
180 __REQ_PREEMPT, /* set for "ide_preempt" requests */
181 __REQ_ORDERED_COLOR, /* is before or after barrier */
182 __REQ_RW_SYNC, /* request is sync (O_DIRECT) */
183 __REQ_NR_BITS, /* stops here */
184};
185
186#define REQ_RW (1 << __REQ_RW)
187#define REQ_FAILFAST (1 << __REQ_FAILFAST)
188#define REQ_SORTED (1 << __REQ_SORTED)
189#define REQ_SOFTBARRIER (1 << __REQ_SOFTBARRIER)
190#define REQ_HARDBARRIER (1 << __REQ_HARDBARRIER)
191#define REQ_FUA (1 << __REQ_FUA)
192#define REQ_NOMERGE (1 << __REQ_NOMERGE)
193#define REQ_STARTED (1 << __REQ_STARTED)
194#define REQ_DONTPREP (1 << __REQ_DONTPREP)
195#define REQ_QUEUED (1 << __REQ_QUEUED)
196#define REQ_ELVPRIV (1 << __REQ_ELVPRIV)
197#define REQ_FAILED (1 << __REQ_FAILED)
198#define REQ_QUIET (1 << __REQ_QUIET)
199#define REQ_PREEMPT (1 << __REQ_PREEMPT)
200#define REQ_ORDERED_COLOR (1 << __REQ_ORDERED_COLOR)
201#define REQ_RW_SYNC (1 << __REQ_RW_SYNC)
202
Linus Torvalds1da177e2005-04-16 15:20:36 -0700203#define BLK_MAX_CDB 16
204
205/*
206 * try to put the fields that are referenced together in the same cacheline
207 */
208struct request {
Jens Axboeff856ba2006-01-09 16:02:34 +0100209 struct list_head queuelist;
210 struct list_head donelist;
211
Jens Axboe4aff5e22006-08-10 08:44:47 +0200212 unsigned int cmd_flags;
213 enum rq_cmd_type_bits cmd_type;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700214
215 /* Maintain bio traversal state for part by part I/O submission.
216 * hard_* are block layer internals, no driver should touch them!
217 */
218
219 sector_t sector; /* next sector to submit */
220 unsigned long nr_sectors; /* no. of sectors left to submit */
221 /* no. of sectors left to submit in the current segment */
222 unsigned int current_nr_sectors;
223
224 sector_t hard_sector; /* next sector to complete */
225 unsigned long hard_nr_sectors; /* no. of sectors left to complete */
226 /* no. of sectors left to complete in the current segment */
227 unsigned int hard_cur_sectors;
228
229 struct bio *bio;
230 struct bio *biotail;
231
Jens Axboe98170642006-07-28 09:23:08 +0200232 struct hlist_node hash; /* merge hash */
Jens Axboe2e662b62006-07-13 11:55:04 +0200233 struct rb_node rb_node; /* sort/lookup */
Jens Axboe98170642006-07-28 09:23:08 +0200234
Linus Torvalds1da177e2005-04-16 15:20:36 -0700235 void *elevator_private;
Jens Axboeff856ba2006-01-09 16:02:34 +0100236 void *completion_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700237
238 int rq_status; /* should split this into a few status bits */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700239 int errors;
Jens Axboe8f34ee72006-06-13 09:02:34 +0200240 struct gendisk *rq_disk;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700241 unsigned long start_time;
242
243 /* Number of scatter-gather DMA addr+len pairs after
244 * physical address coalescing is performed.
245 */
246 unsigned short nr_phys_segments;
247
248 /* Number of scatter-gather addr+len pairs after
249 * physical and DMA remapping hardware coalescing is performed.
250 * This is the number of scatter-gather entries the driver
251 * will actually have to deal with after DMA mapping is done.
252 */
253 unsigned short nr_hw_segments;
254
Jens Axboe8f34ee72006-06-13 09:02:34 +0200255 unsigned short ioprio;
256
Linus Torvalds1da177e2005-04-16 15:20:36 -0700257 int tag;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700258
259 int ref_count;
260 request_queue_t *q;
261 struct request_list *rl;
262
263 struct completion *waiting;
264 void *special;
Jens Axboe8f34ee72006-06-13 09:02:34 +0200265 char *buffer;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700266
267 /*
268 * when request is used as a packet command carrier
269 */
270 unsigned int cmd_len;
271 unsigned char cmd[BLK_MAX_CDB];
272
273 unsigned int data_len;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700274 unsigned int sense_len;
Jens Axboe8f34ee72006-06-13 09:02:34 +0200275 void *data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700276 void *sense;
277
278 unsigned int timeout;
Mike Christie17e01f22005-11-11 05:31:37 -0600279 int retries;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700280
281 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700282 * completion callback. end_io_data should be folded in with waiting
283 */
284 rq_end_io_fn *end_io;
285 void *end_io_data;
286};
287
288/*
Jens Axboe4aff5e22006-08-10 08:44:47 +0200289 * State information carried for REQ_TYPE_PM_SUSPEND and REQ_TYPE_PM_RESUME
Linus Torvalds1da177e2005-04-16 15:20:36 -0700290 * requests. Some step values could eventually be made generic.
291 */
292struct request_pm_state
293{
294 /* PM state machine step value, currently driver specific */
295 int pm_step;
296 /* requested PM state value (S1, S2, S3, S4, ...) */
297 u32 pm_state;
298 void* data; /* for driver use */
299};
300
301#include <linux/elevator.h>
302
303typedef int (merge_request_fn) (request_queue_t *, struct request *,
304 struct bio *);
305typedef int (merge_requests_fn) (request_queue_t *, struct request *,
306 struct request *);
307typedef void (request_fn_proc) (request_queue_t *q);
308typedef int (make_request_fn) (request_queue_t *q, struct bio *bio);
309typedef int (prep_rq_fn) (request_queue_t *, struct request *);
310typedef void (unplug_fn) (request_queue_t *);
311
312struct bio_vec;
313typedef int (merge_bvec_fn) (request_queue_t *, struct bio *, struct bio_vec *);
314typedef void (activity_fn) (void *data, int rw);
315typedef int (issue_flush_fn) (request_queue_t *, struct gendisk *, sector_t *);
Tejun Heo797e7db2006-01-06 09:51:03 +0100316typedef void (prepare_flush_fn) (request_queue_t *, struct request *);
Jens Axboeff856ba2006-01-09 16:02:34 +0100317typedef void (softirq_done_fn)(struct request *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700318
319enum blk_queue_state {
320 Queue_down,
321 Queue_up,
322};
323
Linus Torvalds1da177e2005-04-16 15:20:36 -0700324struct blk_queue_tag {
325 struct request **tag_index; /* map of busy tags */
326 unsigned long *tag_map; /* bit map of free/busy tags */
327 struct list_head busy_list; /* fifo list of busy tags */
328 int busy; /* current depth */
329 int max_depth; /* what we will send to device */
Tejun Heoba025082005-08-05 13:28:11 -0700330 int real_max_depth; /* what the array can hold */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700331 atomic_t refcnt; /* map can be shared */
332};
333
334struct request_queue
335{
336 /*
337 * Together with queue_head for cacheline sharing
338 */
339 struct list_head queue_head;
340 struct request *last_merge;
341 elevator_t *elevator;
342
343 /*
344 * the queue request freelist, one for reads and one for writes
345 */
346 struct request_list rq;
347
348 request_fn_proc *request_fn;
349 merge_request_fn *back_merge_fn;
350 merge_request_fn *front_merge_fn;
351 merge_requests_fn *merge_requests_fn;
352 make_request_fn *make_request_fn;
353 prep_rq_fn *prep_rq_fn;
354 unplug_fn *unplug_fn;
355 merge_bvec_fn *merge_bvec_fn;
356 activity_fn *activity_fn;
357 issue_flush_fn *issue_flush_fn;
358 prepare_flush_fn *prepare_flush_fn;
Jens Axboeff856ba2006-01-09 16:02:34 +0100359 softirq_done_fn *softirq_done_fn;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700360
361 /*
Tejun Heo8922e162005-10-20 16:23:44 +0200362 * Dispatch queue sorting
363 */
Jens Axboe1b47f532005-10-20 16:37:00 +0200364 sector_t end_sector;
Tejun Heo8922e162005-10-20 16:23:44 +0200365 struct request *boundary_rq;
Tejun Heo8922e162005-10-20 16:23:44 +0200366
367 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700368 * Auto-unplugging state
369 */
370 struct timer_list unplug_timer;
371 int unplug_thresh; /* After this many requests */
372 unsigned long unplug_delay; /* After this many jiffies */
373 struct work_struct unplug_work;
374
375 struct backing_dev_info backing_dev_info;
376
377 /*
378 * The queue owner gets to use this for whatever they like.
379 * ll_rw_blk doesn't touch it.
380 */
381 void *queuedata;
382
383 void *activity_data;
384
385 /*
386 * queue needs bounce pages for pages above this limit
387 */
388 unsigned long bounce_pfn;
Al Viro8267e262005-10-21 03:20:53 -0400389 gfp_t bounce_gfp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700390
391 /*
392 * various queue flags, see QUEUE_* below
393 */
394 unsigned long queue_flags;
395
396 /*
152587d2005-04-12 16:22:06 -0500397 * protects queue structures from reentrancy. ->__queue_lock should
398 * _never_ be used directly, it is queue private. always use
399 * ->queue_lock.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700400 */
152587d2005-04-12 16:22:06 -0500401 spinlock_t __queue_lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700402 spinlock_t *queue_lock;
403
404 /*
405 * queue kobject
406 */
407 struct kobject kobj;
408
409 /*
410 * queue settings
411 */
412 unsigned long nr_requests; /* Max # of requests */
413 unsigned int nr_congestion_on;
414 unsigned int nr_congestion_off;
415 unsigned int nr_batching;
416
Jens Axboe2cb2e142006-01-17 09:04:32 +0100417 unsigned int max_sectors;
418 unsigned int max_hw_sectors;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700419 unsigned short max_phys_segments;
420 unsigned short max_hw_segments;
421 unsigned short hardsect_size;
422 unsigned int max_segment_size;
423
424 unsigned long seg_boundary_mask;
425 unsigned int dma_alignment;
426
427 struct blk_queue_tag *queue_tags;
428
Tejun Heo15853af2005-11-10 08:52:05 +0100429 unsigned int nr_sorted;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700430 unsigned int in_flight;
431
432 /*
433 * sg stuff
434 */
435 unsigned int sg_timeout;
436 unsigned int sg_reserved_size;
Christoph Lameter19460892005-06-23 00:08:19 -0700437 int node;
Alexey Dobriyan6c5c9342006-09-29 01:59:40 -0700438#ifdef CONFIG_BLK_DEV_IO_TRACE
Jens Axboe2056a782006-03-23 20:00:26 +0100439 struct blk_trace *blk_trace;
Alexey Dobriyan6c5c9342006-09-29 01:59:40 -0700440#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700441 /*
442 * reserved for flush operations
443 */
Tejun Heo797e7db2006-01-06 09:51:03 +0100444 unsigned int ordered, next_ordered, ordseq;
445 int orderr, ordcolor;
446 struct request pre_flush_rq, bar_rq, post_flush_rq;
447 struct request *orig_bar_rq;
448 unsigned int bi_size;
Al Viro483f4af2006-03-18 18:34:37 -0500449
450 struct mutex sysfs_lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700451};
452
453#define RQ_INACTIVE (-1)
454#define RQ_ACTIVE 1
Linus Torvalds1da177e2005-04-16 15:20:36 -0700455
456#define QUEUE_FLAG_CLUSTER 0 /* cluster several segments into 1 */
457#define QUEUE_FLAG_QUEUED 1 /* uses generic tag queueing */
458#define QUEUE_FLAG_STOPPED 2 /* queue is stopped */
459#define QUEUE_FLAG_READFULL 3 /* write queue has been filled */
460#define QUEUE_FLAG_WRITEFULL 4 /* read queue has been filled */
461#define QUEUE_FLAG_DEAD 5 /* queue being torn down */
462#define QUEUE_FLAG_REENTER 6 /* Re-entrancy avoidance */
463#define QUEUE_FLAG_PLUGGED 7 /* queue is plugged */
Jens Axboe64521d12005-10-28 08:30:39 +0200464#define QUEUE_FLAG_ELVSWITCH 8 /* don't use elevator, just do FIFO */
Tejun Heo797e7db2006-01-06 09:51:03 +0100465
466enum {
467 /*
468 * Hardbarrier is supported with one of the following methods.
469 *
470 * NONE : hardbarrier unsupported
471 * DRAIN : ordering by draining is enough
472 * DRAIN_FLUSH : ordering by draining w/ pre and post flushes
473 * DRAIN_FUA : ordering by draining w/ pre flush and FUA write
474 * TAG : ordering by tag is enough
475 * TAG_FLUSH : ordering by tag w/ pre and post flushes
476 * TAG_FUA : ordering by tag w/ pre flush and FUA write
477 */
478 QUEUE_ORDERED_NONE = 0x00,
479 QUEUE_ORDERED_DRAIN = 0x01,
480 QUEUE_ORDERED_TAG = 0x02,
481
482 QUEUE_ORDERED_PREFLUSH = 0x10,
483 QUEUE_ORDERED_POSTFLUSH = 0x20,
484 QUEUE_ORDERED_FUA = 0x40,
485
486 QUEUE_ORDERED_DRAIN_FLUSH = QUEUE_ORDERED_DRAIN |
487 QUEUE_ORDERED_PREFLUSH | QUEUE_ORDERED_POSTFLUSH,
488 QUEUE_ORDERED_DRAIN_FUA = QUEUE_ORDERED_DRAIN |
489 QUEUE_ORDERED_PREFLUSH | QUEUE_ORDERED_FUA,
490 QUEUE_ORDERED_TAG_FLUSH = QUEUE_ORDERED_TAG |
491 QUEUE_ORDERED_PREFLUSH | QUEUE_ORDERED_POSTFLUSH,
492 QUEUE_ORDERED_TAG_FUA = QUEUE_ORDERED_TAG |
493 QUEUE_ORDERED_PREFLUSH | QUEUE_ORDERED_FUA,
494
495 /*
496 * Ordered operation sequence
497 */
498 QUEUE_ORDSEQ_STARTED = 0x01, /* flushing in progress */
499 QUEUE_ORDSEQ_DRAIN = 0x02, /* waiting for the queue to be drained */
500 QUEUE_ORDSEQ_PREFLUSH = 0x04, /* pre-flushing in progress */
501 QUEUE_ORDSEQ_BAR = 0x08, /* original barrier req in progress */
502 QUEUE_ORDSEQ_POSTFLUSH = 0x10, /* post-flushing in progress */
503 QUEUE_ORDSEQ_DONE = 0x20,
504};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700505
506#define blk_queue_plugged(q) test_bit(QUEUE_FLAG_PLUGGED, &(q)->queue_flags)
507#define blk_queue_tagged(q) test_bit(QUEUE_FLAG_QUEUED, &(q)->queue_flags)
508#define blk_queue_stopped(q) test_bit(QUEUE_FLAG_STOPPED, &(q)->queue_flags)
Tejun Heo797e7db2006-01-06 09:51:03 +0100509#define blk_queue_flushing(q) ((q)->ordseq)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700510
Jens Axboe4aff5e22006-08-10 08:44:47 +0200511#define blk_fs_request(rq) ((rq)->cmd_type == REQ_TYPE_FS)
512#define blk_pc_request(rq) ((rq)->cmd_type == REQ_TYPE_BLOCK_PC)
513#define blk_special_request(rq) ((rq)->cmd_type == REQ_TYPE_SPECIAL)
514#define blk_sense_request(rq) ((rq)->cmd_type == REQ_TYPE_SENSE)
515
516#define blk_noretry_request(rq) ((rq)->cmd_flags & REQ_FAILFAST)
517#define blk_rq_started(rq) ((rq)->cmd_flags & REQ_STARTED)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700518
519#define blk_account_rq(rq) (blk_rq_started(rq) && blk_fs_request(rq))
520
Jens Axboe4aff5e22006-08-10 08:44:47 +0200521#define blk_pm_suspend_request(rq) ((rq)->cmd_type == REQ_TYPE_PM_SUSPEND)
522#define blk_pm_resume_request(rq) ((rq)->cmd_type == REQ_TYPE_PM_RESUME)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700523#define blk_pm_request(rq) \
Jens Axboe4aff5e22006-08-10 08:44:47 +0200524 (blk_pm_suspend_request(rq) || blk_pm_resume_request(rq))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700525
Jens Axboe4aff5e22006-08-10 08:44:47 +0200526#define blk_sorted_rq(rq) ((rq)->cmd_flags & REQ_SORTED)
527#define blk_barrier_rq(rq) ((rq)->cmd_flags & REQ_HARDBARRIER)
528#define blk_fua_rq(rq) ((rq)->cmd_flags & REQ_FUA)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700529
530#define list_entry_rq(ptr) list_entry((ptr), struct request, queuelist)
531
Jens Axboe4aff5e22006-08-10 08:44:47 +0200532#define rq_data_dir(rq) ((rq)->cmd_flags & 1)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700533
534static inline int blk_queue_full(struct request_queue *q, int rw)
535{
536 if (rw == READ)
537 return test_bit(QUEUE_FLAG_READFULL, &q->queue_flags);
538 return test_bit(QUEUE_FLAG_WRITEFULL, &q->queue_flags);
539}
540
541static inline void blk_set_queue_full(struct request_queue *q, int rw)
542{
543 if (rw == READ)
544 set_bit(QUEUE_FLAG_READFULL, &q->queue_flags);
545 else
546 set_bit(QUEUE_FLAG_WRITEFULL, &q->queue_flags);
547}
548
549static inline void blk_clear_queue_full(struct request_queue *q, int rw)
550{
551 if (rw == READ)
552 clear_bit(QUEUE_FLAG_READFULL, &q->queue_flags);
553 else
554 clear_bit(QUEUE_FLAG_WRITEFULL, &q->queue_flags);
555}
556
557
558/*
559 * mergeable request must not have _NOMERGE or _BARRIER bit set, nor may
560 * it already be started by driver.
561 */
562#define RQ_NOMERGE_FLAGS \
563 (REQ_NOMERGE | REQ_STARTED | REQ_HARDBARRIER | REQ_SOFTBARRIER)
564#define rq_mergeable(rq) \
Jens Axboe4aff5e22006-08-10 08:44:47 +0200565 (!((rq)->cmd_flags & RQ_NOMERGE_FLAGS) && blk_fs_request((rq)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700566
567/*
568 * noop, requests are automagically marked as active/inactive by I/O
569 * scheduler -- see elv_next_request
570 */
571#define blk_queue_headactive(q, head_active)
572
573/*
574 * q->prep_rq_fn return values
575 */
576#define BLKPREP_OK 0 /* serve it */
577#define BLKPREP_KILL 1 /* fatal error, kill */
578#define BLKPREP_DEFER 2 /* leave on queue */
579
580extern unsigned long blk_max_low_pfn, blk_max_pfn;
581
582/*
583 * standard bounce addresses:
584 *
585 * BLK_BOUNCE_HIGH : bounce all highmem pages
586 * BLK_BOUNCE_ANY : don't bounce anything
587 * BLK_BOUNCE_ISA : bounce pages above ISA DMA boundary
588 */
589#define BLK_BOUNCE_HIGH ((u64)blk_max_low_pfn << PAGE_SHIFT)
590#define BLK_BOUNCE_ANY ((u64)blk_max_pfn << PAGE_SHIFT)
591#define BLK_BOUNCE_ISA (ISA_DMA_THRESHOLD)
592
593#ifdef CONFIG_MMU
594extern int init_emergency_isa_pool(void);
595extern void blk_queue_bounce(request_queue_t *q, struct bio **bio);
596#else
597static inline int init_emergency_isa_pool(void)
598{
599 return 0;
600}
601static inline void blk_queue_bounce(request_queue_t *q, struct bio **bio)
602{
603}
604#endif /* CONFIG_MMU */
605
606#define rq_for_each_bio(_bio, rq) \
607 if ((rq->bio)) \
608 for (_bio = (rq)->bio; _bio; _bio = _bio->bi_next)
609
610struct sec_size {
611 unsigned block_size;
612 unsigned block_size_bits;
613};
614
615extern int blk_register_queue(struct gendisk *disk);
616extern void blk_unregister_queue(struct gendisk *disk);
617extern void register_disk(struct gendisk *dev);
618extern void generic_make_request(struct bio *bio);
619extern void blk_put_request(struct request *);
Mike Christie6e39b692005-11-11 05:30:24 -0600620extern void __blk_put_request(request_queue_t *, struct request *);
Tejun Heo8ffdc652006-01-06 09:49:03 +0100621extern void blk_end_sync_rq(struct request *rq, int error);
Al Viro8267e262005-10-21 03:20:53 -0400622extern struct request *blk_get_request(request_queue_t *, int, gfp_t);
Tejun Heo 867d1192005-04-24 02:06:05 -0500623extern void blk_insert_request(request_queue_t *, struct request *, int, void *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700624extern void blk_requeue_request(request_queue_t *, struct request *);
625extern void blk_plug_device(request_queue_t *);
626extern int blk_remove_plug(request_queue_t *);
627extern void blk_recount_segments(request_queue_t *, struct bio *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700628extern int scsi_cmd_ioctl(struct file *, struct gendisk *, unsigned int, void __user *);
Christoph Hellwig21b2f0c2006-03-22 17:52:04 +0100629extern int sg_scsi_ioctl(struct file *, struct request_queue *,
630 struct gendisk *, struct scsi_ioctl_command __user *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700631extern void blk_start_queue(request_queue_t *q);
632extern void blk_stop_queue(request_queue_t *q);
633extern void blk_sync_queue(struct request_queue *q);
634extern void __blk_stop_queue(request_queue_t *q);
635extern void blk_run_queue(request_queue_t *);
636extern void blk_queue_activity_fn(request_queue_t *, activity_fn *, void *);
Jens Axboedd1cab92005-06-20 14:06:01 +0200637extern int blk_rq_map_user(request_queue_t *, struct request *, void __user *, unsigned int);
638extern int blk_rq_unmap_user(struct bio *, unsigned int);
Al Viro8267e262005-10-21 03:20:53 -0400639extern int blk_rq_map_kern(request_queue_t *, struct request *, void *, unsigned int, gfp_t);
James Bottomley f1970ba2005-06-20 14:06:52 +0200640extern int blk_rq_map_user_iov(request_queue_t *, struct request *, struct sg_iovec *, int);
James Bottomley 994ca9a2005-06-20 14:11:09 +0200641extern int blk_execute_rq(request_queue_t *, struct gendisk *,
642 struct request *, int);
Mike Christie6e39b692005-11-11 05:30:24 -0600643extern void blk_execute_rq_nowait(request_queue_t *, struct gendisk *,
Jens Axboe15fc8582006-01-06 10:00:50 +0100644 struct request *, int, rq_end_io_fn *);
Mike Christie6e39b692005-11-11 05:30:24 -0600645
Linus Torvalds1da177e2005-04-16 15:20:36 -0700646static inline request_queue_t *bdev_get_queue(struct block_device *bdev)
647{
648 return bdev->bd_disk->queue;
649}
650
651static inline void blk_run_backing_dev(struct backing_dev_info *bdi,
652 struct page *page)
653{
654 if (bdi && bdi->unplug_io_fn)
655 bdi->unplug_io_fn(bdi, page);
656}
657
658static inline void blk_run_address_space(struct address_space *mapping)
659{
660 if (mapping)
661 blk_run_backing_dev(mapping->backing_dev_info, NULL);
662}
663
664/*
665 * end_request() and friends. Must be called with the request queue spinlock
666 * acquired. All functions called within end_request() _must_be_ atomic.
667 *
668 * Several drivers define their own end_request and call
669 * end_that_request_first() and end_that_request_last()
670 * for parts of the original function. This prevents
671 * code duplication in drivers.
672 */
673extern int end_that_request_first(struct request *, int, int);
674extern int end_that_request_chunk(struct request *, int, int);
Tejun Heo8ffdc652006-01-06 09:49:03 +0100675extern void end_that_request_last(struct request *, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700676extern void end_request(struct request *req, int uptodate);
Jens Axboeff856ba2006-01-09 16:02:34 +0100677extern void blk_complete_request(struct request *);
678
679static inline int rq_all_done(struct request *rq, unsigned int nr_bytes)
680{
681 if (blk_fs_request(rq))
682 return (nr_bytes >= (rq->hard_nr_sectors << 9));
683 else if (blk_pc_request(rq))
684 return nr_bytes >= rq->data_len;
685
686 return 0;
687}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700688
689/*
690 * end_that_request_first/chunk() takes an uptodate argument. we account
691 * any value <= as an io error. 0 means -EIO for compatability reasons,
692 * any other < 0 value is the direct error type. An uptodate value of
693 * 1 indicates successful io completion
694 */
695#define end_io_error(uptodate) (unlikely((uptodate) <= 0))
696
697static inline void blkdev_dequeue_request(struct request *req)
698{
Tejun Heo8922e162005-10-20 16:23:44 +0200699 elv_dequeue_request(req->q, req);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700700}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700701
Linus Torvalds1da177e2005-04-16 15:20:36 -0700702/*
703 * Access functions for manipulating queue properties
704 */
Christoph Lameter19460892005-06-23 00:08:19 -0700705extern request_queue_t *blk_init_queue_node(request_fn_proc *rfn,
706 spinlock_t *lock, int node_id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700707extern request_queue_t *blk_init_queue(request_fn_proc *, spinlock_t *);
708extern void blk_cleanup_queue(request_queue_t *);
709extern void blk_queue_make_request(request_queue_t *, make_request_fn *);
710extern void blk_queue_bounce_limit(request_queue_t *, u64);
Jens Axboe2cb2e142006-01-17 09:04:32 +0100711extern void blk_queue_max_sectors(request_queue_t *, unsigned int);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700712extern void blk_queue_max_phys_segments(request_queue_t *, unsigned short);
713extern void blk_queue_max_hw_segments(request_queue_t *, unsigned short);
714extern void blk_queue_max_segment_size(request_queue_t *, unsigned int);
715extern void blk_queue_hardsect_size(request_queue_t *, unsigned short);
716extern void blk_queue_stack_limits(request_queue_t *t, request_queue_t *b);
717extern void blk_queue_segment_boundary(request_queue_t *, unsigned long);
718extern void blk_queue_prep_rq(request_queue_t *, prep_rq_fn *pfn);
719extern void blk_queue_merge_bvec(request_queue_t *, merge_bvec_fn *);
720extern void blk_queue_dma_alignment(request_queue_t *, int);
Jens Axboeff856ba2006-01-09 16:02:34 +0100721extern void blk_queue_softirq_done(request_queue_t *, softirq_done_fn *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700722extern struct backing_dev_info *blk_get_backing_dev_info(struct block_device *bdev);
Tejun Heo797e7db2006-01-06 09:51:03 +0100723extern int blk_queue_ordered(request_queue_t *, unsigned, prepare_flush_fn *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700724extern void blk_queue_issue_flush_fn(request_queue_t *, issue_flush_fn *);
Tejun Heo797e7db2006-01-06 09:51:03 +0100725extern int blk_do_ordered(request_queue_t *, struct request **);
726extern unsigned blk_ordered_cur_seq(request_queue_t *);
727extern unsigned blk_ordered_req_seq(struct request *);
728extern void blk_ordered_complete_seq(request_queue_t *, unsigned, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700729
730extern int blk_rq_map_sg(request_queue_t *, struct request *, struct scatterlist *);
731extern void blk_dump_rq_flags(struct request *, char *);
732extern void generic_unplug_device(request_queue_t *);
733extern void __generic_unplug_device(request_queue_t *);
734extern long nr_blockdev_pages(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700735
736int blk_get_queue(request_queue_t *);
Al Viro8267e262005-10-21 03:20:53 -0400737request_queue_t *blk_alloc_queue(gfp_t);
738request_queue_t *blk_alloc_queue_node(gfp_t, int);
Al Viro483f4af2006-03-18 18:34:37 -0500739extern void blk_put_queue(request_queue_t *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700740
741/*
742 * tag stuff
743 */
744#define blk_queue_tag_depth(q) ((q)->queue_tags->busy)
745#define blk_queue_tag_queue(q) ((q)->queue_tags->busy < (q)->queue_tags->max_depth)
Jens Axboe4aff5e22006-08-10 08:44:47 +0200746#define blk_rq_tagged(rq) ((rq)->cmd_flags & REQ_QUEUED)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700747extern int blk_queue_start_tag(request_queue_t *, struct request *);
748extern struct request *blk_queue_find_tag(request_queue_t *, int);
749extern void blk_queue_end_tag(request_queue_t *, struct request *);
750extern int blk_queue_init_tags(request_queue_t *, int, struct blk_queue_tag *);
751extern void blk_queue_free_tags(request_queue_t *);
752extern int blk_queue_resize_tags(request_queue_t *, int);
753extern void blk_queue_invalidate_tags(request_queue_t *);
754extern long blk_congestion_wait(int rw, long timeout);
James Bottomley492dfb42006-08-30 15:48:45 -0400755extern struct blk_queue_tag *blk_init_tags(int);
756extern void blk_free_tags(struct blk_queue_tag *);
Trond Myklebust275a0822006-08-22 20:06:24 -0400757extern void blk_congestion_end(int rw);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700758
759extern void blk_rq_bio_prep(request_queue_t *, struct request *, struct bio *);
760extern int blkdev_issue_flush(struct block_device *, sector_t *);
761
762#define MAX_PHYS_SEGMENTS 128
763#define MAX_HW_SEGMENTS 128
Mike Christiedefd94b2005-12-05 02:37:06 -0600764#define SAFE_MAX_SECTORS 255
765#define BLK_DEF_MAX_SECTORS 1024
Linus Torvalds1da177e2005-04-16 15:20:36 -0700766
767#define MAX_SEGMENT_SIZE 65536
768
769#define blkdev_entry_to_request(entry) list_entry((entry), struct request, queuelist)
770
Linus Torvalds1da177e2005-04-16 15:20:36 -0700771static inline int queue_hardsect_size(request_queue_t *q)
772{
773 int retval = 512;
774
775 if (q && q->hardsect_size)
776 retval = q->hardsect_size;
777
778 return retval;
779}
780
781static inline int bdev_hardsect_size(struct block_device *bdev)
782{
783 return queue_hardsect_size(bdev_get_queue(bdev));
784}
785
786static inline int queue_dma_alignment(request_queue_t *q)
787{
788 int retval = 511;
789
790 if (q && q->dma_alignment)
791 retval = q->dma_alignment;
792
793 return retval;
794}
795
796static inline int bdev_dma_aligment(struct block_device *bdev)
797{
798 return queue_dma_alignment(bdev_get_queue(bdev));
799}
800
801#define blk_finished_io(nsects) do { } while (0)
802#define blk_started_io(nsects) do { } while (0)
803
804/* assumes size > 256 */
805static inline unsigned int blksize_bits(unsigned int size)
806{
807 unsigned int bits = 8;
808 do {
809 bits++;
810 size >>= 1;
811 } while (size > 256);
812 return bits;
813}
814
Adrian Bunk2befb9e2005-09-10 00:27:17 -0700815static inline unsigned int block_size(struct block_device *bdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700816{
817 return bdev->bd_block_size;
818}
819
820typedef struct {struct page *v;} Sector;
821
822unsigned char *read_dev_sector(struct block_device *, sector_t, Sector *);
823
824static inline void put_dev_sector(Sector p)
825{
826 page_cache_release(p.v);
827}
828
829struct work_struct;
830int kblockd_schedule_work(struct work_struct *work);
831void kblockd_flush(void);
832
833#ifdef CONFIG_LBD
834# include <asm/div64.h>
835# define sector_div(a, b) do_div(a, b)
836#else
837# define sector_div(n, b)( \
838{ \
839 int _res; \
840 _res = (n) % (b); \
841 (n) /= (b); \
842 _res; \
843} \
844)
845#endif
846
847#define MODULE_ALIAS_BLOCKDEV(major,minor) \
848 MODULE_ALIAS("block-major-" __stringify(major) "-" __stringify(minor))
849#define MODULE_ALIAS_BLOCKDEV_MAJOR(major) \
850 MODULE_ALIAS("block-major-" __stringify(major) "-*")
851
852
853#endif