blob: 63f72f00c72eef45640d68fad4579fca271235ed [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>
Bart Van Assche1179a5a2016-06-14 17:03:45 +020029#include "blk.h"
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +020030
Kent Overstreet9f060e22012-10-12 15:29:33 -070031#define BIP_INLINE_VECS 4
Martin K. Petersen7878cba2009-06-26 15:37:49 +020032
Kent Overstreet9f060e22012-10-12 15:29:33 -070033static struct kmem_cache *bip_slab;
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +020034static struct workqueue_struct *kintegrityd_wq;
35
Dan Williams5a48fc12015-10-21 13:20:23 -040036void blk_flush_integrity(void)
37{
38 flush_workqueue(kintegrityd_wq);
39}
40
Martin K. Petersen7878cba2009-06-26 15:37:49 +020041/**
Kent Overstreet1e2a410f2012-09-06 15:34:56 -070042 * bio_integrity_alloc - Allocate integrity payload and attach it to bio
Martin K. Petersen7878cba2009-06-26 15:37:49 +020043 * @bio: bio to attach integrity metadata to
44 * @gfp_mask: Memory allocation mask
45 * @nr_vecs: Number of integrity metadata scatter-gather elements
Martin K. Petersen7878cba2009-06-26 15:37:49 +020046 *
47 * Description: This function prepares a bio for attaching integrity
48 * metadata. nr_vecs specifies the maximum number of pages containing
49 * integrity metadata that can be attached.
50 */
Kent Overstreet1e2a410f2012-09-06 15:34:56 -070051struct bio_integrity_payload *bio_integrity_alloc(struct bio *bio,
52 gfp_t gfp_mask,
53 unsigned int nr_vecs)
Martin K. Petersen7878cba2009-06-26 15:37:49 +020054{
55 struct bio_integrity_payload *bip;
Kent Overstreet1e2a410f2012-09-06 15:34:56 -070056 struct bio_set *bs = bio->bi_pool;
Kent Overstreet9f060e22012-10-12 15:29:33 -070057 unsigned inline_vecs;
Kent Overstreet1e2a410f2012-09-06 15:34:56 -070058
Mike Snitzerbb8bd382015-07-01 12:57:40 -040059 if (!bs || !bs->bio_integrity_pool) {
Kent Overstreet9f060e22012-10-12 15:29:33 -070060 bip = kmalloc(sizeof(struct bio_integrity_payload) +
61 sizeof(struct bio_vec) * nr_vecs, gfp_mask);
62 inline_vecs = nr_vecs;
63 } else {
Martin K. Petersen7878cba2009-06-26 15:37:49 +020064 bip = mempool_alloc(bs->bio_integrity_pool, gfp_mask);
Kent Overstreet9f060e22012-10-12 15:29:33 -070065 inline_vecs = BIP_INLINE_VECS;
Martin K. Petersen7878cba2009-06-26 15:37:49 +020066 }
67
Kent Overstreet9f060e22012-10-12 15:29:33 -070068 if (unlikely(!bip))
Keith Busch06c1e392015-12-03 09:32:21 -070069 return ERR_PTR(-ENOMEM);
Kent Overstreet9f060e22012-10-12 15:29:33 -070070
Martin K. Petersen7878cba2009-06-26 15:37:49 +020071 memset(bip, 0, sizeof(*bip));
72
Kent Overstreet9f060e22012-10-12 15:29:33 -070073 if (nr_vecs > inline_vecs) {
Christoph Hellwiged996a52016-07-19 11:28:42 +020074 unsigned long idx = 0;
75
Kent Overstreet9f060e22012-10-12 15:29:33 -070076 bip->bip_vec = bvec_alloc(gfp_mask, nr_vecs, &idx,
77 bs->bvec_integrity_pool);
78 if (!bip->bip_vec)
79 goto err;
Gu Zhengcbcd10542014-07-01 10:36:47 -060080 bip->bip_max_vcnt = bvec_nr_vecs(idx);
Christoph Hellwiged996a52016-07-19 11:28:42 +020081 bip->bip_slab = idx;
Kent Overstreet9f060e22012-10-12 15:29:33 -070082 } else {
83 bip->bip_vec = bip->bip_inline_vecs;
Gu Zhengcbcd10542014-07-01 10:36:47 -060084 bip->bip_max_vcnt = inline_vecs;
Kent Overstreet9f060e22012-10-12 15:29:33 -070085 }
86
Martin K. Petersen7878cba2009-06-26 15:37:49 +020087 bip->bip_bio = bio;
88 bio->bi_integrity = bip;
Jens Axboe1eff9d32016-08-05 15:35:16 -060089 bio->bi_opf |= REQ_INTEGRITY;
Martin K. Petersen7878cba2009-06-26 15:37:49 +020090
91 return bip;
Kent Overstreet9f060e22012-10-12 15:29:33 -070092err:
93 mempool_free(bip, bs->bio_integrity_pool);
Keith Busch06c1e392015-12-03 09:32:21 -070094 return ERR_PTR(-ENOMEM);
Martin K. Petersen7878cba2009-06-26 15:37:49 +020095}
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +020096EXPORT_SYMBOL(bio_integrity_alloc);
97
98/**
99 * bio_integrity_free - Free bio integrity payload
100 * @bio: bio containing bip to be freed
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200101 *
102 * Description: Used to free the integrity portion of a bio. Usually
103 * called from bio_free().
104 */
Kent Overstreet1e2a410f2012-09-06 15:34:56 -0700105void bio_integrity_free(struct bio *bio)
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200106{
Martin K. Petersen180b2f92014-09-26 19:19:56 -0400107 struct bio_integrity_payload *bip = bio_integrity(bio);
Kent Overstreet1e2a410f2012-09-06 15:34:56 -0700108 struct bio_set *bs = bio->bi_pool;
109
Martin K. Petersenb1f0138852014-09-26 19:20:04 -0400110 if (bip->bip_flags & BIP_BLOCK_INTEGRITY)
Martin K. Petersen5f9378f2014-09-26 19:19:58 -0400111 kfree(page_address(bip->bip_vec->bv_page) +
112 bip->bip_vec->bv_offset);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200113
Mike Snitzerbb8bd382015-07-01 12:57:40 -0400114 if (bs && bs->bio_integrity_pool) {
Christoph Hellwiged996a52016-07-19 11:28:42 +0200115 bvec_free(bs->bvec_integrity_pool, bip->bip_vec, bip->bip_slab);
Kent Overstreet9f060e22012-10-12 15:29:33 -0700116
Martin K. Petersen7878cba2009-06-26 15:37:49 +0200117 mempool_free(bip, bs->bio_integrity_pool);
Kent Overstreet9f060e22012-10-12 15:29:33 -0700118 } else {
119 kfree(bip);
120 }
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200121
122 bio->bi_integrity = NULL;
123}
124EXPORT_SYMBOL(bio_integrity_free);
125
126/**
127 * bio_integrity_add_page - Attach integrity metadata
128 * @bio: bio to update
129 * @page: page containing integrity metadata
130 * @len: number of bytes of integrity metadata in page
131 * @offset: start offset within page
132 *
133 * Description: Attach a page containing integrity metadata to bio.
134 */
135int bio_integrity_add_page(struct bio *bio, struct page *page,
136 unsigned int len, unsigned int offset)
137{
Martin K. Petersen180b2f92014-09-26 19:19:56 -0400138 struct bio_integrity_payload *bip = bio_integrity(bio);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200139 struct bio_vec *iv;
140
Gu Zhengcbcd10542014-07-01 10:36:47 -0600141 if (bip->bip_vcnt >= bip->bip_max_vcnt) {
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200142 printk(KERN_ERR "%s: bip_vec full\n", __func__);
143 return 0;
144 }
145
Kent Overstreetd57a5f72013-11-23 17:20:16 -0800146 iv = bip->bip_vec + bip->bip_vcnt;
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200147
Sagi Grimberg87a816d2015-09-08 09:33:35 -0600148 if (bip->bip_vcnt &&
149 bvec_gap_to_prev(bdev_get_queue(bio->bi_bdev),
150 &bip->bip_vec[bip->bip_vcnt - 1], offset))
151 return 0;
152
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200153 iv->bv_page = page;
154 iv->bv_len = len;
155 iv->bv_offset = offset;
156 bip->bip_vcnt++;
157
158 return len;
159}
160EXPORT_SYMBOL(bio_integrity_add_page);
161
162/**
163 * bio_integrity_enabled - Check whether integrity can be passed
164 * @bio: bio to check
165 *
166 * Description: Determines whether bio_integrity_prep() can be called
167 * on this bio or not. bio data direction and target device must be
168 * set prior to calling. The functions honors the write_generate and
169 * read_verify flags in sysfs.
170 */
Martin K. Petersene7258c12014-09-26 19:19:55 -0400171bool bio_integrity_enabled(struct bio *bio)
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200172{
Martin K. Petersene7258c12014-09-26 19:19:55 -0400173 struct blk_integrity *bi = bdev_get_integrity(bio->bi_bdev);
174
Martin K. Petersene69f18f2014-04-08 22:59:31 -0400175 if (!bio_is_rw(bio))
Martin K. Petersene7258c12014-09-26 19:19:55 -0400176 return false;
Martin K. Petersene69f18f2014-04-08 22:59:31 -0400177
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200178 /* Already protected? */
179 if (bio_integrity(bio))
Martin K. Petersene7258c12014-09-26 19:19:55 -0400180 return false;
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200181
Martin K. Petersene7258c12014-09-26 19:19:55 -0400182 if (bi == NULL)
183 return false;
184
Martin K. Petersen0f8087e2015-10-21 13:19:33 -0400185 if (bio_data_dir(bio) == READ && bi->profile->verify_fn != NULL &&
Martin K. Petersen8288f492014-09-26 19:20:02 -0400186 (bi->flags & BLK_INTEGRITY_VERIFY))
Martin K. Petersene7258c12014-09-26 19:19:55 -0400187 return true;
188
Martin K. Petersen0f8087e2015-10-21 13:19:33 -0400189 if (bio_data_dir(bio) == WRITE && bi->profile->generate_fn != NULL &&
Martin K. Petersen8288f492014-09-26 19:20:02 -0400190 (bi->flags & BLK_INTEGRITY_GENERATE))
Martin K. Petersene7258c12014-09-26 19:19:55 -0400191 return true;
192
193 return false;
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200194}
195EXPORT_SYMBOL(bio_integrity_enabled);
196
197/**
Martin K. Petersen3be91c42014-09-26 19:19:59 -0400198 * bio_integrity_intervals - Return number of integrity intervals for a bio
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200199 * @bi: blk_integrity profile for device
Martin K. Petersen3be91c42014-09-26 19:19:59 -0400200 * @sectors: Size of the bio in 512-byte sectors
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200201 *
202 * Description: The block layer calculates everything in 512 byte
Martin K. Petersen3be91c42014-09-26 19:19:59 -0400203 * sectors but integrity metadata is done in terms of the data integrity
204 * interval size of the storage device. Convert the block layer sectors
205 * to the appropriate number of integrity intervals.
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200206 */
Martin K. Petersen3be91c42014-09-26 19:19:59 -0400207static inline unsigned int bio_integrity_intervals(struct blk_integrity *bi,
208 unsigned int sectors)
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200209{
Martin K. Petersena48f0412015-10-21 13:19:38 -0400210 return sectors >> (bi->interval_exp - 9);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200211}
212
Kent Overstreetd57a5f72013-11-23 17:20:16 -0800213static inline unsigned int bio_integrity_bytes(struct blk_integrity *bi,
214 unsigned int sectors)
215{
Martin K. Petersen3be91c42014-09-26 19:19:59 -0400216 return bio_integrity_intervals(bi, sectors) * bi->tuple_size;
Kent Overstreetd57a5f72013-11-23 17:20:16 -0800217}
218
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200219/**
Martin K. Petersen18593082014-09-26 19:20:01 -0400220 * bio_integrity_process - Process integrity metadata for a bio
Gu Zhengbf36f9c2014-02-21 18:10:59 +0800221 * @bio: bio to generate/verify integrity metadata for
Martin K. Petersen18593082014-09-26 19:20:01 -0400222 * @proc_fn: Pointer to the relevant processing function
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200223 */
Martin K. Petersen18593082014-09-26 19:20:01 -0400224static int bio_integrity_process(struct bio *bio,
225 integrity_processing_fn *proc_fn)
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200226{
227 struct blk_integrity *bi = bdev_get_integrity(bio->bi_bdev);
Martin K. Petersen18593082014-09-26 19:20:01 -0400228 struct blk_integrity_iter iter;
Darrick J. Wong594416a2014-11-25 17:40:25 -0800229 struct bvec_iter bviter;
230 struct bio_vec bv;
Martin K. Petersen5f9378f2014-09-26 19:19:58 -0400231 struct bio_integrity_payload *bip = bio_integrity(bio);
Darrick J. Wong594416a2014-11-25 17:40:25 -0800232 unsigned int ret = 0;
Martin K. Petersen5f9378f2014-09-26 19:19:58 -0400233 void *prot_buf = page_address(bip->bip_vec->bv_page) +
234 bip->bip_vec->bv_offset;
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200235
Martin K. Petersen18593082014-09-26 19:20:01 -0400236 iter.disk_name = bio->bi_bdev->bd_disk->disk_name;
Martin K. Petersena48f0412015-10-21 13:19:38 -0400237 iter.interval = 1 << bi->interval_exp;
Martin K. Petersen18593082014-09-26 19:20:01 -0400238 iter.seed = bip_get_seed(bip);
239 iter.prot_buf = prot_buf;
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200240
Darrick J. Wong594416a2014-11-25 17:40:25 -0800241 bio_for_each_segment(bv, bio, bviter) {
242 void *kaddr = kmap_atomic(bv.bv_page);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200243
Darrick J. Wong594416a2014-11-25 17:40:25 -0800244 iter.data_buf = kaddr + bv.bv_offset;
245 iter.data_size = bv.bv_len;
Martin K. Petersen18593082014-09-26 19:20:01 -0400246
247 ret = proc_fn(&iter);
248 if (ret) {
249 kunmap_atomic(kaddr);
250 return ret;
Gu Zhengbf36f9c2014-02-21 18:10:59 +0800251 }
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200252
Cong Wange8e3c3d2011-11-25 23:14:27 +0800253 kunmap_atomic(kaddr);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200254 }
Gu Zhengbf36f9c2014-02-21 18:10:59 +0800255 return ret;
256}
257
258/**
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200259 * bio_integrity_prep - Prepare bio for integrity I/O
260 * @bio: bio to prepare
261 *
262 * Description: Allocates a buffer for integrity metadata, maps the
263 * pages and attaches them to a bio. The bio must have data
264 * direction, target device and start sector set priot to calling. In
265 * the WRITE case, integrity metadata will be generated using the
266 * block device's integrity function. In the READ case, the buffer
267 * will be prepared for DMA and a suitable end_io handler set up.
268 */
269int bio_integrity_prep(struct bio *bio)
270{
271 struct bio_integrity_payload *bip;
272 struct blk_integrity *bi;
273 struct request_queue *q;
274 void *buf;
275 unsigned long start, end;
276 unsigned int len, nr_pages;
277 unsigned int bytes, offset, i;
Martin K. Petersen3be91c42014-09-26 19:19:59 -0400278 unsigned int intervals;
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200279
280 bi = bdev_get_integrity(bio->bi_bdev);
281 q = bdev_get_queue(bio->bi_bdev);
282 BUG_ON(bi == NULL);
283 BUG_ON(bio_integrity(bio));
284
Martin K. Petersen3be91c42014-09-26 19:19:59 -0400285 intervals = bio_integrity_intervals(bi, bio_sectors(bio));
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200286
287 /* Allocate kernel buffer for protection data */
Martin K. Petersen3be91c42014-09-26 19:19:59 -0400288 len = intervals * bi->tuple_size;
David Rientjes72f46502010-08-23 13:35:09 +0200289 buf = kmalloc(len, GFP_NOIO | q->bounce_gfp);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200290 if (unlikely(buf == NULL)) {
291 printk(KERN_ERR "could not allocate integrity buffer\n");
Andrew Morton220eb7f2010-08-23 13:36:20 +0200292 return -ENOMEM;
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200293 }
294
295 end = (((unsigned long) buf) + len + PAGE_SIZE - 1) >> PAGE_SHIFT;
296 start = ((unsigned long) buf) >> PAGE_SHIFT;
297 nr_pages = end - start;
298
299 /* Allocate bio integrity payload and integrity vectors */
300 bip = bio_integrity_alloc(bio, GFP_NOIO, nr_pages);
Dan Carpenter7b6c0f82015-12-09 13:21:23 +0300301 if (IS_ERR(bip)) {
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200302 printk(KERN_ERR "could not allocate data integrity bioset\n");
303 kfree(buf);
Dan Carpenter7b6c0f82015-12-09 13:21:23 +0300304 return PTR_ERR(bip);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200305 }
306
Martin K. Petersenb1f0138852014-09-26 19:20:04 -0400307 bip->bip_flags |= BIP_BLOCK_INTEGRITY;
Kent Overstreetd57a5f72013-11-23 17:20:16 -0800308 bip->bip_iter.bi_size = len;
Martin K. Petersen18593082014-09-26 19:20:01 -0400309 bip_set_seed(bip, bio->bi_iter.bi_sector);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200310
Martin K. Petersenaae7df52014-09-26 19:20:05 -0400311 if (bi->flags & BLK_INTEGRITY_IP_CHECKSUM)
312 bip->bip_flags |= BIP_IP_CHECKSUM;
313
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200314 /* Map it */
315 offset = offset_in_page(buf);
316 for (i = 0 ; i < nr_pages ; i++) {
317 int ret;
318 bytes = PAGE_SIZE - offset;
319
320 if (len <= 0)
321 break;
322
323 if (bytes > len)
324 bytes = len;
325
326 ret = bio_integrity_add_page(bio, virt_to_page(buf),
327 bytes, offset);
328
329 if (ret == 0)
330 return 0;
331
332 if (ret < bytes)
333 break;
334
335 buf += bytes;
336 len -= bytes;
337 offset = 0;
338 }
339
340 /* Install custom I/O completion handler if read verify is enabled */
341 if (bio_data_dir(bio) == READ) {
342 bip->bip_end_io = bio->bi_end_io;
343 bio->bi_end_io = bio_integrity_endio;
344 }
345
346 /* Auto-generate integrity metadata if this is a write */
347 if (bio_data_dir(bio) == WRITE)
Martin K. Petersen0f8087e2015-10-21 13:19:33 -0400348 bio_integrity_process(bio, bi->profile->generate_fn);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200349
350 return 0;
351}
352EXPORT_SYMBOL(bio_integrity_prep);
353
354/**
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200355 * bio_integrity_verify_fn - Integrity I/O completion worker
356 * @work: Work struct stored in bio to be verified
357 *
358 * Description: This workqueue function is called to complete a READ
359 * request. The function verifies the transferred integrity metadata
360 * and then calls the original bio end_io function.
361 */
362static void bio_integrity_verify_fn(struct work_struct *work)
363{
Jens Axboeb9846792008-06-17 19:05:48 +0200364 struct bio_integrity_payload *bip =
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200365 container_of(work, struct bio_integrity_payload, bip_work);
366 struct bio *bio = bip->bip_bio;
Martin K. Petersen18593082014-09-26 19:20:01 -0400367 struct blk_integrity *bi = bdev_get_integrity(bio->bi_bdev);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200368
Martin K. Petersen0f8087e2015-10-21 13:19:33 -0400369 bio->bi_error = bio_integrity_process(bio, bi->profile->verify_fn);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200370
371 /* Restore original bio completion handler */
372 bio->bi_end_io = bip->bip_end_io;
Christoph Hellwig4246a0b2015-07-20 15:29:37 +0200373 bio_endio(bio);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200374}
375
376/**
377 * bio_integrity_endio - Integrity I/O completion function
378 * @bio: Protected bio
379 * @error: Pointer to errno
380 *
381 * Description: Completion for integrity I/O
382 *
383 * Normally I/O completion is done in interrupt context. However,
384 * verifying I/O integrity is a time-consuming task which must be run
385 * in process context. This function postpones completion
386 * accordingly.
387 */
Christoph Hellwig4246a0b2015-07-20 15:29:37 +0200388void bio_integrity_endio(struct bio *bio)
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200389{
Martin K. Petersen180b2f92014-09-26 19:19:56 -0400390 struct bio_integrity_payload *bip = bio_integrity(bio);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200391
392 BUG_ON(bip->bip_bio != bio);
393
Martin K. Petersen7b24fc42009-01-04 02:43:38 -0500394 /* In case of an I/O error there is no point in verifying the
395 * integrity metadata. Restore original bio end_io handler
396 * and run it.
397 */
Christoph Hellwig4246a0b2015-07-20 15:29:37 +0200398 if (bio->bi_error) {
Martin K. Petersen7b24fc42009-01-04 02:43:38 -0500399 bio->bi_end_io = bip->bip_end_io;
Christoph Hellwig4246a0b2015-07-20 15:29:37 +0200400 bio_endio(bio);
Martin K. Petersen7b24fc42009-01-04 02:43:38 -0500401
402 return;
403 }
404
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200405 INIT_WORK(&bip->bip_work, bio_integrity_verify_fn);
406 queue_work(kintegrityd_wq, &bip->bip_work);
407}
408EXPORT_SYMBOL(bio_integrity_endio);
409
410/**
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200411 * bio_integrity_advance - Advance integrity vector
412 * @bio: bio whose integrity vector to update
413 * @bytes_done: number of data bytes that have been completed
414 *
415 * Description: This function calculates how many integrity bytes the
416 * number of completed data bytes correspond to and advances the
417 * integrity vector accordingly.
418 */
419void bio_integrity_advance(struct bio *bio, unsigned int bytes_done)
420{
Martin K. Petersen180b2f92014-09-26 19:19:56 -0400421 struct bio_integrity_payload *bip = bio_integrity(bio);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200422 struct blk_integrity *bi = bdev_get_integrity(bio->bi_bdev);
Kent Overstreetd57a5f72013-11-23 17:20:16 -0800423 unsigned bytes = bio_integrity_bytes(bi, bytes_done >> 9);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200424
Kent Overstreetd57a5f72013-11-23 17:20:16 -0800425 bvec_iter_advance(bip->bip_vec, &bip->bip_iter, bytes);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200426}
427EXPORT_SYMBOL(bio_integrity_advance);
428
429/**
430 * bio_integrity_trim - Trim integrity vector
431 * @bio: bio whose integrity vector to update
432 * @offset: offset to first data sector
433 * @sectors: number of data sectors
434 *
435 * Description: Used to trim the integrity vector in a cloned bio.
436 * The ivec will be advanced corresponding to 'offset' data sectors
437 * and the length will be truncated corresponding to 'len' data
438 * sectors.
439 */
Jens Axboeb9846792008-06-17 19:05:48 +0200440void bio_integrity_trim(struct bio *bio, unsigned int offset,
441 unsigned int sectors)
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200442{
Martin K. Petersen180b2f92014-09-26 19:19:56 -0400443 struct bio_integrity_payload *bip = bio_integrity(bio);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200444 struct blk_integrity *bi = bdev_get_integrity(bio->bi_bdev);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200445
Kent Overstreetd57a5f72013-11-23 17:20:16 -0800446 bio_integrity_advance(bio, offset << 9);
447 bip->bip_iter.bi_size = bio_integrity_bytes(bi, sectors);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200448}
449EXPORT_SYMBOL(bio_integrity_trim);
450
451/**
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200452 * bio_integrity_clone - Callback for cloning bios with integrity metadata
453 * @bio: New bio
454 * @bio_src: Original bio
un'ichi Nomura87092692009-03-09 10:40:52 +0100455 * @gfp_mask: Memory allocation mask
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200456 *
457 * Description: Called to allocate a bip when cloning a bio
458 */
Martin K. Petersen7878cba2009-06-26 15:37:49 +0200459int bio_integrity_clone(struct bio *bio, struct bio *bio_src,
Kent Overstreet1e2a410f2012-09-06 15:34:56 -0700460 gfp_t gfp_mask)
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200461{
Martin K. Petersen180b2f92014-09-26 19:19:56 -0400462 struct bio_integrity_payload *bip_src = bio_integrity(bio_src);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200463 struct bio_integrity_payload *bip;
464
465 BUG_ON(bip_src == NULL);
466
Kent Overstreet1e2a410f2012-09-06 15:34:56 -0700467 bip = bio_integrity_alloc(bio, gfp_mask, bip_src->bip_vcnt);
Dan Carpenter7b6c0f82015-12-09 13:21:23 +0300468 if (IS_ERR(bip))
469 return PTR_ERR(bip);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200470
471 memcpy(bip->bip_vec, bip_src->bip_vec,
472 bip_src->bip_vcnt * sizeof(struct bio_vec));
473
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200474 bip->bip_vcnt = bip_src->bip_vcnt;
Kent Overstreetd57a5f72013-11-23 17:20:16 -0800475 bip->bip_iter = bip_src->bip_iter;
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200476
477 return 0;
478}
479EXPORT_SYMBOL(bio_integrity_clone);
480
Martin K. Petersen7878cba2009-06-26 15:37:49 +0200481int bioset_integrity_create(struct bio_set *bs, int pool_size)
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200482{
Martin K. Petersena91a2782011-03-17 11:11:05 +0100483 if (bs->bio_integrity_pool)
484 return 0;
485
Kent Overstreet9f060e22012-10-12 15:29:33 -0700486 bs->bio_integrity_pool = mempool_create_slab_pool(pool_size, bip_slab);
Martin K. Petersen7878cba2009-06-26 15:37:49 +0200487 if (!bs->bio_integrity_pool)
488 return -1;
Martin K. Petersen6d2a78e2009-03-10 08:27:39 +0100489
Fabian Fredericka6c39cb4f2014-04-22 15:09:05 -0600490 bs->bvec_integrity_pool = biovec_create_pool(pool_size);
Gu Zhengbc5c8f02013-09-11 14:23:21 -0700491 if (!bs->bvec_integrity_pool) {
492 mempool_destroy(bs->bio_integrity_pool);
493 return -1;
494 }
495
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200496 return 0;
497}
Martin K. Petersen7878cba2009-06-26 15:37:49 +0200498EXPORT_SYMBOL(bioset_integrity_create);
499
500void bioset_integrity_free(struct bio_set *bs)
501{
502 if (bs->bio_integrity_pool)
503 mempool_destroy(bs->bio_integrity_pool);
Kent Overstreet9f060e22012-10-12 15:29:33 -0700504
505 if (bs->bvec_integrity_pool)
Bjorn Helgaasadbe6992013-05-29 16:29:55 -0600506 mempool_destroy(bs->bvec_integrity_pool);
Martin K. Petersen7878cba2009-06-26 15:37:49 +0200507}
508EXPORT_SYMBOL(bioset_integrity_free);
509
510void __init bio_integrity_init(void)
511{
Tejun Heoa6e8dc42011-01-03 15:01:48 +0100512 /*
513 * kintegrityd won't block much but may burn a lot of CPU cycles.
514 * Make it highpri CPU intensive wq with max concurrency of 1.
515 */
516 kintegrityd_wq = alloc_workqueue("kintegrityd", WQ_MEM_RECLAIM |
517 WQ_HIGHPRI | WQ_CPU_INTENSIVE, 1);
Martin K. Petersen7878cba2009-06-26 15:37:49 +0200518 if (!kintegrityd_wq)
519 panic("Failed to create kintegrityd\n");
520
Kent Overstreet9f060e22012-10-12 15:29:33 -0700521 bip_slab = kmem_cache_create("bio_integrity_payload",
522 sizeof(struct bio_integrity_payload) +
523 sizeof(struct bio_vec) * BIP_INLINE_VECS,
524 0, SLAB_HWCACHE_ALIGN|SLAB_PANIC, NULL);
Martin K. Petersen7878cba2009-06-26 15:37:49 +0200525}