xref: /linux-6.15/include/linux/blk-integrity.h (revision ff9fbcaf)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef _LINUX_BLK_INTEGRITY_H
3 #define _LINUX_BLK_INTEGRITY_H
4 
5 #include <linux/blk-mq.h>
6 
7 struct request;
8 
9 enum blk_integrity_flags {
10 	BLK_INTEGRITY_NOVERIFY		= 1 << 0,
11 	BLK_INTEGRITY_NOGENERATE	= 1 << 1,
12 	BLK_INTEGRITY_DEVICE_CAPABLE	= 1 << 2,
13 	BLK_INTEGRITY_REF_TAG		= 1 << 3,
14 	BLK_INTEGRITY_STACKED		= 1 << 4,
15 };
16 
17 const char *blk_integrity_profile_name(struct blk_integrity *bi);
18 bool queue_limits_stack_integrity(struct queue_limits *t,
19 		struct queue_limits *b);
20 static inline bool queue_limits_stack_integrity_bdev(struct queue_limits *t,
21 		struct block_device *bdev)
22 {
23 	return queue_limits_stack_integrity(t, &bdev->bd_disk->queue->limits);
24 }
25 
26 #ifdef CONFIG_BLK_DEV_INTEGRITY
27 int blk_rq_map_integrity_sg(struct request_queue *, struct bio *,
28 				   struct scatterlist *);
29 int blk_rq_count_integrity_sg(struct request_queue *, struct bio *);
30 
31 static inline bool
32 blk_integrity_queue_supports_integrity(struct request_queue *q)
33 {
34 	return q->limits.integrity.tuple_size;
35 }
36 
37 static inline struct blk_integrity *blk_get_integrity(struct gendisk *disk)
38 {
39 	if (!blk_integrity_queue_supports_integrity(disk->queue))
40 		return NULL;
41 	return &disk->queue->limits.integrity;
42 }
43 
44 static inline struct blk_integrity *
45 bdev_get_integrity(struct block_device *bdev)
46 {
47 	return blk_get_integrity(bdev->bd_disk);
48 }
49 
50 static inline unsigned short
51 queue_max_integrity_segments(const struct request_queue *q)
52 {
53 	return q->limits.max_integrity_segments;
54 }
55 
56 /**
57  * bio_integrity_intervals - Return number of integrity intervals for a bio
58  * @bi:		blk_integrity profile for device
59  * @sectors:	Size of the bio in 512-byte sectors
60  *
61  * Description: The block layer calculates everything in 512 byte
62  * sectors but integrity metadata is done in terms of the data integrity
63  * interval size of the storage device.  Convert the block layer sectors
64  * to the appropriate number of integrity intervals.
65  */
66 static inline unsigned int bio_integrity_intervals(struct blk_integrity *bi,
67 						   unsigned int sectors)
68 {
69 	return sectors >> (bi->interval_exp - 9);
70 }
71 
72 static inline unsigned int bio_integrity_bytes(struct blk_integrity *bi,
73 					       unsigned int sectors)
74 {
75 	return bio_integrity_intervals(bi, sectors) * bi->tuple_size;
76 }
77 
78 static inline bool blk_integrity_rq(struct request *rq)
79 {
80 	return rq->cmd_flags & REQ_INTEGRITY;
81 }
82 
83 /*
84  * Return the current bvec that contains the integrity data. bip_iter may be
85  * advanced to iterate over the integrity data.
86  */
87 static inline struct bio_vec rq_integrity_vec(struct request *rq)
88 {
89 	return mp_bvec_iter_bvec(rq->bio->bi_integrity->bip_vec,
90 				 rq->bio->bi_integrity->bip_iter);
91 }
92 #else /* CONFIG_BLK_DEV_INTEGRITY */
93 static inline int blk_rq_count_integrity_sg(struct request_queue *q,
94 					    struct bio *b)
95 {
96 	return 0;
97 }
98 static inline int blk_rq_map_integrity_sg(struct request_queue *q,
99 					  struct bio *b,
100 					  struct scatterlist *s)
101 {
102 	return 0;
103 }
104 static inline struct blk_integrity *bdev_get_integrity(struct block_device *b)
105 {
106 	return NULL;
107 }
108 static inline struct blk_integrity *blk_get_integrity(struct gendisk *disk)
109 {
110 	return NULL;
111 }
112 static inline bool
113 blk_integrity_queue_supports_integrity(struct request_queue *q)
114 {
115 	return false;
116 }
117 static inline unsigned short
118 queue_max_integrity_segments(const struct request_queue *q)
119 {
120 	return 0;
121 }
122 
123 static inline unsigned int bio_integrity_intervals(struct blk_integrity *bi,
124 						   unsigned int sectors)
125 {
126 	return 0;
127 }
128 
129 static inline unsigned int bio_integrity_bytes(struct blk_integrity *bi,
130 					       unsigned int sectors)
131 {
132 	return 0;
133 }
134 static inline int blk_integrity_rq(struct request *rq)
135 {
136 	return 0;
137 }
138 
139 static inline struct bio_vec rq_integrity_vec(struct request *rq)
140 {
141 	/* the optimizer will remove all calls to this function */
142 	return (struct bio_vec){ };
143 }
144 #endif /* CONFIG_BLK_DEV_INTEGRITY */
145 
146 #endif /* _LINUX_BLK_INTEGRITY_H */
147