blob: b5009a896a7faa1dfc9fe4320181798cc42ccfa5 [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
Christoph Hellwigc4aebd02016-10-20 15:12:09 +0200175 if (bio_op(bio) != REQ_OP_READ && bio_op(bio) != REQ_OP_WRITE)
Martin K. Petersene7258c12014-09-26 19:19:55 -0400176 return false;
Martin K. Petersene69f18f2014-04-08 22:59:31 -0400177
Dmitry Monakhov3116a232017-05-10 19:20:44 +0400178 if (!bio_sectors(bio))
179 return false;
180
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200181 /* Already protected? */
182 if (bio_integrity(bio))
Martin K. Petersene7258c12014-09-26 19:19:55 -0400183 return false;
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200184
Martin K. Petersene7258c12014-09-26 19:19:55 -0400185 if (bi == NULL)
186 return false;
187
Martin K. Petersen0f8087e2015-10-21 13:19:33 -0400188 if (bio_data_dir(bio) == READ && bi->profile->verify_fn != NULL &&
Martin K. Petersen8288f492014-09-26 19:20:02 -0400189 (bi->flags & BLK_INTEGRITY_VERIFY))
Martin K. Petersene7258c12014-09-26 19:19:55 -0400190 return true;
191
Martin K. Petersen0f8087e2015-10-21 13:19:33 -0400192 if (bio_data_dir(bio) == WRITE && bi->profile->generate_fn != NULL &&
Martin K. Petersen8288f492014-09-26 19:20:02 -0400193 (bi->flags & BLK_INTEGRITY_GENERATE))
Martin K. Petersene7258c12014-09-26 19:19:55 -0400194 return true;
195
196 return false;
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200197}
198EXPORT_SYMBOL(bio_integrity_enabled);
199
200/**
Martin K. Petersen3be91c42014-09-26 19:19:59 -0400201 * bio_integrity_intervals - Return number of integrity intervals for a bio
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200202 * @bi: blk_integrity profile for device
Martin K. Petersen3be91c42014-09-26 19:19:59 -0400203 * @sectors: Size of the bio in 512-byte sectors
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200204 *
205 * Description: The block layer calculates everything in 512 byte
Martin K. Petersen3be91c42014-09-26 19:19:59 -0400206 * sectors but integrity metadata is done in terms of the data integrity
207 * interval size of the storage device. Convert the block layer sectors
208 * to the appropriate number of integrity intervals.
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200209 */
Martin K. Petersen3be91c42014-09-26 19:19:59 -0400210static inline unsigned int bio_integrity_intervals(struct blk_integrity *bi,
211 unsigned int sectors)
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200212{
Martin K. Petersena48f0412015-10-21 13:19:38 -0400213 return sectors >> (bi->interval_exp - 9);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200214}
215
Kent Overstreetd57a5f72013-11-23 17:20:16 -0800216static inline unsigned int bio_integrity_bytes(struct blk_integrity *bi,
217 unsigned int sectors)
218{
Martin K. Petersen3be91c42014-09-26 19:19:59 -0400219 return bio_integrity_intervals(bi, sectors) * bi->tuple_size;
Kent Overstreetd57a5f72013-11-23 17:20:16 -0800220}
221
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200222/**
Martin K. Petersen18593082014-09-26 19:20:01 -0400223 * bio_integrity_process - Process integrity metadata for a bio
Gu Zhengbf36f9c2014-02-21 18:10:59 +0800224 * @bio: bio to generate/verify integrity metadata for
Martin K. Petersen18593082014-09-26 19:20:01 -0400225 * @proc_fn: Pointer to the relevant processing function
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200226 */
Martin K. Petersen18593082014-09-26 19:20:01 -0400227static int bio_integrity_process(struct bio *bio,
228 integrity_processing_fn *proc_fn)
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200229{
230 struct blk_integrity *bi = bdev_get_integrity(bio->bi_bdev);
Martin K. Petersen18593082014-09-26 19:20:01 -0400231 struct blk_integrity_iter iter;
Darrick J. Wong594416a2014-11-25 17:40:25 -0800232 struct bvec_iter bviter;
233 struct bio_vec bv;
Martin K. Petersen5f9378f2014-09-26 19:19:58 -0400234 struct bio_integrity_payload *bip = bio_integrity(bio);
Darrick J. Wong594416a2014-11-25 17:40:25 -0800235 unsigned int ret = 0;
Martin K. Petersen5f9378f2014-09-26 19:19:58 -0400236 void *prot_buf = page_address(bip->bip_vec->bv_page) +
237 bip->bip_vec->bv_offset;
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200238
Martin K. Petersen18593082014-09-26 19:20:01 -0400239 iter.disk_name = bio->bi_bdev->bd_disk->disk_name;
Martin K. Petersena48f0412015-10-21 13:19:38 -0400240 iter.interval = 1 << bi->interval_exp;
Martin K. Petersen18593082014-09-26 19:20:01 -0400241 iter.seed = bip_get_seed(bip);
242 iter.prot_buf = prot_buf;
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200243
Darrick J. Wong594416a2014-11-25 17:40:25 -0800244 bio_for_each_segment(bv, bio, bviter) {
245 void *kaddr = kmap_atomic(bv.bv_page);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200246
Darrick J. Wong594416a2014-11-25 17:40:25 -0800247 iter.data_buf = kaddr + bv.bv_offset;
248 iter.data_size = bv.bv_len;
Martin K. Petersen18593082014-09-26 19:20:01 -0400249
250 ret = proc_fn(&iter);
251 if (ret) {
252 kunmap_atomic(kaddr);
253 return ret;
Gu Zhengbf36f9c2014-02-21 18:10:59 +0800254 }
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200255
Cong Wange8e3c3d2011-11-25 23:14:27 +0800256 kunmap_atomic(kaddr);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200257 }
Gu Zhengbf36f9c2014-02-21 18:10:59 +0800258 return ret;
259}
260
261/**
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200262 * bio_integrity_prep - Prepare bio for integrity I/O
263 * @bio: bio to prepare
264 *
265 * Description: Allocates a buffer for integrity metadata, maps the
266 * pages and attaches them to a bio. The bio must have data
267 * direction, target device and start sector set priot to calling. In
268 * the WRITE case, integrity metadata will be generated using the
269 * block device's integrity function. In the READ case, the buffer
270 * will be prepared for DMA and a suitable end_io handler set up.
271 */
272int bio_integrity_prep(struct bio *bio)
273{
274 struct bio_integrity_payload *bip;
275 struct blk_integrity *bi;
276 struct request_queue *q;
277 void *buf;
278 unsigned long start, end;
279 unsigned int len, nr_pages;
280 unsigned int bytes, offset, i;
Martin K. Petersen3be91c42014-09-26 19:19:59 -0400281 unsigned int intervals;
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200282
283 bi = bdev_get_integrity(bio->bi_bdev);
284 q = bdev_get_queue(bio->bi_bdev);
285 BUG_ON(bi == NULL);
286 BUG_ON(bio_integrity(bio));
287
Martin K. Petersen3be91c42014-09-26 19:19:59 -0400288 intervals = bio_integrity_intervals(bi, bio_sectors(bio));
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200289
290 /* Allocate kernel buffer for protection data */
Martin K. Petersen3be91c42014-09-26 19:19:59 -0400291 len = intervals * bi->tuple_size;
David Rientjes72f46502010-08-23 13:35:09 +0200292 buf = kmalloc(len, GFP_NOIO | q->bounce_gfp);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200293 if (unlikely(buf == NULL)) {
294 printk(KERN_ERR "could not allocate integrity buffer\n");
Andrew Morton220eb7f2010-08-23 13:36:20 +0200295 return -ENOMEM;
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200296 }
297
298 end = (((unsigned long) buf) + len + PAGE_SIZE - 1) >> PAGE_SHIFT;
299 start = ((unsigned long) buf) >> PAGE_SHIFT;
300 nr_pages = end - start;
301
302 /* Allocate bio integrity payload and integrity vectors */
303 bip = bio_integrity_alloc(bio, GFP_NOIO, nr_pages);
Dan Carpenter7b6c0f82015-12-09 13:21:23 +0300304 if (IS_ERR(bip)) {
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200305 printk(KERN_ERR "could not allocate data integrity bioset\n");
306 kfree(buf);
Dan Carpenter7b6c0f82015-12-09 13:21:23 +0300307 return PTR_ERR(bip);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200308 }
309
Martin K. Petersenb1f0138852014-09-26 19:20:04 -0400310 bip->bip_flags |= BIP_BLOCK_INTEGRITY;
Kent Overstreetd57a5f72013-11-23 17:20:16 -0800311 bip->bip_iter.bi_size = len;
Martin K. Petersen18593082014-09-26 19:20:01 -0400312 bip_set_seed(bip, bio->bi_iter.bi_sector);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200313
Martin K. Petersenaae7df52014-09-26 19:20:05 -0400314 if (bi->flags & BLK_INTEGRITY_IP_CHECKSUM)
315 bip->bip_flags |= BIP_IP_CHECKSUM;
316
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200317 /* Map it */
318 offset = offset_in_page(buf);
319 for (i = 0 ; i < nr_pages ; i++) {
320 int ret;
321 bytes = PAGE_SIZE - offset;
322
323 if (len <= 0)
324 break;
325
326 if (bytes > len)
327 bytes = len;
328
329 ret = bio_integrity_add_page(bio, virt_to_page(buf),
330 bytes, offset);
331
332 if (ret == 0)
333 return 0;
334
335 if (ret < bytes)
336 break;
337
338 buf += bytes;
339 len -= bytes;
340 offset = 0;
341 }
342
343 /* Install custom I/O completion handler if read verify is enabled */
344 if (bio_data_dir(bio) == READ) {
345 bip->bip_end_io = bio->bi_end_io;
346 bio->bi_end_io = bio_integrity_endio;
347 }
348
349 /* Auto-generate integrity metadata if this is a write */
350 if (bio_data_dir(bio) == WRITE)
Martin K. Petersen0f8087e2015-10-21 13:19:33 -0400351 bio_integrity_process(bio, bi->profile->generate_fn);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200352
353 return 0;
354}
355EXPORT_SYMBOL(bio_integrity_prep);
356
357/**
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200358 * bio_integrity_verify_fn - Integrity I/O completion worker
359 * @work: Work struct stored in bio to be verified
360 *
361 * Description: This workqueue function is called to complete a READ
362 * request. The function verifies the transferred integrity metadata
363 * and then calls the original bio end_io function.
364 */
365static void bio_integrity_verify_fn(struct work_struct *work)
366{
Jens Axboeb9846792008-06-17 19:05:48 +0200367 struct bio_integrity_payload *bip =
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200368 container_of(work, struct bio_integrity_payload, bip_work);
369 struct bio *bio = bip->bip_bio;
Martin K. Petersen18593082014-09-26 19:20:01 -0400370 struct blk_integrity *bi = bdev_get_integrity(bio->bi_bdev);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200371
Martin K. Petersen0f8087e2015-10-21 13:19:33 -0400372 bio->bi_error = bio_integrity_process(bio, bi->profile->verify_fn);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200373
374 /* Restore original bio completion handler */
375 bio->bi_end_io = bip->bip_end_io;
Christoph Hellwig4246a0b2015-07-20 15:29:37 +0200376 bio_endio(bio);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200377}
378
379/**
380 * bio_integrity_endio - Integrity I/O completion function
381 * @bio: Protected bio
382 * @error: Pointer to errno
383 *
384 * Description: Completion for integrity I/O
385 *
386 * Normally I/O completion is done in interrupt context. However,
387 * verifying I/O integrity is a time-consuming task which must be run
388 * in process context. This function postpones completion
389 * accordingly.
390 */
Christoph Hellwig4246a0b2015-07-20 15:29:37 +0200391void bio_integrity_endio(struct bio *bio)
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200392{
Martin K. Petersen180b2f92014-09-26 19:19:56 -0400393 struct bio_integrity_payload *bip = bio_integrity(bio);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200394
395 BUG_ON(bip->bip_bio != bio);
396
Martin K. Petersen7b24fc42009-01-04 02:43:38 -0500397 /* In case of an I/O error there is no point in verifying the
398 * integrity metadata. Restore original bio end_io handler
399 * and run it.
400 */
Christoph Hellwig4246a0b2015-07-20 15:29:37 +0200401 if (bio->bi_error) {
Martin K. Petersen7b24fc42009-01-04 02:43:38 -0500402 bio->bi_end_io = bip->bip_end_io;
Christoph Hellwig4246a0b2015-07-20 15:29:37 +0200403 bio_endio(bio);
Martin K. Petersen7b24fc42009-01-04 02:43:38 -0500404
405 return;
406 }
407
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200408 INIT_WORK(&bip->bip_work, bio_integrity_verify_fn);
409 queue_work(kintegrityd_wq, &bip->bip_work);
410}
411EXPORT_SYMBOL(bio_integrity_endio);
412
413/**
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200414 * bio_integrity_advance - Advance integrity vector
415 * @bio: bio whose integrity vector to update
416 * @bytes_done: number of data bytes that have been completed
417 *
418 * Description: This function calculates how many integrity bytes the
419 * number of completed data bytes correspond to and advances the
420 * integrity vector accordingly.
421 */
422void bio_integrity_advance(struct bio *bio, unsigned int bytes_done)
423{
Martin K. Petersen180b2f92014-09-26 19:19:56 -0400424 struct bio_integrity_payload *bip = bio_integrity(bio);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200425 struct blk_integrity *bi = bdev_get_integrity(bio->bi_bdev);
Kent Overstreetd57a5f72013-11-23 17:20:16 -0800426 unsigned bytes = bio_integrity_bytes(bi, bytes_done >> 9);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200427
Kent Overstreetd57a5f72013-11-23 17:20:16 -0800428 bvec_iter_advance(bip->bip_vec, &bip->bip_iter, bytes);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200429}
430EXPORT_SYMBOL(bio_integrity_advance);
431
432/**
433 * bio_integrity_trim - Trim integrity vector
434 * @bio: bio whose integrity vector to update
435 * @offset: offset to first data sector
436 * @sectors: number of data sectors
437 *
438 * Description: Used to trim the integrity vector in a cloned bio.
439 * The ivec will be advanced corresponding to 'offset' data sectors
440 * and the length will be truncated corresponding to 'len' data
441 * sectors.
442 */
Jens Axboeb9846792008-06-17 19:05:48 +0200443void bio_integrity_trim(struct bio *bio, unsigned int offset,
444 unsigned int sectors)
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200445{
Martin K. Petersen180b2f92014-09-26 19:19:56 -0400446 struct bio_integrity_payload *bip = bio_integrity(bio);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200447 struct blk_integrity *bi = bdev_get_integrity(bio->bi_bdev);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200448
Kent Overstreetd57a5f72013-11-23 17:20:16 -0800449 bio_integrity_advance(bio, offset << 9);
450 bip->bip_iter.bi_size = bio_integrity_bytes(bi, sectors);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200451}
452EXPORT_SYMBOL(bio_integrity_trim);
453
454/**
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200455 * bio_integrity_clone - Callback for cloning bios with integrity metadata
456 * @bio: New bio
457 * @bio_src: Original bio
un'ichi Nomura87092692009-03-09 10:40:52 +0100458 * @gfp_mask: Memory allocation mask
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200459 *
460 * Description: Called to allocate a bip when cloning a bio
461 */
Martin K. Petersen7878cba2009-06-26 15:37:49 +0200462int bio_integrity_clone(struct bio *bio, struct bio *bio_src,
Kent Overstreet1e2a410f2012-09-06 15:34:56 -0700463 gfp_t gfp_mask)
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200464{
Martin K. Petersen180b2f92014-09-26 19:19:56 -0400465 struct bio_integrity_payload *bip_src = bio_integrity(bio_src);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200466 struct bio_integrity_payload *bip;
467
468 BUG_ON(bip_src == NULL);
469
Kent Overstreet1e2a410f2012-09-06 15:34:56 -0700470 bip = bio_integrity_alloc(bio, gfp_mask, bip_src->bip_vcnt);
Dan Carpenter7b6c0f82015-12-09 13:21:23 +0300471 if (IS_ERR(bip))
472 return PTR_ERR(bip);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200473
474 memcpy(bip->bip_vec, bip_src->bip_vec,
475 bip_src->bip_vcnt * sizeof(struct bio_vec));
476
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200477 bip->bip_vcnt = bip_src->bip_vcnt;
Kent Overstreetd57a5f72013-11-23 17:20:16 -0800478 bip->bip_iter = bip_src->bip_iter;
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200479
480 return 0;
481}
482EXPORT_SYMBOL(bio_integrity_clone);
483
Martin K. Petersen7878cba2009-06-26 15:37:49 +0200484int bioset_integrity_create(struct bio_set *bs, int pool_size)
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200485{
Martin K. Petersena91a2782011-03-17 11:11:05 +0100486 if (bs->bio_integrity_pool)
487 return 0;
488
Kent Overstreet9f060e22012-10-12 15:29:33 -0700489 bs->bio_integrity_pool = mempool_create_slab_pool(pool_size, bip_slab);
Martin K. Petersen7878cba2009-06-26 15:37:49 +0200490 if (!bs->bio_integrity_pool)
491 return -1;
Martin K. Petersen6d2a78e2009-03-10 08:27:39 +0100492
Fabian Fredericka6c39cb4f2014-04-22 15:09:05 -0600493 bs->bvec_integrity_pool = biovec_create_pool(pool_size);
Gu Zhengbc5c8f02013-09-11 14:23:21 -0700494 if (!bs->bvec_integrity_pool) {
495 mempool_destroy(bs->bio_integrity_pool);
496 return -1;
497 }
498
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200499 return 0;
500}
Martin K. Petersen7878cba2009-06-26 15:37:49 +0200501EXPORT_SYMBOL(bioset_integrity_create);
502
503void bioset_integrity_free(struct bio_set *bs)
504{
505 if (bs->bio_integrity_pool)
506 mempool_destroy(bs->bio_integrity_pool);
Kent Overstreet9f060e22012-10-12 15:29:33 -0700507
508 if (bs->bvec_integrity_pool)
Bjorn Helgaasadbe6992013-05-29 16:29:55 -0600509 mempool_destroy(bs->bvec_integrity_pool);
Martin K. Petersen7878cba2009-06-26 15:37:49 +0200510}
511EXPORT_SYMBOL(bioset_integrity_free);
512
513void __init bio_integrity_init(void)
514{
Tejun Heoa6e8dc42011-01-03 15:01:48 +0100515 /*
516 * kintegrityd won't block much but may burn a lot of CPU cycles.
517 * Make it highpri CPU intensive wq with max concurrency of 1.
518 */
519 kintegrityd_wq = alloc_workqueue("kintegrityd", WQ_MEM_RECLAIM |
520 WQ_HIGHPRI | WQ_CPU_INTENSIVE, 1);
Martin K. Petersen7878cba2009-06-26 15:37:49 +0200521 if (!kintegrityd_wq)
522 panic("Failed to create kintegrityd\n");
523
Kent Overstreet9f060e22012-10-12 15:29:33 -0700524 bip_slab = kmem_cache_create("bio_integrity_payload",
525 sizeof(struct bio_integrity_payload) +
526 sizeof(struct bio_vec) * BIP_INLINE_VECS,
527 0, SLAB_HWCACHE_ALIGN|SLAB_PANIC, NULL);
Martin K. Petersen7878cba2009-06-26 15:37:49 +0200528}