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