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