drivers/md/dm-snap.c

   1 /*
   2  * dm-snapshot.c
   3  *
   4  * Copyright (C) 2001-2002 Sistina Software (UK) Limited.
   5  *
   6  * This file is released under the GPL.
   7  */
   8
   9 #include <linux/blkdev.h>
  10 #include <linux/ctype.h>
  11 #include <linux/device-mapper.h>
  12 #include <linux/fs.h>
  13 #include <linux/init.h>
  14 #include <linux/kdev_t.h>
  15 #include <linux/list.h>
  16 #include <linux/mempool.h>
  17 #include <linux/module.h>
  18 #include <linux/slab.h>
  19 #include <linux/vmalloc.h>
  20
  21 #include "dm-snap.h"
  22 #include "dm-bio-list.h"
  23 #include "kcopyd.h"
  24
  25 #define DM_MSG_PREFIX "snapshots"
  26
  27 /*
  28  * The percentage increment we will wake up users at
  29  */
  30 #define WAKE_UP_PERCENT 5
  31
  32 /*
  33  * kcopyd priority of snapshot operations
  34  */
  35 #define SNAPSHOT_COPY_PRIORITY 2
  36
  37 /*
  38  * Each snapshot reserves this many pages for io
  39  */
  40 #define SNAPSHOT_PAGES 256
  41
  42 struct pending_exception {
  43         struct exception e;
  44
  45         /*
  46          * Origin buffers waiting for this to complete are held
  47          * in a bio list
  48          */
  49         struct bio_list origin_bios;
  50         struct bio_list snapshot_bios;
  51
  52         /*
  53          * Short-term queue of pending exceptions prior to submission.
  54          */
  55         struct list_head list;
  56
  57         /*
  58          * The primary pending_exception is the one that holds
  59          * the sibling_count and the list of origin_bios for a
  60          * group of pending_exceptions.  It is always last to get freed.
  61          * These fields get set up when writing to the origin.
  62          */
  63         struct pending_exception *primary_pe;
  64
  65         /*
  66          * Number of pending_exceptions processing this chunk.
  67          * When this drops to zero we must complete the origin bios.
  68          * If incrementing or decrementing this, hold pe->snap->lock for
  69          * the sibling concerned and not pe->primary_pe->snap->lock unless
  70          * they are the same.
  71          */
  72         atomic_t sibling_count;
  73
  74         /* Pointer back to snapshot context */
  75         struct dm_snapshot *snap;
  76
  77         /*
  78          * 1 indicates the exception has already been sent to
  79          * kcopyd.
  80          */
  81         int started;
  82 };
  83
  84 /*
  85  * Hash table mapping origin volumes to lists of snapshots and
  86  * a lock to protect it
  87  */
  88 static kmem_cache_t *exception_cache;
  89 static kmem_cache_t *pending_cache;
  90 static mempool_t *pending_pool;
  91
  92 /*
  93  * One of these per registered origin, held in the snapshot_origins hash
  94  */
  95 struct origin {
  96         /* The origin device */
  97         struct block_device *bdev;
  98
  99         struct list_head hash_list;
 100
 101         /* List of snapshots for this origin */
 102         struct list_head snapshots;
 103 };
 104
 105 /*
 106  * Size of the hash table for origin volumes. If we make this
 107  * the size of the minors list then it should be nearly perfect
 108  */
 109 #define ORIGIN_HASH_SIZE 256
 110 #define ORIGIN_MASK      0xFF
 111 static struct list_head *_origins;
 112 static struct rw_semaphore _origins_lock;
 113
 114 static int init_origin_hash(void)
 115 {
 116         int i;
 117
 118         _origins = kmalloc(ORIGIN_HASH_SIZE * sizeof(struct list_head),
 119                            GFP_KERNEL);
 120         if (!_origins) {
 121                 DMERR("unable to allocate memory");
 122                 return -ENOMEM;
 123         }
 124
 125         for (i = 0; i < ORIGIN_HASH_SIZE; i++)
 126                 INIT_LIST_HEAD(_origins + i);
 127         init_rwsem(&_origins_lock);
 128
 129         return 0;
 130 }
 131
 132 static void exit_origin_hash(void)
 133 {
 134         kfree(_origins);
 135 }
 136
 137 static inline unsigned int origin_hash(struct block_device *bdev)
 138 {
 139         return bdev->bd_dev & ORIGIN_MASK;
 140 }
 141
 142 static struct origin *__lookup_origin(struct block_device *origin)
 143 {
 144         struct list_head *ol;
 145         struct origin *o;
 146
 147         ol = &_origins[origin_hash(origin)];
 148         list_for_each_entry (o, ol, hash_list)
 149                 if (bdev_equal(o->bdev, origin))
 150                         return o;
 151
 152         return NULL;
 153 }
 154
 155 static void __insert_origin(struct origin *o)
 156 {
 157         struct list_head *sl = &_origins[origin_hash(o->bdev)];
 158         list_add_tail(&o->hash_list, sl);
 159 }
 160
 161 /*
 162  * Make a note of the snapshot and its origin so we can look it
 163  * up when the origin has a write on it.
 164  */
 165 static int register_snapshot(struct dm_snapshot *snap)
 166 {
 167         struct origin *o;
 168         struct block_device *bdev = snap->origin->bdev;
 169
 170         down_write(&_origins_lock);
 171         o = __lookup_origin(bdev);
 172
 173         if (!o) {
 174                 /* New origin */
 175                 o = kmalloc(sizeof(*o), GFP_KERNEL);
 176                 if (!o) {
 177                         up_write(&_origins_lock);
 178                         return -ENOMEM;
 179                 }
 180
 181                 /* Initialise the struct */
 182                 INIT_LIST_HEAD(&o->snapshots);
 183                 o->bdev = bdev;
 184
 185                 __insert_origin(o);
 186         }
 187
 188         list_add_tail(&snap->list, &o->snapshots);
 189
 190         up_write(&_origins_lock);
 191         return 0;
 192 }
 193
 194 static void unregister_snapshot(struct dm_snapshot *s)
 195 {
 196         struct origin *o;
 197
 198         down_write(&_origins_lock);
 199         o = __lookup_origin(s->origin->bdev);
 200
 201         list_del(&s->list);
 202         if (list_empty(&o->snapshots)) {
 203                 list_del(&o->hash_list);
 204                 kfree(o);
 205         }
 206
 207         up_write(&_origins_lock);
 208 }
 209
 210 /*
 211  * Implementation of the exception hash tables.
 212  */
 213 static int init_exception_table(struct exception_table *et, uint32_t size)
 214 {
 215         unsigned int i;
 216
 217         et->hash_mask = size - 1;
 218         et->table = dm_vcalloc(size, sizeof(struct list_head));
 219         if (!et->table)
 220                 return -ENOMEM;
 221
 222         for (i = 0; i < size; i++)
 223                 INIT_LIST_HEAD(et->table + i);
 224
 225         return 0;
 226 }
 227
 228 static void exit_exception_table(struct exception_table *et, kmem_cache_t *mem)
 229 {
 230         struct list_head *slot;
 231         struct exception *ex, *next;
 232         int i, size;
 233
 234         size = et->hash_mask + 1;
 235         for (i = 0; i < size; i++) {
 236                 slot = et->table + i;
 237
 238                 list_for_each_entry_safe (ex, next, slot, hash_list)
 239                         kmem_cache_free(mem, ex);
 240         }
 241
 242         vfree(et->table);
 243 }
 244
 245 static inline uint32_t exception_hash(struct exception_table *et, chunk_t chunk)
 246 {
 247         return chunk & et->hash_mask;
 248 }
 249
 250 static void insert_exception(struct exception_table *eh, struct exception *e)
 251 {
 252         struct list_head *l = &eh->table[exception_hash(eh, e->old_chunk)];
 253         list_add(&e->hash_list, l);
 254 }
 255
 256 static inline void remove_exception(struct exception *e)
 257 {
 258         list_del(&e->hash_list);
 259 }
 260
 261 /*
 262  * Return the exception data for a sector, or NULL if not
 263  * remapped.
 264  */
 265 static struct exception *lookup_exception(struct exception_table *et,
 266                                           chunk_t chunk)
 267 {
 268         struct list_head *slot;
 269         struct exception *e;
 270
 271         slot = &et->table[exception_hash(et, chunk)];
 272         list_for_each_entry (e, slot, hash_list)
 273                 if (e->old_chunk == chunk)
 274                         return e;
 275
 276         return NULL;
 277 }
 278
 279 static inline struct exception *alloc_exception(void)
 280 {
 281         struct exception *e;
 282
 283         e = kmem_cache_alloc(exception_cache, GFP_NOIO);
 284         if (!e)
 285                 e = kmem_cache_alloc(exception_cache, GFP_ATOMIC);
 286
 287         return e;
 288 }
 289
 290 static inline void free_exception(struct exception *e)
 291 {
 292         kmem_cache_free(exception_cache, e);
 293 }
 294
 295 static inline struct pending_exception *alloc_pending_exception(void)
 296 {
 297         return mempool_alloc(pending_pool, GFP_NOIO);
 298 }
 299
 300 static inline void free_pending_exception(struct pending_exception *pe)
 301 {
 302         mempool_free(pe, pending_pool);
 303 }
 304
 305 int dm_add_exception(struct dm_snapshot *s, chunk_t old, chunk_t new)
 306 {
 307         struct exception *e;
 308
 309         e = alloc_exception();
 310         if (!e)
 311                 return -ENOMEM;
 312
 313         e->old_chunk = old;
 314         e->new_chunk = new;
 315         insert_exception(&s->complete, e);
 316         return 0;
 317 }
 318
 319 /*
 320  * Hard coded magic.
 321  */
 322 static int calc_max_buckets(void)
 323 {
 324         /* use a fixed size of 2MB */
 325         unsigned long mem = 2 * 1024 * 1024;
 326         mem /= sizeof(struct list_head);
 327
 328         return mem;
 329 }
 330
 331 /*
 332  * Rounds a number down to a power of 2.
 333  */
 334 static inline uint32_t round_down(uint32_t n)
 335 {
 336         while (n & (n - 1))
 337                 n &= (n - 1);
 338         return n;
 339 }
 340
 341 /*
 342  * Allocate room for a suitable hash table.
 343  */
 344 static int init_hash_tables(struct dm_snapshot *s)
 345 {
 346         sector_t hash_size, cow_dev_size, origin_dev_size, max_buckets;
 347
 348         /*
 349          * Calculate based on the size of the original volume or
 350          * the COW volume...
 351          */
 352         cow_dev_size = get_dev_size(s->cow->bdev);
 353         origin_dev_size = get_dev_size(s->origin->bdev);
 354         max_buckets = calc_max_buckets();
 355
 356         hash_size = min(origin_dev_size, cow_dev_size) >> s->chunk_shift;
 357         hash_size = min(hash_size, max_buckets);
 358
 359         /* Round it down to a power of 2 */
 360         hash_size = round_down(hash_size);
 361         if (init_exception_table(&s->complete, hash_size))
 362                 return -ENOMEM;
 363
 364         /*
 365          * Allocate hash table for in-flight exceptions
 366          * Make this smaller than the real hash table
 367          */
 368         hash_size >>= 3;
 369         if (hash_size < 64)
 370                 hash_size = 64;
 371
 372         if (init_exception_table(&s->pending, hash_size)) {
 373                 exit_exception_table(&s->complete, exception_cache);
 374                 return -ENOMEM;
 375         }
 376
 377         return 0;
 378 }
 379
 380 /*
 381  * Round a number up to the nearest 'size' boundary.  size must
 382  * be a power of 2.
 383  */
 384 static inline ulong round_up(ulong n, ulong size)
 385 {
 386         size--;
 387         return (n + size) & ~size;
 388 }
 389
 390 static void read_snapshot_metadata(struct dm_snapshot *s)
 391 {
 392         if (s->store.read_metadata(&s->store)) {
 393                 down_write(&s->lock);
 394                 s->valid = 0;
 395                 up_write(&s->lock);
 396
 397                 dm_table_event(s->table);
 398         }
 399 }
 400
 401 static int set_chunk_size(struct dm_snapshot *s, const char *chunk_size_arg,
 402                           char **error)
 403 {
 404         unsigned long chunk_size;
 405         char *value;
 406
 407         chunk_size = simple_strtoul(chunk_size_arg, &value, 10);
 408         if (*chunk_size_arg == '\0' || *value != '\0') {
 409                 *error = "Invalid chunk size";
 410                 return -EINVAL;
 411         }
 412
 413         if (!chunk_size) {
 414                 s->chunk_size = s->chunk_mask = s->chunk_shift = 0;
 415                 return 0;
 416         }
 417
 418         /*
 419          * Chunk size must be multiple of page size.  Silently
 420          * round up if it's not.
 421          */
 422         chunk_size = round_up(chunk_size, PAGE_SIZE >> 9);
 423
 424         /* Check chunk_size is a power of 2 */
 425         if (chunk_size & (chunk_size - 1)) {
 426                 *error = "Chunk size is not a power of 2";
 427                 return -EINVAL;
 428         }
 429
 430         /* Validate the chunk size against the device block size */
 431         if (chunk_size % (bdev_hardsect_size(s->cow->bdev) >> 9)) {
 432                 *error = "Chunk size is not a multiple of device blocksize";
 433                 return -EINVAL;
 434         }
 435
 436         s->chunk_size = chunk_size;
 437         s->chunk_mask = chunk_size - 1;
 438         s->chunk_shift = ffs(chunk_size) - 1;
 439
 440         return 0;
 441 }
 442
 443 /*
 444  * Construct a snapshot mapping: <origin_dev> <COW-dev> <p/n> <chunk-size>
 445  */
 446 static int snapshot_ctr(struct dm_target *ti, unsigned int argc, char **argv)
 447 {
 448         struct dm_snapshot *s;
 449         int r = -EINVAL;
 450         char persistent;
 451         char *origin_path;
 452         char *cow_path;
 453
 454         if (argc != 4) {
 455                 ti->error = "requires exactly 4 arguments";
 456                 r = -EINVAL;
 457                 goto bad1;
 458         }
 459
 460         origin_path = argv[0];
 461         cow_path = argv[1];
 462         persistent = toupper(*argv[2]);
 463
 464         if (persistent != 'P' && persistent != 'N') {
 465                 ti->error = "Persistent flag is not P or N";
 466                 r = -EINVAL;
 467                 goto bad1;
 468         }
 469
 470         s = kmalloc(sizeof(*s), GFP_KERNEL);
 471         if (s == NULL) {
 472                 ti->error = "Cannot allocate snapshot context private "
 473                     "structure";
 474                 r = -ENOMEM;
 475                 goto bad1;
 476         }
 477
 478         r = dm_get_device(ti, origin_path, 0, ti->len, FMODE_READ, &s->origin);
 479         if (r) {
 480                 ti->error = "Cannot get origin device";
 481                 goto bad2;
 482         }
 483
 484         r = dm_get_device(ti, cow_path, 0, 0,
 485                           FMODE_READ | FMODE_WRITE, &s->cow);
 486         if (r) {
 487                 dm_put_device(ti, s->origin);
 488                 ti->error = "Cannot get COW device";
 489                 goto bad2;
 490         }
 491
 492         r = set_chunk_size(s, argv[3], &ti->error);
 493         if (r)
 494                 goto bad3;
 495
 496         s->type = persistent;
 497
 498         s->valid = 1;
 499         s->active = 0;
 500         s->last_percent = 0;
 501         init_rwsem(&s->lock);
 502         s->table = ti->table;
 503
 504         /* Allocate hash table for COW data */
 505         if (init_hash_tables(s)) {
 506                 ti->error = "Unable to allocate hash table space";
 507                 r = -ENOMEM;
 508                 goto bad3;
 509         }
 510
 511         s->store.snap = s;
 512
 513         if (persistent == 'P')
 514                 r = dm_create_persistent(&s->store);
 515         else
 516                 r = dm_create_transient(&s->store);
 517
 518         if (r) {
 519                 ti->error = "Couldn't create exception store";
 520                 r = -EINVAL;
 521                 goto bad4;
 522         }
 523
 524         r = kcopyd_client_create(SNAPSHOT_PAGES, &s->kcopyd_client);
 525         if (r) {
 526                 ti->error = "Could not create kcopyd client";
 527                 goto bad5;
 528         }
 529
 530         /* Metadata must only be loaded into one table at once */
 531         read_snapshot_metadata(s);
 532
 533         /* Add snapshot to the list of snapshots for this origin */
 534         /* Exceptions aren't triggered till snapshot_resume() is called */
 535         if (register_snapshot(s)) {
 536                 r = -EINVAL;
 537                 ti->error = "Cannot register snapshot origin";
 538                 goto bad6;
 539         }
 540
 541         ti->private = s;
 542         ti->split_io = s->chunk_size;
 543
 544         return 0;
 545
 546  bad6:
 547         kcopyd_client_destroy(s->kcopyd_client);
 548
 549  bad5:
 550         s->store.destroy(&s->store);
 551
 552  bad4:
 553         exit_exception_table(&s->pending, pending_cache);
 554         exit_exception_table(&s->complete, exception_cache);
 555
 556  bad3:
 557         dm_put_device(ti, s->cow);
 558         dm_put_device(ti, s->origin);
 559
 560  bad2:
 561         kfree(s);
 562
 563  bad1:
 564         return r;
 565 }
 566
 567 static void snapshot_dtr(struct dm_target *ti)
 568 {
 569         struct dm_snapshot *s = (struct dm_snapshot *) ti->private;
 570
 571         /* Prevent further origin writes from using this snapshot. */
 572         /* After this returns there can be no new kcopyd jobs. */
 573         unregister_snapshot(s);
 574
 575         kcopyd_client_destroy(s->kcopyd_client);
 576
 577         exit_exception_table(&s->pending, pending_cache);
 578         exit_exception_table(&s->complete, exception_cache);
 579
 580         /* Deallocate memory used */
 581         s->store.destroy(&s->store);
 582
 583         dm_put_device(ti, s->origin);
 584         dm_put_device(ti, s->cow);
 585
 586         kfree(s);
 587 }
 588
 589 /*
 590  * Flush a list of buffers.
 591  */
 592 static void flush_bios(struct bio *bio)
 593 {
 594         struct bio *n;
 595
 596         while (bio) {
 597                 n = bio->bi_next;
 598                 bio->bi_next = NULL;
 599                 generic_make_request(bio);
 600                 bio = n;
 601         }
 602 }
 603
 604 /*
 605  * Error a list of buffers.
 606  */
 607 static void error_bios(struct bio *bio)
 608 {
 609         struct bio *n;
 610
 611         while (bio) {
 612                 n = bio->bi_next;
 613                 bio->bi_next = NULL;
 614                 bio_io_error(bio, bio->bi_size);
 615                 bio = n;
 616         }
 617 }
 618
 619 static inline void error_snapshot_bios(struct pending_exception *pe)
 620 {
 621         error_bios(bio_list_get(&pe->snapshot_bios));
 622 }
 623
 624 static struct bio *__flush_bios(struct pending_exception *pe)
 625 {
 626         /*
 627          * If this pe is involved in a write to the origin and
 628          * it is the last sibling to complete then release
 629          * the bios for the original write to the origin.
 630          */
 631
 632         if (pe->primary_pe &&
 633             atomic_dec_and_test(&pe->primary_pe->sibling_count))
 634                 return bio_list_get(&pe->primary_pe->origin_bios);
 635
 636         return NULL;
 637 }
 638
 639 static void __invalidate_snapshot(struct dm_snapshot *s,
 640                                 struct pending_exception *pe, int err)
 641 {
 642         if (!s->valid)
 643                 return;
 644
 645         if (err == -EIO)
 646                 DMERR("Invalidating snapshot: Error reading/writing.");
 647         else if (err == -ENOMEM)
 648                 DMERR("Invalidating snapshot: Unable to allocate exception.");
 649
 650         if (pe)
 651                 remove_exception(&pe->e);
 652
 653         if (s->store.drop_snapshot)
 654                 s->store.drop_snapshot(&s->store);
 655
 656         s->valid = 0;
 657
 658         dm_table_event(s->table);
 659 }
 660
 661 static void pending_complete(struct pending_exception *pe, int success)
 662 {
 663         struct exception *e;
 664         struct pending_exception *primary_pe;
 665         struct dm_snapshot *s = pe->snap;
 666         struct bio *flush = NULL;
 667
 668         if (!success) {
 669                 /* Read/write error - snapshot is unusable */
 670                 down_write(&s->lock);
 671                 __invalidate_snapshot(s, pe, -EIO);
 672                 flush = __flush_bios(pe);
 673                 up_write(&s->lock);
 674
 675                 error_snapshot_bios(pe);
 676                 goto out;
 677         }
 678
 679         e = alloc_exception();
 680         if (!e) {
 681                 down_write(&s->lock);
 682                 __invalidate_snapshot(s, pe, -ENOMEM);
 683                 flush = __flush_bios(pe);
 684                 up_write(&s->lock);
 685
 686                 error_snapshot_bios(pe);
 687                 goto out;
 688         }
 689         *e = pe->e;
 690
 691         /*
 692          * Add a proper exception, and remove the
 693          * in-flight exception from the list.
 694          */
 695         down_write(&s->lock);
 696         if (!s->valid) {
 697                 flush = __flush_bios(pe);
 698                 up_write(&s->lock);
 699
 700                 free_exception(e);
 701
 702                 error_snapshot_bios(pe);
 703                 goto out;
 704         }
 705
 706         insert_exception(&s->complete, e);
 707         remove_exception(&pe->e);
 708         flush = __flush_bios(pe);
 709
 710         up_write(&s->lock);
 711
 712         /* Submit any pending write bios */
 713         flush_bios(bio_list_get(&pe->snapshot_bios));
 714
 715  out:
 716         primary_pe = pe->primary_pe;
 717
 718         /*
 719          * Free the pe if it's not linked to an origin write or if
 720          * it's not itself a primary pe.
 721          */
 722         if (!primary_pe || primary_pe != pe)
 723                 free_pending_exception(pe);
 724
 725         /*
 726          * Free the primary pe if nothing references it.
 727          */
 728         if (primary_pe && !atomic_read(&primary_pe->sibling_count))
 729                 free_pending_exception(primary_pe);
 730
 731         if (flush)
 732                 flush_bios(flush);
 733 }
 734
 735 static void commit_callback(void *context, int success)
 736 {
 737         struct pending_exception *pe = (struct pending_exception *) context;
 738         pending_complete(pe, success);
 739 }
 740
 741 /*
 742  * Called when the copy I/O has finished.  kcopyd actually runs
 743  * this code so don't block.
 744  */
 745 static void copy_callback(int read_err, unsigned int write_err, void *context)
 746 {
 747         struct pending_exception *pe = (struct pending_exception *) context;
 748         struct dm_snapshot *s = pe->snap;
 749
 750         if (read_err || write_err)
 751                 pending_complete(pe, 0);
 752
 753         else
 754                 /* Update the metadata if we are persistent */
 755                 s->store.commit_exception(&s->store, &pe->e, commit_callback,
 756                                           pe);
 757 }
 758
 759 /*
 760  * Dispatches the copy operation to kcopyd.
 761  */
 762 static void start_copy(struct pending_exception *pe)
 763 {
 764         struct dm_snapshot *s = pe->snap;
 765         struct io_region src, dest;
 766         struct block_device *bdev = s->origin->bdev;
 767         sector_t dev_size;
 768
 769         dev_size = get_dev_size(bdev);
 770
 771         src.bdev = bdev;
 772         src.sector = chunk_to_sector(s, pe->e.old_chunk);
 773         src.count = min(s->chunk_size, dev_size - src.sector);
 774
 775         dest.bdev = s->cow->bdev;
 776         dest.sector = chunk_to_sector(s, pe->e.new_chunk);
 777         dest.count = src.count;
 778
 779         /* Hand over to kcopyd */
 780         kcopyd_copy(s->kcopyd_client,
 781                     &src, 1, &dest, 0, copy_callback, pe);
 782 }
 783
 784 /*
 785  * Looks to see if this snapshot already has a pending exception
 786  * for this chunk, otherwise it allocates a new one and inserts
 787  * it into the pending table.
 788  *
 789  * NOTE: a write lock must be held on snap->lock before calling
 790  * this.
 791  */
 792 static struct pending_exception *
 793 __find_pending_exception(struct dm_snapshot *s, struct bio *bio)
 794 {
 795         struct exception *e;
 796         struct pending_exception *pe;
 797         chunk_t chunk = sector_to_chunk(s, bio->bi_sector);
 798
 799         /*
 800          * Is there a pending exception for this already ?
 801          */
 802         e = lookup_exception(&s->pending, chunk);
 803         if (e) {
 804                 /* cast the exception to a pending exception */
 805                 pe = container_of(e, struct pending_exception, e);
 806                 goto out;
 807         }
 808
 809         /*
 810          * Create a new pending exception, we don't want
 811          * to hold the lock while we do this.
 812          */
 813         up_write(&s->lock);
 814         pe = alloc_pending_exception();
 815         down_write(&s->lock);
 816
 817         if (!s->valid) {
 818                 free_pending_exception(pe);
 819                 return NULL;
 820         }
 821
 822         e = lookup_exception(&s->pending, chunk);
 823         if (e) {
 824                 free_pending_exception(pe);
 825                 pe = container_of(e, struct pending_exception, e);
 826                 goto out;
 827         }
 828
 829         pe->e.old_chunk = chunk;
 830         bio_list_init(&pe->origin_bios);
 831         bio_list_init(&pe->snapshot_bios);
 832         pe->primary_pe = NULL;
 833         atomic_set(&pe->sibling_count, 1);
 834         pe->snap = s;
 835         pe->started = 0;
 836
 837         if (s->store.prepare_exception(&s->store, &pe->e)) {
 838                 free_pending_exception(pe);
 839                 return NULL;
 840         }
 841
 842         insert_exception(&s->pending, &pe->e);
 843
 844  out:
 845         return pe;
 846 }
 847
 848 static inline void remap_exception(struct dm_snapshot *s, struct exception *e,
 849                                    struct bio *bio)
 850 {
 851         bio->bi_bdev = s->cow->bdev;
 852         bio->bi_sector = chunk_to_sector(s, e->new_chunk) +
 853                 (bio->bi_sector & s->chunk_mask);
 854 }
 855
 856 static int snapshot_map(struct dm_target *ti, struct bio *bio,
 857                         union map_info *map_context)
 858 {
 859         struct exception *e;
 860         struct dm_snapshot *s = (struct dm_snapshot *) ti->private;
 861         int copy_needed = 0;
 862         int r = 1;
 863         chunk_t chunk;
 864         struct pending_exception *pe = NULL;
 865
 866         chunk = sector_to_chunk(s, bio->bi_sector);
 867
 868         /* Full snapshots are not usable */
 869         /* To get here the table must be live so s->active is always set. */
 870         if (!s->valid)
 871                 return -EIO;
 872
 873         if (unlikely(bio_barrier(bio)))
 874                 return -EOPNOTSUPP;
 875
 876         /*
 877          * Write to snapshot - higher level takes care of RW/RO
 878          * flags so we should only get this if we are
 879          * writeable.
 880          */
 881         if (bio_rw(bio) == WRITE) {
 882
 883                 /* FIXME: should only take write lock if we need
 884                  * to copy an exception */
 885                 down_write(&s->lock);
 886
 887                 if (!s->valid) {
 888                         r = -EIO;
 889                         goto out_unlock;
 890                 }
 891
 892                 /* If the block is already remapped - use that, else remap it */
 893                 e = lookup_exception(&s->complete, chunk);
 894                 if (e) {
 895                         remap_exception(s, e, bio);
 896                         goto out_unlock;
 897                 }
 898
 899                 pe = __find_pending_exception(s, bio);
 900                 if (!pe) {
 901                         __invalidate_snapshot(s, pe, -ENOMEM);
 902                         r = -EIO;
 903                         goto out_unlock;
 904                 }
 905
 906                 remap_exception(s, &pe->e, bio);
 907                 bio_list_add(&pe->snapshot_bios, bio);
 908
 909                 if (!pe->started) {
 910                         /* this is protected by snap->lock */
 911                         pe->started = 1;
 912                         copy_needed = 1;
 913                 }
 914
 915                 r = 0;
 916
 917  out_unlock:
 918                 up_write(&s->lock);
 919
 920                 if (copy_needed)
 921                         start_copy(pe);
 922         } else {
 923                 /*
 924                  * FIXME: this read path scares me because we
 925                  * always use the origin when we have a pending
 926                  * exception.  However I can't think of a
 927                  * situation where this is wrong - ejt.
 928                  */
 929
 930                 /* Do reads */
 931                 down_read(&s->lock);
 932
 933                 if (!s->valid) {
 934                         up_read(&s->lock);
 935                         return -EIO;
 936                 }
 937
 938                 /* See if it it has been remapped */
 939                 e = lookup_exception(&s->complete, chunk);
 940                 if (e)
 941                         remap_exception(s, e, bio);
 942                 else
 943                         bio->bi_bdev = s->origin->bdev;
 944
 945                 up_read(&s->lock);
 946         }
 947
 948         return r;
 949 }
 950
 951 static void snapshot_resume(struct dm_target *ti)
 952 {
 953         struct dm_snapshot *s = (struct dm_snapshot *) ti->private;
 954
 955         down_write(&s->lock);
 956         s->active = 1;
 957         up_write(&s->lock);
 958 }
 959
 960 static int snapshot_status(struct dm_target *ti, status_type_t type,
 961                            char *result, unsigned int maxlen)
 962 {
 963         struct dm_snapshot *snap = (struct dm_snapshot *) ti->private;
 964
 965         switch (type) {
 966         case STATUSTYPE_INFO:
 967                 if (!snap->valid)
 968                         snprintf(result, maxlen, "Invalid");
 969                 else {
 970                         if (snap->store.fraction_full) {
 971                                 sector_t numerator, denominator;
 972                                 snap->store.fraction_full(&snap->store,
 973                                                           &numerator,
 974                                                           &denominator);
 975                                 snprintf(result, maxlen, "%llu/%llu",
 976                                         (unsigned long long)numerator,
 977                                         (unsigned long long)denominator);
 978                         }
 979                         else
 980                                 snprintf(result, maxlen, "Unknown");
 981                 }
 982                 break;
 983
 984         case STATUSTYPE_TABLE:
 985                 /*
 986                  * kdevname returns a static pointer so we need
 987                  * to make private copies if the output is to
 988                  * make sense.
 989                  */
 990                 snprintf(result, maxlen, "%s %s %c %llu",
 991                          snap->origin->name, snap->cow->name,
 992                          snap->type,
 993                          (unsigned long long)snap->chunk_size);
 994                 break;
 995         }
 996
 997         return 0;
 998 }
 999
1000 /*-----------------------------------------------------------------
1001  * Origin methods
1002  *---------------------------------------------------------------*/
1003 static int __origin_write(struct list_head *snapshots, struct bio *bio)
1004 {
1005         int r = 1, first = 0;
1006         struct dm_snapshot *snap;
1007         struct exception *e;
1008         struct pending_exception *pe, *next_pe, *primary_pe = NULL;
1009         chunk_t chunk;
1010         LIST_HEAD(pe_queue);
1011
1012         /* Do all the snapshots on this origin */
1013         list_for_each_entry (snap, snapshots, list) {
1014
1015                 down_write(&snap->lock);
1016
1017                 /* Only deal with valid and active snapshots */
1018                 if (!snap->valid || !snap->active)
1019                         goto next_snapshot;
1020
1021                 /* Nothing to do if writing beyond end of snapshot */
1022                 if (bio->bi_sector >= dm_table_get_size(snap->table))
1023                         goto next_snapshot;
1024
1025                 /*
1026                  * Remember, different snapshots can have
1027                  * different chunk sizes.
1028                  */
1029                 chunk = sector_to_chunk(snap, bio->bi_sector);
1030
1031                 /*
1032                  * Check exception table to see if block
1033                  * is already remapped in this snapshot
1034                  * and trigger an exception if not.
1035                  *
1036                  * sibling_count is initialised to 1 so pending_complete()
1037                  * won't destroy the primary_pe while we're inside this loop.
1038                  */
1039                 e = lookup_exception(&snap->complete, chunk);
1040                 if (e)
1041                         goto next_snapshot;
1042
1043                 pe = __find_pending_exception(snap, bio);
1044                 if (!pe) {
1045                         __invalidate_snapshot(snap, pe, -ENOMEM);
1046                         goto next_snapshot;
1047                 }
1048
1049                 if (!primary_pe) {
1050                         /*
1051                          * Either every pe here has same
1052                          * primary_pe or none has one yet.
1053                          */
1054                         if (pe->primary_pe)
1055                                 primary_pe = pe->primary_pe;
1056                         else {
1057                                 primary_pe = pe;
1058                                 first = 1;
1059                         }
1060
1061                         bio_list_add(&primary_pe->origin_bios, bio);
1062
1063                         r = 0;
1064                 }
1065
1066                 if (!pe->primary_pe) {
1067                         atomic_inc(&primary_pe->sibling_count);
1068                         pe->primary_pe = primary_pe;
1069                 }
1070
1071                 if (!pe->started) {
1072                         pe->started = 1;
1073                         list_add_tail(&pe->list, &pe_queue);
1074                 }
1075
1076  next_snapshot:
1077                 up_write(&snap->lock);
1078         }
1079
1080         if (!primary_pe)
1081                 goto out;
1082
1083         /*
1084          * If this is the first time we're processing this chunk and
1085          * sibling_count is now 1 it means all the pending exceptions
1086          * got completed while we were in the loop above, so it falls to
1087          * us here to remove the primary_pe and submit any origin_bios.
1088          */
1089
1090         if (first && atomic_dec_and_test(&primary_pe->sibling_count)) {
1091                 flush_bios(bio_list_get(&primary_pe->origin_bios));
1092                 free_pending_exception(primary_pe);
1093                 /* If we got here, pe_queue is necessarily empty. */
1094                 goto out;
1095         }
1096
1097         /*
1098          * Now that we have a complete pe list we can start the copying.
1099          */
1100         list_for_each_entry_safe(pe, next_pe, &pe_queue, list)
1101                 start_copy(pe);
1102
1103  out:
1104         return r;
1105 }
1106
1107 /*
1108  * Called on a write from the origin driver.
1109  */
1110 static int do_origin(struct dm_dev *origin, struct bio *bio)
1111 {
1112         struct origin *o;
1113         int r = 1;
1114
1115         down_read(&_origins_lock);
1116         o = __lookup_origin(origin->bdev);
1117         if (o)
1118                 r = __origin_write(&o->snapshots, bio);
1119         up_read(&_origins_lock);
1120
1121         return r;
1122 }
1123
1124 /*
1125  * Origin: maps a linear range of a device, with hooks for snapshotting.
1126  */
1127
1128 /*
1129  * Construct an origin mapping: <dev_path>
1130  * The context for an origin is merely a 'struct dm_dev *'
1131  * pointing to the real device.
1132  */
1133 static int origin_ctr(struct dm_target *ti, unsigned int argc, char **argv)
1134 {
1135         int r;
1136         struct dm_dev *dev;
1137
1138         if (argc != 1) {
1139                 ti->error = "origin: incorrect number of arguments";
1140                 return -EINVAL;
1141         }
1142
1143         r = dm_get_device(ti, argv[0], 0, ti->len,
1144                           dm_table_get_mode(ti->table), &dev);
1145         if (r) {
1146                 ti->error = "Cannot get target device";
1147                 return r;
1148         }
1149
1150         ti->private = dev;
1151         return 0;
1152 }
1153
1154 static void origin_dtr(struct dm_target *ti)
1155 {
1156         struct dm_dev *dev = (struct dm_dev *) ti->private;
1157         dm_put_device(ti, dev);
1158 }
1159
1160 static int origin_map(struct dm_target *ti, struct bio *bio,
1161                       union map_info *map_context)
1162 {
1163         struct dm_dev *dev = (struct dm_dev *) ti->private;
1164         bio->bi_bdev = dev->bdev;
1165
1166         if (unlikely(bio_barrier(bio)))
1167                 return -EOPNOTSUPP;
1168
1169         /* Only tell snapshots if this is a write */
1170         return (bio_rw(bio) == WRITE) ? do_origin(dev, bio) : 1;
1171 }
1172
1173 #define min_not_zero(l, r) (l == 0) ? r : ((r == 0) ? l : min(l, r))
1174
1175 /*
1176  * Set the target "split_io" field to the minimum of all the snapshots'
1177  * chunk sizes.
1178  */
1179 static void origin_resume(struct dm_target *ti)
1180 {
1181         struct dm_dev *dev = (struct dm_dev *) ti->private;
1182         struct dm_snapshot *snap;
1183         struct origin *o;
1184         chunk_t chunk_size = 0;
1185
1186         down_read(&_origins_lock);
1187         o = __lookup_origin(dev->bdev);
1188         if (o)
1189                 list_for_each_entry (snap, &o->snapshots, list)
1190                         chunk_size = min_not_zero(chunk_size, snap->chunk_size);
1191         up_read(&_origins_lock);
1192
1193         ti->split_io = chunk_size;
1194 }
1195
1196 static int origin_status(struct dm_target *ti, status_type_t type, char *result,
1197                          unsigned int maxlen)
1198 {
1199         struct dm_dev *dev = (struct dm_dev *) ti->private;
1200
1201         switch (type) {
1202         case STATUSTYPE_INFO:
1203                 result[0] = '\0';
1204                 break;
1205
1206         case STATUSTYPE_TABLE:
1207                 snprintf(result, maxlen, "%s", dev->name);
1208                 break;
1209         }
1210
1211         return 0;
1212 }
1213
1214 static struct target_type origin_target = {
1215         .name    = "snapshot-origin",
1216         .version = {1, 5, 0},
1217         .module  = THIS_MODULE,
1218         .ctr     = origin_ctr,
1219         .dtr     = origin_dtr,
1220         .map     = origin_map,
1221         .resume  = origin_resume,
1222         .status  = origin_status,
1223 };
1224
1225 static struct target_type snapshot_target = {
1226         .name    = "snapshot",
1227         .version = {1, 5, 0},
1228         .module  = THIS_MODULE,
1229         .ctr     = snapshot_ctr,
1230         .dtr     = snapshot_dtr,
1231         .map     = snapshot_map,
1232         .resume  = snapshot_resume,
1233         .status  = snapshot_status,
1234 };
1235
1236 static int __init dm_snapshot_init(void)
1237 {
1238         int r;
1239
1240         r = dm_register_target(&snapshot_target);
1241         if (r) {
1242                 DMERR("snapshot target register failed %d", r);
1243                 return r;
1244         }
1245
1246         r = dm_register_target(&origin_target);
1247         if (r < 0) {
1248                 DMERR("Origin target register failed %d", r);
1249                 goto bad1;
1250         }
1251
1252         r = init_origin_hash();
1253         if (r) {
1254                 DMERR("init_origin_hash failed.");
1255                 goto bad2;
1256         }
1257
1258         exception_cache = kmem_cache_create("dm-snapshot-ex",
1259                                             sizeof(struct exception),
1260                                             __alignof__(struct exception),
1261                                             0, NULL, NULL);
1262         if (!exception_cache) {
1263                 DMERR("Couldn't create exception cache.");
1264                 r = -ENOMEM;
1265                 goto bad3;
1266         }
1267
1268         pending_cache =
1269             kmem_cache_create("dm-snapshot-in",
1270                               sizeof(struct pending_exception),
1271                               __alignof__(struct pending_exception),
1272                               0, NULL, NULL);
1273         if (!pending_cache) {
1274                 DMERR("Couldn't create pending cache.");
1275                 r = -ENOMEM;
1276                 goto bad4;
1277         }
1278
1279         pending_pool = mempool_create_slab_pool(128, pending_cache);
1280         if (!pending_pool) {
1281                 DMERR("Couldn't create pending pool.");
1282                 r = -ENOMEM;
1283                 goto bad5;
1284         }
1285
1286         return 0;
1287
1288       bad5:
1289         kmem_cache_destroy(pending_cache);
1290       bad4:
1291         kmem_cache_destroy(exception_cache);
1292       bad3:
1293         exit_origin_hash();
1294       bad2:
1295         dm_unregister_target(&origin_target);
1296       bad1:
1297         dm_unregister_target(&snapshot_target);
1298         return r;
1299 }
1300
1301 static void __exit dm_snapshot_exit(void)
1302 {
1303         int r;
1304
1305         r = dm_unregister_target(&snapshot_target);
1306         if (r)
1307                 DMERR("snapshot unregister failed %d", r);
1308
1309         r = dm_unregister_target(&origin_target);
1310         if (r)
1311                 DMERR("origin unregister failed %d", r);
1312
1313         exit_origin_hash();
1314         mempool_destroy(pending_pool);
1315         kmem_cache_destroy(pending_cache);
1316         kmem_cache_destroy(exception_cache);
1317 }
1318
1319 /* Module hooks */
1320 module_init(dm_snapshot_init);
1321 module_exit(dm_snapshot_exit);
1322
1323 MODULE_DESCRIPTION(DM_NAME " snapshot target");
1324 MODULE_AUTHOR("Joe Thornber");
1325 MODULE_LICENSE("GPL");