drivers/md/dm-io.c

   1 /*
   2  * Copyright (C) 2003 Sistina Software
   3  * Copyright (C) 2006 Red Hat GmbH
   4  *
   5  * This file is released under the GPL.
   6  */
   7
   8 #include "dm.h"
   9
  10 #include <linux/device-mapper.h>
  11
  12 #include <linux/bio.h>
  13 #include <linux/completion.h>
  14 #include <linux/mempool.h>
  15 #include <linux/module.h>
  16 #include <linux/sched.h>
  17 #include <linux/slab.h>
  18 #include <linux/dm-io.h>
  19
  20 #define DM_MSG_PREFIX "io"
  21
  22 #define DM_IO_MAX_REGIONS       BITS_PER_LONG
  23 #define MIN_IOS         16
  24 #define MIN_BIOS        16
  25
  26 struct dm_io_client {
  27         mempool_t *pool;
  28         struct bio_set *bios;
  29 };
  30
  31 /*
  32  * Aligning 'struct io' reduces the number of bits required to store
  33  * its address.  Refer to store_io_and_region_in_bio() below.
  34  */
  35 struct io {
  36         unsigned long error_bits;
  37         atomic_t count;
  38         struct completion *wait;
  39         struct dm_io_client *client;
  40         io_notify_fn callback;
  41         void *context;
  42         void *vma_invalidate_address;
  43         unsigned long vma_invalidate_size;
  44 } __attribute__((aligned(DM_IO_MAX_REGIONS)));
  45
  46 static struct kmem_cache *_dm_io_cache;
  47
  48 /*
  49  * Create a client with mempool and bioset.
  50  */
  51 struct dm_io_client *dm_io_client_create(void)
  52 {
  53         struct dm_io_client *client;
  54
  55         client = kmalloc(sizeof(*client), GFP_KERNEL);
  56         if (!client)
  57                 return ERR_PTR(-ENOMEM);
  58
  59         client->pool = mempool_create_slab_pool(MIN_IOS, _dm_io_cache);
  60         if (!client->pool)
  61                 goto bad;
  62
  63         client->bios = bioset_create(MIN_BIOS, 0);
  64         if (!client->bios)
  65                 goto bad;
  66
  67         return client;
  68
  69    bad:
  70         if (client->pool)
  71                 mempool_destroy(client->pool);
  72         kfree(client);
  73         return ERR_PTR(-ENOMEM);
  74 }
  75 EXPORT_SYMBOL(dm_io_client_create);
  76
  77 void dm_io_client_destroy(struct dm_io_client *client)
  78 {
  79         mempool_destroy(client->pool);
  80         bioset_free(client->bios);
  81         kfree(client);
  82 }
  83 EXPORT_SYMBOL(dm_io_client_destroy);
  84
  85 /*-----------------------------------------------------------------
  86  * We need to keep track of which region a bio is doing io for.
  87  * To avoid a memory allocation to store just 5 or 6 bits, we
  88  * ensure the 'struct io' pointer is aligned so enough low bits are
  89  * always zero and then combine it with the region number directly in
  90  * bi_private.
  91  *---------------------------------------------------------------*/
  92 static void store_io_and_region_in_bio(struct bio *bio, struct io *io,
  93                                        unsigned region)
  94 {
  95         if (unlikely(!IS_ALIGNED((unsigned long)io, DM_IO_MAX_REGIONS))) {
  96                 DMCRIT("Unaligned struct io pointer %p", io);
  97                 BUG();
  98         }
  99
 100         bio->bi_private = (void *)((unsigned long)io | region);
 101 }
 102
 103 static void retrieve_io_and_region_from_bio(struct bio *bio, struct io **io,
 104                                        unsigned *region)
 105 {
 106         unsigned long val = (unsigned long)bio->bi_private;
 107
 108         *io = (void *)(val & -(unsigned long)DM_IO_MAX_REGIONS);
 109         *region = val & (DM_IO_MAX_REGIONS - 1);
 110 }
 111
 112 /*-----------------------------------------------------------------
 113  * We need an io object to keep track of the number of bios that
 114  * have been dispatched for a particular io.
 115  *---------------------------------------------------------------*/
 116 static void dec_count(struct io *io, unsigned int region, int error)
 117 {
 118         if (error)
 119                 set_bit(region, &io->error_bits);
 120
 121         if (atomic_dec_and_test(&io->count)) {
 122                 if (io->vma_invalidate_size)
 123                         invalidate_kernel_vmap_range(io->vma_invalidate_address,
 124                                                      io->vma_invalidate_size);
 125
 126                 if (io->wait)
 127                         complete(io->wait);
 128
 129                 else {
 130                         unsigned long r = io->error_bits;
 131                         io_notify_fn fn = io->callback;
 132                         void *context = io->context;
 133
 134                         mempool_free(io, io->client->pool);
 135                         fn(r, context);
 136                 }
 137         }
 138 }
 139
 140 static void endio(struct bio *bio, int error)
 141 {
 142         struct io *io;
 143         unsigned region;
 144
 145         if (error && bio_data_dir(bio) == READ)
 146                 zero_fill_bio(bio);
 147
 148         /*
 149          * The bio destructor in bio_put() may use the io object.
 150          */
 151         retrieve_io_and_region_from_bio(bio, &io, &region);
 152
 153         bio_put(bio);
 154
 155         dec_count(io, region, error);
 156 }
 157
 158 /*-----------------------------------------------------------------
 159  * These little objects provide an abstraction for getting a new
 160  * destination page for io.
 161  *---------------------------------------------------------------*/
 162 struct dpages {
 163         void (*get_page)(struct dpages *dp,
 164                          struct page **p, unsigned long *len, unsigned *offset);
 165         void (*next_page)(struct dpages *dp);
 166
 167         unsigned context_u;
 168         void *context_ptr;
 169
 170         void *vma_invalidate_address;
 171         unsigned long vma_invalidate_size;
 172 };
 173
 174 /*
 175  * Functions for getting the pages from a list.
 176  */
 177 static void list_get_page(struct dpages *dp,
 178                   struct page **p, unsigned long *len, unsigned *offset)
 179 {
 180         unsigned o = dp->context_u;
 181         struct page_list *pl = (struct page_list *) dp->context_ptr;
 182
 183         *p = pl->page;
 184         *len = PAGE_SIZE - o;
 185         *offset = o;
 186 }
 187
 188 static void list_next_page(struct dpages *dp)
 189 {
 190         struct page_list *pl = (struct page_list *) dp->context_ptr;
 191         dp->context_ptr = pl->next;
 192         dp->context_u = 0;
 193 }
 194
 195 static void list_dp_init(struct dpages *dp, struct page_list *pl, unsigned offset)
 196 {
 197         dp->get_page = list_get_page;
 198         dp->next_page = list_next_page;
 199         dp->context_u = offset;
 200         dp->context_ptr = pl;
 201 }
 202
 203 /*
 204  * Functions for getting the pages from a bvec.
 205  */
 206 static void bvec_get_page(struct dpages *dp,
 207                   struct page **p, unsigned long *len, unsigned *offset)
 208 {
 209         struct bio_vec *bvec = (struct bio_vec *) dp->context_ptr;
 210         *p = bvec->bv_page;
 211         *len = bvec->bv_len;
 212         *offset = bvec->bv_offset;
 213 }
 214
 215 static void bvec_next_page(struct dpages *dp)
 216 {
 217         struct bio_vec *bvec = (struct bio_vec *) dp->context_ptr;
 218         dp->context_ptr = bvec + 1;
 219 }
 220
 221 static void bvec_dp_init(struct dpages *dp, struct bio_vec *bvec)
 222 {
 223         dp->get_page = bvec_get_page;
 224         dp->next_page = bvec_next_page;
 225         dp->context_ptr = bvec;
 226 }
 227
 228 /*
 229  * Functions for getting the pages from a VMA.
 230  */
 231 static void vm_get_page(struct dpages *dp,
 232                  struct page **p, unsigned long *len, unsigned *offset)
 233 {
 234         *p = vmalloc_to_page(dp->context_ptr);
 235         *offset = dp->context_u;
 236         *len = PAGE_SIZE - dp->context_u;
 237 }
 238
 239 static void vm_next_page(struct dpages *dp)
 240 {
 241         dp->context_ptr += PAGE_SIZE - dp->context_u;
 242         dp->context_u = 0;
 243 }
 244
 245 static void vm_dp_init(struct dpages *dp, void *data)
 246 {
 247         dp->get_page = vm_get_page;
 248         dp->next_page = vm_next_page;
 249         dp->context_u = ((unsigned long) data) & (PAGE_SIZE - 1);
 250         dp->context_ptr = data;
 251 }
 252
 253 static void dm_bio_destructor(struct bio *bio)
 254 {
 255         unsigned region;
 256         struct io *io;
 257
 258         retrieve_io_and_region_from_bio(bio, &io, &region);
 259
 260         bio_free(bio, io->client->bios);
 261 }
 262
 263 /*
 264  * Functions for getting the pages from kernel memory.
 265  */
 266 static void km_get_page(struct dpages *dp, struct page **p, unsigned long *len,
 267                         unsigned *offset)
 268 {
 269         *p = virt_to_page(dp->context_ptr);
 270         *offset = dp->context_u;
 271         *len = PAGE_SIZE - dp->context_u;
 272 }
 273
 274 static void km_next_page(struct dpages *dp)
 275 {
 276         dp->context_ptr += PAGE_SIZE - dp->context_u;
 277         dp->context_u = 0;
 278 }
 279
 280 static void km_dp_init(struct dpages *dp, void *data)
 281 {
 282         dp->get_page = km_get_page;
 283         dp->next_page = km_next_page;
 284         dp->context_u = ((unsigned long) data) & (PAGE_SIZE - 1);
 285         dp->context_ptr = data;
 286 }
 287
 288 /*-----------------------------------------------------------------
 289  * IO routines that accept a list of pages.
 290  *---------------------------------------------------------------*/
 291 static void do_region(int rw, unsigned region, struct dm_io_region *where,
 292                       struct dpages *dp, struct io *io)
 293 {
 294         struct bio *bio;
 295         struct page *page;
 296         unsigned long len;
 297         unsigned offset;
 298         unsigned num_bvecs;
 299         sector_t remaining = where->count;
 300         struct request_queue *q = bdev_get_queue(where->bdev);
 301         sector_t discard_sectors;
 302         unsigned int uninitialized_var(special_cmd_max_sectors);
 303
 304         /* Reject unsupported discard requests */
 305         if (rw & REQ_DISCARD) {
 306                 special_cmd_max_sectors = q->limits.max_discard_sectors;
 307                 if (special_cmd_max_sectors == 0) {
 308                         dec_count(io, region, -EOPNOTSUPP);
 309                         return;
 310                 }
 311         }
 312
 313         /*
 314          * where->count may be zero if rw holds a flush and we need to
 315          * send a zero-sized flush.
 316          */
 317         do {
 318                 /*
 319                  * Allocate a suitably sized-bio.
 320                  */
 321                 if (rw & REQ_DISCARD)
 322                         num_bvecs = 1;
 323                 else
 324                         num_bvecs = min_t(int, bio_get_nr_vecs(where->bdev),
 325                                           dm_sector_div_up(remaining, (PAGE_SIZE >> SECTOR_SHIFT)));
 326
 327                 bio = bio_alloc_bioset(GFP_NOIO, num_bvecs, io->client->bios);
 328                 bio->bi_sector = where->sector + (where->count - remaining);
 329                 bio->bi_bdev = where->bdev;
 330                 bio->bi_end_io = endio;
 331                 bio->bi_destructor = dm_bio_destructor;
 332                 store_io_and_region_in_bio(bio, io, region);
 333
 334                 if (rw & REQ_DISCARD) {
 335                         discard_sectors = min_t(sector_t, special_cmd_max_sectors, remaining);
 336                         bio->bi_size = discard_sectors << SECTOR_SHIFT;
 337                         remaining -= discard_sectors;
 338                 } else while (remaining) {
 339                         /*
 340                          * Try and add as many pages as possible.
 341                          */
 342                         dp->get_page(dp, &page, &len, &offset);
 343                         len = min(len, to_bytes(remaining));
 344                         if (!bio_add_page(bio, page, len, offset))
 345                                 break;
 346
 347                         offset = 0;
 348                         remaining -= to_sector(len);
 349                         dp->next_page(dp);
 350                 }
 351
 352                 atomic_inc(&io->count);
 353                 submit_bio(rw, bio);
 354         } while (remaining);
 355 }
 356
 357 static void dispatch_io(int rw, unsigned int num_regions,
 358                         struct dm_io_region *where, struct dpages *dp,
 359                         struct io *io, int sync)
 360 {
 361         int i;
 362         struct dpages old_pages = *dp;
 363
 364         BUG_ON(num_regions > DM_IO_MAX_REGIONS);
 365
 366         if (sync)
 367                 rw |= REQ_SYNC;
 368
 369         /*
 370          * For multiple regions we need to be careful to rewind
 371          * the dp object for each call to do_region.
 372          */
 373         for (i = 0; i < num_regions; i++) {
 374                 *dp = old_pages;
 375                 if (where[i].count || (rw & REQ_FLUSH))
 376                         do_region(rw, i, where + i, dp, io);
 377         }
 378
 379         /*
 380          * Drop the extra reference that we were holding to avoid
 381          * the io being completed too early.
 382          */
 383         dec_count(io, 0, 0);
 384 }
 385
 386 static int sync_io(struct dm_io_client *client, unsigned int num_regions,
 387                    struct dm_io_region *where, int rw, struct dpages *dp,
 388                    unsigned long *error_bits)
 389 {
 390         /*
 391          * gcc <= 4.3 can't do the alignment for stack variables, so we must
 392          * align it on our own.
 393          * volatile prevents the optimizer from removing or reusing
 394          * "io_" field from the stack frame (allowed in ANSI C).
 395          */
 396         volatile char io_[sizeof(struct io) + __alignof__(struct io) - 1];
 397         struct io *io = (struct io *)PTR_ALIGN(&io_, __alignof__(struct io));
 398         DECLARE_COMPLETION_ONSTACK(wait);
 399
 400         if (num_regions > 1 && (rw & RW_MASK) != WRITE) {
 401                 WARN_ON(1);
 402                 return -EIO;
 403         }
 404
 405         io->error_bits = 0;
 406         atomic_set(&io->count, 1); /* see dispatch_io() */
 407         io->wait = &wait;
 408         io->client = client;
 409
 410         io->vma_invalidate_address = dp->vma_invalidate_address;
 411         io->vma_invalidate_size = dp->vma_invalidate_size;
 412
 413         dispatch_io(rw, num_regions, where, dp, io, 1);
 414
 415         wait_for_completion(&wait);
 416
 417         if (error_bits)
 418                 *error_bits = io->error_bits;
 419
 420         return io->error_bits ? -EIO : 0;
 421 }
 422
 423 static int async_io(struct dm_io_client *client, unsigned int num_regions,
 424                     struct dm_io_region *where, int rw, struct dpages *dp,
 425                     io_notify_fn fn, void *context)
 426 {
 427         struct io *io;
 428
 429         if (num_regions > 1 && (rw & RW_MASK) != WRITE) {
 430                 WARN_ON(1);
 431                 fn(1, context);
 432                 return -EIO;
 433         }
 434
 435         io = mempool_alloc(client->pool, GFP_NOIO);
 436         io->error_bits = 0;
 437         atomic_set(&io->count, 1); /* see dispatch_io() */
 438         io->wait = NULL;
 439         io->client = client;
 440         io->callback = fn;
 441         io->context = context;
 442
 443         io->vma_invalidate_address = dp->vma_invalidate_address;
 444         io->vma_invalidate_size = dp->vma_invalidate_size;
 445
 446         dispatch_io(rw, num_regions, where, dp, io, 0);
 447         return 0;
 448 }
 449
 450 static int dp_init(struct dm_io_request *io_req, struct dpages *dp,
 451                    unsigned long size)
 452 {
 453         /* Set up dpages based on memory type */
 454
 455         dp->vma_invalidate_address = NULL;
 456         dp->vma_invalidate_size = 0;
 457
 458         switch (io_req->mem.type) {
 459         case DM_IO_PAGE_LIST:
 460                 list_dp_init(dp, io_req->mem.ptr.pl, io_req->mem.offset);
 461                 break;
 462
 463         case DM_IO_BVEC:
 464                 bvec_dp_init(dp, io_req->mem.ptr.bvec);
 465                 break;
 466
 467         case DM_IO_VMA:
 468                 flush_kernel_vmap_range(io_req->mem.ptr.vma, size);
 469                 if ((io_req->bi_rw & RW_MASK) == READ) {
 470                         dp->vma_invalidate_address = io_req->mem.ptr.vma;
 471                         dp->vma_invalidate_size = size;
 472                 }
 473                 vm_dp_init(dp, io_req->mem.ptr.vma);
 474                 break;
 475
 476         case DM_IO_KMEM:
 477                 km_dp_init(dp, io_req->mem.ptr.addr);
 478                 break;
 479
 480         default:
 481                 return -EINVAL;
 482         }
 483
 484         return 0;
 485 }
 486
 487 /*
 488  * New collapsed (a)synchronous interface.
 489  *
 490  * If the IO is asynchronous (i.e. it has notify.fn), you must either unplug
 491  * the queue with blk_unplug() some time later or set REQ_SYNC in
 492 io_req->bi_rw. If you fail to do one of these, the IO will be submitted to
 493  * the disk after q->unplug_delay, which defaults to 3ms in blk-settings.c.
 494  */
 495 int dm_io(struct dm_io_request *io_req, unsigned num_regions,
 496           struct dm_io_region *where, unsigned long *sync_error_bits)
 497 {
 498         int r;
 499         struct dpages dp;
 500
 501         r = dp_init(io_req, &dp, (unsigned long)where->count << SECTOR_SHIFT);
 502         if (r)
 503                 return r;
 504
 505         if (!io_req->notify.fn)
 506                 return sync_io(io_req->client, num_regions, where,
 507                                io_req->bi_rw, &dp, sync_error_bits);
 508
 509         return async_io(io_req->client, num_regions, where, io_req->bi_rw,
 510                         &dp, io_req->notify.fn, io_req->notify.context);
 511 }
 512 EXPORT_SYMBOL(dm_io);
 513
 514 int __init dm_io_init(void)
 515 {
 516         _dm_io_cache = KMEM_CACHE(io, 0);
 517         if (!_dm_io_cache)
 518                 return -ENOMEM;
 519
 520         return 0;
 521 }
 522
 523 void dm_io_exit(void)
 524 {
 525         kmem_cache_destroy(_dm_io_cache);
 526         _dm_io_cache = NULL;
 527 }