1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef _LINUX_BIO_INTEGRITY_H
3 #define _LINUX_BIO_INTEGRITY_H
4
5 #include <linux/bio.h>
6
7 enum bip_flags {
8 BIP_BLOCK_INTEGRITY = 1 << 0, /* block layer owns integrity data */
9 BIP_MAPPED_INTEGRITY = 1 << 1, /* ref tag has been remapped */
10 BIP_DISK_NOCHECK = 1 << 2, /* disable disk integrity checking */
11 BIP_IP_CHECKSUM = 1 << 3, /* IP checksum */
12 BIP_COPY_USER = 1 << 4, /* Kernel bounce buffer in use */
13 BIP_CHECK_GUARD = 1 << 5, /* guard check */
14 BIP_CHECK_REFTAG = 1 << 6, /* reftag check */
15 BIP_CHECK_APPTAG = 1 << 7, /* apptag check */
16
17 BIP_MEMPOOL = 1 << 15, /* buffer backed by mempool */
18 };
19
20 /* flags that require generate/verify action. */
21 #define BIP_CHECK_FLAGS (BIP_CHECK_GUARD | BIP_CHECK_REFTAG | BIP_CHECK_APPTAG)
22
23 struct bio_integrity_payload {
24 struct bvec_iter bip_iter;
25
26 unsigned short bip_vcnt; /* # of integrity bio_vecs */
27 unsigned short bip_max_vcnt; /* integrity bio_vec slots */
28 unsigned short bip_flags; /* control flags */
29 u16 app_tag; /* application tag value */
30
31 struct bio_vec *bip_vec;
32 };
33
34 #define BIP_CLONE_FLAGS (BIP_MAPPED_INTEGRITY | BIP_IP_CHECKSUM | \
35 BIP_CHECK_GUARD | BIP_CHECK_REFTAG | BIP_CHECK_APPTAG)
36
37 #ifdef CONFIG_BLK_DEV_INTEGRITY
38
39 #define bip_for_each_vec(bvl, bip, iter) \
40 for_each_bvec(bvl, (bip)->bip_vec, iter, (bip)->bip_iter)
41
42 #define bio_for_each_integrity_vec(_bvl, _bio, _iter) \
43 for_each_bio(_bio) \
44 bip_for_each_vec(_bvl, _bio->bi_integrity, _iter)
45
bio_integrity(struct bio * bio)46 static inline struct bio_integrity_payload *bio_integrity(struct bio *bio)
47 {
48 if (bio->bi_opf & REQ_INTEGRITY)
49 return bio->bi_integrity;
50
51 return NULL;
52 }
53
bio_integrity_flagged(struct bio * bio,enum bip_flags flag)54 static inline bool bio_integrity_flagged(struct bio *bio, enum bip_flags flag)
55 {
56 struct bio_integrity_payload *bip = bio_integrity(bio);
57
58 if (bip)
59 return bip->bip_flags & flag;
60
61 return false;
62 }
63
bip_get_seed(struct bio_integrity_payload * bip)64 static inline sector_t bip_get_seed(struct bio_integrity_payload *bip)
65 {
66 return bip->bip_iter.bi_sector;
67 }
68
bip_set_seed(struct bio_integrity_payload * bip,sector_t seed)69 static inline void bip_set_seed(struct bio_integrity_payload *bip,
70 sector_t seed)
71 {
72 bip->bip_iter.bi_sector = seed;
73 }
74
75 void bio_integrity_init(struct bio *bio, struct bio_integrity_payload *bip,
76 struct bio_vec *bvecs, unsigned int nr_vecs);
77 struct bio_integrity_payload *bio_integrity_alloc(struct bio *bio, gfp_t gfp,
78 unsigned int nr);
79 int bio_integrity_add_page(struct bio *bio, struct page *page, unsigned int len,
80 unsigned int offset);
81 int bio_integrity_map_user(struct bio *bio, struct iov_iter *iter);
82 int bio_integrity_map_iter(struct bio *bio, struct uio_meta *meta);
83 void bio_integrity_unmap_user(struct bio *bio);
84 void bio_integrity_prep(struct bio *bio, unsigned int action);
85 void bio_integrity_advance(struct bio *bio, unsigned int bytes_done);
86 void bio_integrity_trim(struct bio *bio);
87 int bio_integrity_clone(struct bio *bio, struct bio *bio_src, gfp_t gfp_mask);
88
89 #else /* CONFIG_BLK_DEV_INTEGRITY */
90
bio_integrity(struct bio * bio)91 static inline struct bio_integrity_payload *bio_integrity(struct bio *bio)
92 {
93 return NULL;
94 }
95
bio_integrity_map_user(struct bio * bio,struct iov_iter * iter)96 static inline int bio_integrity_map_user(struct bio *bio, struct iov_iter *iter)
97 {
98 return -EINVAL;
99 }
100
bio_integrity_map_iter(struct bio * bio,struct uio_meta * meta)101 static inline int bio_integrity_map_iter(struct bio *bio, struct uio_meta *meta)
102 {
103 return -EINVAL;
104 }
105
bio_integrity_unmap_user(struct bio * bio)106 static inline void bio_integrity_unmap_user(struct bio *bio)
107 {
108 }
109
bio_integrity_prep(struct bio * bio,unsigned int action)110 static inline void bio_integrity_prep(struct bio *bio, unsigned int action)
111 {
112 }
113
bio_integrity_clone(struct bio * bio,struct bio * bio_src,gfp_t gfp_mask)114 static inline int bio_integrity_clone(struct bio *bio, struct bio *bio_src,
115 gfp_t gfp_mask)
116 {
117 return 0;
118 }
119
bio_integrity_advance(struct bio * bio,unsigned int bytes_done)120 static inline void bio_integrity_advance(struct bio *bio,
121 unsigned int bytes_done)
122 {
123 }
124
bio_integrity_trim(struct bio * bio)125 static inline void bio_integrity_trim(struct bio *bio)
126 {
127 }
128
bio_integrity_flagged(struct bio * bio,enum bip_flags flag)129 static inline bool bio_integrity_flagged(struct bio *bio, enum bip_flags flag)
130 {
131 return false;
132 }
133
134 static inline struct bio_integrity_payload *
bio_integrity_alloc(struct bio * bio,gfp_t gfp,unsigned int nr)135 bio_integrity_alloc(struct bio *bio, gfp_t gfp, unsigned int nr)
136 {
137 return ERR_PTR(-EINVAL);
138 }
139
bio_integrity_add_page(struct bio * bio,struct page * page,unsigned int len,unsigned int offset)140 static inline int bio_integrity_add_page(struct bio *bio, struct page *page,
141 unsigned int len, unsigned int offset)
142 {
143 return 0;
144 }
145 #endif /* CONFIG_BLK_DEV_INTEGRITY */
146
147 void bio_integrity_alloc_buf(struct bio *bio, gfp_t gfp, bool zero_buffer);
148 void bio_integrity_free_buf(struct bio_integrity_payload *bip);
149 void bio_integrity_setup_default(struct bio *bio);
150
151 unsigned int fs_bio_integrity_alloc(struct bio *bio);
152 void fs_bio_integrity_free(struct bio *bio);
153 void fs_bio_integrity_generate(struct bio *bio);
154 int fs_bio_integrity_verify(struct bio *bio, sector_t sector,
155 unsigned int size);
156
157 #endif /* _LINUX_BIO_INTEGRITY_H */
158