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