blob: 14b8faf8b09d48937985713e10ed25745aad2dc2 [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
Mike Snitzerbb8bd382015-07-01 12:57:40 -040054 if (!bs || !bs->bio_integrity_pool) {
Kent Overstreet9f060e22012-10-12 15:29:33 -070055 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;
Martin K. Petersen180b2f92014-09-26 19:19:56 -040082 bio->bi_rw |= REQ_INTEGRITY;
Martin K. Petersen7878cba2009-06-26 15:37:49 +020083
84 return bip;
Kent Overstreet9f060e22012-10-12 15:29:33 -070085err:
86 mempool_free(bip, bs->bio_integrity_pool);
87 return NULL;
Martin K. Petersen7878cba2009-06-26 15:37:49 +020088}
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +020089EXPORT_SYMBOL(bio_integrity_alloc);
90
91/**
92 * bio_integrity_free - Free bio integrity payload
93 * @bio: bio containing bip to be freed
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +020094 *
95 * Description: Used to free the integrity portion of a bio. Usually
96 * called from bio_free().
97 */
Kent Overstreet1e2a410f2012-09-06 15:34:56 -070098void bio_integrity_free(struct bio *bio)
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +020099{
Martin K. Petersen180b2f92014-09-26 19:19:56 -0400100 struct bio_integrity_payload *bip = bio_integrity(bio);
Kent Overstreet1e2a410f2012-09-06 15:34:56 -0700101 struct bio_set *bs = bio->bi_pool;
102
Martin K. Petersenb1f0138852014-09-26 19:20:04 -0400103 if (bip->bip_flags & BIP_BLOCK_INTEGRITY)
Martin K. Petersen5f9378f2014-09-26 19:19:58 -0400104 kfree(page_address(bip->bip_vec->bv_page) +
105 bip->bip_vec->bv_offset);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200106
Mike Snitzerbb8bd382015-07-01 12:57:40 -0400107 if (bs && bs->bio_integrity_pool) {
Kent Overstreet9f060e22012-10-12 15:29:33 -0700108 if (bip->bip_slab != BIO_POOL_NONE)
109 bvec_free(bs->bvec_integrity_pool, bip->bip_vec,
110 bip->bip_slab);
111
Martin K. Petersen7878cba2009-06-26 15:37:49 +0200112 mempool_free(bip, bs->bio_integrity_pool);
Kent Overstreet9f060e22012-10-12 15:29:33 -0700113 } else {
114 kfree(bip);
115 }
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200116
117 bio->bi_integrity = NULL;
118}
119EXPORT_SYMBOL(bio_integrity_free);
120
121/**
122 * bio_integrity_add_page - Attach integrity metadata
123 * @bio: bio to update
124 * @page: page containing integrity metadata
125 * @len: number of bytes of integrity metadata in page
126 * @offset: start offset within page
127 *
128 * Description: Attach a page containing integrity metadata to bio.
129 */
130int bio_integrity_add_page(struct bio *bio, struct page *page,
131 unsigned int len, unsigned int offset)
132{
Martin K. Petersen180b2f92014-09-26 19:19:56 -0400133 struct bio_integrity_payload *bip = bio_integrity(bio);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200134 struct bio_vec *iv;
135
Gu Zhengcbcd10542014-07-01 10:36:47 -0600136 if (bip->bip_vcnt >= bip->bip_max_vcnt) {
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200137 printk(KERN_ERR "%s: bip_vec full\n", __func__);
138 return 0;
139 }
140
Kent Overstreetd57a5f72013-11-23 17:20:16 -0800141 iv = bip->bip_vec + bip->bip_vcnt;
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200142
Sagi Grimberg87a816d2015-09-08 09:33:35 -0600143 if (bip->bip_vcnt &&
144 bvec_gap_to_prev(bdev_get_queue(bio->bi_bdev),
145 &bip->bip_vec[bip->bip_vcnt - 1], offset))
146 return 0;
147
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200148 iv->bv_page = page;
149 iv->bv_len = len;
150 iv->bv_offset = offset;
151 bip->bip_vcnt++;
152
153 return len;
154}
155EXPORT_SYMBOL(bio_integrity_add_page);
156
157/**
158 * bio_integrity_enabled - Check whether integrity can be passed
159 * @bio: bio to check
160 *
161 * Description: Determines whether bio_integrity_prep() can be called
162 * on this bio or not. bio data direction and target device must be
163 * set prior to calling. The functions honors the write_generate and
164 * read_verify flags in sysfs.
165 */
Martin K. Petersene7258c12014-09-26 19:19:55 -0400166bool bio_integrity_enabled(struct bio *bio)
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200167{
Martin K. Petersene7258c12014-09-26 19:19:55 -0400168 struct blk_integrity *bi = bdev_get_integrity(bio->bi_bdev);
169
Martin K. Petersene69f18f2014-04-08 22:59:31 -0400170 if (!bio_is_rw(bio))
Martin K. Petersene7258c12014-09-26 19:19:55 -0400171 return false;
Martin K. Petersene69f18f2014-04-08 22:59:31 -0400172
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200173 /* Already protected? */
174 if (bio_integrity(bio))
Martin K. Petersene7258c12014-09-26 19:19:55 -0400175 return false;
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200176
Martin K. Petersene7258c12014-09-26 19:19:55 -0400177 if (bi == NULL)
178 return false;
179
180 if (bio_data_dir(bio) == READ && bi->verify_fn != NULL &&
Martin K. Petersen8288f492014-09-26 19:20:02 -0400181 (bi->flags & BLK_INTEGRITY_VERIFY))
Martin K. Petersene7258c12014-09-26 19:19:55 -0400182 return true;
183
184 if (bio_data_dir(bio) == WRITE && bi->generate_fn != NULL &&
Martin K. Petersen8288f492014-09-26 19:20:02 -0400185 (bi->flags & BLK_INTEGRITY_GENERATE))
Martin K. Petersene7258c12014-09-26 19:19:55 -0400186 return true;
187
188 return false;
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200189}
190EXPORT_SYMBOL(bio_integrity_enabled);
191
192/**
Martin K. Petersen3be91c42014-09-26 19:19:59 -0400193 * bio_integrity_intervals - Return number of integrity intervals for a bio
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200194 * @bi: blk_integrity profile for device
Martin K. Petersen3be91c42014-09-26 19:19:59 -0400195 * @sectors: Size of the bio in 512-byte sectors
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200196 *
197 * Description: The block layer calculates everything in 512 byte
Martin K. Petersen3be91c42014-09-26 19:19:59 -0400198 * sectors but integrity metadata is done in terms of the data integrity
199 * interval size of the storage device. Convert the block layer sectors
200 * to the appropriate number of integrity intervals.
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200201 */
Martin K. Petersen3be91c42014-09-26 19:19:59 -0400202static inline unsigned int bio_integrity_intervals(struct blk_integrity *bi,
203 unsigned int sectors)
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200204{
Martin K. Petersen5a2aa872014-09-26 19:20:00 -0400205 return sectors >> (ilog2(bi->interval) - 9);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200206}
207
Kent Overstreetd57a5f72013-11-23 17:20:16 -0800208static inline unsigned int bio_integrity_bytes(struct blk_integrity *bi,
209 unsigned int sectors)
210{
Martin K. Petersen3be91c42014-09-26 19:19:59 -0400211 return bio_integrity_intervals(bi, sectors) * bi->tuple_size;
Kent Overstreetd57a5f72013-11-23 17:20:16 -0800212}
213
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200214/**
Martin K. Petersen18593082014-09-26 19:20:01 -0400215 * bio_integrity_process - Process integrity metadata for a bio
Gu Zhengbf36f9c2014-02-21 18:10:59 +0800216 * @bio: bio to generate/verify integrity metadata for
Martin K. Petersen18593082014-09-26 19:20:01 -0400217 * @proc_fn: Pointer to the relevant processing function
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200218 */
Martin K. Petersen18593082014-09-26 19:20:01 -0400219static int bio_integrity_process(struct bio *bio,
220 integrity_processing_fn *proc_fn)
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200221{
222 struct blk_integrity *bi = bdev_get_integrity(bio->bi_bdev);
Martin K. Petersen18593082014-09-26 19:20:01 -0400223 struct blk_integrity_iter iter;
Darrick J. Wong594416a2014-11-25 17:40:25 -0800224 struct bvec_iter bviter;
225 struct bio_vec bv;
Martin K. Petersen5f9378f2014-09-26 19:19:58 -0400226 struct bio_integrity_payload *bip = bio_integrity(bio);
Darrick J. Wong594416a2014-11-25 17:40:25 -0800227 unsigned int ret = 0;
Martin K. Petersen5f9378f2014-09-26 19:19:58 -0400228 void *prot_buf = page_address(bip->bip_vec->bv_page) +
229 bip->bip_vec->bv_offset;
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200230
Martin K. Petersen18593082014-09-26 19:20:01 -0400231 iter.disk_name = bio->bi_bdev->bd_disk->disk_name;
232 iter.interval = bi->interval;
233 iter.seed = bip_get_seed(bip);
234 iter.prot_buf = prot_buf;
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200235
Darrick J. Wong594416a2014-11-25 17:40:25 -0800236 bio_for_each_segment(bv, bio, bviter) {
237 void *kaddr = kmap_atomic(bv.bv_page);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200238
Darrick J. Wong594416a2014-11-25 17:40:25 -0800239 iter.data_buf = kaddr + bv.bv_offset;
240 iter.data_size = bv.bv_len;
Martin K. Petersen18593082014-09-26 19:20:01 -0400241
242 ret = proc_fn(&iter);
243 if (ret) {
244 kunmap_atomic(kaddr);
245 return ret;
Gu Zhengbf36f9c2014-02-21 18:10:59 +0800246 }
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200247
Cong Wange8e3c3d2011-11-25 23:14:27 +0800248 kunmap_atomic(kaddr);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200249 }
Gu Zhengbf36f9c2014-02-21 18:10:59 +0800250 return ret;
251}
252
253/**
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200254 * bio_integrity_prep - Prepare bio for integrity I/O
255 * @bio: bio to prepare
256 *
257 * Description: Allocates a buffer for integrity metadata, maps the
258 * pages and attaches them to a bio. The bio must have data
259 * direction, target device and start sector set priot to calling. In
260 * the WRITE case, integrity metadata will be generated using the
261 * block device's integrity function. In the READ case, the buffer
262 * will be prepared for DMA and a suitable end_io handler set up.
263 */
264int bio_integrity_prep(struct bio *bio)
265{
266 struct bio_integrity_payload *bip;
267 struct blk_integrity *bi;
268 struct request_queue *q;
269 void *buf;
270 unsigned long start, end;
271 unsigned int len, nr_pages;
272 unsigned int bytes, offset, i;
Martin K. Petersen3be91c42014-09-26 19:19:59 -0400273 unsigned int intervals;
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200274
275 bi = bdev_get_integrity(bio->bi_bdev);
276 q = bdev_get_queue(bio->bi_bdev);
277 BUG_ON(bi == NULL);
278 BUG_ON(bio_integrity(bio));
279
Martin K. Petersen3be91c42014-09-26 19:19:59 -0400280 intervals = bio_integrity_intervals(bi, bio_sectors(bio));
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200281
282 /* Allocate kernel buffer for protection data */
Martin K. Petersen3be91c42014-09-26 19:19:59 -0400283 len = intervals * bi->tuple_size;
David Rientjes72f46502010-08-23 13:35:09 +0200284 buf = kmalloc(len, GFP_NOIO | q->bounce_gfp);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200285 if (unlikely(buf == NULL)) {
286 printk(KERN_ERR "could not allocate integrity buffer\n");
Andrew Morton220eb7f2010-08-23 13:36:20 +0200287 return -ENOMEM;
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200288 }
289
290 end = (((unsigned long) buf) + len + PAGE_SIZE - 1) >> PAGE_SHIFT;
291 start = ((unsigned long) buf) >> PAGE_SHIFT;
292 nr_pages = end - start;
293
294 /* Allocate bio integrity payload and integrity vectors */
295 bip = bio_integrity_alloc(bio, GFP_NOIO, nr_pages);
296 if (unlikely(bip == NULL)) {
297 printk(KERN_ERR "could not allocate data integrity bioset\n");
298 kfree(buf);
299 return -EIO;
300 }
301
Martin K. Petersenb1f0138852014-09-26 19:20:04 -0400302 bip->bip_flags |= BIP_BLOCK_INTEGRITY;
Kent Overstreetd57a5f72013-11-23 17:20:16 -0800303 bip->bip_iter.bi_size = len;
Martin K. Petersen18593082014-09-26 19:20:01 -0400304 bip_set_seed(bip, bio->bi_iter.bi_sector);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200305
Martin K. Petersenaae7df52014-09-26 19:20:05 -0400306 if (bi->flags & BLK_INTEGRITY_IP_CHECKSUM)
307 bip->bip_flags |= BIP_IP_CHECKSUM;
308
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200309 /* Map it */
310 offset = offset_in_page(buf);
311 for (i = 0 ; i < nr_pages ; i++) {
312 int ret;
313 bytes = PAGE_SIZE - offset;
314
315 if (len <= 0)
316 break;
317
318 if (bytes > len)
319 bytes = len;
320
321 ret = bio_integrity_add_page(bio, virt_to_page(buf),
322 bytes, offset);
323
324 if (ret == 0)
325 return 0;
326
327 if (ret < bytes)
328 break;
329
330 buf += bytes;
331 len -= bytes;
332 offset = 0;
333 }
334
335 /* Install custom I/O completion handler if read verify is enabled */
336 if (bio_data_dir(bio) == READ) {
337 bip->bip_end_io = bio->bi_end_io;
338 bio->bi_end_io = bio_integrity_endio;
339 }
340
341 /* Auto-generate integrity metadata if this is a write */
342 if (bio_data_dir(bio) == WRITE)
Martin K. Petersen18593082014-09-26 19:20:01 -0400343 bio_integrity_process(bio, bi->generate_fn);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200344
345 return 0;
346}
347EXPORT_SYMBOL(bio_integrity_prep);
348
349/**
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200350 * bio_integrity_verify_fn - Integrity I/O completion worker
351 * @work: Work struct stored in bio to be verified
352 *
353 * Description: This workqueue function is called to complete a READ
354 * request. The function verifies the transferred integrity metadata
355 * and then calls the original bio end_io function.
356 */
357static void bio_integrity_verify_fn(struct work_struct *work)
358{
Jens Axboeb9846792008-06-17 19:05:48 +0200359 struct bio_integrity_payload *bip =
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200360 container_of(work, struct bio_integrity_payload, bip_work);
361 struct bio *bio = bip->bip_bio;
Martin K. Petersen18593082014-09-26 19:20:01 -0400362 struct blk_integrity *bi = bdev_get_integrity(bio->bi_bdev);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200363
Christoph Hellwig4246a0b2015-07-20 15:29:37 +0200364 bio->bi_error = bio_integrity_process(bio, bi->verify_fn);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200365
366 /* Restore original bio completion handler */
367 bio->bi_end_io = bip->bip_end_io;
Christoph Hellwig4246a0b2015-07-20 15:29:37 +0200368 bio_endio(bio);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200369}
370
371/**
372 * bio_integrity_endio - Integrity I/O completion function
373 * @bio: Protected bio
374 * @error: Pointer to errno
375 *
376 * Description: Completion for integrity I/O
377 *
378 * Normally I/O completion is done in interrupt context. However,
379 * verifying I/O integrity is a time-consuming task which must be run
380 * in process context. This function postpones completion
381 * accordingly.
382 */
Christoph Hellwig4246a0b2015-07-20 15:29:37 +0200383void bio_integrity_endio(struct bio *bio)
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200384{
Martin K. Petersen180b2f92014-09-26 19:19:56 -0400385 struct bio_integrity_payload *bip = bio_integrity(bio);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200386
387 BUG_ON(bip->bip_bio != bio);
388
Martin K. Petersen7b24fc42009-01-04 02:43:38 -0500389 /* In case of an I/O error there is no point in verifying the
390 * integrity metadata. Restore original bio end_io handler
391 * and run it.
392 */
Christoph Hellwig4246a0b2015-07-20 15:29:37 +0200393 if (bio->bi_error) {
Martin K. Petersen7b24fc42009-01-04 02:43:38 -0500394 bio->bi_end_io = bip->bip_end_io;
Christoph Hellwig4246a0b2015-07-20 15:29:37 +0200395 bio_endio(bio);
Martin K. Petersen7b24fc42009-01-04 02:43:38 -0500396
397 return;
398 }
399
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200400 INIT_WORK(&bip->bip_work, bio_integrity_verify_fn);
401 queue_work(kintegrityd_wq, &bip->bip_work);
402}
403EXPORT_SYMBOL(bio_integrity_endio);
404
405/**
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200406 * bio_integrity_advance - Advance integrity vector
407 * @bio: bio whose integrity vector to update
408 * @bytes_done: number of data bytes that have been completed
409 *
410 * Description: This function calculates how many integrity bytes the
411 * number of completed data bytes correspond to and advances the
412 * integrity vector accordingly.
413 */
414void bio_integrity_advance(struct bio *bio, unsigned int bytes_done)
415{
Martin K. Petersen180b2f92014-09-26 19:19:56 -0400416 struct bio_integrity_payload *bip = bio_integrity(bio);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200417 struct blk_integrity *bi = bdev_get_integrity(bio->bi_bdev);
Kent Overstreetd57a5f72013-11-23 17:20:16 -0800418 unsigned bytes = bio_integrity_bytes(bi, bytes_done >> 9);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200419
Kent Overstreetd57a5f72013-11-23 17:20:16 -0800420 bvec_iter_advance(bip->bip_vec, &bip->bip_iter, bytes);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200421}
422EXPORT_SYMBOL(bio_integrity_advance);
423
424/**
425 * bio_integrity_trim - Trim integrity vector
426 * @bio: bio whose integrity vector to update
427 * @offset: offset to first data sector
428 * @sectors: number of data sectors
429 *
430 * Description: Used to trim the integrity vector in a cloned bio.
431 * The ivec will be advanced corresponding to 'offset' data sectors
432 * and the length will be truncated corresponding to 'len' data
433 * sectors.
434 */
Jens Axboeb9846792008-06-17 19:05:48 +0200435void bio_integrity_trim(struct bio *bio, unsigned int offset,
436 unsigned int sectors)
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200437{
Martin K. Petersen180b2f92014-09-26 19:19:56 -0400438 struct bio_integrity_payload *bip = bio_integrity(bio);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200439 struct blk_integrity *bi = bdev_get_integrity(bio->bi_bdev);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200440
Kent Overstreetd57a5f72013-11-23 17:20:16 -0800441 bio_integrity_advance(bio, offset << 9);
442 bip->bip_iter.bi_size = bio_integrity_bytes(bi, sectors);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200443}
444EXPORT_SYMBOL(bio_integrity_trim);
445
446/**
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200447 * bio_integrity_clone - Callback for cloning bios with integrity metadata
448 * @bio: New bio
449 * @bio_src: Original bio
un'ichi Nomura87092692009-03-09 10:40:52 +0100450 * @gfp_mask: Memory allocation mask
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200451 *
452 * Description: Called to allocate a bip when cloning a bio
453 */
Martin K. Petersen7878cba2009-06-26 15:37:49 +0200454int bio_integrity_clone(struct bio *bio, struct bio *bio_src,
Kent Overstreet1e2a410f2012-09-06 15:34:56 -0700455 gfp_t gfp_mask)
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200456{
Martin K. Petersen180b2f92014-09-26 19:19:56 -0400457 struct bio_integrity_payload *bip_src = bio_integrity(bio_src);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200458 struct bio_integrity_payload *bip;
459
460 BUG_ON(bip_src == NULL);
461
Kent Overstreet1e2a410f2012-09-06 15:34:56 -0700462 bip = bio_integrity_alloc(bio, gfp_mask, bip_src->bip_vcnt);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200463
464 if (bip == NULL)
465 return -EIO;
466
467 memcpy(bip->bip_vec, bip_src->bip_vec,
468 bip_src->bip_vcnt * sizeof(struct bio_vec));
469
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200470 bip->bip_vcnt = bip_src->bip_vcnt;
Kent Overstreetd57a5f72013-11-23 17:20:16 -0800471 bip->bip_iter = bip_src->bip_iter;
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200472
473 return 0;
474}
475EXPORT_SYMBOL(bio_integrity_clone);
476
Martin K. Petersen7878cba2009-06-26 15:37:49 +0200477int bioset_integrity_create(struct bio_set *bs, int pool_size)
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200478{
Martin K. Petersena91a2782011-03-17 11:11:05 +0100479 if (bs->bio_integrity_pool)
480 return 0;
481
Kent Overstreet9f060e22012-10-12 15:29:33 -0700482 bs->bio_integrity_pool = mempool_create_slab_pool(pool_size, bip_slab);
Martin K. Petersen7878cba2009-06-26 15:37:49 +0200483 if (!bs->bio_integrity_pool)
484 return -1;
Martin K. Petersen6d2a78e2009-03-10 08:27:39 +0100485
Fabian Fredericka6c39cb4f2014-04-22 15:09:05 -0600486 bs->bvec_integrity_pool = biovec_create_pool(pool_size);
Gu Zhengbc5c8f02013-09-11 14:23:21 -0700487 if (!bs->bvec_integrity_pool) {
488 mempool_destroy(bs->bio_integrity_pool);
489 return -1;
490 }
491
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200492 return 0;
493}
Martin K. Petersen7878cba2009-06-26 15:37:49 +0200494EXPORT_SYMBOL(bioset_integrity_create);
495
496void bioset_integrity_free(struct bio_set *bs)
497{
498 if (bs->bio_integrity_pool)
499 mempool_destroy(bs->bio_integrity_pool);
Kent Overstreet9f060e22012-10-12 15:29:33 -0700500
501 if (bs->bvec_integrity_pool)
Bjorn Helgaasadbe6992013-05-29 16:29:55 -0600502 mempool_destroy(bs->bvec_integrity_pool);
Martin K. Petersen7878cba2009-06-26 15:37:49 +0200503}
504EXPORT_SYMBOL(bioset_integrity_free);
505
506void __init bio_integrity_init(void)
507{
Tejun Heoa6e8dc42011-01-03 15:01:48 +0100508 /*
509 * kintegrityd won't block much but may burn a lot of CPU cycles.
510 * Make it highpri CPU intensive wq with max concurrency of 1.
511 */
512 kintegrityd_wq = alloc_workqueue("kintegrityd", WQ_MEM_RECLAIM |
513 WQ_HIGHPRI | WQ_CPU_INTENSIVE, 1);
Martin K. Petersen7878cba2009-06-26 15:37:49 +0200514 if (!kintegrityd_wq)
515 panic("Failed to create kintegrityd\n");
516
Kent Overstreet9f060e22012-10-12 15:29:33 -0700517 bip_slab = kmem_cache_create("bio_integrity_payload",
518 sizeof(struct bio_integrity_payload) +
519 sizeof(struct bio_vec) * BIP_INLINE_VECS,
520 0, SLAB_HWCACHE_ALIGN|SLAB_PANIC, NULL);
Martin K. Petersen7878cba2009-06-26 15:37:49 +0200521}