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 /*
 254  * Functions for getting the pages from kernel memory.
 255  */
 256 static void km_get_page(struct dpages *dp, struct page **p, unsigned long *len,
 257                         unsigned *offset)
 258 {
 259         *p = virt_to_page(dp->context_ptr);
 260         *offset = dp->context_u;
 261         *len = PAGE_SIZE - dp->context_u;
 262 }
 263
 264 static void km_next_page(struct dpages *dp)
 265 {
 266         dp->context_ptr += PAGE_SIZE - dp->context_u;
 267         dp->context_u = 0;
 268 }
 269
 270 static void km_dp_init(struct dpages *dp, void *data)
 271 {
 272         dp->get_page = km_get_page;
 273         dp->next_page = km_next_page;
 274         dp->context_u = ((unsigned long) data) & (PAGE_SIZE - 1);
 275         dp->context_ptr = data;
 276 }
 277
 278 /*-----------------------------------------------------------------
 279  * IO routines that accept a list of pages.
 280  *---------------------------------------------------------------*/
 281 static void do_region(int rw, unsigned region, struct dm_io_region *where,
 282                       struct dpages *dp, struct io *io)
 283 {
 284         struct bio *bio;
 285         struct page *page;
 286         unsigned long len;
 287         unsigned offset;
 288         unsigned num_bvecs;
 289         sector_t remaining = where->count;
 290         struct request_queue *q = bdev_get_queue(where->bdev);
 291         unsigned short logical_block_size = queue_logical_block_size(q);
 292         sector_t num_sectors;
 293
 294         /*
 295          * where->count may be zero if rw holds a flush and we need to
 296          * send a zero-sized flush.
 297          */
 298         do {
 299                 /*
 300                  * Allocate a suitably sized-bio.
 301                  */
 302                 if ((rw & REQ_DISCARD) || (rw & REQ_WRITE_SAME))
 303                         num_bvecs = 1;
 304                 else
 305                         num_bvecs = min_t(int, bio_get_nr_vecs(where->bdev),
 306                                           dm_sector_div_up(remaining, (PAGE_SIZE >> SECTOR_SHIFT)));
 307
 308                 bio = bio_alloc_bioset(GFP_NOIO, num_bvecs, io->client->bios);
 309                 bio->bi_sector = where->sector + (where->count - remaining);
 310                 bio->bi_bdev = where->bdev;
 311                 bio->bi_end_io = endio;
 312                 store_io_and_region_in_bio(bio, io, region);
 313
 314                 if (rw & REQ_DISCARD) {
 315                         num_sectors = min_t(sector_t, q->limits.max_discard_sectors, remaining);
 316                         bio->bi_size = num_sectors << SECTOR_SHIFT;
 317                         remaining -= num_sectors;
 318                 } else if (rw & REQ_WRITE_SAME) {
 319                         /*
 320                          * WRITE SAME only uses a single page.
 321                          */
 322                         dp->get_page(dp, &page, &len, &offset);
 323                         bio_add_page(bio, page, logical_block_size, offset);
 324                         num_sectors = min_t(sector_t, q->limits.max_write_same_sectors, remaining);
 325                         bio->bi_size = num_sectors << SECTOR_SHIFT;
 326
 327                         offset = 0;
 328                         remaining -= num_sectors;
 329                         dp->next_page(dp);
 330                 } else while (remaining) {
 331                         /*
 332                          * Try and add as many pages as possible.
 333                          */
 334                         dp->get_page(dp, &page, &len, &offset);
 335                         len = min(len, to_bytes(remaining));
 336                         if (!bio_add_page(bio, page, len, offset))
 337                                 break;
 338
 339                         offset = 0;
 340                         remaining -= to_sector(len);
 341                         dp->next_page(dp);
 342                 }
 343
 344                 atomic_inc(&io->count);
 345                 submit_bio(rw, bio);
 346         } while (remaining);
 347 }
 348
 349 static void dispatch_io(int rw, unsigned int num_regions,
 350                         struct dm_io_region *where, struct dpages *dp,
 351                         struct io *io, int sync)
 352 {
 353         int i;
 354         struct dpages old_pages = *dp;
 355
 356         BUG_ON(num_regions > DM_IO_MAX_REGIONS);
 357
 358         if (sync)
 359                 rw |= REQ_SYNC;
 360
 361         /*
 362          * For multiple regions we need to be careful to rewind
 363          * the dp object for each call to do_region.
 364          */
 365         for (i = 0; i < num_regions; i++) {
 366                 *dp = old_pages;
 367                 if (where[i].count || (rw & REQ_FLUSH))
 368                         do_region(rw, i, where + i, dp, io);
 369         }
 370
 371         /*
 372          * Drop the extra reference that we were holding to avoid
 373          * the io being completed too early.
 374          */
 375         dec_count(io, 0, 0);
 376 }
 377
 378 static int sync_io(struct dm_io_client *client, unsigned int num_regions,
 379                    struct dm_io_region *where, int rw, struct dpages *dp,
 380                    unsigned long *error_bits)
 381 {
 382         /*
 383          * gcc <= 4.3 can't do the alignment for stack variables, so we must
 384          * align it on our own.
 385          * volatile prevents the optimizer from removing or reusing
 386          * "io_" field from the stack frame (allowed in ANSI C).
 387          */
 388         volatile char io_[sizeof(struct io) + __alignof__(struct io) - 1];
 389         struct io *io = (struct io *)PTR_ALIGN(&io_, __alignof__(struct io));
 390         DECLARE_COMPLETION_ONSTACK(wait);
 391
 392         if (num_regions > 1 && (rw & RW_MASK) != WRITE) {
 393                 WARN_ON(1);
 394                 return -EIO;
 395         }
 396
 397         io->error_bits = 0;
 398         atomic_set(&io->count, 1); /* see dispatch_io() */
 399         io->wait = &wait;
 400         io->client = client;
 401
 402         io->vma_invalidate_address = dp->vma_invalidate_address;
 403         io->vma_invalidate_size = dp->vma_invalidate_size;
 404
 405         dispatch_io(rw, num_regions, where, dp, io, 1);
 406
 407         wait_for_completion_io(&wait);
 408
 409         if (error_bits)
 410                 *error_bits = io->error_bits;
 411
 412         return io->error_bits ? -EIO : 0;
 413 }
 414
 415 static int async_io(struct dm_io_client *client, unsigned int num_regions,
 416                     struct dm_io_region *where, int rw, struct dpages *dp,
 417                     io_notify_fn fn, void *context)
 418 {
 419         struct io *io;
 420
 421         if (num_regions > 1 && (rw & RW_MASK) != WRITE) {
 422                 WARN_ON(1);
 423                 fn(1, context);
 424                 return -EIO;
 425         }
 426
 427         io = mempool_alloc(client->pool, GFP_NOIO);
 428         io->error_bits = 0;
 429         atomic_set(&io->count, 1); /* see dispatch_io() */
 430         io->wait = NULL;
 431         io->client = client;
 432         io->callback = fn;
 433         io->context = context;
 434
 435         io->vma_invalidate_address = dp->vma_invalidate_address;
 436         io->vma_invalidate_size = dp->vma_invalidate_size;
 437
 438         dispatch_io(rw, num_regions, where, dp, io, 0);
 439         return 0;
 440 }
 441
 442 static int dp_init(struct dm_io_request *io_req, struct dpages *dp,
 443                    unsigned long size)
 444 {
 445         /* Set up dpages based on memory type */
 446
 447         dp->vma_invalidate_address = NULL;
 448         dp->vma_invalidate_size = 0;
 449
 450         switch (io_req->mem.type) {
 451         case DM_IO_PAGE_LIST:
 452                 list_dp_init(dp, io_req->mem.ptr.pl, io_req->mem.offset);
 453                 break;
 454
 455         case DM_IO_BVEC:
 456                 bvec_dp_init(dp, io_req->mem.ptr.bvec);
 457                 break;
 458
 459         case DM_IO_VMA:
 460                 flush_kernel_vmap_range(io_req->mem.ptr.vma, size);
 461                 if ((io_req->bi_rw & RW_MASK) == READ) {
 462                         dp->vma_invalidate_address = io_req->mem.ptr.vma;
 463                         dp->vma_invalidate_size = size;
 464                 }
 465                 vm_dp_init(dp, io_req->mem.ptr.vma);
 466                 break;
 467
 468         case DM_IO_KMEM:
 469                 km_dp_init(dp, io_req->mem.ptr.addr);
 470                 break;
 471
 472         default:
 473                 return -EINVAL;
 474         }
 475
 476         return 0;
 477 }
 478
 479 /*
 480  * New collapsed (a)synchronous interface.
 481  *
 482  * If the IO is asynchronous (i.e. it has notify.fn), you must either unplug
 483  * the queue with blk_unplug() some time later or set REQ_SYNC in
 484 io_req->bi_rw. If you fail to do one of these, the IO will be submitted to
 485  * the disk after q->unplug_delay, which defaults to 3ms in blk-settings.c.
 486  */
 487 int dm_io(struct dm_io_request *io_req, unsigned num_regions,
 488           struct dm_io_region *where, unsigned long *sync_error_bits)
 489 {
 490         int r;
 491         struct dpages dp;
 492
 493         r = dp_init(io_req, &dp, (unsigned long)where->count << SECTOR_SHIFT);
 494         if (r)
 495                 return r;
 496
 497         if (!io_req->notify.fn)
 498                 return sync_io(io_req->client, num_regions, where,
 499                                io_req->bi_rw, &dp, sync_error_bits);
 500
 501         return async_io(io_req->client, num_regions, where, io_req->bi_rw,
 502                         &dp, io_req->notify.fn, io_req->notify.context);
 503 }
 504 EXPORT_SYMBOL(dm_io);
 505
 506 int __init dm_io_init(void)
 507 {
 508         _dm_io_cache = KMEM_CACHE(io, 0);
 509         if (!_dm_io_cache)
 510                 return -ENOMEM;
 511
 512         return 0;
 513 }
 514
 515 void dm_io_exit(void)
 516 {
 517         kmem_cache_destroy(_dm_io_cache);
 518         _dm_io_cache = NULL;
 519 }