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