Loading...
1/*
2 * bio-integrity.c - bio data integrity extensions
3 *
4 * Copyright (C) 2007, 2008, 2009 Oracle Corporation
5 * 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>
25#include <linux/export.h>
26#include <linux/bio.h>
27#include <linux/workqueue.h>
28#include <linux/slab.h>
29
30#define BIP_INLINE_VECS 4
31
32static struct kmem_cache *bip_slab;
33static struct workqueue_struct *kintegrityd_wq;
34
35void blk_flush_integrity(void)
36{
37 flush_workqueue(kintegrityd_wq);
38}
39
40/**
41 * bio_integrity_alloc - Allocate integrity payload and attach it to bio
42 * @bio: bio to attach integrity metadata to
43 * @gfp_mask: Memory allocation mask
44 * @nr_vecs: Number of integrity metadata scatter-gather elements
45 *
46 * Description: This function prepares a bio for attaching integrity
47 * metadata. nr_vecs specifies the maximum number of pages containing
48 * integrity metadata that can be attached.
49 */
50struct bio_integrity_payload *bio_integrity_alloc(struct bio *bio,
51 gfp_t gfp_mask,
52 unsigned int nr_vecs)
53{
54 struct bio_integrity_payload *bip;
55 struct bio_set *bs = bio->bi_pool;
56 unsigned long idx = BIO_POOL_NONE;
57 unsigned inline_vecs;
58
59 if (!bs || !bs->bio_integrity_pool) {
60 bip = kmalloc(sizeof(struct bio_integrity_payload) +
61 sizeof(struct bio_vec) * nr_vecs, gfp_mask);
62 inline_vecs = nr_vecs;
63 } else {
64 bip = mempool_alloc(bs->bio_integrity_pool, gfp_mask);
65 inline_vecs = BIP_INLINE_VECS;
66 }
67
68 if (unlikely(!bip))
69 return ERR_PTR(-ENOMEM);
70
71 memset(bip, 0, sizeof(*bip));
72
73 if (nr_vecs > inline_vecs) {
74 bip->bip_vec = bvec_alloc(gfp_mask, nr_vecs, &idx,
75 bs->bvec_integrity_pool);
76 if (!bip->bip_vec)
77 goto err;
78 bip->bip_max_vcnt = bvec_nr_vecs(idx);
79 } else {
80 bip->bip_vec = bip->bip_inline_vecs;
81 bip->bip_max_vcnt = inline_vecs;
82 }
83
84 bip->bip_slab = idx;
85 bip->bip_bio = bio;
86 bio->bi_integrity = bip;
87 bio->bi_rw |= REQ_INTEGRITY;
88
89 return bip;
90err:
91 mempool_free(bip, bs->bio_integrity_pool);
92 return ERR_PTR(-ENOMEM);
93}
94EXPORT_SYMBOL(bio_integrity_alloc);
95
96/**
97 * bio_integrity_free - Free bio integrity payload
98 * @bio: bio containing bip to be freed
99 *
100 * Description: Used to free the integrity portion of a bio. Usually
101 * called from bio_free().
102 */
103void bio_integrity_free(struct bio *bio)
104{
105 struct bio_integrity_payload *bip = bio_integrity(bio);
106 struct bio_set *bs = bio->bi_pool;
107
108 if (bip->bip_flags & BIP_BLOCK_INTEGRITY)
109 kfree(page_address(bip->bip_vec->bv_page) +
110 bip->bip_vec->bv_offset);
111
112 if (bs && bs->bio_integrity_pool) {
113 if (bip->bip_slab != BIO_POOL_NONE)
114 bvec_free(bs->bvec_integrity_pool, bip->bip_vec,
115 bip->bip_slab);
116
117 mempool_free(bip, bs->bio_integrity_pool);
118 } else {
119 kfree(bip);
120 }
121
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{
138 struct bio_integrity_payload *bip = bio_integrity(bio);
139 struct bio_vec *iv;
140
141 if (bip->bip_vcnt >= bip->bip_max_vcnt) {
142 printk(KERN_ERR "%s: bip_vec full\n", __func__);
143 return 0;
144 }
145
146 iv = bip->bip_vec + bip->bip_vcnt;
147
148 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
153 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 */
171bool bio_integrity_enabled(struct bio *bio)
172{
173 struct blk_integrity *bi = bdev_get_integrity(bio->bi_bdev);
174
175 if (!bio_is_rw(bio))
176 return false;
177
178 /* Already protected? */
179 if (bio_integrity(bio))
180 return false;
181
182 if (bi == NULL)
183 return false;
184
185 if (bio_data_dir(bio) == READ && bi->profile->verify_fn != NULL &&
186 (bi->flags & BLK_INTEGRITY_VERIFY))
187 return true;
188
189 if (bio_data_dir(bio) == WRITE && bi->profile->generate_fn != NULL &&
190 (bi->flags & BLK_INTEGRITY_GENERATE))
191 return true;
192
193 return false;
194}
195EXPORT_SYMBOL(bio_integrity_enabled);
196
197/**
198 * bio_integrity_intervals - Return number of integrity intervals for a bio
199 * @bi: blk_integrity profile for device
200 * @sectors: Size of the bio in 512-byte sectors
201 *
202 * Description: The block layer calculates everything in 512 byte
203 * 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.
206 */
207static inline unsigned int bio_integrity_intervals(struct blk_integrity *bi,
208 unsigned int sectors)
209{
210 return sectors >> (bi->interval_exp - 9);
211}
212
213static inline unsigned int bio_integrity_bytes(struct blk_integrity *bi,
214 unsigned int sectors)
215{
216 return bio_integrity_intervals(bi, sectors) * bi->tuple_size;
217}
218
219/**
220 * bio_integrity_process - Process integrity metadata for a bio
221 * @bio: bio to generate/verify integrity metadata for
222 * @proc_fn: Pointer to the relevant processing function
223 */
224static int bio_integrity_process(struct bio *bio,
225 integrity_processing_fn *proc_fn)
226{
227 struct blk_integrity *bi = bdev_get_integrity(bio->bi_bdev);
228 struct blk_integrity_iter iter;
229 struct bvec_iter bviter;
230 struct bio_vec bv;
231 struct bio_integrity_payload *bip = bio_integrity(bio);
232 unsigned int ret = 0;
233 void *prot_buf = page_address(bip->bip_vec->bv_page) +
234 bip->bip_vec->bv_offset;
235
236 iter.disk_name = bio->bi_bdev->bd_disk->disk_name;
237 iter.interval = 1 << bi->interval_exp;
238 iter.seed = bip_get_seed(bip);
239 iter.prot_buf = prot_buf;
240
241 bio_for_each_segment(bv, bio, bviter) {
242 void *kaddr = kmap_atomic(bv.bv_page);
243
244 iter.data_buf = kaddr + bv.bv_offset;
245 iter.data_size = bv.bv_len;
246
247 ret = proc_fn(&iter);
248 if (ret) {
249 kunmap_atomic(kaddr);
250 return ret;
251 }
252
253 kunmap_atomic(kaddr);
254 }
255 return ret;
256}
257
258/**
259 * 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;
278 unsigned int intervals;
279
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
285 intervals = bio_integrity_intervals(bi, bio_sectors(bio));
286
287 /* Allocate kernel buffer for protection data */
288 len = intervals * bi->tuple_size;
289 buf = kmalloc(len, GFP_NOIO | q->bounce_gfp);
290 if (unlikely(buf == NULL)) {
291 printk(KERN_ERR "could not allocate integrity buffer\n");
292 return -ENOMEM;
293 }
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);
301 if (IS_ERR(bip)) {
302 printk(KERN_ERR "could not allocate data integrity bioset\n");
303 kfree(buf);
304 return PTR_ERR(bip);
305 }
306
307 bip->bip_flags |= BIP_BLOCK_INTEGRITY;
308 bip->bip_iter.bi_size = len;
309 bip_set_seed(bip, bio->bi_iter.bi_sector);
310
311 if (bi->flags & BLK_INTEGRITY_IP_CHECKSUM)
312 bip->bip_flags |= BIP_IP_CHECKSUM;
313
314 /* 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)
348 bio_integrity_process(bio, bi->profile->generate_fn);
349
350 return 0;
351}
352EXPORT_SYMBOL(bio_integrity_prep);
353
354/**
355 * 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{
364 struct bio_integrity_payload *bip =
365 container_of(work, struct bio_integrity_payload, bip_work);
366 struct bio *bio = bip->bip_bio;
367 struct blk_integrity *bi = bdev_get_integrity(bio->bi_bdev);
368
369 bio->bi_error = bio_integrity_process(bio, bi->profile->verify_fn);
370
371 /* Restore original bio completion handler */
372 bio->bi_end_io = bip->bip_end_io;
373 bio_endio(bio);
374}
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 */
388void bio_integrity_endio(struct bio *bio)
389{
390 struct bio_integrity_payload *bip = bio_integrity(bio);
391
392 BUG_ON(bip->bip_bio != bio);
393
394 /* 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 */
398 if (bio->bi_error) {
399 bio->bi_end_io = bip->bip_end_io;
400 bio_endio(bio);
401
402 return;
403 }
404
405 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/**
411 * 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{
421 struct bio_integrity_payload *bip = bio_integrity(bio);
422 struct blk_integrity *bi = bdev_get_integrity(bio->bi_bdev);
423 unsigned bytes = bio_integrity_bytes(bi, bytes_done >> 9);
424
425 bvec_iter_advance(bip->bip_vec, &bip->bip_iter, bytes);
426}
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 */
440void bio_integrity_trim(struct bio *bio, unsigned int offset,
441 unsigned int sectors)
442{
443 struct bio_integrity_payload *bip = bio_integrity(bio);
444 struct blk_integrity *bi = bdev_get_integrity(bio->bi_bdev);
445
446 bio_integrity_advance(bio, offset << 9);
447 bip->bip_iter.bi_size = bio_integrity_bytes(bi, sectors);
448}
449EXPORT_SYMBOL(bio_integrity_trim);
450
451/**
452 * bio_integrity_clone - Callback for cloning bios with integrity metadata
453 * @bio: New bio
454 * @bio_src: Original bio
455 * @gfp_mask: Memory allocation mask
456 *
457 * Description: Called to allocate a bip when cloning a bio
458 */
459int bio_integrity_clone(struct bio *bio, struct bio *bio_src,
460 gfp_t gfp_mask)
461{
462 struct bio_integrity_payload *bip_src = bio_integrity(bio_src);
463 struct bio_integrity_payload *bip;
464
465 BUG_ON(bip_src == NULL);
466
467 bip = bio_integrity_alloc(bio, gfp_mask, bip_src->bip_vcnt);
468 if (IS_ERR(bip))
469 return PTR_ERR(bip);
470
471 memcpy(bip->bip_vec, bip_src->bip_vec,
472 bip_src->bip_vcnt * sizeof(struct bio_vec));
473
474 bip->bip_vcnt = bip_src->bip_vcnt;
475 bip->bip_iter = bip_src->bip_iter;
476
477 return 0;
478}
479EXPORT_SYMBOL(bio_integrity_clone);
480
481int bioset_integrity_create(struct bio_set *bs, int pool_size)
482{
483 if (bs->bio_integrity_pool)
484 return 0;
485
486 bs->bio_integrity_pool = mempool_create_slab_pool(pool_size, bip_slab);
487 if (!bs->bio_integrity_pool)
488 return -1;
489
490 bs->bvec_integrity_pool = biovec_create_pool(pool_size);
491 if (!bs->bvec_integrity_pool) {
492 mempool_destroy(bs->bio_integrity_pool);
493 return -1;
494 }
495
496 return 0;
497}
498EXPORT_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);
504
505 if (bs->bvec_integrity_pool)
506 mempool_destroy(bs->bvec_integrity_pool);
507}
508EXPORT_SYMBOL(bioset_integrity_free);
509
510void __init bio_integrity_init(void)
511{
512 /*
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);
518 if (!kintegrityd_wq)
519 panic("Failed to create kintegrityd\n");
520
521 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);
525}
1// SPDX-License-Identifier: GPL-2.0
2/*
3 * bio-integrity.c - bio data integrity extensions
4 *
5 * Copyright (C) 2007, 2008, 2009 Oracle Corporation
6 * Written by: Martin K. Petersen <martin.petersen@oracle.com>
7 */
8
9#include <linux/blk-integrity.h>
10#include <linux/mempool.h>
11#include <linux/export.h>
12#include <linux/bio.h>
13#include <linux/workqueue.h>
14#include <linux/slab.h>
15#include "blk.h"
16
17static struct kmem_cache *bip_slab;
18static struct workqueue_struct *kintegrityd_wq;
19
20void blk_flush_integrity(void)
21{
22 flush_workqueue(kintegrityd_wq);
23}
24
25static void __bio_integrity_free(struct bio_set *bs,
26 struct bio_integrity_payload *bip)
27{
28 if (bs && mempool_initialized(&bs->bio_integrity_pool)) {
29 if (bip->bip_vec)
30 bvec_free(&bs->bvec_integrity_pool, bip->bip_vec,
31 bip->bip_max_vcnt);
32 mempool_free(bip, &bs->bio_integrity_pool);
33 } else {
34 kfree(bip);
35 }
36}
37
38/**
39 * bio_integrity_alloc - Allocate integrity payload and attach it to bio
40 * @bio: bio to attach integrity metadata to
41 * @gfp_mask: Memory allocation mask
42 * @nr_vecs: Number of integrity metadata scatter-gather elements
43 *
44 * Description: This function prepares a bio for attaching integrity
45 * metadata. nr_vecs specifies the maximum number of pages containing
46 * integrity metadata that can be attached.
47 */
48struct bio_integrity_payload *bio_integrity_alloc(struct bio *bio,
49 gfp_t gfp_mask,
50 unsigned int nr_vecs)
51{
52 struct bio_integrity_payload *bip;
53 struct bio_set *bs = bio->bi_pool;
54 unsigned inline_vecs;
55
56 if (WARN_ON_ONCE(bio_has_crypt_ctx(bio)))
57 return ERR_PTR(-EOPNOTSUPP);
58
59 if (!bs || !mempool_initialized(&bs->bio_integrity_pool)) {
60 bip = kmalloc(struct_size(bip, bip_inline_vecs, nr_vecs), gfp_mask);
61 inline_vecs = nr_vecs;
62 } else {
63 bip = mempool_alloc(&bs->bio_integrity_pool, gfp_mask);
64 inline_vecs = BIO_INLINE_VECS;
65 }
66
67 if (unlikely(!bip))
68 return ERR_PTR(-ENOMEM);
69
70 memset(bip, 0, sizeof(*bip));
71
72 /* always report as many vecs as asked explicitly, not inline vecs */
73 bip->bip_max_vcnt = nr_vecs;
74 if (nr_vecs > inline_vecs) {
75 bip->bip_vec = bvec_alloc(&bs->bvec_integrity_pool,
76 &bip->bip_max_vcnt, gfp_mask);
77 if (!bip->bip_vec)
78 goto err;
79 } else {
80 bip->bip_vec = bip->bip_inline_vecs;
81 }
82
83 bip->bip_bio = bio;
84 bio->bi_integrity = bip;
85 bio->bi_opf |= REQ_INTEGRITY;
86
87 return bip;
88err:
89 __bio_integrity_free(bs, bip);
90 return ERR_PTR(-ENOMEM);
91}
92EXPORT_SYMBOL(bio_integrity_alloc);
93
94static void bio_integrity_unpin_bvec(struct bio_vec *bv, int nr_vecs,
95 bool dirty)
96{
97 int i;
98
99 for (i = 0; i < nr_vecs; i++) {
100 if (dirty && !PageCompound(bv[i].bv_page))
101 set_page_dirty_lock(bv[i].bv_page);
102 unpin_user_page(bv[i].bv_page);
103 }
104}
105
106static void bio_integrity_uncopy_user(struct bio_integrity_payload *bip)
107{
108 unsigned short nr_vecs = bip->bip_max_vcnt - 1;
109 struct bio_vec *copy = &bip->bip_vec[1];
110 size_t bytes = bip->bip_iter.bi_size;
111 struct iov_iter iter;
112 int ret;
113
114 iov_iter_bvec(&iter, ITER_DEST, copy, nr_vecs, bytes);
115 ret = copy_to_iter(bvec_virt(bip->bip_vec), bytes, &iter);
116 WARN_ON_ONCE(ret != bytes);
117
118 bio_integrity_unpin_bvec(copy, nr_vecs, true);
119}
120
121static void bio_integrity_unmap_user(struct bio_integrity_payload *bip)
122{
123 bool dirty = bio_data_dir(bip->bip_bio) == READ;
124
125 if (bip->bip_flags & BIP_COPY_USER) {
126 if (dirty)
127 bio_integrity_uncopy_user(bip);
128 kfree(bvec_virt(bip->bip_vec));
129 return;
130 }
131
132 bio_integrity_unpin_bvec(bip->bip_vec, bip->bip_max_vcnt, dirty);
133}
134
135/**
136 * bio_integrity_free - Free bio integrity payload
137 * @bio: bio containing bip to be freed
138 *
139 * Description: Used to free the integrity portion of a bio. Usually
140 * called from bio_free().
141 */
142void bio_integrity_free(struct bio *bio)
143{
144 struct bio_integrity_payload *bip = bio_integrity(bio);
145 struct bio_set *bs = bio->bi_pool;
146
147 if (bip->bip_flags & BIP_BLOCK_INTEGRITY)
148 kfree(bvec_virt(bip->bip_vec));
149 else if (bip->bip_flags & BIP_INTEGRITY_USER)
150 bio_integrity_unmap_user(bip);
151
152 __bio_integrity_free(bs, bip);
153 bio->bi_integrity = NULL;
154 bio->bi_opf &= ~REQ_INTEGRITY;
155}
156
157/**
158 * bio_integrity_add_page - Attach integrity metadata
159 * @bio: bio to update
160 * @page: page containing integrity metadata
161 * @len: number of bytes of integrity metadata in page
162 * @offset: start offset within page
163 *
164 * Description: Attach a page containing integrity metadata to bio.
165 */
166int bio_integrity_add_page(struct bio *bio, struct page *page,
167 unsigned int len, unsigned int offset)
168{
169 struct request_queue *q = bdev_get_queue(bio->bi_bdev);
170 struct bio_integrity_payload *bip = bio_integrity(bio);
171
172 if (((bip->bip_iter.bi_size + len) >> SECTOR_SHIFT) >
173 queue_max_hw_sectors(q))
174 return 0;
175
176 if (bip->bip_vcnt > 0) {
177 struct bio_vec *bv = &bip->bip_vec[bip->bip_vcnt - 1];
178 bool same_page = false;
179
180 if (bvec_try_merge_hw_page(q, bv, page, len, offset,
181 &same_page)) {
182 bip->bip_iter.bi_size += len;
183 return len;
184 }
185
186 if (bip->bip_vcnt >=
187 min(bip->bip_max_vcnt, queue_max_integrity_segments(q)))
188 return 0;
189
190 /*
191 * If the queue doesn't support SG gaps and adding this segment
192 * would create a gap, disallow it.
193 */
194 if (bvec_gap_to_prev(&q->limits, bv, offset))
195 return 0;
196 }
197
198 bvec_set_page(&bip->bip_vec[bip->bip_vcnt], page, len, offset);
199 bip->bip_vcnt++;
200 bip->bip_iter.bi_size += len;
201
202 return len;
203}
204EXPORT_SYMBOL(bio_integrity_add_page);
205
206static int bio_integrity_copy_user(struct bio *bio, struct bio_vec *bvec,
207 int nr_vecs, unsigned int len,
208 unsigned int direction, u32 seed)
209{
210 bool write = direction == ITER_SOURCE;
211 struct bio_integrity_payload *bip;
212 struct iov_iter iter;
213 void *buf;
214 int ret;
215
216 buf = kmalloc(len, GFP_KERNEL);
217 if (!buf)
218 return -ENOMEM;
219
220 if (write) {
221 iov_iter_bvec(&iter, direction, bvec, nr_vecs, len);
222 if (!copy_from_iter_full(buf, len, &iter)) {
223 ret = -EFAULT;
224 goto free_buf;
225 }
226
227 bip = bio_integrity_alloc(bio, GFP_KERNEL, 1);
228 } else {
229 memset(buf, 0, len);
230
231 /*
232 * We need to preserve the original bvec and the number of vecs
233 * in it for completion handling
234 */
235 bip = bio_integrity_alloc(bio, GFP_KERNEL, nr_vecs + 1);
236 }
237
238 if (IS_ERR(bip)) {
239 ret = PTR_ERR(bip);
240 goto free_buf;
241 }
242
243 if (write)
244 bio_integrity_unpin_bvec(bvec, nr_vecs, false);
245 else
246 memcpy(&bip->bip_vec[1], bvec, nr_vecs * sizeof(*bvec));
247
248 ret = bio_integrity_add_page(bio, virt_to_page(buf), len,
249 offset_in_page(buf));
250 if (ret != len) {
251 ret = -ENOMEM;
252 goto free_bip;
253 }
254
255 bip->bip_flags |= BIP_INTEGRITY_USER | BIP_COPY_USER;
256 bip->bip_iter.bi_sector = seed;
257 return 0;
258free_bip:
259 bio_integrity_free(bio);
260free_buf:
261 kfree(buf);
262 return ret;
263}
264
265static int bio_integrity_init_user(struct bio *bio, struct bio_vec *bvec,
266 int nr_vecs, unsigned int len, u32 seed)
267{
268 struct bio_integrity_payload *bip;
269
270 bip = bio_integrity_alloc(bio, GFP_KERNEL, nr_vecs);
271 if (IS_ERR(bip))
272 return PTR_ERR(bip);
273
274 memcpy(bip->bip_vec, bvec, nr_vecs * sizeof(*bvec));
275 bip->bip_flags |= BIP_INTEGRITY_USER;
276 bip->bip_iter.bi_sector = seed;
277 bip->bip_iter.bi_size = len;
278 return 0;
279}
280
281static unsigned int bvec_from_pages(struct bio_vec *bvec, struct page **pages,
282 int nr_vecs, ssize_t bytes, ssize_t offset)
283{
284 unsigned int nr_bvecs = 0;
285 int i, j;
286
287 for (i = 0; i < nr_vecs; i = j) {
288 size_t size = min_t(size_t, bytes, PAGE_SIZE - offset);
289 struct folio *folio = page_folio(pages[i]);
290
291 bytes -= size;
292 for (j = i + 1; j < nr_vecs; j++) {
293 size_t next = min_t(size_t, PAGE_SIZE, bytes);
294
295 if (page_folio(pages[j]) != folio ||
296 pages[j] != pages[j - 1] + 1)
297 break;
298 unpin_user_page(pages[j]);
299 size += next;
300 bytes -= next;
301 }
302
303 bvec_set_page(&bvec[nr_bvecs], pages[i], size, offset);
304 offset = 0;
305 nr_bvecs++;
306 }
307
308 return nr_bvecs;
309}
310
311int bio_integrity_map_user(struct bio *bio, void __user *ubuf, ssize_t bytes,
312 u32 seed)
313{
314 struct request_queue *q = bdev_get_queue(bio->bi_bdev);
315 unsigned int align = q->dma_pad_mask | queue_dma_alignment(q);
316 struct page *stack_pages[UIO_FASTIOV], **pages = stack_pages;
317 struct bio_vec stack_vec[UIO_FASTIOV], *bvec = stack_vec;
318 unsigned int direction, nr_bvecs;
319 struct iov_iter iter;
320 int ret, nr_vecs;
321 size_t offset;
322 bool copy;
323
324 if (bio_integrity(bio))
325 return -EINVAL;
326 if (bytes >> SECTOR_SHIFT > queue_max_hw_sectors(q))
327 return -E2BIG;
328
329 if (bio_data_dir(bio) == READ)
330 direction = ITER_DEST;
331 else
332 direction = ITER_SOURCE;
333
334 iov_iter_ubuf(&iter, direction, ubuf, bytes);
335 nr_vecs = iov_iter_npages(&iter, BIO_MAX_VECS + 1);
336 if (nr_vecs > BIO_MAX_VECS)
337 return -E2BIG;
338 if (nr_vecs > UIO_FASTIOV) {
339 bvec = kcalloc(nr_vecs, sizeof(*bvec), GFP_KERNEL);
340 if (!bvec)
341 return -ENOMEM;
342 pages = NULL;
343 }
344
345 copy = !iov_iter_is_aligned(&iter, align, align);
346 ret = iov_iter_extract_pages(&iter, &pages, bytes, nr_vecs, 0, &offset);
347 if (unlikely(ret < 0))
348 goto free_bvec;
349
350 nr_bvecs = bvec_from_pages(bvec, pages, nr_vecs, bytes, offset);
351 if (pages != stack_pages)
352 kvfree(pages);
353 if (nr_bvecs > queue_max_integrity_segments(q))
354 copy = true;
355
356 if (copy)
357 ret = bio_integrity_copy_user(bio, bvec, nr_bvecs, bytes,
358 direction, seed);
359 else
360 ret = bio_integrity_init_user(bio, bvec, nr_bvecs, bytes, seed);
361 if (ret)
362 goto release_pages;
363 if (bvec != stack_vec)
364 kfree(bvec);
365
366 return 0;
367
368release_pages:
369 bio_integrity_unpin_bvec(bvec, nr_bvecs, false);
370free_bvec:
371 if (bvec != stack_vec)
372 kfree(bvec);
373 return ret;
374}
375EXPORT_SYMBOL_GPL(bio_integrity_map_user);
376
377/**
378 * bio_integrity_process - Process integrity metadata for a bio
379 * @bio: bio to generate/verify integrity metadata for
380 * @proc_iter: iterator to process
381 * @proc_fn: Pointer to the relevant processing function
382 */
383static blk_status_t bio_integrity_process(struct bio *bio,
384 struct bvec_iter *proc_iter, integrity_processing_fn *proc_fn)
385{
386 struct blk_integrity *bi = blk_get_integrity(bio->bi_bdev->bd_disk);
387 struct blk_integrity_iter iter;
388 struct bvec_iter bviter;
389 struct bio_vec bv;
390 struct bio_integrity_payload *bip = bio_integrity(bio);
391 blk_status_t ret = BLK_STS_OK;
392
393 iter.disk_name = bio->bi_bdev->bd_disk->disk_name;
394 iter.interval = 1 << bi->interval_exp;
395 iter.tuple_size = bi->tuple_size;
396 iter.seed = proc_iter->bi_sector;
397 iter.prot_buf = bvec_virt(bip->bip_vec);
398 iter.pi_offset = bi->pi_offset;
399
400 __bio_for_each_segment(bv, bio, bviter, *proc_iter) {
401 void *kaddr = bvec_kmap_local(&bv);
402
403 iter.data_buf = kaddr;
404 iter.data_size = bv.bv_len;
405 ret = proc_fn(&iter);
406 kunmap_local(kaddr);
407
408 if (ret)
409 break;
410
411 }
412 return ret;
413}
414
415/**
416 * bio_integrity_prep - Prepare bio for integrity I/O
417 * @bio: bio to prepare
418 *
419 * Description: Checks if the bio already has an integrity payload attached.
420 * If it does, the payload has been generated by another kernel subsystem,
421 * and we just pass it through. Otherwise allocates integrity payload.
422 * The bio must have data direction, target device and start sector set priot
423 * to calling. In the WRITE case, integrity metadata will be generated using
424 * the block device's integrity function. In the READ case, the buffer
425 * will be prepared for DMA and a suitable end_io handler set up.
426 */
427bool bio_integrity_prep(struct bio *bio)
428{
429 struct bio_integrity_payload *bip;
430 struct blk_integrity *bi = blk_get_integrity(bio->bi_bdev->bd_disk);
431 void *buf;
432 unsigned long start, end;
433 unsigned int len, nr_pages;
434 unsigned int bytes, offset, i;
435
436 if (!bi)
437 return true;
438
439 if (bio_op(bio) != REQ_OP_READ && bio_op(bio) != REQ_OP_WRITE)
440 return true;
441
442 if (!bio_sectors(bio))
443 return true;
444
445 /* Already protected? */
446 if (bio_integrity(bio))
447 return true;
448
449 if (bio_data_dir(bio) == READ) {
450 if (!bi->profile->verify_fn ||
451 !(bi->flags & BLK_INTEGRITY_VERIFY))
452 return true;
453 } else {
454 if (!bi->profile->generate_fn ||
455 !(bi->flags & BLK_INTEGRITY_GENERATE))
456 return true;
457 }
458
459 /* Allocate kernel buffer for protection data */
460 len = bio_integrity_bytes(bi, bio_sectors(bio));
461 buf = kmalloc(len, GFP_NOIO);
462 if (unlikely(buf == NULL)) {
463 printk(KERN_ERR "could not allocate integrity buffer\n");
464 goto err_end_io;
465 }
466
467 end = (((unsigned long) buf) + len + PAGE_SIZE - 1) >> PAGE_SHIFT;
468 start = ((unsigned long) buf) >> PAGE_SHIFT;
469 nr_pages = end - start;
470
471 /* Allocate bio integrity payload and integrity vectors */
472 bip = bio_integrity_alloc(bio, GFP_NOIO, nr_pages);
473 if (IS_ERR(bip)) {
474 printk(KERN_ERR "could not allocate data integrity bioset\n");
475 kfree(buf);
476 goto err_end_io;
477 }
478
479 bip->bip_flags |= BIP_BLOCK_INTEGRITY;
480 bip_set_seed(bip, bio->bi_iter.bi_sector);
481
482 if (bi->flags & BLK_INTEGRITY_IP_CHECKSUM)
483 bip->bip_flags |= BIP_IP_CHECKSUM;
484
485 /* Map it */
486 offset = offset_in_page(buf);
487 for (i = 0; i < nr_pages && len > 0; i++) {
488 bytes = PAGE_SIZE - offset;
489
490 if (bytes > len)
491 bytes = len;
492
493 if (bio_integrity_add_page(bio, virt_to_page(buf),
494 bytes, offset) < bytes) {
495 printk(KERN_ERR "could not attach integrity payload\n");
496 goto err_end_io;
497 }
498
499 buf += bytes;
500 len -= bytes;
501 offset = 0;
502 }
503
504 /* Auto-generate integrity metadata if this is a write */
505 if (bio_data_dir(bio) == WRITE) {
506 bio_integrity_process(bio, &bio->bi_iter,
507 bi->profile->generate_fn);
508 } else {
509 bip->bio_iter = bio->bi_iter;
510 }
511 return true;
512
513err_end_io:
514 bio->bi_status = BLK_STS_RESOURCE;
515 bio_endio(bio);
516 return false;
517}
518EXPORT_SYMBOL(bio_integrity_prep);
519
520/**
521 * bio_integrity_verify_fn - Integrity I/O completion worker
522 * @work: Work struct stored in bio to be verified
523 *
524 * Description: This workqueue function is called to complete a READ
525 * request. The function verifies the transferred integrity metadata
526 * and then calls the original bio end_io function.
527 */
528static void bio_integrity_verify_fn(struct work_struct *work)
529{
530 struct bio_integrity_payload *bip =
531 container_of(work, struct bio_integrity_payload, bip_work);
532 struct bio *bio = bip->bip_bio;
533 struct blk_integrity *bi = blk_get_integrity(bio->bi_bdev->bd_disk);
534
535 /*
536 * At the moment verify is called bio's iterator was advanced
537 * during split and completion, we need to rewind iterator to
538 * it's original position.
539 */
540 bio->bi_status = bio_integrity_process(bio, &bip->bio_iter,
541 bi->profile->verify_fn);
542 bio_integrity_free(bio);
543 bio_endio(bio);
544}
545
546/**
547 * __bio_integrity_endio - Integrity I/O completion function
548 * @bio: Protected bio
549 *
550 * Description: Completion for integrity I/O
551 *
552 * Normally I/O completion is done in interrupt context. However,
553 * verifying I/O integrity is a time-consuming task which must be run
554 * in process context. This function postpones completion
555 * accordingly.
556 */
557bool __bio_integrity_endio(struct bio *bio)
558{
559 struct blk_integrity *bi = blk_get_integrity(bio->bi_bdev->bd_disk);
560 struct bio_integrity_payload *bip = bio_integrity(bio);
561
562 if (bio_op(bio) == REQ_OP_READ && !bio->bi_status &&
563 (bip->bip_flags & BIP_BLOCK_INTEGRITY) && bi->profile->verify_fn) {
564 INIT_WORK(&bip->bip_work, bio_integrity_verify_fn);
565 queue_work(kintegrityd_wq, &bip->bip_work);
566 return false;
567 }
568
569 bio_integrity_free(bio);
570 return true;
571}
572
573/**
574 * bio_integrity_advance - Advance integrity vector
575 * @bio: bio whose integrity vector to update
576 * @bytes_done: number of data bytes that have been completed
577 *
578 * Description: This function calculates how many integrity bytes the
579 * number of completed data bytes correspond to and advances the
580 * integrity vector accordingly.
581 */
582void bio_integrity_advance(struct bio *bio, unsigned int bytes_done)
583{
584 struct bio_integrity_payload *bip = bio_integrity(bio);
585 struct blk_integrity *bi = blk_get_integrity(bio->bi_bdev->bd_disk);
586 unsigned bytes = bio_integrity_bytes(bi, bytes_done >> 9);
587
588 bip->bip_iter.bi_sector += bio_integrity_intervals(bi, bytes_done >> 9);
589 bvec_iter_advance(bip->bip_vec, &bip->bip_iter, bytes);
590}
591
592/**
593 * bio_integrity_trim - Trim integrity vector
594 * @bio: bio whose integrity vector to update
595 *
596 * Description: Used to trim the integrity vector in a cloned bio.
597 */
598void bio_integrity_trim(struct bio *bio)
599{
600 struct bio_integrity_payload *bip = bio_integrity(bio);
601 struct blk_integrity *bi = blk_get_integrity(bio->bi_bdev->bd_disk);
602
603 bip->bip_iter.bi_size = bio_integrity_bytes(bi, bio_sectors(bio));
604}
605EXPORT_SYMBOL(bio_integrity_trim);
606
607/**
608 * bio_integrity_clone - Callback for cloning bios with integrity metadata
609 * @bio: New bio
610 * @bio_src: Original bio
611 * @gfp_mask: Memory allocation mask
612 *
613 * Description: Called to allocate a bip when cloning a bio
614 */
615int bio_integrity_clone(struct bio *bio, struct bio *bio_src,
616 gfp_t gfp_mask)
617{
618 struct bio_integrity_payload *bip_src = bio_integrity(bio_src);
619 struct bio_integrity_payload *bip;
620
621 BUG_ON(bip_src == NULL);
622
623 bip = bio_integrity_alloc(bio, gfp_mask, bip_src->bip_vcnt);
624 if (IS_ERR(bip))
625 return PTR_ERR(bip);
626
627 memcpy(bip->bip_vec, bip_src->bip_vec,
628 bip_src->bip_vcnt * sizeof(struct bio_vec));
629
630 bip->bip_vcnt = bip_src->bip_vcnt;
631 bip->bip_iter = bip_src->bip_iter;
632 bip->bip_flags = bip_src->bip_flags & ~BIP_BLOCK_INTEGRITY;
633
634 return 0;
635}
636
637int bioset_integrity_create(struct bio_set *bs, int pool_size)
638{
639 if (mempool_initialized(&bs->bio_integrity_pool))
640 return 0;
641
642 if (mempool_init_slab_pool(&bs->bio_integrity_pool,
643 pool_size, bip_slab))
644 return -1;
645
646 if (biovec_init_pool(&bs->bvec_integrity_pool, pool_size)) {
647 mempool_exit(&bs->bio_integrity_pool);
648 return -1;
649 }
650
651 return 0;
652}
653EXPORT_SYMBOL(bioset_integrity_create);
654
655void bioset_integrity_free(struct bio_set *bs)
656{
657 mempool_exit(&bs->bio_integrity_pool);
658 mempool_exit(&bs->bvec_integrity_pool);
659}
660
661void __init bio_integrity_init(void)
662{
663 /*
664 * kintegrityd won't block much but may burn a lot of CPU cycles.
665 * Make it highpri CPU intensive wq with max concurrency of 1.
666 */
667 kintegrityd_wq = alloc_workqueue("kintegrityd", WQ_MEM_RECLAIM |
668 WQ_HIGHPRI | WQ_CPU_INTENSIVE, 1);
669 if (!kintegrityd_wq)
670 panic("Failed to create kintegrityd\n");
671
672 bip_slab = kmem_cache_create("bio_integrity_payload",
673 sizeof(struct bio_integrity_payload) +
674 sizeof(struct bio_vec) * BIO_INLINE_VECS,
675 0, SLAB_HWCACHE_ALIGN|SLAB_PANIC, NULL);
676}