[PATCHv2 1/4] block: bio-integrity: directly map user buffers

Keith Busch
2023-10-27T18:20:16Z

From: Keith Busch <kbusch@kernel.org>

Passthrough commands that utilize metadata currently need to bounce the
user space buffer through the kernel. Add support for mapping user space
directly so that we can avoid this costly overhead. This is similiar to
how the normal bio data payload utilizes user addresses with
bio_map_user_iov().

If the user address can't directly be used for reasons like too many
segments or address unalignement, fallback to a copy of the user vec
while keeping the user address pinned for the IO duration so that it
can safely be copied on completion in any process context.

Signed-off-by: Keith Busch <kbusch@kernel.org>
---
block/bio-integrity.c | 195 ++++++++++++++++++++++++++++++++++++++++++
include/linux/bio.h | 9 ++
2 files changed, 204 insertions(+)

diff --git a/block/bio-integrity.c b/block/bio-integrity.c
index ec8ac8cf6e1b9..7f9d242ad79df 100644
--- a/block/bio-integrity.c
+++ b/block/bio-integrity.c
@@ -91,6 +91,37 @@ struct bio_integrity_payload *bio_integrity_alloc(struct bio *bio,
}
EXPORT_SYMBOL(bio_integrity_alloc);

+static void bio_integrity_unmap_user(struct bio_integrity_payload *bip)
+{
+ bool dirty = bio_data_dir(bip->bip_bio) == READ;
+ struct bio_vec *copy = bip->copy_vec;
+ struct bvec_iter iter;
+ struct bio_vec bv;
+
+ if (copy) {
+ unsigned short nr_vecs = bip->bip_max_vcnt;
+ size_t bytes = bip->bip_iter.bi_size;
+ void *buf = bvec_virt(bip->bip_vec);
+
+ if (dirty) {
+ struct iov_iter iter;
+
+ iov_iter_bvec(&iter, ITER_DEST, copy, nr_vecs, bytes);
+ WARN_ON(copy_to_iter(buf, bytes, &iter) != bytes);
+ }
+
+ memcpy(bip->bip_vec, copy, nr_vecs * sizeof(*copy));
+ kfree(copy);
+ kfree(buf);
+ }
+
+ bip_for_each_vec(bv, bip, iter) {
+ if (dirty && !PageCompound(bv.bv_page))
+ set_page_dirty_lock(bv.bv_page);
+ unpin_user_page(bv.bv_page);
+ }
+}
+
/**
* bio_integrity_free - Free bio integrity payload
* @bio: bio containing bip to be freed
@@ -105,6 +136,8 @@ void bio_integrity_free(struct bio *bio)

if (bip->bip_flags & BIP_BLOCK_INTEGRITY)
kfree(bvec_virt(bip->bip_vec));
+ else if (bip->bip_flags & BIP_INTEGRITY_USER)
+ bio_integrity_unmap_user(bip);

__bio_integrity_free(bs, bip);
bio->bi_integrity = NULL;
@@ -160,6 +193,168 @@ int bio_integrity_add_page(struct bio *bio, struct page *page,
}
EXPORT_SYMBOL(bio_integrity_add_page);

+static int bio_integrity_copy_user(struct bio *bio, struct bio_vec *bvec,
+ int nr_vecs, unsigned int len,
+ unsigned int direction, u32 seed)
+{
+ struct bio_integrity_payload *bip;
+ struct bio_vec *copy_vec = NULL;
+ struct iov_iter iter;
+ void *buf;
+ int ret;
+
+ /* if bvec is on the stack, we need to allocate a copy for the completion */
+ if (nr_vecs <= UIO_FASTIOV) {
+ copy_vec = kcalloc(sizeof(*bvec), nr_vecs, GFP_KERNEL);
+ if (!copy_vec)
+ return -ENOMEM;
+ memcpy(copy_vec, bvec, nr_vecs * sizeof(*bvec));
+ }
+
+ buf = kmalloc(len, GFP_KERNEL);
+ if (!buf)
+ goto free_copy;
+
+ if (direction == ITER_SOURCE) {
+ iov_iter_bvec(&iter, direction, bvec, nr_vecs, len);
+ if (!copy_from_iter_full(buf, len, &iter)) {
+ ret = -EFAULT;
+ goto free_buf;
+ }
+ } else {
+ memset(buf, 0, len);
+ }
+
+ /*
+ * We just need one vec for this bip, but we need to preserve the
+ * number of vecs in the user bvec for the completion handling, so use
+ * nr_vecs.
+ */
+ bip = bio_integrity_alloc(bio, GFP_KERNEL, nr_vecs);
+ if (IS_ERR(bip)) {
+ ret = PTR_ERR(bip);
+ goto free_buf;
+ }
+
+ ret = bio_integrity_add_page(bio, virt_to_page(buf), len,
+ offset_in_page(buf));
+ if (ret != len) {
+ ret = -ENOMEM;
+ goto free_bip;
+ }
+
+ bip->bip_flags |= BIP_INTEGRITY_USER;
+ bip->copy_vec = copy_vec ?: bvec;
+ return 0;
+free_bip:
+ bio_integrity_free(bio);
+free_buf:
+ kfree(buf);
+free_copy:
+ kfree(copy_vec);
+ return ret;
+}
+
+int bio_integrity_map_user(struct bio *bio, void __user *ubuf, unsigned int len,
+ u32 seed)
+{
+ struct request_queue *q = bdev_get_queue(bio->bi_bdev);
+ unsigned long offs, align = q->dma_pad_mask | queue_dma_alignment(q);
+ int ret, direction, nr_vecs, i, j, folios = 0;
+ struct bio_vec stack_vec[UIO_FASTIOV];
+ struct bio_vec bv, *bvec = stack_vec;
+ struct page *stack_pages[UIO_FASTIOV];
+ struct page **pages = stack_pages;
+ struct bio_integrity_payload *bip;
+ struct iov_iter iter;
+ struct bvec_iter bi;
+ u32 bytes;
+
+ if (bio_integrity(bio))
+ return -EINVAL;
+ if (len >> SECTOR_SHIFT > queue_max_hw_sectors(q))
+ return -E2BIG;
+
+ if (bio_data_dir(bio) == READ)
+ direction = ITER_DEST;
+ else
+ direction = ITER_SOURCE;
+
+ iov_iter_ubuf(&iter, direction, ubuf, len);
+ nr_vecs = iov_iter_npages(&iter, BIO_MAX_VECS + 1);
+ if (nr_vecs > BIO_MAX_VECS)
+ return -E2BIG;
+ if (nr_vecs > UIO_FASTIOV) {
+ bvec = kcalloc(sizeof(*bvec), nr_vecs, GFP_KERNEL);
+ if (!bvec)
+ return -ENOMEM;
+ pages = NULL;
+ }
+
+ bytes = iov_iter_extract_pages(&iter, &pages, len, nr_vecs, 0, &offs);
+ if (unlikely(bytes < 0)) {
+ ret = bytes;
+ goto free_bvec;
+ }
+
+ for (i = 0; i < nr_vecs; i = j) {
+ size_t size = min_t(size_t, bytes, PAGE_SIZE - offs);
+ struct folio *folio = page_folio(pages[i]);
+
+ bytes -= size;
+ for (j = i + 1; j < nr_vecs; j++) {
+ size_t next = min_t(size_t, PAGE_SIZE, bytes);
+
+ if (page_folio(pages[j]) != folio ||
+ pages[j] != pages[j - 1] + 1)
+ break;
+ unpin_user_page(pages[j]);
+ size += next;
+ bytes -= next;
+ }
+
+ bvec_set_page(&bvec[folios], pages[i], size, offs);
+ offs = 0;
+ folios++;
+ }
+
+ if (pages != stack_pages)
+ kvfree(pages);
+
+ if (folios > queue_max_integrity_segments(q) ||
+ !iov_iter_is_aligned(&iter, align, align)) {
+ ret = bio_integrity_copy_user(bio, bvec, folios, len,
+ direction, seed);
+ if (ret)
+ goto release_pages;
+ return 0;
+ }
+
+ bip = bio_integrity_alloc(bio, GFP_KERNEL, folios);
+ if (IS_ERR(bip)) {
+ ret = PTR_ERR(bip);
+ goto release_pages;
+ }
+
+ memcpy(bip->bip_vec, bvec, folios * sizeof(*bvec));
+ if (bvec != stack_vec)
+ kfree(bvec);
+
+ bip->bip_flags |= BIP_INTEGRITY_USER;
+ bip->copy_vec = NULL;
+ return 0;
+
+release_pages:
+ bi.bi_size = len;
+ for_each_bvec(bv, bvec, bi, bi)
+ unpin_user_page(bv.bv_page);
+free_bvec:
+ if (bvec != stack_vec)
+ kfree(bvec);
+ return ret;
+}
+EXPORT_SYMBOL_GPL(bio_integrity_map_user);
+
/**
* bio_integrity_process - Process integrity metadata for a bio
* @bio: bio to generate/verify integrity metadata for
diff --git a/include/linux/bio.h b/include/linux/bio.h
index 41d417ee13499..2b4a0de838ed1 100644
--- a/include/linux/bio.h
+++ b/include/linux/bio.h
@@ -324,6 +324,7 @@ enum bip_flags {
BIP_CTRL_NOCHECK = 1 << 2, /* disable HBA integrity checking */
BIP_DISK_NOCHECK = 1 << 3, /* disable disk integrity checking */
BIP_IP_CHECKSUM = 1 << 4, /* IP checksum */
+ BIP_INTEGRITY_USER = 1 << 5, /* Integrity payload is user address */
};

/*
@@ -342,6 +343,7 @@ struct bio_integrity_payload {

struct work_struct bip_work; /* I/O completion */

+ struct bio_vec *copy_vec; /* for bounce buffering */
struct bio_vec *bip_vec;
struct bio_vec bip_inline_vecs[];/* embedded bvec array */
};
@@ -720,6 +722,7 @@ static inline bool bioset_initialized(struct bio_set *bs)

extern struct bio_integrity_payload *bio_integrity_alloc(struct bio *, gfp_t, unsigned int);
extern int bio_integrity_add_page(struct bio *, struct page *, unsigned int, unsigned int);
+extern int bio_integrity_map_user(struct bio *, void __user *, unsigned int, u32);
extern bool bio_integrity_prep(struct bio *);
extern void bio_integrity_advance(struct bio *, unsigned int);
extern void bio_integrity_trim(struct bio *);
@@ -789,6 +792,12 @@ static inline int bio_integrity_add_page(struct bio *bio, struct page *page,
return 0;
}

+static inline int bio_integrity_map_user(struct bio *bio, void __user *ubuf,
+ unsigned int len, u32 seed)
+{
+ return -EINVAL
+}
+
#endif /* CONFIG_BLK_DEV_INTEGRITY */

/*
--
2.34.1