2 * bio-integrity.c - bio data integrity extensions
4 * Copyright (C) 2007, 2008, 2009 Oracle Corporation
5 * Written by: Martin K. Petersen <martin.petersen@oracle.com>
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.
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.
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,
23 #include <linux/blkdev.h>
24 #include <linux/mempool.h>
25 #include <linux/export.h>
26 #include <linux/bio.h>
27 #include <linux/workqueue.h>
28 #include <linux/slab.h>
30 #define BIP_INLINE_VECS 4
32 static struct kmem_cache *bip_slab;
33 static struct workqueue_struct *kintegrityd_wq;
36 * bio_integrity_alloc - Allocate integrity payload and attach it to bio
37 * @bio: bio to attach integrity metadata to
38 * @gfp_mask: Memory allocation mask
39 * @nr_vecs: Number of integrity metadata scatter-gather elements
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.
45 struct bio_integrity_payload *bio_integrity_alloc(struct bio *bio,
49 struct bio_integrity_payload *bip;
50 struct bio_set *bs = bio->bi_pool;
51 unsigned long idx = BIO_POOL_NONE;
55 bip = kmalloc(sizeof(struct bio_integrity_payload) +
56 sizeof(struct bio_vec) * nr_vecs, gfp_mask);
57 inline_vecs = nr_vecs;
59 bip = mempool_alloc(bs->bio_integrity_pool, gfp_mask);
60 inline_vecs = BIP_INLINE_VECS;
66 memset(bip, 0, sizeof(*bip));
68 if (nr_vecs > inline_vecs) {
69 bip->bip_vec = bvec_alloc(gfp_mask, nr_vecs, &idx,
70 bs->bvec_integrity_pool);
74 bip->bip_vec = bip->bip_inline_vecs;
79 bio->bi_integrity = bip;
83 mempool_free(bip, bs->bio_integrity_pool);
86 EXPORT_SYMBOL(bio_integrity_alloc);
89 * bio_integrity_free - Free bio integrity payload
90 * @bio: bio containing bip to be freed
92 * Description: Used to free the integrity portion of a bio. Usually
93 * called from bio_free().
95 void bio_integrity_free(struct bio *bio)
97 struct bio_integrity_payload *bip = bio->bi_integrity;
98 struct bio_set *bs = bio->bi_pool;
100 if (bip->bip_owns_buf)
104 if (bip->bip_slab != BIO_POOL_NONE)
105 bvec_free(bs->bvec_integrity_pool, bip->bip_vec,
108 mempool_free(bip, bs->bio_integrity_pool);
113 bio->bi_integrity = NULL;
115 EXPORT_SYMBOL(bio_integrity_free);
117 static inline unsigned int bip_integrity_vecs(struct bio_integrity_payload *bip)
119 if (bip->bip_slab == BIO_POOL_NONE)
120 return BIP_INLINE_VECS;
122 return bvec_nr_vecs(bip->bip_slab);
126 * bio_integrity_add_page - Attach integrity metadata
127 * @bio: bio to update
128 * @page: page containing integrity metadata
129 * @len: number of bytes of integrity metadata in page
130 * @offset: start offset within page
132 * Description: Attach a page containing integrity metadata to bio.
134 int bio_integrity_add_page(struct bio *bio, struct page *page,
135 unsigned int len, unsigned int offset)
137 struct bio_integrity_payload *bip = bio->bi_integrity;
140 if (bip->bip_vcnt >= bip_integrity_vecs(bip)) {
141 printk(KERN_ERR "%s: bip_vec full\n", __func__);
145 iv = bip->bip_vec + bip->bip_vcnt;
149 iv->bv_offset = offset;
154 EXPORT_SYMBOL(bio_integrity_add_page);
156 static int bdev_integrity_enabled(struct block_device *bdev, int rw)
158 struct blk_integrity *bi = bdev_get_integrity(bdev);
163 if (rw == READ && bi->verify_fn != NULL &&
164 (bi->flags & INTEGRITY_FLAG_READ))
167 if (rw == WRITE && bi->generate_fn != NULL &&
168 (bi->flags & INTEGRITY_FLAG_WRITE))
175 * bio_integrity_enabled - Check whether integrity can be passed
178 * Description: Determines whether bio_integrity_prep() can be called
179 * on this bio or not. bio data direction and target device must be
180 * set prior to calling. The functions honors the write_generate and
181 * read_verify flags in sysfs.
183 int bio_integrity_enabled(struct bio *bio)
185 /* Already protected? */
186 if (bio_integrity(bio))
189 return bdev_integrity_enabled(bio->bi_bdev, bio_data_dir(bio));
191 EXPORT_SYMBOL(bio_integrity_enabled);
194 * bio_integrity_hw_sectors - Convert 512b sectors to hardware ditto
195 * @bi: blk_integrity profile for device
196 * @sectors: Number of 512 sectors to convert
198 * Description: The block layer calculates everything in 512 byte
199 * sectors but integrity metadata is done in terms of the hardware
200 * sector size of the storage device. Convert the block layer sectors
201 * to physical sectors.
203 static inline unsigned int bio_integrity_hw_sectors(struct blk_integrity *bi,
204 unsigned int sectors)
206 /* At this point there are only 512b or 4096b DIF/EPP devices */
207 if (bi->sector_size == 4096)
208 return sectors >>= 3;
213 static inline unsigned int bio_integrity_bytes(struct blk_integrity *bi,
214 unsigned int sectors)
216 return bio_integrity_hw_sectors(bi, sectors) * bi->tuple_size;
220 * bio_integrity_tag_size - Retrieve integrity tag space
221 * @bio: bio to inspect
223 * Description: Returns the maximum number of tag bytes that can be
224 * attached to this bio. Filesystems can use this to determine how
225 * much metadata to attach to an I/O.
227 unsigned int bio_integrity_tag_size(struct bio *bio)
229 struct blk_integrity *bi = bdev_get_integrity(bio->bi_bdev);
231 BUG_ON(bio->bi_iter.bi_size == 0);
233 return bi->tag_size * (bio->bi_iter.bi_size / bi->sector_size);
235 EXPORT_SYMBOL(bio_integrity_tag_size);
237 int bio_integrity_tag(struct bio *bio, void *tag_buf, unsigned int len, int set)
239 struct bio_integrity_payload *bip = bio->bi_integrity;
240 struct blk_integrity *bi = bdev_get_integrity(bio->bi_bdev);
241 unsigned int nr_sectors;
243 BUG_ON(bip->bip_buf == NULL);
245 if (bi->tag_size == 0)
248 nr_sectors = bio_integrity_hw_sectors(bi,
249 DIV_ROUND_UP(len, bi->tag_size));
251 if (nr_sectors * bi->tuple_size > bip->bip_iter.bi_size) {
252 printk(KERN_ERR "%s: tag too big for bio: %u > %u\n", __func__,
253 nr_sectors * bi->tuple_size, bip->bip_iter.bi_size);
258 bi->set_tag_fn(bip->bip_buf, tag_buf, nr_sectors);
260 bi->get_tag_fn(bip->bip_buf, tag_buf, nr_sectors);
266 * bio_integrity_set_tag - Attach a tag buffer to a bio
267 * @bio: bio to attach buffer to
268 * @tag_buf: Pointer to a buffer containing tag data
269 * @len: Length of the included buffer
271 * Description: Use this function to tag a bio by leveraging the extra
272 * space provided by devices formatted with integrity protection. The
273 * size of the integrity buffer must be <= to the size reported by
274 * bio_integrity_tag_size().
276 int bio_integrity_set_tag(struct bio *bio, void *tag_buf, unsigned int len)
278 BUG_ON(bio_data_dir(bio) != WRITE);
280 return bio_integrity_tag(bio, tag_buf, len, 1);
282 EXPORT_SYMBOL(bio_integrity_set_tag);
285 * bio_integrity_get_tag - Retrieve a tag buffer from a bio
286 * @bio: bio to retrieve buffer from
287 * @tag_buf: Pointer to a buffer for the tag data
288 * @len: Length of the target buffer
290 * Description: Use this function to retrieve the tag buffer from a
291 * completed I/O. The size of the integrity buffer must be <= to the
292 * size reported by bio_integrity_tag_size().
294 int bio_integrity_get_tag(struct bio *bio, void *tag_buf, unsigned int len)
296 BUG_ON(bio_data_dir(bio) != READ);
298 return bio_integrity_tag(bio, tag_buf, len, 0);
300 EXPORT_SYMBOL(bio_integrity_get_tag);
303 * bio_integrity_generate - Generate integrity metadata for a bio
304 * @bio: bio to generate integrity metadata for
306 * Description: Generates integrity metadata for a bio by calling the
307 * block device's generation callback function. The bio must have a
308 * bip attached with enough room to accommodate the generated
309 * integrity metadata.
311 static void bio_integrity_generate(struct bio *bio)
313 struct blk_integrity *bi = bdev_get_integrity(bio->bi_bdev);
314 struct blk_integrity_exchg bix;
316 struct bvec_iter iter;
317 sector_t sector = bio->bi_iter.bi_sector;
318 unsigned int sectors, total;
319 void *prot_buf = bio->bi_integrity->bip_buf;
322 bix.disk_name = bio->bi_bdev->bd_disk->disk_name;
323 bix.sector_size = bi->sector_size;
325 bio_for_each_segment(bv, bio, iter) {
326 void *kaddr = kmap_atomic(bv.bv_page);
327 bix.data_buf = kaddr + bv.bv_offset;
328 bix.data_size = bv.bv_len;
329 bix.prot_buf = prot_buf;
332 bi->generate_fn(&bix);
334 sectors = bv.bv_len / bi->sector_size;
336 prot_buf += sectors * bi->tuple_size;
337 total += sectors * bi->tuple_size;
338 BUG_ON(total > bio->bi_integrity->bip_iter.bi_size);
340 kunmap_atomic(kaddr);
344 static inline unsigned short blk_integrity_tuple_size(struct blk_integrity *bi)
347 return bi->tuple_size;
353 * bio_integrity_prep - Prepare bio for integrity I/O
354 * @bio: bio to prepare
356 * Description: Allocates a buffer for integrity metadata, maps the
357 * pages and attaches them to a bio. The bio must have data
358 * direction, target device and start sector set priot to calling. In
359 * the WRITE case, integrity metadata will be generated using the
360 * block device's integrity function. In the READ case, the buffer
361 * will be prepared for DMA and a suitable end_io handler set up.
363 int bio_integrity_prep(struct bio *bio)
365 struct bio_integrity_payload *bip;
366 struct blk_integrity *bi;
367 struct request_queue *q;
369 unsigned long start, end;
370 unsigned int len, nr_pages;
371 unsigned int bytes, offset, i;
372 unsigned int sectors;
374 bi = bdev_get_integrity(bio->bi_bdev);
375 q = bdev_get_queue(bio->bi_bdev);
377 BUG_ON(bio_integrity(bio));
379 sectors = bio_integrity_hw_sectors(bi, bio_sectors(bio));
381 /* Allocate kernel buffer for protection data */
382 len = sectors * blk_integrity_tuple_size(bi);
383 buf = kmalloc(len, GFP_NOIO | q->bounce_gfp);
384 if (unlikely(buf == NULL)) {
385 printk(KERN_ERR "could not allocate integrity buffer\n");
389 end = (((unsigned long) buf) + len + PAGE_SIZE - 1) >> PAGE_SHIFT;
390 start = ((unsigned long) buf) >> PAGE_SHIFT;
391 nr_pages = end - start;
393 /* Allocate bio integrity payload and integrity vectors */
394 bip = bio_integrity_alloc(bio, GFP_NOIO, nr_pages);
395 if (unlikely(bip == NULL)) {
396 printk(KERN_ERR "could not allocate data integrity bioset\n");
401 bip->bip_owns_buf = 1;
403 bip->bip_iter.bi_size = len;
404 bip->bip_iter.bi_sector = bio->bi_iter.bi_sector;
407 offset = offset_in_page(buf);
408 for (i = 0 ; i < nr_pages ; i++) {
410 bytes = PAGE_SIZE - offset;
418 ret = bio_integrity_add_page(bio, virt_to_page(buf),
432 /* Install custom I/O completion handler if read verify is enabled */
433 if (bio_data_dir(bio) == READ) {
434 bip->bip_end_io = bio->bi_end_io;
435 bio->bi_end_io = bio_integrity_endio;
438 /* Auto-generate integrity metadata if this is a write */
439 if (bio_data_dir(bio) == WRITE)
440 bio_integrity_generate(bio);
444 EXPORT_SYMBOL(bio_integrity_prep);
447 * bio_integrity_verify - Verify integrity metadata for a bio
448 * @bio: bio to verify
450 * Description: This function is called to verify the integrity of a
451 * bio. The data in the bio io_vec is compared to the integrity
452 * metadata returned by the HBA.
454 static int bio_integrity_verify(struct bio *bio)
456 struct blk_integrity *bi = bdev_get_integrity(bio->bi_bdev);
457 struct blk_integrity_exchg bix;
459 sector_t sector = bio->bi_integrity->bip_iter.bi_sector;
460 unsigned int sectors, total, ret;
461 void *prot_buf = bio->bi_integrity->bip_buf;
465 bix.disk_name = bio->bi_bdev->bd_disk->disk_name;
466 bix.sector_size = bi->sector_size;
468 bio_for_each_segment_all(bv, bio, i) {
469 void *kaddr = kmap_atomic(bv->bv_page);
471 bix.data_buf = kaddr + bv->bv_offset;
472 bix.data_size = bv->bv_len;
473 bix.prot_buf = prot_buf;
476 ret = bi->verify_fn(&bix);
479 kunmap_atomic(kaddr);
483 sectors = bv->bv_len / bi->sector_size;
485 prot_buf += sectors * bi->tuple_size;
486 total += sectors * bi->tuple_size;
487 BUG_ON(total > bio->bi_integrity->bip_iter.bi_size);
489 kunmap_atomic(kaddr);
496 * bio_integrity_verify_fn - Integrity I/O completion worker
497 * @work: Work struct stored in bio to be verified
499 * Description: This workqueue function is called to complete a READ
500 * request. The function verifies the transferred integrity metadata
501 * and then calls the original bio end_io function.
503 static void bio_integrity_verify_fn(struct work_struct *work)
505 struct bio_integrity_payload *bip =
506 container_of(work, struct bio_integrity_payload, bip_work);
507 struct bio *bio = bip->bip_bio;
510 error = bio_integrity_verify(bio);
512 /* Restore original bio completion handler */
513 bio->bi_end_io = bip->bip_end_io;
514 bio_endio_nodec(bio, error);
518 * bio_integrity_endio - Integrity I/O completion function
519 * @bio: Protected bio
520 * @error: Pointer to errno
522 * Description: Completion for integrity I/O
524 * Normally I/O completion is done in interrupt context. However,
525 * verifying I/O integrity is a time-consuming task which must be run
526 * in process context. This function postpones completion
529 void bio_integrity_endio(struct bio *bio, int error)
531 struct bio_integrity_payload *bip = bio->bi_integrity;
533 BUG_ON(bip->bip_bio != bio);
535 /* In case of an I/O error there is no point in verifying the
536 * integrity metadata. Restore original bio end_io handler
540 bio->bi_end_io = bip->bip_end_io;
541 bio_endio(bio, error);
546 INIT_WORK(&bip->bip_work, bio_integrity_verify_fn);
547 queue_work(kintegrityd_wq, &bip->bip_work);
549 EXPORT_SYMBOL(bio_integrity_endio);
552 * bio_integrity_advance - Advance integrity vector
553 * @bio: bio whose integrity vector to update
554 * @bytes_done: number of data bytes that have been completed
556 * Description: This function calculates how many integrity bytes the
557 * number of completed data bytes correspond to and advances the
558 * integrity vector accordingly.
560 void bio_integrity_advance(struct bio *bio, unsigned int bytes_done)
562 struct bio_integrity_payload *bip = bio->bi_integrity;
563 struct blk_integrity *bi = bdev_get_integrity(bio->bi_bdev);
564 unsigned bytes = bio_integrity_bytes(bi, bytes_done >> 9);
566 bvec_iter_advance(bip->bip_vec, &bip->bip_iter, bytes);
568 EXPORT_SYMBOL(bio_integrity_advance);
571 * bio_integrity_trim - Trim integrity vector
572 * @bio: bio whose integrity vector to update
573 * @offset: offset to first data sector
574 * @sectors: number of data sectors
576 * Description: Used to trim the integrity vector in a cloned bio.
577 * The ivec will be advanced corresponding to 'offset' data sectors
578 * and the length will be truncated corresponding to 'len' data
581 void bio_integrity_trim(struct bio *bio, unsigned int offset,
582 unsigned int sectors)
584 struct bio_integrity_payload *bip = bio->bi_integrity;
585 struct blk_integrity *bi = bdev_get_integrity(bio->bi_bdev);
587 bio_integrity_advance(bio, offset << 9);
588 bip->bip_iter.bi_size = bio_integrity_bytes(bi, sectors);
590 EXPORT_SYMBOL(bio_integrity_trim);
593 * bio_integrity_clone - Callback for cloning bios with integrity metadata
595 * @bio_src: Original bio
596 * @gfp_mask: Memory allocation mask
598 * Description: Called to allocate a bip when cloning a bio
600 int bio_integrity_clone(struct bio *bio, struct bio *bio_src,
603 struct bio_integrity_payload *bip_src = bio_src->bi_integrity;
604 struct bio_integrity_payload *bip;
606 BUG_ON(bip_src == NULL);
608 bip = bio_integrity_alloc(bio, gfp_mask, bip_src->bip_vcnt);
613 memcpy(bip->bip_vec, bip_src->bip_vec,
614 bip_src->bip_vcnt * sizeof(struct bio_vec));
616 bip->bip_vcnt = bip_src->bip_vcnt;
617 bip->bip_iter = bip_src->bip_iter;
621 EXPORT_SYMBOL(bio_integrity_clone);
623 int bioset_integrity_create(struct bio_set *bs, int pool_size)
625 if (bs->bio_integrity_pool)
628 bs->bio_integrity_pool = mempool_create_slab_pool(pool_size, bip_slab);
629 if (!bs->bio_integrity_pool)
632 bs->bvec_integrity_pool = biovec_create_pool(bs, pool_size);
633 if (!bs->bvec_integrity_pool) {
634 mempool_destroy(bs->bio_integrity_pool);
640 EXPORT_SYMBOL(bioset_integrity_create);
642 void bioset_integrity_free(struct bio_set *bs)
644 if (bs->bio_integrity_pool)
645 mempool_destroy(bs->bio_integrity_pool);
647 if (bs->bvec_integrity_pool)
648 mempool_destroy(bs->bvec_integrity_pool);
650 EXPORT_SYMBOL(bioset_integrity_free);
652 void __init bio_integrity_init(void)
655 * kintegrityd won't block much but may burn a lot of CPU cycles.
656 * Make it highpri CPU intensive wq with max concurrency of 1.
658 kintegrityd_wq = alloc_workqueue("kintegrityd", WQ_MEM_RECLAIM |
659 WQ_HIGHPRI | WQ_CPU_INTENSIVE, 1);
661 panic("Failed to create kintegrityd\n");
663 bip_slab = kmem_cache_create("bio_integrity_payload",
664 sizeof(struct bio_integrity_payload) +
665 sizeof(struct bio_vec) * BIP_INLINE_VECS,
666 0, SLAB_HWCACHE_ALIGN|SLAB_PANIC, NULL);
668 panic("Failed to create slab\n");