block/bio-integrity.c

   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/blkdev.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
  17 static struct kmem_cache *bip_slab;
  18 static struct workqueue_struct *kintegrityd_wq;
  19
  20 void blk_flush_integrity(void)
  21 {
  22         flush_workqueue(kintegrityd_wq);
  23 }
  24
  25 static 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  */
  48 struct 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         if (nr_vecs > inline_vecs) {
  73                 bip->bip_max_vcnt = nr_vecs;
  74                 bip->bip_vec = bvec_alloc(&bs->bvec_integrity_pool,
  75                                           &bip->bip_max_vcnt, gfp_mask);
  76                 if (!bip->bip_vec)
  77                         goto err;
  78         } else {
  79                 bip->bip_vec = bip->bip_inline_vecs;
  80                 bip->bip_max_vcnt = inline_vecs;
  81         }
  82
  83         bip->bip_bio = bio;
  84         bio->bi_integrity = bip;
  85         bio->bi_opf |= REQ_INTEGRITY;
  86
  87         return bip;
  88 err:
  89         __bio_integrity_free(bs, bip);
  90         return ERR_PTR(-ENOMEM);
  91 }
  92 EXPORT_SYMBOL(bio_integrity_alloc);
  93
  94 /**
  95  * bio_integrity_free - Free bio integrity payload
  96  * @bio:        bio containing bip to be freed
  97  *
  98  * Description: Used to free the integrity portion of a bio. Usually
  99  * called from bio_free().
 100  */
 101 void bio_integrity_free(struct bio *bio)
 102 {
 103         struct bio_integrity_payload *bip = bio_integrity(bio);
 104         struct bio_set *bs = bio->bi_pool;
 105
 106         if (bip->bip_flags & BIP_BLOCK_INTEGRITY)
 107                 kfree(page_address(bip->bip_vec->bv_page) +
 108                       bip->bip_vec->bv_offset);
 109
 110         __bio_integrity_free(bs, bip);
 111         bio->bi_integrity = NULL;
 112         bio->bi_opf &= ~REQ_INTEGRITY;
 113 }
 114
 115 /**
 116  * bio_integrity_add_page - Attach integrity metadata
 117  * @bio:        bio to update
 118  * @page:       page containing integrity metadata
 119  * @len:        number of bytes of integrity metadata in page
 120  * @offset:     start offset within page
 121  *
 122  * Description: Attach a page containing integrity metadata to bio.
 123  */
 124 int bio_integrity_add_page(struct bio *bio, struct page *page,
 125                            unsigned int len, unsigned int offset)
 126 {
 127         struct bio_integrity_payload *bip = bio_integrity(bio);
 128         struct bio_vec *iv;
 129
 130         if (bip->bip_vcnt >= bip->bip_max_vcnt) {
 131                 printk(KERN_ERR "%s: bip_vec full\n", __func__);
 132                 return 0;
 133         }
 134
 135         iv = bip->bip_vec + bip->bip_vcnt;
 136
 137         if (bip->bip_vcnt &&
 138             bvec_gap_to_prev(bio->bi_bdev->bd_disk->queue,
 139                              &bip->bip_vec[bip->bip_vcnt - 1], offset))
 140                 return 0;
 141
 142         iv->bv_page = page;
 143         iv->bv_len = len;
 144         iv->bv_offset = offset;
 145         bip->bip_vcnt++;
 146
 147         return len;
 148 }
 149 EXPORT_SYMBOL(bio_integrity_add_page);
 150
 151 /**
 152  * bio_integrity_process - Process integrity metadata for a bio
 153  * @bio:        bio to generate/verify integrity metadata for
 154  * @proc_iter:  iterator to process
 155  * @proc_fn:    Pointer to the relevant processing function
 156  */
 157 static blk_status_t bio_integrity_process(struct bio *bio,
 158                 struct bvec_iter *proc_iter, integrity_processing_fn *proc_fn)
 159 {
 160         struct blk_integrity *bi = blk_get_integrity(bio->bi_bdev->bd_disk);
 161         struct blk_integrity_iter iter;
 162         struct bvec_iter bviter;
 163         struct bio_vec bv;
 164         struct bio_integrity_payload *bip = bio_integrity(bio);
 165         blk_status_t ret = BLK_STS_OK;
 166         void *prot_buf = page_address(bip->bip_vec->bv_page) +
 167                 bip->bip_vec->bv_offset;
 168
 169         iter.disk_name = bio->bi_bdev->bd_disk->disk_name;
 170         iter.interval = 1 << bi->interval_exp;
 171         iter.seed = proc_iter->bi_sector;
 172         iter.prot_buf = prot_buf;
 173
 174         __bio_for_each_segment(bv, bio, bviter, *proc_iter) {
 175                 void *kaddr = bvec_kmap_local(&bv);
 176
 177                 iter.data_buf = kaddr;
 178                 iter.data_size = bv.bv_len;
 179                 ret = proc_fn(&iter);
 180                 kunmap_local(kaddr);
 181
 182                 if (ret)
 183                         break;
 184
 185         }
 186         return ret;
 187 }
 188
 189 /**
 190  * bio_integrity_prep - Prepare bio for integrity I/O
 191  * @bio:        bio to prepare
 192  *
 193  * Description:  Checks if the bio already has an integrity payload attached.
 194  * If it does, the payload has been generated by another kernel subsystem,
 195  * and we just pass it through. Otherwise allocates integrity payload.
 196  * The bio must have data direction, target device and start sector set priot
 197  * to calling.  In the WRITE case, integrity metadata will be generated using
 198  * the block device's integrity function.  In the READ case, the buffer
 199  * will be prepared for DMA and a suitable end_io handler set up.
 200  */
 201 bool bio_integrity_prep(struct bio *bio)
 202 {
 203         struct bio_integrity_payload *bip;
 204         struct blk_integrity *bi = blk_get_integrity(bio->bi_bdev->bd_disk);
 205         void *buf;
 206         unsigned long start, end;
 207         unsigned int len, nr_pages;
 208         unsigned int bytes, offset, i;
 209         unsigned int intervals;
 210         blk_status_t status;
 211
 212         if (!bi)
 213                 return true;
 214
 215         if (bio_op(bio) != REQ_OP_READ && bio_op(bio) != REQ_OP_WRITE)
 216                 return true;
 217
 218         if (!bio_sectors(bio))
 219                 return true;
 220
 221         /* Already protected? */
 222         if (bio_integrity(bio))
 223                 return true;
 224
 225         if (bio_data_dir(bio) == READ) {
 226                 if (!bi->profile->verify_fn ||
 227                     !(bi->flags & BLK_INTEGRITY_VERIFY))
 228                         return true;
 229         } else {
 230                 if (!bi->profile->generate_fn ||
 231                     !(bi->flags & BLK_INTEGRITY_GENERATE))
 232                         return true;
 233         }
 234         intervals = bio_integrity_intervals(bi, bio_sectors(bio));
 235
 236         /* Allocate kernel buffer for protection data */
 237         len = intervals * bi->tuple_size;
 238         buf = kmalloc(len, GFP_NOIO);
 239         status = BLK_STS_RESOURCE;
 240         if (unlikely(buf == NULL)) {
 241                 printk(KERN_ERR "could not allocate integrity buffer\n");
 242                 goto err_end_io;
 243         }
 244
 245         end = (((unsigned long) buf) + len + PAGE_SIZE - 1) >> PAGE_SHIFT;
 246         start = ((unsigned long) buf) >> PAGE_SHIFT;
 247         nr_pages = end - start;
 248
 249         /* Allocate bio integrity payload and integrity vectors */
 250         bip = bio_integrity_alloc(bio, GFP_NOIO, nr_pages);
 251         if (IS_ERR(bip)) {
 252                 printk(KERN_ERR "could not allocate data integrity bioset\n");
 253                 kfree(buf);
 254                 status = BLK_STS_RESOURCE;
 255                 goto err_end_io;
 256         }
 257
 258         bip->bip_flags |= BIP_BLOCK_INTEGRITY;
 259         bip->bip_iter.bi_size = len;
 260         bip_set_seed(bip, bio->bi_iter.bi_sector);
 261
 262         if (bi->flags & BLK_INTEGRITY_IP_CHECKSUM)
 263                 bip->bip_flags |= BIP_IP_CHECKSUM;
 264
 265         /* Map it */
 266         offset = offset_in_page(buf);
 267         for (i = 0 ; i < nr_pages ; i++) {
 268                 int ret;
 269                 bytes = PAGE_SIZE - offset;
 270
 271                 if (len <= 0)
 272                         break;
 273
 274                 if (bytes > len)
 275                         bytes = len;
 276
 277                 ret = bio_integrity_add_page(bio, virt_to_page(buf),
 278                                              bytes, offset);
 279
 280                 if (ret == 0) {
 281                         printk(KERN_ERR "could not attach integrity payload\n");
 282                         status = BLK_STS_RESOURCE;
 283                         goto err_end_io;
 284                 }
 285
 286                 if (ret < bytes)
 287                         break;
 288
 289                 buf += bytes;
 290                 len -= bytes;
 291                 offset = 0;
 292         }
 293
 294         /* Auto-generate integrity metadata if this is a write */
 295         if (bio_data_dir(bio) == WRITE) {
 296                 bio_integrity_process(bio, &bio->bi_iter,
 297                                       bi->profile->generate_fn);
 298         } else {
 299                 bip->bio_iter = bio->bi_iter;
 300         }
 301         return true;
 302
 303 err_end_io:
 304         bio->bi_status = status;
 305         bio_endio(bio);
 306         return false;
 307
 308 }
 309 EXPORT_SYMBOL(bio_integrity_prep);
 310
 311 /**
 312  * bio_integrity_verify_fn - Integrity I/O completion worker
 313  * @work:       Work struct stored in bio to be verified
 314  *
 315  * Description: This workqueue function is called to complete a READ
 316  * request.  The function verifies the transferred integrity metadata
 317  * and then calls the original bio end_io function.
 318  */
 319 static void bio_integrity_verify_fn(struct work_struct *work)
 320 {
 321         struct bio_integrity_payload *bip =
 322                 container_of(work, struct bio_integrity_payload, bip_work);
 323         struct bio *bio = bip->bip_bio;
 324         struct blk_integrity *bi = blk_get_integrity(bio->bi_bdev->bd_disk);
 325
 326         /*
 327          * At the moment verify is called bio's iterator was advanced
 328          * during split and completion, we need to rewind iterator to
 329          * it's original position.
 330          */
 331         bio->bi_status = bio_integrity_process(bio, &bip->bio_iter,
 332                                                 bi->profile->verify_fn);
 333         bio_integrity_free(bio);
 334         bio_endio(bio);
 335 }
 336
 337 /**
 338  * __bio_integrity_endio - Integrity I/O completion function
 339  * @bio:        Protected bio
 340  *
 341  * Description: Completion for integrity I/O
 342  *
 343  * Normally I/O completion is done in interrupt context.  However,
 344  * verifying I/O integrity is a time-consuming task which must be run
 345  * in process context.  This function postpones completion
 346  * accordingly.
 347  */
 348 bool __bio_integrity_endio(struct bio *bio)
 349 {
 350         struct blk_integrity *bi = blk_get_integrity(bio->bi_bdev->bd_disk);
 351         struct bio_integrity_payload *bip = bio_integrity(bio);
 352
 353         if (bio_op(bio) == REQ_OP_READ && !bio->bi_status &&
 354             (bip->bip_flags & BIP_BLOCK_INTEGRITY) && bi->profile->verify_fn) {
 355                 INIT_WORK(&bip->bip_work, bio_integrity_verify_fn);
 356                 queue_work(kintegrityd_wq, &bip->bip_work);
 357                 return false;
 358         }
 359
 360         bio_integrity_free(bio);
 361         return true;
 362 }
 363
 364 /**
 365  * bio_integrity_advance - Advance integrity vector
 366  * @bio:        bio whose integrity vector to update
 367  * @bytes_done: number of data bytes that have been completed
 368  *
 369  * Description: This function calculates how many integrity bytes the
 370  * number of completed data bytes correspond to and advances the
 371  * integrity vector accordingly.
 372  */
 373 void bio_integrity_advance(struct bio *bio, unsigned int bytes_done)
 374 {
 375         struct bio_integrity_payload *bip = bio_integrity(bio);
 376         struct blk_integrity *bi = blk_get_integrity(bio->bi_bdev->bd_disk);
 377         unsigned bytes = bio_integrity_bytes(bi, bytes_done >> 9);
 378
 379         bip->bip_iter.bi_sector += bytes_done >> 9;
 380         bvec_iter_advance(bip->bip_vec, &bip->bip_iter, bytes);
 381 }
 382
 383 /**
 384  * bio_integrity_trim - Trim integrity vector
 385  * @bio:        bio whose integrity vector to update
 386  *
 387  * Description: Used to trim the integrity vector in a cloned bio.
 388  */
 389 void bio_integrity_trim(struct bio *bio)
 390 {
 391         struct bio_integrity_payload *bip = bio_integrity(bio);
 392         struct blk_integrity *bi = blk_get_integrity(bio->bi_bdev->bd_disk);
 393
 394         bip->bip_iter.bi_size = bio_integrity_bytes(bi, bio_sectors(bio));
 395 }
 396 EXPORT_SYMBOL(bio_integrity_trim);
 397
 398 /**
 399  * bio_integrity_clone - Callback for cloning bios with integrity metadata
 400  * @bio:        New bio
 401  * @bio_src:    Original bio
 402  * @gfp_mask:   Memory allocation mask
 403  *
 404  * Description: Called to allocate a bip when cloning a bio
 405  */
 406 int bio_integrity_clone(struct bio *bio, struct bio *bio_src,
 407                         gfp_t gfp_mask)
 408 {
 409         struct bio_integrity_payload *bip_src = bio_integrity(bio_src);
 410         struct bio_integrity_payload *bip;
 411
 412         BUG_ON(bip_src == NULL);
 413
 414         bip = bio_integrity_alloc(bio, gfp_mask, bip_src->bip_vcnt);
 415         if (IS_ERR(bip))
 416                 return PTR_ERR(bip);
 417
 418         memcpy(bip->bip_vec, bip_src->bip_vec,
 419                bip_src->bip_vcnt * sizeof(struct bio_vec));
 420
 421         bip->bip_vcnt = bip_src->bip_vcnt;
 422         bip->bip_iter = bip_src->bip_iter;
 423
 424         return 0;
 425 }
 426 EXPORT_SYMBOL(bio_integrity_clone);
 427
 428 int bioset_integrity_create(struct bio_set *bs, int pool_size)
 429 {
 430         if (mempool_initialized(&bs->bio_integrity_pool))
 431                 return 0;
 432
 433         if (mempool_init_slab_pool(&bs->bio_integrity_pool,
 434                                    pool_size, bip_slab))
 435                 return -1;
 436
 437         if (biovec_init_pool(&bs->bvec_integrity_pool, pool_size)) {
 438                 mempool_exit(&bs->bio_integrity_pool);
 439                 return -1;
 440         }
 441
 442         return 0;
 443 }
 444 EXPORT_SYMBOL(bioset_integrity_create);
 445
 446 void bioset_integrity_free(struct bio_set *bs)
 447 {
 448         mempool_exit(&bs->bio_integrity_pool);
 449         mempool_exit(&bs->bvec_integrity_pool);
 450 }
 451
 452 void __init bio_integrity_init(void)
 453 {
 454         /*
 455          * kintegrityd won't block much but may burn a lot of CPU cycles.
 456          * Make it highpri CPU intensive wq with max concurrency of 1.
 457          */
 458         kintegrityd_wq = alloc_workqueue("kintegrityd", WQ_MEM_RECLAIM |
 459                                          WQ_HIGHPRI | WQ_CPU_INTENSIVE, 1);
 460         if (!kintegrityd_wq)
 461                 panic("Failed to create kintegrityd\n");
 462
 463         bip_slab = kmem_cache_create("bio_integrity_payload",
 464                                      sizeof(struct bio_integrity_payload) +
 465                                      sizeof(struct bio_vec) * BIO_INLINE_VECS,
 466                                      0, SLAB_HWCACHE_ALIGN|SLAB_PANIC, NULL);
 467 }