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