blk-mq-debugfs: Show more request state information
[linux-block.git] / include / linux / blkdev.h
CommitLineData
b2441318 1/* SPDX-License-Identifier: GPL-2.0 */
1da177e4
LT
2#ifndef _LINUX_BLKDEV_H
3#define _LINUX_BLKDEV_H
4
85fd0bc9 5#include <linux/sched.h>
e6017571 6#include <linux/sched/clock.h>
85fd0bc9 7
f5ff8422
JA
8#ifdef CONFIG_BLOCK
9
1da177e4
LT
10#include <linux/major.h>
11#include <linux/genhd.h>
12#include <linux/list.h>
320ae51f 13#include <linux/llist.h>
1da177e4
LT
14#include <linux/timer.h>
15#include <linux/workqueue.h>
16#include <linux/pagemap.h>
66114cad 17#include <linux/backing-dev-defs.h>
1da177e4
LT
18#include <linux/wait.h>
19#include <linux/mempool.h>
34c0fd54 20#include <linux/pfn.h>
1da177e4 21#include <linux/bio.h>
1da177e4 22#include <linux/stringify.h>
3e6053d7 23#include <linux/gfp.h>
d351af01 24#include <linux/bsg.h>
c7c22e4d 25#include <linux/smp.h>
548bc8e1 26#include <linux/rcupdate.h>
add703fd 27#include <linux/percpu-refcount.h>
84be456f 28#include <linux/scatterlist.h>
6a0cb1bc 29#include <linux/blkzoned.h>
1d9bd516
TH
30#include <linux/seqlock.h>
31#include <linux/u64_stats_sync.h>
1da177e4 32
de477254 33struct module;
21b2f0c8
CH
34struct scsi_ioctl_command;
35
1da177e4 36struct request_queue;
1da177e4 37struct elevator_queue;
2056a782 38struct blk_trace;
3d6392cf
JA
39struct request;
40struct sg_io_hdr;
aa387cc8 41struct bsg_job;
3c798398 42struct blkcg_gq;
7c94e1c1 43struct blk_flush_queue;
bbd3e064 44struct pr_ops;
87760e5e 45struct rq_wb;
34dbad5d
OS
46struct blk_queue_stats;
47struct blk_stat_callback;
1da177e4
LT
48
49#define BLKDEV_MIN_RQ 4
50#define BLKDEV_MAX_RQ 128 /* Default maximum */
51
096392e0 52/* Must be consistent with blk_mq_poll_stats_bkt() */
0206319f
SB
53#define BLK_MQ_POLL_STATS_BKTS 16
54
8bd435b3
TH
55/*
56 * Maximum number of blkcg policies allowed to be registered concurrently.
57 * Defined here to simplify include dependency.
58 */
e21b7a0b 59#define BLKCG_MAX_POLS 3
8bd435b3 60
2a842aca 61typedef void (rq_end_io_fn)(struct request *, blk_status_t);
1da177e4 62
5b788ce3
TH
63#define BLK_RL_SYNCFULL (1U << 0)
64#define BLK_RL_ASYNCFULL (1U << 1)
65
1da177e4 66struct request_list {
5b788ce3 67 struct request_queue *q; /* the queue this rl belongs to */
a051661c
TH
68#ifdef CONFIG_BLK_CGROUP
69 struct blkcg_gq *blkg; /* blkg this request pool belongs to */
70#endif
1faa16d2
JA
71 /*
72 * count[], starved[], and wait[] are indexed by
73 * BLK_RW_SYNC/BLK_RW_ASYNC
74 */
8a5ecdd4
TH
75 int count[2];
76 int starved[2];
77 mempool_t *rq_pool;
78 wait_queue_head_t wait[2];
5b788ce3 79 unsigned int flags;
1da177e4
LT
80};
81
e8064021
CH
82/*
83 * request flags */
84typedef __u32 __bitwise req_flags_t;
85
86/* elevator knows about this request */
87#define RQF_SORTED ((__force req_flags_t)(1 << 0))
88/* drive already may have started this one */
89#define RQF_STARTED ((__force req_flags_t)(1 << 1))
90/* uses tagged queueing */
91#define RQF_QUEUED ((__force req_flags_t)(1 << 2))
92/* may not be passed by ioscheduler */
93#define RQF_SOFTBARRIER ((__force req_flags_t)(1 << 3))
94/* request for flush sequence */
95#define RQF_FLUSH_SEQ ((__force req_flags_t)(1 << 4))
96/* merge of different types, fail separately */
97#define RQF_MIXED_MERGE ((__force req_flags_t)(1 << 5))
98/* track inflight for MQ */
99#define RQF_MQ_INFLIGHT ((__force req_flags_t)(1 << 6))
100/* don't call prep for this one */
101#define RQF_DONTPREP ((__force req_flags_t)(1 << 7))
102/* set for "ide_preempt" requests and also for requests for which the SCSI
103 "quiesce" state must be ignored. */
104#define RQF_PREEMPT ((__force req_flags_t)(1 << 8))
105/* contains copies of user pages */
106#define RQF_COPY_USER ((__force req_flags_t)(1 << 9))
107/* vaguely specified driver internal error. Ignored by the block layer */
108#define RQF_FAILED ((__force req_flags_t)(1 << 10))
109/* don't warn about errors */
110#define RQF_QUIET ((__force req_flags_t)(1 << 11))
111/* elevator private data attached */
112#define RQF_ELVPRIV ((__force req_flags_t)(1 << 12))
113/* account I/O stat */
114#define RQF_IO_STAT ((__force req_flags_t)(1 << 13))
115/* request came from our alloc pool */
116#define RQF_ALLOCED ((__force req_flags_t)(1 << 14))
117/* runtime pm request */
118#define RQF_PM ((__force req_flags_t)(1 << 15))
119/* on IO scheduler merge hash */
120#define RQF_HASHED ((__force req_flags_t)(1 << 16))
cf43e6be
JA
121/* IO stats tracking on */
122#define RQF_STATS ((__force req_flags_t)(1 << 17))
f9d03f96
CH
123/* Look at ->special_vec for the actual data payload instead of the
124 bio chain. */
125#define RQF_SPECIAL_PAYLOAD ((__force req_flags_t)(1 << 18))
6cc77e9c
CH
126/* The per-zone write lock is held for this request */
127#define RQF_ZONE_WRITE_LOCKED ((__force req_flags_t)(1 << 19))
634f9e46
TH
128/* timeout is expired */
129#define RQF_MQ_TIMEOUT_EXPIRED ((__force req_flags_t)(1 << 20))
76a86f9d
JA
130/* already slept for hybrid poll */
131#define RQF_MQ_POLL_SLEPT ((__force req_flags_t)(1 << 21))
e8064021
CH
132
133/* flags that prevent us from merging requests: */
134#define RQF_NOMERGE_FLAGS \
f9d03f96 135 (RQF_STARTED | RQF_SOFTBARRIER | RQF_FLUSH_SEQ | RQF_SPECIAL_PAYLOAD)
e8064021 136
1da177e4 137/*
af76e555
CH
138 * Try to put the fields that are referenced together in the same cacheline.
139 *
140 * If you modify this structure, make sure to update blk_rq_init() and
141 * especially blk_mq_rq_ctx_init() to take care of the added fields.
1da177e4
LT
142 */
143struct request {
165125e1 144 struct request_queue *q;
320ae51f 145 struct blk_mq_ctx *mq_ctx;
e6a1c874 146
ca93e453 147 int cpu;
ef295ecf 148 unsigned int cmd_flags; /* op and common flags */
e8064021 149 req_flags_t rq_flags;
d486f1f2
JA
150
151 int internal_tag;
152
a2dec7b3 153 /* the following two fields are internal, NEVER access directly */
a2dec7b3 154 unsigned int __data_len; /* total data len */
bd166ef1 155 int tag;
181fdde3 156 sector_t __sector; /* sector cursor */
1da177e4
LT
157
158 struct bio *bio;
159 struct bio *biotail;
160
7c3fb70f
JA
161 struct list_head queuelist;
162
360f92c2
JA
163 /*
164 * The hash is used inside the scheduler, and killed once the
165 * request reaches the dispatch list. The ipi_list is only used
166 * to queue the request for softirq completion, which is long
167 * after the request has been unhashed (and even removed from
168 * the dispatch list).
169 */
170 union {
171 struct hlist_node hash; /* merge hash */
172 struct list_head ipi_list;
173 };
174
e6a1c874
JA
175 /*
176 * The rb_node is only used inside the io scheduler, requests
177 * are pruned when moved to the dispatch queue. So let the
c186794d 178 * completion_data share space with the rb_node.
e6a1c874
JA
179 */
180 union {
181 struct rb_node rb_node; /* sort/lookup */
f9d03f96 182 struct bio_vec special_vec;
c186794d 183 void *completion_data;
e26738e0 184 int error_count; /* for legacy drivers, don't use */
e6a1c874 185 };
9817064b 186
ff7d145f 187 /*
7f1dc8a2 188 * Three pointers are available for the IO schedulers, if they need
c186794d
MS
189 * more they have to dynamically allocate it. Flush requests are
190 * never put on the IO scheduler. So let the flush fields share
a612fddf 191 * space with the elevator data.
ff7d145f 192 */
c186794d 193 union {
a612fddf
TH
194 struct {
195 struct io_cq *icq;
196 void *priv[2];
197 } elv;
198
c186794d
MS
199 struct {
200 unsigned int seq;
201 struct list_head list;
4853abaa 202 rq_end_io_fn *saved_end_io;
c186794d
MS
203 } flush;
204 };
ff7d145f 205
8f34ee75 206 struct gendisk *rq_disk;
09e099d4 207 struct hd_struct *part;
1da177e4 208 unsigned long start_time;
cf43e6be 209 struct blk_issue_stat issue_stat;
1da177e4
LT
210 /* Number of scatter-gather DMA addr+len pairs after
211 * physical address coalescing is performed.
212 */
213 unsigned short nr_phys_segments;
7c3fb70f 214
13f05c8d
MP
215#if defined(CONFIG_BLK_DEV_INTEGRITY)
216 unsigned short nr_integrity_segments;
217#endif
1da177e4 218
7c3fb70f 219 unsigned short write_hint;
8f34ee75
JA
220 unsigned short ioprio;
221
1dd5198b 222 unsigned int timeout;
1da177e4 223
731ec497 224 void *special; /* opaque pointer available for LLD use */
cdd60262 225
7a85f889 226 unsigned int extra_len; /* length of alignment and padding */
1da177e4 227
1d9bd516
TH
228 /*
229 * On blk-mq, the lower bits of ->gstate (generation number and
230 * state) carry the MQ_RQ_* state value and the upper bits the
231 * generation number which is monotonically incremented and used to
232 * distinguish the reuse instances.
233 *
234 * ->gstate_seq allows updates to ->gstate and other fields
235 * (currently ->deadline) during request start to be read
236 * atomically from the timeout path, so that it can operate on a
237 * coherent set of information.
238 */
239 seqcount_t gstate_seq;
240 u64 gstate;
241
242 /*
243 * ->aborted_gstate is used by the timeout to claim a specific
244 * recycle instance of this request. See blk_mq_timeout_work().
245 */
246 struct u64_stats_sync aborted_gstate_sync;
247 u64 aborted_gstate;
248
0a72e7f4
JA
249 /* access through blk_rq_set_deadline, blk_rq_deadline */
250 unsigned long __deadline;
cb6934f8 251
242f9dcb 252 struct list_head timeout_list;
1da177e4 253
7c3fb70f 254 union {
0a4b6e2f 255 struct __call_single_data csd;
7c3fb70f
JA
256 u64 fifo_time;
257 };
258
1da177e4 259 /*
c00895ab 260 * completion callback.
1da177e4
LT
261 */
262 rq_end_io_fn *end_io;
263 void *end_io_data;
abae1fde
FT
264
265 /* for bidi */
266 struct request *next_rq;
7c3fb70f
JA
267
268#ifdef CONFIG_BLK_CGROUP
269 struct request_list *rl; /* rl this rq is alloced from */
270 unsigned long long start_time_ns;
271 unsigned long long io_start_time_ns; /* when passed to hardware */
272#endif
1da177e4
LT
273};
274
14cb0dc6
ML
275static inline bool blk_op_is_scsi(unsigned int op)
276{
277 return op == REQ_OP_SCSI_IN || op == REQ_OP_SCSI_OUT;
278}
279
280static inline bool blk_op_is_private(unsigned int op)
281{
282 return op == REQ_OP_DRV_IN || op == REQ_OP_DRV_OUT;
283}
284
aebf526b
CH
285static inline bool blk_rq_is_scsi(struct request *rq)
286{
14cb0dc6 287 return blk_op_is_scsi(req_op(rq));
aebf526b
CH
288}
289
290static inline bool blk_rq_is_private(struct request *rq)
291{
14cb0dc6 292 return blk_op_is_private(req_op(rq));
aebf526b
CH
293}
294
57292b58
CH
295static inline bool blk_rq_is_passthrough(struct request *rq)
296{
aebf526b 297 return blk_rq_is_scsi(rq) || blk_rq_is_private(rq);
57292b58
CH
298}
299
14cb0dc6
ML
300static inline bool bio_is_passthrough(struct bio *bio)
301{
302 unsigned op = bio_op(bio);
303
304 return blk_op_is_scsi(op) || blk_op_is_private(op);
305}
306
766ca442
FLVC
307static inline unsigned short req_get_ioprio(struct request *req)
308{
309 return req->ioprio;
310}
311
1da177e4
LT
312#include <linux/elevator.h>
313
320ae51f
JA
314struct blk_queue_ctx;
315
165125e1 316typedef void (request_fn_proc) (struct request_queue *q);
dece1635 317typedef blk_qc_t (make_request_fn) (struct request_queue *q, struct bio *bio);
ea435e1b 318typedef bool (poll_q_fn) (struct request_queue *q, blk_qc_t);
165125e1 319typedef int (prep_rq_fn) (struct request_queue *, struct request *);
28018c24 320typedef void (unprep_rq_fn) (struct request_queue *, struct request *);
1da177e4
LT
321
322struct bio_vec;
ff856bad 323typedef void (softirq_done_fn)(struct request *);
2fb98e84 324typedef int (dma_drain_needed_fn)(struct request *);
ef9e3fac 325typedef int (lld_busy_fn) (struct request_queue *q);
aa387cc8 326typedef int (bsg_job_fn) (struct bsg_job *);
6d247d7f
CH
327typedef int (init_rq_fn)(struct request_queue *, struct request *, gfp_t);
328typedef void (exit_rq_fn)(struct request_queue *, struct request *);
1da177e4 329
242f9dcb
JA
330enum blk_eh_timer_return {
331 BLK_EH_NOT_HANDLED,
332 BLK_EH_HANDLED,
333 BLK_EH_RESET_TIMER,
334};
335
336typedef enum blk_eh_timer_return (rq_timed_out_fn)(struct request *);
337
1da177e4
LT
338enum blk_queue_state {
339 Queue_down,
340 Queue_up,
341};
342
1da177e4
LT
343struct blk_queue_tag {
344 struct request **tag_index; /* map of busy tags */
345 unsigned long *tag_map; /* bit map of free/busy tags */
1da177e4 346 int max_depth; /* what we will send to device */
ba025082 347 int real_max_depth; /* what the array can hold */
1da177e4 348 atomic_t refcnt; /* map can be shared */
ee1b6f7a
SL
349 int alloc_policy; /* tag allocation policy */
350 int next_tag; /* next tag */
1da177e4 351};
ee1b6f7a
SL
352#define BLK_TAG_ALLOC_FIFO 0 /* allocate starting from 0 */
353#define BLK_TAG_ALLOC_RR 1 /* allocate starting from last allocated tag */
1da177e4 354
abf54393
FT
355#define BLK_SCSI_MAX_CMDS (256)
356#define BLK_SCSI_CMD_PER_LONG (BLK_SCSI_MAX_CMDS / (sizeof(long) * 8))
357
797476b8
DLM
358/*
359 * Zoned block device models (zoned limit).
360 */
361enum blk_zoned_model {
362 BLK_ZONED_NONE, /* Regular block device */
363 BLK_ZONED_HA, /* Host-aware zoned block device */
364 BLK_ZONED_HM, /* Host-managed zoned block device */
365};
366
025146e1
MP
367struct queue_limits {
368 unsigned long bounce_pfn;
369 unsigned long seg_boundary_mask;
03100aad 370 unsigned long virt_boundary_mask;
025146e1
MP
371
372 unsigned int max_hw_sectors;
ca369d51 373 unsigned int max_dev_sectors;
762380ad 374 unsigned int chunk_sectors;
025146e1
MP
375 unsigned int max_sectors;
376 unsigned int max_segment_size;
c72758f3
MP
377 unsigned int physical_block_size;
378 unsigned int alignment_offset;
379 unsigned int io_min;
380 unsigned int io_opt;
67efc925 381 unsigned int max_discard_sectors;
0034af03 382 unsigned int max_hw_discard_sectors;
4363ac7c 383 unsigned int max_write_same_sectors;
a6f0788e 384 unsigned int max_write_zeroes_sectors;
86b37281
MP
385 unsigned int discard_granularity;
386 unsigned int discard_alignment;
025146e1
MP
387
388 unsigned short logical_block_size;
8a78362c 389 unsigned short max_segments;
13f05c8d 390 unsigned short max_integrity_segments;
1e739730 391 unsigned short max_discard_segments;
025146e1 392
c72758f3 393 unsigned char misaligned;
86b37281 394 unsigned char discard_misaligned;
e692cb66 395 unsigned char cluster;
c78afc62 396 unsigned char raid_partial_stripes_expensive;
797476b8 397 enum blk_zoned_model zoned;
025146e1
MP
398};
399
6a0cb1bc
HR
400#ifdef CONFIG_BLK_DEV_ZONED
401
402struct blk_zone_report_hdr {
403 unsigned int nr_zones;
404 u8 padding[60];
405};
406
407extern int blkdev_report_zones(struct block_device *bdev,
408 sector_t sector, struct blk_zone *zones,
409 unsigned int *nr_zones, gfp_t gfp_mask);
410extern int blkdev_reset_zones(struct block_device *bdev, sector_t sectors,
411 sector_t nr_sectors, gfp_t gfp_mask);
412
3ed05a98
ST
413extern int blkdev_report_zones_ioctl(struct block_device *bdev, fmode_t mode,
414 unsigned int cmd, unsigned long arg);
415extern int blkdev_reset_zones_ioctl(struct block_device *bdev, fmode_t mode,
416 unsigned int cmd, unsigned long arg);
417
418#else /* CONFIG_BLK_DEV_ZONED */
419
420static inline int blkdev_report_zones_ioctl(struct block_device *bdev,
421 fmode_t mode, unsigned int cmd,
422 unsigned long arg)
423{
424 return -ENOTTY;
425}
426
427static inline int blkdev_reset_zones_ioctl(struct block_device *bdev,
428 fmode_t mode, unsigned int cmd,
429 unsigned long arg)
430{
431 return -ENOTTY;
432}
433
6a0cb1bc
HR
434#endif /* CONFIG_BLK_DEV_ZONED */
435
d7b76301 436struct request_queue {
1da177e4
LT
437 /*
438 * Together with queue_head for cacheline sharing
439 */
440 struct list_head queue_head;
441 struct request *last_merge;
b374d18a 442 struct elevator_queue *elevator;
8a5ecdd4
TH
443 int nr_rqs[2]; /* # allocated [a]sync rqs */
444 int nr_rqs_elvpriv; /* # allocated rqs w/ elvpriv */
1da177e4 445
8e8320c9
JA
446 atomic_t shared_hctx_restart;
447
34dbad5d 448 struct blk_queue_stats *stats;
87760e5e
JA
449 struct rq_wb *rq_wb;
450
1da177e4 451 /*
a051661c
TH
452 * If blkcg is not used, @q->root_rl serves all requests. If blkcg
453 * is used, root blkg allocates from @q->root_rl and all other
454 * blkgs from their own blkg->rl. Which one to use should be
455 * determined using bio_request_list().
1da177e4 456 */
a051661c 457 struct request_list root_rl;
1da177e4
LT
458
459 request_fn_proc *request_fn;
1da177e4 460 make_request_fn *make_request_fn;
ea435e1b 461 poll_q_fn *poll_fn;
1da177e4 462 prep_rq_fn *prep_rq_fn;
28018c24 463 unprep_rq_fn *unprep_rq_fn;
ff856bad 464 softirq_done_fn *softirq_done_fn;
242f9dcb 465 rq_timed_out_fn *rq_timed_out_fn;
2fb98e84 466 dma_drain_needed_fn *dma_drain_needed;
ef9e3fac 467 lld_busy_fn *lld_busy_fn;
d280bab3 468 /* Called just after a request is allocated */
6d247d7f 469 init_rq_fn *init_rq_fn;
d280bab3 470 /* Called just before a request is freed */
6d247d7f 471 exit_rq_fn *exit_rq_fn;
d280bab3
BVA
472 /* Called from inside blk_get_request() */
473 void (*initialize_rq_fn)(struct request *rq);
1da177e4 474
f8a5b122 475 const struct blk_mq_ops *mq_ops;
320ae51f
JA
476
477 unsigned int *mq_map;
478
479 /* sw queues */
e6cdb092 480 struct blk_mq_ctx __percpu *queue_ctx;
320ae51f
JA
481 unsigned int nr_queues;
482
d278d4a8
JA
483 unsigned int queue_depth;
484
320ae51f
JA
485 /* hw dispatch queues */
486 struct blk_mq_hw_ctx **queue_hw_ctx;
487 unsigned int nr_hw_queues;
488
8922e16c
TH
489 /*
490 * Dispatch queue sorting
491 */
1b47f531 492 sector_t end_sector;
8922e16c 493 struct request *boundary_rq;
8922e16c 494
1da177e4 495 /*
3cca6dc1 496 * Delayed queue handling
1da177e4 497 */
3cca6dc1 498 struct delayed_work delay_work;
1da177e4 499
dc3b17cc 500 struct backing_dev_info *backing_dev_info;
1da177e4
LT
501
502 /*
503 * The queue owner gets to use this for whatever they like.
504 * ll_rw_blk doesn't touch it.
505 */
506 void *queuedata;
507
1da177e4 508 /*
d7b76301 509 * various queue flags, see QUEUE_* below
1da177e4 510 */
d7b76301 511 unsigned long queue_flags;
1da177e4 512
a73f730d
TH
513 /*
514 * ida allocated id for this queue. Used to index queues from
515 * ioctx.
516 */
517 int id;
518
1da177e4 519 /*
d7b76301 520 * queue needs bounce pages for pages above this limit
1da177e4 521 */
d7b76301 522 gfp_t bounce_gfp;
1da177e4
LT
523
524 /*
152587de 525 * protects queue structures from reentrancy. ->__queue_lock should
526 * _never_ be used directly, it is queue private. always use
527 * ->queue_lock.
1da177e4 528 */
152587de 529 spinlock_t __queue_lock;
1da177e4
LT
530 spinlock_t *queue_lock;
531
532 /*
533 * queue kobject
534 */
535 struct kobject kobj;
536
320ae51f
JA
537 /*
538 * mq queue kobject
539 */
540 struct kobject mq_kobj;
541
ac6fc48c
DW
542#ifdef CONFIG_BLK_DEV_INTEGRITY
543 struct blk_integrity integrity;
544#endif /* CONFIG_BLK_DEV_INTEGRITY */
545
47fafbc7 546#ifdef CONFIG_PM
6c954667
LM
547 struct device *dev;
548 int rpm_status;
549 unsigned int nr_pending;
550#endif
551
1da177e4
LT
552 /*
553 * queue settings
554 */
555 unsigned long nr_requests; /* Max # of requests */
556 unsigned int nr_congestion_on;
557 unsigned int nr_congestion_off;
558 unsigned int nr_batching;
559
fa0ccd83 560 unsigned int dma_drain_size;
d7b76301 561 void *dma_drain_buffer;
e3790c7d 562 unsigned int dma_pad_mask;
1da177e4
LT
563 unsigned int dma_alignment;
564
565 struct blk_queue_tag *queue_tags;
6eca9004 566 struct list_head tag_busy_list;
1da177e4 567
15853af9 568 unsigned int nr_sorted;
0a7ae2ff 569 unsigned int in_flight[2];
cf43e6be 570
24faf6f6
BVA
571 /*
572 * Number of active block driver functions for which blk_drain_queue()
573 * must wait. Must be incremented around functions that unlock the
574 * queue_lock internally, e.g. scsi_request_fn().
575 */
576 unsigned int request_fn_active;
1da177e4 577
242f9dcb 578 unsigned int rq_timeout;
64f1c21e 579 int poll_nsec;
34dbad5d
OS
580
581 struct blk_stat_callback *poll_cb;
0206319f 582 struct blk_rq_stat poll_stat[BLK_MQ_POLL_STATS_BKTS];
34dbad5d 583
242f9dcb 584 struct timer_list timeout;
287922eb 585 struct work_struct timeout_work;
242f9dcb
JA
586 struct list_head timeout_list;
587
a612fddf 588 struct list_head icq_list;
4eef3049 589#ifdef CONFIG_BLK_CGROUP
a2b1693b 590 DECLARE_BITMAP (blkcg_pols, BLKCG_MAX_POLS);
3c798398 591 struct blkcg_gq *root_blkg;
03aa264a 592 struct list_head blkg_list;
4eef3049 593#endif
a612fddf 594
025146e1
MP
595 struct queue_limits limits;
596
6cc77e9c
CH
597 /*
598 * Zoned block device information for request dispatch control.
599 * nr_zones is the total number of zones of the device. This is always
600 * 0 for regular block devices. seq_zones_bitmap is a bitmap of nr_zones
601 * bits which indicates if a zone is conventional (bit clear) or
602 * sequential (bit set). seq_zones_wlock is a bitmap of nr_zones
603 * bits which indicates if a zone is write locked, that is, if a write
604 * request targeting the zone was dispatched. All three fields are
605 * initialized by the low level device driver (e.g. scsi/sd.c).
606 * Stacking drivers (device mappers) may or may not initialize
607 * these fields.
608 */
609 unsigned int nr_zones;
610 unsigned long *seq_zones_bitmap;
611 unsigned long *seq_zones_wlock;
612
1da177e4
LT
613 /*
614 * sg stuff
615 */
616 unsigned int sg_timeout;
617 unsigned int sg_reserved_size;
1946089a 618 int node;
6c5c9341 619#ifdef CONFIG_BLK_DEV_IO_TRACE
2056a782 620 struct blk_trace *blk_trace;
5acb3cc2 621 struct mutex blk_trace_mutex;
6c5c9341 622#endif
1da177e4 623 /*
4913efe4 624 * for flush operations
1da177e4 625 */
7c94e1c1 626 struct blk_flush_queue *fq;
483f4afc 627
6fca6a61
CH
628 struct list_head requeue_list;
629 spinlock_t requeue_lock;
2849450a 630 struct delayed_work requeue_work;
6fca6a61 631
483f4afc 632 struct mutex sysfs_lock;
d351af01 633
d732580b 634 int bypass_depth;
4ecd4fef 635 atomic_t mq_freeze_depth;
d732580b 636
d351af01 637#if defined(CONFIG_BLK_DEV_BSG)
aa387cc8 638 bsg_job_fn *bsg_job_fn;
d351af01
FT
639 struct bsg_class_device bsg_dev;
640#endif
e43473b7
VG
641
642#ifdef CONFIG_BLK_DEV_THROTTLING
643 /* Throttle data */
644 struct throtl_data *td;
645#endif
548bc8e1 646 struct rcu_head rcu_head;
320ae51f 647 wait_queue_head_t mq_freeze_wq;
3ef28e83 648 struct percpu_ref q_usage_counter;
320ae51f 649 struct list_head all_q_node;
0d2602ca
JA
650
651 struct blk_mq_tag_set *tag_set;
652 struct list_head tag_set_list;
54efd50b 653 struct bio_set *bio_split;
4593fdbe 654
03796c14 655#ifdef CONFIG_BLK_DEBUG_FS
07e4fead 656 struct dentry *debugfs_dir;
d332ce09 657 struct dentry *sched_debugfs_dir;
07e4fead
OS
658#endif
659
4593fdbe 660 bool mq_sysfs_init_done;
6d247d7f
CH
661
662 size_t cmd_size;
663 void *rq_alloc_data;
dc9edc44
BVA
664
665 struct work_struct release_work;
f793dfd3
JA
666
667#define BLK_MAX_WRITE_HINTS 5
668 u64 write_hints[BLK_MAX_WRITE_HINTS];
1da177e4
LT
669};
670
e743eb1e
JA
671#define QUEUE_FLAG_QUEUED 0 /* uses generic tag queueing */
672#define QUEUE_FLAG_STOPPED 1 /* queue is stopped */
673#define QUEUE_FLAG_DYING 2 /* queue being torn down */
674#define QUEUE_FLAG_BYPASS 3 /* act as dumb FIFO queue */
675#define QUEUE_FLAG_BIDI 4 /* queue supports bidi requests */
676#define QUEUE_FLAG_NOMERGES 5 /* disable merge attempts */
677#define QUEUE_FLAG_SAME_COMP 6 /* complete on same CPU-group */
678#define QUEUE_FLAG_FAIL_IO 7 /* fake timeout */
e743eb1e 679#define QUEUE_FLAG_NONROT 9 /* non-rotational device (SSD) */
88e740f1 680#define QUEUE_FLAG_VIRT QUEUE_FLAG_NONROT /* paravirt device */
e743eb1e
JA
681#define QUEUE_FLAG_IO_STAT 10 /* do IO stats */
682#define QUEUE_FLAG_DISCARD 11 /* supports DISCARD */
683#define QUEUE_FLAG_NOXMERGES 12 /* No extended merges */
684#define QUEUE_FLAG_ADD_RANDOM 13 /* Contributes to random pool */
685#define QUEUE_FLAG_SECERASE 14 /* supports secure erase */
686#define QUEUE_FLAG_SAME_FORCE 15 /* force complete on same CPU */
687#define QUEUE_FLAG_DEAD 16 /* queue tear-down finished */
688#define QUEUE_FLAG_INIT_DONE 17 /* queue is initialized */
689#define QUEUE_FLAG_NO_SG_MERGE 18 /* don't attempt to merge SG segments*/
690#define QUEUE_FLAG_POLL 19 /* IO polling enabled if set */
691#define QUEUE_FLAG_WC 20 /* Write back caching */
692#define QUEUE_FLAG_FUA 21 /* device supports FUA writes */
693#define QUEUE_FLAG_FLUSH_NQ 22 /* flush not queueuable */
694#define QUEUE_FLAG_DAX 23 /* device supports DAX */
695#define QUEUE_FLAG_STATS 24 /* track rq completion times */
696#define QUEUE_FLAG_POLL_STATS 25 /* collecting stats for hybrid polling */
697#define QUEUE_FLAG_REGISTERED 26 /* queue has been registered to a disk */
698#define QUEUE_FLAG_SCSI_PASSTHROUGH 27 /* queue supports SCSI commands */
699#define QUEUE_FLAG_QUIESCED 28 /* queue has been quiesced */
c9254f2d 700#define QUEUE_FLAG_PREEMPT_ONLY 29 /* only process REQ_PREEMPT requests */
bc58ba94
JA
701
702#define QUEUE_FLAG_DEFAULT ((1 << QUEUE_FLAG_IO_STAT) | \
e2e1a148
JA
703 (1 << QUEUE_FLAG_SAME_COMP) | \
704 (1 << QUEUE_FLAG_ADD_RANDOM))
797e7dbb 705
94eddfbe 706#define QUEUE_FLAG_MQ_DEFAULT ((1 << QUEUE_FLAG_IO_STAT) | \
8e0b60b9
CH
707 (1 << QUEUE_FLAG_SAME_COMP) | \
708 (1 << QUEUE_FLAG_POLL))
94eddfbe 709
8814ce8a
BVA
710void blk_queue_flag_set(unsigned int flag, struct request_queue *q);
711void blk_queue_flag_clear(unsigned int flag, struct request_queue *q);
712bool blk_queue_flag_test_and_set(unsigned int flag, struct request_queue *q);
713bool blk_queue_flag_test_and_clear(unsigned int flag, struct request_queue *q);
714
1da177e4
LT
715#define blk_queue_tagged(q) test_bit(QUEUE_FLAG_QUEUED, &(q)->queue_flags)
716#define blk_queue_stopped(q) test_bit(QUEUE_FLAG_STOPPED, &(q)->queue_flags)
3f3299d5 717#define blk_queue_dying(q) test_bit(QUEUE_FLAG_DYING, &(q)->queue_flags)
c246e80d 718#define blk_queue_dead(q) test_bit(QUEUE_FLAG_DEAD, &(q)->queue_flags)
d732580b 719#define blk_queue_bypass(q) test_bit(QUEUE_FLAG_BYPASS, &(q)->queue_flags)
320ae51f 720#define blk_queue_init_done(q) test_bit(QUEUE_FLAG_INIT_DONE, &(q)->queue_flags)
ac9fafa1 721#define blk_queue_nomerges(q) test_bit(QUEUE_FLAG_NOMERGES, &(q)->queue_flags)
488991e2
AB
722#define blk_queue_noxmerges(q) \
723 test_bit(QUEUE_FLAG_NOXMERGES, &(q)->queue_flags)
a68bbddb 724#define blk_queue_nonrot(q) test_bit(QUEUE_FLAG_NONROT, &(q)->queue_flags)
bc58ba94 725#define blk_queue_io_stat(q) test_bit(QUEUE_FLAG_IO_STAT, &(q)->queue_flags)
e2e1a148 726#define blk_queue_add_random(q) test_bit(QUEUE_FLAG_ADD_RANDOM, &(q)->queue_flags)
c15227de 727#define blk_queue_discard(q) test_bit(QUEUE_FLAG_DISCARD, &(q)->queue_flags)
288dab8a
CH
728#define blk_queue_secure_erase(q) \
729 (test_bit(QUEUE_FLAG_SECERASE, &(q)->queue_flags))
163d4baa 730#define blk_queue_dax(q) test_bit(QUEUE_FLAG_DAX, &(q)->queue_flags)
9efc160f
BVA
731#define blk_queue_scsi_passthrough(q) \
732 test_bit(QUEUE_FLAG_SCSI_PASSTHROUGH, &(q)->queue_flags)
1da177e4 733
33659ebb
CH
734#define blk_noretry_request(rq) \
735 ((rq)->cmd_flags & (REQ_FAILFAST_DEV|REQ_FAILFAST_TRANSPORT| \
736 REQ_FAILFAST_DRIVER))
f4560ffe 737#define blk_queue_quiesced(q) test_bit(QUEUE_FLAG_QUIESCED, &(q)->queue_flags)
c9254f2d
BVA
738#define blk_queue_preempt_only(q) \
739 test_bit(QUEUE_FLAG_PREEMPT_ONLY, &(q)->queue_flags)
740
741extern int blk_set_preempt_only(struct request_queue *q);
742extern void blk_clear_preempt_only(struct request_queue *q);
33659ebb 743
66f91322
BVA
744static inline int queue_in_flight(struct request_queue *q)
745{
746 return q->in_flight[0] + q->in_flight[1];
747}
748
57292b58
CH
749static inline bool blk_account_rq(struct request *rq)
750{
751 return (rq->rq_flags & RQF_STARTED) && !blk_rq_is_passthrough(rq);
752}
33659ebb 753
ab780f1e 754#define blk_rq_cpu_valid(rq) ((rq)->cpu != -1)
abae1fde 755#define blk_bidi_rq(rq) ((rq)->next_rq != NULL)
336cdb40
KU
756/* rq->queuelist of dequeued request must be list_empty() */
757#define blk_queued_rq(rq) (!list_empty(&(rq)->queuelist))
1da177e4
LT
758
759#define list_entry_rq(ptr) list_entry((ptr), struct request, queuelist)
760
4e1b2d52 761#define rq_data_dir(rq) (op_is_write(req_op(rq)) ? WRITE : READ)
1da177e4 762
49fd524f
JA
763/*
764 * Driver can handle struct request, if it either has an old style
765 * request_fn defined, or is blk-mq based.
766 */
767static inline bool queue_is_rq_based(struct request_queue *q)
768{
769 return q->request_fn || q->mq_ops;
770}
771
e692cb66
MP
772static inline unsigned int blk_queue_cluster(struct request_queue *q)
773{
774 return q->limits.cluster;
775}
776
797476b8
DLM
777static inline enum blk_zoned_model
778blk_queue_zoned_model(struct request_queue *q)
779{
780 return q->limits.zoned;
781}
782
783static inline bool blk_queue_is_zoned(struct request_queue *q)
784{
785 switch (blk_queue_zoned_model(q)) {
786 case BLK_ZONED_HA:
787 case BLK_ZONED_HM:
788 return true;
789 default:
790 return false;
791 }
792}
793
f99e8648 794static inline unsigned int blk_queue_zone_sectors(struct request_queue *q)
6a0cb1bc
HR
795{
796 return blk_queue_is_zoned(q) ? q->limits.chunk_sectors : 0;
797}
798
6cc77e9c
CH
799static inline unsigned int blk_queue_nr_zones(struct request_queue *q)
800{
801 return q->nr_zones;
802}
803
804static inline unsigned int blk_queue_zone_no(struct request_queue *q,
805 sector_t sector)
806{
807 if (!blk_queue_is_zoned(q))
808 return 0;
809 return sector >> ilog2(q->limits.chunk_sectors);
810}
811
812static inline bool blk_queue_zone_is_seq(struct request_queue *q,
813 sector_t sector)
814{
815 if (!blk_queue_is_zoned(q) || !q->seq_zones_bitmap)
816 return false;
817 return test_bit(blk_queue_zone_no(q, sector), q->seq_zones_bitmap);
818}
819
1faa16d2
JA
820static inline bool rq_is_sync(struct request *rq)
821{
ef295ecf 822 return op_is_sync(rq->cmd_flags);
1faa16d2
JA
823}
824
5b788ce3 825static inline bool blk_rl_full(struct request_list *rl, bool sync)
1da177e4 826{
5b788ce3
TH
827 unsigned int flag = sync ? BLK_RL_SYNCFULL : BLK_RL_ASYNCFULL;
828
829 return rl->flags & flag;
1da177e4
LT
830}
831
5b788ce3 832static inline void blk_set_rl_full(struct request_list *rl, bool sync)
1da177e4 833{
5b788ce3
TH
834 unsigned int flag = sync ? BLK_RL_SYNCFULL : BLK_RL_ASYNCFULL;
835
836 rl->flags |= flag;
1da177e4
LT
837}
838
5b788ce3 839static inline void blk_clear_rl_full(struct request_list *rl, bool sync)
1da177e4 840{
5b788ce3
TH
841 unsigned int flag = sync ? BLK_RL_SYNCFULL : BLK_RL_ASYNCFULL;
842
843 rl->flags &= ~flag;
1da177e4
LT
844}
845
e2a60da7
MP
846static inline bool rq_mergeable(struct request *rq)
847{
57292b58 848 if (blk_rq_is_passthrough(rq))
e2a60da7 849 return false;
1da177e4 850
3a5e02ce
MC
851 if (req_op(rq) == REQ_OP_FLUSH)
852 return false;
853
a6f0788e
CK
854 if (req_op(rq) == REQ_OP_WRITE_ZEROES)
855 return false;
856
e2a60da7 857 if (rq->cmd_flags & REQ_NOMERGE_FLAGS)
e8064021
CH
858 return false;
859 if (rq->rq_flags & RQF_NOMERGE_FLAGS)
e2a60da7
MP
860 return false;
861
862 return true;
863}
1da177e4 864
4363ac7c
MP
865static inline bool blk_write_same_mergeable(struct bio *a, struct bio *b)
866{
efbeccdb
CH
867 if (bio_page(a) == bio_page(b) &&
868 bio_offset(a) == bio_offset(b))
4363ac7c
MP
869 return true;
870
871 return false;
872}
873
d278d4a8
JA
874static inline unsigned int blk_queue_depth(struct request_queue *q)
875{
876 if (q->queue_depth)
877 return q->queue_depth;
878
879 return q->nr_requests;
880}
881
1da177e4
LT
882/*
883 * q->prep_rq_fn return values
884 */
0fb5b1fb
MP
885enum {
886 BLKPREP_OK, /* serve it */
887 BLKPREP_KILL, /* fatal error, kill, return -EIO */
888 BLKPREP_DEFER, /* leave on queue */
889 BLKPREP_INVALID, /* invalid command, kill, return -EREMOTEIO */
890};
1da177e4
LT
891
892extern unsigned long blk_max_low_pfn, blk_max_pfn;
893
894/*
895 * standard bounce addresses:
896 *
897 * BLK_BOUNCE_HIGH : bounce all highmem pages
898 * BLK_BOUNCE_ANY : don't bounce anything
899 * BLK_BOUNCE_ISA : bounce pages above ISA DMA boundary
900 */
2472892a
AK
901
902#if BITS_PER_LONG == 32
1da177e4 903#define BLK_BOUNCE_HIGH ((u64)blk_max_low_pfn << PAGE_SHIFT)
2472892a
AK
904#else
905#define BLK_BOUNCE_HIGH -1ULL
906#endif
907#define BLK_BOUNCE_ANY (-1ULL)
bfe17231 908#define BLK_BOUNCE_ISA (DMA_BIT_MASK(24))
1da177e4 909
3d6392cf
JA
910/*
911 * default timeout for SG_IO if none specified
912 */
913#define BLK_DEFAULT_SG_TIMEOUT (60 * HZ)
f2f1fa78 914#define BLK_MIN_SG_TIMEOUT (7 * HZ)
3d6392cf 915
152e283f
FT
916struct rq_map_data {
917 struct page **pages;
918 int page_order;
919 int nr_entries;
56c451f4 920 unsigned long offset;
97ae77a1 921 int null_mapped;
ecb554a8 922 int from_user;
152e283f
FT
923};
924
5705f702 925struct req_iterator {
7988613b 926 struct bvec_iter iter;
5705f702
N
927 struct bio *bio;
928};
929
930/* This should not be used directly - use rq_for_each_segment */
1e428079
JA
931#define for_each_bio(_bio) \
932 for (; _bio; _bio = _bio->bi_next)
5705f702 933#define __rq_for_each_bio(_bio, rq) \
1da177e4
LT
934 if ((rq->bio)) \
935 for (_bio = (rq)->bio; _bio; _bio = _bio->bi_next)
936
5705f702
N
937#define rq_for_each_segment(bvl, _rq, _iter) \
938 __rq_for_each_bio(_iter.bio, _rq) \
7988613b 939 bio_for_each_segment(bvl, _iter.bio, _iter.iter)
5705f702 940
4550dd6c 941#define rq_iter_last(bvec, _iter) \
7988613b 942 (_iter.bio->bi_next == NULL && \
4550dd6c 943 bio_iter_last(bvec, _iter.iter))
5705f702 944
2d4dc890
IL
945#ifndef ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE
946# error "You should define ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE for your platform"
947#endif
948#if ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE
949extern void rq_flush_dcache_pages(struct request *rq);
950#else
951static inline void rq_flush_dcache_pages(struct request *rq)
952{
953}
954#endif
955
1da177e4
LT
956extern int blk_register_queue(struct gendisk *disk);
957extern void blk_unregister_queue(struct gendisk *disk);
dece1635 958extern blk_qc_t generic_make_request(struct bio *bio);
f421e1d9 959extern blk_qc_t direct_make_request(struct bio *bio);
2a4aa30c 960extern void blk_rq_init(struct request_queue *q, struct request *rq);
da8d7f07 961extern void blk_init_request_from_bio(struct request *req, struct bio *bio);
1da177e4 962extern void blk_put_request(struct request *);
165125e1 963extern void __blk_put_request(struct request_queue *, struct request *);
6a15674d
BVA
964extern struct request *blk_get_request_flags(struct request_queue *,
965 unsigned int op,
9a95e4ef 966 blk_mq_req_flags_t flags);
cd6ce148
BVA
967extern struct request *blk_get_request(struct request_queue *, unsigned int op,
968 gfp_t gfp_mask);
165125e1 969extern void blk_requeue_request(struct request_queue *, struct request *);
ef9e3fac 970extern int blk_lld_busy(struct request_queue *q);
78d8e58a
MS
971extern int blk_rq_prep_clone(struct request *rq, struct request *rq_src,
972 struct bio_set *bs, gfp_t gfp_mask,
973 int (*bio_ctr)(struct bio *, struct bio *, void *),
974 void *data);
975extern void blk_rq_unprep_clone(struct request *rq);
2a842aca 976extern blk_status_t blk_insert_cloned_request(struct request_queue *q,
82124d60 977 struct request *rq);
0abc2a10 978extern int blk_rq_append_bio(struct request *rq, struct bio **bio);
3cca6dc1 979extern void blk_delay_queue(struct request_queue *, unsigned long);
af67c31f 980extern void blk_queue_split(struct request_queue *, struct bio **);
165125e1 981extern void blk_recount_segments(struct request_queue *, struct bio *);
0bfc96cb 982extern int scsi_verify_blk_ioctl(struct block_device *, unsigned int);
577ebb37
PB
983extern int scsi_cmd_blk_ioctl(struct block_device *, fmode_t,
984 unsigned int, void __user *);
74f3c8af
AV
985extern int scsi_cmd_ioctl(struct request_queue *, struct gendisk *, fmode_t,
986 unsigned int, void __user *);
e915e872
AV
987extern int sg_scsi_ioctl(struct request_queue *, struct gendisk *, fmode_t,
988 struct scsi_ioctl_command __user *);
3fcfab16 989
9a95e4ef 990extern int blk_queue_enter(struct request_queue *q, blk_mq_req_flags_t flags);
2e6edc95 991extern void blk_queue_exit(struct request_queue *q);
165125e1 992extern void blk_start_queue(struct request_queue *q);
21491412 993extern void blk_start_queue_async(struct request_queue *q);
165125e1 994extern void blk_stop_queue(struct request_queue *q);
1da177e4 995extern void blk_sync_queue(struct request_queue *q);
165125e1 996extern void __blk_stop_queue(struct request_queue *q);
24ecfbe2 997extern void __blk_run_queue(struct request_queue *q);
a7928c15 998extern void __blk_run_queue_uncond(struct request_queue *q);
165125e1 999extern void blk_run_queue(struct request_queue *);
c21e6beb 1000extern void blk_run_queue_async(struct request_queue *q);
a3bce90e 1001extern int blk_rq_map_user(struct request_queue *, struct request *,
152e283f
FT
1002 struct rq_map_data *, void __user *, unsigned long,
1003 gfp_t);
8e5cfc45 1004extern int blk_rq_unmap_user(struct bio *);
165125e1
JA
1005extern int blk_rq_map_kern(struct request_queue *, struct request *, void *, unsigned int, gfp_t);
1006extern int blk_rq_map_user_iov(struct request_queue *, struct request *,
26e49cfc
KO
1007 struct rq_map_data *, const struct iov_iter *,
1008 gfp_t);
b7819b92 1009extern void blk_execute_rq(struct request_queue *, struct gendisk *,
994ca9a1 1010 struct request *, int);
165125e1 1011extern void blk_execute_rq_nowait(struct request_queue *, struct gendisk *,
15fc858a 1012 struct request *, int, rq_end_io_fn *);
6e39b69e 1013
2a842aca
CH
1014int blk_status_to_errno(blk_status_t status);
1015blk_status_t errno_to_blk_status(int errno);
1016
ea435e1b 1017bool blk_poll(struct request_queue *q, blk_qc_t cookie);
05229bee 1018
165125e1 1019static inline struct request_queue *bdev_get_queue(struct block_device *bdev)
1da177e4 1020{
ff9ea323 1021 return bdev->bd_disk->queue; /* this is never NULL */
1da177e4
LT
1022}
1023
5efccd17 1024/*
80a761fd
TH
1025 * blk_rq_pos() : the current sector
1026 * blk_rq_bytes() : bytes left in the entire request
1027 * blk_rq_cur_bytes() : bytes left in the current segment
1028 * blk_rq_err_bytes() : bytes left till the next error boundary
1029 * blk_rq_sectors() : sectors left in the entire request
1030 * blk_rq_cur_sectors() : sectors left in the current segment
5efccd17 1031 */
5b93629b
TH
1032static inline sector_t blk_rq_pos(const struct request *rq)
1033{
a2dec7b3 1034 return rq->__sector;
2e46e8b2
TH
1035}
1036
1037static inline unsigned int blk_rq_bytes(const struct request *rq)
1038{
a2dec7b3 1039 return rq->__data_len;
5b93629b
TH
1040}
1041
2e46e8b2
TH
1042static inline int blk_rq_cur_bytes(const struct request *rq)
1043{
1044 return rq->bio ? bio_cur_bytes(rq->bio) : 0;
1045}
5efccd17 1046
80a761fd
TH
1047extern unsigned int blk_rq_err_bytes(const struct request *rq);
1048
5b93629b
TH
1049static inline unsigned int blk_rq_sectors(const struct request *rq)
1050{
2e46e8b2 1051 return blk_rq_bytes(rq) >> 9;
5b93629b
TH
1052}
1053
1054static inline unsigned int blk_rq_cur_sectors(const struct request *rq)
1055{
2e46e8b2 1056 return blk_rq_cur_bytes(rq) >> 9;
5b93629b
TH
1057}
1058
6cc77e9c
CH
1059static inline unsigned int blk_rq_zone_no(struct request *rq)
1060{
1061 return blk_queue_zone_no(rq->q, blk_rq_pos(rq));
1062}
1063
1064static inline unsigned int blk_rq_zone_is_seq(struct request *rq)
1065{
1066 return blk_queue_zone_is_seq(rq->q, blk_rq_pos(rq));
1067}
1068
2e3258ec
CH
1069/*
1070 * Some commands like WRITE SAME have a payload or data transfer size which
1071 * is different from the size of the request. Any driver that supports such
1072 * commands using the RQF_SPECIAL_PAYLOAD flag needs to use this helper to
1073 * calculate the data transfer size.
1074 */
1075static inline unsigned int blk_rq_payload_bytes(struct request *rq)
1076{
1077 if (rq->rq_flags & RQF_SPECIAL_PAYLOAD)
1078 return rq->special_vec.bv_len;
1079 return blk_rq_bytes(rq);
1080}
1081
f31dc1cd 1082static inline unsigned int blk_queue_get_max_sectors(struct request_queue *q,
8fe0d473 1083 int op)
f31dc1cd 1084{
7afafc8a 1085 if (unlikely(op == REQ_OP_DISCARD || op == REQ_OP_SECURE_ERASE))
871dd928 1086 return min(q->limits.max_discard_sectors, UINT_MAX >> 9);
f31dc1cd 1087
8fe0d473 1088 if (unlikely(op == REQ_OP_WRITE_SAME))
4363ac7c
MP
1089 return q->limits.max_write_same_sectors;
1090
a6f0788e
CK
1091 if (unlikely(op == REQ_OP_WRITE_ZEROES))
1092 return q->limits.max_write_zeroes_sectors;
1093
f31dc1cd
MP
1094 return q->limits.max_sectors;
1095}
1096
762380ad
JA
1097/*
1098 * Return maximum size of a request at given offset. Only valid for
1099 * file system requests.
1100 */
1101static inline unsigned int blk_max_size_offset(struct request_queue *q,
1102 sector_t offset)
1103{
1104 if (!q->limits.chunk_sectors)
736ed4de 1105 return q->limits.max_sectors;
762380ad
JA
1106
1107 return q->limits.chunk_sectors -
1108 (offset & (q->limits.chunk_sectors - 1));
1109}
1110
17007f39
DLM
1111static inline unsigned int blk_rq_get_max_sectors(struct request *rq,
1112 sector_t offset)
f31dc1cd
MP
1113{
1114 struct request_queue *q = rq->q;
1115
57292b58 1116 if (blk_rq_is_passthrough(rq))
f31dc1cd
MP
1117 return q->limits.max_hw_sectors;
1118
7afafc8a
AH
1119 if (!q->limits.chunk_sectors ||
1120 req_op(rq) == REQ_OP_DISCARD ||
1121 req_op(rq) == REQ_OP_SECURE_ERASE)
8fe0d473 1122 return blk_queue_get_max_sectors(q, req_op(rq));
762380ad 1123
17007f39 1124 return min(blk_max_size_offset(q, offset),
8fe0d473 1125 blk_queue_get_max_sectors(q, req_op(rq)));
f31dc1cd
MP
1126}
1127
75afb352
JN
1128static inline unsigned int blk_rq_count_bios(struct request *rq)
1129{
1130 unsigned int nr_bios = 0;
1131 struct bio *bio;
1132
1133 __rq_for_each_bio(bio, rq)
1134 nr_bios++;
1135
1136 return nr_bios;
1137}
1138
9934c8c0
TH
1139/*
1140 * Request issue related functions.
1141 */
1142extern struct request *blk_peek_request(struct request_queue *q);
1143extern void blk_start_request(struct request *rq);
1144extern struct request *blk_fetch_request(struct request_queue *q);
1145
ef71de8b
CH
1146void blk_steal_bios(struct bio_list *list, struct request *rq);
1147
1da177e4 1148/*
2e60e022
TH
1149 * Request completion related functions.
1150 *
1151 * blk_update_request() completes given number of bytes and updates
1152 * the request without completing it.
1153 *
f06d9a2b
TH
1154 * blk_end_request() and friends. __blk_end_request() must be called
1155 * with the request queue spinlock acquired.
1da177e4
LT
1156 *
1157 * Several drivers define their own end_request and call
3bcddeac
KU
1158 * blk_end_request() for parts of the original function.
1159 * This prevents code duplication in drivers.
1da177e4 1160 */
2a842aca 1161extern bool blk_update_request(struct request *rq, blk_status_t error,
2e60e022 1162 unsigned int nr_bytes);
2a842aca
CH
1163extern void blk_finish_request(struct request *rq, blk_status_t error);
1164extern bool blk_end_request(struct request *rq, blk_status_t error,
b1f74493 1165 unsigned int nr_bytes);
2a842aca
CH
1166extern void blk_end_request_all(struct request *rq, blk_status_t error);
1167extern bool __blk_end_request(struct request *rq, blk_status_t error,
b1f74493 1168 unsigned int nr_bytes);
2a842aca
CH
1169extern void __blk_end_request_all(struct request *rq, blk_status_t error);
1170extern bool __blk_end_request_cur(struct request *rq, blk_status_t error);
2e60e022 1171
ff856bad 1172extern void blk_complete_request(struct request *);
242f9dcb
JA
1173extern void __blk_complete_request(struct request *);
1174extern void blk_abort_request(struct request *);
28018c24 1175extern void blk_unprep_request(struct request *);
ff856bad 1176
1da177e4
LT
1177/*
1178 * Access functions for manipulating queue properties
1179 */
165125e1 1180extern struct request_queue *blk_init_queue_node(request_fn_proc *rfn,
1946089a 1181 spinlock_t *lock, int node_id);
165125e1 1182extern struct request_queue *blk_init_queue(request_fn_proc *, spinlock_t *);
5ea708d1 1183extern int blk_init_allocated_queue(struct request_queue *);
165125e1
JA
1184extern void blk_cleanup_queue(struct request_queue *);
1185extern void blk_queue_make_request(struct request_queue *, make_request_fn *);
1186extern void blk_queue_bounce_limit(struct request_queue *, u64);
086fa5ff 1187extern void blk_queue_max_hw_sectors(struct request_queue *, unsigned int);
762380ad 1188extern void blk_queue_chunk_sectors(struct request_queue *, unsigned int);
8a78362c 1189extern void blk_queue_max_segments(struct request_queue *, unsigned short);
1e739730
CH
1190extern void blk_queue_max_discard_segments(struct request_queue *,
1191 unsigned short);
165125e1 1192extern void blk_queue_max_segment_size(struct request_queue *, unsigned int);
67efc925
CH
1193extern void blk_queue_max_discard_sectors(struct request_queue *q,
1194 unsigned int max_discard_sectors);
4363ac7c
MP
1195extern void blk_queue_max_write_same_sectors(struct request_queue *q,
1196 unsigned int max_write_same_sectors);
a6f0788e
CK
1197extern void blk_queue_max_write_zeroes_sectors(struct request_queue *q,
1198 unsigned int max_write_same_sectors);
e1defc4f 1199extern void blk_queue_logical_block_size(struct request_queue *, unsigned short);
892b6f90 1200extern void blk_queue_physical_block_size(struct request_queue *, unsigned int);
c72758f3
MP
1201extern void blk_queue_alignment_offset(struct request_queue *q,
1202 unsigned int alignment);
7c958e32 1203extern void blk_limits_io_min(struct queue_limits *limits, unsigned int min);
c72758f3 1204extern void blk_queue_io_min(struct request_queue *q, unsigned int min);
3c5820c7 1205extern void blk_limits_io_opt(struct queue_limits *limits, unsigned int opt);
c72758f3 1206extern void blk_queue_io_opt(struct request_queue *q, unsigned int opt);
d278d4a8 1207extern void blk_set_queue_depth(struct request_queue *q, unsigned int depth);
e475bba2 1208extern void blk_set_default_limits(struct queue_limits *lim);
b1bd055d 1209extern void blk_set_stacking_limits(struct queue_limits *lim);
c72758f3
MP
1210extern int blk_stack_limits(struct queue_limits *t, struct queue_limits *b,
1211 sector_t offset);
17be8c24
MP
1212extern int bdev_stack_limits(struct queue_limits *t, struct block_device *bdev,
1213 sector_t offset);
c72758f3
MP
1214extern void disk_stack_limits(struct gendisk *disk, struct block_device *bdev,
1215 sector_t offset);
165125e1 1216extern void blk_queue_stack_limits(struct request_queue *t, struct request_queue *b);
e3790c7d 1217extern void blk_queue_dma_pad(struct request_queue *, unsigned int);
27f8221a 1218extern void blk_queue_update_dma_pad(struct request_queue *, unsigned int);
2fb98e84
TH
1219extern int blk_queue_dma_drain(struct request_queue *q,
1220 dma_drain_needed_fn *dma_drain_needed,
1221 void *buf, unsigned int size);
ef9e3fac 1222extern void blk_queue_lld_busy(struct request_queue *q, lld_busy_fn *fn);
165125e1 1223extern void blk_queue_segment_boundary(struct request_queue *, unsigned long);
03100aad 1224extern void blk_queue_virt_boundary(struct request_queue *, unsigned long);
165125e1 1225extern void blk_queue_prep_rq(struct request_queue *, prep_rq_fn *pfn);
28018c24 1226extern void blk_queue_unprep_rq(struct request_queue *, unprep_rq_fn *ufn);
165125e1 1227extern void blk_queue_dma_alignment(struct request_queue *, int);
11c3e689 1228extern void blk_queue_update_dma_alignment(struct request_queue *, int);
165125e1 1229extern void blk_queue_softirq_done(struct request_queue *, softirq_done_fn *);
242f9dcb
JA
1230extern void blk_queue_rq_timed_out(struct request_queue *, rq_timed_out_fn *);
1231extern void blk_queue_rq_timeout(struct request_queue *, unsigned int);
f3876930 1232extern void blk_queue_flush_queueable(struct request_queue *q, bool queueable);
93e9d8e8 1233extern void blk_queue_write_cache(struct request_queue *q, bool enabled, bool fua);
1da177e4 1234
1e739730
CH
1235/*
1236 * Number of physical segments as sent to the device.
1237 *
1238 * Normally this is the number of discontiguous data segments sent by the
1239 * submitter. But for data-less command like discard we might have no
1240 * actual data segments submitted, but the driver might have to add it's
1241 * own special payload. In that case we still return 1 here so that this
1242 * special payload will be mapped.
1243 */
f9d03f96
CH
1244static inline unsigned short blk_rq_nr_phys_segments(struct request *rq)
1245{
1246 if (rq->rq_flags & RQF_SPECIAL_PAYLOAD)
1247 return 1;
1248 return rq->nr_phys_segments;
1249}
1250
1e739730
CH
1251/*
1252 * Number of discard segments (or ranges) the driver needs to fill in.
1253 * Each discard bio merged into a request is counted as one segment.
1254 */
1255static inline unsigned short blk_rq_nr_discard_segments(struct request *rq)
1256{
1257 return max_t(unsigned short, rq->nr_phys_segments, 1);
1258}
1259
165125e1 1260extern int blk_rq_map_sg(struct request_queue *, struct request *, struct scatterlist *);
1da177e4 1261extern void blk_dump_rq_flags(struct request *, char *);
1da177e4 1262extern long nr_blockdev_pages(void);
1da177e4 1263
09ac46c4 1264bool __must_check blk_get_queue(struct request_queue *);
165125e1 1265struct request_queue *blk_alloc_queue(gfp_t);
5ee0524b
BVA
1266struct request_queue *blk_alloc_queue_node(gfp_t gfp_mask, int node_id,
1267 spinlock_t *lock);
165125e1 1268extern void blk_put_queue(struct request_queue *);
3f21c265 1269extern void blk_set_queue_dying(struct request_queue *);
1da177e4 1270
6c954667
LM
1271/*
1272 * block layer runtime pm functions
1273 */
47fafbc7 1274#ifdef CONFIG_PM
6c954667
LM
1275extern void blk_pm_runtime_init(struct request_queue *q, struct device *dev);
1276extern int blk_pre_runtime_suspend(struct request_queue *q);
1277extern void blk_post_runtime_suspend(struct request_queue *q, int err);
1278extern void blk_pre_runtime_resume(struct request_queue *q);
1279extern void blk_post_runtime_resume(struct request_queue *q, int err);
d07ab6d1 1280extern void blk_set_runtime_active(struct request_queue *q);
6c954667
LM
1281#else
1282static inline void blk_pm_runtime_init(struct request_queue *q,
1283 struct device *dev) {}
1284static inline int blk_pre_runtime_suspend(struct request_queue *q)
1285{
1286 return -ENOSYS;
1287}
1288static inline void blk_post_runtime_suspend(struct request_queue *q, int err) {}
1289static inline void blk_pre_runtime_resume(struct request_queue *q) {}
1290static inline void blk_post_runtime_resume(struct request_queue *q, int err) {}
9a05e754 1291static inline void blk_set_runtime_active(struct request_queue *q) {}
6c954667
LM
1292#endif
1293
316cc67d 1294/*
75df7136
SJ
1295 * blk_plug permits building a queue of related requests by holding the I/O
1296 * fragments for a short period. This allows merging of sequential requests
1297 * into single larger request. As the requests are moved from a per-task list to
1298 * the device's request_queue in a batch, this results in improved scalability
1299 * as the lock contention for request_queue lock is reduced.
1300 *
1301 * It is ok not to disable preemption when adding the request to the plug list
1302 * or when attempting a merge, because blk_schedule_flush_list() will only flush
1303 * the plug list when the task sleeps by itself. For details, please see
1304 * schedule() where blk_schedule_flush_plug() is called.
316cc67d 1305 */
73c10101 1306struct blk_plug {
75df7136 1307 struct list_head list; /* requests */
320ae51f 1308 struct list_head mq_list; /* blk-mq requests */
75df7136 1309 struct list_head cb_list; /* md requires an unplug callback */
73c10101 1310};
55c022bb 1311#define BLK_MAX_REQUEST_COUNT 16
50d24c34 1312#define BLK_PLUG_FLUSH_SIZE (128 * 1024)
55c022bb 1313
9cbb1750 1314struct blk_plug_cb;
74018dc3 1315typedef void (*blk_plug_cb_fn)(struct blk_plug_cb *, bool);
048c9374
N
1316struct blk_plug_cb {
1317 struct list_head list;
9cbb1750
N
1318 blk_plug_cb_fn callback;
1319 void *data;
048c9374 1320};
9cbb1750
N
1321extern struct blk_plug_cb *blk_check_plugged(blk_plug_cb_fn unplug,
1322 void *data, int size);
73c10101
JA
1323extern void blk_start_plug(struct blk_plug *);
1324extern void blk_finish_plug(struct blk_plug *);
f6603783 1325extern void blk_flush_plug_list(struct blk_plug *, bool);
73c10101
JA
1326
1327static inline void blk_flush_plug(struct task_struct *tsk)
1328{
1329 struct blk_plug *plug = tsk->plug;
1330
a237c1c5
JA
1331 if (plug)
1332 blk_flush_plug_list(plug, false);
1333}
1334
1335static inline void blk_schedule_flush_plug(struct task_struct *tsk)
1336{
1337 struct blk_plug *plug = tsk->plug;
1338
88b996cd 1339 if (plug)
f6603783 1340 blk_flush_plug_list(plug, true);
73c10101
JA
1341}
1342
1343static inline bool blk_needs_flush_plug(struct task_struct *tsk)
1344{
1345 struct blk_plug *plug = tsk->plug;
1346
320ae51f
JA
1347 return plug &&
1348 (!list_empty(&plug->list) ||
1349 !list_empty(&plug->mq_list) ||
1350 !list_empty(&plug->cb_list));
73c10101
JA
1351}
1352
1da177e4
LT
1353/*
1354 * tag stuff
1355 */
165125e1
JA
1356extern int blk_queue_start_tag(struct request_queue *, struct request *);
1357extern struct request *blk_queue_find_tag(struct request_queue *, int);
1358extern void blk_queue_end_tag(struct request_queue *, struct request *);
ee1b6f7a 1359extern int blk_queue_init_tags(struct request_queue *, int, struct blk_queue_tag *, int);
165125e1
JA
1360extern void blk_queue_free_tags(struct request_queue *);
1361extern int blk_queue_resize_tags(struct request_queue *, int);
1362extern void blk_queue_invalidate_tags(struct request_queue *);
ee1b6f7a 1363extern struct blk_queue_tag *blk_init_tags(int, int);
492dfb48 1364extern void blk_free_tags(struct blk_queue_tag *);
1da177e4 1365
f583f492
DS
1366static inline struct request *blk_map_queue_find_tag(struct blk_queue_tag *bqt,
1367 int tag)
1368{
1369 if (unlikely(bqt == NULL || tag >= bqt->real_max_depth))
1370 return NULL;
1371 return bqt->tag_index[tag];
1372}
dd3932ed 1373
ee472d83
CH
1374extern int blkdev_issue_flush(struct block_device *, gfp_t, sector_t *);
1375extern int blkdev_issue_write_same(struct block_device *bdev, sector_t sector,
1376 sector_t nr_sects, gfp_t gfp_mask, struct page *page);
e950fdf7
CH
1377
1378#define BLKDEV_DISCARD_SECURE (1 << 0) /* issue a secure erase */
dd3932ed 1379
fbd9b09a
DM
1380extern int blkdev_issue_discard(struct block_device *bdev, sector_t sector,
1381 sector_t nr_sects, gfp_t gfp_mask, unsigned long flags);
38f25255 1382extern int __blkdev_issue_discard(struct block_device *bdev, sector_t sector,
288dab8a 1383 sector_t nr_sects, gfp_t gfp_mask, int flags,
469e3216 1384 struct bio **biop);
ee472d83
CH
1385
1386#define BLKDEV_ZERO_NOUNMAP (1 << 0) /* do not free blocks */
cb365b96 1387#define BLKDEV_ZERO_NOFALLBACK (1 << 1) /* don't write explicit zeroes */
ee472d83 1388
e73c23ff
CK
1389extern int __blkdev_issue_zeroout(struct block_device *bdev, sector_t sector,
1390 sector_t nr_sects, gfp_t gfp_mask, struct bio **biop,
ee472d83 1391 unsigned flags);
3f14d792 1392extern int blkdev_issue_zeroout(struct block_device *bdev, sector_t sector,
ee472d83
CH
1393 sector_t nr_sects, gfp_t gfp_mask, unsigned flags);
1394
2cf6d26a
CH
1395static inline int sb_issue_discard(struct super_block *sb, sector_t block,
1396 sector_t nr_blocks, gfp_t gfp_mask, unsigned long flags)
fb2dce86 1397{
2cf6d26a
CH
1398 return blkdev_issue_discard(sb->s_bdev, block << (sb->s_blocksize_bits - 9),
1399 nr_blocks << (sb->s_blocksize_bits - 9),
1400 gfp_mask, flags);
fb2dce86 1401}
e6fa0be6 1402static inline int sb_issue_zeroout(struct super_block *sb, sector_t block,
a107e5a3 1403 sector_t nr_blocks, gfp_t gfp_mask)
e6fa0be6
LC
1404{
1405 return blkdev_issue_zeroout(sb->s_bdev,
1406 block << (sb->s_blocksize_bits - 9),
1407 nr_blocks << (sb->s_blocksize_bits - 9),
ee472d83 1408 gfp_mask, 0);
e6fa0be6 1409}
1da177e4 1410
f00c4d80 1411extern int blk_verify_command(unsigned char *cmd, fmode_t mode);
0b07de85 1412
eb28d31b
MP
1413enum blk_default_limits {
1414 BLK_MAX_SEGMENTS = 128,
1415 BLK_SAFE_MAX_SECTORS = 255,
d2be537c 1416 BLK_DEF_MAX_SECTORS = 2560,
eb28d31b
MP
1417 BLK_MAX_SEGMENT_SIZE = 65536,
1418 BLK_SEG_BOUNDARY_MASK = 0xFFFFFFFFUL,
1419};
0e435ac2 1420
1da177e4
LT
1421#define blkdev_entry_to_request(entry) list_entry((entry), struct request, queuelist)
1422
ae03bf63
MP
1423static inline unsigned long queue_segment_boundary(struct request_queue *q)
1424{
025146e1 1425 return q->limits.seg_boundary_mask;
ae03bf63
MP
1426}
1427
03100aad
KB
1428static inline unsigned long queue_virt_boundary(struct request_queue *q)
1429{
1430 return q->limits.virt_boundary_mask;
1431}
1432
ae03bf63
MP
1433static inline unsigned int queue_max_sectors(struct request_queue *q)
1434{
025146e1 1435 return q->limits.max_sectors;
ae03bf63
MP
1436}
1437
1438static inline unsigned int queue_max_hw_sectors(struct request_queue *q)
1439{
025146e1 1440 return q->limits.max_hw_sectors;
ae03bf63
MP
1441}
1442
8a78362c 1443static inline unsigned short queue_max_segments(struct request_queue *q)
ae03bf63 1444{
8a78362c 1445 return q->limits.max_segments;
ae03bf63
MP
1446}
1447
1e739730
CH
1448static inline unsigned short queue_max_discard_segments(struct request_queue *q)
1449{
1450 return q->limits.max_discard_segments;
1451}
1452
ae03bf63
MP
1453static inline unsigned int queue_max_segment_size(struct request_queue *q)
1454{
025146e1 1455 return q->limits.max_segment_size;
ae03bf63
MP
1456}
1457
e1defc4f 1458static inline unsigned short queue_logical_block_size(struct request_queue *q)
1da177e4
LT
1459{
1460 int retval = 512;
1461
025146e1
MP
1462 if (q && q->limits.logical_block_size)
1463 retval = q->limits.logical_block_size;
1da177e4
LT
1464
1465 return retval;
1466}
1467
e1defc4f 1468static inline unsigned short bdev_logical_block_size(struct block_device *bdev)
1da177e4 1469{
e1defc4f 1470 return queue_logical_block_size(bdev_get_queue(bdev));
1da177e4
LT
1471}
1472
c72758f3
MP
1473static inline unsigned int queue_physical_block_size(struct request_queue *q)
1474{
1475 return q->limits.physical_block_size;
1476}
1477
892b6f90 1478static inline unsigned int bdev_physical_block_size(struct block_device *bdev)
ac481c20
MP
1479{
1480 return queue_physical_block_size(bdev_get_queue(bdev));
1481}
1482
c72758f3
MP
1483static inline unsigned int queue_io_min(struct request_queue *q)
1484{
1485 return q->limits.io_min;
1486}
1487
ac481c20
MP
1488static inline int bdev_io_min(struct block_device *bdev)
1489{
1490 return queue_io_min(bdev_get_queue(bdev));
1491}
1492
c72758f3
MP
1493static inline unsigned int queue_io_opt(struct request_queue *q)
1494{
1495 return q->limits.io_opt;
1496}
1497
ac481c20
MP
1498static inline int bdev_io_opt(struct block_device *bdev)
1499{
1500 return queue_io_opt(bdev_get_queue(bdev));
1501}
1502
c72758f3
MP
1503static inline int queue_alignment_offset(struct request_queue *q)
1504{
ac481c20 1505 if (q->limits.misaligned)
c72758f3
MP
1506 return -1;
1507
ac481c20 1508 return q->limits.alignment_offset;
c72758f3
MP
1509}
1510
e03a72e1 1511static inline int queue_limit_alignment_offset(struct queue_limits *lim, sector_t sector)
81744ee4
MP
1512{
1513 unsigned int granularity = max(lim->physical_block_size, lim->io_min);
b8839b8c 1514 unsigned int alignment = sector_div(sector, granularity >> 9) << 9;
81744ee4 1515
b8839b8c 1516 return (granularity + lim->alignment_offset - alignment) % granularity;
c72758f3
MP
1517}
1518
ac481c20
MP
1519static inline int bdev_alignment_offset(struct block_device *bdev)
1520{
1521 struct request_queue *q = bdev_get_queue(bdev);
1522
1523 if (q->limits.misaligned)
1524 return -1;
1525
1526 if (bdev != bdev->bd_contains)
1527 return bdev->bd_part->alignment_offset;
1528
1529 return q->limits.alignment_offset;
1530}
1531
86b37281
MP
1532static inline int queue_discard_alignment(struct request_queue *q)
1533{
1534 if (q->limits.discard_misaligned)
1535 return -1;
1536
1537 return q->limits.discard_alignment;
1538}
1539
e03a72e1 1540static inline int queue_limit_discard_alignment(struct queue_limits *lim, sector_t sector)
86b37281 1541{
59771079 1542 unsigned int alignment, granularity, offset;
dd3d145d 1543
a934a00a
MP
1544 if (!lim->max_discard_sectors)
1545 return 0;
1546
59771079
LT
1547 /* Why are these in bytes, not sectors? */
1548 alignment = lim->discard_alignment >> 9;
1549 granularity = lim->discard_granularity >> 9;
1550 if (!granularity)
1551 return 0;
1552
1553 /* Offset of the partition start in 'granularity' sectors */
1554 offset = sector_div(sector, granularity);
1555
1556 /* And why do we do this modulus *again* in blkdev_issue_discard()? */
1557 offset = (granularity + alignment - offset) % granularity;
1558
1559 /* Turn it back into bytes, gaah */
1560 return offset << 9;
86b37281
MP
1561}
1562
c6e66634
PB
1563static inline int bdev_discard_alignment(struct block_device *bdev)
1564{
1565 struct request_queue *q = bdev_get_queue(bdev);
1566
1567 if (bdev != bdev->bd_contains)
1568 return bdev->bd_part->discard_alignment;
1569
1570 return q->limits.discard_alignment;
1571}
1572
4363ac7c
MP
1573static inline unsigned int bdev_write_same(struct block_device *bdev)
1574{
1575 struct request_queue *q = bdev_get_queue(bdev);
1576
1577 if (q)
1578 return q->limits.max_write_same_sectors;
1579
1580 return 0;
1581}
1582
a6f0788e
CK
1583static inline unsigned int bdev_write_zeroes_sectors(struct block_device *bdev)
1584{
1585 struct request_queue *q = bdev_get_queue(bdev);
1586
1587 if (q)
1588 return q->limits.max_write_zeroes_sectors;
1589
1590 return 0;
1591}
1592
797476b8
DLM
1593static inline enum blk_zoned_model bdev_zoned_model(struct block_device *bdev)
1594{
1595 struct request_queue *q = bdev_get_queue(bdev);
1596
1597 if (q)
1598 return blk_queue_zoned_model(q);
1599
1600 return BLK_ZONED_NONE;
1601}
1602
1603static inline bool bdev_is_zoned(struct block_device *bdev)
1604{
1605 struct request_queue *q = bdev_get_queue(bdev);
1606
1607 if (q)
1608 return blk_queue_is_zoned(q);
1609
1610 return false;
1611}
1612
f99e8648 1613static inline unsigned int bdev_zone_sectors(struct block_device *bdev)
6a0cb1bc
HR
1614{
1615 struct request_queue *q = bdev_get_queue(bdev);
1616
1617 if (q)
f99e8648 1618 return blk_queue_zone_sectors(q);
6cc77e9c
CH
1619 return 0;
1620}
6a0cb1bc 1621
6cc77e9c
CH
1622static inline unsigned int bdev_nr_zones(struct block_device *bdev)
1623{
1624 struct request_queue *q = bdev_get_queue(bdev);
6a0cb1bc 1625
6cc77e9c
CH
1626 if (q)
1627 return blk_queue_nr_zones(q);
6a0cb1bc
HR
1628 return 0;
1629}
1630
165125e1 1631static inline int queue_dma_alignment(struct request_queue *q)
1da177e4 1632{
482eb689 1633 return q ? q->dma_alignment : 511;
1da177e4
LT
1634}
1635
14417799 1636static inline int blk_rq_aligned(struct request_queue *q, unsigned long addr,
87904074
FT
1637 unsigned int len)
1638{
1639 unsigned int alignment = queue_dma_alignment(q) | q->dma_pad_mask;
14417799 1640 return !(addr & alignment) && !(len & alignment);
87904074
FT
1641}
1642
1da177e4
LT
1643/* assumes size > 256 */
1644static inline unsigned int blksize_bits(unsigned int size)
1645{
1646 unsigned int bits = 8;
1647 do {
1648 bits++;
1649 size >>= 1;
1650 } while (size > 256);
1651 return bits;
1652}
1653
2befb9e3 1654static inline unsigned int block_size(struct block_device *bdev)
1da177e4
LT
1655{
1656 return bdev->bd_block_size;
1657}
1658
f3876930 1659static inline bool queue_flush_queueable(struct request_queue *q)
1660{
c888a8f9 1661 return !test_bit(QUEUE_FLAG_FLUSH_NQ, &q->queue_flags);
f3876930 1662}
1663
1da177e4
LT
1664typedef struct {struct page *v;} Sector;
1665
1666unsigned char *read_dev_sector(struct block_device *, sector_t, Sector *);
1667
1668static inline void put_dev_sector(Sector p)
1669{
09cbfeaf 1670 put_page(p.v);
1da177e4
LT
1671}
1672
e0af2917
ML
1673static inline bool __bvec_gap_to_prev(struct request_queue *q,
1674 struct bio_vec *bprv, unsigned int offset)
1675{
1676 return offset ||
1677 ((bprv->bv_offset + bprv->bv_len) & queue_virt_boundary(q));
1678}
1679
03100aad
KB
1680/*
1681 * Check if adding a bio_vec after bprv with offset would create a gap in
1682 * the SG list. Most drivers don't care about this, but some do.
1683 */
1684static inline bool bvec_gap_to_prev(struct request_queue *q,
1685 struct bio_vec *bprv, unsigned int offset)
1686{
1687 if (!queue_virt_boundary(q))
1688 return false;
e0af2917 1689 return __bvec_gap_to_prev(q, bprv, offset);
03100aad
KB
1690}
1691
729204ef
ML
1692/*
1693 * Check if the two bvecs from two bios can be merged to one segment.
1694 * If yes, no need to check gap between the two bios since the 1st bio
1695 * and the 1st bvec in the 2nd bio can be handled in one segment.
1696 */
1697static inline bool bios_segs_mergeable(struct request_queue *q,
1698 struct bio *prev, struct bio_vec *prev_last_bv,
1699 struct bio_vec *next_first_bv)
1700{
1701 if (!BIOVEC_PHYS_MERGEABLE(prev_last_bv, next_first_bv))
1702 return false;
1703 if (!BIOVEC_SEG_BOUNDARY(q, prev_last_bv, next_first_bv))
1704 return false;
1705 if (prev->bi_seg_back_size + next_first_bv->bv_len >
1706 queue_max_segment_size(q))
1707 return false;
1708 return true;
1709}
1710
5a8d75a1
ML
1711static inline bool bio_will_gap(struct request_queue *q,
1712 struct request *prev_rq,
1713 struct bio *prev,
1714 struct bio *next)
5e7c4274 1715{
25e71a99
ML
1716 if (bio_has_data(prev) && queue_virt_boundary(q)) {
1717 struct bio_vec pb, nb;
1718
5a8d75a1
ML
1719 /*
1720 * don't merge if the 1st bio starts with non-zero
1721 * offset, otherwise it is quite difficult to respect
1722 * sg gap limit. We work hard to merge a huge number of small
1723 * single bios in case of mkfs.
1724 */
1725 if (prev_rq)
1726 bio_get_first_bvec(prev_rq->bio, &pb);
1727 else
1728 bio_get_first_bvec(prev, &pb);
1729 if (pb.bv_offset)
1730 return true;
1731
1732 /*
1733 * We don't need to worry about the situation that the
1734 * merged segment ends in unaligned virt boundary:
1735 *
1736 * - if 'pb' ends aligned, the merged segment ends aligned
1737 * - if 'pb' ends unaligned, the next bio must include
1738 * one single bvec of 'nb', otherwise the 'nb' can't
1739 * merge with 'pb'
1740 */
25e71a99
ML
1741 bio_get_last_bvec(prev, &pb);
1742 bio_get_first_bvec(next, &nb);
5e7c4274 1743
729204ef
ML
1744 if (!bios_segs_mergeable(q, prev, &pb, &nb))
1745 return __bvec_gap_to_prev(q, &pb, nb.bv_offset);
25e71a99
ML
1746 }
1747
1748 return false;
5e7c4274
JA
1749}
1750
1751static inline bool req_gap_back_merge(struct request *req, struct bio *bio)
1752{
5a8d75a1 1753 return bio_will_gap(req->q, req, req->biotail, bio);
5e7c4274
JA
1754}
1755
1756static inline bool req_gap_front_merge(struct request *req, struct bio *bio)
1757{
5a8d75a1 1758 return bio_will_gap(req->q, NULL, bio, req->bio);
5e7c4274
JA
1759}
1760
59c3d45e 1761int kblockd_schedule_work(struct work_struct *work);
ee63cfa7 1762int kblockd_schedule_work_on(int cpu, struct work_struct *work);
818cd1cb 1763int kblockd_mod_delayed_work_on(int cpu, struct delayed_work *dwork, unsigned long delay);
1da177e4 1764
9195291e 1765#ifdef CONFIG_BLK_CGROUP
28f4197e
JA
1766/*
1767 * This should not be using sched_clock(). A real patch is in progress
1768 * to fix this up, until that is in place we need to disable preemption
1769 * around sched_clock() in this function and set_io_start_time_ns().
1770 */
9195291e
DS
1771static inline void set_start_time_ns(struct request *req)
1772{
28f4197e 1773 preempt_disable();
9195291e 1774 req->start_time_ns = sched_clock();
28f4197e 1775 preempt_enable();
9195291e
DS
1776}
1777
1778static inline void set_io_start_time_ns(struct request *req)
1779{
28f4197e 1780 preempt_disable();
9195291e 1781 req->io_start_time_ns = sched_clock();
28f4197e 1782 preempt_enable();
9195291e 1783}
84c124da
DS
1784
1785static inline uint64_t rq_start_time_ns(struct request *req)
1786{
1787 return req->start_time_ns;
1788}
1789
1790static inline uint64_t rq_io_start_time_ns(struct request *req)
1791{
1792 return req->io_start_time_ns;
1793}
9195291e
DS
1794#else
1795static inline void set_start_time_ns(struct request *req) {}
1796static inline void set_io_start_time_ns(struct request *req) {}
84c124da
DS
1797static inline uint64_t rq_start_time_ns(struct request *req)
1798{
1799 return 0;
1800}
1801static inline uint64_t rq_io_start_time_ns(struct request *req)
1802{
1803 return 0;
1804}
9195291e
DS
1805#endif
1806
1da177e4
LT
1807#define MODULE_ALIAS_BLOCKDEV(major,minor) \
1808 MODULE_ALIAS("block-major-" __stringify(major) "-" __stringify(minor))
1809#define MODULE_ALIAS_BLOCKDEV_MAJOR(major) \
1810 MODULE_ALIAS("block-major-" __stringify(major) "-*")
1811
7ba1ba12
MP
1812#if defined(CONFIG_BLK_DEV_INTEGRITY)
1813
8288f496
MP
1814enum blk_integrity_flags {
1815 BLK_INTEGRITY_VERIFY = 1 << 0,
1816 BLK_INTEGRITY_GENERATE = 1 << 1,
3aec2f41 1817 BLK_INTEGRITY_DEVICE_CAPABLE = 1 << 2,
aae7df50 1818 BLK_INTEGRITY_IP_CHECKSUM = 1 << 3,
8288f496 1819};
7ba1ba12 1820
18593088 1821struct blk_integrity_iter {
7ba1ba12
MP
1822 void *prot_buf;
1823 void *data_buf;
3be91c4a 1824 sector_t seed;
7ba1ba12 1825 unsigned int data_size;
3be91c4a 1826 unsigned short interval;
7ba1ba12
MP
1827 const char *disk_name;
1828};
1829
4e4cbee9 1830typedef blk_status_t (integrity_processing_fn) (struct blk_integrity_iter *);
7ba1ba12 1831
0f8087ec
MP
1832struct blk_integrity_profile {
1833 integrity_processing_fn *generate_fn;
1834 integrity_processing_fn *verify_fn;
1835 const char *name;
1836};
7ba1ba12 1837
25520d55 1838extern void blk_integrity_register(struct gendisk *, struct blk_integrity *);
7ba1ba12 1839extern void blk_integrity_unregister(struct gendisk *);
ad7fce93 1840extern int blk_integrity_compare(struct gendisk *, struct gendisk *);
13f05c8d
MP
1841extern int blk_rq_map_integrity_sg(struct request_queue *, struct bio *,
1842 struct scatterlist *);
1843extern int blk_rq_count_integrity_sg(struct request_queue *, struct bio *);
4eaf99be
MP
1844extern bool blk_integrity_merge_rq(struct request_queue *, struct request *,
1845 struct request *);
1846extern bool blk_integrity_merge_bio(struct request_queue *, struct request *,
1847 struct bio *);
7ba1ba12 1848
25520d55 1849static inline struct blk_integrity *blk_get_integrity(struct gendisk *disk)
b04accc4 1850{
ac6fc48c 1851 struct blk_integrity *bi = &disk->queue->integrity;
25520d55
MP
1852
1853 if (!bi->profile)
1854 return NULL;
1855
1856 return bi;
b04accc4
JA
1857}
1858
25520d55
MP
1859static inline
1860struct blk_integrity *bdev_get_integrity(struct block_device *bdev)
b02739b0 1861{
25520d55 1862 return blk_get_integrity(bdev->bd_disk);
b02739b0
MP
1863}
1864
180b2f95 1865static inline bool blk_integrity_rq(struct request *rq)
7ba1ba12 1866{
180b2f95 1867 return rq->cmd_flags & REQ_INTEGRITY;
7ba1ba12
MP
1868}
1869
13f05c8d
MP
1870static inline void blk_queue_max_integrity_segments(struct request_queue *q,
1871 unsigned int segs)
1872{
1873 q->limits.max_integrity_segments = segs;
1874}
1875
1876static inline unsigned short
1877queue_max_integrity_segments(struct request_queue *q)
1878{
1879 return q->limits.max_integrity_segments;
1880}
1881
7f39add3
SG
1882static inline bool integrity_req_gap_back_merge(struct request *req,
1883 struct bio *next)
1884{
1885 struct bio_integrity_payload *bip = bio_integrity(req->bio);
1886 struct bio_integrity_payload *bip_next = bio_integrity(next);
1887
1888 return bvec_gap_to_prev(req->q, &bip->bip_vec[bip->bip_vcnt - 1],
1889 bip_next->bip_vec[0].bv_offset);
1890}
1891
1892static inline bool integrity_req_gap_front_merge(struct request *req,
1893 struct bio *bio)
1894{
1895 struct bio_integrity_payload *bip = bio_integrity(bio);
1896 struct bio_integrity_payload *bip_next = bio_integrity(req->bio);
1897
1898 return bvec_gap_to_prev(req->q, &bip->bip_vec[bip->bip_vcnt - 1],
1899 bip_next->bip_vec[0].bv_offset);
1900}
1901
7ba1ba12
MP
1902#else /* CONFIG_BLK_DEV_INTEGRITY */
1903
fd83240a
SR
1904struct bio;
1905struct block_device;
1906struct gendisk;
1907struct blk_integrity;
1908
1909static inline int blk_integrity_rq(struct request *rq)
1910{
1911 return 0;
1912}
1913static inline int blk_rq_count_integrity_sg(struct request_queue *q,
1914 struct bio *b)
1915{
1916 return 0;
1917}
1918static inline int blk_rq_map_integrity_sg(struct request_queue *q,
1919 struct bio *b,
1920 struct scatterlist *s)
1921{
1922 return 0;
1923}
1924static inline struct blk_integrity *bdev_get_integrity(struct block_device *b)
1925{
61a04e5b 1926 return NULL;
fd83240a
SR
1927}
1928static inline struct blk_integrity *blk_get_integrity(struct gendisk *disk)
1929{
1930 return NULL;
1931}
1932static inline int blk_integrity_compare(struct gendisk *a, struct gendisk *b)
1933{
1934 return 0;
1935}
25520d55 1936static inline void blk_integrity_register(struct gendisk *d,
fd83240a
SR
1937 struct blk_integrity *b)
1938{
fd83240a
SR
1939}
1940static inline void blk_integrity_unregister(struct gendisk *d)
1941{
1942}
1943static inline void blk_queue_max_integrity_segments(struct request_queue *q,
1944 unsigned int segs)
1945{
1946}
1947static inline unsigned short queue_max_integrity_segments(struct request_queue *q)
1948{
1949 return 0;
1950}
4eaf99be
MP
1951static inline bool blk_integrity_merge_rq(struct request_queue *rq,
1952 struct request *r1,
1953 struct request *r2)
fd83240a 1954{
cb1a5ab6 1955 return true;
fd83240a 1956}
4eaf99be
MP
1957static inline bool blk_integrity_merge_bio(struct request_queue *rq,
1958 struct request *r,
1959 struct bio *b)
fd83240a 1960{
cb1a5ab6 1961 return true;
fd83240a 1962}
25520d55 1963
7f39add3
SG
1964static inline bool integrity_req_gap_back_merge(struct request *req,
1965 struct bio *next)
1966{
1967 return false;
1968}
1969static inline bool integrity_req_gap_front_merge(struct request *req,
1970 struct bio *bio)
1971{
1972 return false;
1973}
7ba1ba12
MP
1974
1975#endif /* CONFIG_BLK_DEV_INTEGRITY */
1976
08f85851 1977struct block_device_operations {
d4430d62 1978 int (*open) (struct block_device *, fmode_t);
db2a144b 1979 void (*release) (struct gendisk *, fmode_t);
c11f0c0b 1980 int (*rw_page)(struct block_device *, sector_t, struct page *, bool);
d4430d62
AV
1981 int (*ioctl) (struct block_device *, fmode_t, unsigned, unsigned long);
1982 int (*compat_ioctl) (struct block_device *, fmode_t, unsigned, unsigned long);
77ea887e
TH
1983 unsigned int (*check_events) (struct gendisk *disk,
1984 unsigned int clearing);
1985 /* ->media_changed() is DEPRECATED, use ->check_events() instead */
08f85851 1986 int (*media_changed) (struct gendisk *);
c3e33e04 1987 void (*unlock_native_capacity) (struct gendisk *);
08f85851
AV
1988 int (*revalidate_disk) (struct gendisk *);
1989 int (*getgeo)(struct block_device *, struct hd_geometry *);
b3a27d05
NG
1990 /* this callback is with swap_lock and sometimes page table lock held */
1991 void (*swap_slot_free_notify) (struct block_device *, unsigned long);
08f85851 1992 struct module *owner;
bbd3e064 1993 const struct pr_ops *pr_ops;
08f85851
AV
1994};
1995
633a08b8
AV
1996extern int __blkdev_driver_ioctl(struct block_device *, fmode_t, unsigned int,
1997 unsigned long);
47a191fd
MW
1998extern int bdev_read_page(struct block_device *, sector_t, struct page *);
1999extern int bdev_write_page(struct block_device *, sector_t, struct page *,
2000 struct writeback_control *);
6cc77e9c
CH
2001
2002#ifdef CONFIG_BLK_DEV_ZONED
2003bool blk_req_needs_zone_write_lock(struct request *rq);
2004void __blk_req_zone_write_lock(struct request *rq);
2005void __blk_req_zone_write_unlock(struct request *rq);
2006
2007static inline void blk_req_zone_write_lock(struct request *rq)
2008{
2009 if (blk_req_needs_zone_write_lock(rq))
2010 __blk_req_zone_write_lock(rq);
2011}
2012
2013static inline void blk_req_zone_write_unlock(struct request *rq)
2014{
2015 if (rq->rq_flags & RQF_ZONE_WRITE_LOCKED)
2016 __blk_req_zone_write_unlock(rq);
2017}
2018
2019static inline bool blk_req_zone_is_write_locked(struct request *rq)
2020{
2021 return rq->q->seq_zones_wlock &&
2022 test_bit(blk_rq_zone_no(rq), rq->q->seq_zones_wlock);
2023}
2024
2025static inline bool blk_req_can_dispatch_to_zone(struct request *rq)
2026{
2027 if (!blk_req_needs_zone_write_lock(rq))
2028 return true;
2029 return !blk_req_zone_is_write_locked(rq);
2030}
2031#else
2032static inline bool blk_req_needs_zone_write_lock(struct request *rq)
2033{
2034 return false;
2035}
2036
2037static inline void blk_req_zone_write_lock(struct request *rq)
2038{
2039}
2040
2041static inline void blk_req_zone_write_unlock(struct request *rq)
2042{
2043}
2044static inline bool blk_req_zone_is_write_locked(struct request *rq)
2045{
2046 return false;
2047}
2048
2049static inline bool blk_req_can_dispatch_to_zone(struct request *rq)
2050{
2051 return true;
2052}
2053#endif /* CONFIG_BLK_DEV_ZONED */
2054
9361401e 2055#else /* CONFIG_BLOCK */
ac13a829
FF
2056
2057struct block_device;
2058
9361401e
DH
2059/*
2060 * stubs for when the block layer is configured out
2061 */
2062#define buffer_heads_over_limit 0
2063
9361401e
DH
2064static inline long nr_blockdev_pages(void)
2065{
2066 return 0;
2067}
2068
1f940bdf
JA
2069struct blk_plug {
2070};
2071
2072static inline void blk_start_plug(struct blk_plug *plug)
73c10101
JA
2073{
2074}
2075
1f940bdf 2076static inline void blk_finish_plug(struct blk_plug *plug)
73c10101
JA
2077{
2078}
2079
1f940bdf 2080static inline void blk_flush_plug(struct task_struct *task)
73c10101
JA
2081{
2082}
2083
a237c1c5
JA
2084static inline void blk_schedule_flush_plug(struct task_struct *task)
2085{
2086}
2087
2088
73c10101
JA
2089static inline bool blk_needs_flush_plug(struct task_struct *tsk)
2090{
2091 return false;
2092}
2093
ac13a829
FF
2094static inline int blkdev_issue_flush(struct block_device *bdev, gfp_t gfp_mask,
2095 sector_t *error_sector)
2096{
2097 return 0;
2098}
2099
9361401e
DH
2100#endif /* CONFIG_BLOCK */
2101
1da177e4 2102#endif