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