]> git.ipfire.org Git - thirdparty/linux.git/blame - include/linux/blkdev.h
Merge branch 'pmem-api' into libnvdimm-for-next
[thirdparty/linux.git] / include / linux / blkdev.h
CommitLineData
1da177e4
LT
1#ifndef _LINUX_BLKDEV_H
2#define _LINUX_BLKDEV_H
3
85fd0bc9
RK
4#include <linux/sched.h>
5
f5ff8422
JA
6#ifdef CONFIG_BLOCK
7
1da177e4
LT
8#include <linux/major.h>
9#include <linux/genhd.h>
10#include <linux/list.h>
320ae51f 11#include <linux/llist.h>
1da177e4
LT
12#include <linux/timer.h>
13#include <linux/workqueue.h>
14#include <linux/pagemap.h>
66114cad 15#include <linux/backing-dev-defs.h>
1da177e4
LT
16#include <linux/wait.h>
17#include <linux/mempool.h>
18#include <linux/bio.h>
1da177e4 19#include <linux/stringify.h>
3e6053d7 20#include <linux/gfp.h>
d351af01 21#include <linux/bsg.h>
c7c22e4d 22#include <linux/smp.h>
548bc8e1 23#include <linux/rcupdate.h>
add703fd 24#include <linux/percpu-refcount.h>
84be456f 25#include <linux/scatterlist.h>
1da177e4 26
de477254 27struct module;
21b2f0c8
CH
28struct scsi_ioctl_command;
29
1da177e4 30struct request_queue;
1da177e4 31struct elevator_queue;
2056a782 32struct blk_trace;
3d6392cf
JA
33struct request;
34struct sg_io_hdr;
aa387cc8 35struct bsg_job;
3c798398 36struct blkcg_gq;
7c94e1c1 37struct blk_flush_queue;
1da177e4
LT
38
39#define BLKDEV_MIN_RQ 4
40#define BLKDEV_MAX_RQ 128 /* Default maximum */
41
8bd435b3
TH
42/*
43 * Maximum number of blkcg policies allowed to be registered concurrently.
44 * Defined here to simplify include dependency.
45 */
46#define BLKCG_MAX_POLS 2
47
1da177e4 48struct request;
8ffdc655 49typedef void (rq_end_io_fn)(struct request *, int);
1da177e4 50
5b788ce3
TH
51#define BLK_RL_SYNCFULL (1U << 0)
52#define BLK_RL_ASYNCFULL (1U << 1)
53
1da177e4 54struct request_list {
5b788ce3 55 struct request_queue *q; /* the queue this rl belongs to */
a051661c
TH
56#ifdef CONFIG_BLK_CGROUP
57 struct blkcg_gq *blkg; /* blkg this request pool belongs to */
58#endif
1faa16d2
JA
59 /*
60 * count[], starved[], and wait[] are indexed by
61 * BLK_RW_SYNC/BLK_RW_ASYNC
62 */
8a5ecdd4
TH
63 int count[2];
64 int starved[2];
65 mempool_t *rq_pool;
66 wait_queue_head_t wait[2];
5b788ce3 67 unsigned int flags;
1da177e4
LT
68};
69
4aff5e23
JA
70/*
71 * request command types
72 */
73enum rq_cmd_type_bits {
74 REQ_TYPE_FS = 1, /* fs request */
75 REQ_TYPE_BLOCK_PC, /* scsi command */
b42171ef 76 REQ_TYPE_DRV_PRIV, /* driver defined types from here */
4aff5e23
JA
77};
78
1da177e4
LT
79#define BLK_MAX_CDB 16
80
81/*
af76e555
CH
82 * Try to put the fields that are referenced together in the same cacheline.
83 *
84 * If you modify this structure, make sure to update blk_rq_init() and
85 * especially blk_mq_rq_ctx_init() to take care of the added fields.
1da177e4
LT
86 */
87struct request {
6897fc22 88 struct list_head queuelist;
320ae51f
JA
89 union {
90 struct call_single_data csd;
8b4922d3 91 unsigned long fifo_time;
320ae51f 92 };
ff856bad 93
165125e1 94 struct request_queue *q;
320ae51f 95 struct blk_mq_ctx *mq_ctx;
e6a1c874 96
5953316d 97 u64 cmd_flags;
b42171ef 98 unsigned cmd_type;
242f9dcb 99 unsigned long atomic_flags;
1da177e4 100
181fdde3
RK
101 int cpu;
102
a2dec7b3 103 /* the following two fields are internal, NEVER access directly */
a2dec7b3 104 unsigned int __data_len; /* total data len */
181fdde3 105 sector_t __sector; /* sector cursor */
1da177e4
LT
106
107 struct bio *bio;
108 struct bio *biotail;
109
360f92c2
JA
110 /*
111 * The hash is used inside the scheduler, and killed once the
112 * request reaches the dispatch list. The ipi_list is only used
113 * to queue the request for softirq completion, which is long
114 * after the request has been unhashed (and even removed from
115 * the dispatch list).
116 */
117 union {
118 struct hlist_node hash; /* merge hash */
119 struct list_head ipi_list;
120 };
121
e6a1c874
JA
122 /*
123 * The rb_node is only used inside the io scheduler, requests
124 * are pruned when moved to the dispatch queue. So let the
c186794d 125 * completion_data share space with the rb_node.
e6a1c874
JA
126 */
127 union {
128 struct rb_node rb_node; /* sort/lookup */
c186794d 129 void *completion_data;
e6a1c874 130 };
9817064b 131
ff7d145f 132 /*
7f1dc8a2 133 * Three pointers are available for the IO schedulers, if they need
c186794d
MS
134 * more they have to dynamically allocate it. Flush requests are
135 * never put on the IO scheduler. So let the flush fields share
a612fddf 136 * space with the elevator data.
ff7d145f 137 */
c186794d 138 union {
a612fddf
TH
139 struct {
140 struct io_cq *icq;
141 void *priv[2];
142 } elv;
143
c186794d
MS
144 struct {
145 unsigned int seq;
146 struct list_head list;
4853abaa 147 rq_end_io_fn *saved_end_io;
c186794d
MS
148 } flush;
149 };
ff7d145f 150
8f34ee75 151 struct gendisk *rq_disk;
09e099d4 152 struct hd_struct *part;
1da177e4 153 unsigned long start_time;
9195291e 154#ifdef CONFIG_BLK_CGROUP
a051661c 155 struct request_list *rl; /* rl this rq is alloced from */
9195291e
DS
156 unsigned long long start_time_ns;
157 unsigned long long io_start_time_ns; /* when passed to hardware */
158#endif
1da177e4
LT
159 /* Number of scatter-gather DMA addr+len pairs after
160 * physical address coalescing is performed.
161 */
162 unsigned short nr_phys_segments;
13f05c8d
MP
163#if defined(CONFIG_BLK_DEV_INTEGRITY)
164 unsigned short nr_integrity_segments;
165#endif
1da177e4 166
8f34ee75
JA
167 unsigned short ioprio;
168
731ec497 169 void *special; /* opaque pointer available for LLD use */
1da177e4 170
cdd60262
JA
171 int tag;
172 int errors;
173
1da177e4
LT
174 /*
175 * when request is used as a packet command carrier
176 */
d7e3c324
FT
177 unsigned char __cmd[BLK_MAX_CDB];
178 unsigned char *cmd;
181fdde3 179 unsigned short cmd_len;
1da177e4 180
7a85f889 181 unsigned int extra_len; /* length of alignment and padding */
1da177e4 182 unsigned int sense_len;
c3a4d78c 183 unsigned int resid_len; /* residual count */
1da177e4
LT
184 void *sense;
185
242f9dcb
JA
186 unsigned long deadline;
187 struct list_head timeout_list;
1da177e4 188 unsigned int timeout;
17e01f21 189 int retries;
1da177e4 190
1da177e4 191 /*
c00895ab 192 * completion callback.
1da177e4
LT
193 */
194 rq_end_io_fn *end_io;
195 void *end_io_data;
abae1fde
FT
196
197 /* for bidi */
198 struct request *next_rq;
1da177e4
LT
199};
200
766ca442
FLVC
201static inline unsigned short req_get_ioprio(struct request *req)
202{
203 return req->ioprio;
204}
205
1da177e4
LT
206#include <linux/elevator.h>
207
320ae51f
JA
208struct blk_queue_ctx;
209
165125e1 210typedef void (request_fn_proc) (struct request_queue *q);
5a7bbad2 211typedef void (make_request_fn) (struct request_queue *q, struct bio *bio);
165125e1 212typedef int (prep_rq_fn) (struct request_queue *, struct request *);
28018c24 213typedef void (unprep_rq_fn) (struct request_queue *, struct request *);
1da177e4
LT
214
215struct bio_vec;
cc371e66
AK
216struct bvec_merge_data {
217 struct block_device *bi_bdev;
218 sector_t bi_sector;
219 unsigned bi_size;
220 unsigned long bi_rw;
221};
222typedef int (merge_bvec_fn) (struct request_queue *, struct bvec_merge_data *,
223 struct bio_vec *);
ff856bad 224typedef void (softirq_done_fn)(struct request *);
2fb98e84 225typedef int (dma_drain_needed_fn)(struct request *);
ef9e3fac 226typedef int (lld_busy_fn) (struct request_queue *q);
aa387cc8 227typedef int (bsg_job_fn) (struct bsg_job *);
1da177e4 228
242f9dcb
JA
229enum blk_eh_timer_return {
230 BLK_EH_NOT_HANDLED,
231 BLK_EH_HANDLED,
232 BLK_EH_RESET_TIMER,
233};
234
235typedef enum blk_eh_timer_return (rq_timed_out_fn)(struct request *);
236
1da177e4
LT
237enum blk_queue_state {
238 Queue_down,
239 Queue_up,
240};
241
1da177e4
LT
242struct blk_queue_tag {
243 struct request **tag_index; /* map of busy tags */
244 unsigned long *tag_map; /* bit map of free/busy tags */
1da177e4
LT
245 int busy; /* current depth */
246 int max_depth; /* what we will send to device */
ba025082 247 int real_max_depth; /* what the array can hold */
1da177e4 248 atomic_t refcnt; /* map can be shared */
ee1b6f7a
SL
249 int alloc_policy; /* tag allocation policy */
250 int next_tag; /* next tag */
1da177e4 251};
ee1b6f7a
SL
252#define BLK_TAG_ALLOC_FIFO 0 /* allocate starting from 0 */
253#define BLK_TAG_ALLOC_RR 1 /* allocate starting from last allocated tag */
1da177e4 254
abf54393
FT
255#define BLK_SCSI_MAX_CMDS (256)
256#define BLK_SCSI_CMD_PER_LONG (BLK_SCSI_MAX_CMDS / (sizeof(long) * 8))
257
025146e1
MP
258struct queue_limits {
259 unsigned long bounce_pfn;
260 unsigned long seg_boundary_mask;
261
262 unsigned int max_hw_sectors;
762380ad 263 unsigned int chunk_sectors;
025146e1
MP
264 unsigned int max_sectors;
265 unsigned int max_segment_size;
c72758f3
MP
266 unsigned int physical_block_size;
267 unsigned int alignment_offset;
268 unsigned int io_min;
269 unsigned int io_opt;
67efc925 270 unsigned int max_discard_sectors;
4363ac7c 271 unsigned int max_write_same_sectors;
86b37281
MP
272 unsigned int discard_granularity;
273 unsigned int discard_alignment;
025146e1
MP
274
275 unsigned short logical_block_size;
8a78362c 276 unsigned short max_segments;
13f05c8d 277 unsigned short max_integrity_segments;
025146e1 278
c72758f3 279 unsigned char misaligned;
86b37281 280 unsigned char discard_misaligned;
e692cb66 281 unsigned char cluster;
a934a00a 282 unsigned char discard_zeroes_data;
c78afc62 283 unsigned char raid_partial_stripes_expensive;
025146e1
MP
284};
285
d7b76301 286struct request_queue {
1da177e4
LT
287 /*
288 * Together with queue_head for cacheline sharing
289 */
290 struct list_head queue_head;
291 struct request *last_merge;
b374d18a 292 struct elevator_queue *elevator;
8a5ecdd4
TH
293 int nr_rqs[2]; /* # allocated [a]sync rqs */
294 int nr_rqs_elvpriv; /* # allocated rqs w/ elvpriv */
1da177e4
LT
295
296 /*
a051661c
TH
297 * If blkcg is not used, @q->root_rl serves all requests. If blkcg
298 * is used, root blkg allocates from @q->root_rl and all other
299 * blkgs from their own blkg->rl. Which one to use should be
300 * determined using bio_request_list().
1da177e4 301 */
a051661c 302 struct request_list root_rl;
1da177e4
LT
303
304 request_fn_proc *request_fn;
1da177e4
LT
305 make_request_fn *make_request_fn;
306 prep_rq_fn *prep_rq_fn;
28018c24 307 unprep_rq_fn *unprep_rq_fn;
1da177e4 308 merge_bvec_fn *merge_bvec_fn;
ff856bad 309 softirq_done_fn *softirq_done_fn;
242f9dcb 310 rq_timed_out_fn *rq_timed_out_fn;
2fb98e84 311 dma_drain_needed_fn *dma_drain_needed;
ef9e3fac 312 lld_busy_fn *lld_busy_fn;
1da177e4 313
320ae51f
JA
314 struct blk_mq_ops *mq_ops;
315
316 unsigned int *mq_map;
317
318 /* sw queues */
e6cdb092 319 struct blk_mq_ctx __percpu *queue_ctx;
320ae51f
JA
320 unsigned int nr_queues;
321
322 /* hw dispatch queues */
323 struct blk_mq_hw_ctx **queue_hw_ctx;
324 unsigned int nr_hw_queues;
325
8922e16c
TH
326 /*
327 * Dispatch queue sorting
328 */
1b47f531 329 sector_t end_sector;
8922e16c 330 struct request *boundary_rq;
8922e16c 331
1da177e4 332 /*
3cca6dc1 333 * Delayed queue handling
1da177e4 334 */
3cca6dc1 335 struct delayed_work delay_work;
1da177e4
LT
336
337 struct backing_dev_info backing_dev_info;
338
339 /*
340 * The queue owner gets to use this for whatever they like.
341 * ll_rw_blk doesn't touch it.
342 */
343 void *queuedata;
344
1da177e4 345 /*
d7b76301 346 * various queue flags, see QUEUE_* below
1da177e4 347 */
d7b76301 348 unsigned long queue_flags;
1da177e4 349
a73f730d
TH
350 /*
351 * ida allocated id for this queue. Used to index queues from
352 * ioctx.
353 */
354 int id;
355
1da177e4 356 /*
d7b76301 357 * queue needs bounce pages for pages above this limit
1da177e4 358 */
d7b76301 359 gfp_t bounce_gfp;
1da177e4
LT
360
361 /*
152587de
JA
362 * protects queue structures from reentrancy. ->__queue_lock should
363 * _never_ be used directly, it is queue private. always use
364 * ->queue_lock.
1da177e4 365 */
152587de 366 spinlock_t __queue_lock;
1da177e4
LT
367 spinlock_t *queue_lock;
368
369 /*
370 * queue kobject
371 */
372 struct kobject kobj;
373
320ae51f
JA
374 /*
375 * mq queue kobject
376 */
377 struct kobject mq_kobj;
378
47fafbc7 379#ifdef CONFIG_PM
6c954667
LM
380 struct device *dev;
381 int rpm_status;
382 unsigned int nr_pending;
383#endif
384
1da177e4
LT
385 /*
386 * queue settings
387 */
388 unsigned long nr_requests; /* Max # of requests */
389 unsigned int nr_congestion_on;
390 unsigned int nr_congestion_off;
391 unsigned int nr_batching;
392
fa0ccd83 393 unsigned int dma_drain_size;
d7b76301 394 void *dma_drain_buffer;
e3790c7d 395 unsigned int dma_pad_mask;
1da177e4
LT
396 unsigned int dma_alignment;
397
398 struct blk_queue_tag *queue_tags;
6eca9004 399 struct list_head tag_busy_list;
1da177e4 400
15853af9 401 unsigned int nr_sorted;
0a7ae2ff 402 unsigned int in_flight[2];
24faf6f6
BVA
403 /*
404 * Number of active block driver functions for which blk_drain_queue()
405 * must wait. Must be incremented around functions that unlock the
406 * queue_lock internally, e.g. scsi_request_fn().
407 */
408 unsigned int request_fn_active;
1da177e4 409
242f9dcb
JA
410 unsigned int rq_timeout;
411 struct timer_list timeout;
412 struct list_head timeout_list;
413
a612fddf 414 struct list_head icq_list;
4eef3049 415#ifdef CONFIG_BLK_CGROUP
a2b1693b 416 DECLARE_BITMAP (blkcg_pols, BLKCG_MAX_POLS);
3c798398 417 struct blkcg_gq *root_blkg;
03aa264a 418 struct list_head blkg_list;
4eef3049 419#endif
a612fddf 420
025146e1
MP
421 struct queue_limits limits;
422
1da177e4
LT
423 /*
424 * sg stuff
425 */
426 unsigned int sg_timeout;
427 unsigned int sg_reserved_size;
1946089a 428 int node;
6c5c9341 429#ifdef CONFIG_BLK_DEV_IO_TRACE
2056a782 430 struct blk_trace *blk_trace;
6c5c9341 431#endif
1da177e4 432 /*
4913efe4 433 * for flush operations
1da177e4 434 */
4913efe4 435 unsigned int flush_flags;
f3876930 436 unsigned int flush_not_queueable:1;
7c94e1c1 437 struct blk_flush_queue *fq;
483f4afc 438
6fca6a61
CH
439 struct list_head requeue_list;
440 spinlock_t requeue_lock;
441 struct work_struct requeue_work;
442
483f4afc 443 struct mutex sysfs_lock;
d351af01 444
d732580b 445 int bypass_depth;
4ecd4fef 446 atomic_t mq_freeze_depth;
d732580b 447
d351af01 448#if defined(CONFIG_BLK_DEV_BSG)
aa387cc8
MC
449 bsg_job_fn *bsg_job_fn;
450 int bsg_job_size;
d351af01
FT
451 struct bsg_class_device bsg_dev;
452#endif
e43473b7
VG
453
454#ifdef CONFIG_BLK_DEV_THROTTLING
455 /* Throttle data */
456 struct throtl_data *td;
457#endif
548bc8e1 458 struct rcu_head rcu_head;
320ae51f 459 wait_queue_head_t mq_freeze_wq;
add703fd 460 struct percpu_ref mq_usage_counter;
320ae51f 461 struct list_head all_q_node;
0d2602ca
JA
462
463 struct blk_mq_tag_set *tag_set;
464 struct list_head tag_set_list;
1da177e4
LT
465};
466
1da177e4
LT
467#define QUEUE_FLAG_QUEUED 1 /* uses generic tag queueing */
468#define QUEUE_FLAG_STOPPED 2 /* queue is stopped */
1faa16d2
JA
469#define QUEUE_FLAG_SYNCFULL 3 /* read queue has been filled */
470#define QUEUE_FLAG_ASYNCFULL 4 /* write queue has been filled */
3f3299d5 471#define QUEUE_FLAG_DYING 5 /* queue being torn down */
d732580b 472#define QUEUE_FLAG_BYPASS 6 /* act as dumb FIFO queue */
c21e6beb
JA
473#define QUEUE_FLAG_BIDI 7 /* queue supports bidi requests */
474#define QUEUE_FLAG_NOMERGES 8 /* disable merge attempts */
5757a6d7 475#define QUEUE_FLAG_SAME_COMP 9 /* complete on same CPU-group */
c21e6beb
JA
476#define QUEUE_FLAG_FAIL_IO 10 /* fake timeout */
477#define QUEUE_FLAG_STACKABLE 11 /* supports request stacking */
478#define QUEUE_FLAG_NONROT 12 /* non-rotational device (SSD) */
88e740f1 479#define QUEUE_FLAG_VIRT QUEUE_FLAG_NONROT /* paravirt device */
c21e6beb
JA
480#define QUEUE_FLAG_IO_STAT 13 /* do IO stats */
481#define QUEUE_FLAG_DISCARD 14 /* supports DISCARD */
482#define QUEUE_FLAG_NOXMERGES 15 /* No extended merges */
483#define QUEUE_FLAG_ADD_RANDOM 16 /* Contributes to random pool */
484#define QUEUE_FLAG_SECDISCARD 17 /* supports SECDISCARD */
5757a6d7 485#define QUEUE_FLAG_SAME_FORCE 18 /* force complete on same CPU */
c246e80d 486#define QUEUE_FLAG_DEAD 19 /* queue tear-down finished */
320ae51f 487#define QUEUE_FLAG_INIT_DONE 20 /* queue is initialized */
05f1dd53 488#define QUEUE_FLAG_NO_SG_MERGE 21 /* don't attempt to merge SG segments*/
66cb45aa 489#define QUEUE_FLAG_SG_GAPS 22 /* queue doesn't support SG gaps */
bc58ba94
JA
490
491#define QUEUE_FLAG_DEFAULT ((1 << QUEUE_FLAG_IO_STAT) | \
01e97f6b 492 (1 << QUEUE_FLAG_STACKABLE) | \
e2e1a148
JA
493 (1 << QUEUE_FLAG_SAME_COMP) | \
494 (1 << QUEUE_FLAG_ADD_RANDOM))
797e7dbb 495
94eddfbe 496#define QUEUE_FLAG_MQ_DEFAULT ((1 << QUEUE_FLAG_IO_STAT) | \
ad9cf3bb 497 (1 << QUEUE_FLAG_STACKABLE) | \
94eddfbe
JA
498 (1 << QUEUE_FLAG_SAME_COMP))
499
8bcb6c7d 500static inline void queue_lockdep_assert_held(struct request_queue *q)
8f45c1a5 501{
8bcb6c7d
AK
502 if (q->queue_lock)
503 lockdep_assert_held(q->queue_lock);
8f45c1a5
LT
504}
505
75ad23bc
NP
506static inline void queue_flag_set_unlocked(unsigned int flag,
507 struct request_queue *q)
508{
509 __set_bit(flag, &q->queue_flags);
510}
511
e48ec690
JA
512static inline int queue_flag_test_and_clear(unsigned int flag,
513 struct request_queue *q)
514{
8bcb6c7d 515 queue_lockdep_assert_held(q);
e48ec690
JA
516
517 if (test_bit(flag, &q->queue_flags)) {
518 __clear_bit(flag, &q->queue_flags);
519 return 1;
520 }
521
522 return 0;
523}
524
525static inline int queue_flag_test_and_set(unsigned int flag,
526 struct request_queue *q)
527{
8bcb6c7d 528 queue_lockdep_assert_held(q);
e48ec690
JA
529
530 if (!test_bit(flag, &q->queue_flags)) {
531 __set_bit(flag, &q->queue_flags);
532 return 0;
533 }
534
535 return 1;
536}
537
75ad23bc
NP
538static inline void queue_flag_set(unsigned int flag, struct request_queue *q)
539{
8bcb6c7d 540 queue_lockdep_assert_held(q);
75ad23bc
NP
541 __set_bit(flag, &q->queue_flags);
542}
543
544static inline void queue_flag_clear_unlocked(unsigned int flag,
545 struct request_queue *q)
546{
547 __clear_bit(flag, &q->queue_flags);
548}
549
0a7ae2ff
JA
550static inline int queue_in_flight(struct request_queue *q)
551{
552 return q->in_flight[0] + q->in_flight[1];
553}
554
75ad23bc
NP
555static inline void queue_flag_clear(unsigned int flag, struct request_queue *q)
556{
8bcb6c7d 557 queue_lockdep_assert_held(q);
75ad23bc
NP
558 __clear_bit(flag, &q->queue_flags);
559}
560
1da177e4
LT
561#define blk_queue_tagged(q) test_bit(QUEUE_FLAG_QUEUED, &(q)->queue_flags)
562#define blk_queue_stopped(q) test_bit(QUEUE_FLAG_STOPPED, &(q)->queue_flags)
3f3299d5 563#define blk_queue_dying(q) test_bit(QUEUE_FLAG_DYING, &(q)->queue_flags)
c246e80d 564#define blk_queue_dead(q) test_bit(QUEUE_FLAG_DEAD, &(q)->queue_flags)
d732580b 565#define blk_queue_bypass(q) test_bit(QUEUE_FLAG_BYPASS, &(q)->queue_flags)
320ae51f 566#define blk_queue_init_done(q) test_bit(QUEUE_FLAG_INIT_DONE, &(q)->queue_flags)
ac9fafa1 567#define blk_queue_nomerges(q) test_bit(QUEUE_FLAG_NOMERGES, &(q)->queue_flags)
488991e2
AB
568#define blk_queue_noxmerges(q) \
569 test_bit(QUEUE_FLAG_NOXMERGES, &(q)->queue_flags)
a68bbddb 570#define blk_queue_nonrot(q) test_bit(QUEUE_FLAG_NONROT, &(q)->queue_flags)
bc58ba94 571#define blk_queue_io_stat(q) test_bit(QUEUE_FLAG_IO_STAT, &(q)->queue_flags)
e2e1a148 572#define blk_queue_add_random(q) test_bit(QUEUE_FLAG_ADD_RANDOM, &(q)->queue_flags)
4ee5eaf4
KU
573#define blk_queue_stackable(q) \
574 test_bit(QUEUE_FLAG_STACKABLE, &(q)->queue_flags)
c15227de 575#define blk_queue_discard(q) test_bit(QUEUE_FLAG_DISCARD, &(q)->queue_flags)
8d57a98c
AH
576#define blk_queue_secdiscard(q) (blk_queue_discard(q) && \
577 test_bit(QUEUE_FLAG_SECDISCARD, &(q)->queue_flags))
1da177e4 578
33659ebb
CH
579#define blk_noretry_request(rq) \
580 ((rq)->cmd_flags & (REQ_FAILFAST_DEV|REQ_FAILFAST_TRANSPORT| \
581 REQ_FAILFAST_DRIVER))
582
583#define blk_account_rq(rq) \
584 (((rq)->cmd_flags & REQ_STARTED) && \
e2a60da7 585 ((rq)->cmd_type == REQ_TYPE_FS))
33659ebb 586
ab780f1e 587#define blk_rq_cpu_valid(rq) ((rq)->cpu != -1)
abae1fde 588#define blk_bidi_rq(rq) ((rq)->next_rq != NULL)
336cdb40
KU
589/* rq->queuelist of dequeued request must be list_empty() */
590#define blk_queued_rq(rq) (!list_empty(&(rq)->queuelist))
1da177e4
LT
591
592#define list_entry_rq(ptr) list_entry((ptr), struct request, queuelist)
593
5953316d 594#define rq_data_dir(rq) (((rq)->cmd_flags & 1) != 0)
1da177e4 595
49fd524f
JA
596/*
597 * Driver can handle struct request, if it either has an old style
598 * request_fn defined, or is blk-mq based.
599 */
600static inline bool queue_is_rq_based(struct request_queue *q)
601{
602 return q->request_fn || q->mq_ops;
603}
604
e692cb66
MP
605static inline unsigned int blk_queue_cluster(struct request_queue *q)
606{
607 return q->limits.cluster;
608}
609
9e2585a8 610/*
1faa16d2 611 * We regard a request as sync, if either a read or a sync write
9e2585a8 612 */
1faa16d2
JA
613static inline bool rw_is_sync(unsigned int rw_flags)
614{
7b6d91da 615 return !(rw_flags & REQ_WRITE) || (rw_flags & REQ_SYNC);
1faa16d2
JA
616}
617
618static inline bool rq_is_sync(struct request *rq)
619{
620 return rw_is_sync(rq->cmd_flags);
621}
622
5b788ce3 623static inline bool blk_rl_full(struct request_list *rl, bool sync)
1da177e4 624{
5b788ce3
TH
625 unsigned int flag = sync ? BLK_RL_SYNCFULL : BLK_RL_ASYNCFULL;
626
627 return rl->flags & flag;
1da177e4
LT
628}
629
5b788ce3 630static inline void blk_set_rl_full(struct request_list *rl, bool sync)
1da177e4 631{
5b788ce3
TH
632 unsigned int flag = sync ? BLK_RL_SYNCFULL : BLK_RL_ASYNCFULL;
633
634 rl->flags |= flag;
1da177e4
LT
635}
636
5b788ce3 637static inline void blk_clear_rl_full(struct request_list *rl, bool sync)
1da177e4 638{
5b788ce3
TH
639 unsigned int flag = sync ? BLK_RL_SYNCFULL : BLK_RL_ASYNCFULL;
640
641 rl->flags &= ~flag;
1da177e4
LT
642}
643
e2a60da7
MP
644static inline bool rq_mergeable(struct request *rq)
645{
646 if (rq->cmd_type != REQ_TYPE_FS)
647 return false;
1da177e4 648
e2a60da7
MP
649 if (rq->cmd_flags & REQ_NOMERGE_FLAGS)
650 return false;
651
652 return true;
653}
1da177e4 654
f31dc1cd
MP
655static inline bool blk_check_merge_flags(unsigned int flags1,
656 unsigned int flags2)
657{
658 if ((flags1 & REQ_DISCARD) != (flags2 & REQ_DISCARD))
659 return false;
660
661 if ((flags1 & REQ_SECURE) != (flags2 & REQ_SECURE))
662 return false;
663
4363ac7c
MP
664 if ((flags1 & REQ_WRITE_SAME) != (flags2 & REQ_WRITE_SAME))
665 return false;
666
f31dc1cd
MP
667 return true;
668}
669
4363ac7c
MP
670static inline bool blk_write_same_mergeable(struct bio *a, struct bio *b)
671{
672 if (bio_data(a) == bio_data(b))
673 return true;
674
675 return false;
676}
677
1da177e4
LT
678/*
679 * q->prep_rq_fn return values
680 */
681#define BLKPREP_OK 0 /* serve it */
682#define BLKPREP_KILL 1 /* fatal error, kill */
683#define BLKPREP_DEFER 2 /* leave on queue */
684
685extern unsigned long blk_max_low_pfn, blk_max_pfn;
686
687/*
688 * standard bounce addresses:
689 *
690 * BLK_BOUNCE_HIGH : bounce all highmem pages
691 * BLK_BOUNCE_ANY : don't bounce anything
692 * BLK_BOUNCE_ISA : bounce pages above ISA DMA boundary
693 */
2472892a
AK
694
695#if BITS_PER_LONG == 32
1da177e4 696#define BLK_BOUNCE_HIGH ((u64)blk_max_low_pfn << PAGE_SHIFT)
2472892a
AK
697#else
698#define BLK_BOUNCE_HIGH -1ULL
699#endif
700#define BLK_BOUNCE_ANY (-1ULL)
bfe17231 701#define BLK_BOUNCE_ISA (DMA_BIT_MASK(24))
1da177e4 702
3d6392cf
JA
703/*
704 * default timeout for SG_IO if none specified
705 */
706#define BLK_DEFAULT_SG_TIMEOUT (60 * HZ)
f2f1fa78 707#define BLK_MIN_SG_TIMEOUT (7 * HZ)
3d6392cf 708
2a7326b5 709#ifdef CONFIG_BOUNCE
1da177e4 710extern int init_emergency_isa_pool(void);
165125e1 711extern void blk_queue_bounce(struct request_queue *q, struct bio **bio);
1da177e4
LT
712#else
713static inline int init_emergency_isa_pool(void)
714{
715 return 0;
716}
165125e1 717static inline void blk_queue_bounce(struct request_queue *q, struct bio **bio)
1da177e4
LT
718{
719}
720#endif /* CONFIG_MMU */
721
152e283f
FT
722struct rq_map_data {
723 struct page **pages;
724 int page_order;
725 int nr_entries;
56c451f4 726 unsigned long offset;
97ae77a1 727 int null_mapped;
ecb554a8 728 int from_user;
152e283f
FT
729};
730
5705f702 731struct req_iterator {
7988613b 732 struct bvec_iter iter;
5705f702
N
733 struct bio *bio;
734};
735
736/* This should not be used directly - use rq_for_each_segment */
1e428079
JA
737#define for_each_bio(_bio) \
738 for (; _bio; _bio = _bio->bi_next)
5705f702 739#define __rq_for_each_bio(_bio, rq) \
1da177e4
LT
740 if ((rq->bio)) \
741 for (_bio = (rq)->bio; _bio; _bio = _bio->bi_next)
742
5705f702
N
743#define rq_for_each_segment(bvl, _rq, _iter) \
744 __rq_for_each_bio(_iter.bio, _rq) \
7988613b 745 bio_for_each_segment(bvl, _iter.bio, _iter.iter)
5705f702 746
4550dd6c 747#define rq_iter_last(bvec, _iter) \
7988613b 748 (_iter.bio->bi_next == NULL && \
4550dd6c 749 bio_iter_last(bvec, _iter.iter))
5705f702 750
2d4dc890
IL
751#ifndef ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE
752# error "You should define ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE for your platform"
753#endif
754#if ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE
755extern void rq_flush_dcache_pages(struct request *rq);
756#else
757static inline void rq_flush_dcache_pages(struct request *rq)
758{
759}
760#endif
761
1da177e4
LT
762extern int blk_register_queue(struct gendisk *disk);
763extern void blk_unregister_queue(struct gendisk *disk);
1da177e4 764extern void generic_make_request(struct bio *bio);
2a4aa30c 765extern void blk_rq_init(struct request_queue *q, struct request *rq);
1da177e4 766extern void blk_put_request(struct request *);
165125e1 767extern void __blk_put_request(struct request_queue *, struct request *);
165125e1 768extern struct request *blk_get_request(struct request_queue *, int, gfp_t);
79eb63e9
BH
769extern struct request *blk_make_request(struct request_queue *, struct bio *,
770 gfp_t);
f27b087b 771extern void blk_rq_set_block_pc(struct request *);
165125e1 772extern void blk_requeue_request(struct request_queue *, struct request *);
66ac0280
CH
773extern void blk_add_request_payload(struct request *rq, struct page *page,
774 unsigned int len);
82124d60 775extern int blk_rq_check_limits(struct request_queue *q, struct request *rq);
ef9e3fac 776extern int blk_lld_busy(struct request_queue *q);
78d8e58a
MS
777extern int blk_rq_prep_clone(struct request *rq, struct request *rq_src,
778 struct bio_set *bs, gfp_t gfp_mask,
779 int (*bio_ctr)(struct bio *, struct bio *, void *),
780 void *data);
781extern void blk_rq_unprep_clone(struct request *rq);
82124d60
KU
782extern int blk_insert_cloned_request(struct request_queue *q,
783 struct request *rq);
3cca6dc1 784extern void blk_delay_queue(struct request_queue *, unsigned long);
165125e1 785extern void blk_recount_segments(struct request_queue *, struct bio *);
0bfc96cb 786extern int scsi_verify_blk_ioctl(struct block_device *, unsigned int);
577ebb37
PB
787extern int scsi_cmd_blk_ioctl(struct block_device *, fmode_t,
788 unsigned int, void __user *);
74f3c8af
AV
789extern int scsi_cmd_ioctl(struct request_queue *, struct gendisk *, fmode_t,
790 unsigned int, void __user *);
e915e872
AV
791extern int sg_scsi_ioctl(struct request_queue *, struct gendisk *, fmode_t,
792 struct scsi_ioctl_command __user *);
3fcfab16 793
165125e1
JA
794extern void blk_start_queue(struct request_queue *q);
795extern void blk_stop_queue(struct request_queue *q);
1da177e4 796extern void blk_sync_queue(struct request_queue *q);
165125e1 797extern void __blk_stop_queue(struct request_queue *q);
24ecfbe2 798extern void __blk_run_queue(struct request_queue *q);
a7928c15 799extern void __blk_run_queue_uncond(struct request_queue *q);
165125e1 800extern void blk_run_queue(struct request_queue *);
c21e6beb 801extern void blk_run_queue_async(struct request_queue *q);
a3bce90e 802extern int blk_rq_map_user(struct request_queue *, struct request *,
152e283f
FT
803 struct rq_map_data *, void __user *, unsigned long,
804 gfp_t);
8e5cfc45 805extern int blk_rq_unmap_user(struct bio *);
165125e1
JA
806extern int blk_rq_map_kern(struct request_queue *, struct request *, void *, unsigned int, gfp_t);
807extern int blk_rq_map_user_iov(struct request_queue *, struct request *,
26e49cfc
KO
808 struct rq_map_data *, const struct iov_iter *,
809 gfp_t);
165125e1 810extern int blk_execute_rq(struct request_queue *, struct gendisk *,
994ca9a1 811 struct request *, int);
165125e1 812extern void blk_execute_rq_nowait(struct request_queue *, struct gendisk *,
15fc858a 813 struct request *, int, rq_end_io_fn *);
6e39b69e 814
165125e1 815static inline struct request_queue *bdev_get_queue(struct block_device *bdev)
1da177e4 816{
ff9ea323 817 return bdev->bd_disk->queue; /* this is never NULL */
1da177e4
LT
818}
819
5efccd17 820/*
80a761fd
TH
821 * blk_rq_pos() : the current sector
822 * blk_rq_bytes() : bytes left in the entire request
823 * blk_rq_cur_bytes() : bytes left in the current segment
824 * blk_rq_err_bytes() : bytes left till the next error boundary
825 * blk_rq_sectors() : sectors left in the entire request
826 * blk_rq_cur_sectors() : sectors left in the current segment
5efccd17 827 */
5b93629b
TH
828static inline sector_t blk_rq_pos(const struct request *rq)
829{
a2dec7b3 830 return rq->__sector;
2e46e8b2
TH
831}
832
833static inline unsigned int blk_rq_bytes(const struct request *rq)
834{
a2dec7b3 835 return rq->__data_len;
5b93629b
TH
836}
837
2e46e8b2
TH
838static inline int blk_rq_cur_bytes(const struct request *rq)
839{
840 return rq->bio ? bio_cur_bytes(rq->bio) : 0;
841}
5efccd17 842
80a761fd
TH
843extern unsigned int blk_rq_err_bytes(const struct request *rq);
844
5b93629b
TH
845static inline unsigned int blk_rq_sectors(const struct request *rq)
846{
2e46e8b2 847 return blk_rq_bytes(rq) >> 9;
5b93629b
TH
848}
849
850static inline unsigned int blk_rq_cur_sectors(const struct request *rq)
851{
2e46e8b2 852 return blk_rq_cur_bytes(rq) >> 9;
5b93629b
TH
853}
854
f31dc1cd
MP
855static inline unsigned int blk_queue_get_max_sectors(struct request_queue *q,
856 unsigned int cmd_flags)
857{
858 if (unlikely(cmd_flags & REQ_DISCARD))
871dd928 859 return min(q->limits.max_discard_sectors, UINT_MAX >> 9);
f31dc1cd 860
4363ac7c
MP
861 if (unlikely(cmd_flags & REQ_WRITE_SAME))
862 return q->limits.max_write_same_sectors;
863
f31dc1cd
MP
864 return q->limits.max_sectors;
865}
866
762380ad
JA
867/*
868 * Return maximum size of a request at given offset. Only valid for
869 * file system requests.
870 */
871static inline unsigned int blk_max_size_offset(struct request_queue *q,
872 sector_t offset)
873{
874 if (!q->limits.chunk_sectors)
736ed4de 875 return q->limits.max_sectors;
762380ad
JA
876
877 return q->limits.chunk_sectors -
878 (offset & (q->limits.chunk_sectors - 1));
879}
880
f31dc1cd
MP
881static inline unsigned int blk_rq_get_max_sectors(struct request *rq)
882{
883 struct request_queue *q = rq->q;
884
885 if (unlikely(rq->cmd_type == REQ_TYPE_BLOCK_PC))
886 return q->limits.max_hw_sectors;
887
e548ca4e 888 if (!q->limits.chunk_sectors || (rq->cmd_flags & REQ_DISCARD))
762380ad
JA
889 return blk_queue_get_max_sectors(q, rq->cmd_flags);
890
891 return min(blk_max_size_offset(q, blk_rq_pos(rq)),
892 blk_queue_get_max_sectors(q, rq->cmd_flags));
f31dc1cd
MP
893}
894
75afb352
JN
895static inline unsigned int blk_rq_count_bios(struct request *rq)
896{
897 unsigned int nr_bios = 0;
898 struct bio *bio;
899
900 __rq_for_each_bio(bio, rq)
901 nr_bios++;
902
903 return nr_bios;
904}
905
9934c8c0
TH
906/*
907 * Request issue related functions.
908 */
909extern struct request *blk_peek_request(struct request_queue *q);
910extern void blk_start_request(struct request *rq);
911extern struct request *blk_fetch_request(struct request_queue *q);
912
1da177e4 913/*
2e60e022
TH
914 * Request completion related functions.
915 *
916 * blk_update_request() completes given number of bytes and updates
917 * the request without completing it.
918 *
f06d9a2b
TH
919 * blk_end_request() and friends. __blk_end_request() must be called
920 * with the request queue spinlock acquired.
1da177e4
LT
921 *
922 * Several drivers define their own end_request and call
3bcddeac
KU
923 * blk_end_request() for parts of the original function.
924 * This prevents code duplication in drivers.
1da177e4 925 */
2e60e022
TH
926extern bool blk_update_request(struct request *rq, int error,
927 unsigned int nr_bytes);
12120077 928extern void blk_finish_request(struct request *rq, int error);
b1f74493
FT
929extern bool blk_end_request(struct request *rq, int error,
930 unsigned int nr_bytes);
931extern void blk_end_request_all(struct request *rq, int error);
932extern bool blk_end_request_cur(struct request *rq, int error);
80a761fd 933extern bool blk_end_request_err(struct request *rq, int error);
b1f74493
FT
934extern bool __blk_end_request(struct request *rq, int error,
935 unsigned int nr_bytes);
936extern void __blk_end_request_all(struct request *rq, int error);
937extern bool __blk_end_request_cur(struct request *rq, int error);
80a761fd 938extern bool __blk_end_request_err(struct request *rq, int error);
2e60e022 939
ff856bad 940extern void blk_complete_request(struct request *);
242f9dcb
JA
941extern void __blk_complete_request(struct request *);
942extern void blk_abort_request(struct request *);
28018c24 943extern void blk_unprep_request(struct request *);
ff856bad 944
1da177e4
LT
945/*
946 * Access functions for manipulating queue properties
947 */
165125e1 948extern struct request_queue *blk_init_queue_node(request_fn_proc *rfn,
1946089a 949 spinlock_t *lock, int node_id);
165125e1 950extern struct request_queue *blk_init_queue(request_fn_proc *, spinlock_t *);
01effb0d
MS
951extern struct request_queue *blk_init_allocated_queue(struct request_queue *,
952 request_fn_proc *, spinlock_t *);
165125e1
JA
953extern void blk_cleanup_queue(struct request_queue *);
954extern void blk_queue_make_request(struct request_queue *, make_request_fn *);
955extern void blk_queue_bounce_limit(struct request_queue *, u64);
72d4cd9f 956extern void blk_limits_max_hw_sectors(struct queue_limits *, unsigned int);
086fa5ff 957extern void blk_queue_max_hw_sectors(struct request_queue *, unsigned int);
762380ad 958extern void blk_queue_chunk_sectors(struct request_queue *, unsigned int);
8a78362c 959extern void blk_queue_max_segments(struct request_queue *, unsigned short);
165125e1 960extern void blk_queue_max_segment_size(struct request_queue *, unsigned int);
67efc925
CH
961extern void blk_queue_max_discard_sectors(struct request_queue *q,
962 unsigned int max_discard_sectors);
4363ac7c
MP
963extern void blk_queue_max_write_same_sectors(struct request_queue *q,
964 unsigned int max_write_same_sectors);
e1defc4f 965extern void blk_queue_logical_block_size(struct request_queue *, unsigned short);
892b6f90 966extern void blk_queue_physical_block_size(struct request_queue *, unsigned int);
c72758f3
MP
967extern void blk_queue_alignment_offset(struct request_queue *q,
968 unsigned int alignment);
7c958e32 969extern void blk_limits_io_min(struct queue_limits *limits, unsigned int min);
c72758f3 970extern void blk_queue_io_min(struct request_queue *q, unsigned int min);
3c5820c7 971extern void blk_limits_io_opt(struct queue_limits *limits, unsigned int opt);
c72758f3 972extern void blk_queue_io_opt(struct request_queue *q, unsigned int opt);
e475bba2 973extern void blk_set_default_limits(struct queue_limits *lim);
b1bd055d 974extern void blk_set_stacking_limits(struct queue_limits *lim);
c72758f3
MP
975extern int blk_stack_limits(struct queue_limits *t, struct queue_limits *b,
976 sector_t offset);
17be8c24
MP
977extern int bdev_stack_limits(struct queue_limits *t, struct block_device *bdev,
978 sector_t offset);
c72758f3
MP
979extern void disk_stack_limits(struct gendisk *disk, struct block_device *bdev,
980 sector_t offset);
165125e1 981extern void blk_queue_stack_limits(struct request_queue *t, struct request_queue *b);
e3790c7d 982extern void blk_queue_dma_pad(struct request_queue *, unsigned int);
27f8221a 983extern void blk_queue_update_dma_pad(struct request_queue *, unsigned int);
2fb98e84
TH
984extern int blk_queue_dma_drain(struct request_queue *q,
985 dma_drain_needed_fn *dma_drain_needed,
986 void *buf, unsigned int size);
ef9e3fac 987extern void blk_queue_lld_busy(struct request_queue *q, lld_busy_fn *fn);
165125e1
JA
988extern void blk_queue_segment_boundary(struct request_queue *, unsigned long);
989extern void blk_queue_prep_rq(struct request_queue *, prep_rq_fn *pfn);
28018c24 990extern void blk_queue_unprep_rq(struct request_queue *, unprep_rq_fn *ufn);
165125e1
JA
991extern void blk_queue_merge_bvec(struct request_queue *, merge_bvec_fn *);
992extern void blk_queue_dma_alignment(struct request_queue *, int);
11c3e689 993extern void blk_queue_update_dma_alignment(struct request_queue *, int);
165125e1 994extern void blk_queue_softirq_done(struct request_queue *, softirq_done_fn *);
242f9dcb
JA
995extern void blk_queue_rq_timed_out(struct request_queue *, rq_timed_out_fn *);
996extern void blk_queue_rq_timeout(struct request_queue *, unsigned int);
4913efe4 997extern void blk_queue_flush(struct request_queue *q, unsigned int flush);
f3876930 998extern void blk_queue_flush_queueable(struct request_queue *q, bool queueable);
1da177e4 999extern struct backing_dev_info *blk_get_backing_dev_info(struct block_device *bdev);
1da177e4 1000
165125e1 1001extern int blk_rq_map_sg(struct request_queue *, struct request *, struct scatterlist *);
1da177e4 1002extern void blk_dump_rq_flags(struct request *, char *);
1da177e4 1003extern long nr_blockdev_pages(void);
1da177e4 1004
09ac46c4 1005bool __must_check blk_get_queue(struct request_queue *);
165125e1
JA
1006struct request_queue *blk_alloc_queue(gfp_t);
1007struct request_queue *blk_alloc_queue_node(gfp_t, int);
1008extern void blk_put_queue(struct request_queue *);
3f21c265 1009extern void blk_set_queue_dying(struct request_queue *);
1da177e4 1010
6c954667
LM
1011/*
1012 * block layer runtime pm functions
1013 */
47fafbc7 1014#ifdef CONFIG_PM
6c954667
LM
1015extern void blk_pm_runtime_init(struct request_queue *q, struct device *dev);
1016extern int blk_pre_runtime_suspend(struct request_queue *q);
1017extern void blk_post_runtime_suspend(struct request_queue *q, int err);
1018extern void blk_pre_runtime_resume(struct request_queue *q);
1019extern void blk_post_runtime_resume(struct request_queue *q, int err);
1020#else
1021static inline void blk_pm_runtime_init(struct request_queue *q,
1022 struct device *dev) {}
1023static inline int blk_pre_runtime_suspend(struct request_queue *q)
1024{
1025 return -ENOSYS;
1026}
1027static inline void blk_post_runtime_suspend(struct request_queue *q, int err) {}
1028static inline void blk_pre_runtime_resume(struct request_queue *q) {}
1029static inline void blk_post_runtime_resume(struct request_queue *q, int err) {}
1030#endif
1031
316cc67d 1032/*
75df7136
SJ
1033 * blk_plug permits building a queue of related requests by holding the I/O
1034 * fragments for a short period. This allows merging of sequential requests
1035 * into single larger request. As the requests are moved from a per-task list to
1036 * the device's request_queue in a batch, this results in improved scalability
1037 * as the lock contention for request_queue lock is reduced.
1038 *
1039 * It is ok not to disable preemption when adding the request to the plug list
1040 * or when attempting a merge, because blk_schedule_flush_list() will only flush
1041 * the plug list when the task sleeps by itself. For details, please see
1042 * schedule() where blk_schedule_flush_plug() is called.
316cc67d 1043 */
73c10101 1044struct blk_plug {
75df7136 1045 struct list_head list; /* requests */
320ae51f 1046 struct list_head mq_list; /* blk-mq requests */
75df7136 1047 struct list_head cb_list; /* md requires an unplug callback */
73c10101 1048};
55c022bb
SL
1049#define BLK_MAX_REQUEST_COUNT 16
1050
9cbb1750 1051struct blk_plug_cb;
74018dc3 1052typedef void (*blk_plug_cb_fn)(struct blk_plug_cb *, bool);
048c9374
N
1053struct blk_plug_cb {
1054 struct list_head list;
9cbb1750
N
1055 blk_plug_cb_fn callback;
1056 void *data;
048c9374 1057};
9cbb1750
N
1058extern struct blk_plug_cb *blk_check_plugged(blk_plug_cb_fn unplug,
1059 void *data, int size);
73c10101
JA
1060extern void blk_start_plug(struct blk_plug *);
1061extern void blk_finish_plug(struct blk_plug *);
f6603783 1062extern void blk_flush_plug_list(struct blk_plug *, bool);
73c10101
JA
1063
1064static inline void blk_flush_plug(struct task_struct *tsk)
1065{
1066 struct blk_plug *plug = tsk->plug;
1067
a237c1c5
JA
1068 if (plug)
1069 blk_flush_plug_list(plug, false);
1070}
1071
1072static inline void blk_schedule_flush_plug(struct task_struct *tsk)
1073{
1074 struct blk_plug *plug = tsk->plug;
1075
88b996cd 1076 if (plug)
f6603783 1077 blk_flush_plug_list(plug, true);
73c10101
JA
1078}
1079
1080static inline bool blk_needs_flush_plug(struct task_struct *tsk)
1081{
1082 struct blk_plug *plug = tsk->plug;
1083
320ae51f
JA
1084 return plug &&
1085 (!list_empty(&plug->list) ||
1086 !list_empty(&plug->mq_list) ||
1087 !list_empty(&plug->cb_list));
73c10101
JA
1088}
1089
1da177e4
LT
1090/*
1091 * tag stuff
1092 */
165125e1
JA
1093extern int blk_queue_start_tag(struct request_queue *, struct request *);
1094extern struct request *blk_queue_find_tag(struct request_queue *, int);
1095extern void blk_queue_end_tag(struct request_queue *, struct request *);
ee1b6f7a 1096extern int blk_queue_init_tags(struct request_queue *, int, struct blk_queue_tag *, int);
165125e1
JA
1097extern void blk_queue_free_tags(struct request_queue *);
1098extern int blk_queue_resize_tags(struct request_queue *, int);
1099extern void blk_queue_invalidate_tags(struct request_queue *);
ee1b6f7a 1100extern struct blk_queue_tag *blk_init_tags(int, int);
492dfb48 1101extern void blk_free_tags(struct blk_queue_tag *);
1da177e4 1102
f583f492
DS
1103static inline struct request *blk_map_queue_find_tag(struct blk_queue_tag *bqt,
1104 int tag)
1105{
1106 if (unlikely(bqt == NULL || tag >= bqt->real_max_depth))
1107 return NULL;
1108 return bqt->tag_index[tag];
1109}
dd3932ed
CH
1110
1111#define BLKDEV_DISCARD_SECURE 0x01 /* secure discard */
1112
1113extern int blkdev_issue_flush(struct block_device *, gfp_t, sector_t *);
fbd9b09a
DM
1114extern int blkdev_issue_discard(struct block_device *bdev, sector_t sector,
1115 sector_t nr_sects, gfp_t gfp_mask, unsigned long flags);
4363ac7c
MP
1116extern int blkdev_issue_write_same(struct block_device *bdev, sector_t sector,
1117 sector_t nr_sects, gfp_t gfp_mask, struct page *page);
3f14d792 1118extern int blkdev_issue_zeroout(struct block_device *bdev, sector_t sector,
d93ba7a5 1119 sector_t nr_sects, gfp_t gfp_mask, bool discard);
2cf6d26a
CH
1120static inline int sb_issue_discard(struct super_block *sb, sector_t block,
1121 sector_t nr_blocks, gfp_t gfp_mask, unsigned long flags)
fb2dce86 1122{
2cf6d26a
CH
1123 return blkdev_issue_discard(sb->s_bdev, block << (sb->s_blocksize_bits - 9),
1124 nr_blocks << (sb->s_blocksize_bits - 9),
1125 gfp_mask, flags);
fb2dce86 1126}
e6fa0be6 1127static inline int sb_issue_zeroout(struct super_block *sb, sector_t block,
a107e5a3 1128 sector_t nr_blocks, gfp_t gfp_mask)
e6fa0be6
LC
1129{
1130 return blkdev_issue_zeroout(sb->s_bdev,
1131 block << (sb->s_blocksize_bits - 9),
1132 nr_blocks << (sb->s_blocksize_bits - 9),
d93ba7a5 1133 gfp_mask, true);
e6fa0be6 1134}
1da177e4 1135
018e0446 1136extern int blk_verify_command(unsigned char *cmd, fmode_t has_write_perm);
0b07de85 1137
eb28d31b
MP
1138enum blk_default_limits {
1139 BLK_MAX_SEGMENTS = 128,
1140 BLK_SAFE_MAX_SECTORS = 255,
eb28d31b
MP
1141 BLK_MAX_SEGMENT_SIZE = 65536,
1142 BLK_SEG_BOUNDARY_MASK = 0xFFFFFFFFUL,
1143};
0e435ac2 1144
1da177e4
LT
1145#define blkdev_entry_to_request(entry) list_entry((entry), struct request, queuelist)
1146
ae03bf63
MP
1147static inline unsigned long queue_bounce_pfn(struct request_queue *q)
1148{
025146e1 1149 return q->limits.bounce_pfn;
ae03bf63
MP
1150}
1151
1152static inline unsigned long queue_segment_boundary(struct request_queue *q)
1153{
025146e1 1154 return q->limits.seg_boundary_mask;
ae03bf63
MP
1155}
1156
1157static inline unsigned int queue_max_sectors(struct request_queue *q)
1158{
025146e1 1159 return q->limits.max_sectors;
ae03bf63
MP
1160}
1161
1162static inline unsigned int queue_max_hw_sectors(struct request_queue *q)
1163{
025146e1 1164 return q->limits.max_hw_sectors;
ae03bf63
MP
1165}
1166
8a78362c 1167static inline unsigned short queue_max_segments(struct request_queue *q)
ae03bf63 1168{
8a78362c 1169 return q->limits.max_segments;
ae03bf63
MP
1170}
1171
1172static inline unsigned int queue_max_segment_size(struct request_queue *q)
1173{
025146e1 1174 return q->limits.max_segment_size;
ae03bf63
MP
1175}
1176
e1defc4f 1177static inline unsigned short queue_logical_block_size(struct request_queue *q)
1da177e4
LT
1178{
1179 int retval = 512;
1180
025146e1
MP
1181 if (q && q->limits.logical_block_size)
1182 retval = q->limits.logical_block_size;
1da177e4
LT
1183
1184 return retval;
1185}
1186
e1defc4f 1187static inline unsigned short bdev_logical_block_size(struct block_device *bdev)
1da177e4 1188{
e1defc4f 1189 return queue_logical_block_size(bdev_get_queue(bdev));
1da177e4
LT
1190}
1191
c72758f3
MP
1192static inline unsigned int queue_physical_block_size(struct request_queue *q)
1193{
1194 return q->limits.physical_block_size;
1195}
1196
892b6f90 1197static inline unsigned int bdev_physical_block_size(struct block_device *bdev)
ac481c20
MP
1198{
1199 return queue_physical_block_size(bdev_get_queue(bdev));
1200}
1201
c72758f3
MP
1202static inline unsigned int queue_io_min(struct request_queue *q)
1203{
1204 return q->limits.io_min;
1205}
1206
ac481c20
MP
1207static inline int bdev_io_min(struct block_device *bdev)
1208{
1209 return queue_io_min(bdev_get_queue(bdev));
1210}
1211
c72758f3
MP
1212static inline unsigned int queue_io_opt(struct request_queue *q)
1213{
1214 return q->limits.io_opt;
1215}
1216
ac481c20
MP
1217static inline int bdev_io_opt(struct block_device *bdev)
1218{
1219 return queue_io_opt(bdev_get_queue(bdev));
1220}
1221
c72758f3
MP
1222static inline int queue_alignment_offset(struct request_queue *q)
1223{
ac481c20 1224 if (q->limits.misaligned)
c72758f3
MP
1225 return -1;
1226
ac481c20 1227 return q->limits.alignment_offset;
c72758f3
MP
1228}
1229
e03a72e1 1230static inline int queue_limit_alignment_offset(struct queue_limits *lim, sector_t sector)
81744ee4
MP
1231{
1232 unsigned int granularity = max(lim->physical_block_size, lim->io_min);
b8839b8c 1233 unsigned int alignment = sector_div(sector, granularity >> 9) << 9;
81744ee4 1234
b8839b8c 1235 return (granularity + lim->alignment_offset - alignment) % granularity;
c72758f3
MP
1236}
1237
ac481c20
MP
1238static inline int bdev_alignment_offset(struct block_device *bdev)
1239{
1240 struct request_queue *q = bdev_get_queue(bdev);
1241
1242 if (q->limits.misaligned)
1243 return -1;
1244
1245 if (bdev != bdev->bd_contains)
1246 return bdev->bd_part->alignment_offset;
1247
1248 return q->limits.alignment_offset;
1249}
1250
86b37281
MP
1251static inline int queue_discard_alignment(struct request_queue *q)
1252{
1253 if (q->limits.discard_misaligned)
1254 return -1;
1255
1256 return q->limits.discard_alignment;
1257}
1258
e03a72e1 1259static inline int queue_limit_discard_alignment(struct queue_limits *lim, sector_t sector)
86b37281 1260{
59771079 1261 unsigned int alignment, granularity, offset;
dd3d145d 1262
a934a00a
MP
1263 if (!lim->max_discard_sectors)
1264 return 0;
1265
59771079
LT
1266 /* Why are these in bytes, not sectors? */
1267 alignment = lim->discard_alignment >> 9;
1268 granularity = lim->discard_granularity >> 9;
1269 if (!granularity)
1270 return 0;
1271
1272 /* Offset of the partition start in 'granularity' sectors */
1273 offset = sector_div(sector, granularity);
1274
1275 /* And why do we do this modulus *again* in blkdev_issue_discard()? */
1276 offset = (granularity + alignment - offset) % granularity;
1277
1278 /* Turn it back into bytes, gaah */
1279 return offset << 9;
86b37281
MP
1280}
1281
c6e66634
PB
1282static inline int bdev_discard_alignment(struct block_device *bdev)
1283{
1284 struct request_queue *q = bdev_get_queue(bdev);
1285
1286 if (bdev != bdev->bd_contains)
1287 return bdev->bd_part->discard_alignment;
1288
1289 return q->limits.discard_alignment;
1290}
1291
98262f27
MP
1292static inline unsigned int queue_discard_zeroes_data(struct request_queue *q)
1293{
a934a00a 1294 if (q->limits.max_discard_sectors && q->limits.discard_zeroes_data == 1)
98262f27
MP
1295 return 1;
1296
1297 return 0;
1298}
1299
1300static inline unsigned int bdev_discard_zeroes_data(struct block_device *bdev)
1301{
1302 return queue_discard_zeroes_data(bdev_get_queue(bdev));
1303}
1304
4363ac7c
MP
1305static inline unsigned int bdev_write_same(struct block_device *bdev)
1306{
1307 struct request_queue *q = bdev_get_queue(bdev);
1308
1309 if (q)
1310 return q->limits.max_write_same_sectors;
1311
1312 return 0;
1313}
1314
165125e1 1315static inline int queue_dma_alignment(struct request_queue *q)
1da177e4 1316{
482eb689 1317 return q ? q->dma_alignment : 511;
1da177e4
LT
1318}
1319
14417799 1320static inline int blk_rq_aligned(struct request_queue *q, unsigned long addr,
87904074
FT
1321 unsigned int len)
1322{
1323 unsigned int alignment = queue_dma_alignment(q) | q->dma_pad_mask;
14417799 1324 return !(addr & alignment) && !(len & alignment);
87904074
FT
1325}
1326
1da177e4
LT
1327/* assumes size > 256 */
1328static inline unsigned int blksize_bits(unsigned int size)
1329{
1330 unsigned int bits = 8;
1331 do {
1332 bits++;
1333 size >>= 1;
1334 } while (size > 256);
1335 return bits;
1336}
1337
2befb9e3 1338static inline unsigned int block_size(struct block_device *bdev)
1da177e4
LT
1339{
1340 return bdev->bd_block_size;
1341}
1342
f3876930 1343static inline bool queue_flush_queueable(struct request_queue *q)
1344{
1345 return !q->flush_not_queueable;
1346}
1347
1da177e4
LT
1348typedef struct {struct page *v;} Sector;
1349
1350unsigned char *read_dev_sector(struct block_device *, sector_t, Sector *);
1351
1352static inline void put_dev_sector(Sector p)
1353{
1354 page_cache_release(p.v);
1355}
1356
1357struct work_struct;
59c3d45e
JA
1358int kblockd_schedule_work(struct work_struct *work);
1359int kblockd_schedule_delayed_work(struct delayed_work *dwork, unsigned long delay);
8ab14595 1360int kblockd_schedule_delayed_work_on(int cpu, struct delayed_work *dwork, unsigned long delay);
1da177e4 1361
9195291e 1362#ifdef CONFIG_BLK_CGROUP
28f4197e
JA
1363/*
1364 * This should not be using sched_clock(). A real patch is in progress
1365 * to fix this up, until that is in place we need to disable preemption
1366 * around sched_clock() in this function and set_io_start_time_ns().
1367 */
9195291e
DS
1368static inline void set_start_time_ns(struct request *req)
1369{
28f4197e 1370 preempt_disable();
9195291e 1371 req->start_time_ns = sched_clock();
28f4197e 1372 preempt_enable();
9195291e
DS
1373}
1374
1375static inline void set_io_start_time_ns(struct request *req)
1376{
28f4197e 1377 preempt_disable();
9195291e 1378 req->io_start_time_ns = sched_clock();
28f4197e 1379 preempt_enable();
9195291e 1380}
84c124da
DS
1381
1382static inline uint64_t rq_start_time_ns(struct request *req)
1383{
1384 return req->start_time_ns;
1385}
1386
1387static inline uint64_t rq_io_start_time_ns(struct request *req)
1388{
1389 return req->io_start_time_ns;
1390}
9195291e
DS
1391#else
1392static inline void set_start_time_ns(struct request *req) {}
1393static inline void set_io_start_time_ns(struct request *req) {}
84c124da
DS
1394static inline uint64_t rq_start_time_ns(struct request *req)
1395{
1396 return 0;
1397}
1398static inline uint64_t rq_io_start_time_ns(struct request *req)
1399{
1400 return 0;
1401}
9195291e
DS
1402#endif
1403
1da177e4
LT
1404#define MODULE_ALIAS_BLOCKDEV(major,minor) \
1405 MODULE_ALIAS("block-major-" __stringify(major) "-" __stringify(minor))
1406#define MODULE_ALIAS_BLOCKDEV_MAJOR(major) \
1407 MODULE_ALIAS("block-major-" __stringify(major) "-*")
1408
7ba1ba12
MP
1409#if defined(CONFIG_BLK_DEV_INTEGRITY)
1410
8288f496
MP
1411enum blk_integrity_flags {
1412 BLK_INTEGRITY_VERIFY = 1 << 0,
1413 BLK_INTEGRITY_GENERATE = 1 << 1,
3aec2f41 1414 BLK_INTEGRITY_DEVICE_CAPABLE = 1 << 2,
aae7df50 1415 BLK_INTEGRITY_IP_CHECKSUM = 1 << 3,
8288f496 1416};
7ba1ba12 1417
18593088 1418struct blk_integrity_iter {
7ba1ba12
MP
1419 void *prot_buf;
1420 void *data_buf;
3be91c4a 1421 sector_t seed;
7ba1ba12 1422 unsigned int data_size;
3be91c4a 1423 unsigned short interval;
7ba1ba12
MP
1424 const char *disk_name;
1425};
1426
18593088 1427typedef int (integrity_processing_fn) (struct blk_integrity_iter *);
7ba1ba12
MP
1428
1429struct blk_integrity {
18593088
MP
1430 integrity_processing_fn *generate_fn;
1431 integrity_processing_fn *verify_fn;
7ba1ba12
MP
1432
1433 unsigned short flags;
1434 unsigned short tuple_size;
3be91c4a 1435 unsigned short interval;
7ba1ba12
MP
1436 unsigned short tag_size;
1437
1438 const char *name;
1439
1440 struct kobject kobj;
1441};
1442
a63a5cf8 1443extern bool blk_integrity_is_initialized(struct gendisk *);
7ba1ba12
MP
1444extern int blk_integrity_register(struct gendisk *, struct blk_integrity *);
1445extern void blk_integrity_unregister(struct gendisk *);
ad7fce93 1446extern int blk_integrity_compare(struct gendisk *, struct gendisk *);
13f05c8d
MP
1447extern int blk_rq_map_integrity_sg(struct request_queue *, struct bio *,
1448 struct scatterlist *);
1449extern int blk_rq_count_integrity_sg(struct request_queue *, struct bio *);
4eaf99be
MP
1450extern bool blk_integrity_merge_rq(struct request_queue *, struct request *,
1451 struct request *);
1452extern bool blk_integrity_merge_bio(struct request_queue *, struct request *,
1453 struct bio *);
7ba1ba12 1454
b04accc4
JA
1455static inline
1456struct blk_integrity *bdev_get_integrity(struct block_device *bdev)
1457{
1458 return bdev->bd_disk->integrity;
1459}
1460
b02739b0
MP
1461static inline struct blk_integrity *blk_get_integrity(struct gendisk *disk)
1462{
1463 return disk->integrity;
1464}
1465
180b2f95 1466static inline bool blk_integrity_rq(struct request *rq)
7ba1ba12 1467{
180b2f95 1468 return rq->cmd_flags & REQ_INTEGRITY;
7ba1ba12
MP
1469}
1470
13f05c8d
MP
1471static inline void blk_queue_max_integrity_segments(struct request_queue *q,
1472 unsigned int segs)
1473{
1474 q->limits.max_integrity_segments = segs;
1475}
1476
1477static inline unsigned short
1478queue_max_integrity_segments(struct request_queue *q)
1479{
1480 return q->limits.max_integrity_segments;
1481}
1482
7ba1ba12
MP
1483#else /* CONFIG_BLK_DEV_INTEGRITY */
1484
fd83240a
SR
1485struct bio;
1486struct block_device;
1487struct gendisk;
1488struct blk_integrity;
1489
1490static inline int blk_integrity_rq(struct request *rq)
1491{
1492 return 0;
1493}
1494static inline int blk_rq_count_integrity_sg(struct request_queue *q,
1495 struct bio *b)
1496{
1497 return 0;
1498}
1499static inline int blk_rq_map_integrity_sg(struct request_queue *q,
1500 struct bio *b,
1501 struct scatterlist *s)
1502{
1503 return 0;
1504}
1505static inline struct blk_integrity *bdev_get_integrity(struct block_device *b)
1506{
61a04e5b 1507 return NULL;
fd83240a
SR
1508}
1509static inline struct blk_integrity *blk_get_integrity(struct gendisk *disk)
1510{
1511 return NULL;
1512}
1513static inline int blk_integrity_compare(struct gendisk *a, struct gendisk *b)
1514{
1515 return 0;
1516}
1517static inline int blk_integrity_register(struct gendisk *d,
1518 struct blk_integrity *b)
1519{
1520 return 0;
1521}
1522static inline void blk_integrity_unregister(struct gendisk *d)
1523{
1524}
1525static inline void blk_queue_max_integrity_segments(struct request_queue *q,
1526 unsigned int segs)
1527{
1528}
1529static inline unsigned short queue_max_integrity_segments(struct request_queue *q)
1530{
1531 return 0;
1532}
4eaf99be
MP
1533static inline bool blk_integrity_merge_rq(struct request_queue *rq,
1534 struct request *r1,
1535 struct request *r2)
fd83240a 1536{
cb1a5ab6 1537 return true;
fd83240a 1538}
4eaf99be
MP
1539static inline bool blk_integrity_merge_bio(struct request_queue *rq,
1540 struct request *r,
1541 struct bio *b)
fd83240a 1542{
cb1a5ab6 1543 return true;
fd83240a
SR
1544}
1545static inline bool blk_integrity_is_initialized(struct gendisk *g)
1546{
1547 return 0;
1548}
7ba1ba12
MP
1549
1550#endif /* CONFIG_BLK_DEV_INTEGRITY */
1551
08f85851 1552struct block_device_operations {
d4430d62 1553 int (*open) (struct block_device *, fmode_t);
db2a144b 1554 void (*release) (struct gendisk *, fmode_t);
47a191fd 1555 int (*rw_page)(struct block_device *, sector_t, struct page *, int rw);
d4430d62
AV
1556 int (*ioctl) (struct block_device *, fmode_t, unsigned, unsigned long);
1557 int (*compat_ioctl) (struct block_device *, fmode_t, unsigned, unsigned long);
e2e05394
RZ
1558 long (*direct_access)(struct block_device *, sector_t, void __pmem **,
1559 unsigned long *pfn, long size);
77ea887e
TH
1560 unsigned int (*check_events) (struct gendisk *disk,
1561 unsigned int clearing);
1562 /* ->media_changed() is DEPRECATED, use ->check_events() instead */
08f85851 1563 int (*media_changed) (struct gendisk *);
c3e33e04 1564 void (*unlock_native_capacity) (struct gendisk *);
08f85851
AV
1565 int (*revalidate_disk) (struct gendisk *);
1566 int (*getgeo)(struct block_device *, struct hd_geometry *);
b3a27d05
NG
1567 /* this callback is with swap_lock and sometimes page table lock held */
1568 void (*swap_slot_free_notify) (struct block_device *, unsigned long);
08f85851
AV
1569 struct module *owner;
1570};
1571
633a08b8
AV
1572extern int __blkdev_driver_ioctl(struct block_device *, fmode_t, unsigned int,
1573 unsigned long);
47a191fd
MW
1574extern int bdev_read_page(struct block_device *, sector_t, struct page *);
1575extern int bdev_write_page(struct block_device *, sector_t, struct page *,
1576 struct writeback_control *);
e2e05394
RZ
1577extern long bdev_direct_access(struct block_device *, sector_t,
1578 void __pmem **addr, unsigned long *pfn, long size);
9361401e 1579#else /* CONFIG_BLOCK */
ac13a829
FF
1580
1581struct block_device;
1582
9361401e
DH
1583/*
1584 * stubs for when the block layer is configured out
1585 */
1586#define buffer_heads_over_limit 0
1587
9361401e
DH
1588static inline long nr_blockdev_pages(void)
1589{
1590 return 0;
1591}
1592
1f940bdf
JA
1593struct blk_plug {
1594};
1595
1596static inline void blk_start_plug(struct blk_plug *plug)
73c10101
JA
1597{
1598}
1599
1f940bdf 1600static inline void blk_finish_plug(struct blk_plug *plug)
73c10101
JA
1601{
1602}
1603
1f940bdf 1604static inline void blk_flush_plug(struct task_struct *task)
73c10101
JA
1605{
1606}
1607
a237c1c5
JA
1608static inline void blk_schedule_flush_plug(struct task_struct *task)
1609{
1610}
1611
1612
73c10101
JA
1613static inline bool blk_needs_flush_plug(struct task_struct *tsk)
1614{
1615 return false;
1616}
1617
ac13a829
FF
1618static inline int blkdev_issue_flush(struct block_device *bdev, gfp_t gfp_mask,
1619 sector_t *error_sector)
1620{
1621 return 0;
1622}
1623
9361401e
DH
1624#endif /* CONFIG_BLOCK */
1625
1da177e4 1626#endif