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