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