block: decouple blk_set_stacking_limits from blk_set_default_limits
[linux-block.git] / include / linux / blkdev.h
CommitLineData
b2441318 1/* SPDX-License-Identifier: GPL-2.0 */
322cbb50
CH
2/*
3 * Portions Copyright (C) 1992 Drew Eckhardt
4 */
1da177e4
LT
5#ifndef _LINUX_BLKDEV_H
6#define _LINUX_BLKDEV_H
7
322cbb50
CH
8#include <linux/types.h>
9#include <linux/blk_types.h>
10#include <linux/device.h>
1da177e4 11#include <linux/list.h>
320ae51f 12#include <linux/llist.h>
b296a6d5 13#include <linux/minmax.h>
1da177e4
LT
14#include <linux/timer.h>
15#include <linux/workqueue.h>
1da177e4 16#include <linux/wait.h>
1da177e4 17#include <linux/bio.h>
3e6053d7 18#include <linux/gfp.h>
322cbb50 19#include <linux/kdev_t.h>
548bc8e1 20#include <linux/rcupdate.h>
add703fd 21#include <linux/percpu-refcount.h>
6a0cb1bc 22#include <linux/blkzoned.h>
322cbb50 23#include <linux/sched.h>
d97e594c 24#include <linux/sbitmap.h>
322cbb50
CH
25#include <linux/uuid.h>
26#include <linux/xarray.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;
3e08773c 36struct kiocb;
bbd3e064 37struct pr_ops;
a7905043 38struct rq_qos;
34dbad5d
OS
39struct blk_queue_stats;
40struct blk_stat_callback;
cb77cb5a 41struct blk_crypto_profile;
1da177e4 42
322cbb50 43extern const struct device_type disk_type;
cdb37f73 44extern const struct device_type part_type;
322cbb50
CH
45extern struct class block_class;
46
8bd435b3
TH
47/*
48 * Maximum number of blkcg policies allowed to be registered concurrently.
49 * Defined here to simplify include dependency.
50 */
ec645dc9 51#define BLKCG_MAX_POLS 6
8bd435b3 52
322cbb50
CH
53#define DISK_MAX_PARTS 256
54#define DISK_NAME_LEN 32
55
56#define PARTITION_META_INFO_VOLNAMELTH 64
57/*
58 * Enough for the string representation of any kind of UUID plus NULL.
59 * EFI UUID is 36 characters. MSDOS UUID is 11 characters.
60 */
61#define PARTITION_META_INFO_UUIDLTH (UUID_STRING_LEN + 1)
62
63struct partition_meta_info {
64 char uuid[PARTITION_META_INFO_UUIDLTH];
65 u8 volname[PARTITION_META_INFO_VOLNAMELTH];
66};
67
68/**
69 * DOC: genhd capability flags
70 *
71 * ``GENHD_FL_REMOVABLE``: indicates that the block device gives access to
72 * removable media. When set, the device remains present even when media is not
73 * inserted. Shall not be set for devices which are removed entirely when the
74 * media is removed.
75 *
76 * ``GENHD_FL_HIDDEN``: the block device is hidden; it doesn't produce events,
77 * doesn't appear in sysfs, and can't be opened from userspace or using
78 * blkdev_get*. Used for the underlying components of multipath devices.
79 *
80 * ``GENHD_FL_NO_PART``: partition support is disabled. The kernel will not
81 * scan for partitions from add_disk, and users can't add partitions manually.
82 *
83 */
84enum {
85 GENHD_FL_REMOVABLE = 1 << 0,
86 GENHD_FL_HIDDEN = 1 << 1,
87 GENHD_FL_NO_PART = 1 << 2,
88};
89
90enum {
91 DISK_EVENT_MEDIA_CHANGE = 1 << 0, /* media changed */
92 DISK_EVENT_EJECT_REQUEST = 1 << 1, /* eject requested */
93};
94
95enum {
96 /* Poll even if events_poll_msecs is unset */
97 DISK_EVENT_FLAG_POLL = 1 << 0,
98 /* Forward events to udev */
99 DISK_EVENT_FLAG_UEVENT = 1 << 1,
100 /* Block event polling when open for exclusive write */
101 DISK_EVENT_FLAG_BLOCK_ON_EXCL_WRITE = 1 << 2,
102};
103
104struct disk_events;
105struct badblocks;
106
107struct blk_integrity {
108 const struct blk_integrity_profile *profile;
109 unsigned char flags;
110 unsigned char tuple_size;
60d21aac 111 unsigned char pi_offset;
322cbb50
CH
112 unsigned char interval_exp;
113 unsigned char tag_size;
114};
115
05bdb996
CH
116typedef unsigned int __bitwise blk_mode_t;
117
118/* open for reading */
119#define BLK_OPEN_READ ((__force blk_mode_t)(1 << 0))
120/* open for writing */
121#define BLK_OPEN_WRITE ((__force blk_mode_t)(1 << 1))
122/* open exclusively (vs other exclusive openers */
123#define BLK_OPEN_EXCL ((__force blk_mode_t)(1 << 2))
124/* opened with O_NDELAY */
125#define BLK_OPEN_NDELAY ((__force blk_mode_t)(1 << 3))
126/* open for "writes" only for ioctls (specialy hack for floppy.c) */
127#define BLK_OPEN_WRITE_IOCTL ((__force blk_mode_t)(1 << 4))
ed5cc702
JK
128/* open is exclusive wrt all other BLK_OPEN_WRITE opens to the device */
129#define BLK_OPEN_RESTRICT_WRITES ((__force blk_mode_t)(1 << 5))
05bdb996 130
322cbb50
CH
131struct gendisk {
132 /*
133 * major/first_minor/minors should not be set by any new driver, the
134 * block core will take care of allocating them automatically.
135 */
136 int major;
137 int first_minor;
138 int minors;
139
140 char disk_name[DISK_NAME_LEN]; /* name of major driver */
141
142 unsigned short events; /* supported events */
143 unsigned short event_flags; /* flags related to event processing */
144
145 struct xarray part_tbl;
146 struct block_device *part0;
147
148 const struct block_device_operations *fops;
149 struct request_queue *queue;
150 void *private_data;
151
46754bd0
CH
152 struct bio_set bio_split;
153
322cbb50
CH
154 int flags;
155 unsigned long state;
156#define GD_NEED_PART_SCAN 0
157#define GD_READ_ONLY 1
158#define GD_DEAD 2
159#define GD_NATIVE_CAPACITY 3
76792055 160#define GD_ADDED 4
b9684a71 161#define GD_SUPPRESS_PART_SCAN 5
6f8191fd 162#define GD_OWNS_QUEUE 6
322cbb50
CH
163
164 struct mutex open_mutex; /* open/close mutex */
165 unsigned open_partitions; /* number of open partitions */
166
167 struct backing_dev_info *bdi;
2bd85221 168 struct kobject queue_kobj; /* the queue/ directory */
322cbb50
CH
169 struct kobject *slave_dir;
170#ifdef CONFIG_BLOCK_HOLDER_DEPRECATED
171 struct list_head slave_bdevs;
172#endif
173 struct timer_rand_state *random;
174 atomic_t sync_io; /* RAID */
175 struct disk_events *ev;
d86e716a
CH
176
177#ifdef CONFIG_BLK_DEV_ZONED
178 /*
179 * Zoned block device information for request dispatch control.
180 * nr_zones is the total number of zones of the device. This is always
181 * 0 for regular block devices. conv_zones_bitmap is a bitmap of nr_zones
182 * bits which indicates if a zone is conventional (bit set) or
183 * sequential (bit clear). seq_zones_wlock is a bitmap of nr_zones
184 * bits which indicates if a zone is write locked, that is, if a write
185 * request targeting the zone was dispatched.
186 *
187 * Reads of this information must be protected with blk_queue_enter() /
188 * blk_queue_exit(). Modifying this information is only allowed while
189 * no requests are being processed. See also blk_mq_freeze_queue() and
190 * blk_mq_unfreeze_queue().
191 */
192 unsigned int nr_zones;
d86e716a
CH
193 unsigned long *conv_zones_bitmap;
194 unsigned long *seq_zones_wlock;
195#endif /* CONFIG_BLK_DEV_ZONED */
196
322cbb50
CH
197#if IS_ENABLED(CONFIG_CDROM)
198 struct cdrom_device_info *cdi;
199#endif
200 int node_id;
201 struct badblocks *bb;
202 struct lockdep_map lockdep_map;
203 u64 diskseq;
05bdb996 204 blk_mode_t open_mode;
6a27d28c
CH
205
206 /*
207 * Independent sector access ranges. This is always NULL for
208 * devices that do not have multiple independent access ranges.
209 */
210 struct blk_independent_access_ranges *ia_ranges;
322cbb50
CH
211};
212
213static inline bool disk_live(struct gendisk *disk)
214{
215 return !inode_unhashed(disk->part0->bd_inode);
216}
217
dbdc1be3
CH
218/**
219 * disk_openers - returns how many openers are there for a disk
220 * @disk: disk to check
221 *
222 * This returns the number of openers for a disk. Note that this value is only
223 * stable if disk->open_mutex is held.
224 *
225 * Note: Due to a quirk in the block layer open code, each open partition is
226 * only counted once even if there are multiple openers.
227 */
228static inline unsigned int disk_openers(struct gendisk *disk)
229{
9acf381f 230 return atomic_read(&disk->part0->bd_openers);
dbdc1be3
CH
231}
232
322cbb50
CH
233/*
234 * The gendisk is refcounted by the part0 block_device, and the bd_device
235 * therein is also used for device model presentation in sysfs.
236 */
237#define dev_to_disk(device) \
238 (dev_to_bdev(device)->bd_disk)
239#define disk_to_dev(disk) \
240 (&((disk)->part0->bd_device))
241
242#if IS_REACHABLE(CONFIG_CDROM)
243#define disk_to_cdi(disk) ((disk)->cdi)
244#else
245#define disk_to_cdi(disk) NULL
246#endif
247
248static inline dev_t disk_devt(struct gendisk *disk)
249{
250 return MKDEV(disk->major, disk->first_minor);
251}
252
37ae5a0f 253static inline int blk_validate_block_size(unsigned long bsize)
570b1cac
XY
254{
255 if (bsize < 512 || bsize > PAGE_SIZE || !is_power_of_2(bsize))
256 return -EINVAL;
257
258 return 0;
259}
260
16458cf3 261static inline bool blk_op_is_passthrough(blk_opf_t op)
14cb0dc6 262{
da6269da 263 op &= REQ_OP_MASK;
14cb0dc6
ML
264 return op == REQ_OP_DRV_IN || op == REQ_OP_DRV_OUT;
265}
266
9bb33f24
CH
267/*
268 * BLK_BOUNCE_NONE: never bounce (default)
269 * BLK_BOUNCE_HIGH: bounce all highmem pages
270 */
271enum blk_bounce {
272 BLK_BOUNCE_NONE,
273 BLK_BOUNCE_HIGH,
274};
275
025146e1 276struct queue_limits {
9bb33f24 277 enum blk_bounce bounce;
025146e1 278 unsigned long seg_boundary_mask;
03100aad 279 unsigned long virt_boundary_mask;
025146e1
MP
280
281 unsigned int max_hw_sectors;
ca369d51 282 unsigned int max_dev_sectors;
762380ad 283 unsigned int chunk_sectors;
025146e1 284 unsigned int max_sectors;
c9c77418 285 unsigned int max_user_sectors;
025146e1 286 unsigned int max_segment_size;
c72758f3 287 unsigned int physical_block_size;
ad6bf88a 288 unsigned int logical_block_size;
c72758f3
MP
289 unsigned int alignment_offset;
290 unsigned int io_min;
291 unsigned int io_opt;
67efc925 292 unsigned int max_discard_sectors;
0034af03 293 unsigned int max_hw_discard_sectors;
44abff2c 294 unsigned int max_secure_erase_sectors;
a6f0788e 295 unsigned int max_write_zeroes_sectors;
0512a75b 296 unsigned int max_zone_append_sectors;
86b37281
MP
297 unsigned int discard_granularity;
298 unsigned int discard_alignment;
a805a4fa 299 unsigned int zone_write_granularity;
025146e1 300
8a78362c 301 unsigned short max_segments;
13f05c8d 302 unsigned short max_integrity_segments;
1e739730 303 unsigned short max_discard_segments;
025146e1 304
c72758f3 305 unsigned char misaligned;
86b37281 306 unsigned char discard_misaligned;
c78afc62 307 unsigned char raid_partial_stripes_expensive;
7437bb73 308 bool zoned;
8c4955c0
CH
309 unsigned int max_open_zones;
310 unsigned int max_active_zones;
c964d62f
KB
311
312 /*
313 * Drivers that set dma_alignment to less than 511 must be prepared to
314 * handle individual bvec's that are not a multiple of a SECTOR_SIZE
315 * due to possible offsets.
316 */
317 unsigned int dma_alignment;
025146e1
MP
318};
319
d4100351
CH
320typedef int (*report_zones_cb)(struct blk_zone *zone, unsigned int idx,
321 void *data);
322
d73e93b4 323void disk_set_zoned(struct gendisk *disk);
27ba3e8f 324
d4100351
CH
325#define BLK_ALL_ZONES ((unsigned int)-1)
326int blkdev_report_zones(struct block_device *bdev, sector_t sector,
668bfeea
CH
327 unsigned int nr_zones, report_zones_cb cb, void *data);
328int blkdev_zone_mgmt(struct block_device *bdev, enum req_op op,
71f4ecdb 329 sector_t sectors, sector_t nr_sectors);
e732671a 330int blk_revalidate_disk_zones(struct gendisk *disk,
668bfeea 331 void (*update_driver_data)(struct gendisk *disk));
6a0cb1bc 332
a2247f19
DLM
333/*
334 * Independent access ranges: struct blk_independent_access_range describes
335 * a range of contiguous sectors that can be accessed using device command
336 * execution resources that are independent from the resources used for
337 * other access ranges. This is typically found with single-LUN multi-actuator
338 * HDDs where each access range is served by a different set of heads.
339 * The set of independent ranges supported by the device is defined using
340 * struct blk_independent_access_ranges. The independent ranges must not overlap
341 * and must include all sectors within the disk capacity (no sector holes
342 * allowed).
343 * For a device with multiple ranges, requests targeting sectors in different
344 * ranges can be executed in parallel. A request can straddle an access range
345 * boundary.
346 */
347struct blk_independent_access_range {
348 struct kobject kobj;
a2247f19
DLM
349 sector_t sector;
350 sector_t nr_sectors;
351};
352
353struct blk_independent_access_ranges {
354 struct kobject kobj;
355 bool sysfs_registered;
356 unsigned int nr_ia_ranges;
357 struct blk_independent_access_range ia_range[];
358};
359
d7b76301 360struct request_queue {
0c734c5e
JA
361 /*
362 * The queue owner gets to use this for whatever they like.
363 * ll_rw_blk doesn't touch it.
364 */
365 void *queuedata;
0549e87c 366
0c734c5e 367 struct elevator_queue *elevator;
87760e5e 368
f8a5b122 369 const struct blk_mq_ops *mq_ops;
320ae51f 370
320ae51f 371 /* sw queues */
e6cdb092 372 struct blk_mq_ctx __percpu *queue_ctx;
320ae51f 373
0c734c5e
JA
374 /*
375 * various queue flags, see QUEUE_* below
376 */
377 unsigned long queue_flags;
378
379 unsigned int rq_timeout;
380
d278d4a8
JA
381 unsigned int queue_depth;
382
0c734c5e
JA
383 refcount_t refs;
384
320ae51f 385 /* hw dispatch queues */
320ae51f 386 unsigned int nr_hw_queues;
0c734c5e 387 struct xarray hctx_table;
320ae51f 388
0c734c5e 389 struct percpu_ref q_usage_counter;
1da177e4 390
0c734c5e 391 struct request *last_merge;
a73f730d 392
0d945c1f 393 spinlock_t queue_lock;
1da177e4 394
0c734c5e 395 int quiesce_depth;
d152c682 396
0c734c5e 397 struct gendisk *disk;
1da177e4 398
320ae51f
JA
399 /*
400 * mq queue kobject
401 */
1db4909e 402 struct kobject *mq_kobj;
320ae51f 403
0c734c5e
JA
404 struct queue_limits limits;
405
ac6fc48c
DW
406#ifdef CONFIG_BLK_DEV_INTEGRITY
407 struct blk_integrity integrity;
408#endif /* CONFIG_BLK_DEV_INTEGRITY */
409
47fafbc7 410#ifdef CONFIG_PM
6c954667 411 struct device *dev;
db04e18d 412 enum rpm_status rpm_status;
6c954667
LM
413#endif
414
1da177e4 415 /*
0c734c5e
JA
416 * Number of contexts that have called blk_set_pm_only(). If this
417 * counter is above zero then only RQF_PM requests are processed.
1da177e4 418 */
0c734c5e
JA
419 atomic_t pm_only;
420
421 struct blk_queue_stats *stats;
422 struct rq_qos *rq_qos;
423 struct mutex rq_qos_mutex;
424
425 /*
426 * ida allocated id for this queue. Used to index queues from
427 * ioctx.
428 */
429 int id;
1da177e4 430
e3790c7d 431 unsigned int dma_pad_mask;
1da177e4 432
0c734c5e
JA
433 /*
434 * queue settings
435 */
436 unsigned long nr_requests; /* Max # of requests */
437
1b262839 438#ifdef CONFIG_BLK_INLINE_ENCRYPTION
cb77cb5a 439 struct blk_crypto_profile *crypto_profile;
20f01f16 440 struct kobject *crypto_kobject;
1b262839
ST
441#endif
442
242f9dcb 443 struct timer_list timeout;
287922eb 444 struct work_struct timeout_work;
242f9dcb 445
079a2e3e 446 atomic_t nr_active_requests_shared_tags;
bccf5e26 447
0c734c5e
JA
448 unsigned int required_elevator_features;
449
079a2e3e 450 struct blk_mq_tags *sched_shared_tags;
d97e594c 451
a612fddf 452 struct list_head icq_list;
1231039d
CH
453#ifdef CONFIG_BLK_CGROUP
454 DECLARE_BITMAP (blkcg_pols, BLKCG_MAX_POLS);
455 struct blkcg_gq *root_blkg;
456 struct list_head blkg_list;
457 struct mutex blkcg_mutex;
458#endif
a612fddf 459
0c734c5e 460 int node;
025146e1 461
0c734c5e
JA
462 spinlock_t requeue_lock;
463 struct list_head requeue_list;
464 struct delayed_work requeue_work;
68c43f13 465
6c5c9341 466#ifdef CONFIG_BLK_DEV_IO_TRACE
c780e86d 467 struct blk_trace __rcu *blk_trace;
6c5c9341 468#endif
1da177e4 469 /*
4913efe4 470 * for flush operations
1da177e4 471 */
7c94e1c1 472 struct blk_flush_queue *fq;
9a67aa52 473 struct list_head flush_list;
483f4afc
AV
474
475 struct mutex sysfs_lock;
cecf5d87 476 struct mutex sysfs_dir_lock;
d351af01 477
2f8f1336
ML
478 /*
479 * for reusing dead hctx instance in case of updating
480 * nr_hw_queues
481 */
482 struct list_head unused_hctx_list;
483 spinlock_t unused_hctx_lock;
484
7996a8b5 485 int mq_freeze_depth;
d732580b 486
e43473b7
VG
487#ifdef CONFIG_BLK_DEV_THROTTLING
488 /* Throttle data */
489 struct throtl_data *td;
490#endif
548bc8e1 491 struct rcu_head rcu_head;
320ae51f 492 wait_queue_head_t mq_freeze_wq;
7996a8b5
BL
493 /*
494 * Protect concurrent access to q_usage_counter by
495 * percpu_ref_kill() and percpu_ref_reinit().
496 */
497 struct mutex mq_freeze_lock;
0d2602ca
JA
498
499 struct blk_mq_tag_set *tag_set;
500 struct list_head tag_set_list;
4593fdbe 501
07e4fead 502 struct dentry *debugfs_dir;
d332ce09 503 struct dentry *sched_debugfs_dir;
cc56694f 504 struct dentry *rqos_debugfs_dir;
5cf9c91b
CH
505 /*
506 * Serializes all debugfs metadata operations using the above dentries.
507 */
508 struct mutex debugfs_mutex;
07e4fead 509
4593fdbe 510 bool mq_sysfs_init_done;
1da177e4
LT
511};
512
bfe373f6 513/* Keep blk_queue_flag_name[] in sync with the definitions below */
eca7abf3
JA
514#define QUEUE_FLAG_STOPPED 0 /* queue is stopped */
515#define QUEUE_FLAG_DYING 1 /* queue being torn down */
eca7abf3
JA
516#define QUEUE_FLAG_NOMERGES 3 /* disable merge attempts */
517#define QUEUE_FLAG_SAME_COMP 4 /* complete on same CPU-group */
518#define QUEUE_FLAG_FAIL_IO 5 /* fake timeout */
519#define QUEUE_FLAG_NONROT 6 /* non-rotational device (SSD) */
520#define QUEUE_FLAG_VIRT QUEUE_FLAG_NONROT /* paravirt device */
521#define QUEUE_FLAG_IO_STAT 7 /* do disk/partitions IO accounting */
eca7abf3
JA
522#define QUEUE_FLAG_NOXMERGES 9 /* No extended merges */
523#define QUEUE_FLAG_ADD_RANDOM 10 /* Contributes to random pool */
3222d8c2 524#define QUEUE_FLAG_SYNCHRONOUS 11 /* always completes in submit context */
eca7abf3 525#define QUEUE_FLAG_SAME_FORCE 12 /* force complete on same CPU */
02d374f3 526#define QUEUE_FLAG_HW_WC 13 /* Write back caching supported */
eca7abf3 527#define QUEUE_FLAG_INIT_DONE 14 /* queue is initialized */
1cb039f3 528#define QUEUE_FLAG_STABLE_WRITES 15 /* don't modify blks until WB is done */
eca7abf3
JA
529#define QUEUE_FLAG_POLL 16 /* IO polling enabled if set */
530#define QUEUE_FLAG_WC 17 /* Write back caching */
531#define QUEUE_FLAG_FUA 18 /* device supports FUA writes */
532#define QUEUE_FLAG_DAX 19 /* device supports DAX */
533#define QUEUE_FLAG_STATS 20 /* track IO start and completion times */
eca7abf3 534#define QUEUE_FLAG_REGISTERED 22 /* queue has been registered to a disk */
eca7abf3
JA
535#define QUEUE_FLAG_QUIESCED 24 /* queue has been quiesced */
536#define QUEUE_FLAG_PCI_P2PDMA 25 /* device supports PCI p2p requests */
e84e8f06 537#define QUEUE_FLAG_ZONE_RESETALL 26 /* supports Zone Reset All */
6f816b4b 538#define QUEUE_FLAG_RQ_ALLOC_TIME 27 /* record rq->alloc_time_ns */
021a2446
MS
539#define QUEUE_FLAG_HCTX_ACTIVE 28 /* at least one blk-mq hctx is active */
540#define QUEUE_FLAG_NOWAIT 29 /* device supports NOWAIT */
4d337ceb 541#define QUEUE_FLAG_SQ_SCHED 30 /* single queue style io dispatch */
414dd48e 542#define QUEUE_FLAG_SKIP_TAGSET_QUIESCE 31 /* quiesce_tagset skip the queue*/
797e7dbb 543
ca5eebda
BF
544#define QUEUE_FLAG_MQ_DEFAULT ((1UL << QUEUE_FLAG_IO_STAT) | \
545 (1UL << QUEUE_FLAG_SAME_COMP) | \
546 (1UL << QUEUE_FLAG_NOWAIT))
94eddfbe 547
8814ce8a
BVA
548void blk_queue_flag_set(unsigned int flag, struct request_queue *q);
549void blk_queue_flag_clear(unsigned int flag, struct request_queue *q);
550bool blk_queue_flag_test_and_set(unsigned int flag, struct request_queue *q);
8814ce8a 551
1da177e4 552#define blk_queue_stopped(q) test_bit(QUEUE_FLAG_STOPPED, &(q)->queue_flags)
3f3299d5 553#define blk_queue_dying(q) test_bit(QUEUE_FLAG_DYING, &(q)->queue_flags)
320ae51f 554#define blk_queue_init_done(q) test_bit(QUEUE_FLAG_INIT_DONE, &(q)->queue_flags)
ac9fafa1 555#define blk_queue_nomerges(q) test_bit(QUEUE_FLAG_NOMERGES, &(q)->queue_flags)
488991e2
AB
556#define blk_queue_noxmerges(q) \
557 test_bit(QUEUE_FLAG_NOXMERGES, &(q)->queue_flags)
a68bbddb 558#define blk_queue_nonrot(q) test_bit(QUEUE_FLAG_NONROT, &(q)->queue_flags)
1cb039f3
CH
559#define blk_queue_stable_writes(q) \
560 test_bit(QUEUE_FLAG_STABLE_WRITES, &(q)->queue_flags)
bc58ba94 561#define blk_queue_io_stat(q) test_bit(QUEUE_FLAG_IO_STAT, &(q)->queue_flags)
e2e1a148 562#define blk_queue_add_random(q) test_bit(QUEUE_FLAG_ADD_RANDOM, &(q)->queue_flags)
e84e8f06
CK
563#define blk_queue_zone_resetall(q) \
564 test_bit(QUEUE_FLAG_ZONE_RESETALL, &(q)->queue_flags)
163d4baa 565#define blk_queue_dax(q) test_bit(QUEUE_FLAG_DAX, &(q)->queue_flags)
49d92c0d
LG
566#define blk_queue_pci_p2pdma(q) \
567 test_bit(QUEUE_FLAG_PCI_P2PDMA, &(q)->queue_flags)
6f816b4b
TH
568#ifdef CONFIG_BLK_RQ_ALLOC_TIME
569#define blk_queue_rq_alloc_time(q) \
570 test_bit(QUEUE_FLAG_RQ_ALLOC_TIME, &(q)->queue_flags)
571#else
572#define blk_queue_rq_alloc_time(q) false
573#endif
1da177e4 574
33659ebb
CH
575#define blk_noretry_request(rq) \
576 ((rq)->cmd_flags & (REQ_FAILFAST_DEV|REQ_FAILFAST_TRANSPORT| \
577 REQ_FAILFAST_DRIVER))
f4560ffe 578#define blk_queue_quiesced(q) test_bit(QUEUE_FLAG_QUIESCED, &(q)->queue_flags)
cd84a62e 579#define blk_queue_pm_only(q) atomic_read(&(q)->pm_only)
58c898ba 580#define blk_queue_registered(q) test_bit(QUEUE_FLAG_REGISTERED, &(q)->queue_flags)
4d337ceb 581#define blk_queue_sq_sched(q) test_bit(QUEUE_FLAG_SQ_SCHED, &(q)->queue_flags)
414dd48e
CL
582#define blk_queue_skip_tagset_quiesce(q) \
583 test_bit(QUEUE_FLAG_SKIP_TAGSET_QUIESCE, &(q)->queue_flags)
c9254f2d 584
cd84a62e
BVA
585extern void blk_set_pm_only(struct request_queue *q);
586extern void blk_clear_pm_only(struct request_queue *q);
33659ebb 587
1da177e4
LT
588#define list_entry_rq(ptr) list_entry((ptr), struct request, queuelist)
589
3ab3a031
CH
590#define dma_map_bvec(dev, bv, dir, attrs) \
591 dma_map_page_attrs(dev, (bv)->bv_page, (bv)->bv_offset, (bv)->bv_len, \
592 (dir), (attrs))
593
344e9ffc 594static inline bool queue_is_mq(struct request_queue *q)
49fd524f 595{
a1ce35fa 596 return q->mq_ops;
49fd524f
JA
597}
598
52abca64
AS
599#ifdef CONFIG_PM
600static inline enum rpm_status queue_rpm_status(struct request_queue *q)
601{
602 return q->rpm_status;
603}
604#else
605static inline enum rpm_status queue_rpm_status(struct request_queue *q)
606{
607 return RPM_ACTIVE;
608}
609#endif
610
797476b8
DLM
611static inline bool blk_queue_is_zoned(struct request_queue *q)
612{
7437bb73 613 return IS_ENABLED(CONFIG_BLK_DEV_ZONED) && q->limits.zoned;
797476b8
DLM
614}
615
6a5ac984 616#ifdef CONFIG_BLK_DEV_ZONED
668bfeea
CH
617unsigned int bdev_nr_zones(struct block_device *bdev);
618
d86e716a 619static inline unsigned int disk_nr_zones(struct gendisk *disk)
965b652e 620{
d86e716a 621 return blk_queue_is_zoned(disk->queue) ? disk->nr_zones : 0;
965b652e
DLM
622}
623
d86e716a 624static inline unsigned int disk_zone_no(struct gendisk *disk, sector_t sector)
6cc77e9c 625{
d86e716a 626 if (!blk_queue_is_zoned(disk->queue))
6cc77e9c 627 return 0;
d86e716a 628 return sector >> ilog2(disk->queue->limits.chunk_sectors);
6cc77e9c
CH
629}
630
d86e716a 631static inline bool disk_zone_is_seq(struct gendisk *disk, sector_t sector)
6cc77e9c 632{
d86e716a 633 if (!blk_queue_is_zoned(disk->queue))
6cc77e9c 634 return false;
d86e716a 635 if (!disk->conv_zones_bitmap)
f216fdd7 636 return true;
d86e716a 637 return !test_bit(disk_zone_no(disk, sector), disk->conv_zones_bitmap);
6cc77e9c 638}
e15864f8 639
982977df 640static inline void disk_set_max_open_zones(struct gendisk *disk,
e15864f8
NC
641 unsigned int max_open_zones)
642{
8c4955c0 643 disk->queue->limits.max_open_zones = max_open_zones;
e15864f8
NC
644}
645
982977df 646static inline void disk_set_max_active_zones(struct gendisk *disk,
659bf827
NC
647 unsigned int max_active_zones)
648{
8c4955c0 649 disk->queue->limits.max_active_zones = max_active_zones;
659bf827
NC
650}
651
1dc01720
CH
652static inline unsigned int bdev_max_open_zones(struct block_device *bdev)
653{
8c4955c0 654 return bdev->bd_disk->queue->limits.max_open_zones;
1dc01720
CH
655}
656
657static inline unsigned int bdev_max_active_zones(struct block_device *bdev)
659bf827 658{
8c4955c0 659 return bdev->bd_disk->queue->limits.max_active_zones;
659bf827 660}
1dc01720 661
965b652e 662#else /* CONFIG_BLK_DEV_ZONED */
668bfeea
CH
663static inline unsigned int bdev_nr_zones(struct block_device *bdev)
664{
665 return 0;
666}
667
d86e716a 668static inline unsigned int disk_nr_zones(struct gendisk *disk)
965b652e
DLM
669{
670 return 0;
671}
d86e716a 672static inline bool disk_zone_is_seq(struct gendisk *disk, sector_t sector)
02992df8
JT
673{
674 return false;
675}
d86e716a 676static inline unsigned int disk_zone_no(struct gendisk *disk, sector_t sector)
02992df8
JT
677{
678 return 0;
679}
1dc01720 680static inline unsigned int bdev_max_open_zones(struct block_device *bdev)
e15864f8
NC
681{
682 return 0;
683}
d86e716a 684
1dc01720 685static inline unsigned int bdev_max_active_zones(struct block_device *bdev)
659bf827
NC
686{
687 return 0;
688}
6a5ac984 689#endif /* CONFIG_BLK_DEV_ZONED */
6cc77e9c 690
d278d4a8
JA
691static inline unsigned int blk_queue_depth(struct request_queue *q)
692{
693 if (q->queue_depth)
694 return q->queue_depth;
695
696 return q->nr_requests;
697}
698
3d6392cf
JA
699/*
700 * default timeout for SG_IO if none specified
701 */
702#define BLK_DEFAULT_SG_TIMEOUT (60 * HZ)
f2f1fa78 703#define BLK_MIN_SG_TIMEOUT (7 * HZ)
3d6392cf 704
5705f702 705/* This should not be used directly - use rq_for_each_segment */
1e428079
JA
706#define for_each_bio(_bio) \
707 for (; _bio; _bio = _bio->bi_next)
5705f702 708
322cbb50
CH
709int __must_check device_add_disk(struct device *parent, struct gendisk *disk,
710 const struct attribute_group **groups);
711static inline int __must_check add_disk(struct gendisk *disk)
712{
713 return device_add_disk(NULL, disk, NULL);
714}
715void del_gendisk(struct gendisk *gp);
716void invalidate_disk(struct gendisk *disk);
717void set_disk_ro(struct gendisk *disk, bool read_only);
718void disk_uevent(struct gendisk *disk, enum kobject_action action);
719
720static inline int get_disk_ro(struct gendisk *disk)
721{
722 return disk->part0->bd_read_only ||
723 test_bit(GD_READ_ONLY, &disk->state);
724}
725
726static inline int bdev_read_only(struct block_device *bdev)
727{
728 return bdev->bd_read_only || get_disk_ro(bdev->bd_disk);
729}
730
731bool set_capacity_and_notify(struct gendisk *disk, sector_t size);
ab6860f6 732void disk_force_media_change(struct gendisk *disk);
560e20e4 733void bdev_mark_dead(struct block_device *bdev, bool surprise);
322cbb50
CH
734
735void add_disk_randomness(struct gendisk *disk) __latent_entropy;
736void rand_initialize_disk(struct gendisk *disk);
737
738static inline sector_t get_start_sect(struct block_device *bdev)
739{
740 return bdev->bd_start_sect;
741}
742
743static inline sector_t bdev_nr_sectors(struct block_device *bdev)
744{
745 return bdev->bd_nr_sectors;
746}
747
748static inline loff_t bdev_nr_bytes(struct block_device *bdev)
749{
750 return (loff_t)bdev_nr_sectors(bdev) << SECTOR_SHIFT;
751}
752
753static inline sector_t get_capacity(struct gendisk *disk)
754{
755 return bdev_nr_sectors(disk->part0);
756}
757
758static inline u64 sb_bdev_nr_blocks(struct super_block *sb)
759{
760 return bdev_nr_sectors(sb->s_bdev) >>
761 (sb->s_blocksize_bits - SECTOR_SHIFT);
762}
763
764int bdev_disk_changed(struct gendisk *disk, bool invalidate);
765
322cbb50
CH
766void put_disk(struct gendisk *disk);
767struct gendisk *__blk_alloc_disk(int node, struct lock_class_key *lkclass);
768
769/**
770 * blk_alloc_disk - allocate a gendisk structure
771 * @node_id: numa node to allocate on
772 *
773 * Allocate and pre-initialize a gendisk structure for use with BIO based
774 * drivers.
775 *
776 * Context: can sleep
777 */
778#define blk_alloc_disk(node_id) \
779({ \
780 static struct lock_class_key __key; \
781 \
782 __blk_alloc_disk(node_id, &__key); \
783})
322cbb50
CH
784
785int __register_blkdev(unsigned int major, const char *name,
786 void (*probe)(dev_t devt));
787#define register_blkdev(major, name) \
788 __register_blkdev(major, name, NULL)
789void unregister_blkdev(unsigned int major, const char *name);
790
444aa2c5 791bool disk_check_media_change(struct gendisk *disk);
322cbb50
CH
792void set_capacity(struct gendisk *disk, sector_t size);
793
794#ifdef CONFIG_BLOCK_HOLDER_DEPRECATED
795int bd_link_disk_holder(struct block_device *bdev, struct gendisk *disk);
796void bd_unlink_disk_holder(struct block_device *bdev, struct gendisk *disk);
322cbb50
CH
797#else
798static inline int bd_link_disk_holder(struct block_device *bdev,
799 struct gendisk *disk)
800{
801 return 0;
802}
803static inline void bd_unlink_disk_holder(struct block_device *bdev,
804 struct gendisk *disk)
805{
806}
322cbb50
CH
807#endif /* CONFIG_BLOCK_HOLDER_DEPRECATED */
808
809dev_t part_devt(struct gendisk *disk, u8 partno);
810void inc_diskseq(struct gendisk *disk);
322cbb50 811void blk_request_module(dev_t devt);
2d4dc890 812
1da177e4
LT
813extern int blk_register_queue(struct gendisk *disk);
814extern void blk_unregister_queue(struct gendisk *disk);
3e08773c 815void submit_bio_noacct(struct bio *bio);
5a97806f 816struct bio *bio_split_to_limits(struct bio *bio);
24b83deb 817
ef9e3fac 818extern int blk_lld_busy(struct request_queue *q);
9a95e4ef 819extern int blk_queue_enter(struct request_queue *q, blk_mq_req_flags_t flags);
2e6edc95 820extern void blk_queue_exit(struct request_queue *q);
1da177e4 821extern void blk_sync_queue(struct request_queue *q);
fb9b16e1 822
e47bc4ed 823/* Helper to convert REQ_OP_XXX to its string format XXX */
77e7ffd7 824extern const char *blk_op_str(enum req_op op);
e47bc4ed 825
2a842aca
CH
826int blk_status_to_errno(blk_status_t status);
827blk_status_t errno_to_blk_status(int errno);
7ba37927 828const char *blk_status_to_str(blk_status_t status);
2a842aca 829
ef99b2d3
CH
830/* only poll the hardware once, don't continue until a completion was found */
831#define BLK_POLL_ONESHOT (1 << 0)
5a72e899
JA
832int bio_poll(struct bio *bio, struct io_comp_batch *iob, unsigned int flags);
833int iocb_bio_iopoll(struct kiocb *kiocb, struct io_comp_batch *iob,
834 unsigned int flags);
05229bee 835
165125e1 836static inline struct request_queue *bdev_get_queue(struct block_device *bdev)
1da177e4 837{
17220ca5 838 return bdev->bd_queue; /* this is never NULL */
1da177e4
LT
839}
840
02694e86
CK
841/* Helper to convert BLK_ZONE_ZONE_XXX to its string format XXX */
842const char *blk_zone_cond_str(enum blk_zone_cond zone_cond);
843
d0ea6bde
DLM
844static inline unsigned int bio_zone_no(struct bio *bio)
845{
d86e716a 846 return disk_zone_no(bio->bi_bdev->bd_disk, bio->bi_iter.bi_sector);
d0ea6bde
DLM
847}
848
849static inline unsigned int bio_zone_is_seq(struct bio *bio)
850{
d86e716a 851 return disk_zone_is_seq(bio->bi_bdev->bd_disk, bio->bi_iter.bi_sector);
d0ea6bde 852}
6cc77e9c 853
8689461b
CH
854/*
855 * Return how much of the chunk is left to be used for I/O at a given offset.
856 */
857static inline unsigned int blk_chunk_sectors_left(sector_t offset,
858 unsigned int chunk_sectors)
859{
860 if (unlikely(!is_power_of_2(chunk_sectors)))
861 return chunk_sectors - sector_div(offset, chunk_sectors);
862 return chunk_sectors - (offset & (chunk_sectors - 1));
863}
864
1da177e4
LT
865/*
866 * Access functions for manipulating queue properties
867 */
9bb33f24 868void blk_queue_bounce_limit(struct request_queue *q, enum blk_bounce limit);
086fa5ff 869extern void blk_queue_max_hw_sectors(struct request_queue *, unsigned int);
762380ad 870extern void blk_queue_chunk_sectors(struct request_queue *, unsigned int);
8a78362c 871extern void blk_queue_max_segments(struct request_queue *, unsigned short);
1e739730
CH
872extern void blk_queue_max_discard_segments(struct request_queue *,
873 unsigned short);
44abff2c
CH
874void blk_queue_max_secure_erase_sectors(struct request_queue *q,
875 unsigned int max_sectors);
165125e1 876extern void blk_queue_max_segment_size(struct request_queue *, unsigned int);
67efc925
CH
877extern void blk_queue_max_discard_sectors(struct request_queue *q,
878 unsigned int max_discard_sectors);
a6f0788e
CK
879extern void blk_queue_max_write_zeroes_sectors(struct request_queue *q,
880 unsigned int max_write_same_sectors);
ad6bf88a 881extern void blk_queue_logical_block_size(struct request_queue *, unsigned int);
0512a75b
KB
882extern void blk_queue_max_zone_append_sectors(struct request_queue *q,
883 unsigned int max_zone_append_sectors);
892b6f90 884extern void blk_queue_physical_block_size(struct request_queue *, unsigned int);
a805a4fa
DLM
885void blk_queue_zone_write_granularity(struct request_queue *q,
886 unsigned int size);
c72758f3
MP
887extern void blk_queue_alignment_offset(struct request_queue *q,
888 unsigned int alignment);
471aa704 889void disk_update_readahead(struct gendisk *disk);
7c958e32 890extern void blk_limits_io_min(struct queue_limits *limits, unsigned int min);
c72758f3 891extern void blk_queue_io_min(struct request_queue *q, unsigned int min);
3c5820c7 892extern void blk_limits_io_opt(struct queue_limits *limits, unsigned int opt);
c72758f3 893extern void blk_queue_io_opt(struct request_queue *q, unsigned int opt);
d278d4a8 894extern void blk_set_queue_depth(struct request_queue *q, unsigned int depth);
b1bd055d 895extern void blk_set_stacking_limits(struct queue_limits *lim);
c72758f3
MP
896extern int blk_stack_limits(struct queue_limits *t, struct queue_limits *b,
897 sector_t offset);
898extern void disk_stack_limits(struct gendisk *disk, struct block_device *bdev,
899 sector_t offset);
27f8221a 900extern void blk_queue_update_dma_pad(struct request_queue *, unsigned int);
165125e1 901extern void blk_queue_segment_boundary(struct request_queue *, unsigned long);
03100aad 902extern void blk_queue_virt_boundary(struct request_queue *, unsigned long);
165125e1 903extern void blk_queue_dma_alignment(struct request_queue *, int);
11c3e689 904extern void blk_queue_update_dma_alignment(struct request_queue *, int);
242f9dcb 905extern void blk_queue_rq_timeout(struct request_queue *, unsigned int);
93e9d8e8 906extern void blk_queue_write_cache(struct request_queue *q, bool enabled, bool fua);
2e9bc346 907
a2247f19
DLM
908struct blk_independent_access_ranges *
909disk_alloc_independent_access_ranges(struct gendisk *disk, int nr_ia_ranges);
910void disk_set_independent_access_ranges(struct gendisk *disk,
911 struct blk_independent_access_ranges *iars);
912
2e9bc346
CH
913/*
914 * Elevator features for blk_queue_required_elevator_features:
915 */
916/* Supports zoned block devices sequential write constraint */
917#define ELEVATOR_F_ZBD_SEQ_WRITE (1U << 0)
2e9bc346 918
68c43f13
DLM
919extern void blk_queue_required_elevator_features(struct request_queue *q,
920 unsigned int features);
45147fb5
YS
921extern bool blk_queue_can_use_dma_map_merging(struct request_queue *q,
922 struct device *dev);
1da177e4 923
09ac46c4 924bool __must_check blk_get_queue(struct request_queue *);
165125e1 925extern void blk_put_queue(struct request_queue *);
7a5428dc
CH
926
927void blk_mark_disk_dead(struct gendisk *disk);
1da177e4 928
1a4dcfa8 929#ifdef CONFIG_BLOCK
316cc67d 930/*
75df7136
SJ
931 * blk_plug permits building a queue of related requests by holding the I/O
932 * fragments for a short period. This allows merging of sequential requests
933 * into single larger request. As the requests are moved from a per-task list to
934 * the device's request_queue in a batch, this results in improved scalability
935 * as the lock contention for request_queue lock is reduced.
936 *
937 * It is ok not to disable preemption when adding the request to the plug list
008f75a2
CH
938 * or when attempting a merge. For details, please see schedule() where
939 * blk_flush_plug() is called.
316cc67d 940 */
73c10101 941struct blk_plug {
bc490f81 942 struct request *mq_list; /* blk-mq requests */
47c122e3
JA
943
944 /* if ios_left is > 1, we can batch tag/rq allocations */
945 struct request *cached_rq;
da4c8c3d 946 u64 cur_ktime;
47c122e3
JA
947 unsigned short nr_ios;
948
5f0ed774 949 unsigned short rq_count;
47c122e3 950
ce5b009c 951 bool multiple_queues;
dc5fc361 952 bool has_elevator;
47c122e3
JA
953
954 struct list_head cb_list; /* md requires an unplug callback */
73c10101 955};
55c022bb 956
9cbb1750 957struct blk_plug_cb;
74018dc3 958typedef void (*blk_plug_cb_fn)(struct blk_plug_cb *, bool);
048c9374
N
959struct blk_plug_cb {
960 struct list_head list;
9cbb1750
N
961 blk_plug_cb_fn callback;
962 void *data;
048c9374 963};
9cbb1750
N
964extern struct blk_plug_cb *blk_check_plugged(blk_plug_cb_fn unplug,
965 void *data, int size);
73c10101 966extern void blk_start_plug(struct blk_plug *);
47c122e3 967extern void blk_start_plug_nr_ios(struct blk_plug *, unsigned short);
73c10101 968extern void blk_finish_plug(struct blk_plug *);
73c10101 969
aa8dccca
CH
970void __blk_flush_plug(struct blk_plug *plug, bool from_schedule);
971static inline void blk_flush_plug(struct blk_plug *plug, bool async)
73c10101 972{
aa8dccca
CH
973 if (plug)
974 __blk_flush_plug(plug, async);
73c10101
JA
975}
976
06b23f92
JA
977/*
978 * tsk == current here
979 */
980static inline void blk_plug_invalidate_ts(struct task_struct *tsk)
981{
982 struct blk_plug *plug = tsk->plug;
983
984 if (plug)
985 plug->cur_ktime = 0;
986 current->flags &= ~PF_BLOCK_TS;
987}
988
c6bf3f0e 989int blkdev_issue_flush(struct block_device *bdev);
1a4dcfa8
CH
990long nr_blockdev_pages(void);
991#else /* CONFIG_BLOCK */
992struct blk_plug {
993};
994
47c122e3
JA
995static inline void blk_start_plug_nr_ios(struct blk_plug *plug,
996 unsigned short nr_ios)
997{
998}
999
1a4dcfa8
CH
1000static inline void blk_start_plug(struct blk_plug *plug)
1001{
1002}
1003
1004static inline void blk_finish_plug(struct blk_plug *plug)
1005{
1006}
1007
008f75a2 1008static inline void blk_flush_plug(struct blk_plug *plug, bool async)
1a4dcfa8
CH
1009{
1010}
1011
06b23f92
JA
1012static inline void blk_plug_invalidate_ts(struct task_struct *tsk)
1013{
1014}
1015
c6bf3f0e 1016static inline int blkdev_issue_flush(struct block_device *bdev)
1a4dcfa8
CH
1017{
1018 return 0;
1019}
1020
1021static inline long nr_blockdev_pages(void)
1022{
1023 return 0;
1024}
1025#endif /* CONFIG_BLOCK */
1026
71ac860a
ML
1027extern void blk_io_schedule(void);
1028
44abff2c
CH
1029int blkdev_issue_discard(struct block_device *bdev, sector_t sector,
1030 sector_t nr_sects, gfp_t gfp_mask);
1031int __blkdev_issue_discard(struct block_device *bdev, sector_t sector,
1032 sector_t nr_sects, gfp_t gfp_mask, struct bio **biop);
1033int blkdev_issue_secure_erase(struct block_device *bdev, sector_t sector,
1034 sector_t nr_sects, gfp_t gfp);
ee472d83
CH
1035
1036#define BLKDEV_ZERO_NOUNMAP (1 << 0) /* do not free blocks */
cb365b96 1037#define BLKDEV_ZERO_NOFALLBACK (1 << 1) /* don't write explicit zeroes */
ee472d83 1038
e73c23ff
CK
1039extern int __blkdev_issue_zeroout(struct block_device *bdev, sector_t sector,
1040 sector_t nr_sects, gfp_t gfp_mask, struct bio **biop,
ee472d83 1041 unsigned flags);
3f14d792 1042extern int blkdev_issue_zeroout(struct block_device *bdev, sector_t sector,
ee472d83
CH
1043 sector_t nr_sects, gfp_t gfp_mask, unsigned flags);
1044
2cf6d26a
CH
1045static inline int sb_issue_discard(struct super_block *sb, sector_t block,
1046 sector_t nr_blocks, gfp_t gfp_mask, unsigned long flags)
fb2dce86 1047{
233bde21
BVA
1048 return blkdev_issue_discard(sb->s_bdev,
1049 block << (sb->s_blocksize_bits -
1050 SECTOR_SHIFT),
1051 nr_blocks << (sb->s_blocksize_bits -
1052 SECTOR_SHIFT),
44abff2c 1053 gfp_mask);
fb2dce86 1054}
e6fa0be6 1055static inline int sb_issue_zeroout(struct super_block *sb, sector_t block,
a107e5a3 1056 sector_t nr_blocks, gfp_t gfp_mask)
e6fa0be6
LC
1057{
1058 return blkdev_issue_zeroout(sb->s_bdev,
233bde21
BVA
1059 block << (sb->s_blocksize_bits -
1060 SECTOR_SHIFT),
1061 nr_blocks << (sb->s_blocksize_bits -
1062 SECTOR_SHIFT),
ee472d83 1063 gfp_mask, 0);
e6fa0be6 1064}
1da177e4 1065
fa01b1e9
CH
1066static inline bool bdev_is_partition(struct block_device *bdev)
1067{
1068 return bdev->bd_partno;
1069}
1070
eb28d31b
MP
1071enum blk_default_limits {
1072 BLK_MAX_SEGMENTS = 128,
1073 BLK_SAFE_MAX_SECTORS = 255,
eb28d31b
MP
1074 BLK_MAX_SEGMENT_SIZE = 65536,
1075 BLK_SEG_BOUNDARY_MASK = 0xFFFFFFFFUL,
1076};
0e435ac2 1077
d6b9f4e6
CH
1078/*
1079 * Default upper limit for the software max_sectors limit used for
1080 * regular file system I/O. This can be increased through sysfs.
1081 *
1082 * Not to be confused with the max_hw_sector limit that is entirely
1083 * controlled by the driver, usually based on hardware limits.
1084 */
1085#define BLK_DEF_MAX_SECTORS_CAP 2560u
0a26f327 1086
af2c68fe 1087static inline unsigned long queue_segment_boundary(const struct request_queue *q)
ae03bf63 1088{
025146e1 1089 return q->limits.seg_boundary_mask;
ae03bf63
MP
1090}
1091
af2c68fe 1092static inline unsigned long queue_virt_boundary(const struct request_queue *q)
03100aad
KB
1093{
1094 return q->limits.virt_boundary_mask;
1095}
1096
af2c68fe 1097static inline unsigned int queue_max_sectors(const struct request_queue *q)
ae03bf63 1098{
025146e1 1099 return q->limits.max_sectors;
ae03bf63
MP
1100}
1101
547e2f70
CH
1102static inline unsigned int queue_max_bytes(struct request_queue *q)
1103{
1104 return min_t(unsigned int, queue_max_sectors(q), INT_MAX >> 9) << 9;
1105}
1106
af2c68fe 1107static inline unsigned int queue_max_hw_sectors(const struct request_queue *q)
ae03bf63 1108{
025146e1 1109 return q->limits.max_hw_sectors;
ae03bf63
MP
1110}
1111
af2c68fe 1112static inline unsigned short queue_max_segments(const struct request_queue *q)
ae03bf63 1113{
8a78362c 1114 return q->limits.max_segments;
ae03bf63
MP
1115}
1116
af2c68fe 1117static inline unsigned short queue_max_discard_segments(const struct request_queue *q)
1e739730
CH
1118{
1119 return q->limits.max_discard_segments;
1120}
1121
af2c68fe 1122static inline unsigned int queue_max_segment_size(const struct request_queue *q)
ae03bf63 1123{
025146e1 1124 return q->limits.max_segment_size;
ae03bf63
MP
1125}
1126
0512a75b
KB
1127static inline unsigned int queue_max_zone_append_sectors(const struct request_queue *q)
1128{
fe6f0cdc
JT
1129
1130 const struct queue_limits *l = &q->limits;
1131
1132 return min(l->max_zone_append_sectors, l->max_sectors);
0512a75b
KB
1133}
1134
2aba0d19
CH
1135static inline unsigned int
1136bdev_max_zone_append_sectors(struct block_device *bdev)
1137{
1138 return queue_max_zone_append_sectors(bdev_get_queue(bdev));
1139}
1140
65ea1b66
NA
1141static inline unsigned int bdev_max_segments(struct block_device *bdev)
1142{
1143 return queue_max_segments(bdev_get_queue(bdev));
1144}
1145
ad6bf88a 1146static inline unsigned queue_logical_block_size(const struct request_queue *q)
1da177e4
LT
1147{
1148 int retval = 512;
1149
025146e1
MP
1150 if (q && q->limits.logical_block_size)
1151 retval = q->limits.logical_block_size;
1da177e4
LT
1152
1153 return retval;
1154}
1155
ad6bf88a 1156static inline unsigned int bdev_logical_block_size(struct block_device *bdev)
1da177e4 1157{
e1defc4f 1158 return queue_logical_block_size(bdev_get_queue(bdev));
1da177e4
LT
1159}
1160
af2c68fe 1161static inline unsigned int queue_physical_block_size(const struct request_queue *q)
c72758f3
MP
1162{
1163 return q->limits.physical_block_size;
1164}
1165
892b6f90 1166static inline unsigned int bdev_physical_block_size(struct block_device *bdev)
ac481c20
MP
1167{
1168 return queue_physical_block_size(bdev_get_queue(bdev));
1169}
1170
af2c68fe 1171static inline unsigned int queue_io_min(const struct request_queue *q)
c72758f3
MP
1172{
1173 return q->limits.io_min;
1174}
1175
ac481c20
MP
1176static inline int bdev_io_min(struct block_device *bdev)
1177{
1178 return queue_io_min(bdev_get_queue(bdev));
1179}
1180
af2c68fe 1181static inline unsigned int queue_io_opt(const struct request_queue *q)
c72758f3
MP
1182{
1183 return q->limits.io_opt;
1184}
1185
ac481c20
MP
1186static inline int bdev_io_opt(struct block_device *bdev)
1187{
1188 return queue_io_opt(bdev_get_queue(bdev));
1189}
1190
a805a4fa
DLM
1191static inline unsigned int
1192queue_zone_write_granularity(const struct request_queue *q)
1193{
1194 return q->limits.zone_write_granularity;
1195}
1196
1197static inline unsigned int
1198bdev_zone_write_granularity(struct block_device *bdev)
1199{
1200 return queue_zone_write_granularity(bdev_get_queue(bdev));
1201}
1202
89098b07 1203int bdev_alignment_offset(struct block_device *bdev);
5c4b4a5c 1204unsigned int bdev_discard_alignment(struct block_device *bdev);
c6e66634 1205
cf0fbf89
CH
1206static inline unsigned int bdev_max_discard_sectors(struct block_device *bdev)
1207{
1208 return bdev_get_queue(bdev)->limits.max_discard_sectors;
1209}
1210
7b47ef52
CH
1211static inline unsigned int bdev_discard_granularity(struct block_device *bdev)
1212{
1213 return bdev_get_queue(bdev)->limits.discard_granularity;
1214}
1215
44abff2c
CH
1216static inline unsigned int
1217bdev_max_secure_erase_sectors(struct block_device *bdev)
1218{
1219 return bdev_get_queue(bdev)->limits.max_secure_erase_sectors;
1220}
1221
a6f0788e
CK
1222static inline unsigned int bdev_write_zeroes_sectors(struct block_device *bdev)
1223{
1224 struct request_queue *q = bdev_get_queue(bdev);
1225
1226 if (q)
1227 return q->limits.max_write_zeroes_sectors;
1228
1229 return 0;
1230}
1231
10f0d2a5
CH
1232static inline bool bdev_nonrot(struct block_device *bdev)
1233{
1234 return blk_queue_nonrot(bdev_get_queue(bdev));
1235}
1236
3222d8c2
CH
1237static inline bool bdev_synchronous(struct block_device *bdev)
1238{
1239 return test_bit(QUEUE_FLAG_SYNCHRONOUS,
1240 &bdev_get_queue(bdev)->queue_flags);
1241}
1242
36d25489
CH
1243static inline bool bdev_stable_writes(struct block_device *bdev)
1244{
1245 return test_bit(QUEUE_FLAG_STABLE_WRITES,
1246 &bdev_get_queue(bdev)->queue_flags);
1247}
1248
08e688fd
CH
1249static inline bool bdev_write_cache(struct block_device *bdev)
1250{
1251 return test_bit(QUEUE_FLAG_WC, &bdev_get_queue(bdev)->queue_flags);
1252}
1253
a557e82e
CH
1254static inline bool bdev_fua(struct block_device *bdev)
1255{
1256 return test_bit(QUEUE_FLAG_FUA, &bdev_get_queue(bdev)->queue_flags);
1257}
1258
568ec936
CH
1259static inline bool bdev_nowait(struct block_device *bdev)
1260{
1261 return test_bit(QUEUE_FLAG_NOWAIT, &bdev_get_queue(bdev)->queue_flags);
1262}
1263
797476b8
DLM
1264static inline bool bdev_is_zoned(struct block_device *bdev)
1265{
fea127b3 1266 return blk_queue_is_zoned(bdev_get_queue(bdev));
797476b8
DLM
1267}
1268
d67ea690
PR
1269static inline unsigned int bdev_zone_no(struct block_device *bdev, sector_t sec)
1270{
1271 return disk_zone_no(bdev->bd_disk, sec);
1272}
1273
a3707982
BVA
1274/* Whether write serialization is required for @op on zoned devices. */
1275static inline bool op_needs_zoned_write_locking(enum req_op op)
8cafdb5a 1276{
8cafdb5a
PR
1277 return op == REQ_OP_WRITE || op == REQ_OP_WRITE_ZEROES;
1278}
1279
8cafdb5a 1280static inline bool bdev_op_is_zoned_write(struct block_device *bdev,
3ddbe2a7 1281 enum req_op op)
8cafdb5a 1282{
a3707982 1283 return bdev_is_zoned(bdev) && op_needs_zoned_write_locking(op);
8cafdb5a
PR
1284}
1285
113ab72e 1286static inline sector_t bdev_zone_sectors(struct block_device *bdev)
6a0cb1bc
HR
1287{
1288 struct request_queue *q = bdev_get_queue(bdev);
1289
de71973c
CH
1290 if (!blk_queue_is_zoned(q))
1291 return 0;
1292 return q->limits.chunk_sectors;
6cc77e9c 1293}
6a0cb1bc 1294
e29b2100
PR
1295static inline sector_t bdev_offset_from_zone_start(struct block_device *bdev,
1296 sector_t sector)
1297{
1298 return sector & (bdev_zone_sectors(bdev) - 1);
1299}
1300
1301static inline bool bdev_is_zone_start(struct block_device *bdev,
1302 sector_t sector)
1303{
1304 return bdev_offset_from_zone_start(bdev, sector) == 0;
1305}
1306
af2c68fe 1307static inline int queue_dma_alignment(const struct request_queue *q)
1da177e4 1308{
c964d62f 1309 return q ? q->limits.dma_alignment : 511;
1da177e4
LT
1310}
1311
4a2dcc35
KB
1312static inline unsigned int bdev_dma_alignment(struct block_device *bdev)
1313{
1314 return queue_dma_alignment(bdev_get_queue(bdev));
1315}
1316
5debd969
KB
1317static inline bool bdev_iter_is_aligned(struct block_device *bdev,
1318 struct iov_iter *iter)
1319{
1320 return iov_iter_is_aligned(iter, bdev_dma_alignment(bdev),
1321 bdev_logical_block_size(bdev) - 1);
1322}
1323
14417799 1324static inline int blk_rq_aligned(struct request_queue *q, unsigned long addr,
87904074
FT
1325 unsigned int len)
1326{
1327 unsigned int alignment = queue_dma_alignment(q) | q->dma_pad_mask;
14417799 1328 return !(addr & alignment) && !(len & alignment);
87904074
FT
1329}
1330
1da177e4
LT
1331/* assumes size > 256 */
1332static inline unsigned int blksize_bits(unsigned int size)
1333{
adff2158 1334 return order_base_2(size >> SECTOR_SHIFT) + SECTOR_SHIFT;
1da177e4
LT
1335}
1336
2befb9e3 1337static inline unsigned int block_size(struct block_device *bdev)
1da177e4 1338{
6b7b181b 1339 return 1 << bdev->bd_inode->i_blkbits;
1da177e4
LT
1340}
1341
59c3d45e 1342int kblockd_schedule_work(struct work_struct *work);
818cd1cb 1343int kblockd_mod_delayed_work_on(int cpu, struct delayed_work *dwork, unsigned long delay);
1da177e4 1344
1da177e4
LT
1345#define MODULE_ALIAS_BLOCKDEV(major,minor) \
1346 MODULE_ALIAS("block-major-" __stringify(major) "-" __stringify(minor))
1347#define MODULE_ALIAS_BLOCKDEV_MAJOR(major) \
1348 MODULE_ALIAS("block-major-" __stringify(major) "-*")
1349
d145dc23
ST
1350#ifdef CONFIG_BLK_INLINE_ENCRYPTION
1351
cb77cb5a
EB
1352bool blk_crypto_register(struct blk_crypto_profile *profile,
1353 struct request_queue *q);
d145dc23 1354
d145dc23
ST
1355#else /* CONFIG_BLK_INLINE_ENCRYPTION */
1356
cb77cb5a
EB
1357static inline bool blk_crypto_register(struct blk_crypto_profile *profile,
1358 struct request_queue *q)
d145dc23
ST
1359{
1360 return true;
1361}
1362
d145dc23
ST
1363#endif /* CONFIG_BLK_INLINE_ENCRYPTION */
1364
9208d414
CH
1365enum blk_unique_id {
1366 /* these match the Designator Types specified in SPC */
1367 BLK_UID_T10 = 1,
1368 BLK_UID_EUI64 = 2,
1369 BLK_UID_NAA = 3,
1370};
1371
08f85851 1372struct block_device_operations {
3e08773c 1373 void (*submit_bio)(struct bio *bio);
69fe0f29
ML
1374 int (*poll_bio)(struct bio *bio, struct io_comp_batch *iob,
1375 unsigned int flags);
05bdb996 1376 int (*open)(struct gendisk *disk, blk_mode_t mode);
ae220766 1377 void (*release)(struct gendisk *disk);
05bdb996
CH
1378 int (*ioctl)(struct block_device *bdev, blk_mode_t mode,
1379 unsigned cmd, unsigned long arg);
1380 int (*compat_ioctl)(struct block_device *bdev, blk_mode_t mode,
1381 unsigned cmd, unsigned long arg);
77ea887e
TH
1382 unsigned int (*check_events) (struct gendisk *disk,
1383 unsigned int clearing);
c3e33e04 1384 void (*unlock_native_capacity) (struct gendisk *);
08f85851 1385 int (*getgeo)(struct block_device *, struct hd_geometry *);
e00adcad 1386 int (*set_read_only)(struct block_device *bdev, bool ro);
76792055 1387 void (*free_disk)(struct gendisk *disk);
b3a27d05
NG
1388 /* this callback is with swap_lock and sometimes page table lock held */
1389 void (*swap_slot_free_notify) (struct block_device *, unsigned long);
e76239a3 1390 int (*report_zones)(struct gendisk *, sector_t sector,
d4100351 1391 unsigned int nr_zones, report_zones_cb cb, void *data);
050a4f34 1392 char *(*devnode)(struct gendisk *disk, umode_t *mode);
9208d414
CH
1393 /* returns the length of the identifier or a negative errno: */
1394 int (*get_unique_id)(struct gendisk *disk, u8 id[16],
1395 enum blk_unique_id id_type);
08f85851 1396 struct module *owner;
bbd3e064 1397 const struct pr_ops *pr_ops;
0bdfbca8
DO
1398
1399 /*
1400 * Special callback for probing GPT entry at a given sector.
1401 * Needed by Android devices, used by GPT scanner and MMC blk
1402 * driver.
1403 */
1404 int (*alternative_gpt_sector)(struct gendisk *disk, sector_t *sector);
08f85851
AV
1405};
1406
ee6a129d 1407#ifdef CONFIG_COMPAT
05bdb996 1408extern int blkdev_compat_ptr_ioctl(struct block_device *, blk_mode_t,
ee6a129d
AB
1409 unsigned int, unsigned long);
1410#else
1411#define blkdev_compat_ptr_ioctl NULL
1412#endif
1413
0619317f
JA
1414static inline void blk_wake_io_task(struct task_struct *waiter)
1415{
1416 /*
1417 * If we're polling, the task itself is doing the completions. For
1418 * that case, we don't need to signal a wakeup, it's enough to just
1419 * mark us as RUNNING.
1420 */
1421 if (waiter == current)
1422 __set_current_state(TASK_RUNNING);
1423 else
1424 wake_up_process(waiter);
1425}
1426
5f275713 1427unsigned long bdev_start_io_acct(struct block_device *bdev, enum req_op op,
5f0614a5 1428 unsigned long start_time);
77e7ffd7 1429void bdev_end_io_acct(struct block_device *bdev, enum req_op op,
5f275713 1430 unsigned int sectors, unsigned long start_time);
956d510e 1431
99dfc43e
CH
1432unsigned long bio_start_io_acct(struct bio *bio);
1433void bio_end_io_acct_remapped(struct bio *bio, unsigned long start_time,
1434 struct block_device *orig_bdev);
956d510e
CH
1435
1436/**
1437 * bio_end_io_acct - end I/O accounting for bio based drivers
1438 * @bio: bio to end account for
b42c1fc3 1439 * @start_time: start time returned by bio_start_io_acct()
956d510e
CH
1440 */
1441static inline void bio_end_io_acct(struct bio *bio, unsigned long start_time)
1442{
99dfc43e 1443 return bio_end_io_acct_remapped(bio, start_time, bio->bi_bdev);
956d510e 1444}
956d510e 1445
3f1266f1
CH
1446int bdev_read_only(struct block_device *bdev);
1447int set_blocksize(struct block_device *bdev, int size);
1448
4e7b5671 1449int lookup_bdev(const char *pathname, dev_t *dev);
3f1266f1
CH
1450
1451void blkdev_show(struct seq_file *seqf, off_t offset);
1452
1453#define BDEVNAME_SIZE 32 /* Largest string for a blockdev identifier */
1454#define BDEVT_SIZE 10 /* Largest string for MAJ:MIN for blkdev */
1455#ifdef CONFIG_BLOCK
1456#define BLKDEV_MAJOR_MAX 512
1457#else
1458#define BLKDEV_MAJOR_MAX 0
1459#endif
1460
0718afd4 1461struct blk_holder_ops {
d8530de5 1462 void (*mark_dead)(struct block_device *bdev, bool surprise);
2142b88c
CH
1463
1464 /*
1465 * Sync the file system mounted on the block device.
1466 */
1467 void (*sync)(struct block_device *bdev);
a30561a9
CB
1468
1469 /*
1470 * Freeze the file system mounted on the block device.
1471 */
1472 int (*freeze)(struct block_device *bdev);
1473
1474 /*
1475 * Thaw the file system mounted on the block device.
1476 */
1477 int (*thaw)(struct block_device *bdev);
0718afd4
CH
1478};
1479
e419cf3e
CB
1480/*
1481 * For filesystems using @fs_holder_ops, the @holder argument passed to
1482 * helpers used to open and claim block devices via
1483 * bd_prepare_to_claim() must point to a superblock.
1484 */
7ecd0b6f
CH
1485extern const struct blk_holder_ops fs_holder_ops;
1486
3f0b3e78
CH
1487/*
1488 * Return the correct open flags for blkdev_get_by_* for super block flags
1489 * as stored in sb->s_flags.
1490 */
1491#define sb_open_mode(flags) \
6f861765
JK
1492 (BLK_OPEN_READ | BLK_OPEN_RESTRICT_WRITES | \
1493 (((flags) & SB_RDONLY) ? 0 : BLK_OPEN_WRITE))
3f0b3e78 1494
e719b4d1
JK
1495struct bdev_handle {
1496 struct block_device *bdev;
1497 void *holder;
841dd789 1498 blk_mode_t mode;
e719b4d1
JK
1499};
1500
e719b4d1
JK
1501struct bdev_handle *bdev_open_by_dev(dev_t dev, blk_mode_t mode, void *holder,
1502 const struct blk_holder_ops *hops);
1503struct bdev_handle *bdev_open_by_path(const char *path, blk_mode_t mode,
1504 void *holder, const struct blk_holder_ops *hops);
0718afd4
CH
1505int bd_prepare_to_claim(struct block_device *bdev, void *holder,
1506 const struct blk_holder_ops *hops);
37c3fc9a 1507void bd_abort_claiming(struct block_device *bdev, void *holder);
e719b4d1 1508void bdev_release(struct bdev_handle *handle);
3f1266f1 1509
22ae8ce8
CH
1510/* just for blk-cgroup, don't use elsewhere */
1511struct block_device *blkdev_get_no_open(dev_t dev);
1512void blkdev_put_no_open(struct block_device *bdev);
1513
621c1f42 1514struct block_device *I_BDEV(struct inode *inode);
3f1266f1
CH
1515
1516#ifdef CONFIG_BLOCK
1517void invalidate_bdev(struct block_device *bdev);
1518int sync_blockdev(struct block_device *bdev);
97d6fb1b 1519int sync_blockdev_range(struct block_device *bdev, loff_t lstart, loff_t lend);
70164eb6 1520int sync_blockdev_nowait(struct block_device *bdev);
1e03a36b 1521void sync_bdevs(bool wait);
2d985f8c 1522void bdev_statx_dioalign(struct inode *inode, struct kstat *stat);
322cbb50 1523void printk_all_partitions(void);
2577f53f 1524int __init early_lookup_bdev(const char *pathname, dev_t *dev);
3f1266f1
CH
1525#else
1526static inline void invalidate_bdev(struct block_device *bdev)
1527{
1528}
1529static inline int sync_blockdev(struct block_device *bdev)
1530{
1531 return 0;
1532}
70164eb6
CH
1533static inline int sync_blockdev_nowait(struct block_device *bdev)
1534{
1535 return 0;
1536}
1e03a36b
CH
1537static inline void sync_bdevs(bool wait)
1538{
1539}
2d985f8c
EB
1540static inline void bdev_statx_dioalign(struct inode *inode, struct kstat *stat)
1541{
1542}
322cbb50
CH
1543static inline void printk_all_partitions(void)
1544{
1545}
cf056a43
CH
1546static inline int early_lookup_bdev(const char *pathname, dev_t *dev)
1547{
1548 return -EINVAL;
1549}
322cbb50
CH
1550#endif /* CONFIG_BLOCK */
1551
982c3b30
CB
1552int bdev_freeze(struct block_device *bdev);
1553int bdev_thaw(struct block_device *bdev);
3f1266f1 1554
5a72e899
JA
1555struct io_comp_batch {
1556 struct request *req_list;
1557 bool need_ts;
1558 void (*complete)(struct io_comp_batch *);
1559};
1560
1561#define DEFINE_IO_COMP_BATCH(name) struct io_comp_batch name = { }
1562
3f1266f1 1563#endif /* _LINUX_BLKDEV_H */