]> git.proxmox.com Git - mirror_ubuntu-jammy-kernel.git/blame - include/linux/blkdev.h
KVM: arm64: Fix PMU probe ordering
[mirror_ubuntu-jammy-kernel.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>
1da177e4
LT
7#include <linux/major.h>
8#include <linux/genhd.h>
9#include <linux/list.h>
320ae51f 10#include <linux/llist.h>
b296a6d5 11#include <linux/minmax.h>
1da177e4
LT
12#include <linux/timer.h>
13#include <linux/workqueue.h>
1da177e4
LT
14#include <linux/wait.h>
15#include <linux/mempool.h>
34c0fd54 16#include <linux/pfn.h>
1da177e4 17#include <linux/bio.h>
1da177e4 18#include <linux/stringify.h>
3e6053d7 19#include <linux/gfp.h>
c7c22e4d 20#include <linux/smp.h>
548bc8e1 21#include <linux/rcupdate.h>
add703fd 22#include <linux/percpu-refcount.h>
84be456f 23#include <linux/scatterlist.h>
6a0cb1bc 24#include <linux/blkzoned.h>
db04e18d 25#include <linux/pm.h>
d97e594c 26#include <linux/sbitmap.h>
1da177e4 27
de477254 28struct module;
1da177e4 29struct request_queue;
1da177e4 30struct elevator_queue;
2056a782 31struct blk_trace;
3d6392cf
JA
32struct request;
33struct sg_io_hdr;
3c798398 34struct blkcg_gq;
7c94e1c1 35struct blk_flush_queue;
bbd3e064 36struct pr_ops;
a7905043 37struct rq_qos;
34dbad5d
OS
38struct blk_queue_stats;
39struct blk_stat_callback;
1b262839 40struct blk_keyslot_manager;
1da177e4
LT
41
42#define BLKDEV_MIN_RQ 4
43#define BLKDEV_MAX_RQ 128 /* Default maximum */
44
096392e0 45/* Must be consistent with blk_mq_poll_stats_bkt() */
0206319f
SB
46#define BLK_MQ_POLL_STATS_BKTS 16
47
29ece8b4
YY
48/* Doing classic polling */
49#define BLK_MQ_POLL_CLASSIC -1
50
8bd435b3
TH
51/*
52 * Maximum number of blkcg policies allowed to be registered concurrently.
53 * Defined here to simplify include dependency.
54 */
ec645dc9 55#define BLKCG_MAX_POLS 6
8bd435b3 56
2a842aca 57typedef void (rq_end_io_fn)(struct request *, blk_status_t);
1da177e4 58
e8064021
CH
59/*
60 * request flags */
61typedef __u32 __bitwise req_flags_t;
62
e8064021
CH
63/* drive already may have started this one */
64#define RQF_STARTED ((__force req_flags_t)(1 << 1))
e8064021
CH
65/* may not be passed by ioscheduler */
66#define RQF_SOFTBARRIER ((__force req_flags_t)(1 << 3))
67/* request for flush sequence */
68#define RQF_FLUSH_SEQ ((__force req_flags_t)(1 << 4))
69/* merge of different types, fail separately */
70#define RQF_MIXED_MERGE ((__force req_flags_t)(1 << 5))
71/* track inflight for MQ */
72#define RQF_MQ_INFLIGHT ((__force req_flags_t)(1 << 6))
73/* don't call prep for this one */
74#define RQF_DONTPREP ((__force req_flags_t)(1 << 7))
e8064021
CH
75/* vaguely specified driver internal error. Ignored by the block layer */
76#define RQF_FAILED ((__force req_flags_t)(1 << 10))
77/* don't warn about errors */
78#define RQF_QUIET ((__force req_flags_t)(1 << 11))
79/* elevator private data attached */
80#define RQF_ELVPRIV ((__force req_flags_t)(1 << 12))
4822e902 81/* account into disk and partition IO statistics */
e8064021 82#define RQF_IO_STAT ((__force req_flags_t)(1 << 13))
e8064021
CH
83/* runtime pm request */
84#define RQF_PM ((__force req_flags_t)(1 << 15))
85/* on IO scheduler merge hash */
86#define RQF_HASHED ((__force req_flags_t)(1 << 16))
4822e902 87/* track IO completion time */
cf43e6be 88#define RQF_STATS ((__force req_flags_t)(1 << 17))
f9d03f96
CH
89/* Look at ->special_vec for the actual data payload instead of the
90 bio chain. */
91#define RQF_SPECIAL_PAYLOAD ((__force req_flags_t)(1 << 18))
6cc77e9c
CH
92/* The per-zone write lock is held for this request */
93#define RQF_ZONE_WRITE_LOCKED ((__force req_flags_t)(1 << 19))
76a86f9d 94/* already slept for hybrid poll */
12f5b931 95#define RQF_MQ_POLL_SLEPT ((__force req_flags_t)(1 << 20))
da661267
CH
96/* ->timeout has been called, don't expire again */
97#define RQF_TIMED_OUT ((__force req_flags_t)(1 << 21))
e8064021
CH
98
99/* flags that prevent us from merging requests: */
100#define RQF_NOMERGE_FLAGS \
f9d03f96 101 (RQF_STARTED | RQF_SOFTBARRIER | RQF_FLUSH_SEQ | RQF_SPECIAL_PAYLOAD)
e8064021 102
12f5b931
KB
103/*
104 * Request state for blk-mq.
105 */
106enum mq_rq_state {
107 MQ_RQ_IDLE = 0,
108 MQ_RQ_IN_FLIGHT = 1,
109 MQ_RQ_COMPLETE = 2,
110};
111
1da177e4 112/*
af76e555
CH
113 * Try to put the fields that are referenced together in the same cacheline.
114 *
115 * If you modify this structure, make sure to update blk_rq_init() and
116 * especially blk_mq_rq_ctx_init() to take care of the added fields.
1da177e4
LT
117 */
118struct request {
165125e1 119 struct request_queue *q;
320ae51f 120 struct blk_mq_ctx *mq_ctx;
ea4f995e 121 struct blk_mq_hw_ctx *mq_hctx;
e6a1c874 122
ef295ecf 123 unsigned int cmd_flags; /* op and common flags */
e8064021 124 req_flags_t rq_flags;
d486f1f2 125
2f578aaf 126 int tag;
d486f1f2
JA
127 int internal_tag;
128
a2dec7b3 129 /* the following two fields are internal, NEVER access directly */
a2dec7b3 130 unsigned int __data_len; /* total data len */
181fdde3 131 sector_t __sector; /* sector cursor */
1da177e4
LT
132
133 struct bio *bio;
134 struct bio *biotail;
135
7c3fb70f
JA
136 struct list_head queuelist;
137
360f92c2
JA
138 /*
139 * The hash is used inside the scheduler, and killed once the
140 * request reaches the dispatch list. The ipi_list is only used
141 * to queue the request for softirq completion, which is long
142 * after the request has been unhashed (and even removed from
143 * the dispatch list).
144 */
145 union {
146 struct hlist_node hash; /* merge hash */
f9ab4918 147 struct llist_node ipi_list;
360f92c2
JA
148 };
149
e6a1c874
JA
150 /*
151 * The rb_node is only used inside the io scheduler, requests
152 * are pruned when moved to the dispatch queue. So let the
c186794d 153 * completion_data share space with the rb_node.
e6a1c874
JA
154 */
155 union {
156 struct rb_node rb_node; /* sort/lookup */
f9d03f96 157 struct bio_vec special_vec;
c186794d 158 void *completion_data;
e26738e0 159 int error_count; /* for legacy drivers, don't use */
e6a1c874 160 };
9817064b 161
ff7d145f 162 /*
7f1dc8a2 163 * Three pointers are available for the IO schedulers, if they need
c186794d
MS
164 * more they have to dynamically allocate it. Flush requests are
165 * never put on the IO scheduler. So let the flush fields share
a612fddf 166 * space with the elevator data.
ff7d145f 167 */
c186794d 168 union {
a612fddf
TH
169 struct {
170 struct io_cq *icq;
171 void *priv[2];
172 } elv;
173
c186794d
MS
174 struct {
175 unsigned int seq;
176 struct list_head list;
4853abaa 177 rq_end_io_fn *saved_end_io;
c186794d
MS
178 } flush;
179 };
ff7d145f 180
8f34ee75 181 struct gendisk *rq_disk;
8446fe92 182 struct block_device *part;
6f816b4b
TH
183#ifdef CONFIG_BLK_RQ_ALLOC_TIME
184 /* Time that the first bio started allocating this request. */
185 u64 alloc_time_ns;
186#endif
187 /* Time that this request was allocated for this IO. */
522a7775 188 u64 start_time_ns;
544ccc8d
OS
189 /* Time that I/O was submitted to the device. */
190 u64 io_start_time_ns;
191
192#ifdef CONFIG_BLK_WBT
193 unsigned short wbt_flags;
194#endif
3d244306
HT
195 /*
196 * rq sectors used for blk stats. It has the same value
197 * with blk_rq_sectors(rq), except that it never be zeroed
198 * by completion.
199 */
200 unsigned short stats_sectors;
544ccc8d
OS
201
202 /*
203 * Number of scatter-gather DMA addr+len pairs after
1da177e4
LT
204 * physical address coalescing is performed.
205 */
206 unsigned short nr_phys_segments;
7c3fb70f 207
13f05c8d
MP
208#if defined(CONFIG_BLK_DEV_INTEGRITY)
209 unsigned short nr_integrity_segments;
210#endif
1da177e4 211
a892c8d5
ST
212#ifdef CONFIG_BLK_INLINE_ENCRYPTION
213 struct bio_crypt_ctx *crypt_ctx;
214 struct blk_ksm_keyslot *crypt_keyslot;
215#endif
216
7c3fb70f 217 unsigned short write_hint;
8f34ee75
JA
218 unsigned short ioprio;
219
12f5b931
KB
220 enum mq_rq_state state;
221 refcount_t ref;
1d9bd516 222
0b7576d8 223 unsigned int timeout;
079076b3 224 unsigned long deadline;
cb6934f8 225
7c3fb70f 226 union {
0a4b6e2f 227 struct __call_single_data csd;
7c3fb70f
JA
228 u64 fifo_time;
229 };
230
1da177e4 231 /*
c00895ab 232 * completion callback.
1da177e4
LT
233 */
234 rq_end_io_fn *end_io;
235 void *end_io_data;
236};
237
da6269da 238static inline bool blk_op_is_passthrough(unsigned int op)
14cb0dc6 239{
da6269da 240 op &= REQ_OP_MASK;
14cb0dc6
ML
241 return op == REQ_OP_DRV_IN || op == REQ_OP_DRV_OUT;
242}
243
57292b58
CH
244static inline bool blk_rq_is_passthrough(struct request *rq)
245{
da6269da 246 return blk_op_is_passthrough(req_op(rq));
8d663f34
LF
247}
248
766ca442
FLVC
249static inline unsigned short req_get_ioprio(struct request *req)
250{
251 return req->ioprio;
252}
253
1da177e4
LT
254#include <linux/elevator.h>
255
320ae51f
JA
256struct blk_queue_ctx;
257
1da177e4 258struct bio_vec;
1da177e4 259
242f9dcb 260enum blk_eh_timer_return {
88b0cfad
CH
261 BLK_EH_DONE, /* drivers has completed the command */
262 BLK_EH_RESET_TIMER, /* reset timer and try again */
242f9dcb
JA
263};
264
1da177e4
LT
265enum blk_queue_state {
266 Queue_down,
267 Queue_up,
268};
269
ee1b6f7a
SL
270#define BLK_TAG_ALLOC_FIFO 0 /* allocate starting from 0 */
271#define BLK_TAG_ALLOC_RR 1 /* allocate starting from last allocated tag */
1da177e4 272
797476b8
DLM
273/*
274 * Zoned block device models (zoned limit).
3093a479
CH
275 *
276 * Note: This needs to be ordered from the least to the most severe
277 * restrictions for the inheritance in blk_stack_limits() to work.
797476b8
DLM
278 */
279enum blk_zoned_model {
3093a479
CH
280 BLK_ZONED_NONE = 0, /* Regular block device */
281 BLK_ZONED_HA, /* Host-aware zoned block device */
282 BLK_ZONED_HM, /* Host-managed zoned block device */
797476b8
DLM
283};
284
9bb33f24
CH
285/*
286 * BLK_BOUNCE_NONE: never bounce (default)
287 * BLK_BOUNCE_HIGH: bounce all highmem pages
288 */
289enum blk_bounce {
290 BLK_BOUNCE_NONE,
291 BLK_BOUNCE_HIGH,
292};
293
025146e1 294struct queue_limits {
9bb33f24 295 enum blk_bounce bounce;
025146e1 296 unsigned long seg_boundary_mask;
03100aad 297 unsigned long virt_boundary_mask;
025146e1
MP
298
299 unsigned int max_hw_sectors;
ca369d51 300 unsigned int max_dev_sectors;
762380ad 301 unsigned int chunk_sectors;
025146e1
MP
302 unsigned int max_sectors;
303 unsigned int max_segment_size;
c72758f3 304 unsigned int physical_block_size;
ad6bf88a 305 unsigned int logical_block_size;
c72758f3
MP
306 unsigned int alignment_offset;
307 unsigned int io_min;
308 unsigned int io_opt;
67efc925 309 unsigned int max_discard_sectors;
0034af03 310 unsigned int max_hw_discard_sectors;
4363ac7c 311 unsigned int max_write_same_sectors;
a6f0788e 312 unsigned int max_write_zeroes_sectors;
0512a75b 313 unsigned int max_zone_append_sectors;
86b37281
MP
314 unsigned int discard_granularity;
315 unsigned int discard_alignment;
a805a4fa 316 unsigned int zone_write_granularity;
025146e1 317
8a78362c 318 unsigned short max_segments;
13f05c8d 319 unsigned short max_integrity_segments;
1e739730 320 unsigned short max_discard_segments;
025146e1 321
c72758f3 322 unsigned char misaligned;
86b37281 323 unsigned char discard_misaligned;
c78afc62 324 unsigned char raid_partial_stripes_expensive;
797476b8 325 enum blk_zoned_model zoned;
025146e1
MP
326};
327
d4100351
CH
328typedef int (*report_zones_cb)(struct blk_zone *zone, unsigned int idx,
329 void *data);
330
27ba3e8f
DLM
331void blk_queue_set_zoned(struct gendisk *disk, enum blk_zoned_model model);
332
6a0cb1bc
HR
333#ifdef CONFIG_BLK_DEV_ZONED
334
d4100351
CH
335#define BLK_ALL_ZONES ((unsigned int)-1)
336int blkdev_report_zones(struct block_device *bdev, sector_t sector,
337 unsigned int nr_zones, report_zones_cb cb, void *data);
9b38bb4b 338unsigned int blkdev_nr_zones(struct gendisk *disk);
6c1b1da5
AJ
339extern int blkdev_zone_mgmt(struct block_device *bdev, enum req_opf op,
340 sector_t sectors, sector_t nr_sectors,
341 gfp_t gfp_mask);
e732671a
DLM
342int blk_revalidate_disk_zones(struct gendisk *disk,
343 void (*update_driver_data)(struct gendisk *disk));
6a0cb1bc 344
3ed05a98
ST
345extern int blkdev_report_zones_ioctl(struct block_device *bdev, fmode_t mode,
346 unsigned int cmd, unsigned long arg);
e876df1f
AJ
347extern int blkdev_zone_mgmt_ioctl(struct block_device *bdev, fmode_t mode,
348 unsigned int cmd, unsigned long arg);
3ed05a98
ST
349
350#else /* CONFIG_BLK_DEV_ZONED */
351
9b38bb4b 352static inline unsigned int blkdev_nr_zones(struct gendisk *disk)
a91e1380
DLM
353{
354 return 0;
355}
bf505456 356
3ed05a98
ST
357static inline int blkdev_report_zones_ioctl(struct block_device *bdev,
358 fmode_t mode, unsigned int cmd,
359 unsigned long arg)
360{
361 return -ENOTTY;
362}
363
e876df1f
AJ
364static inline int blkdev_zone_mgmt_ioctl(struct block_device *bdev,
365 fmode_t mode, unsigned int cmd,
366 unsigned long arg)
3ed05a98
ST
367{
368 return -ENOTTY;
369}
370
6a0cb1bc
HR
371#endif /* CONFIG_BLK_DEV_ZONED */
372
d7b76301 373struct request_queue {
1da177e4 374 struct request *last_merge;
b374d18a 375 struct elevator_queue *elevator;
1da177e4 376
0549e87c
ML
377 struct percpu_ref q_usage_counter;
378
34dbad5d 379 struct blk_queue_stats *stats;
a7905043 380 struct rq_qos *rq_qos;
87760e5e 381
f8a5b122 382 const struct blk_mq_ops *mq_ops;
320ae51f 383
320ae51f 384 /* sw queues */
e6cdb092 385 struct blk_mq_ctx __percpu *queue_ctx;
320ae51f 386
d278d4a8
JA
387 unsigned int queue_depth;
388
320ae51f
JA
389 /* hw dispatch queues */
390 struct blk_mq_hw_ctx **queue_hw_ctx;
391 unsigned int nr_hw_queues;
392
1da177e4
LT
393 /*
394 * The queue owner gets to use this for whatever they like.
395 * ll_rw_blk doesn't touch it.
396 */
397 void *queuedata;
398
1da177e4 399 /*
d7b76301 400 * various queue flags, see QUEUE_* below
1da177e4 401 */
d7b76301 402 unsigned long queue_flags;
cd84a62e
BVA
403 /*
404 * Number of contexts that have called blk_set_pm_only(). If this
a4d34da7 405 * counter is above zero then only RQF_PM requests are processed.
cd84a62e
BVA
406 */
407 atomic_t pm_only;
1da177e4 408
a73f730d
TH
409 /*
410 * ida allocated id for this queue. Used to index queues from
411 * ioctx.
412 */
413 int id;
414
0d945c1f 415 spinlock_t queue_lock;
1da177e4 416
d152c682
CH
417 struct gendisk *disk;
418
1da177e4
LT
419 /*
420 * queue kobject
421 */
422 struct kobject kobj;
423
320ae51f
JA
424 /*
425 * mq queue kobject
426 */
1db4909e 427 struct kobject *mq_kobj;
320ae51f 428
ac6fc48c
DW
429#ifdef CONFIG_BLK_DEV_INTEGRITY
430 struct blk_integrity integrity;
431#endif /* CONFIG_BLK_DEV_INTEGRITY */
432
47fafbc7 433#ifdef CONFIG_PM
6c954667 434 struct device *dev;
db04e18d 435 enum rpm_status rpm_status;
6c954667
LM
436#endif
437
1da177e4
LT
438 /*
439 * queue settings
440 */
441 unsigned long nr_requests; /* Max # of requests */
1da177e4 442
e3790c7d 443 unsigned int dma_pad_mask;
1da177e4
LT
444 unsigned int dma_alignment;
445
1b262839
ST
446#ifdef CONFIG_BLK_INLINE_ENCRYPTION
447 /* Inline crypto capabilities */
448 struct blk_keyslot_manager *ksm;
449#endif
450
242f9dcb 451 unsigned int rq_timeout;
64f1c21e 452 int poll_nsec;
34dbad5d
OS
453
454 struct blk_stat_callback *poll_cb;
0206319f 455 struct blk_rq_stat poll_stat[BLK_MQ_POLL_STATS_BKTS];
34dbad5d 456
242f9dcb 457 struct timer_list timeout;
287922eb 458 struct work_struct timeout_work;
242f9dcb 459
bccf5e26
JG
460 atomic_t nr_active_requests_shared_sbitmap;
461
d97e594c
JG
462 struct sbitmap_queue sched_bitmap_tags;
463 struct sbitmap_queue sched_breserved_tags;
464
a612fddf 465 struct list_head icq_list;
4eef3049 466#ifdef CONFIG_BLK_CGROUP
a2b1693b 467 DECLARE_BITMAP (blkcg_pols, BLKCG_MAX_POLS);
3c798398 468 struct blkcg_gq *root_blkg;
03aa264a 469 struct list_head blkg_list;
4eef3049 470#endif
a612fddf 471
025146e1
MP
472 struct queue_limits limits;
473
68c43f13
DLM
474 unsigned int required_elevator_features;
475
6a5ac984 476#ifdef CONFIG_BLK_DEV_ZONED
6cc77e9c
CH
477 /*
478 * Zoned block device information for request dispatch control.
479 * nr_zones is the total number of zones of the device. This is always
f216fdd7
CH
480 * 0 for regular block devices. conv_zones_bitmap is a bitmap of nr_zones
481 * bits which indicates if a zone is conventional (bit set) or
482 * sequential (bit clear). seq_zones_wlock is a bitmap of nr_zones
6cc77e9c
CH
483 * bits which indicates if a zone is write locked, that is, if a write
484 * request targeting the zone was dispatched. All three fields are
485 * initialized by the low level device driver (e.g. scsi/sd.c).
486 * Stacking drivers (device mappers) may or may not initialize
487 * these fields.
ccce20fc
BVA
488 *
489 * Reads of this information must be protected with blk_queue_enter() /
490 * blk_queue_exit(). Modifying this information is only allowed while
491 * no requests are being processed. See also blk_mq_freeze_queue() and
492 * blk_mq_unfreeze_queue().
6cc77e9c
CH
493 */
494 unsigned int nr_zones;
f216fdd7 495 unsigned long *conv_zones_bitmap;
6cc77e9c 496 unsigned long *seq_zones_wlock;
e15864f8 497 unsigned int max_open_zones;
659bf827 498 unsigned int max_active_zones;
6a5ac984 499#endif /* CONFIG_BLK_DEV_ZONED */
6cc77e9c 500
1946089a 501 int node;
85e0cbbb 502 struct mutex debugfs_mutex;
6c5c9341 503#ifdef CONFIG_BLK_DEV_IO_TRACE
c780e86d 504 struct blk_trace __rcu *blk_trace;
6c5c9341 505#endif
1da177e4 506 /*
4913efe4 507 * for flush operations
1da177e4 508 */
7c94e1c1 509 struct blk_flush_queue *fq;
483f4afc 510
6fca6a61
CH
511 struct list_head requeue_list;
512 spinlock_t requeue_lock;
2849450a 513 struct delayed_work requeue_work;
6fca6a61 514
483f4afc 515 struct mutex sysfs_lock;
cecf5d87 516 struct mutex sysfs_dir_lock;
d351af01 517
2f8f1336
ML
518 /*
519 * for reusing dead hctx instance in case of updating
520 * nr_hw_queues
521 */
522 struct list_head unused_hctx_list;
523 spinlock_t unused_hctx_lock;
524
7996a8b5 525 int mq_freeze_depth;
d732580b 526
e43473b7
VG
527#ifdef CONFIG_BLK_DEV_THROTTLING
528 /* Throttle data */
529 struct throtl_data *td;
530#endif
548bc8e1 531 struct rcu_head rcu_head;
320ae51f 532 wait_queue_head_t mq_freeze_wq;
7996a8b5
BL
533 /*
534 * Protect concurrent access to q_usage_counter by
535 * percpu_ref_kill() and percpu_ref_reinit().
536 */
537 struct mutex mq_freeze_lock;
0d2602ca
JA
538
539 struct blk_mq_tag_set *tag_set;
540 struct list_head tag_set_list;
338aa96d 541 struct bio_set bio_split;
4593fdbe 542
07e4fead 543 struct dentry *debugfs_dir;
85e0cbbb
LC
544
545#ifdef CONFIG_BLK_DEBUG_FS
d332ce09 546 struct dentry *sched_debugfs_dir;
cc56694f 547 struct dentry *rqos_debugfs_dir;
07e4fead
OS
548#endif
549
4593fdbe 550 bool mq_sysfs_init_done;
6d247d7f
CH
551
552 size_t cmd_size;
dc9edc44 553
f793dfd3
JA
554#define BLK_MAX_WRITE_HINTS 5
555 u64 write_hints[BLK_MAX_WRITE_HINTS];
1da177e4
LT
556};
557
bfe373f6 558/* Keep blk_queue_flag_name[] in sync with the definitions below */
eca7abf3
JA
559#define QUEUE_FLAG_STOPPED 0 /* queue is stopped */
560#define QUEUE_FLAG_DYING 1 /* queue being torn down */
eca7abf3
JA
561#define QUEUE_FLAG_NOMERGES 3 /* disable merge attempts */
562#define QUEUE_FLAG_SAME_COMP 4 /* complete on same CPU-group */
563#define QUEUE_FLAG_FAIL_IO 5 /* fake timeout */
564#define QUEUE_FLAG_NONROT 6 /* non-rotational device (SSD) */
565#define QUEUE_FLAG_VIRT QUEUE_FLAG_NONROT /* paravirt device */
566#define QUEUE_FLAG_IO_STAT 7 /* do disk/partitions IO accounting */
567#define QUEUE_FLAG_DISCARD 8 /* supports DISCARD */
568#define QUEUE_FLAG_NOXMERGES 9 /* No extended merges */
569#define QUEUE_FLAG_ADD_RANDOM 10 /* Contributes to random pool */
570#define QUEUE_FLAG_SECERASE 11 /* supports secure erase */
571#define QUEUE_FLAG_SAME_FORCE 12 /* force complete on same CPU */
572#define QUEUE_FLAG_DEAD 13 /* queue tear-down finished */
573#define QUEUE_FLAG_INIT_DONE 14 /* queue is initialized */
1cb039f3 574#define QUEUE_FLAG_STABLE_WRITES 15 /* don't modify blks until WB is done */
eca7abf3
JA
575#define QUEUE_FLAG_POLL 16 /* IO polling enabled if set */
576#define QUEUE_FLAG_WC 17 /* Write back caching */
577#define QUEUE_FLAG_FUA 18 /* device supports FUA writes */
578#define QUEUE_FLAG_DAX 19 /* device supports DAX */
579#define QUEUE_FLAG_STATS 20 /* track IO start and completion times */
580#define QUEUE_FLAG_POLL_STATS 21 /* collecting stats for hybrid polling */
581#define QUEUE_FLAG_REGISTERED 22 /* queue has been registered to a disk */
582#define QUEUE_FLAG_SCSI_PASSTHROUGH 23 /* queue supports SCSI commands */
583#define QUEUE_FLAG_QUIESCED 24 /* queue has been quiesced */
584#define QUEUE_FLAG_PCI_P2PDMA 25 /* device supports PCI p2p requests */
e84e8f06 585#define QUEUE_FLAG_ZONE_RESETALL 26 /* supports Zone Reset All */
6f816b4b 586#define QUEUE_FLAG_RQ_ALLOC_TIME 27 /* record rq->alloc_time_ns */
021a2446
MS
587#define QUEUE_FLAG_HCTX_ACTIVE 28 /* at least one blk-mq hctx is active */
588#define QUEUE_FLAG_NOWAIT 29 /* device supports NOWAIT */
797e7dbb 589
94eddfbe 590#define QUEUE_FLAG_MQ_DEFAULT ((1 << QUEUE_FLAG_IO_STAT) | \
021a2446
MS
591 (1 << QUEUE_FLAG_SAME_COMP) | \
592 (1 << QUEUE_FLAG_NOWAIT))
94eddfbe 593
8814ce8a
BVA
594void blk_queue_flag_set(unsigned int flag, struct request_queue *q);
595void blk_queue_flag_clear(unsigned int flag, struct request_queue *q);
596bool blk_queue_flag_test_and_set(unsigned int flag, struct request_queue *q);
8814ce8a 597
1da177e4 598#define blk_queue_stopped(q) test_bit(QUEUE_FLAG_STOPPED, &(q)->queue_flags)
3f3299d5 599#define blk_queue_dying(q) test_bit(QUEUE_FLAG_DYING, &(q)->queue_flags)
c246e80d 600#define blk_queue_dead(q) test_bit(QUEUE_FLAG_DEAD, &(q)->queue_flags)
320ae51f 601#define blk_queue_init_done(q) test_bit(QUEUE_FLAG_INIT_DONE, &(q)->queue_flags)
ac9fafa1 602#define blk_queue_nomerges(q) test_bit(QUEUE_FLAG_NOMERGES, &(q)->queue_flags)
488991e2
AB
603#define blk_queue_noxmerges(q) \
604 test_bit(QUEUE_FLAG_NOXMERGES, &(q)->queue_flags)
a68bbddb 605#define blk_queue_nonrot(q) test_bit(QUEUE_FLAG_NONROT, &(q)->queue_flags)
1cb039f3
CH
606#define blk_queue_stable_writes(q) \
607 test_bit(QUEUE_FLAG_STABLE_WRITES, &(q)->queue_flags)
bc58ba94 608#define blk_queue_io_stat(q) test_bit(QUEUE_FLAG_IO_STAT, &(q)->queue_flags)
e2e1a148 609#define blk_queue_add_random(q) test_bit(QUEUE_FLAG_ADD_RANDOM, &(q)->queue_flags)
c15227de 610#define blk_queue_discard(q) test_bit(QUEUE_FLAG_DISCARD, &(q)->queue_flags)
e84e8f06
CK
611#define blk_queue_zone_resetall(q) \
612 test_bit(QUEUE_FLAG_ZONE_RESETALL, &(q)->queue_flags)
288dab8a
CH
613#define blk_queue_secure_erase(q) \
614 (test_bit(QUEUE_FLAG_SECERASE, &(q)->queue_flags))
163d4baa 615#define blk_queue_dax(q) test_bit(QUEUE_FLAG_DAX, &(q)->queue_flags)
9efc160f
BVA
616#define blk_queue_scsi_passthrough(q) \
617 test_bit(QUEUE_FLAG_SCSI_PASSTHROUGH, &(q)->queue_flags)
49d92c0d
LG
618#define blk_queue_pci_p2pdma(q) \
619 test_bit(QUEUE_FLAG_PCI_P2PDMA, &(q)->queue_flags)
6f816b4b
TH
620#ifdef CONFIG_BLK_RQ_ALLOC_TIME
621#define blk_queue_rq_alloc_time(q) \
622 test_bit(QUEUE_FLAG_RQ_ALLOC_TIME, &(q)->queue_flags)
623#else
624#define blk_queue_rq_alloc_time(q) false
625#endif
1da177e4 626
33659ebb
CH
627#define blk_noretry_request(rq) \
628 ((rq)->cmd_flags & (REQ_FAILFAST_DEV|REQ_FAILFAST_TRANSPORT| \
629 REQ_FAILFAST_DRIVER))
f4560ffe 630#define blk_queue_quiesced(q) test_bit(QUEUE_FLAG_QUIESCED, &(q)->queue_flags)
cd84a62e 631#define blk_queue_pm_only(q) atomic_read(&(q)->pm_only)
0ce91444 632#define blk_queue_fua(q) test_bit(QUEUE_FLAG_FUA, &(q)->queue_flags)
58c898ba 633#define blk_queue_registered(q) test_bit(QUEUE_FLAG_REGISTERED, &(q)->queue_flags)
021a2446 634#define blk_queue_nowait(q) test_bit(QUEUE_FLAG_NOWAIT, &(q)->queue_flags)
c9254f2d 635
cd84a62e
BVA
636extern void blk_set_pm_only(struct request_queue *q);
637extern void blk_clear_pm_only(struct request_queue *q);
33659ebb 638
1da177e4
LT
639#define list_entry_rq(ptr) list_entry((ptr), struct request, queuelist)
640
4e1b2d52 641#define rq_data_dir(rq) (op_is_write(req_op(rq)) ? WRITE : READ)
1da177e4 642
9d9de535
CH
643#define rq_dma_dir(rq) \
644 (op_is_write(req_op(rq)) ? DMA_TO_DEVICE : DMA_FROM_DEVICE)
645
3ab3a031
CH
646#define dma_map_bvec(dev, bv, dir, attrs) \
647 dma_map_page_attrs(dev, (bv)->bv_page, (bv)->bv_offset, (bv)->bv_len, \
648 (dir), (attrs))
649
344e9ffc 650static inline bool queue_is_mq(struct request_queue *q)
49fd524f 651{
a1ce35fa 652 return q->mq_ops;
49fd524f
JA
653}
654
52abca64
AS
655#ifdef CONFIG_PM
656static inline enum rpm_status queue_rpm_status(struct request_queue *q)
657{
658 return q->rpm_status;
659}
660#else
661static inline enum rpm_status queue_rpm_status(struct request_queue *q)
662{
663 return RPM_ACTIVE;
664}
665#endif
666
797476b8
DLM
667static inline enum blk_zoned_model
668blk_queue_zoned_model(struct request_queue *q)
669{
6fcd6695
CH
670 if (IS_ENABLED(CONFIG_BLK_DEV_ZONED))
671 return q->limits.zoned;
672 return BLK_ZONED_NONE;
797476b8
DLM
673}
674
675static inline bool blk_queue_is_zoned(struct request_queue *q)
676{
677 switch (blk_queue_zoned_model(q)) {
678 case BLK_ZONED_HA:
679 case BLK_ZONED_HM:
680 return true;
681 default:
682 return false;
683 }
684}
685
113ab72e 686static inline sector_t blk_queue_zone_sectors(struct request_queue *q)
6a0cb1bc
HR
687{
688 return blk_queue_is_zoned(q) ? q->limits.chunk_sectors : 0;
689}
690
6a5ac984 691#ifdef CONFIG_BLK_DEV_ZONED
965b652e
DLM
692static inline unsigned int blk_queue_nr_zones(struct request_queue *q)
693{
694 return blk_queue_is_zoned(q) ? q->nr_zones : 0;
695}
696
6cc77e9c
CH
697static inline unsigned int blk_queue_zone_no(struct request_queue *q,
698 sector_t sector)
699{
700 if (!blk_queue_is_zoned(q))
701 return 0;
702 return sector >> ilog2(q->limits.chunk_sectors);
703}
704
705static inline bool blk_queue_zone_is_seq(struct request_queue *q,
706 sector_t sector)
707{
f216fdd7 708 if (!blk_queue_is_zoned(q))
6cc77e9c 709 return false;
f216fdd7
CH
710 if (!q->conv_zones_bitmap)
711 return true;
712 return !test_bit(blk_queue_zone_no(q, sector), q->conv_zones_bitmap);
6cc77e9c 713}
e15864f8
NC
714
715static inline void blk_queue_max_open_zones(struct request_queue *q,
716 unsigned int max_open_zones)
717{
718 q->max_open_zones = max_open_zones;
719}
720
721static inline unsigned int queue_max_open_zones(const struct request_queue *q)
722{
723 return q->max_open_zones;
724}
659bf827
NC
725
726static inline void blk_queue_max_active_zones(struct request_queue *q,
727 unsigned int max_active_zones)
728{
729 q->max_active_zones = max_active_zones;
730}
731
732static inline unsigned int queue_max_active_zones(const struct request_queue *q)
733{
734 return q->max_active_zones;
735}
965b652e
DLM
736#else /* CONFIG_BLK_DEV_ZONED */
737static inline unsigned int blk_queue_nr_zones(struct request_queue *q)
738{
739 return 0;
740}
02992df8
JT
741static inline bool blk_queue_zone_is_seq(struct request_queue *q,
742 sector_t sector)
743{
744 return false;
745}
746static inline unsigned int blk_queue_zone_no(struct request_queue *q,
747 sector_t sector)
748{
749 return 0;
750}
e15864f8
NC
751static inline unsigned int queue_max_open_zones(const struct request_queue *q)
752{
753 return 0;
754}
659bf827
NC
755static inline unsigned int queue_max_active_zones(const struct request_queue *q)
756{
757 return 0;
758}
6a5ac984 759#endif /* CONFIG_BLK_DEV_ZONED */
6cc77e9c 760
1faa16d2
JA
761static inline bool rq_is_sync(struct request *rq)
762{
ef295ecf 763 return op_is_sync(rq->cmd_flags);
1faa16d2
JA
764}
765
e2a60da7
MP
766static inline bool rq_mergeable(struct request *rq)
767{
57292b58 768 if (blk_rq_is_passthrough(rq))
e2a60da7 769 return false;
1da177e4 770
3a5e02ce
MC
771 if (req_op(rq) == REQ_OP_FLUSH)
772 return false;
773
a6f0788e
CK
774 if (req_op(rq) == REQ_OP_WRITE_ZEROES)
775 return false;
776
0512a75b
KB
777 if (req_op(rq) == REQ_OP_ZONE_APPEND)
778 return false;
779
e2a60da7 780 if (rq->cmd_flags & REQ_NOMERGE_FLAGS)
e8064021
CH
781 return false;
782 if (rq->rq_flags & RQF_NOMERGE_FLAGS)
e2a60da7
MP
783 return false;
784
785 return true;
786}
1da177e4 787
4363ac7c
MP
788static inline bool blk_write_same_mergeable(struct bio *a, struct bio *b)
789{
efbeccdb
CH
790 if (bio_page(a) == bio_page(b) &&
791 bio_offset(a) == bio_offset(b))
4363ac7c
MP
792 return true;
793
794 return false;
795}
796
d278d4a8
JA
797static inline unsigned int blk_queue_depth(struct request_queue *q)
798{
799 if (q->queue_depth)
800 return q->queue_depth;
801
802 return q->nr_requests;
803}
804
3d6392cf
JA
805/*
806 * default timeout for SG_IO if none specified
807 */
808#define BLK_DEFAULT_SG_TIMEOUT (60 * HZ)
f2f1fa78 809#define BLK_MIN_SG_TIMEOUT (7 * HZ)
3d6392cf 810
152e283f
FT
811struct rq_map_data {
812 struct page **pages;
813 int page_order;
814 int nr_entries;
56c451f4 815 unsigned long offset;
97ae77a1 816 int null_mapped;
ecb554a8 817 int from_user;
152e283f
FT
818};
819
5705f702 820struct req_iterator {
7988613b 821 struct bvec_iter iter;
5705f702
N
822 struct bio *bio;
823};
824
825/* This should not be used directly - use rq_for_each_segment */
1e428079
JA
826#define for_each_bio(_bio) \
827 for (; _bio; _bio = _bio->bi_next)
5705f702 828#define __rq_for_each_bio(_bio, rq) \
1da177e4
LT
829 if ((rq->bio)) \
830 for (_bio = (rq)->bio; _bio; _bio = _bio->bi_next)
831
5705f702
N
832#define rq_for_each_segment(bvl, _rq, _iter) \
833 __rq_for_each_bio(_iter.bio, _rq) \
7988613b 834 bio_for_each_segment(bvl, _iter.bio, _iter.iter)
5705f702 835
d18d9174
ML
836#define rq_for_each_bvec(bvl, _rq, _iter) \
837 __rq_for_each_bio(_iter.bio, _rq) \
838 bio_for_each_bvec(bvl, _iter.bio, _iter.iter)
839
4550dd6c 840#define rq_iter_last(bvec, _iter) \
7988613b 841 (_iter.bio->bi_next == NULL && \
4550dd6c 842 bio_iter_last(bvec, _iter.iter))
5705f702 843
2d4dc890
IL
844#ifndef ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE
845# error "You should define ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE for your platform"
846#endif
847#if ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE
848extern void rq_flush_dcache_pages(struct request *rq);
849#else
850static inline void rq_flush_dcache_pages(struct request *rq)
851{
852}
853#endif
854
1da177e4
LT
855extern int blk_register_queue(struct gendisk *disk);
856extern void blk_unregister_queue(struct gendisk *disk);
ed00aabd 857blk_qc_t submit_bio_noacct(struct bio *bio);
2a4aa30c 858extern void blk_rq_init(struct request_queue *q, struct request *rq);
1da177e4 859extern void blk_put_request(struct request *);
cd6ce148 860extern struct request *blk_get_request(struct request_queue *, unsigned int op,
ff005a06 861 blk_mq_req_flags_t flags);
ef9e3fac 862extern int blk_lld_busy(struct request_queue *q);
78d8e58a
MS
863extern int blk_rq_prep_clone(struct request *rq, struct request *rq_src,
864 struct bio_set *bs, gfp_t gfp_mask,
865 int (*bio_ctr)(struct bio *, struct bio *, void *),
866 void *data);
867extern void blk_rq_unprep_clone(struct request *rq);
2a842aca 868extern blk_status_t blk_insert_cloned_request(struct request_queue *q,
82124d60 869 struct request *rq);
393bb12e 870int blk_rq_append_bio(struct request *rq, struct bio *bio);
f695ca38 871extern void blk_queue_split(struct bio **);
9a95e4ef 872extern int blk_queue_enter(struct request_queue *q, blk_mq_req_flags_t flags);
2e6edc95 873extern void blk_queue_exit(struct request_queue *q);
1da177e4 874extern void blk_sync_queue(struct request_queue *q);
a3bce90e 875extern int blk_rq_map_user(struct request_queue *, struct request *,
152e283f
FT
876 struct rq_map_data *, void __user *, unsigned long,
877 gfp_t);
8e5cfc45 878extern int blk_rq_unmap_user(struct bio *);
165125e1
JA
879extern int blk_rq_map_kern(struct request_queue *, struct request *, void *, unsigned int, gfp_t);
880extern int blk_rq_map_user_iov(struct request_queue *, struct request *,
26e49cfc
KO
881 struct rq_map_data *, const struct iov_iter *,
882 gfp_t);
8eeed0b5 883extern void blk_execute_rq_nowait(struct gendisk *,
15fc858a 884 struct request *, int, rq_end_io_fn *);
6e39b69e 885
fb9b16e1
KB
886blk_status_t blk_execute_rq(struct gendisk *bd_disk, struct request *rq,
887 int at_head);
888
e47bc4ed
CK
889/* Helper to convert REQ_OP_XXX to its string format XXX */
890extern const char *blk_op_str(unsigned int op);
891
2a842aca
CH
892int blk_status_to_errno(blk_status_t status);
893blk_status_t errno_to_blk_status(int errno);
894
0a1b8b87 895int blk_poll(struct request_queue *q, blk_qc_t cookie, bool spin);
05229bee 896
165125e1 897static inline struct request_queue *bdev_get_queue(struct block_device *bdev)
1da177e4 898{
ff9ea323 899 return bdev->bd_disk->queue; /* this is never NULL */
1da177e4
LT
900}
901
233bde21
BVA
902/*
903 * The basic unit of block I/O is a sector. It is used in a number of contexts
904 * in Linux (blk, bio, genhd). The size of one sector is 512 = 2**9
905 * bytes. Variables of type sector_t represent an offset or size that is a
906 * multiple of 512 bytes. Hence these two constants.
907 */
908#ifndef SECTOR_SHIFT
909#define SECTOR_SHIFT 9
910#endif
911#ifndef SECTOR_SIZE
912#define SECTOR_SIZE (1 << SECTOR_SHIFT)
913#endif
914
018eca45
GJ
915#define PAGE_SECTORS_SHIFT (PAGE_SHIFT - SECTOR_SHIFT)
916#define PAGE_SECTORS (1 << PAGE_SECTORS_SHIFT)
917#define SECTOR_MASK (PAGE_SECTORS - 1)
918
5efccd17 919/*
80a761fd
TH
920 * blk_rq_pos() : the current sector
921 * blk_rq_bytes() : bytes left in the entire request
922 * blk_rq_cur_bytes() : bytes left in the current segment
923 * blk_rq_err_bytes() : bytes left till the next error boundary
924 * blk_rq_sectors() : sectors left in the entire request
925 * blk_rq_cur_sectors() : sectors left in the current segment
3d244306 926 * blk_rq_stats_sectors() : sectors of the entire request used for stats
5efccd17 927 */
5b93629b
TH
928static inline sector_t blk_rq_pos(const struct request *rq)
929{
a2dec7b3 930 return rq->__sector;
2e46e8b2
TH
931}
932
933static inline unsigned int blk_rq_bytes(const struct request *rq)
934{
a2dec7b3 935 return rq->__data_len;
5b93629b
TH
936}
937
2e46e8b2
TH
938static inline int blk_rq_cur_bytes(const struct request *rq)
939{
940 return rq->bio ? bio_cur_bytes(rq->bio) : 0;
941}
5efccd17 942
80a761fd
TH
943extern unsigned int blk_rq_err_bytes(const struct request *rq);
944
5b93629b
TH
945static inline unsigned int blk_rq_sectors(const struct request *rq)
946{
233bde21 947 return blk_rq_bytes(rq) >> SECTOR_SHIFT;
5b93629b
TH
948}
949
950static inline unsigned int blk_rq_cur_sectors(const struct request *rq)
951{
233bde21 952 return blk_rq_cur_bytes(rq) >> SECTOR_SHIFT;
5b93629b
TH
953}
954
3d244306
HT
955static inline unsigned int blk_rq_stats_sectors(const struct request *rq)
956{
957 return rq->stats_sectors;
958}
959
6a5ac984 960#ifdef CONFIG_BLK_DEV_ZONED
02694e86
CK
961
962/* Helper to convert BLK_ZONE_ZONE_XXX to its string format XXX */
963const char *blk_zone_cond_str(enum blk_zone_cond zone_cond);
964
d0ea6bde
DLM
965static inline unsigned int bio_zone_no(struct bio *bio)
966{
967 return blk_queue_zone_no(bdev_get_queue(bio->bi_bdev),
968 bio->bi_iter.bi_sector);
969}
970
971static inline unsigned int bio_zone_is_seq(struct bio *bio)
972{
973 return blk_queue_zone_is_seq(bdev_get_queue(bio->bi_bdev),
974 bio->bi_iter.bi_sector);
975}
976
6cc77e9c
CH
977static inline unsigned int blk_rq_zone_no(struct request *rq)
978{
979 return blk_queue_zone_no(rq->q, blk_rq_pos(rq));
980}
981
982static inline unsigned int blk_rq_zone_is_seq(struct request *rq)
983{
984 return blk_queue_zone_is_seq(rq->q, blk_rq_pos(rq));
985}
6a5ac984 986#endif /* CONFIG_BLK_DEV_ZONED */
6cc77e9c 987
2e3258ec
CH
988/*
989 * Some commands like WRITE SAME have a payload or data transfer size which
990 * is different from the size of the request. Any driver that supports such
991 * commands using the RQF_SPECIAL_PAYLOAD flag needs to use this helper to
992 * calculate the data transfer size.
993 */
994static inline unsigned int blk_rq_payload_bytes(struct request *rq)
995{
996 if (rq->rq_flags & RQF_SPECIAL_PAYLOAD)
997 return rq->special_vec.bv_len;
998 return blk_rq_bytes(rq);
999}
1000
3aef3cae
CH
1001/*
1002 * Return the first full biovec in the request. The caller needs to check that
1003 * there are any bvecs before calling this helper.
1004 */
1005static inline struct bio_vec req_bvec(struct request *rq)
1006{
1007 if (rq->rq_flags & RQF_SPECIAL_PAYLOAD)
1008 return rq->special_vec;
1009 return mp_bvec_iter_bvec(rq->bio->bi_io_vec, rq->bio->bi_iter);
1010}
1011
f31dc1cd 1012static inline unsigned int blk_queue_get_max_sectors(struct request_queue *q,
8fe0d473 1013 int op)
f31dc1cd 1014{
7afafc8a 1015 if (unlikely(op == REQ_OP_DISCARD || op == REQ_OP_SECURE_ERASE))
233bde21
BVA
1016 return min(q->limits.max_discard_sectors,
1017 UINT_MAX >> SECTOR_SHIFT);
f31dc1cd 1018
8fe0d473 1019 if (unlikely(op == REQ_OP_WRITE_SAME))
4363ac7c
MP
1020 return q->limits.max_write_same_sectors;
1021
a6f0788e
CK
1022 if (unlikely(op == REQ_OP_WRITE_ZEROES))
1023 return q->limits.max_write_zeroes_sectors;
1024
f31dc1cd
MP
1025 return q->limits.max_sectors;
1026}
1027
762380ad
JA
1028/*
1029 * Return maximum size of a request at given offset. Only valid for
1030 * file system requests.
1031 */
1032static inline unsigned int blk_max_size_offset(struct request_queue *q,
3ee16db3
MS
1033 sector_t offset,
1034 unsigned int chunk_sectors)
762380ad 1035{
65f33b35
MS
1036 if (!chunk_sectors) {
1037 if (q->limits.chunk_sectors)
1038 chunk_sectors = q->limits.chunk_sectors;
1039 else
1040 return q->limits.max_sectors;
1041 }
762380ad 1042
07d098e6
MS
1043 if (likely(is_power_of_2(chunk_sectors)))
1044 chunk_sectors -= offset & (chunk_sectors - 1);
1045 else
1046 chunk_sectors -= sector_div(offset, chunk_sectors);
1047
1048 return min(q->limits.max_sectors, chunk_sectors);
762380ad
JA
1049}
1050
17007f39
DLM
1051static inline unsigned int blk_rq_get_max_sectors(struct request *rq,
1052 sector_t offset)
f31dc1cd
MP
1053{
1054 struct request_queue *q = rq->q;
1055
57292b58 1056 if (blk_rq_is_passthrough(rq))
f31dc1cd
MP
1057 return q->limits.max_hw_sectors;
1058
7afafc8a
AH
1059 if (!q->limits.chunk_sectors ||
1060 req_op(rq) == REQ_OP_DISCARD ||
1061 req_op(rq) == REQ_OP_SECURE_ERASE)
8fe0d473 1062 return blk_queue_get_max_sectors(q, req_op(rq));
762380ad 1063
3ee16db3 1064 return min(blk_max_size_offset(q, offset, 0),
8fe0d473 1065 blk_queue_get_max_sectors(q, req_op(rq)));
f31dc1cd
MP
1066}
1067
75afb352
JN
1068static inline unsigned int blk_rq_count_bios(struct request *rq)
1069{
1070 unsigned int nr_bios = 0;
1071 struct bio *bio;
1072
1073 __rq_for_each_bio(bio, rq)
1074 nr_bios++;
1075
1076 return nr_bios;
1077}
1078
ef71de8b
CH
1079void blk_steal_bios(struct bio_list *list, struct request *rq);
1080
1da177e4 1081/*
2e60e022
TH
1082 * Request completion related functions.
1083 *
1084 * blk_update_request() completes given number of bytes and updates
1085 * the request without completing it.
1da177e4 1086 */
2a842aca 1087extern bool blk_update_request(struct request *rq, blk_status_t error,
2e60e022 1088 unsigned int nr_bytes);
2e60e022 1089
242f9dcb 1090extern void blk_abort_request(struct request *);
ff856bad 1091
1da177e4
LT
1092/*
1093 * Access functions for manipulating queue properties
1094 */
165125e1 1095extern void blk_cleanup_queue(struct request_queue *);
9bb33f24 1096void blk_queue_bounce_limit(struct request_queue *q, enum blk_bounce limit);
086fa5ff 1097extern void blk_queue_max_hw_sectors(struct request_queue *, unsigned int);
762380ad 1098extern void blk_queue_chunk_sectors(struct request_queue *, unsigned int);
8a78362c 1099extern void blk_queue_max_segments(struct request_queue *, unsigned short);
1e739730
CH
1100extern void blk_queue_max_discard_segments(struct request_queue *,
1101 unsigned short);
165125e1 1102extern void blk_queue_max_segment_size(struct request_queue *, unsigned int);
67efc925
CH
1103extern void blk_queue_max_discard_sectors(struct request_queue *q,
1104 unsigned int max_discard_sectors);
4363ac7c
MP
1105extern void blk_queue_max_write_same_sectors(struct request_queue *q,
1106 unsigned int max_write_same_sectors);
a6f0788e
CK
1107extern void blk_queue_max_write_zeroes_sectors(struct request_queue *q,
1108 unsigned int max_write_same_sectors);
ad6bf88a 1109extern void blk_queue_logical_block_size(struct request_queue *, unsigned int);
0512a75b
KB
1110extern void blk_queue_max_zone_append_sectors(struct request_queue *q,
1111 unsigned int max_zone_append_sectors);
892b6f90 1112extern void blk_queue_physical_block_size(struct request_queue *, unsigned int);
a805a4fa
DLM
1113void blk_queue_zone_write_granularity(struct request_queue *q,
1114 unsigned int size);
c72758f3
MP
1115extern void blk_queue_alignment_offset(struct request_queue *q,
1116 unsigned int alignment);
471aa704 1117void disk_update_readahead(struct gendisk *disk);
7c958e32 1118extern void blk_limits_io_min(struct queue_limits *limits, unsigned int min);
c72758f3 1119extern void blk_queue_io_min(struct request_queue *q, unsigned int min);
3c5820c7 1120extern void blk_limits_io_opt(struct queue_limits *limits, unsigned int opt);
c72758f3 1121extern void blk_queue_io_opt(struct request_queue *q, unsigned int opt);
d278d4a8 1122extern void blk_set_queue_depth(struct request_queue *q, unsigned int depth);
e475bba2 1123extern void blk_set_default_limits(struct queue_limits *lim);
b1bd055d 1124extern void blk_set_stacking_limits(struct queue_limits *lim);
c72758f3
MP
1125extern int blk_stack_limits(struct queue_limits *t, struct queue_limits *b,
1126 sector_t offset);
1127extern void disk_stack_limits(struct gendisk *disk, struct block_device *bdev,
1128 sector_t offset);
27f8221a 1129extern void blk_queue_update_dma_pad(struct request_queue *, unsigned int);
165125e1 1130extern void blk_queue_segment_boundary(struct request_queue *, unsigned long);
03100aad 1131extern void blk_queue_virt_boundary(struct request_queue *, unsigned long);
165125e1 1132extern void blk_queue_dma_alignment(struct request_queue *, int);
11c3e689 1133extern void blk_queue_update_dma_alignment(struct request_queue *, int);
242f9dcb 1134extern void blk_queue_rq_timeout(struct request_queue *, unsigned int);
93e9d8e8 1135extern void blk_queue_write_cache(struct request_queue *q, bool enabled, bool fua);
68c43f13
DLM
1136extern void blk_queue_required_elevator_features(struct request_queue *q,
1137 unsigned int features);
45147fb5
YS
1138extern bool blk_queue_can_use_dma_map_merging(struct request_queue *q,
1139 struct device *dev);
1da177e4 1140
1e739730
CH
1141/*
1142 * Number of physical segments as sent to the device.
1143 *
1144 * Normally this is the number of discontiguous data segments sent by the
1145 * submitter. But for data-less command like discard we might have no
1146 * actual data segments submitted, but the driver might have to add it's
1147 * own special payload. In that case we still return 1 here so that this
1148 * special payload will be mapped.
1149 */
f9d03f96
CH
1150static inline unsigned short blk_rq_nr_phys_segments(struct request *rq)
1151{
1152 if (rq->rq_flags & RQF_SPECIAL_PAYLOAD)
1153 return 1;
1154 return rq->nr_phys_segments;
1155}
1156
1e739730
CH
1157/*
1158 * Number of discard segments (or ranges) the driver needs to fill in.
1159 * Each discard bio merged into a request is counted as one segment.
1160 */
1161static inline unsigned short blk_rq_nr_discard_segments(struct request *rq)
1162{
1163 return max_t(unsigned short, rq->nr_phys_segments, 1);
1164}
1165
89de1504
CH
1166int __blk_rq_map_sg(struct request_queue *q, struct request *rq,
1167 struct scatterlist *sglist, struct scatterlist **last_sg);
1168static inline int blk_rq_map_sg(struct request_queue *q, struct request *rq,
1169 struct scatterlist *sglist)
1170{
1171 struct scatterlist *last_sg = NULL;
1172
1173 return __blk_rq_map_sg(q, rq, sglist, &last_sg);
1174}
1da177e4 1175extern void blk_dump_rq_flags(struct request *, char *);
1da177e4 1176
09ac46c4 1177bool __must_check blk_get_queue(struct request_queue *);
165125e1 1178extern void blk_put_queue(struct request_queue *);
3f21c265 1179extern void blk_set_queue_dying(struct request_queue *);
1da177e4 1180
1a4dcfa8 1181#ifdef CONFIG_BLOCK
316cc67d 1182/*
75df7136
SJ
1183 * blk_plug permits building a queue of related requests by holding the I/O
1184 * fragments for a short period. This allows merging of sequential requests
1185 * into single larger request. As the requests are moved from a per-task list to
1186 * the device's request_queue in a batch, this results in improved scalability
1187 * as the lock contention for request_queue lock is reduced.
1188 *
1189 * It is ok not to disable preemption when adding the request to the plug list
1190 * or when attempting a merge, because blk_schedule_flush_list() will only flush
1191 * the plug list when the task sleeps by itself. For details, please see
1192 * schedule() where blk_schedule_flush_plug() is called.
316cc67d 1193 */
73c10101 1194struct blk_plug {
320ae51f 1195 struct list_head mq_list; /* blk-mq requests */
75df7136 1196 struct list_head cb_list; /* md requires an unplug callback */
5f0ed774 1197 unsigned short rq_count;
ce5b009c 1198 bool multiple_queues;
5a473e83 1199 bool nowait;
73c10101 1200};
55c022bb 1201#define BLK_MAX_REQUEST_COUNT 16
50d24c34 1202#define BLK_PLUG_FLUSH_SIZE (128 * 1024)
55c022bb 1203
9cbb1750 1204struct blk_plug_cb;
74018dc3 1205typedef void (*blk_plug_cb_fn)(struct blk_plug_cb *, bool);
048c9374
N
1206struct blk_plug_cb {
1207 struct list_head list;
9cbb1750
N
1208 blk_plug_cb_fn callback;
1209 void *data;
048c9374 1210};
9cbb1750
N
1211extern struct blk_plug_cb *blk_check_plugged(blk_plug_cb_fn unplug,
1212 void *data, int size);
73c10101
JA
1213extern void blk_start_plug(struct blk_plug *);
1214extern void blk_finish_plug(struct blk_plug *);
f6603783 1215extern void blk_flush_plug_list(struct blk_plug *, bool);
73c10101
JA
1216
1217static inline void blk_flush_plug(struct task_struct *tsk)
1218{
1219 struct blk_plug *plug = tsk->plug;
1220
a237c1c5
JA
1221 if (plug)
1222 blk_flush_plug_list(plug, false);
1223}
1224
1225static inline void blk_schedule_flush_plug(struct task_struct *tsk)
1226{
1227 struct blk_plug *plug = tsk->plug;
1228
88b996cd 1229 if (plug)
f6603783 1230 blk_flush_plug_list(plug, true);
73c10101
JA
1231}
1232
1233static inline bool blk_needs_flush_plug(struct task_struct *tsk)
1234{
1235 struct blk_plug *plug = tsk->plug;
1236
320ae51f 1237 return plug &&
a1ce35fa 1238 (!list_empty(&plug->mq_list) ||
320ae51f 1239 !list_empty(&plug->cb_list));
73c10101
JA
1240}
1241
c6bf3f0e 1242int blkdev_issue_flush(struct block_device *bdev);
1a4dcfa8
CH
1243long nr_blockdev_pages(void);
1244#else /* CONFIG_BLOCK */
1245struct blk_plug {
1246};
1247
1248static inline void blk_start_plug(struct blk_plug *plug)
1249{
1250}
1251
1252static inline void blk_finish_plug(struct blk_plug *plug)
1253{
1254}
1255
1256static inline void blk_flush_plug(struct task_struct *task)
1257{
1258}
1259
1260static inline void blk_schedule_flush_plug(struct task_struct *task)
1261{
1262}
1263
1264
1265static inline bool blk_needs_flush_plug(struct task_struct *tsk)
1266{
1267 return false;
1268}
1269
c6bf3f0e 1270static inline int blkdev_issue_flush(struct block_device *bdev)
1a4dcfa8
CH
1271{
1272 return 0;
1273}
1274
1275static inline long nr_blockdev_pages(void)
1276{
1277 return 0;
1278}
1279#endif /* CONFIG_BLOCK */
1280
71ac860a
ML
1281extern void blk_io_schedule(void);
1282
ee472d83
CH
1283extern int blkdev_issue_write_same(struct block_device *bdev, sector_t sector,
1284 sector_t nr_sects, gfp_t gfp_mask, struct page *page);
e950fdf7
CH
1285
1286#define BLKDEV_DISCARD_SECURE (1 << 0) /* issue a secure erase */
dd3932ed 1287
fbd9b09a
DM
1288extern int blkdev_issue_discard(struct block_device *bdev, sector_t sector,
1289 sector_t nr_sects, gfp_t gfp_mask, unsigned long flags);
38f25255 1290extern int __blkdev_issue_discard(struct block_device *bdev, sector_t sector,
288dab8a 1291 sector_t nr_sects, gfp_t gfp_mask, int flags,
469e3216 1292 struct bio **biop);
ee472d83
CH
1293
1294#define BLKDEV_ZERO_NOUNMAP (1 << 0) /* do not free blocks */
cb365b96 1295#define BLKDEV_ZERO_NOFALLBACK (1 << 1) /* don't write explicit zeroes */
ee472d83 1296
e73c23ff
CK
1297extern int __blkdev_issue_zeroout(struct block_device *bdev, sector_t sector,
1298 sector_t nr_sects, gfp_t gfp_mask, struct bio **biop,
ee472d83 1299 unsigned flags);
3f14d792 1300extern int blkdev_issue_zeroout(struct block_device *bdev, sector_t sector,
ee472d83
CH
1301 sector_t nr_sects, gfp_t gfp_mask, unsigned flags);
1302
2cf6d26a
CH
1303static inline int sb_issue_discard(struct super_block *sb, sector_t block,
1304 sector_t nr_blocks, gfp_t gfp_mask, unsigned long flags)
fb2dce86 1305{
233bde21
BVA
1306 return blkdev_issue_discard(sb->s_bdev,
1307 block << (sb->s_blocksize_bits -
1308 SECTOR_SHIFT),
1309 nr_blocks << (sb->s_blocksize_bits -
1310 SECTOR_SHIFT),
2cf6d26a 1311 gfp_mask, flags);
fb2dce86 1312}
e6fa0be6 1313static inline int sb_issue_zeroout(struct super_block *sb, sector_t block,
a107e5a3 1314 sector_t nr_blocks, gfp_t gfp_mask)
e6fa0be6
LC
1315{
1316 return blkdev_issue_zeroout(sb->s_bdev,
233bde21
BVA
1317 block << (sb->s_blocksize_bits -
1318 SECTOR_SHIFT),
1319 nr_blocks << (sb->s_blocksize_bits -
1320 SECTOR_SHIFT),
ee472d83 1321 gfp_mask, 0);
e6fa0be6 1322}
1da177e4 1323
fa01b1e9
CH
1324static inline bool bdev_is_partition(struct block_device *bdev)
1325{
1326 return bdev->bd_partno;
1327}
1328
eb28d31b
MP
1329enum blk_default_limits {
1330 BLK_MAX_SEGMENTS = 128,
1331 BLK_SAFE_MAX_SECTORS = 255,
d2be537c 1332 BLK_DEF_MAX_SECTORS = 2560,
eb28d31b
MP
1333 BLK_MAX_SEGMENT_SIZE = 65536,
1334 BLK_SEG_BOUNDARY_MASK = 0xFFFFFFFFUL,
1335};
0e435ac2 1336
af2c68fe 1337static inline unsigned long queue_segment_boundary(const struct request_queue *q)
ae03bf63 1338{
025146e1 1339 return q->limits.seg_boundary_mask;
ae03bf63
MP
1340}
1341
af2c68fe 1342static inline unsigned long queue_virt_boundary(const struct request_queue *q)
03100aad
KB
1343{
1344 return q->limits.virt_boundary_mask;
1345}
1346
af2c68fe 1347static inline unsigned int queue_max_sectors(const struct request_queue *q)
ae03bf63 1348{
025146e1 1349 return q->limits.max_sectors;
ae03bf63
MP
1350}
1351
547e2f70
CH
1352static inline unsigned int queue_max_bytes(struct request_queue *q)
1353{
1354 return min_t(unsigned int, queue_max_sectors(q), INT_MAX >> 9) << 9;
1355}
1356
af2c68fe 1357static inline unsigned int queue_max_hw_sectors(const struct request_queue *q)
ae03bf63 1358{
025146e1 1359 return q->limits.max_hw_sectors;
ae03bf63
MP
1360}
1361
af2c68fe 1362static inline unsigned short queue_max_segments(const struct request_queue *q)
ae03bf63 1363{
8a78362c 1364 return q->limits.max_segments;
ae03bf63
MP
1365}
1366
af2c68fe 1367static inline unsigned short queue_max_discard_segments(const struct request_queue *q)
1e739730
CH
1368{
1369 return q->limits.max_discard_segments;
1370}
1371
af2c68fe 1372static inline unsigned int queue_max_segment_size(const struct request_queue *q)
ae03bf63 1373{
025146e1 1374 return q->limits.max_segment_size;
ae03bf63
MP
1375}
1376
0512a75b
KB
1377static inline unsigned int queue_max_zone_append_sectors(const struct request_queue *q)
1378{
fe6f0cdc
JT
1379
1380 const struct queue_limits *l = &q->limits;
1381
1382 return min(l->max_zone_append_sectors, l->max_sectors);
0512a75b
KB
1383}
1384
ad6bf88a 1385static inline unsigned queue_logical_block_size(const struct request_queue *q)
1da177e4
LT
1386{
1387 int retval = 512;
1388
025146e1
MP
1389 if (q && q->limits.logical_block_size)
1390 retval = q->limits.logical_block_size;
1da177e4
LT
1391
1392 return retval;
1393}
1394
ad6bf88a 1395static inline unsigned int bdev_logical_block_size(struct block_device *bdev)
1da177e4 1396{
e1defc4f 1397 return queue_logical_block_size(bdev_get_queue(bdev));
1da177e4
LT
1398}
1399
af2c68fe 1400static inline unsigned int queue_physical_block_size(const struct request_queue *q)
c72758f3
MP
1401{
1402 return q->limits.physical_block_size;
1403}
1404
892b6f90 1405static inline unsigned int bdev_physical_block_size(struct block_device *bdev)
ac481c20
MP
1406{
1407 return queue_physical_block_size(bdev_get_queue(bdev));
1408}
1409
af2c68fe 1410static inline unsigned int queue_io_min(const struct request_queue *q)
c72758f3
MP
1411{
1412 return q->limits.io_min;
1413}
1414
ac481c20
MP
1415static inline int bdev_io_min(struct block_device *bdev)
1416{
1417 return queue_io_min(bdev_get_queue(bdev));
1418}
1419
af2c68fe 1420static inline unsigned int queue_io_opt(const struct request_queue *q)
c72758f3
MP
1421{
1422 return q->limits.io_opt;
1423}
1424
ac481c20
MP
1425static inline int bdev_io_opt(struct block_device *bdev)
1426{
1427 return queue_io_opt(bdev_get_queue(bdev));
1428}
1429
a805a4fa
DLM
1430static inline unsigned int
1431queue_zone_write_granularity(const struct request_queue *q)
1432{
1433 return q->limits.zone_write_granularity;
1434}
1435
1436static inline unsigned int
1437bdev_zone_write_granularity(struct block_device *bdev)
1438{
1439 return queue_zone_write_granularity(bdev_get_queue(bdev));
1440}
1441
af2c68fe 1442static inline int queue_alignment_offset(const struct request_queue *q)
c72758f3 1443{
ac481c20 1444 if (q->limits.misaligned)
c72758f3
MP
1445 return -1;
1446
ac481c20 1447 return q->limits.alignment_offset;
c72758f3
MP
1448}
1449
e03a72e1 1450static inline int queue_limit_alignment_offset(struct queue_limits *lim, sector_t sector)
81744ee4
MP
1451{
1452 unsigned int granularity = max(lim->physical_block_size, lim->io_min);
233bde21
BVA
1453 unsigned int alignment = sector_div(sector, granularity >> SECTOR_SHIFT)
1454 << SECTOR_SHIFT;
81744ee4 1455
b8839b8c 1456 return (granularity + lim->alignment_offset - alignment) % granularity;
c72758f3
MP
1457}
1458
ac481c20
MP
1459static inline int bdev_alignment_offset(struct block_device *bdev)
1460{
1461 struct request_queue *q = bdev_get_queue(bdev);
1462
1463 if (q->limits.misaligned)
1464 return -1;
fa01b1e9 1465 if (bdev_is_partition(bdev))
7b8917f5 1466 return queue_limit_alignment_offset(&q->limits,
29ff57c6 1467 bdev->bd_start_sect);
ac481c20
MP
1468 return q->limits.alignment_offset;
1469}
1470
af2c68fe 1471static inline int queue_discard_alignment(const struct request_queue *q)
86b37281
MP
1472{
1473 if (q->limits.discard_misaligned)
1474 return -1;
1475
1476 return q->limits.discard_alignment;
1477}
1478
e03a72e1 1479static inline int queue_limit_discard_alignment(struct queue_limits *lim, sector_t sector)
86b37281 1480{
59771079 1481 unsigned int alignment, granularity, offset;
dd3d145d 1482
a934a00a
MP
1483 if (!lim->max_discard_sectors)
1484 return 0;
1485
59771079 1486 /* Why are these in bytes, not sectors? */
233bde21
BVA
1487 alignment = lim->discard_alignment >> SECTOR_SHIFT;
1488 granularity = lim->discard_granularity >> SECTOR_SHIFT;
59771079
LT
1489 if (!granularity)
1490 return 0;
1491
1492 /* Offset of the partition start in 'granularity' sectors */
1493 offset = sector_div(sector, granularity);
1494
1495 /* And why do we do this modulus *again* in blkdev_issue_discard()? */
1496 offset = (granularity + alignment - offset) % granularity;
1497
1498 /* Turn it back into bytes, gaah */
233bde21 1499 return offset << SECTOR_SHIFT;
86b37281
MP
1500}
1501
866663b7
ML
1502/*
1503 * Two cases of handling DISCARD merge:
1504 * If max_discard_segments > 1, the driver takes every bio
1505 * as a range and send them to controller together. The ranges
1506 * needn't to be contiguous.
1507 * Otherwise, the bios/requests will be handled as same as
1508 * others which should be contiguous.
1509 */
1510static inline bool blk_discard_mergable(struct request *req)
1511{
1512 if (req_op(req) == REQ_OP_DISCARD &&
1513 queue_max_discard_segments(req->q) > 1)
1514 return true;
1515 return false;
1516}
1517
c6e66634
PB
1518static inline int bdev_discard_alignment(struct block_device *bdev)
1519{
1520 struct request_queue *q = bdev_get_queue(bdev);
1521
fa01b1e9 1522 if (bdev_is_partition(bdev))
7cf34d97 1523 return queue_limit_discard_alignment(&q->limits,
29ff57c6 1524 bdev->bd_start_sect);
c6e66634
PB
1525 return q->limits.discard_alignment;
1526}
1527
4363ac7c
MP
1528static inline unsigned int bdev_write_same(struct block_device *bdev)
1529{
1530 struct request_queue *q = bdev_get_queue(bdev);
1531
1532 if (q)
1533 return q->limits.max_write_same_sectors;
1534
1535 return 0;
1536}
1537
a6f0788e
CK
1538static inline unsigned int bdev_write_zeroes_sectors(struct block_device *bdev)
1539{
1540 struct request_queue *q = bdev_get_queue(bdev);
1541
1542 if (q)
1543 return q->limits.max_write_zeroes_sectors;
1544
1545 return 0;
1546}
1547
797476b8
DLM
1548static inline enum blk_zoned_model bdev_zoned_model(struct block_device *bdev)
1549{
1550 struct request_queue *q = bdev_get_queue(bdev);
1551
1552 if (q)
1553 return blk_queue_zoned_model(q);
1554
1555 return BLK_ZONED_NONE;
1556}
1557
1558static inline bool bdev_is_zoned(struct block_device *bdev)
1559{
1560 struct request_queue *q = bdev_get_queue(bdev);
1561
1562 if (q)
1563 return blk_queue_is_zoned(q);
1564
1565 return false;
1566}
1567
113ab72e 1568static inline sector_t bdev_zone_sectors(struct block_device *bdev)
6a0cb1bc
HR
1569{
1570 struct request_queue *q = bdev_get_queue(bdev);
1571
1572 if (q)
f99e8648 1573 return blk_queue_zone_sectors(q);
6cc77e9c
CH
1574 return 0;
1575}
6a0cb1bc 1576
e15864f8
NC
1577static inline unsigned int bdev_max_open_zones(struct block_device *bdev)
1578{
1579 struct request_queue *q = bdev_get_queue(bdev);
1580
1581 if (q)
1582 return queue_max_open_zones(q);
1583 return 0;
1584}
1585
659bf827
NC
1586static inline unsigned int bdev_max_active_zones(struct block_device *bdev)
1587{
1588 struct request_queue *q = bdev_get_queue(bdev);
1589
1590 if (q)
1591 return queue_max_active_zones(q);
1592 return 0;
1593}
1594
af2c68fe 1595static inline int queue_dma_alignment(const struct request_queue *q)
1da177e4 1596{
482eb689 1597 return q ? q->dma_alignment : 511;
1da177e4
LT
1598}
1599
14417799 1600static inline int blk_rq_aligned(struct request_queue *q, unsigned long addr,
87904074
FT
1601 unsigned int len)
1602{
1603 unsigned int alignment = queue_dma_alignment(q) | q->dma_pad_mask;
14417799 1604 return !(addr & alignment) && !(len & alignment);
87904074
FT
1605}
1606
1da177e4
LT
1607/* assumes size > 256 */
1608static inline unsigned int blksize_bits(unsigned int size)
1609{
1610 unsigned int bits = 8;
1611 do {
1612 bits++;
1613 size >>= 1;
1614 } while (size > 256);
1615 return bits;
1616}
1617
2befb9e3 1618static inline unsigned int block_size(struct block_device *bdev)
1da177e4 1619{
6b7b181b 1620 return 1 << bdev->bd_inode->i_blkbits;
1da177e4
LT
1621}
1622
59c3d45e 1623int kblockd_schedule_work(struct work_struct *work);
818cd1cb 1624int kblockd_mod_delayed_work_on(int cpu, struct delayed_work *dwork, unsigned long delay);
1da177e4 1625
1da177e4
LT
1626#define MODULE_ALIAS_BLOCKDEV(major,minor) \
1627 MODULE_ALIAS("block-major-" __stringify(major) "-" __stringify(minor))
1628#define MODULE_ALIAS_BLOCKDEV_MAJOR(major) \
1629 MODULE_ALIAS("block-major-" __stringify(major) "-*")
1630
7ba1ba12
MP
1631#if defined(CONFIG_BLK_DEV_INTEGRITY)
1632
8288f496
MP
1633enum blk_integrity_flags {
1634 BLK_INTEGRITY_VERIFY = 1 << 0,
1635 BLK_INTEGRITY_GENERATE = 1 << 1,
3aec2f41 1636 BLK_INTEGRITY_DEVICE_CAPABLE = 1 << 2,
aae7df50 1637 BLK_INTEGRITY_IP_CHECKSUM = 1 << 3,
8288f496 1638};
7ba1ba12 1639
18593088 1640struct blk_integrity_iter {
7ba1ba12
MP
1641 void *prot_buf;
1642 void *data_buf;
3be91c4a 1643 sector_t seed;
7ba1ba12 1644 unsigned int data_size;
3be91c4a 1645 unsigned short interval;
7ba1ba12
MP
1646 const char *disk_name;
1647};
1648
4e4cbee9 1649typedef blk_status_t (integrity_processing_fn) (struct blk_integrity_iter *);
54d4e6ab
MG
1650typedef void (integrity_prepare_fn) (struct request *);
1651typedef void (integrity_complete_fn) (struct request *, unsigned int);
7ba1ba12 1652
0f8087ec
MP
1653struct blk_integrity_profile {
1654 integrity_processing_fn *generate_fn;
1655 integrity_processing_fn *verify_fn;
54d4e6ab
MG
1656 integrity_prepare_fn *prepare_fn;
1657 integrity_complete_fn *complete_fn;
0f8087ec
MP
1658 const char *name;
1659};
7ba1ba12 1660
25520d55 1661extern void blk_integrity_register(struct gendisk *, struct blk_integrity *);
7ba1ba12 1662extern void blk_integrity_unregister(struct gendisk *);
ad7fce93 1663extern int blk_integrity_compare(struct gendisk *, struct gendisk *);
13f05c8d
MP
1664extern int blk_rq_map_integrity_sg(struct request_queue *, struct bio *,
1665 struct scatterlist *);
1666extern int blk_rq_count_integrity_sg(struct request_queue *, struct bio *);
7ba1ba12 1667
25520d55 1668static inline struct blk_integrity *blk_get_integrity(struct gendisk *disk)
b04accc4 1669{
ac6fc48c 1670 struct blk_integrity *bi = &disk->queue->integrity;
25520d55
MP
1671
1672 if (!bi->profile)
1673 return NULL;
1674
1675 return bi;
b04accc4
JA
1676}
1677
25520d55
MP
1678static inline
1679struct blk_integrity *bdev_get_integrity(struct block_device *bdev)
b02739b0 1680{
25520d55 1681 return blk_get_integrity(bdev->bd_disk);
b02739b0
MP
1682}
1683
d145dc23
ST
1684static inline bool
1685blk_integrity_queue_supports_integrity(struct request_queue *q)
1686{
1687 return q->integrity.profile;
1688}
1689
180b2f95 1690static inline bool blk_integrity_rq(struct request *rq)
7ba1ba12 1691{
180b2f95 1692 return rq->cmd_flags & REQ_INTEGRITY;
7ba1ba12
MP
1693}
1694
13f05c8d
MP
1695static inline void blk_queue_max_integrity_segments(struct request_queue *q,
1696 unsigned int segs)
1697{
1698 q->limits.max_integrity_segments = segs;
1699}
1700
1701static inline unsigned short
af2c68fe 1702queue_max_integrity_segments(const struct request_queue *q)
13f05c8d
MP
1703{
1704 return q->limits.max_integrity_segments;
1705}
1706
359f6427
GE
1707/**
1708 * bio_integrity_intervals - Return number of integrity intervals for a bio
1709 * @bi: blk_integrity profile for device
1710 * @sectors: Size of the bio in 512-byte sectors
1711 *
1712 * Description: The block layer calculates everything in 512 byte
1713 * sectors but integrity metadata is done in terms of the data integrity
1714 * interval size of the storage device. Convert the block layer sectors
1715 * to the appropriate number of integrity intervals.
1716 */
1717static inline unsigned int bio_integrity_intervals(struct blk_integrity *bi,
1718 unsigned int sectors)
1719{
1720 return sectors >> (bi->interval_exp - 9);
1721}
1722
1723static inline unsigned int bio_integrity_bytes(struct blk_integrity *bi,
1724 unsigned int sectors)
1725{
1726 return bio_integrity_intervals(bi, sectors) * bi->tuple_size;
1727}
1728
2a876f5e
CH
1729/*
1730 * Return the first bvec that contains integrity data. Only drivers that are
1731 * limited to a single integrity segment should use this helper.
1732 */
1733static inline struct bio_vec *rq_integrity_vec(struct request *rq)
1734{
1735 if (WARN_ON_ONCE(queue_max_integrity_segments(rq->q) > 1))
1736 return NULL;
1737 return rq->bio->bi_integrity->bip_vec;
1738}
1739
7ba1ba12
MP
1740#else /* CONFIG_BLK_DEV_INTEGRITY */
1741
fd83240a
SR
1742struct bio;
1743struct block_device;
1744struct gendisk;
1745struct blk_integrity;
1746
1747static inline int blk_integrity_rq(struct request *rq)
1748{
1749 return 0;
1750}
1751static inline int blk_rq_count_integrity_sg(struct request_queue *q,
1752 struct bio *b)
1753{
1754 return 0;
1755}
1756static inline int blk_rq_map_integrity_sg(struct request_queue *q,
1757 struct bio *b,
1758 struct scatterlist *s)
1759{
1760 return 0;
1761}
1762static inline struct blk_integrity *bdev_get_integrity(struct block_device *b)
1763{
61a04e5b 1764 return NULL;
fd83240a
SR
1765}
1766static inline struct blk_integrity *blk_get_integrity(struct gendisk *disk)
1767{
1768 return NULL;
1769}
d145dc23
ST
1770static inline bool
1771blk_integrity_queue_supports_integrity(struct request_queue *q)
1772{
1773 return false;
1774}
fd83240a
SR
1775static inline int blk_integrity_compare(struct gendisk *a, struct gendisk *b)
1776{
1777 return 0;
1778}
25520d55 1779static inline void blk_integrity_register(struct gendisk *d,
fd83240a
SR
1780 struct blk_integrity *b)
1781{
fd83240a
SR
1782}
1783static inline void blk_integrity_unregister(struct gendisk *d)
1784{
1785}
1786static inline void blk_queue_max_integrity_segments(struct request_queue *q,
1787 unsigned int segs)
1788{
1789}
af2c68fe 1790static inline unsigned short queue_max_integrity_segments(const struct request_queue *q)
fd83240a
SR
1791{
1792 return 0;
1793}
25520d55 1794
359f6427
GE
1795static inline unsigned int bio_integrity_intervals(struct blk_integrity *bi,
1796 unsigned int sectors)
1797{
1798 return 0;
1799}
1800
1801static inline unsigned int bio_integrity_bytes(struct blk_integrity *bi,
1802 unsigned int sectors)
1803{
1804 return 0;
1805}
1806
2a876f5e
CH
1807static inline struct bio_vec *rq_integrity_vec(struct request *rq)
1808{
1809 return NULL;
1810}
1811
7ba1ba12
MP
1812#endif /* CONFIG_BLK_DEV_INTEGRITY */
1813
d145dc23
ST
1814#ifdef CONFIG_BLK_INLINE_ENCRYPTION
1815
1816bool blk_ksm_register(struct blk_keyslot_manager *ksm, struct request_queue *q);
1817
1818void blk_ksm_unregister(struct request_queue *q);
1819
1820#else /* CONFIG_BLK_INLINE_ENCRYPTION */
1821
1822static inline bool blk_ksm_register(struct blk_keyslot_manager *ksm,
1823 struct request_queue *q)
1824{
1825 return true;
1826}
1827
1828static inline void blk_ksm_unregister(struct request_queue *q) { }
1829
1830#endif /* CONFIG_BLK_INLINE_ENCRYPTION */
1831
1832
08f85851 1833struct block_device_operations {
c62b37d9 1834 blk_qc_t (*submit_bio) (struct bio *bio);
d4430d62 1835 int (*open) (struct block_device *, fmode_t);
db2a144b 1836 void (*release) (struct gendisk *, fmode_t);
3f289dcb 1837 int (*rw_page)(struct block_device *, sector_t, struct page *, unsigned int);
d4430d62
AV
1838 int (*ioctl) (struct block_device *, fmode_t, unsigned, unsigned long);
1839 int (*compat_ioctl) (struct block_device *, fmode_t, unsigned, unsigned long);
77ea887e
TH
1840 unsigned int (*check_events) (struct gendisk *disk,
1841 unsigned int clearing);
c3e33e04 1842 void (*unlock_native_capacity) (struct gendisk *);
08f85851 1843 int (*getgeo)(struct block_device *, struct hd_geometry *);
e00adcad 1844 int (*set_read_only)(struct block_device *bdev, bool ro);
b3a27d05
NG
1845 /* this callback is with swap_lock and sometimes page table lock held */
1846 void (*swap_slot_free_notify) (struct block_device *, unsigned long);
e76239a3 1847 int (*report_zones)(struct gendisk *, sector_t sector,
d4100351 1848 unsigned int nr_zones, report_zones_cb cb, void *data);
348e114b 1849 char *(*devnode)(struct gendisk *disk, umode_t *mode);
08f85851 1850 struct module *owner;
bbd3e064 1851 const struct pr_ops *pr_ops;
0bdfbca8
DO
1852
1853 /*
1854 * Special callback for probing GPT entry at a given sector.
1855 * Needed by Android devices, used by GPT scanner and MMC blk
1856 * driver.
1857 */
1858 int (*alternative_gpt_sector)(struct gendisk *disk, sector_t *sector);
08f85851
AV
1859};
1860
ee6a129d
AB
1861#ifdef CONFIG_COMPAT
1862extern int blkdev_compat_ptr_ioctl(struct block_device *, fmode_t,
1863 unsigned int, unsigned long);
1864#else
1865#define blkdev_compat_ptr_ioctl NULL
1866#endif
1867
47a191fd
MW
1868extern int bdev_read_page(struct block_device *, sector_t, struct page *);
1869extern int bdev_write_page(struct block_device *, sector_t, struct page *,
1870 struct writeback_control *);
6cc77e9c
CH
1871
1872#ifdef CONFIG_BLK_DEV_ZONED
1873bool blk_req_needs_zone_write_lock(struct request *rq);
1392d370 1874bool blk_req_zone_write_trylock(struct request *rq);
6cc77e9c
CH
1875void __blk_req_zone_write_lock(struct request *rq);
1876void __blk_req_zone_write_unlock(struct request *rq);
1877
1878static inline void blk_req_zone_write_lock(struct request *rq)
1879{
1880 if (blk_req_needs_zone_write_lock(rq))
1881 __blk_req_zone_write_lock(rq);
1882}
1883
1884static inline void blk_req_zone_write_unlock(struct request *rq)
1885{
1886 if (rq->rq_flags & RQF_ZONE_WRITE_LOCKED)
1887 __blk_req_zone_write_unlock(rq);
1888}
1889
1890static inline bool blk_req_zone_is_write_locked(struct request *rq)
1891{
1892 return rq->q->seq_zones_wlock &&
1893 test_bit(blk_rq_zone_no(rq), rq->q->seq_zones_wlock);
1894}
1895
1896static inline bool blk_req_can_dispatch_to_zone(struct request *rq)
1897{
1898 if (!blk_req_needs_zone_write_lock(rq))
1899 return true;
1900 return !blk_req_zone_is_write_locked(rq);
1901}
1902#else
1903static inline bool blk_req_needs_zone_write_lock(struct request *rq)
1904{
1905 return false;
1906}
1907
1908static inline void blk_req_zone_write_lock(struct request *rq)
1909{
1910}
1911
1912static inline void blk_req_zone_write_unlock(struct request *rq)
1913{
1914}
1915static inline bool blk_req_zone_is_write_locked(struct request *rq)
1916{
1917 return false;
1918}
1919
1920static inline bool blk_req_can_dispatch_to_zone(struct request *rq)
1921{
1922 return true;
1923}
1924#endif /* CONFIG_BLK_DEV_ZONED */
1925
0619317f
JA
1926static inline void blk_wake_io_task(struct task_struct *waiter)
1927{
1928 /*
1929 * If we're polling, the task itself is doing the completions. For
1930 * that case, we don't need to signal a wakeup, it's enough to just
1931 * mark us as RUNNING.
1932 */
1933 if (waiter == current)
1934 __set_current_state(TASK_RUNNING);
1935 else
1936 wake_up_process(waiter);
1937}
1938
956d510e
CH
1939unsigned long disk_start_io_acct(struct gendisk *disk, unsigned int sectors,
1940 unsigned int op);
1941void disk_end_io_acct(struct gendisk *disk, unsigned int op,
1942 unsigned long start_time);
1943
99dfc43e
CH
1944unsigned long bio_start_io_acct(struct bio *bio);
1945void bio_end_io_acct_remapped(struct bio *bio, unsigned long start_time,
1946 struct block_device *orig_bdev);
956d510e
CH
1947
1948/**
1949 * bio_end_io_acct - end I/O accounting for bio based drivers
1950 * @bio: bio to end account for
1951 * @start: start time returned by bio_start_io_acct()
1952 */
1953static inline void bio_end_io_acct(struct bio *bio, unsigned long start_time)
1954{
99dfc43e 1955 return bio_end_io_acct_remapped(bio, start_time, bio->bi_bdev);
956d510e 1956}
956d510e 1957
3f1266f1
CH
1958int bdev_read_only(struct block_device *bdev);
1959int set_blocksize(struct block_device *bdev, int size);
1960
1961const char *bdevname(struct block_device *bdev, char *buffer);
4e7b5671 1962int lookup_bdev(const char *pathname, dev_t *dev);
3f1266f1
CH
1963
1964void blkdev_show(struct seq_file *seqf, off_t offset);
1965
1966#define BDEVNAME_SIZE 32 /* Largest string for a blockdev identifier */
1967#define BDEVT_SIZE 10 /* Largest string for MAJ:MIN for blkdev */
1968#ifdef CONFIG_BLOCK
1969#define BLKDEV_MAJOR_MAX 512
1970#else
1971#define BLKDEV_MAJOR_MAX 0
1972#endif
1973
3f1266f1
CH
1974struct block_device *blkdev_get_by_path(const char *path, fmode_t mode,
1975 void *holder);
1976struct block_device *blkdev_get_by_dev(dev_t dev, fmode_t mode, void *holder);
37c3fc9a
CH
1977int bd_prepare_to_claim(struct block_device *bdev, void *holder);
1978void bd_abort_claiming(struct block_device *bdev, void *holder);
3f1266f1
CH
1979void blkdev_put(struct block_device *bdev, fmode_t mode);
1980
22ae8ce8
CH
1981/* just for blk-cgroup, don't use elsewhere */
1982struct block_device *blkdev_get_no_open(dev_t dev);
1983void blkdev_put_no_open(struct block_device *bdev);
1984
1985struct block_device *bdev_alloc(struct gendisk *disk, u8 partno);
1986void bdev_add(struct block_device *bdev, dev_t dev);
621c1f42 1987struct block_device *I_BDEV(struct inode *inode);
2c2b9fd6
CH
1988int truncate_bdev_range(struct block_device *bdev, fmode_t mode, loff_t lstart,
1989 loff_t lend);
3f1266f1
CH
1990
1991#ifdef CONFIG_BLOCK
1992void invalidate_bdev(struct block_device *bdev);
1993int sync_blockdev(struct block_device *bdev);
1994#else
1995static inline void invalidate_bdev(struct block_device *bdev)
1996{
1997}
1998static inline int sync_blockdev(struct block_device *bdev)
1999{
2000 return 0;
2001}
1da177e4 2002#endif
3f1266f1
CH
2003int fsync_bdev(struct block_device *bdev);
2004
040f04bd
CH
2005int freeze_bdev(struct block_device *bdev);
2006int thaw_bdev(struct block_device *bdev);
3f1266f1
CH
2007
2008#endif /* _LINUX_BLKDEV_H */