blob: f14b4abbebd89a0b812a67b06e3a9bb2dffb707b [file] [log] [blame]
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +02001/*
2 * bio-integrity.c - bio data integrity extensions
3 *
Martin K. Petersen7878cba2009-06-26 15:37:49 +02004 * Copyright (C) 2007, 2008, 2009 Oracle Corporation
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +02005 * Written by: Martin K. Petersen <martin.petersen@oracle.com>
6 *
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License version
9 * 2 as published by the Free Software Foundation.
10 *
11 * This program is distributed in the hope that it will be useful, but
12 * WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; see the file COPYING. If not, write to
18 * the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139,
19 * USA.
20 *
21 */
22
23#include <linux/blkdev.h>
24#include <linux/mempool.h>
Paul Gortmakerafeacc82011-05-26 16:00:52 -040025#include <linux/export.h>
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +020026#include <linux/bio.h>
27#include <linux/workqueue.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090028#include <linux/slab.h>
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +020029
Kent Overstreet9f060e22012-10-12 15:29:33 -070030#define BIP_INLINE_VECS 4
Martin K. Petersen7878cba2009-06-26 15:37:49 +020031
Kent Overstreet9f060e22012-10-12 15:29:33 -070032static struct kmem_cache *bip_slab;
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +020033static struct workqueue_struct *kintegrityd_wq;
34
Martin K. Petersen7878cba2009-06-26 15:37:49 +020035/**
Kent Overstreet1e2a410f2012-09-06 15:34:56 -070036 * bio_integrity_alloc - Allocate integrity payload and attach it to bio
Martin K. Petersen7878cba2009-06-26 15:37:49 +020037 * @bio: bio to attach integrity metadata to
38 * @gfp_mask: Memory allocation mask
39 * @nr_vecs: Number of integrity metadata scatter-gather elements
Martin K. Petersen7878cba2009-06-26 15:37:49 +020040 *
41 * Description: This function prepares a bio for attaching integrity
42 * metadata. nr_vecs specifies the maximum number of pages containing
43 * integrity metadata that can be attached.
44 */
Kent Overstreet1e2a410f2012-09-06 15:34:56 -070045struct bio_integrity_payload *bio_integrity_alloc(struct bio *bio,
46 gfp_t gfp_mask,
47 unsigned int nr_vecs)
Martin K. Petersen7878cba2009-06-26 15:37:49 +020048{
49 struct bio_integrity_payload *bip;
Kent Overstreet1e2a410f2012-09-06 15:34:56 -070050 struct bio_set *bs = bio->bi_pool;
Kent Overstreet9f060e22012-10-12 15:29:33 -070051 unsigned long idx = BIO_POOL_NONE;
52 unsigned inline_vecs;
Kent Overstreet1e2a410f2012-09-06 15:34:56 -070053
Kent Overstreet9f060e22012-10-12 15:29:33 -070054 if (!bs) {
55 bip = kmalloc(sizeof(struct bio_integrity_payload) +
56 sizeof(struct bio_vec) * nr_vecs, gfp_mask);
57 inline_vecs = nr_vecs;
58 } else {
Martin K. Petersen7878cba2009-06-26 15:37:49 +020059 bip = mempool_alloc(bs->bio_integrity_pool, gfp_mask);
Kent Overstreet9f060e22012-10-12 15:29:33 -070060 inline_vecs = BIP_INLINE_VECS;
Martin K. Petersen7878cba2009-06-26 15:37:49 +020061 }
62
Kent Overstreet9f060e22012-10-12 15:29:33 -070063 if (unlikely(!bip))
64 return NULL;
65
Martin K. Petersen7878cba2009-06-26 15:37:49 +020066 memset(bip, 0, sizeof(*bip));
67
Kent Overstreet9f060e22012-10-12 15:29:33 -070068 if (nr_vecs > inline_vecs) {
69 bip->bip_vec = bvec_alloc(gfp_mask, nr_vecs, &idx,
70 bs->bvec_integrity_pool);
71 if (!bip->bip_vec)
72 goto err;
Gu Zhengcbcd10542014-07-01 10:36:47 -060073 bip->bip_max_vcnt = bvec_nr_vecs(idx);
Kent Overstreet9f060e22012-10-12 15:29:33 -070074 } else {
75 bip->bip_vec = bip->bip_inline_vecs;
Gu Zhengcbcd10542014-07-01 10:36:47 -060076 bip->bip_max_vcnt = inline_vecs;
Kent Overstreet9f060e22012-10-12 15:29:33 -070077 }
78
Martin K. Petersen7878cba2009-06-26 15:37:49 +020079 bip->bip_slab = idx;
80 bip->bip_bio = bio;
81 bio->bi_integrity = bip;
82
83 return bip;
Kent Overstreet9f060e22012-10-12 15:29:33 -070084err:
85 mempool_free(bip, bs->bio_integrity_pool);
86 return NULL;
Martin K. Petersen7878cba2009-06-26 15:37:49 +020087}
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +020088EXPORT_SYMBOL(bio_integrity_alloc);
89
90/**
91 * bio_integrity_free - Free bio integrity payload
92 * @bio: bio containing bip to be freed
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +020093 *
94 * Description: Used to free the integrity portion of a bio. Usually
95 * called from bio_free().
96 */
Kent Overstreet1e2a410f2012-09-06 15:34:56 -070097void bio_integrity_free(struct bio *bio)
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +020098{
99 struct bio_integrity_payload *bip = bio->bi_integrity;
Kent Overstreet1e2a410f2012-09-06 15:34:56 -0700100 struct bio_set *bs = bio->bi_pool;
101
Kent Overstreet29ed7812012-09-04 09:54:22 -0700102 if (bip->bip_owns_buf)
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200103 kfree(bip->bip_buf);
104
Kent Overstreet9f060e22012-10-12 15:29:33 -0700105 if (bs) {
106 if (bip->bip_slab != BIO_POOL_NONE)
107 bvec_free(bs->bvec_integrity_pool, bip->bip_vec,
108 bip->bip_slab);
109
Martin K. Petersen7878cba2009-06-26 15:37:49 +0200110 mempool_free(bip, bs->bio_integrity_pool);
Kent Overstreet9f060e22012-10-12 15:29:33 -0700111 } else {
112 kfree(bip);
113 }
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200114
115 bio->bi_integrity = NULL;
116}
117EXPORT_SYMBOL(bio_integrity_free);
118
119/**
120 * bio_integrity_add_page - Attach integrity metadata
121 * @bio: bio to update
122 * @page: page containing integrity metadata
123 * @len: number of bytes of integrity metadata in page
124 * @offset: start offset within page
125 *
126 * Description: Attach a page containing integrity metadata to bio.
127 */
128int bio_integrity_add_page(struct bio *bio, struct page *page,
129 unsigned int len, unsigned int offset)
130{
131 struct bio_integrity_payload *bip = bio->bi_integrity;
132 struct bio_vec *iv;
133
Gu Zhengcbcd10542014-07-01 10:36:47 -0600134 if (bip->bip_vcnt >= bip->bip_max_vcnt) {
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200135 printk(KERN_ERR "%s: bip_vec full\n", __func__);
136 return 0;
137 }
138
Kent Overstreetd57a5f72013-11-23 17:20:16 -0800139 iv = bip->bip_vec + bip->bip_vcnt;
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200140
141 iv->bv_page = page;
142 iv->bv_len = len;
143 iv->bv_offset = offset;
144 bip->bip_vcnt++;
145
146 return len;
147}
148EXPORT_SYMBOL(bio_integrity_add_page);
149
Jens Axboe9c02f2b2008-09-18 09:31:53 -0700150static int bdev_integrity_enabled(struct block_device *bdev, int rw)
151{
152 struct blk_integrity *bi = bdev_get_integrity(bdev);
153
154 if (bi == NULL)
155 return 0;
156
157 if (rw == READ && bi->verify_fn != NULL &&
158 (bi->flags & INTEGRITY_FLAG_READ))
159 return 1;
160
161 if (rw == WRITE && bi->generate_fn != NULL &&
162 (bi->flags & INTEGRITY_FLAG_WRITE))
163 return 1;
164
165 return 0;
166}
167
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200168/**
169 * bio_integrity_enabled - Check whether integrity can be passed
170 * @bio: bio to check
171 *
172 * Description: Determines whether bio_integrity_prep() can be called
173 * on this bio or not. bio data direction and target device must be
174 * set prior to calling. The functions honors the write_generate and
175 * read_verify flags in sysfs.
176 */
177int bio_integrity_enabled(struct bio *bio)
178{
Martin K. Petersene69f18f2014-04-08 22:59:31 -0400179 if (!bio_is_rw(bio))
180 return 0;
181
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200182 /* Already protected? */
183 if (bio_integrity(bio))
184 return 0;
185
186 return bdev_integrity_enabled(bio->bi_bdev, bio_data_dir(bio));
187}
188EXPORT_SYMBOL(bio_integrity_enabled);
189
190/**
191 * bio_integrity_hw_sectors - Convert 512b sectors to hardware ditto
192 * @bi: blk_integrity profile for device
193 * @sectors: Number of 512 sectors to convert
194 *
195 * Description: The block layer calculates everything in 512 byte
196 * sectors but integrity metadata is done in terms of the hardware
197 * sector size of the storage device. Convert the block layer sectors
198 * to physical sectors.
199 */
Jens Axboeb9846792008-06-17 19:05:48 +0200200static inline unsigned int bio_integrity_hw_sectors(struct blk_integrity *bi,
201 unsigned int sectors)
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200202{
203 /* At this point there are only 512b or 4096b DIF/EPP devices */
204 if (bi->sector_size == 4096)
205 return sectors >>= 3;
206
207 return sectors;
208}
209
Kent Overstreetd57a5f72013-11-23 17:20:16 -0800210static inline unsigned int bio_integrity_bytes(struct blk_integrity *bi,
211 unsigned int sectors)
212{
213 return bio_integrity_hw_sectors(bi, sectors) * bi->tuple_size;
214}
215
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200216/**
217 * bio_integrity_tag_size - Retrieve integrity tag space
218 * @bio: bio to inspect
219 *
220 * Description: Returns the maximum number of tag bytes that can be
221 * attached to this bio. Filesystems can use this to determine how
222 * much metadata to attach to an I/O.
223 */
224unsigned int bio_integrity_tag_size(struct bio *bio)
225{
226 struct blk_integrity *bi = bdev_get_integrity(bio->bi_bdev);
227
Kent Overstreet4f024f32013-10-11 15:44:27 -0700228 BUG_ON(bio->bi_iter.bi_size == 0);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200229
Kent Overstreet4f024f32013-10-11 15:44:27 -0700230 return bi->tag_size * (bio->bi_iter.bi_size / bi->sector_size);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200231}
232EXPORT_SYMBOL(bio_integrity_tag_size);
233
Rashika Kheria0b4ef8d2014-02-09 18:22:53 +0530234static int bio_integrity_tag(struct bio *bio, void *tag_buf, unsigned int len,
235 int set)
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200236{
237 struct bio_integrity_payload *bip = bio->bi_integrity;
238 struct blk_integrity *bi = bdev_get_integrity(bio->bi_bdev);
239 unsigned int nr_sectors;
240
241 BUG_ON(bip->bip_buf == NULL);
242
243 if (bi->tag_size == 0)
244 return -1;
245
Jens Axboeb9846792008-06-17 19:05:48 +0200246 nr_sectors = bio_integrity_hw_sectors(bi,
247 DIV_ROUND_UP(len, bi->tag_size));
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200248
Kent Overstreetd57a5f72013-11-23 17:20:16 -0800249 if (nr_sectors * bi->tuple_size > bip->bip_iter.bi_size) {
250 printk(KERN_ERR "%s: tag too big for bio: %u > %u\n", __func__,
251 nr_sectors * bi->tuple_size, bip->bip_iter.bi_size);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200252 return -1;
253 }
254
255 if (set)
256 bi->set_tag_fn(bip->bip_buf, tag_buf, nr_sectors);
257 else
258 bi->get_tag_fn(bip->bip_buf, tag_buf, nr_sectors);
259
260 return 0;
261}
262
263/**
264 * bio_integrity_set_tag - Attach a tag buffer to a bio
265 * @bio: bio to attach buffer to
266 * @tag_buf: Pointer to a buffer containing tag data
267 * @len: Length of the included buffer
268 *
269 * Description: Use this function to tag a bio by leveraging the extra
270 * space provided by devices formatted with integrity protection. The
271 * size of the integrity buffer must be <= to the size reported by
272 * bio_integrity_tag_size().
273 */
274int bio_integrity_set_tag(struct bio *bio, void *tag_buf, unsigned int len)
275{
276 BUG_ON(bio_data_dir(bio) != WRITE);
277
278 return bio_integrity_tag(bio, tag_buf, len, 1);
279}
280EXPORT_SYMBOL(bio_integrity_set_tag);
281
282/**
283 * bio_integrity_get_tag - Retrieve a tag buffer from a bio
284 * @bio: bio to retrieve buffer from
285 * @tag_buf: Pointer to a buffer for the tag data
286 * @len: Length of the target buffer
287 *
288 * Description: Use this function to retrieve the tag buffer from a
289 * completed I/O. The size of the integrity buffer must be <= to the
290 * size reported by bio_integrity_tag_size().
291 */
292int bio_integrity_get_tag(struct bio *bio, void *tag_buf, unsigned int len)
293{
294 BUG_ON(bio_data_dir(bio) != READ);
295
296 return bio_integrity_tag(bio, tag_buf, len, 0);
297}
298EXPORT_SYMBOL(bio_integrity_get_tag);
299
300/**
Gu Zhengbf36f9c2014-02-21 18:10:59 +0800301 * bio_integrity_generate_verify - Generate/verify integrity metadata for a bio
302 * @bio: bio to generate/verify integrity metadata for
303 * @operate: operate number, 1 for generate, 0 for verify
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200304 */
Gu Zhengbf36f9c2014-02-21 18:10:59 +0800305static int bio_integrity_generate_verify(struct bio *bio, int operate)
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200306{
307 struct blk_integrity *bi = bdev_get_integrity(bio->bi_bdev);
308 struct blk_integrity_exchg bix;
Martin K. Petersen0bc69972014-04-08 22:43:44 -0400309 struct bio_vec *bv;
Gu Zhengbf36f9c2014-02-21 18:10:59 +0800310 sector_t sector;
Martin K. Petersen0bc69972014-04-08 22:43:44 -0400311 unsigned int sectors, ret = 0, i;
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200312 void *prot_buf = bio->bi_integrity->bip_buf;
313
Gu Zhengbf36f9c2014-02-21 18:10:59 +0800314 if (operate)
315 sector = bio->bi_iter.bi_sector;
316 else
317 sector = bio->bi_integrity->bip_iter.bi_sector;
318
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200319 bix.disk_name = bio->bi_bdev->bd_disk->disk_name;
320 bix.sector_size = bi->sector_size;
321
Martin K. Petersen0bc69972014-04-08 22:43:44 -0400322 bio_for_each_segment_all(bv, bio, i) {
323 void *kaddr = kmap_atomic(bv->bv_page);
324 bix.data_buf = kaddr + bv->bv_offset;
325 bix.data_size = bv->bv_len;
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200326 bix.prot_buf = prot_buf;
327 bix.sector = sector;
328
Martin K. Petersen0bc69972014-04-08 22:43:44 -0400329 if (operate)
Gu Zhengbf36f9c2014-02-21 18:10:59 +0800330 bi->generate_fn(&bix);
Martin K. Petersen0bc69972014-04-08 22:43:44 -0400331 else {
Gu Zhengbf36f9c2014-02-21 18:10:59 +0800332 ret = bi->verify_fn(&bix);
333 if (ret) {
334 kunmap_atomic(kaddr);
335 return ret;
336 }
337 }
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200338
Martin K. Petersen0bc69972014-04-08 22:43:44 -0400339 sectors = bv->bv_len / bi->sector_size;
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200340 sector += sectors;
341 prot_buf += sectors * bi->tuple_size;
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200342
Cong Wange8e3c3d2011-11-25 23:14:27 +0800343 kunmap_atomic(kaddr);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200344 }
Gu Zhengbf36f9c2014-02-21 18:10:59 +0800345 return ret;
346}
347
348/**
349 * bio_integrity_generate - Generate integrity metadata for a bio
350 * @bio: bio to generate integrity metadata for
351 *
352 * Description: Generates integrity metadata for a bio by calling the
353 * block device's generation callback function. The bio must have a
354 * bip attached with enough room to accommodate the generated
355 * integrity metadata.
356 */
357static void bio_integrity_generate(struct bio *bio)
358{
359 bio_integrity_generate_verify(bio, 1);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200360}
361
Jens Axboe9c02f2b2008-09-18 09:31:53 -0700362static inline unsigned short blk_integrity_tuple_size(struct blk_integrity *bi)
363{
364 if (bi)
365 return bi->tuple_size;
366
367 return 0;
368}
369
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200370/**
371 * bio_integrity_prep - Prepare bio for integrity I/O
372 * @bio: bio to prepare
373 *
374 * Description: Allocates a buffer for integrity metadata, maps the
375 * pages and attaches them to a bio. The bio must have data
376 * direction, target device and start sector set priot to calling. In
377 * the WRITE case, integrity metadata will be generated using the
378 * block device's integrity function. In the READ case, the buffer
379 * will be prepared for DMA and a suitable end_io handler set up.
380 */
381int bio_integrity_prep(struct bio *bio)
382{
383 struct bio_integrity_payload *bip;
384 struct blk_integrity *bi;
385 struct request_queue *q;
386 void *buf;
387 unsigned long start, end;
388 unsigned int len, nr_pages;
389 unsigned int bytes, offset, i;
390 unsigned int sectors;
391
392 bi = bdev_get_integrity(bio->bi_bdev);
393 q = bdev_get_queue(bio->bi_bdev);
394 BUG_ON(bi == NULL);
395 BUG_ON(bio_integrity(bio));
396
397 sectors = bio_integrity_hw_sectors(bi, bio_sectors(bio));
398
399 /* Allocate kernel buffer for protection data */
400 len = sectors * blk_integrity_tuple_size(bi);
David Rientjes72f46502010-08-23 13:35:09 +0200401 buf = kmalloc(len, GFP_NOIO | q->bounce_gfp);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200402 if (unlikely(buf == NULL)) {
403 printk(KERN_ERR "could not allocate integrity buffer\n");
Andrew Morton220eb7f2010-08-23 13:36:20 +0200404 return -ENOMEM;
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200405 }
406
407 end = (((unsigned long) buf) + len + PAGE_SIZE - 1) >> PAGE_SHIFT;
408 start = ((unsigned long) buf) >> PAGE_SHIFT;
409 nr_pages = end - start;
410
411 /* Allocate bio integrity payload and integrity vectors */
412 bip = bio_integrity_alloc(bio, GFP_NOIO, nr_pages);
413 if (unlikely(bip == NULL)) {
414 printk(KERN_ERR "could not allocate data integrity bioset\n");
415 kfree(buf);
416 return -EIO;
417 }
418
Kent Overstreet29ed7812012-09-04 09:54:22 -0700419 bip->bip_owns_buf = 1;
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200420 bip->bip_buf = buf;
Kent Overstreetd57a5f72013-11-23 17:20:16 -0800421 bip->bip_iter.bi_size = len;
422 bip->bip_iter.bi_sector = bio->bi_iter.bi_sector;
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200423
424 /* Map it */
425 offset = offset_in_page(buf);
426 for (i = 0 ; i < nr_pages ; i++) {
427 int ret;
428 bytes = PAGE_SIZE - offset;
429
430 if (len <= 0)
431 break;
432
433 if (bytes > len)
434 bytes = len;
435
436 ret = bio_integrity_add_page(bio, virt_to_page(buf),
437 bytes, offset);
438
439 if (ret == 0)
440 return 0;
441
442 if (ret < bytes)
443 break;
444
445 buf += bytes;
446 len -= bytes;
447 offset = 0;
448 }
449
450 /* Install custom I/O completion handler if read verify is enabled */
451 if (bio_data_dir(bio) == READ) {
452 bip->bip_end_io = bio->bi_end_io;
453 bio->bi_end_io = bio_integrity_endio;
454 }
455
456 /* Auto-generate integrity metadata if this is a write */
457 if (bio_data_dir(bio) == WRITE)
458 bio_integrity_generate(bio);
459
460 return 0;
461}
462EXPORT_SYMBOL(bio_integrity_prep);
463
464/**
465 * bio_integrity_verify - Verify integrity metadata for a bio
466 * @bio: bio to verify
467 *
468 * Description: This function is called to verify the integrity of a
469 * bio. The data in the bio io_vec is compared to the integrity
470 * metadata returned by the HBA.
471 */
472static int bio_integrity_verify(struct bio *bio)
473{
Gu Zhengbf36f9c2014-02-21 18:10:59 +0800474 return bio_integrity_generate_verify(bio, 0);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200475}
476
477/**
478 * bio_integrity_verify_fn - Integrity I/O completion worker
479 * @work: Work struct stored in bio to be verified
480 *
481 * Description: This workqueue function is called to complete a READ
482 * request. The function verifies the transferred integrity metadata
483 * and then calls the original bio end_io function.
484 */
485static void bio_integrity_verify_fn(struct work_struct *work)
486{
Jens Axboeb9846792008-06-17 19:05:48 +0200487 struct bio_integrity_payload *bip =
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200488 container_of(work, struct bio_integrity_payload, bip_work);
489 struct bio *bio = bip->bip_bio;
Martin K. Petersen7b24fc42009-01-04 02:43:38 -0500490 int error;
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200491
Martin K. Petersen7b24fc42009-01-04 02:43:38 -0500492 error = bio_integrity_verify(bio);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200493
494 /* Restore original bio completion handler */
495 bio->bi_end_io = bip->bip_end_io;
Kent Overstreet196d38b2013-11-23 18:34:15 -0800496 bio_endio_nodec(bio, error);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200497}
498
499/**
500 * bio_integrity_endio - Integrity I/O completion function
501 * @bio: Protected bio
502 * @error: Pointer to errno
503 *
504 * Description: Completion for integrity I/O
505 *
506 * Normally I/O completion is done in interrupt context. However,
507 * verifying I/O integrity is a time-consuming task which must be run
508 * in process context. This function postpones completion
509 * accordingly.
510 */
511void bio_integrity_endio(struct bio *bio, int error)
512{
513 struct bio_integrity_payload *bip = bio->bi_integrity;
514
515 BUG_ON(bip->bip_bio != bio);
516
Martin K. Petersen7b24fc42009-01-04 02:43:38 -0500517 /* In case of an I/O error there is no point in verifying the
518 * integrity metadata. Restore original bio end_io handler
519 * and run it.
520 */
521 if (error) {
522 bio->bi_end_io = bip->bip_end_io;
Sagi Grimberg16f408d2014-08-13 14:49:31 +0300523 bio_endio_nodec(bio, error);
Martin K. Petersen7b24fc42009-01-04 02:43:38 -0500524
525 return;
526 }
527
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200528 INIT_WORK(&bip->bip_work, bio_integrity_verify_fn);
529 queue_work(kintegrityd_wq, &bip->bip_work);
530}
531EXPORT_SYMBOL(bio_integrity_endio);
532
533/**
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200534 * bio_integrity_advance - Advance integrity vector
535 * @bio: bio whose integrity vector to update
536 * @bytes_done: number of data bytes that have been completed
537 *
538 * Description: This function calculates how many integrity bytes the
539 * number of completed data bytes correspond to and advances the
540 * integrity vector accordingly.
541 */
542void bio_integrity_advance(struct bio *bio, unsigned int bytes_done)
543{
544 struct bio_integrity_payload *bip = bio->bi_integrity;
545 struct blk_integrity *bi = bdev_get_integrity(bio->bi_bdev);
Kent Overstreetd57a5f72013-11-23 17:20:16 -0800546 unsigned bytes = bio_integrity_bytes(bi, bytes_done >> 9);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200547
Kent Overstreetd57a5f72013-11-23 17:20:16 -0800548 bvec_iter_advance(bip->bip_vec, &bip->bip_iter, bytes);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200549}
550EXPORT_SYMBOL(bio_integrity_advance);
551
552/**
553 * bio_integrity_trim - Trim integrity vector
554 * @bio: bio whose integrity vector to update
555 * @offset: offset to first data sector
556 * @sectors: number of data sectors
557 *
558 * Description: Used to trim the integrity vector in a cloned bio.
559 * The ivec will be advanced corresponding to 'offset' data sectors
560 * and the length will be truncated corresponding to 'len' data
561 * sectors.
562 */
Jens Axboeb9846792008-06-17 19:05:48 +0200563void bio_integrity_trim(struct bio *bio, unsigned int offset,
564 unsigned int sectors)
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200565{
566 struct bio_integrity_payload *bip = bio->bi_integrity;
567 struct blk_integrity *bi = bdev_get_integrity(bio->bi_bdev);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200568
Kent Overstreetd57a5f72013-11-23 17:20:16 -0800569 bio_integrity_advance(bio, offset << 9);
570 bip->bip_iter.bi_size = bio_integrity_bytes(bi, sectors);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200571}
572EXPORT_SYMBOL(bio_integrity_trim);
573
574/**
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200575 * bio_integrity_clone - Callback for cloning bios with integrity metadata
576 * @bio: New bio
577 * @bio_src: Original bio
un'ichi Nomura87092692009-03-09 10:40:52 +0100578 * @gfp_mask: Memory allocation mask
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200579 *
580 * Description: Called to allocate a bip when cloning a bio
581 */
Martin K. Petersen7878cba2009-06-26 15:37:49 +0200582int bio_integrity_clone(struct bio *bio, struct bio *bio_src,
Kent Overstreet1e2a410f2012-09-06 15:34:56 -0700583 gfp_t gfp_mask)
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200584{
585 struct bio_integrity_payload *bip_src = bio_src->bi_integrity;
586 struct bio_integrity_payload *bip;
587
588 BUG_ON(bip_src == NULL);
589
Kent Overstreet1e2a410f2012-09-06 15:34:56 -0700590 bip = bio_integrity_alloc(bio, gfp_mask, bip_src->bip_vcnt);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200591
592 if (bip == NULL)
593 return -EIO;
594
595 memcpy(bip->bip_vec, bip_src->bip_vec,
596 bip_src->bip_vcnt * sizeof(struct bio_vec));
597
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200598 bip->bip_vcnt = bip_src->bip_vcnt;
Kent Overstreetd57a5f72013-11-23 17:20:16 -0800599 bip->bip_iter = bip_src->bip_iter;
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200600
601 return 0;
602}
603EXPORT_SYMBOL(bio_integrity_clone);
604
Martin K. Petersen7878cba2009-06-26 15:37:49 +0200605int bioset_integrity_create(struct bio_set *bs, int pool_size)
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200606{
Martin K. Petersena91a2782011-03-17 11:11:05 +0100607 if (bs->bio_integrity_pool)
608 return 0;
609
Kent Overstreet9f060e22012-10-12 15:29:33 -0700610 bs->bio_integrity_pool = mempool_create_slab_pool(pool_size, bip_slab);
Martin K. Petersen7878cba2009-06-26 15:37:49 +0200611 if (!bs->bio_integrity_pool)
612 return -1;
Martin K. Petersen6d2a78e2009-03-10 08:27:39 +0100613
Fabian Fredericka6c39cb4f2014-04-22 15:09:05 -0600614 bs->bvec_integrity_pool = biovec_create_pool(pool_size);
Gu Zhengbc5c8f02013-09-11 14:23:21 -0700615 if (!bs->bvec_integrity_pool) {
616 mempool_destroy(bs->bio_integrity_pool);
617 return -1;
618 }
619
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200620 return 0;
621}
Martin K. Petersen7878cba2009-06-26 15:37:49 +0200622EXPORT_SYMBOL(bioset_integrity_create);
623
624void bioset_integrity_free(struct bio_set *bs)
625{
626 if (bs->bio_integrity_pool)
627 mempool_destroy(bs->bio_integrity_pool);
Kent Overstreet9f060e22012-10-12 15:29:33 -0700628
629 if (bs->bvec_integrity_pool)
Bjorn Helgaasadbe6992013-05-29 16:29:55 -0600630 mempool_destroy(bs->bvec_integrity_pool);
Martin K. Petersen7878cba2009-06-26 15:37:49 +0200631}
632EXPORT_SYMBOL(bioset_integrity_free);
633
634void __init bio_integrity_init(void)
635{
Tejun Heoa6e8dc42011-01-03 15:01:48 +0100636 /*
637 * kintegrityd won't block much but may burn a lot of CPU cycles.
638 * Make it highpri CPU intensive wq with max concurrency of 1.
639 */
640 kintegrityd_wq = alloc_workqueue("kintegrityd", WQ_MEM_RECLAIM |
641 WQ_HIGHPRI | WQ_CPU_INTENSIVE, 1);
Martin K. Petersen7878cba2009-06-26 15:37:49 +0200642 if (!kintegrityd_wq)
643 panic("Failed to create kintegrityd\n");
644
Kent Overstreet9f060e22012-10-12 15:29:33 -0700645 bip_slab = kmem_cache_create("bio_integrity_payload",
646 sizeof(struct bio_integrity_payload) +
647 sizeof(struct bio_vec) * BIP_INLINE_VECS,
648 0, SLAB_HWCACHE_ALIGN|SLAB_PANIC, NULL);
649 if (!bip_slab)
650 panic("Failed to create slab\n");
Martin K. Petersen7878cba2009-06-26 15:37:49 +0200651}