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