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