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 struct bio_integrity_payload {
21 struct bvec_iter bip_iter;
22
23 unsigned short bip_vcnt; /* # of integrity bio_vecs */
24 unsigned short bip_max_vcnt; /* integrity bio_vec slots */
25 unsigned short bip_flags; /* control flags */
26 u16 app_tag; /* application tag value */
27
28 struct bio_vec *bip_vec;
29 };
30
31 #define BIP_CLONE_FLAGS (BIP_MAPPED_INTEGRITY | BIP_IP_CHECKSUM | \
32 BIP_CHECK_GUARD | BIP_CHECK_REFTAG | BIP_CHECK_APPTAG)
33
34 #ifdef CONFIG_BLK_DEV_INTEGRITY
35
36 #define bip_for_each_vec(bvl, bip, iter) \
37 for_each_bvec(bvl, (bip)->bip_vec, iter, (bip)->bip_iter)
38
39 #define bio_for_each_integrity_vec(_bvl, _bio, _iter) \
40 for_each_bio(_bio) \
41 bip_for_each_vec(_bvl, _bio->bi_integrity, _iter)
42
bio_integrity(struct bio * bio)43 static inline struct bio_integrity_payload *bio_integrity(struct bio *bio)
44 {
45 if (bio->bi_opf & REQ_INTEGRITY)
46 return bio->bi_integrity;
47
48 return NULL;
49 }
50
bio_integrity_flagged(struct bio * bio,enum bip_flags flag)51 static inline bool bio_integrity_flagged(struct bio *bio, enum bip_flags flag)
52 {
53 struct bio_integrity_payload *bip = bio_integrity(bio);
54
55 if (bip)
56 return bip->bip_flags & flag;
57
58 return false;
59 }
60
bip_get_seed(struct bio_integrity_payload * bip)61 static inline sector_t bip_get_seed(struct bio_integrity_payload *bip)
62 {
63 return bip->bip_iter.bi_sector;
64 }
65
bip_set_seed(struct bio_integrity_payload * bip,sector_t seed)66 static inline void bip_set_seed(struct bio_integrity_payload *bip,
67 sector_t seed)
68 {
69 bip->bip_iter.bi_sector = seed;
70 }
71
72 void bio_integrity_init(struct bio *bio, struct bio_integrity_payload *bip,
73 struct bio_vec *bvecs, unsigned int nr_vecs);
74 struct bio_integrity_payload *bio_integrity_alloc(struct bio *bio, gfp_t gfp,
75 unsigned int nr);
76 int bio_integrity_add_page(struct bio *bio, struct page *page, unsigned int len,
77 unsigned int offset);
78 int bio_integrity_map_user(struct bio *bio, struct iov_iter *iter);
79 int bio_integrity_map_iter(struct bio *bio, struct uio_meta *meta);
80 void bio_integrity_unmap_user(struct bio *bio);
81 void bio_integrity_prep(struct bio *bio, unsigned int action);
82 void bio_integrity_advance(struct bio *bio, unsigned int bytes_done);
83 void bio_integrity_trim(struct bio *bio);
84 int bio_integrity_clone(struct bio *bio, struct bio *bio_src, gfp_t gfp_mask);
85
86 #else /* CONFIG_BLK_DEV_INTEGRITY */
87
bio_integrity(struct bio * bio)88 static inline struct bio_integrity_payload *bio_integrity(struct bio *bio)
89 {
90 return NULL;
91 }
92
bio_integrity_map_user(struct bio * bio,struct iov_iter * iter)93 static inline int bio_integrity_map_user(struct bio *bio, struct iov_iter *iter)
94 {
95 return -EINVAL;
96 }
97
bio_integrity_map_iter(struct bio * bio,struct uio_meta * meta)98 static inline int bio_integrity_map_iter(struct bio *bio, struct uio_meta *meta)
99 {
100 return -EINVAL;
101 }
102
bio_integrity_unmap_user(struct bio * bio)103 static inline void bio_integrity_unmap_user(struct bio *bio)
104 {
105 }
106
bio_integrity_prep(struct bio * bio,unsigned int action)107 static inline void bio_integrity_prep(struct bio *bio, unsigned int action)
108 {
109 }
110
bio_integrity_clone(struct bio * bio,struct bio * bio_src,gfp_t gfp_mask)111 static inline int bio_integrity_clone(struct bio *bio, struct bio *bio_src,
112 gfp_t gfp_mask)
113 {
114 return 0;
115 }
116
bio_integrity_advance(struct bio * bio,unsigned int bytes_done)117 static inline void bio_integrity_advance(struct bio *bio,
118 unsigned int bytes_done)
119 {
120 }
121
bio_integrity_trim(struct bio * bio)122 static inline void bio_integrity_trim(struct bio *bio)
123 {
124 }
125
bio_integrity_flagged(struct bio * bio,enum bip_flags flag)126 static inline bool bio_integrity_flagged(struct bio *bio, enum bip_flags flag)
127 {
128 return false;
129 }
130
131 static inline struct bio_integrity_payload *
bio_integrity_alloc(struct bio * bio,gfp_t gfp,unsigned int nr)132 bio_integrity_alloc(struct bio *bio, gfp_t gfp, unsigned int nr)
133 {
134 return ERR_PTR(-EINVAL);
135 }
136
bio_integrity_add_page(struct bio * bio,struct page * page,unsigned int len,unsigned int offset)137 static inline int bio_integrity_add_page(struct bio *bio, struct page *page,
138 unsigned int len, unsigned int offset)
139 {
140 return 0;
141 }
142 #endif /* CONFIG_BLK_DEV_INTEGRITY */
143
144 void bio_integrity_alloc_buf(struct bio *bio, bool zero_buffer);
145 void bio_integrity_free_buf(struct bio_integrity_payload *bip);
146 void bio_integrity_setup_default(struct bio *bio);
147
148 unsigned int fs_bio_integrity_alloc(struct bio *bio);
149 void fs_bio_integrity_free(struct bio *bio);
150 void fs_bio_integrity_generate(struct bio *bio);
151 int fs_bio_integrity_verify(struct bio *bio, sector_t sector,
152 unsigned int size);
153
154 #endif /* _LINUX_BIO_INTEGRITY_H */
155