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