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_vec_idx(bip
, bip
->bip_vcnt
);
150 iv
->bv_offset
= offset
;
155 EXPORT_SYMBOL(bio_integrity_add_page
);
157 static int bdev_integrity_enabled(struct block_device
*bdev
, int rw
)
159 struct blk_integrity
*bi
= bdev_get_integrity(bdev
);
164 if (rw
== READ
&& bi
->verify_fn
!= NULL
&&
165 (bi
->flags
& INTEGRITY_FLAG_READ
))
168 if (rw
== WRITE
&& bi
->generate_fn
!= NULL
&&
169 (bi
->flags
& INTEGRITY_FLAG_WRITE
))
176 * bio_integrity_enabled - Check whether integrity can be passed
179 * Description: Determines whether bio_integrity_prep() can be called
180 * on this bio or not. bio data direction and target device must be
181 * set prior to calling. The functions honors the write_generate and
182 * read_verify flags in sysfs.
184 int bio_integrity_enabled(struct bio
*bio
)
186 /* Already protected? */
187 if (bio_integrity(bio
))
190 return bdev_integrity_enabled(bio
->bi_bdev
, bio_data_dir(bio
));
192 EXPORT_SYMBOL(bio_integrity_enabled
);
195 * bio_integrity_hw_sectors - Convert 512b sectors to hardware ditto
196 * @bi: blk_integrity profile for device
197 * @sectors: Number of 512 sectors to convert
199 * Description: The block layer calculates everything in 512 byte
200 * sectors but integrity metadata is done in terms of the hardware
201 * sector size of the storage device. Convert the block layer sectors
202 * to physical sectors.
204 static inline unsigned int bio_integrity_hw_sectors(struct blk_integrity
*bi
,
205 unsigned int sectors
)
207 /* At this point there are only 512b or 4096b DIF/EPP devices */
208 if (bi
->sector_size
== 4096)
209 return sectors
>>= 3;
215 * bio_integrity_tag_size - Retrieve integrity tag space
216 * @bio: bio to inspect
218 * Description: Returns the maximum number of tag bytes that can be
219 * attached to this bio. Filesystems can use this to determine how
220 * much metadata to attach to an I/O.
222 unsigned int bio_integrity_tag_size(struct bio
*bio
)
224 struct blk_integrity
*bi
= bdev_get_integrity(bio
->bi_bdev
);
226 BUG_ON(bio
->bi_size
== 0);
228 return bi
->tag_size
* (bio
->bi_size
/ bi
->sector_size
);
230 EXPORT_SYMBOL(bio_integrity_tag_size
);
232 int bio_integrity_tag(struct bio
*bio
, void *tag_buf
, unsigned int len
, int set
)
234 struct bio_integrity_payload
*bip
= bio
->bi_integrity
;
235 struct blk_integrity
*bi
= bdev_get_integrity(bio
->bi_bdev
);
236 unsigned int nr_sectors
;
238 BUG_ON(bip
->bip_buf
== NULL
);
240 if (bi
->tag_size
== 0)
243 nr_sectors
= bio_integrity_hw_sectors(bi
,
244 DIV_ROUND_UP(len
, bi
->tag_size
));
246 if (nr_sectors
* bi
->tuple_size
> bip
->bip_size
) {
247 printk(KERN_ERR
"%s: tag too big for bio: %u > %u\n",
248 __func__
, nr_sectors
* bi
->tuple_size
, bip
->bip_size
);
253 bi
->set_tag_fn(bip
->bip_buf
, tag_buf
, nr_sectors
);
255 bi
->get_tag_fn(bip
->bip_buf
, tag_buf
, nr_sectors
);
261 * bio_integrity_set_tag - Attach a tag buffer to a bio
262 * @bio: bio to attach buffer to
263 * @tag_buf: Pointer to a buffer containing tag data
264 * @len: Length of the included buffer
266 * Description: Use this function to tag a bio by leveraging the extra
267 * space provided by devices formatted with integrity protection. The
268 * size of the integrity buffer must be <= to the size reported by
269 * bio_integrity_tag_size().
271 int bio_integrity_set_tag(struct bio
*bio
, void *tag_buf
, unsigned int len
)
273 BUG_ON(bio_data_dir(bio
) != WRITE
);
275 return bio_integrity_tag(bio
, tag_buf
, len
, 1);
277 EXPORT_SYMBOL(bio_integrity_set_tag
);
280 * bio_integrity_get_tag - Retrieve a tag buffer from a bio
281 * @bio: bio to retrieve buffer from
282 * @tag_buf: Pointer to a buffer for the tag data
283 * @len: Length of the target buffer
285 * Description: Use this function to retrieve the tag buffer from a
286 * completed I/O. The size of the integrity buffer must be <= to the
287 * size reported by bio_integrity_tag_size().
289 int bio_integrity_get_tag(struct bio
*bio
, void *tag_buf
, unsigned int len
)
291 BUG_ON(bio_data_dir(bio
) != READ
);
293 return bio_integrity_tag(bio
, tag_buf
, len
, 0);
295 EXPORT_SYMBOL(bio_integrity_get_tag
);
298 * bio_integrity_generate - Generate integrity metadata for a bio
299 * @bio: bio to generate integrity metadata for
301 * Description: Generates integrity metadata for a bio by calling the
302 * block device's generation callback function. The bio must have a
303 * bip attached with enough room to accommodate the generated
304 * integrity metadata.
306 static void bio_integrity_generate(struct bio
*bio
)
308 struct blk_integrity
*bi
= bdev_get_integrity(bio
->bi_bdev
);
309 struct blk_integrity_exchg bix
;
311 sector_t sector
= bio
->bi_sector
;
312 unsigned int i
, sectors
, total
;
313 void *prot_buf
= bio
->bi_integrity
->bip_buf
;
316 bix
.disk_name
= bio
->bi_bdev
->bd_disk
->disk_name
;
317 bix
.sector_size
= bi
->sector_size
;
319 bio_for_each_segment(bv
, bio
, i
) {
320 void *kaddr
= kmap_atomic(bv
->bv_page
);
321 bix
.data_buf
= kaddr
+ bv
->bv_offset
;
322 bix
.data_size
= bv
->bv_len
;
323 bix
.prot_buf
= prot_buf
;
326 bi
->generate_fn(&bix
);
328 sectors
= bv
->bv_len
/ bi
->sector_size
;
330 prot_buf
+= sectors
* bi
->tuple_size
;
331 total
+= sectors
* bi
->tuple_size
;
332 BUG_ON(total
> bio
->bi_integrity
->bip_size
);
334 kunmap_atomic(kaddr
);
338 static inline unsigned short blk_integrity_tuple_size(struct blk_integrity
*bi
)
341 return bi
->tuple_size
;
347 * bio_integrity_prep - Prepare bio for integrity I/O
348 * @bio: bio to prepare
350 * Description: Allocates a buffer for integrity metadata, maps the
351 * pages and attaches them to a bio. The bio must have data
352 * direction, target device and start sector set priot to calling. In
353 * the WRITE case, integrity metadata will be generated using the
354 * block device's integrity function. In the READ case, the buffer
355 * will be prepared for DMA and a suitable end_io handler set up.
357 int bio_integrity_prep(struct bio
*bio
)
359 struct bio_integrity_payload
*bip
;
360 struct blk_integrity
*bi
;
361 struct request_queue
*q
;
363 unsigned long start
, end
;
364 unsigned int len
, nr_pages
;
365 unsigned int bytes
, offset
, i
;
366 unsigned int sectors
;
368 bi
= bdev_get_integrity(bio
->bi_bdev
);
369 q
= bdev_get_queue(bio
->bi_bdev
);
371 BUG_ON(bio_integrity(bio
));
373 sectors
= bio_integrity_hw_sectors(bi
, bio_sectors(bio
));
375 /* Allocate kernel buffer for protection data */
376 len
= sectors
* blk_integrity_tuple_size(bi
);
377 buf
= kmalloc(len
, GFP_NOIO
| q
->bounce_gfp
);
378 if (unlikely(buf
== NULL
)) {
379 printk(KERN_ERR
"could not allocate integrity buffer\n");
383 end
= (((unsigned long) buf
) + len
+ PAGE_SIZE
- 1) >> PAGE_SHIFT
;
384 start
= ((unsigned long) buf
) >> PAGE_SHIFT
;
385 nr_pages
= end
- start
;
387 /* Allocate bio integrity payload and integrity vectors */
388 bip
= bio_integrity_alloc(bio
, GFP_NOIO
, nr_pages
);
389 if (unlikely(bip
== NULL
)) {
390 printk(KERN_ERR
"could not allocate data integrity bioset\n");
395 bip
->bip_owns_buf
= 1;
398 bip
->bip_sector
= bio
->bi_sector
;
401 offset
= offset_in_page(buf
);
402 for (i
= 0 ; i
< nr_pages
; i
++) {
404 bytes
= PAGE_SIZE
- offset
;
412 ret
= bio_integrity_add_page(bio
, virt_to_page(buf
),
426 /* Install custom I/O completion handler if read verify is enabled */
427 if (bio_data_dir(bio
) == READ
) {
428 bip
->bip_end_io
= bio
->bi_end_io
;
429 bio
->bi_end_io
= bio_integrity_endio
;
432 /* Auto-generate integrity metadata if this is a write */
433 if (bio_data_dir(bio
) == WRITE
)
434 bio_integrity_generate(bio
);
438 EXPORT_SYMBOL(bio_integrity_prep
);
441 * bio_integrity_verify - Verify integrity metadata for a bio
442 * @bio: bio to verify
444 * Description: This function is called to verify the integrity of a
445 * bio. The data in the bio io_vec is compared to the integrity
446 * metadata returned by the HBA.
448 static int bio_integrity_verify(struct bio
*bio
)
450 struct blk_integrity
*bi
= bdev_get_integrity(bio
->bi_bdev
);
451 struct blk_integrity_exchg bix
;
453 sector_t sector
= bio
->bi_integrity
->bip_sector
;
454 unsigned int i
, sectors
, total
, ret
;
455 void *prot_buf
= bio
->bi_integrity
->bip_buf
;
458 bix
.disk_name
= bio
->bi_bdev
->bd_disk
->disk_name
;
459 bix
.sector_size
= bi
->sector_size
;
461 bio_for_each_segment_all(bv
, bio
, i
) {
462 void *kaddr
= kmap_atomic(bv
->bv_page
);
463 bix
.data_buf
= kaddr
+ bv
->bv_offset
;
464 bix
.data_size
= bv
->bv_len
;
465 bix
.prot_buf
= prot_buf
;
468 ret
= bi
->verify_fn(&bix
);
471 kunmap_atomic(kaddr
);
475 sectors
= bv
->bv_len
/ bi
->sector_size
;
477 prot_buf
+= sectors
* bi
->tuple_size
;
478 total
+= sectors
* bi
->tuple_size
;
479 BUG_ON(total
> bio
->bi_integrity
->bip_size
);
481 kunmap_atomic(kaddr
);
488 * bio_integrity_verify_fn - Integrity I/O completion worker
489 * @work: Work struct stored in bio to be verified
491 * Description: This workqueue function is called to complete a READ
492 * request. The function verifies the transferred integrity metadata
493 * and then calls the original bio end_io function.
495 static void bio_integrity_verify_fn(struct work_struct
*work
)
497 struct bio_integrity_payload
*bip
=
498 container_of(work
, struct bio_integrity_payload
, bip_work
);
499 struct bio
*bio
= bip
->bip_bio
;
502 error
= bio_integrity_verify(bio
);
504 /* Restore original bio completion handler */
505 bio
->bi_end_io
= bip
->bip_end_io
;
506 bio_endio(bio
, error
);
510 * bio_integrity_endio - Integrity I/O completion function
511 * @bio: Protected bio
512 * @error: Pointer to errno
514 * Description: Completion for integrity I/O
516 * Normally I/O completion is done in interrupt context. However,
517 * verifying I/O integrity is a time-consuming task which must be run
518 * in process context. This function postpones completion
521 void bio_integrity_endio(struct bio
*bio
, int error
)
523 struct bio_integrity_payload
*bip
= bio
->bi_integrity
;
525 BUG_ON(bip
->bip_bio
!= bio
);
527 /* In case of an I/O error there is no point in verifying the
528 * integrity metadata. Restore original bio end_io handler
532 bio
->bi_end_io
= bip
->bip_end_io
;
533 bio_endio(bio
, error
);
538 INIT_WORK(&bip
->bip_work
, bio_integrity_verify_fn
);
539 queue_work(kintegrityd_wq
, &bip
->bip_work
);
541 EXPORT_SYMBOL(bio_integrity_endio
);
544 * bio_integrity_mark_head - Advance bip_vec skip bytes
545 * @bip: Integrity vector to advance
546 * @skip: Number of bytes to advance it
548 void bio_integrity_mark_head(struct bio_integrity_payload
*bip
,
554 bip_for_each_vec(iv
, bip
, i
) {
558 } else if (skip
>= iv
->bv_len
) {
560 } else { /* skip < iv->bv_len) */
561 iv
->bv_offset
+= skip
;
570 * bio_integrity_mark_tail - Truncate bip_vec to be len bytes long
571 * @bip: Integrity vector to truncate
572 * @len: New length of integrity vector
574 void bio_integrity_mark_tail(struct bio_integrity_payload
*bip
,
580 bip_for_each_vec(iv
, bip
, i
) {
584 } else if (len
>= iv
->bv_len
) {
586 } else { /* len < iv->bv_len) */
594 * bio_integrity_advance - Advance integrity vector
595 * @bio: bio whose integrity vector to update
596 * @bytes_done: number of data bytes that have been completed
598 * Description: This function calculates how many integrity bytes the
599 * number of completed data bytes correspond to and advances the
600 * integrity vector accordingly.
602 void bio_integrity_advance(struct bio
*bio
, unsigned int bytes_done
)
604 struct bio_integrity_payload
*bip
= bio
->bi_integrity
;
605 struct blk_integrity
*bi
= bdev_get_integrity(bio
->bi_bdev
);
606 unsigned int nr_sectors
;
611 nr_sectors
= bio_integrity_hw_sectors(bi
, bytes_done
>> 9);
612 bio_integrity_mark_head(bip
, nr_sectors
* bi
->tuple_size
);
614 EXPORT_SYMBOL(bio_integrity_advance
);
617 * bio_integrity_trim - Trim integrity vector
618 * @bio: bio whose integrity vector to update
619 * @offset: offset to first data sector
620 * @sectors: number of data sectors
622 * Description: Used to trim the integrity vector in a cloned bio.
623 * The ivec will be advanced corresponding to 'offset' data sectors
624 * and the length will be truncated corresponding to 'len' data
627 void bio_integrity_trim(struct bio
*bio
, unsigned int offset
,
628 unsigned int sectors
)
630 struct bio_integrity_payload
*bip
= bio
->bi_integrity
;
631 struct blk_integrity
*bi
= bdev_get_integrity(bio
->bi_bdev
);
632 unsigned int nr_sectors
;
636 BUG_ON(!bio_flagged(bio
, BIO_CLONED
));
638 nr_sectors
= bio_integrity_hw_sectors(bi
, sectors
);
639 bip
->bip_sector
= bip
->bip_sector
+ offset
;
640 bio_integrity_mark_head(bip
, offset
* bi
->tuple_size
);
641 bio_integrity_mark_tail(bip
, sectors
* bi
->tuple_size
);
643 EXPORT_SYMBOL(bio_integrity_trim
);
646 * bio_integrity_split - Split integrity metadata
647 * @bio: Protected bio
648 * @bp: Resulting bio_pair
651 * Description: Splits an integrity page into a bio_pair.
653 void bio_integrity_split(struct bio
*bio
, struct bio_pair
*bp
, int sectors
)
655 struct blk_integrity
*bi
;
656 struct bio_integrity_payload
*bip
= bio
->bi_integrity
;
657 unsigned int nr_sectors
;
659 if (bio_integrity(bio
) == 0)
662 bi
= bdev_get_integrity(bio
->bi_bdev
);
664 BUG_ON(bip
->bip_vcnt
!= 1);
666 nr_sectors
= bio_integrity_hw_sectors(bi
, sectors
);
668 bp
->bio1
.bi_integrity
= &bp
->bip1
;
669 bp
->bio2
.bi_integrity
= &bp
->bip2
;
671 bp
->iv1
= bip
->bip_vec
[bip
->bip_idx
];
672 bp
->iv2
= bip
->bip_vec
[bip
->bip_idx
];
674 bp
->bip1
.bip_vec
= &bp
->iv1
;
675 bp
->bip2
.bip_vec
= &bp
->iv2
;
677 bp
->iv1
.bv_len
= sectors
* bi
->tuple_size
;
678 bp
->iv2
.bv_offset
+= sectors
* bi
->tuple_size
;
679 bp
->iv2
.bv_len
-= sectors
* bi
->tuple_size
;
681 bp
->bip1
.bip_sector
= bio
->bi_integrity
->bip_sector
;
682 bp
->bip2
.bip_sector
= bio
->bi_integrity
->bip_sector
+ nr_sectors
;
684 bp
->bip1
.bip_vcnt
= bp
->bip2
.bip_vcnt
= 1;
685 bp
->bip1
.bip_idx
= bp
->bip2
.bip_idx
= 0;
687 EXPORT_SYMBOL(bio_integrity_split
);
690 * bio_integrity_clone - Callback for cloning bios with integrity metadata
692 * @bio_src: Original bio
693 * @gfp_mask: Memory allocation mask
695 * Description: Called to allocate a bip when cloning a bio
697 int bio_integrity_clone(struct bio
*bio
, struct bio
*bio_src
,
700 struct bio_integrity_payload
*bip_src
= bio_src
->bi_integrity
;
701 struct bio_integrity_payload
*bip
;
703 BUG_ON(bip_src
== NULL
);
705 bip
= bio_integrity_alloc(bio
, gfp_mask
, bip_src
->bip_vcnt
);
710 memcpy(bip
->bip_vec
, bip_src
->bip_vec
,
711 bip_src
->bip_vcnt
* sizeof(struct bio_vec
));
713 bip
->bip_sector
= bip_src
->bip_sector
;
714 bip
->bip_vcnt
= bip_src
->bip_vcnt
;
715 bip
->bip_idx
= bip_src
->bip_idx
;
719 EXPORT_SYMBOL(bio_integrity_clone
);
721 int bioset_integrity_create(struct bio_set
*bs
, int pool_size
)
723 if (bs
->bio_integrity_pool
)
726 bs
->bio_integrity_pool
= mempool_create_slab_pool(pool_size
, bip_slab
);
728 bs
->bvec_integrity_pool
= biovec_create_pool(bs
, pool_size
);
729 if (!bs
->bvec_integrity_pool
)
732 if (!bs
->bio_integrity_pool
)
737 EXPORT_SYMBOL(bioset_integrity_create
);
739 void bioset_integrity_free(struct bio_set
*bs
)
741 if (bs
->bio_integrity_pool
)
742 mempool_destroy(bs
->bio_integrity_pool
);
744 if (bs
->bvec_integrity_pool
)
745 mempool_destroy(bs
->bvec_integrity_pool
);
747 EXPORT_SYMBOL(bioset_integrity_free
);
749 void __init
bio_integrity_init(void)
752 * kintegrityd won't block much but may burn a lot of CPU cycles.
753 * Make it highpri CPU intensive wq with max concurrency of 1.
755 kintegrityd_wq
= alloc_workqueue("kintegrityd", WQ_MEM_RECLAIM
|
756 WQ_HIGHPRI
| WQ_CPU_INTENSIVE
, 1);
758 panic("Failed to create kintegrityd\n");
760 bip_slab
= kmem_cache_create("bio_integrity_payload",
761 sizeof(struct bio_integrity_payload
) +
762 sizeof(struct bio_vec
) * BIP_INLINE_VECS
,
763 0, SLAB_HWCACHE_ALIGN
|SLAB_PANIC
, NULL
);
765 panic("Failed to create slab\n");