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