4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2 only,
8 * as published by the Free Software Foundation.
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License version 2 for more details (a copy is included
14 * in the LICENSE file that accompanied this code).
16 * You should have received a copy of the GNU General Public License
17 * version 2 along with this program; If not, see
18 * http://www.gnu.org/licenses/gpl-2.0.html
23 * Copyright (c) 2018, DataDirect Networks Storage.
26 * Data integrity functions for OSD
27 * Codes copied from kernel 3.10.0-862.el7
28 * drivers/scsi/sd_dif.c and block/t10-pi.c
30 #include <linux/blkdev.h>
31 #include <linux/blk_types.h>
33 #include <obd_cksum.h>
34 #include <lustre_compat.h>
36 #include "osd_internal.h"
38 #if IS_ENABLED(CONFIG_CRC_T10DIF)
40 * Data Integrity Field tuple.
43 __be16 guard_tag; /* Checksum */
44 __be16 app_tag; /* Opaque storage */
45 __be32 ref_tag; /* Target LBA or indirect LBA */
48 static struct niobuf_local *find_lnb(struct blk_integrity_exchg *bix)
50 struct bio *bio = bix->bio;
51 struct bio_vec *bv = bio_iovec_idx(bio, bix->bi_idx);
52 struct osd_bio_private *bio_private = bio->bi_private;
53 struct osd_iobuf *iobuf = bio_private->obp_iobuf;
54 int index = bio_private->obp_start_page_idx + bix->bi_idx;
58 * blocks are contiguous in bio but pages added to bio
59 * could have a gap comparing to iobuf->dr_pages.
60 * e.g. a page mapped to a hole in the middle.
62 for (i = index; i < iobuf->dr_npages; i++) {
63 if (iobuf->dr_pages[i] == bv->bv_page)
64 return iobuf->dr_lnbs[i];
71 * Type 1 and Type 2 protection use the same format: 16 bit guard tag,
72 * 16 bit app tag, 32 bit reference tag.
74 static void osd_dif_type1_generate(struct blk_integrity_exchg *bix,
77 void *buf = bix->data_buf;
78 struct sd_dif_tuple *sdt = bix->prot_buf;
79 struct niobuf_local *lnb = find_lnb(bix);
80 __u16 *guard_buf = lnb ? lnb->lnb_guards : NULL;
81 sector_t sector = bix->sector;
84 for (i = 0 ; i < bix->data_size ; i += bix->sector_size, sdt++) {
85 if (lnb && lnb->lnb_guard_rpc) {
86 sdt->guard_tag = *guard_buf;
89 sdt->guard_tag = fn(buf, bix->sector_size);
90 sdt->ref_tag = cpu_to_be32(sector & 0xffffffff);
93 buf += bix->sector_size;
98 static void osd_dif_type1_generate_crc(struct blk_integrity_exchg *bix)
100 osd_dif_type1_generate(bix, obd_dif_crc_fn);
103 static void osd_dif_type1_generate_ip(struct blk_integrity_exchg *bix)
105 osd_dif_type1_generate(bix, obd_dif_ip_fn);
108 static int osd_dif_type1_verify(struct blk_integrity_exchg *bix,
111 void *buf = bix->data_buf;
112 struct sd_dif_tuple *sdt = bix->prot_buf;
113 struct niobuf_local *lnb = find_lnb(bix);
114 __u16 *guard_buf = lnb ? lnb->lnb_guards : NULL;
115 sector_t sector = bix->sector;
119 for (i = 0 ; i < bix->data_size ; i += bix->sector_size, sdt++) {
120 /* Unwritten sectors */
121 if (sdt->app_tag == 0xffff)
124 if (be32_to_cpu(sdt->ref_tag) != (sector & 0xffffffff)) {
125 CERROR("%s: ref tag error on sector %lu (rcvd %u)\n",
126 bix->disk_name, (unsigned long)sector,
127 be32_to_cpu(sdt->ref_tag));
131 csum = fn(buf, bix->sector_size);
133 if (sdt->guard_tag != csum) {
134 CERROR("%s: guard tag error on sector %lu " \
135 "(rcvd %04x, data %04x)\n", bix->disk_name,
136 (unsigned long)sector,
137 be16_to_cpu(sdt->guard_tag), be16_to_cpu(csum));
146 buf += bix->sector_size;
151 lnb->lnb_guard_disk = 1;
155 static int osd_dif_type1_verify_crc(struct blk_integrity_exchg *bix)
157 return osd_dif_type1_verify(bix, obd_dif_crc_fn);
160 static int osd_dif_type1_verify_ip(struct blk_integrity_exchg *bix)
162 return osd_dif_type1_verify(bix, obd_dif_ip_fn);
166 * Type 3 protection has a 16-bit guard tag and 16 + 32 bits of opaque
169 static void osd_dif_type3_generate(struct blk_integrity_exchg *bix,
172 void *buf = bix->data_buf;
173 struct sd_dif_tuple *sdt = bix->prot_buf;
174 struct niobuf_local *lnb = find_lnb(bix);
175 __u16 *guard_buf = lnb ? lnb->lnb_guards : NULL;
178 for (i = 0 ; i < bix->data_size ; i += bix->sector_size, sdt++) {
179 if (lnb && lnb->lnb_guard_rpc) {
180 sdt->guard_tag = *guard_buf;
183 sdt->guard_tag = fn(buf, bix->sector_size);
187 buf += bix->sector_size;
191 static void osd_dif_type3_generate_crc(struct blk_integrity_exchg *bix)
193 osd_dif_type3_generate(bix, obd_dif_crc_fn);
196 static void osd_dif_type3_generate_ip(struct blk_integrity_exchg *bix)
198 osd_dif_type3_generate(bix, obd_dif_ip_fn);
201 static int osd_dif_type3_verify(struct blk_integrity_exchg *bix,
204 void *buf = bix->data_buf;
205 struct sd_dif_tuple *sdt = bix->prot_buf;
206 struct niobuf_local *lnb = find_lnb(bix);
207 __u16 *guard_buf = lnb ? lnb->lnb_guards : NULL;
208 sector_t sector = bix->sector;
212 for (i = 0 ; i < bix->data_size ; i += bix->sector_size, sdt++) {
213 /* Unwritten sectors */
214 if (sdt->app_tag == 0xffff && sdt->ref_tag == 0xffffffff)
217 csum = fn(buf, bix->sector_size);
219 if (sdt->guard_tag != csum) {
220 CERROR("%s: guard tag error on sector %lu " \
221 "(rcvd %04x, data %04x)\n", bix->disk_name,
222 (unsigned long)sector,
223 be16_to_cpu(sdt->guard_tag), be16_to_cpu(csum));
232 buf += bix->sector_size;
237 lnb->lnb_guard_disk = 1;
241 static int osd_dif_type3_verify_crc(struct blk_integrity_exchg *bix)
243 return osd_dif_type3_verify(bix, obd_dif_crc_fn);
246 static int osd_dif_type3_verify_ip(struct blk_integrity_exchg *bix)
248 return osd_dif_type3_verify(bix, obd_dif_ip_fn);
251 int osd_get_integrity_profile(struct osd_device *osd,
252 integrity_gen_fn **generate_fn,
253 integrity_vrfy_fn **verify_fn)
255 switch (osd->od_t10_type) {
256 case OSD_T10_TYPE1_CRC:
257 *verify_fn = osd_dif_type1_verify_crc;
258 *generate_fn = osd_dif_type1_generate_crc;
260 case OSD_T10_TYPE3_CRC:
261 *verify_fn = osd_dif_type3_verify_crc;
262 *generate_fn = osd_dif_type3_generate_crc;
264 case OSD_T10_TYPE1_IP:
265 *verify_fn = osd_dif_type1_verify_ip;
266 *generate_fn = osd_dif_type1_generate_ip;
268 case OSD_T10_TYPE3_IP:
269 *verify_fn = osd_dif_type3_verify_ip;
270 *generate_fn = osd_dif_type3_generate_ip;
278 #endif /* CONFIG_CRC_T10DIF */