xref: /openbmc/linux/include/linux/blkdev.h (revision 37d838de)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 /*
3  * Portions Copyright (C) 1992 Drew Eckhardt
4  */
5 #ifndef _LINUX_BLKDEV_H
6 #define _LINUX_BLKDEV_H
7 
8 #include <linux/types.h>
9 #include <linux/blk_types.h>
10 #include <linux/device.h>
11 #include <linux/list.h>
12 #include <linux/llist.h>
13 #include <linux/minmax.h>
14 #include <linux/timer.h>
15 #include <linux/workqueue.h>
16 #include <linux/wait.h>
17 #include <linux/bio.h>
18 #include <linux/gfp.h>
19 #include <linux/kdev_t.h>
20 #include <linux/rcupdate.h>
21 #include <linux/percpu-refcount.h>
22 #include <linux/blkzoned.h>
23 #include <linux/sched.h>
24 #include <linux/sbitmap.h>
25 #include <linux/srcu.h>
26 #include <linux/uuid.h>
27 #include <linux/xarray.h>
28 
29 struct module;
30 struct request_queue;
31 struct elevator_queue;
32 struct blk_trace;
33 struct request;
34 struct sg_io_hdr;
35 struct blkcg_gq;
36 struct blk_flush_queue;
37 struct kiocb;
38 struct pr_ops;
39 struct rq_qos;
40 struct blk_queue_stats;
41 struct blk_stat_callback;
42 struct blk_crypto_profile;
43 
44 extern const struct device_type disk_type;
45 extern struct device_type part_type;
46 extern struct class block_class;
47 
48 /* Must be consistent with blk_mq_poll_stats_bkt() */
49 #define BLK_MQ_POLL_STATS_BKTS 16
50 
51 /* Doing classic polling */
52 #define BLK_MQ_POLL_CLASSIC -1
53 
54 /*
55  * Maximum number of blkcg policies allowed to be registered concurrently.
56  * Defined here to simplify include dependency.
57  */
58 #define BLKCG_MAX_POLS		6
59 
60 #define DISK_MAX_PARTS			256
61 #define DISK_NAME_LEN			32
62 
63 #define PARTITION_META_INFO_VOLNAMELTH	64
64 /*
65  * Enough for the string representation of any kind of UUID plus NULL.
66  * EFI UUID is 36 characters. MSDOS UUID is 11 characters.
67  */
68 #define PARTITION_META_INFO_UUIDLTH	(UUID_STRING_LEN + 1)
69 
70 struct partition_meta_info {
71 	char uuid[PARTITION_META_INFO_UUIDLTH];
72 	u8 volname[PARTITION_META_INFO_VOLNAMELTH];
73 };
74 
75 /**
76  * DOC: genhd capability flags
77  *
78  * ``GENHD_FL_REMOVABLE``: indicates that the block device gives access to
79  * removable media.  When set, the device remains present even when media is not
80  * inserted.  Shall not be set for devices which are removed entirely when the
81  * media is removed.
82  *
83  * ``GENHD_FL_HIDDEN``: the block device is hidden; it doesn't produce events,
84  * doesn't appear in sysfs, and can't be opened from userspace or using
85  * blkdev_get*. Used for the underlying components of multipath devices.
86  *
87  * ``GENHD_FL_NO_PART``: partition support is disabled.  The kernel will not
88  * scan for partitions from add_disk, and users can't add partitions manually.
89  *
90  */
91 enum {
92 	GENHD_FL_REMOVABLE			= 1 << 0,
93 	GENHD_FL_HIDDEN				= 1 << 1,
94 	GENHD_FL_NO_PART			= 1 << 2,
95 };
96 
97 enum {
98 	DISK_EVENT_MEDIA_CHANGE			= 1 << 0, /* media changed */
99 	DISK_EVENT_EJECT_REQUEST		= 1 << 1, /* eject requested */
100 };
101 
102 enum {
103 	/* Poll even if events_poll_msecs is unset */
104 	DISK_EVENT_FLAG_POLL			= 1 << 0,
105 	/* Forward events to udev */
106 	DISK_EVENT_FLAG_UEVENT			= 1 << 1,
107 	/* Block event polling when open for exclusive write */
108 	DISK_EVENT_FLAG_BLOCK_ON_EXCL_WRITE	= 1 << 2,
109 };
110 
111 struct disk_events;
112 struct badblocks;
113 
114 struct blk_integrity {
115 	const struct blk_integrity_profile	*profile;
116 	unsigned char				flags;
117 	unsigned char				tuple_size;
118 	unsigned char				interval_exp;
119 	unsigned char				tag_size;
120 };
121 
122 struct gendisk {
123 	/*
124 	 * major/first_minor/minors should not be set by any new driver, the
125 	 * block core will take care of allocating them automatically.
126 	 */
127 	int major;
128 	int first_minor;
129 	int minors;
130 
131 	char disk_name[DISK_NAME_LEN];	/* name of major driver */
132 
133 	unsigned short events;		/* supported events */
134 	unsigned short event_flags;	/* flags related to event processing */
135 
136 	struct xarray part_tbl;
137 	struct block_device *part0;
138 
139 	const struct block_device_operations *fops;
140 	struct request_queue *queue;
141 	void *private_data;
142 
143 	int flags;
144 	unsigned long state;
145 #define GD_NEED_PART_SCAN		0
146 #define GD_READ_ONLY			1
147 #define GD_DEAD				2
148 #define GD_NATIVE_CAPACITY		3
149 #define GD_ADDED			4
150 #define GD_SUPPRESS_PART_SCAN		5
151 
152 	struct mutex open_mutex;	/* open/close mutex */
153 	unsigned open_partitions;	/* number of open partitions */
154 
155 	struct backing_dev_info	*bdi;
156 	struct kobject *slave_dir;
157 #ifdef CONFIG_BLOCK_HOLDER_DEPRECATED
158 	struct list_head slave_bdevs;
159 #endif
160 	struct timer_rand_state *random;
161 	atomic_t sync_io;		/* RAID */
162 	struct disk_events *ev;
163 #ifdef  CONFIG_BLK_DEV_INTEGRITY
164 	struct kobject integrity_kobj;
165 #endif	/* CONFIG_BLK_DEV_INTEGRITY */
166 #if IS_ENABLED(CONFIG_CDROM)
167 	struct cdrom_device_info *cdi;
168 #endif
169 	int node_id;
170 	struct badblocks *bb;
171 	struct lockdep_map lockdep_map;
172 	u64 diskseq;
173 };
174 
175 static inline bool disk_live(struct gendisk *disk)
176 {
177 	return !inode_unhashed(disk->part0->bd_inode);
178 }
179 
180 /**
181  * disk_openers - returns how many openers are there for a disk
182  * @disk: disk to check
183  *
184  * This returns the number of openers for a disk.  Note that this value is only
185  * stable if disk->open_mutex is held.
186  *
187  * Note: Due to a quirk in the block layer open code, each open partition is
188  * only counted once even if there are multiple openers.
189  */
190 static inline unsigned int disk_openers(struct gendisk *disk)
191 {
192 	return atomic_read(&disk->part0->bd_openers);
193 }
194 
195 /*
196  * The gendisk is refcounted by the part0 block_device, and the bd_device
197  * therein is also used for device model presentation in sysfs.
198  */
199 #define dev_to_disk(device) \
200 	(dev_to_bdev(device)->bd_disk)
201 #define disk_to_dev(disk) \
202 	(&((disk)->part0->bd_device))
203 
204 #if IS_REACHABLE(CONFIG_CDROM)
205 #define disk_to_cdi(disk)	((disk)->cdi)
206 #else
207 #define disk_to_cdi(disk)	NULL
208 #endif
209 
210 static inline dev_t disk_devt(struct gendisk *disk)
211 {
212 	return MKDEV(disk->major, disk->first_minor);
213 }
214 
215 static inline int blk_validate_block_size(unsigned long bsize)
216 {
217 	if (bsize < 512 || bsize > PAGE_SIZE || !is_power_of_2(bsize))
218 		return -EINVAL;
219 
220 	return 0;
221 }
222 
223 static inline bool blk_op_is_passthrough(unsigned int op)
224 {
225 	op &= REQ_OP_MASK;
226 	return op == REQ_OP_DRV_IN || op == REQ_OP_DRV_OUT;
227 }
228 
229 /*
230  * Zoned block device models (zoned limit).
231  *
232  * Note: This needs to be ordered from the least to the most severe
233  * restrictions for the inheritance in blk_stack_limits() to work.
234  */
235 enum blk_zoned_model {
236 	BLK_ZONED_NONE = 0,	/* Regular block device */
237 	BLK_ZONED_HA,		/* Host-aware zoned block device */
238 	BLK_ZONED_HM,		/* Host-managed zoned block device */
239 };
240 
241 /*
242  * BLK_BOUNCE_NONE:	never bounce (default)
243  * BLK_BOUNCE_HIGH:	bounce all highmem pages
244  */
245 enum blk_bounce {
246 	BLK_BOUNCE_NONE,
247 	BLK_BOUNCE_HIGH,
248 };
249 
250 struct queue_limits {
251 	enum blk_bounce		bounce;
252 	unsigned long		seg_boundary_mask;
253 	unsigned long		virt_boundary_mask;
254 
255 	unsigned int		max_hw_sectors;
256 	unsigned int		max_dev_sectors;
257 	unsigned int		chunk_sectors;
258 	unsigned int		max_sectors;
259 	unsigned int		max_segment_size;
260 	unsigned int		physical_block_size;
261 	unsigned int		logical_block_size;
262 	unsigned int		alignment_offset;
263 	unsigned int		io_min;
264 	unsigned int		io_opt;
265 	unsigned int		max_discard_sectors;
266 	unsigned int		max_hw_discard_sectors;
267 	unsigned int		max_secure_erase_sectors;
268 	unsigned int		max_write_zeroes_sectors;
269 	unsigned int		max_zone_append_sectors;
270 	unsigned int		discard_granularity;
271 	unsigned int		discard_alignment;
272 	unsigned int		zone_write_granularity;
273 
274 	unsigned short		max_segments;
275 	unsigned short		max_integrity_segments;
276 	unsigned short		max_discard_segments;
277 
278 	unsigned char		misaligned;
279 	unsigned char		discard_misaligned;
280 	unsigned char		raid_partial_stripes_expensive;
281 	enum blk_zoned_model	zoned;
282 };
283 
284 typedef int (*report_zones_cb)(struct blk_zone *zone, unsigned int idx,
285 			       void *data);
286 
287 void blk_queue_set_zoned(struct gendisk *disk, enum blk_zoned_model model);
288 
289 #ifdef CONFIG_BLK_DEV_ZONED
290 
291 #define BLK_ALL_ZONES  ((unsigned int)-1)
292 int blkdev_report_zones(struct block_device *bdev, sector_t sector,
293 			unsigned int nr_zones, report_zones_cb cb, void *data);
294 unsigned int blkdev_nr_zones(struct gendisk *disk);
295 extern int blkdev_zone_mgmt(struct block_device *bdev, enum req_opf op,
296 			    sector_t sectors, sector_t nr_sectors,
297 			    gfp_t gfp_mask);
298 int blk_revalidate_disk_zones(struct gendisk *disk,
299 			      void (*update_driver_data)(struct gendisk *disk));
300 
301 extern int blkdev_report_zones_ioctl(struct block_device *bdev, fmode_t mode,
302 				     unsigned int cmd, unsigned long arg);
303 extern int blkdev_zone_mgmt_ioctl(struct block_device *bdev, fmode_t mode,
304 				  unsigned int cmd, unsigned long arg);
305 
306 #else /* CONFIG_BLK_DEV_ZONED */
307 
308 static inline unsigned int blkdev_nr_zones(struct gendisk *disk)
309 {
310 	return 0;
311 }
312 
313 static inline int blkdev_report_zones_ioctl(struct block_device *bdev,
314 					    fmode_t mode, unsigned int cmd,
315 					    unsigned long arg)
316 {
317 	return -ENOTTY;
318 }
319 
320 static inline int blkdev_zone_mgmt_ioctl(struct block_device *bdev,
321 					 fmode_t mode, unsigned int cmd,
322 					 unsigned long arg)
323 {
324 	return -ENOTTY;
325 }
326 
327 #endif /* CONFIG_BLK_DEV_ZONED */
328 
329 /*
330  * Independent access ranges: struct blk_independent_access_range describes
331  * a range of contiguous sectors that can be accessed using device command
332  * execution resources that are independent from the resources used for
333  * other access ranges. This is typically found with single-LUN multi-actuator
334  * HDDs where each access range is served by a different set of heads.
335  * The set of independent ranges supported by the device is defined using
336  * struct blk_independent_access_ranges. The independent ranges must not overlap
337  * and must include all sectors within the disk capacity (no sector holes
338  * allowed).
339  * For a device with multiple ranges, requests targeting sectors in different
340  * ranges can be executed in parallel. A request can straddle an access range
341  * boundary.
342  */
343 struct blk_independent_access_range {
344 	struct kobject		kobj;
345 	struct request_queue	*queue;
346 	sector_t		sector;
347 	sector_t		nr_sectors;
348 };
349 
350 struct blk_independent_access_ranges {
351 	struct kobject				kobj;
352 	bool					sysfs_registered;
353 	unsigned int				nr_ia_ranges;
354 	struct blk_independent_access_range	ia_range[];
355 };
356 
357 struct request_queue {
358 	struct request		*last_merge;
359 	struct elevator_queue	*elevator;
360 
361 	struct percpu_ref	q_usage_counter;
362 
363 	struct blk_queue_stats	*stats;
364 	struct rq_qos		*rq_qos;
365 
366 	const struct blk_mq_ops	*mq_ops;
367 
368 	/* sw queues */
369 	struct blk_mq_ctx __percpu	*queue_ctx;
370 
371 	unsigned int		queue_depth;
372 
373 	/* hw dispatch queues */
374 	struct xarray		hctx_table;
375 	unsigned int		nr_hw_queues;
376 
377 	/*
378 	 * The queue owner gets to use this for whatever they like.
379 	 * ll_rw_blk doesn't touch it.
380 	 */
381 	void			*queuedata;
382 
383 	/*
384 	 * various queue flags, see QUEUE_* below
385 	 */
386 	unsigned long		queue_flags;
387 	/*
388 	 * Number of contexts that have called blk_set_pm_only(). If this
389 	 * counter is above zero then only RQF_PM requests are processed.
390 	 */
391 	atomic_t		pm_only;
392 
393 	/*
394 	 * ida allocated id for this queue.  Used to index queues from
395 	 * ioctx.
396 	 */
397 	int			id;
398 
399 	spinlock_t		queue_lock;
400 
401 	struct gendisk		*disk;
402 
403 	/*
404 	 * queue kobject
405 	 */
406 	struct kobject kobj;
407 
408 	/*
409 	 * mq queue kobject
410 	 */
411 	struct kobject *mq_kobj;
412 
413 #ifdef  CONFIG_BLK_DEV_INTEGRITY
414 	struct blk_integrity integrity;
415 #endif	/* CONFIG_BLK_DEV_INTEGRITY */
416 
417 #ifdef CONFIG_PM
418 	struct device		*dev;
419 	enum rpm_status		rpm_status;
420 #endif
421 
422 	/*
423 	 * queue settings
424 	 */
425 	unsigned long		nr_requests;	/* Max # of requests */
426 
427 	unsigned int		dma_pad_mask;
428 	unsigned int		dma_alignment;
429 
430 #ifdef CONFIG_BLK_INLINE_ENCRYPTION
431 	struct blk_crypto_profile *crypto_profile;
432 	struct kobject *crypto_kobject;
433 #endif
434 
435 	unsigned int		rq_timeout;
436 	int			poll_nsec;
437 
438 	struct blk_stat_callback	*poll_cb;
439 	struct blk_rq_stat	*poll_stat;
440 
441 	struct timer_list	timeout;
442 	struct work_struct	timeout_work;
443 
444 	atomic_t		nr_active_requests_shared_tags;
445 
446 	struct blk_mq_tags	*sched_shared_tags;
447 
448 	struct list_head	icq_list;
449 #ifdef CONFIG_BLK_CGROUP
450 	DECLARE_BITMAP		(blkcg_pols, BLKCG_MAX_POLS);
451 	struct blkcg_gq		*root_blkg;
452 	struct list_head	blkg_list;
453 #endif
454 
455 	struct queue_limits	limits;
456 
457 	unsigned int		required_elevator_features;
458 
459 #ifdef CONFIG_BLK_DEV_ZONED
460 	/*
461 	 * Zoned block device information for request dispatch control.
462 	 * nr_zones is the total number of zones of the device. This is always
463 	 * 0 for regular block devices. conv_zones_bitmap is a bitmap of nr_zones
464 	 * bits which indicates if a zone is conventional (bit set) or
465 	 * sequential (bit clear). seq_zones_wlock is a bitmap of nr_zones
466 	 * bits which indicates if a zone is write locked, that is, if a write
467 	 * request targeting the zone was dispatched. All three fields are
468 	 * initialized by the low level device driver (e.g. scsi/sd.c).
469 	 * Stacking drivers (device mappers) may or may not initialize
470 	 * these fields.
471 	 *
472 	 * Reads of this information must be protected with blk_queue_enter() /
473 	 * blk_queue_exit(). Modifying this information is only allowed while
474 	 * no requests are being processed. See also blk_mq_freeze_queue() and
475 	 * blk_mq_unfreeze_queue().
476 	 */
477 	unsigned int		nr_zones;
478 	unsigned long		*conv_zones_bitmap;
479 	unsigned long		*seq_zones_wlock;
480 	unsigned int		max_open_zones;
481 	unsigned int		max_active_zones;
482 #endif /* CONFIG_BLK_DEV_ZONED */
483 
484 	int			node;
485 	struct mutex		debugfs_mutex;
486 #ifdef CONFIG_BLK_DEV_IO_TRACE
487 	struct blk_trace __rcu	*blk_trace;
488 #endif
489 	/*
490 	 * for flush operations
491 	 */
492 	struct blk_flush_queue	*fq;
493 
494 	struct list_head	requeue_list;
495 	spinlock_t		requeue_lock;
496 	struct delayed_work	requeue_work;
497 
498 	struct mutex		sysfs_lock;
499 	struct mutex		sysfs_dir_lock;
500 
501 	/*
502 	 * for reusing dead hctx instance in case of updating
503 	 * nr_hw_queues
504 	 */
505 	struct list_head	unused_hctx_list;
506 	spinlock_t		unused_hctx_lock;
507 
508 	int			mq_freeze_depth;
509 
510 #ifdef CONFIG_BLK_DEV_THROTTLING
511 	/* Throttle data */
512 	struct throtl_data *td;
513 #endif
514 	struct rcu_head		rcu_head;
515 	wait_queue_head_t	mq_freeze_wq;
516 	/*
517 	 * Protect concurrent access to q_usage_counter by
518 	 * percpu_ref_kill() and percpu_ref_reinit().
519 	 */
520 	struct mutex		mq_freeze_lock;
521 
522 	int			quiesce_depth;
523 
524 	struct blk_mq_tag_set	*tag_set;
525 	struct list_head	tag_set_list;
526 	struct bio_set		bio_split;
527 
528 	struct dentry		*debugfs_dir;
529 
530 #ifdef CONFIG_BLK_DEBUG_FS
531 	struct dentry		*sched_debugfs_dir;
532 	struct dentry		*rqos_debugfs_dir;
533 #endif
534 
535 	bool			mq_sysfs_init_done;
536 
537 	/*
538 	 * Independent sector access ranges. This is always NULL for
539 	 * devices that do not have multiple independent access ranges.
540 	 */
541 	struct blk_independent_access_ranges *ia_ranges;
542 
543 	/**
544 	 * @srcu: Sleepable RCU. Use as lock when type of the request queue
545 	 * is blocking (BLK_MQ_F_BLOCKING). Must be the last member
546 	 */
547 	struct srcu_struct	srcu[];
548 };
549 
550 /* Keep blk_queue_flag_name[] in sync with the definitions below */
551 #define QUEUE_FLAG_STOPPED	0	/* queue is stopped */
552 #define QUEUE_FLAG_DYING	1	/* queue being torn down */
553 #define QUEUE_FLAG_HAS_SRCU	2	/* SRCU is allocated */
554 #define QUEUE_FLAG_NOMERGES     3	/* disable merge attempts */
555 #define QUEUE_FLAG_SAME_COMP	4	/* complete on same CPU-group */
556 #define QUEUE_FLAG_FAIL_IO	5	/* fake timeout */
557 #define QUEUE_FLAG_NONROT	6	/* non-rotational device (SSD) */
558 #define QUEUE_FLAG_VIRT		QUEUE_FLAG_NONROT /* paravirt device */
559 #define QUEUE_FLAG_IO_STAT	7	/* do disk/partitions IO accounting */
560 #define QUEUE_FLAG_NOXMERGES	9	/* No extended merges */
561 #define QUEUE_FLAG_ADD_RANDOM	10	/* Contributes to random pool */
562 #define QUEUE_FLAG_SAME_FORCE	12	/* force complete on same CPU */
563 #define QUEUE_FLAG_DEAD		13	/* queue tear-down finished */
564 #define QUEUE_FLAG_INIT_DONE	14	/* queue is initialized */
565 #define QUEUE_FLAG_STABLE_WRITES 15	/* don't modify blks until WB is done */
566 #define QUEUE_FLAG_POLL		16	/* IO polling enabled if set */
567 #define QUEUE_FLAG_WC		17	/* Write back caching */
568 #define QUEUE_FLAG_FUA		18	/* device supports FUA writes */
569 #define QUEUE_FLAG_DAX		19	/* device supports DAX */
570 #define QUEUE_FLAG_STATS	20	/* track IO start and completion times */
571 #define QUEUE_FLAG_REGISTERED	22	/* queue has been registered to a disk */
572 #define QUEUE_FLAG_QUIESCED	24	/* queue has been quiesced */
573 #define QUEUE_FLAG_PCI_P2PDMA	25	/* device supports PCI p2p requests */
574 #define QUEUE_FLAG_ZONE_RESETALL 26	/* supports Zone Reset All */
575 #define QUEUE_FLAG_RQ_ALLOC_TIME 27	/* record rq->alloc_time_ns */
576 #define QUEUE_FLAG_HCTX_ACTIVE	28	/* at least one blk-mq hctx is active */
577 #define QUEUE_FLAG_NOWAIT       29	/* device supports NOWAIT */
578 
579 #define QUEUE_FLAG_MQ_DEFAULT	((1 << QUEUE_FLAG_IO_STAT) |		\
580 				 (1 << QUEUE_FLAG_SAME_COMP) |		\
581 				 (1 << QUEUE_FLAG_NOWAIT))
582 
583 void blk_queue_flag_set(unsigned int flag, struct request_queue *q);
584 void blk_queue_flag_clear(unsigned int flag, struct request_queue *q);
585 bool blk_queue_flag_test_and_set(unsigned int flag, struct request_queue *q);
586 
587 #define blk_queue_stopped(q)	test_bit(QUEUE_FLAG_STOPPED, &(q)->queue_flags)
588 #define blk_queue_dying(q)	test_bit(QUEUE_FLAG_DYING, &(q)->queue_flags)
589 #define blk_queue_has_srcu(q)	test_bit(QUEUE_FLAG_HAS_SRCU, &(q)->queue_flags)
590 #define blk_queue_dead(q)	test_bit(QUEUE_FLAG_DEAD, &(q)->queue_flags)
591 #define blk_queue_init_done(q)	test_bit(QUEUE_FLAG_INIT_DONE, &(q)->queue_flags)
592 #define blk_queue_nomerges(q)	test_bit(QUEUE_FLAG_NOMERGES, &(q)->queue_flags)
593 #define blk_queue_noxmerges(q)	\
594 	test_bit(QUEUE_FLAG_NOXMERGES, &(q)->queue_flags)
595 #define blk_queue_nonrot(q)	test_bit(QUEUE_FLAG_NONROT, &(q)->queue_flags)
596 #define blk_queue_stable_writes(q) \
597 	test_bit(QUEUE_FLAG_STABLE_WRITES, &(q)->queue_flags)
598 #define blk_queue_io_stat(q)	test_bit(QUEUE_FLAG_IO_STAT, &(q)->queue_flags)
599 #define blk_queue_add_random(q)	test_bit(QUEUE_FLAG_ADD_RANDOM, &(q)->queue_flags)
600 #define blk_queue_zone_resetall(q)	\
601 	test_bit(QUEUE_FLAG_ZONE_RESETALL, &(q)->queue_flags)
602 #define blk_queue_dax(q)	test_bit(QUEUE_FLAG_DAX, &(q)->queue_flags)
603 #define blk_queue_pci_p2pdma(q)	\
604 	test_bit(QUEUE_FLAG_PCI_P2PDMA, &(q)->queue_flags)
605 #ifdef CONFIG_BLK_RQ_ALLOC_TIME
606 #define blk_queue_rq_alloc_time(q)	\
607 	test_bit(QUEUE_FLAG_RQ_ALLOC_TIME, &(q)->queue_flags)
608 #else
609 #define blk_queue_rq_alloc_time(q)	false
610 #endif
611 
612 #define blk_noretry_request(rq) \
613 	((rq)->cmd_flags & (REQ_FAILFAST_DEV|REQ_FAILFAST_TRANSPORT| \
614 			     REQ_FAILFAST_DRIVER))
615 #define blk_queue_quiesced(q)	test_bit(QUEUE_FLAG_QUIESCED, &(q)->queue_flags)
616 #define blk_queue_pm_only(q)	atomic_read(&(q)->pm_only)
617 #define blk_queue_registered(q)	test_bit(QUEUE_FLAG_REGISTERED, &(q)->queue_flags)
618 #define blk_queue_nowait(q)	test_bit(QUEUE_FLAG_NOWAIT, &(q)->queue_flags)
619 
620 extern void blk_set_pm_only(struct request_queue *q);
621 extern void blk_clear_pm_only(struct request_queue *q);
622 
623 #define list_entry_rq(ptr)	list_entry((ptr), struct request, queuelist)
624 
625 #define dma_map_bvec(dev, bv, dir, attrs) \
626 	dma_map_page_attrs(dev, (bv)->bv_page, (bv)->bv_offset, (bv)->bv_len, \
627 	(dir), (attrs))
628 
629 static inline bool queue_is_mq(struct request_queue *q)
630 {
631 	return q->mq_ops;
632 }
633 
634 #ifdef CONFIG_PM
635 static inline enum rpm_status queue_rpm_status(struct request_queue *q)
636 {
637 	return q->rpm_status;
638 }
639 #else
640 static inline enum rpm_status queue_rpm_status(struct request_queue *q)
641 {
642 	return RPM_ACTIVE;
643 }
644 #endif
645 
646 static inline enum blk_zoned_model
647 blk_queue_zoned_model(struct request_queue *q)
648 {
649 	if (IS_ENABLED(CONFIG_BLK_DEV_ZONED))
650 		return q->limits.zoned;
651 	return BLK_ZONED_NONE;
652 }
653 
654 static inline bool blk_queue_is_zoned(struct request_queue *q)
655 {
656 	switch (blk_queue_zoned_model(q)) {
657 	case BLK_ZONED_HA:
658 	case BLK_ZONED_HM:
659 		return true;
660 	default:
661 		return false;
662 	}
663 }
664 
665 static inline sector_t blk_queue_zone_sectors(struct request_queue *q)
666 {
667 	return blk_queue_is_zoned(q) ? q->limits.chunk_sectors : 0;
668 }
669 
670 #ifdef CONFIG_BLK_DEV_ZONED
671 static inline unsigned int blk_queue_nr_zones(struct request_queue *q)
672 {
673 	return blk_queue_is_zoned(q) ? q->nr_zones : 0;
674 }
675 
676 static inline unsigned int blk_queue_zone_no(struct request_queue *q,
677 					     sector_t sector)
678 {
679 	if (!blk_queue_is_zoned(q))
680 		return 0;
681 	return sector >> ilog2(q->limits.chunk_sectors);
682 }
683 
684 static inline bool blk_queue_zone_is_seq(struct request_queue *q,
685 					 sector_t sector)
686 {
687 	if (!blk_queue_is_zoned(q))
688 		return false;
689 	if (!q->conv_zones_bitmap)
690 		return true;
691 	return !test_bit(blk_queue_zone_no(q, sector), q->conv_zones_bitmap);
692 }
693 
694 static inline void blk_queue_max_open_zones(struct request_queue *q,
695 		unsigned int max_open_zones)
696 {
697 	q->max_open_zones = max_open_zones;
698 }
699 
700 static inline unsigned int queue_max_open_zones(const struct request_queue *q)
701 {
702 	return q->max_open_zones;
703 }
704 
705 static inline void blk_queue_max_active_zones(struct request_queue *q,
706 		unsigned int max_active_zones)
707 {
708 	q->max_active_zones = max_active_zones;
709 }
710 
711 static inline unsigned int queue_max_active_zones(const struct request_queue *q)
712 {
713 	return q->max_active_zones;
714 }
715 #else /* CONFIG_BLK_DEV_ZONED */
716 static inline unsigned int blk_queue_nr_zones(struct request_queue *q)
717 {
718 	return 0;
719 }
720 static inline bool blk_queue_zone_is_seq(struct request_queue *q,
721 					 sector_t sector)
722 {
723 	return false;
724 }
725 static inline unsigned int blk_queue_zone_no(struct request_queue *q,
726 					     sector_t sector)
727 {
728 	return 0;
729 }
730 static inline unsigned int queue_max_open_zones(const struct request_queue *q)
731 {
732 	return 0;
733 }
734 static inline unsigned int queue_max_active_zones(const struct request_queue *q)
735 {
736 	return 0;
737 }
738 #endif /* CONFIG_BLK_DEV_ZONED */
739 
740 static inline unsigned int blk_queue_depth(struct request_queue *q)
741 {
742 	if (q->queue_depth)
743 		return q->queue_depth;
744 
745 	return q->nr_requests;
746 }
747 
748 /*
749  * default timeout for SG_IO if none specified
750  */
751 #define BLK_DEFAULT_SG_TIMEOUT	(60 * HZ)
752 #define BLK_MIN_SG_TIMEOUT	(7 * HZ)
753 
754 /* This should not be used directly - use rq_for_each_segment */
755 #define for_each_bio(_bio)		\
756 	for (; _bio; _bio = _bio->bi_next)
757 
758 int __must_check device_add_disk(struct device *parent, struct gendisk *disk,
759 				 const struct attribute_group **groups);
760 static inline int __must_check add_disk(struct gendisk *disk)
761 {
762 	return device_add_disk(NULL, disk, NULL);
763 }
764 void del_gendisk(struct gendisk *gp);
765 void invalidate_disk(struct gendisk *disk);
766 void set_disk_ro(struct gendisk *disk, bool read_only);
767 void disk_uevent(struct gendisk *disk, enum kobject_action action);
768 
769 static inline int get_disk_ro(struct gendisk *disk)
770 {
771 	return disk->part0->bd_read_only ||
772 		test_bit(GD_READ_ONLY, &disk->state);
773 }
774 
775 static inline int bdev_read_only(struct block_device *bdev)
776 {
777 	return bdev->bd_read_only || get_disk_ro(bdev->bd_disk);
778 }
779 
780 bool set_capacity_and_notify(struct gendisk *disk, sector_t size);
781 bool disk_force_media_change(struct gendisk *disk, unsigned int events);
782 
783 void add_disk_randomness(struct gendisk *disk) __latent_entropy;
784 void rand_initialize_disk(struct gendisk *disk);
785 
786 static inline sector_t get_start_sect(struct block_device *bdev)
787 {
788 	return bdev->bd_start_sect;
789 }
790 
791 static inline sector_t bdev_nr_sectors(struct block_device *bdev)
792 {
793 	return bdev->bd_nr_sectors;
794 }
795 
796 static inline loff_t bdev_nr_bytes(struct block_device *bdev)
797 {
798 	return (loff_t)bdev_nr_sectors(bdev) << SECTOR_SHIFT;
799 }
800 
801 static inline sector_t get_capacity(struct gendisk *disk)
802 {
803 	return bdev_nr_sectors(disk->part0);
804 }
805 
806 static inline u64 sb_bdev_nr_blocks(struct super_block *sb)
807 {
808 	return bdev_nr_sectors(sb->s_bdev) >>
809 		(sb->s_blocksize_bits - SECTOR_SHIFT);
810 }
811 
812 int bdev_disk_changed(struct gendisk *disk, bool invalidate);
813 
814 struct gendisk *__alloc_disk_node(struct request_queue *q, int node_id,
815 		struct lock_class_key *lkclass);
816 void put_disk(struct gendisk *disk);
817 struct gendisk *__blk_alloc_disk(int node, struct lock_class_key *lkclass);
818 
819 /**
820  * blk_alloc_disk - allocate a gendisk structure
821  * @node_id: numa node to allocate on
822  *
823  * Allocate and pre-initialize a gendisk structure for use with BIO based
824  * drivers.
825  *
826  * Context: can sleep
827  */
828 #define blk_alloc_disk(node_id)						\
829 ({									\
830 	static struct lock_class_key __key;				\
831 									\
832 	__blk_alloc_disk(node_id, &__key);				\
833 })
834 void blk_cleanup_disk(struct gendisk *disk);
835 
836 int __register_blkdev(unsigned int major, const char *name,
837 		void (*probe)(dev_t devt));
838 #define register_blkdev(major, name) \
839 	__register_blkdev(major, name, NULL)
840 void unregister_blkdev(unsigned int major, const char *name);
841 
842 bool bdev_check_media_change(struct block_device *bdev);
843 int __invalidate_device(struct block_device *bdev, bool kill_dirty);
844 void set_capacity(struct gendisk *disk, sector_t size);
845 
846 #ifdef CONFIG_BLOCK_HOLDER_DEPRECATED
847 int bd_link_disk_holder(struct block_device *bdev, struct gendisk *disk);
848 void bd_unlink_disk_holder(struct block_device *bdev, struct gendisk *disk);
849 int bd_register_pending_holders(struct gendisk *disk);
850 #else
851 static inline int bd_link_disk_holder(struct block_device *bdev,
852 				      struct gendisk *disk)
853 {
854 	return 0;
855 }
856 static inline void bd_unlink_disk_holder(struct block_device *bdev,
857 					 struct gendisk *disk)
858 {
859 }
860 static inline int bd_register_pending_holders(struct gendisk *disk)
861 {
862 	return 0;
863 }
864 #endif /* CONFIG_BLOCK_HOLDER_DEPRECATED */
865 
866 dev_t part_devt(struct gendisk *disk, u8 partno);
867 void inc_diskseq(struct gendisk *disk);
868 dev_t blk_lookup_devt(const char *name, int partno);
869 void blk_request_module(dev_t devt);
870 
871 extern int blk_register_queue(struct gendisk *disk);
872 extern void blk_unregister_queue(struct gendisk *disk);
873 void submit_bio_noacct(struct bio *bio);
874 
875 extern int blk_lld_busy(struct request_queue *q);
876 extern void blk_queue_split(struct bio **);
877 extern int blk_queue_enter(struct request_queue *q, blk_mq_req_flags_t flags);
878 extern void blk_queue_exit(struct request_queue *q);
879 extern void blk_sync_queue(struct request_queue *q);
880 
881 /* Helper to convert REQ_OP_XXX to its string format XXX */
882 extern const char *blk_op_str(unsigned int op);
883 
884 int blk_status_to_errno(blk_status_t status);
885 blk_status_t errno_to_blk_status(int errno);
886 
887 /* only poll the hardware once, don't continue until a completion was found */
888 #define BLK_POLL_ONESHOT		(1 << 0)
889 /* do not sleep to wait for the expected completion time */
890 #define BLK_POLL_NOSLEEP		(1 << 1)
891 int bio_poll(struct bio *bio, struct io_comp_batch *iob, unsigned int flags);
892 int iocb_bio_iopoll(struct kiocb *kiocb, struct io_comp_batch *iob,
893 			unsigned int flags);
894 
895 static inline struct request_queue *bdev_get_queue(struct block_device *bdev)
896 {
897 	return bdev->bd_queue;	/* this is never NULL */
898 }
899 
900 #ifdef CONFIG_BLK_DEV_ZONED
901 
902 /* Helper to convert BLK_ZONE_ZONE_XXX to its string format XXX */
903 const char *blk_zone_cond_str(enum blk_zone_cond zone_cond);
904 
905 static inline unsigned int bio_zone_no(struct bio *bio)
906 {
907 	return blk_queue_zone_no(bdev_get_queue(bio->bi_bdev),
908 				 bio->bi_iter.bi_sector);
909 }
910 
911 static inline unsigned int bio_zone_is_seq(struct bio *bio)
912 {
913 	return blk_queue_zone_is_seq(bdev_get_queue(bio->bi_bdev),
914 				     bio->bi_iter.bi_sector);
915 }
916 #endif /* CONFIG_BLK_DEV_ZONED */
917 
918 static inline unsigned int blk_queue_get_max_sectors(struct request_queue *q,
919 						     int op)
920 {
921 	if (unlikely(op == REQ_OP_DISCARD || op == REQ_OP_SECURE_ERASE))
922 		return min(q->limits.max_discard_sectors,
923 			   UINT_MAX >> SECTOR_SHIFT);
924 
925 	if (unlikely(op == REQ_OP_WRITE_ZEROES))
926 		return q->limits.max_write_zeroes_sectors;
927 
928 	return q->limits.max_sectors;
929 }
930 
931 /*
932  * Return maximum size of a request at given offset. Only valid for
933  * file system requests.
934  */
935 static inline unsigned int blk_max_size_offset(struct request_queue *q,
936 					       sector_t offset,
937 					       unsigned int chunk_sectors)
938 {
939 	if (!chunk_sectors) {
940 		if (q->limits.chunk_sectors)
941 			chunk_sectors = q->limits.chunk_sectors;
942 		else
943 			return q->limits.max_sectors;
944 	}
945 
946 	if (likely(is_power_of_2(chunk_sectors)))
947 		chunk_sectors -= offset & (chunk_sectors - 1);
948 	else
949 		chunk_sectors -= sector_div(offset, chunk_sectors);
950 
951 	return min(q->limits.max_sectors, chunk_sectors);
952 }
953 
954 /*
955  * Access functions for manipulating queue properties
956  */
957 extern void blk_cleanup_queue(struct request_queue *);
958 void blk_queue_bounce_limit(struct request_queue *q, enum blk_bounce limit);
959 extern void blk_queue_max_hw_sectors(struct request_queue *, unsigned int);
960 extern void blk_queue_chunk_sectors(struct request_queue *, unsigned int);
961 extern void blk_queue_max_segments(struct request_queue *, unsigned short);
962 extern void blk_queue_max_discard_segments(struct request_queue *,
963 		unsigned short);
964 void blk_queue_max_secure_erase_sectors(struct request_queue *q,
965 		unsigned int max_sectors);
966 extern void blk_queue_max_segment_size(struct request_queue *, unsigned int);
967 extern void blk_queue_max_discard_sectors(struct request_queue *q,
968 		unsigned int max_discard_sectors);
969 extern void blk_queue_max_write_zeroes_sectors(struct request_queue *q,
970 		unsigned int max_write_same_sectors);
971 extern void blk_queue_logical_block_size(struct request_queue *, unsigned int);
972 extern void blk_queue_max_zone_append_sectors(struct request_queue *q,
973 		unsigned int max_zone_append_sectors);
974 extern void blk_queue_physical_block_size(struct request_queue *, unsigned int);
975 void blk_queue_zone_write_granularity(struct request_queue *q,
976 				      unsigned int size);
977 extern void blk_queue_alignment_offset(struct request_queue *q,
978 				       unsigned int alignment);
979 void disk_update_readahead(struct gendisk *disk);
980 extern void blk_limits_io_min(struct queue_limits *limits, unsigned int min);
981 extern void blk_queue_io_min(struct request_queue *q, unsigned int min);
982 extern void blk_limits_io_opt(struct queue_limits *limits, unsigned int opt);
983 extern void blk_queue_io_opt(struct request_queue *q, unsigned int opt);
984 extern void blk_set_queue_depth(struct request_queue *q, unsigned int depth);
985 extern void blk_set_default_limits(struct queue_limits *lim);
986 extern void blk_set_stacking_limits(struct queue_limits *lim);
987 extern int blk_stack_limits(struct queue_limits *t, struct queue_limits *b,
988 			    sector_t offset);
989 extern void disk_stack_limits(struct gendisk *disk, struct block_device *bdev,
990 			      sector_t offset);
991 extern void blk_queue_update_dma_pad(struct request_queue *, unsigned int);
992 extern void blk_queue_segment_boundary(struct request_queue *, unsigned long);
993 extern void blk_queue_virt_boundary(struct request_queue *, unsigned long);
994 extern void blk_queue_dma_alignment(struct request_queue *, int);
995 extern void blk_queue_update_dma_alignment(struct request_queue *, int);
996 extern void blk_queue_rq_timeout(struct request_queue *, unsigned int);
997 extern void blk_queue_write_cache(struct request_queue *q, bool enabled, bool fua);
998 
999 struct blk_independent_access_ranges *
1000 disk_alloc_independent_access_ranges(struct gendisk *disk, int nr_ia_ranges);
1001 void disk_set_independent_access_ranges(struct gendisk *disk,
1002 				struct blk_independent_access_ranges *iars);
1003 
1004 /*
1005  * Elevator features for blk_queue_required_elevator_features:
1006  */
1007 /* Supports zoned block devices sequential write constraint */
1008 #define ELEVATOR_F_ZBD_SEQ_WRITE	(1U << 0)
1009 /* Supports scheduling on multiple hardware queues */
1010 #define ELEVATOR_F_MQ_AWARE		(1U << 1)
1011 
1012 extern void blk_queue_required_elevator_features(struct request_queue *q,
1013 						 unsigned int features);
1014 extern bool blk_queue_can_use_dma_map_merging(struct request_queue *q,
1015 					      struct device *dev);
1016 
1017 bool __must_check blk_get_queue(struct request_queue *);
1018 extern void blk_put_queue(struct request_queue *);
1019 
1020 void blk_mark_disk_dead(struct gendisk *disk);
1021 
1022 #ifdef CONFIG_BLOCK
1023 /*
1024  * blk_plug permits building a queue of related requests by holding the I/O
1025  * fragments for a short period. This allows merging of sequential requests
1026  * into single larger request. As the requests are moved from a per-task list to
1027  * the device's request_queue in a batch, this results in improved scalability
1028  * as the lock contention for request_queue lock is reduced.
1029  *
1030  * It is ok not to disable preemption when adding the request to the plug list
1031  * or when attempting a merge. For details, please see schedule() where
1032  * blk_flush_plug() is called.
1033  */
1034 struct blk_plug {
1035 	struct request *mq_list; /* blk-mq requests */
1036 
1037 	/* if ios_left is > 1, we can batch tag/rq allocations */
1038 	struct request *cached_rq;
1039 	unsigned short nr_ios;
1040 
1041 	unsigned short rq_count;
1042 
1043 	bool multiple_queues;
1044 	bool has_elevator;
1045 	bool nowait;
1046 
1047 	struct list_head cb_list; /* md requires an unplug callback */
1048 };
1049 
1050 struct blk_plug_cb;
1051 typedef void (*blk_plug_cb_fn)(struct blk_plug_cb *, bool);
1052 struct blk_plug_cb {
1053 	struct list_head list;
1054 	blk_plug_cb_fn callback;
1055 	void *data;
1056 };
1057 extern struct blk_plug_cb *blk_check_plugged(blk_plug_cb_fn unplug,
1058 					     void *data, int size);
1059 extern void blk_start_plug(struct blk_plug *);
1060 extern void blk_start_plug_nr_ios(struct blk_plug *, unsigned short);
1061 extern void blk_finish_plug(struct blk_plug *);
1062 
1063 void __blk_flush_plug(struct blk_plug *plug, bool from_schedule);
1064 static inline void blk_flush_plug(struct blk_plug *plug, bool async)
1065 {
1066 	if (plug)
1067 		__blk_flush_plug(plug, async);
1068 }
1069 
1070 int blkdev_issue_flush(struct block_device *bdev);
1071 long nr_blockdev_pages(void);
1072 #else /* CONFIG_BLOCK */
1073 struct blk_plug {
1074 };
1075 
1076 static inline void blk_start_plug_nr_ios(struct blk_plug *plug,
1077 					 unsigned short nr_ios)
1078 {
1079 }
1080 
1081 static inline void blk_start_plug(struct blk_plug *plug)
1082 {
1083 }
1084 
1085 static inline void blk_finish_plug(struct blk_plug *plug)
1086 {
1087 }
1088 
1089 static inline void blk_flush_plug(struct blk_plug *plug, bool async)
1090 {
1091 }
1092 
1093 static inline int blkdev_issue_flush(struct block_device *bdev)
1094 {
1095 	return 0;
1096 }
1097 
1098 static inline long nr_blockdev_pages(void)
1099 {
1100 	return 0;
1101 }
1102 #endif /* CONFIG_BLOCK */
1103 
1104 extern void blk_io_schedule(void);
1105 
1106 int blkdev_issue_discard(struct block_device *bdev, sector_t sector,
1107 		sector_t nr_sects, gfp_t gfp_mask);
1108 int __blkdev_issue_discard(struct block_device *bdev, sector_t sector,
1109 		sector_t nr_sects, gfp_t gfp_mask, struct bio **biop);
1110 int blkdev_issue_secure_erase(struct block_device *bdev, sector_t sector,
1111 		sector_t nr_sects, gfp_t gfp);
1112 
1113 #define BLKDEV_ZERO_NOUNMAP	(1 << 0)  /* do not free blocks */
1114 #define BLKDEV_ZERO_NOFALLBACK	(1 << 1)  /* don't write explicit zeroes */
1115 
1116 extern int __blkdev_issue_zeroout(struct block_device *bdev, sector_t sector,
1117 		sector_t nr_sects, gfp_t gfp_mask, struct bio **biop,
1118 		unsigned flags);
1119 extern int blkdev_issue_zeroout(struct block_device *bdev, sector_t sector,
1120 		sector_t nr_sects, gfp_t gfp_mask, unsigned flags);
1121 
1122 static inline int sb_issue_discard(struct super_block *sb, sector_t block,
1123 		sector_t nr_blocks, gfp_t gfp_mask, unsigned long flags)
1124 {
1125 	return blkdev_issue_discard(sb->s_bdev,
1126 				    block << (sb->s_blocksize_bits -
1127 					      SECTOR_SHIFT),
1128 				    nr_blocks << (sb->s_blocksize_bits -
1129 						  SECTOR_SHIFT),
1130 				    gfp_mask);
1131 }
1132 static inline int sb_issue_zeroout(struct super_block *sb, sector_t block,
1133 		sector_t nr_blocks, gfp_t gfp_mask)
1134 {
1135 	return blkdev_issue_zeroout(sb->s_bdev,
1136 				    block << (sb->s_blocksize_bits -
1137 					      SECTOR_SHIFT),
1138 				    nr_blocks << (sb->s_blocksize_bits -
1139 						  SECTOR_SHIFT),
1140 				    gfp_mask, 0);
1141 }
1142 
1143 static inline bool bdev_is_partition(struct block_device *bdev)
1144 {
1145 	return bdev->bd_partno;
1146 }
1147 
1148 enum blk_default_limits {
1149 	BLK_MAX_SEGMENTS	= 128,
1150 	BLK_SAFE_MAX_SECTORS	= 255,
1151 	BLK_DEF_MAX_SECTORS	= 2560,
1152 	BLK_MAX_SEGMENT_SIZE	= 65536,
1153 	BLK_SEG_BOUNDARY_MASK	= 0xFFFFFFFFUL,
1154 };
1155 
1156 static inline unsigned long queue_segment_boundary(const struct request_queue *q)
1157 {
1158 	return q->limits.seg_boundary_mask;
1159 }
1160 
1161 static inline unsigned long queue_virt_boundary(const struct request_queue *q)
1162 {
1163 	return q->limits.virt_boundary_mask;
1164 }
1165 
1166 static inline unsigned int queue_max_sectors(const struct request_queue *q)
1167 {
1168 	return q->limits.max_sectors;
1169 }
1170 
1171 static inline unsigned int queue_max_bytes(struct request_queue *q)
1172 {
1173 	return min_t(unsigned int, queue_max_sectors(q), INT_MAX >> 9) << 9;
1174 }
1175 
1176 static inline unsigned int queue_max_hw_sectors(const struct request_queue *q)
1177 {
1178 	return q->limits.max_hw_sectors;
1179 }
1180 
1181 static inline unsigned short queue_max_segments(const struct request_queue *q)
1182 {
1183 	return q->limits.max_segments;
1184 }
1185 
1186 static inline unsigned short queue_max_discard_segments(const struct request_queue *q)
1187 {
1188 	return q->limits.max_discard_segments;
1189 }
1190 
1191 static inline unsigned int queue_max_segment_size(const struct request_queue *q)
1192 {
1193 	return q->limits.max_segment_size;
1194 }
1195 
1196 static inline unsigned int queue_max_zone_append_sectors(const struct request_queue *q)
1197 {
1198 
1199 	const struct queue_limits *l = &q->limits;
1200 
1201 	return min(l->max_zone_append_sectors, l->max_sectors);
1202 }
1203 
1204 static inline unsigned int
1205 bdev_max_zone_append_sectors(struct block_device *bdev)
1206 {
1207 	return queue_max_zone_append_sectors(bdev_get_queue(bdev));
1208 }
1209 
1210 static inline unsigned queue_logical_block_size(const struct request_queue *q)
1211 {
1212 	int retval = 512;
1213 
1214 	if (q && q->limits.logical_block_size)
1215 		retval = q->limits.logical_block_size;
1216 
1217 	return retval;
1218 }
1219 
1220 static inline unsigned int bdev_logical_block_size(struct block_device *bdev)
1221 {
1222 	return queue_logical_block_size(bdev_get_queue(bdev));
1223 }
1224 
1225 static inline unsigned int queue_physical_block_size(const struct request_queue *q)
1226 {
1227 	return q->limits.physical_block_size;
1228 }
1229 
1230 static inline unsigned int bdev_physical_block_size(struct block_device *bdev)
1231 {
1232 	return queue_physical_block_size(bdev_get_queue(bdev));
1233 }
1234 
1235 static inline unsigned int queue_io_min(const struct request_queue *q)
1236 {
1237 	return q->limits.io_min;
1238 }
1239 
1240 static inline int bdev_io_min(struct block_device *bdev)
1241 {
1242 	return queue_io_min(bdev_get_queue(bdev));
1243 }
1244 
1245 static inline unsigned int queue_io_opt(const struct request_queue *q)
1246 {
1247 	return q->limits.io_opt;
1248 }
1249 
1250 static inline int bdev_io_opt(struct block_device *bdev)
1251 {
1252 	return queue_io_opt(bdev_get_queue(bdev));
1253 }
1254 
1255 static inline unsigned int
1256 queue_zone_write_granularity(const struct request_queue *q)
1257 {
1258 	return q->limits.zone_write_granularity;
1259 }
1260 
1261 static inline unsigned int
1262 bdev_zone_write_granularity(struct block_device *bdev)
1263 {
1264 	return queue_zone_write_granularity(bdev_get_queue(bdev));
1265 }
1266 
1267 int bdev_alignment_offset(struct block_device *bdev);
1268 unsigned int bdev_discard_alignment(struct block_device *bdev);
1269 
1270 static inline unsigned int bdev_max_discard_sectors(struct block_device *bdev)
1271 {
1272 	return bdev_get_queue(bdev)->limits.max_discard_sectors;
1273 }
1274 
1275 static inline unsigned int bdev_discard_granularity(struct block_device *bdev)
1276 {
1277 	return bdev_get_queue(bdev)->limits.discard_granularity;
1278 }
1279 
1280 static inline unsigned int
1281 bdev_max_secure_erase_sectors(struct block_device *bdev)
1282 {
1283 	return bdev_get_queue(bdev)->limits.max_secure_erase_sectors;
1284 }
1285 
1286 static inline unsigned int bdev_write_zeroes_sectors(struct block_device *bdev)
1287 {
1288 	struct request_queue *q = bdev_get_queue(bdev);
1289 
1290 	if (q)
1291 		return q->limits.max_write_zeroes_sectors;
1292 
1293 	return 0;
1294 }
1295 
1296 static inline bool bdev_nonrot(struct block_device *bdev)
1297 {
1298 	return blk_queue_nonrot(bdev_get_queue(bdev));
1299 }
1300 
1301 static inline bool bdev_stable_writes(struct block_device *bdev)
1302 {
1303 	return test_bit(QUEUE_FLAG_STABLE_WRITES,
1304 			&bdev_get_queue(bdev)->queue_flags);
1305 }
1306 
1307 static inline bool bdev_write_cache(struct block_device *bdev)
1308 {
1309 	return test_bit(QUEUE_FLAG_WC, &bdev_get_queue(bdev)->queue_flags);
1310 }
1311 
1312 static inline bool bdev_fua(struct block_device *bdev)
1313 {
1314 	return test_bit(QUEUE_FLAG_FUA, &bdev_get_queue(bdev)->queue_flags);
1315 }
1316 
1317 static inline enum blk_zoned_model bdev_zoned_model(struct block_device *bdev)
1318 {
1319 	struct request_queue *q = bdev_get_queue(bdev);
1320 
1321 	if (q)
1322 		return blk_queue_zoned_model(q);
1323 
1324 	return BLK_ZONED_NONE;
1325 }
1326 
1327 static inline bool bdev_is_zoned(struct block_device *bdev)
1328 {
1329 	struct request_queue *q = bdev_get_queue(bdev);
1330 
1331 	if (q)
1332 		return blk_queue_is_zoned(q);
1333 
1334 	return false;
1335 }
1336 
1337 static inline sector_t bdev_zone_sectors(struct block_device *bdev)
1338 {
1339 	struct request_queue *q = bdev_get_queue(bdev);
1340 
1341 	if (q)
1342 		return blk_queue_zone_sectors(q);
1343 	return 0;
1344 }
1345 
1346 static inline unsigned int bdev_max_open_zones(struct block_device *bdev)
1347 {
1348 	struct request_queue *q = bdev_get_queue(bdev);
1349 
1350 	if (q)
1351 		return queue_max_open_zones(q);
1352 	return 0;
1353 }
1354 
1355 static inline unsigned int bdev_max_active_zones(struct block_device *bdev)
1356 {
1357 	struct request_queue *q = bdev_get_queue(bdev);
1358 
1359 	if (q)
1360 		return queue_max_active_zones(q);
1361 	return 0;
1362 }
1363 
1364 static inline int queue_dma_alignment(const struct request_queue *q)
1365 {
1366 	return q ? q->dma_alignment : 511;
1367 }
1368 
1369 static inline int blk_rq_aligned(struct request_queue *q, unsigned long addr,
1370 				 unsigned int len)
1371 {
1372 	unsigned int alignment = queue_dma_alignment(q) | q->dma_pad_mask;
1373 	return !(addr & alignment) && !(len & alignment);
1374 }
1375 
1376 /* assumes size > 256 */
1377 static inline unsigned int blksize_bits(unsigned int size)
1378 {
1379 	unsigned int bits = 8;
1380 	do {
1381 		bits++;
1382 		size >>= 1;
1383 	} while (size > 256);
1384 	return bits;
1385 }
1386 
1387 static inline unsigned int block_size(struct block_device *bdev)
1388 {
1389 	return 1 << bdev->bd_inode->i_blkbits;
1390 }
1391 
1392 int kblockd_schedule_work(struct work_struct *work);
1393 int kblockd_mod_delayed_work_on(int cpu, struct delayed_work *dwork, unsigned long delay);
1394 
1395 #define MODULE_ALIAS_BLOCKDEV(major,minor) \
1396 	MODULE_ALIAS("block-major-" __stringify(major) "-" __stringify(minor))
1397 #define MODULE_ALIAS_BLOCKDEV_MAJOR(major) \
1398 	MODULE_ALIAS("block-major-" __stringify(major) "-*")
1399 
1400 #ifdef CONFIG_BLK_INLINE_ENCRYPTION
1401 
1402 bool blk_crypto_register(struct blk_crypto_profile *profile,
1403 			 struct request_queue *q);
1404 
1405 #else /* CONFIG_BLK_INLINE_ENCRYPTION */
1406 
1407 static inline bool blk_crypto_register(struct blk_crypto_profile *profile,
1408 				       struct request_queue *q)
1409 {
1410 	return true;
1411 }
1412 
1413 #endif /* CONFIG_BLK_INLINE_ENCRYPTION */
1414 
1415 enum blk_unique_id {
1416 	/* these match the Designator Types specified in SPC */
1417 	BLK_UID_T10	= 1,
1418 	BLK_UID_EUI64	= 2,
1419 	BLK_UID_NAA	= 3,
1420 };
1421 
1422 #define NFL4_UFLG_MASK			0x0000003F
1423 
1424 struct block_device_operations {
1425 	void (*submit_bio)(struct bio *bio);
1426 	int (*poll_bio)(struct bio *bio, struct io_comp_batch *iob,
1427 			unsigned int flags);
1428 	int (*open) (struct block_device *, fmode_t);
1429 	void (*release) (struct gendisk *, fmode_t);
1430 	int (*rw_page)(struct block_device *, sector_t, struct page *, unsigned int);
1431 	int (*ioctl) (struct block_device *, fmode_t, unsigned, unsigned long);
1432 	int (*compat_ioctl) (struct block_device *, fmode_t, unsigned, unsigned long);
1433 	unsigned int (*check_events) (struct gendisk *disk,
1434 				      unsigned int clearing);
1435 	void (*unlock_native_capacity) (struct gendisk *);
1436 	int (*getgeo)(struct block_device *, struct hd_geometry *);
1437 	int (*set_read_only)(struct block_device *bdev, bool ro);
1438 	void (*free_disk)(struct gendisk *disk);
1439 	/* this callback is with swap_lock and sometimes page table lock held */
1440 	void (*swap_slot_free_notify) (struct block_device *, unsigned long);
1441 	int (*report_zones)(struct gendisk *, sector_t sector,
1442 			unsigned int nr_zones, report_zones_cb cb, void *data);
1443 	char *(*devnode)(struct gendisk *disk, umode_t *mode);
1444 	/* returns the length of the identifier or a negative errno: */
1445 	int (*get_unique_id)(struct gendisk *disk, u8 id[16],
1446 			enum blk_unique_id id_type);
1447 	struct module *owner;
1448 	const struct pr_ops *pr_ops;
1449 
1450 	/*
1451 	 * Special callback for probing GPT entry at a given sector.
1452 	 * Needed by Android devices, used by GPT scanner and MMC blk
1453 	 * driver.
1454 	 */
1455 	int (*alternative_gpt_sector)(struct gendisk *disk, sector_t *sector);
1456 };
1457 
1458 #ifdef CONFIG_COMPAT
1459 extern int blkdev_compat_ptr_ioctl(struct block_device *, fmode_t,
1460 				      unsigned int, unsigned long);
1461 #else
1462 #define blkdev_compat_ptr_ioctl NULL
1463 #endif
1464 
1465 extern int bdev_read_page(struct block_device *, sector_t, struct page *);
1466 extern int bdev_write_page(struct block_device *, sector_t, struct page *,
1467 						struct writeback_control *);
1468 
1469 static inline void blk_wake_io_task(struct task_struct *waiter)
1470 {
1471 	/*
1472 	 * If we're polling, the task itself is doing the completions. For
1473 	 * that case, we don't need to signal a wakeup, it's enough to just
1474 	 * mark us as RUNNING.
1475 	 */
1476 	if (waiter == current)
1477 		__set_current_state(TASK_RUNNING);
1478 	else
1479 		wake_up_process(waiter);
1480 }
1481 
1482 unsigned long bdev_start_io_acct(struct block_device *bdev,
1483 				 unsigned int sectors, unsigned int op,
1484 				 unsigned long start_time);
1485 void bdev_end_io_acct(struct block_device *bdev, unsigned int op,
1486 		unsigned long start_time);
1487 
1488 void bio_start_io_acct_time(struct bio *bio, unsigned long start_time);
1489 unsigned long bio_start_io_acct(struct bio *bio);
1490 void bio_end_io_acct_remapped(struct bio *bio, unsigned long start_time,
1491 		struct block_device *orig_bdev);
1492 
1493 /**
1494  * bio_end_io_acct - end I/O accounting for bio based drivers
1495  * @bio:	bio to end account for
1496  * @start_time:	start time returned by bio_start_io_acct()
1497  */
1498 static inline void bio_end_io_acct(struct bio *bio, unsigned long start_time)
1499 {
1500 	return bio_end_io_acct_remapped(bio, start_time, bio->bi_bdev);
1501 }
1502 
1503 int bdev_read_only(struct block_device *bdev);
1504 int set_blocksize(struct block_device *bdev, int size);
1505 
1506 const char *bdevname(struct block_device *bdev, char *buffer);
1507 int lookup_bdev(const char *pathname, dev_t *dev);
1508 
1509 void blkdev_show(struct seq_file *seqf, off_t offset);
1510 
1511 #define BDEVNAME_SIZE	32	/* Largest string for a blockdev identifier */
1512 #define BDEVT_SIZE	10	/* Largest string for MAJ:MIN for blkdev */
1513 #ifdef CONFIG_BLOCK
1514 #define BLKDEV_MAJOR_MAX	512
1515 #else
1516 #define BLKDEV_MAJOR_MAX	0
1517 #endif
1518 
1519 struct block_device *blkdev_get_by_path(const char *path, fmode_t mode,
1520 		void *holder);
1521 struct block_device *blkdev_get_by_dev(dev_t dev, fmode_t mode, void *holder);
1522 int bd_prepare_to_claim(struct block_device *bdev, void *holder);
1523 void bd_abort_claiming(struct block_device *bdev, void *holder);
1524 void blkdev_put(struct block_device *bdev, fmode_t mode);
1525 
1526 /* just for blk-cgroup, don't use elsewhere */
1527 struct block_device *blkdev_get_no_open(dev_t dev);
1528 void blkdev_put_no_open(struct block_device *bdev);
1529 
1530 struct block_device *bdev_alloc(struct gendisk *disk, u8 partno);
1531 void bdev_add(struct block_device *bdev, dev_t dev);
1532 struct block_device *I_BDEV(struct inode *inode);
1533 int truncate_bdev_range(struct block_device *bdev, fmode_t mode, loff_t lstart,
1534 		loff_t lend);
1535 
1536 #ifdef CONFIG_BLOCK
1537 void invalidate_bdev(struct block_device *bdev);
1538 int sync_blockdev(struct block_device *bdev);
1539 int sync_blockdev_range(struct block_device *bdev, loff_t lstart, loff_t lend);
1540 int sync_blockdev_nowait(struct block_device *bdev);
1541 void sync_bdevs(bool wait);
1542 void printk_all_partitions(void);
1543 #else
1544 static inline void invalidate_bdev(struct block_device *bdev)
1545 {
1546 }
1547 static inline int sync_blockdev(struct block_device *bdev)
1548 {
1549 	return 0;
1550 }
1551 static inline int sync_blockdev_nowait(struct block_device *bdev)
1552 {
1553 	return 0;
1554 }
1555 static inline void sync_bdevs(bool wait)
1556 {
1557 }
1558 static inline void printk_all_partitions(void)
1559 {
1560 }
1561 #endif /* CONFIG_BLOCK */
1562 
1563 int fsync_bdev(struct block_device *bdev);
1564 
1565 int freeze_bdev(struct block_device *bdev);
1566 int thaw_bdev(struct block_device *bdev);
1567 
1568 struct io_comp_batch {
1569 	struct request *req_list;
1570 	bool need_ts;
1571 	void (*complete)(struct io_comp_batch *);
1572 };
1573 
1574 #define DEFINE_IO_COMP_BATCH(name)	struct io_comp_batch name = { }
1575 
1576 #endif /* _LINUX_BLKDEV_H */
1577