block/bio-integrity.c

   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 #include "blk.h"
  30
  31 #define BIP_INLINE_VECS 4
  32
  33 static struct kmem_cache *bip_slab;
  34 static struct workqueue_struct *kintegrityd_wq;
  35
  36 void blk_flush_integrity(void)
  37 {
  38         flush_workqueue(kintegrityd_wq);
  39 }
  40
  41 /**
  42  * bio_integrity_alloc - Allocate integrity payload and attach it to bio
  43  * @bio:        bio to attach integrity metadata to
  44  * @gfp_mask:   Memory allocation mask
  45  * @nr_vecs:    Number of integrity metadata scatter-gather elements
  46  *
  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  */
  51 struct bio_integrity_payload *bio_integrity_alloc(struct bio *bio,
  52                                                   gfp_t gfp_mask,
  53                                                   unsigned int nr_vecs)
  54 {
  55         struct bio_integrity_payload *bip;
  56         struct bio_set *bs = bio->bi_pool;
  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                 unsigned long idx = 0;
  75
  76                 bip->bip_vec = bvec_alloc(gfp_mask, nr_vecs, &idx,
  77                                           bs->bvec_integrity_pool);
  78                 if (!bip->bip_vec)
  79                         goto err;
  80                 bip->bip_max_vcnt = bvec_nr_vecs(idx);
  81                 bip->bip_slab = idx;
  82         } else {
  83                 bip->bip_vec = bip->bip_inline_vecs;
  84                 bip->bip_max_vcnt = inline_vecs;
  85         }
  86
  87         bip->bip_bio = bio;
  88         bio->bi_integrity = bip;
  89         bio->bi_opf |= REQ_INTEGRITY;
  90
  91         return bip;
  92 err:
  93         mempool_free(bip, bs->bio_integrity_pool);
  94         return ERR_PTR(-ENOMEM);
  95 }
  96 EXPORT_SYMBOL(bio_integrity_alloc);
  97
  98 /**
  99  * bio_integrity_free - Free bio integrity payload
 100  * @bio:        bio containing bip to be freed
 101  *
 102  * Description: Used to free the integrity portion of a bio. Usually
 103  * called from bio_free().
 104  */
 105 void bio_integrity_free(struct bio *bio)
 106 {
 107         struct bio_integrity_payload *bip = bio_integrity(bio);
 108         struct bio_set *bs = bio->bi_pool;
 109
 110         if (bip->bip_flags & BIP_BLOCK_INTEGRITY)
 111                 kfree(page_address(bip->bip_vec->bv_page) +
 112                       bip->bip_vec->bv_offset);
 113
 114         if (bs && bs->bio_integrity_pool) {
 115                 bvec_free(bs->bvec_integrity_pool, bip->bip_vec, 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 }
 124 EXPORT_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  */
 135 int 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 }
 160 EXPORT_SYMBOL(bio_integrity_add_page);
 161
 162 /**
 163  * bio_integrity_intervals - Return number of integrity intervals for a bio
 164  * @bi:         blk_integrity profile for device
 165  * @sectors:    Size of the bio in 512-byte sectors
 166  *
 167  * Description: The block layer calculates everything in 512 byte
 168  * sectors but integrity metadata is done in terms of the data integrity
 169  * interval size of the storage device.  Convert the block layer sectors
 170  * to the appropriate number of integrity intervals.
 171  */
 172 static inline unsigned int bio_integrity_intervals(struct blk_integrity *bi,
 173                                                    unsigned int sectors)
 174 {
 175         return sectors >> (bi->interval_exp - 9);
 176 }
 177
 178 static inline unsigned int bio_integrity_bytes(struct blk_integrity *bi,
 179                                                unsigned int sectors)
 180 {
 181         return bio_integrity_intervals(bi, sectors) * bi->tuple_size;
 182 }
 183
 184 /**
 185  * bio_integrity_process - Process integrity metadata for a bio
 186  * @bio:        bio to generate/verify integrity metadata for
 187  * @proc_fn:    Pointer to the relevant processing function
 188  */
 189 static blk_status_t bio_integrity_process(struct bio *bio,
 190                                  integrity_processing_fn *proc_fn)
 191 {
 192         struct blk_integrity *bi = bdev_get_integrity(bio->bi_bdev);
 193         struct blk_integrity_iter iter;
 194         struct bvec_iter bviter;
 195         struct bio_vec bv;
 196         struct bio_integrity_payload *bip = bio_integrity(bio);
 197         blk_status_t ret = BLK_STS_OK;
 198         void *prot_buf = page_address(bip->bip_vec->bv_page) +
 199                 bip->bip_vec->bv_offset;
 200
 201         iter.disk_name = bio->bi_bdev->bd_disk->disk_name;
 202         iter.interval = 1 << bi->interval_exp;
 203         iter.seed = bip_get_seed(bip);
 204         iter.prot_buf = prot_buf;
 205
 206         bio_for_each_segment(bv, bio, bviter) {
 207                 void *kaddr = kmap_atomic(bv.bv_page);
 208
 209                 iter.data_buf = kaddr + bv.bv_offset;
 210                 iter.data_size = bv.bv_len;
 211
 212                 ret = proc_fn(&iter);
 213                 if (ret) {
 214                         kunmap_atomic(kaddr);
 215                         return ret;
 216                 }
 217
 218                 kunmap_atomic(kaddr);
 219         }
 220         return ret;
 221 }
 222
 223 /**
 224  * bio_integrity_prep - Prepare bio for integrity I/O
 225  * @bio:        bio to prepare
 226  *
 227  * Description:  Checks if the bio already has an integrity payload attached.
 228  * If it does, the payload has been generated by another kernel subsystem,
 229  * and we just pass it through. Otherwise allocates integrity payload.
 230  * The bio must have data direction, target device and start sector set priot
 231  * to calling.  In the WRITE case, integrity metadata will be generated using
 232  * the block device's integrity function.  In the READ case, the buffer
 233  * will be prepared for DMA and a suitable end_io handler set up.
 234  */
 235 bool bio_integrity_prep(struct bio *bio)
 236 {
 237         struct bio_integrity_payload *bip;
 238         struct blk_integrity *bi;
 239         struct request_queue *q;
 240         void *buf;
 241         unsigned long start, end;
 242         unsigned int len, nr_pages;
 243         unsigned int bytes, offset, i;
 244         unsigned int intervals;
 245         blk_status_t status;
 246
 247         bi = bdev_get_integrity(bio->bi_bdev);
 248         q = bdev_get_queue(bio->bi_bdev);
 249         if (bio_op(bio) != REQ_OP_READ && bio_op(bio) != REQ_OP_WRITE)
 250                 return true;
 251
 252         if (!bio_sectors(bio))
 253                 return true;
 254
 255         /* Already protected? */
 256         if (bio_integrity(bio))
 257                 return true;
 258
 259         if (bi == NULL)
 260                 return true;
 261
 262         if (bio_data_dir(bio) == READ) {
 263                 if (!bi->profile->verify_fn ||
 264                     !(bi->flags & BLK_INTEGRITY_VERIFY))
 265                         return true;
 266         } else {
 267                 if (!bi->profile->generate_fn ||
 268                     !(bi->flags & BLK_INTEGRITY_GENERATE))
 269                         return true;
 270         }
 271         intervals = bio_integrity_intervals(bi, bio_sectors(bio));
 272
 273         /* Allocate kernel buffer for protection data */
 274         len = intervals * bi->tuple_size;
 275         buf = kmalloc(len, GFP_NOIO | q->bounce_gfp);
 276         status = BLK_STS_RESOURCE;
 277         if (unlikely(buf == NULL)) {
 278                 printk(KERN_ERR "could not allocate integrity buffer\n");
 279                 goto err_end_io;
 280         }
 281
 282         end = (((unsigned long) buf) + len + PAGE_SIZE - 1) >> PAGE_SHIFT;
 283         start = ((unsigned long) buf) >> PAGE_SHIFT;
 284         nr_pages = end - start;
 285
 286         /* Allocate bio integrity payload and integrity vectors */
 287         bip = bio_integrity_alloc(bio, GFP_NOIO, nr_pages);
 288         if (IS_ERR(bip)) {
 289                 printk(KERN_ERR "could not allocate data integrity bioset\n");
 290                 kfree(buf);
 291                 status = BLK_STS_RESOURCE;
 292                 goto err_end_io;
 293         }
 294
 295         bip->bip_flags |= BIP_BLOCK_INTEGRITY;
 296         bip->bip_iter.bi_size = len;
 297         bip_set_seed(bip, bio->bi_iter.bi_sector);
 298
 299         if (bi->flags & BLK_INTEGRITY_IP_CHECKSUM)
 300                 bip->bip_flags |= BIP_IP_CHECKSUM;
 301
 302         /* Map it */
 303         offset = offset_in_page(buf);
 304         for (i = 0 ; i < nr_pages ; i++) {
 305                 int ret;
 306                 bytes = PAGE_SIZE - offset;
 307
 308                 if (len <= 0)
 309                         break;
 310
 311                 if (bytes > len)
 312                         bytes = len;
 313
 314                 ret = bio_integrity_add_page(bio, virt_to_page(buf),
 315                                              bytes, offset);
 316
 317                 if (ret == 0)
 318                         return 0;
 319
 320                 if (ret < bytes)
 321                         break;
 322
 323                 buf += bytes;
 324                 len -= bytes;
 325                 offset = 0;
 326         }
 327
 328         /* Install custom I/O completion handler if read verify is enabled */
 329         if (bio_data_dir(bio) == READ) {
 330                 bip->bip_end_io = bio->bi_end_io;
 331                 bio->bi_end_io = bio_integrity_endio;
 332         }
 333
 334         /* Auto-generate integrity metadata if this is a write */
 335         if (bio_data_dir(bio) == WRITE)
 336                 bio_integrity_process(bio, bi->profile->generate_fn);
 337         return true;
 338
 339 err_end_io:
 340         bio->bi_status = status;
 341         bio_endio(bio);
 342         return false;
 343
 344 }
 345 EXPORT_SYMBOL(bio_integrity_prep);
 346
 347 /**
 348  * bio_integrity_verify_fn - Integrity I/O completion worker
 349  * @work:       Work struct stored in bio to be verified
 350  *
 351  * Description: This workqueue function is called to complete a READ
 352  * request.  The function verifies the transferred integrity metadata
 353  * and then calls the original bio end_io function.
 354  */
 355 static void bio_integrity_verify_fn(struct work_struct *work)
 356 {
 357         struct bio_integrity_payload *bip =
 358                 container_of(work, struct bio_integrity_payload, bip_work);
 359         struct bio *bio = bip->bip_bio;
 360         struct blk_integrity *bi = bdev_get_integrity(bio->bi_bdev);
 361
 362         bio->bi_status = bio_integrity_process(bio, bi->profile->verify_fn);
 363
 364         /* Restore original bio completion handler */
 365         bio->bi_end_io = bip->bip_end_io;
 366         bio_endio(bio);
 367 }
 368
 369 /**
 370  * bio_integrity_endio - Integrity I/O completion function
 371  * @bio:        Protected bio
 372  * @error:      Pointer to errno
 373  *
 374  * Description: Completion for integrity I/O
 375  *
 376  * Normally I/O completion is done in interrupt context.  However,
 377  * verifying I/O integrity is a time-consuming task which must be run
 378  * in process context.  This function postpones completion
 379  * accordingly.
 380  */
 381 void bio_integrity_endio(struct bio *bio)
 382 {
 383         struct bio_integrity_payload *bip = bio_integrity(bio);
 384
 385         BUG_ON(bip->bip_bio != bio);
 386
 387         /* In case of an I/O error there is no point in verifying the
 388          * integrity metadata.  Restore original bio end_io handler
 389          * and run it.
 390          */
 391         if (bio->bi_status) {
 392                 bio->bi_end_io = bip->bip_end_io;
 393                 bio_endio(bio);
 394
 395                 return;
 396         }
 397
 398         INIT_WORK(&bip->bip_work, bio_integrity_verify_fn);
 399         queue_work(kintegrityd_wq, &bip->bip_work);
 400 }
 401 EXPORT_SYMBOL(bio_integrity_endio);
 402
 403 /**
 404  * bio_integrity_advance - Advance integrity vector
 405  * @bio:        bio whose integrity vector to update
 406  * @bytes_done: number of data bytes that have been completed
 407  *
 408  * Description: This function calculates how many integrity bytes the
 409  * number of completed data bytes correspond to and advances the
 410  * integrity vector accordingly.
 411  */
 412 void bio_integrity_advance(struct bio *bio, unsigned int bytes_done)
 413 {
 414         struct bio_integrity_payload *bip = bio_integrity(bio);
 415         struct blk_integrity *bi = bdev_get_integrity(bio->bi_bdev);
 416         unsigned bytes = bio_integrity_bytes(bi, bytes_done >> 9);
 417
 418         bip->bip_iter.bi_sector += bytes_done >> 9;
 419         bvec_iter_advance(bip->bip_vec, &bip->bip_iter, bytes);
 420 }
 421 EXPORT_SYMBOL(bio_integrity_advance);
 422
 423 /**
 424  * bio_integrity_trim - Trim integrity vector
 425  * @bio:        bio whose integrity vector to update
 426  *
 427  * Description: Used to trim the integrity vector in a cloned bio.
 428  */
 429 void bio_integrity_trim(struct bio *bio)
 430 {
 431         struct bio_integrity_payload *bip = bio_integrity(bio);
 432         struct blk_integrity *bi = bdev_get_integrity(bio->bi_bdev);
 433
 434         bip->bip_iter.bi_size = bio_integrity_bytes(bi, bio_sectors(bio));
 435 }
 436 EXPORT_SYMBOL(bio_integrity_trim);
 437
 438 /**
 439  * bio_integrity_clone - Callback for cloning bios with integrity metadata
 440  * @bio:        New bio
 441  * @bio_src:    Original bio
 442  * @gfp_mask:   Memory allocation mask
 443  *
 444  * Description: Called to allocate a bip when cloning a bio
 445  */
 446 int bio_integrity_clone(struct bio *bio, struct bio *bio_src,
 447                         gfp_t gfp_mask)
 448 {
 449         struct bio_integrity_payload *bip_src = bio_integrity(bio_src);
 450         struct bio_integrity_payload *bip;
 451
 452         BUG_ON(bip_src == NULL);
 453
 454         bip = bio_integrity_alloc(bio, gfp_mask, bip_src->bip_vcnt);
 455         if (IS_ERR(bip))
 456                 return PTR_ERR(bip);
 457
 458         memcpy(bip->bip_vec, bip_src->bip_vec,
 459                bip_src->bip_vcnt * sizeof(struct bio_vec));
 460
 461         bip->bip_vcnt = bip_src->bip_vcnt;
 462         bip->bip_iter = bip_src->bip_iter;
 463
 464         return 0;
 465 }
 466 EXPORT_SYMBOL(bio_integrity_clone);
 467
 468 int bioset_integrity_create(struct bio_set *bs, int pool_size)
 469 {
 470         if (bs->bio_integrity_pool)
 471                 return 0;
 472
 473         bs->bio_integrity_pool = mempool_create_slab_pool(pool_size, bip_slab);
 474         if (!bs->bio_integrity_pool)
 475                 return -1;
 476
 477         bs->bvec_integrity_pool = biovec_create_pool(pool_size);
 478         if (!bs->bvec_integrity_pool) {
 479                 mempool_destroy(bs->bio_integrity_pool);
 480                 return -1;
 481         }
 482
 483         return 0;
 484 }
 485 EXPORT_SYMBOL(bioset_integrity_create);
 486
 487 void bioset_integrity_free(struct bio_set *bs)
 488 {
 489         if (bs->bio_integrity_pool)
 490                 mempool_destroy(bs->bio_integrity_pool);
 491
 492         if (bs->bvec_integrity_pool)
 493                 mempool_destroy(bs->bvec_integrity_pool);
 494 }
 495 EXPORT_SYMBOL(bioset_integrity_free);
 496
 497 void __init bio_integrity_init(void)
 498 {
 499         /*
 500          * kintegrityd won't block much but may burn a lot of CPU cycles.
 501          * Make it highpri CPU intensive wq with max concurrency of 1.
 502          */
 503         kintegrityd_wq = alloc_workqueue("kintegrityd", WQ_MEM_RECLAIM |
 504                                          WQ_HIGHPRI | WQ_CPU_INTENSIVE, 1);
 505         if (!kintegrityd_wq)
 506                 panic("Failed to create kintegrityd\n");
 507
 508         bip_slab = kmem_cache_create("bio_integrity_payload",
 509                                      sizeof(struct bio_integrity_payload) +
 510                                      sizeof(struct bio_vec) * BIP_INLINE_VECS,
 511                                      0, SLAB_HWCACHE_ALIGN|SLAB_PANIC, NULL);
 512 }