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