4 * Copyright (C) 2001-2002 Sistina Software (UK) Limited.
6 * This file is released under the GPL.
9 #include <linux/blkdev.h>
10 #include <linux/config.h>
11 #include <linux/ctype.h>
12 #include <linux/device-mapper.h>
14 #include <linux/init.h>
15 #include <linux/kdev_t.h>
16 #include <linux/list.h>
17 #include <linux/mempool.h>
18 #include <linux/module.h>
19 #include <linux/slab.h>
20 #include <linux/vmalloc.h>
23 #include "dm-bio-list.h"
27 * The percentage increment we will wake up users at
29 #define WAKE_UP_PERCENT 5
32 * kcopyd priority of snapshot operations
34 #define SNAPSHOT_COPY_PRIORITY 2
37 * Each snapshot reserves this many pages for io
39 #define SNAPSHOT_PAGES 256
41 struct pending_exception {
45 * Origin buffers waiting for this to complete are held
48 struct bio_list origin_bios;
49 struct bio_list snapshot_bios;
52 * Other pending_exceptions that are processing this
53 * chunk. When this list is empty, we know we can
54 * complete the origins.
56 struct list_head siblings;
58 /* Pointer back to snapshot context */
59 struct dm_snapshot *snap;
62 * 1 indicates the exception has already been sent to
69 * Hash table mapping origin volumes to lists of snapshots and
70 * a lock to protect it
72 static kmem_cache_t *exception_cache;
73 static kmem_cache_t *pending_cache;
74 static mempool_t *pending_pool;
77 * One of these per registered origin, held in the snapshot_origins hash
80 /* The origin device */
81 struct block_device *bdev;
83 struct list_head hash_list;
85 /* List of snapshots for this origin */
86 struct list_head snapshots;
90 * Size of the hash table for origin volumes. If we make this
91 * the size of the minors list then it should be nearly perfect
93 #define ORIGIN_HASH_SIZE 256
94 #define ORIGIN_MASK 0xFF
95 static struct list_head *_origins;
96 static struct rw_semaphore _origins_lock;
98 static int init_origin_hash(void)
102 _origins = kmalloc(ORIGIN_HASH_SIZE * sizeof(struct list_head),
105 DMERR("Device mapper: Snapshot: unable to allocate memory");
109 for (i = 0; i < ORIGIN_HASH_SIZE; i++)
110 INIT_LIST_HEAD(_origins + i);
111 init_rwsem(&_origins_lock);
116 static void exit_origin_hash(void)
121 static inline unsigned int origin_hash(struct block_device *bdev)
123 return bdev->bd_dev & ORIGIN_MASK;
126 static struct origin *__lookup_origin(struct block_device *origin)
128 struct list_head *ol;
131 ol = &_origins[origin_hash(origin)];
132 list_for_each_entry (o, ol, hash_list)
133 if (bdev_equal(o->bdev, origin))
139 static void __insert_origin(struct origin *o)
141 struct list_head *sl = &_origins[origin_hash(o->bdev)];
142 list_add_tail(&o->hash_list, sl);
146 * Make a note of the snapshot and its origin so we can look it
147 * up when the origin has a write on it.
149 static int register_snapshot(struct dm_snapshot *snap)
152 struct block_device *bdev = snap->origin->bdev;
154 down_write(&_origins_lock);
155 o = __lookup_origin(bdev);
159 o = kmalloc(sizeof(*o), GFP_KERNEL);
161 up_write(&_origins_lock);
165 /* Initialise the struct */
166 INIT_LIST_HEAD(&o->snapshots);
172 list_add_tail(&snap->list, &o->snapshots);
174 up_write(&_origins_lock);
178 static void unregister_snapshot(struct dm_snapshot *s)
182 down_write(&_origins_lock);
183 o = __lookup_origin(s->origin->bdev);
186 if (list_empty(&o->snapshots)) {
187 list_del(&o->hash_list);
191 up_write(&_origins_lock);
195 * Implementation of the exception hash tables.
197 static int init_exception_table(struct exception_table *et, uint32_t size)
201 et->hash_mask = size - 1;
202 et->table = dm_vcalloc(size, sizeof(struct list_head));
206 for (i = 0; i < size; i++)
207 INIT_LIST_HEAD(et->table + i);
212 static void exit_exception_table(struct exception_table *et, kmem_cache_t *mem)
214 struct list_head *slot;
215 struct exception *ex, *next;
218 size = et->hash_mask + 1;
219 for (i = 0; i < size; i++) {
220 slot = et->table + i;
222 list_for_each_entry_safe (ex, next, slot, hash_list)
223 kmem_cache_free(mem, ex);
229 static inline uint32_t exception_hash(struct exception_table *et, chunk_t chunk)
231 return chunk & et->hash_mask;
234 static void insert_exception(struct exception_table *eh, struct exception *e)
236 struct list_head *l = &eh->table[exception_hash(eh, e->old_chunk)];
237 list_add(&e->hash_list, l);
240 static inline void remove_exception(struct exception *e)
242 list_del(&e->hash_list);
246 * Return the exception data for a sector, or NULL if not
249 static struct exception *lookup_exception(struct exception_table *et,
252 struct list_head *slot;
255 slot = &et->table[exception_hash(et, chunk)];
256 list_for_each_entry (e, slot, hash_list)
257 if (e->old_chunk == chunk)
263 static inline struct exception *alloc_exception(void)
267 e = kmem_cache_alloc(exception_cache, GFP_NOIO);
269 e = kmem_cache_alloc(exception_cache, GFP_ATOMIC);
274 static inline void free_exception(struct exception *e)
276 kmem_cache_free(exception_cache, e);
279 static inline struct pending_exception *alloc_pending_exception(void)
281 return mempool_alloc(pending_pool, GFP_NOIO);
284 static inline void free_pending_exception(struct pending_exception *pe)
286 mempool_free(pe, pending_pool);
289 int dm_add_exception(struct dm_snapshot *s, chunk_t old, chunk_t new)
293 e = alloc_exception();
299 insert_exception(&s->complete, e);
306 static int calc_max_buckets(void)
308 /* use a fixed size of 2MB */
309 unsigned long mem = 2 * 1024 * 1024;
310 mem /= sizeof(struct list_head);
316 * Rounds a number down to a power of 2.
318 static inline uint32_t round_down(uint32_t n)
326 * Allocate room for a suitable hash table.
328 static int init_hash_tables(struct dm_snapshot *s)
330 sector_t hash_size, cow_dev_size, origin_dev_size, max_buckets;
333 * Calculate based on the size of the original volume or
336 cow_dev_size = get_dev_size(s->cow->bdev);
337 origin_dev_size = get_dev_size(s->origin->bdev);
338 max_buckets = calc_max_buckets();
340 hash_size = min(origin_dev_size, cow_dev_size) >> s->chunk_shift;
341 hash_size = min(hash_size, max_buckets);
343 /* Round it down to a power of 2 */
344 hash_size = round_down(hash_size);
345 if (init_exception_table(&s->complete, hash_size))
349 * Allocate hash table for in-flight exceptions
350 * Make this smaller than the real hash table
356 if (init_exception_table(&s->pending, hash_size)) {
357 exit_exception_table(&s->complete, exception_cache);
365 * Round a number up to the nearest 'size' boundary. size must
368 static inline ulong round_up(ulong n, ulong size)
371 return (n + size) & ~size;
375 * Construct a snapshot mapping: <origin_dev> <COW-dev> <p/n> <chunk-size>
377 static int snapshot_ctr(struct dm_target *ti, unsigned int argc, char **argv)
379 struct dm_snapshot *s;
380 unsigned long chunk_size;
389 ti->error = "dm-snapshot: requires exactly 4 arguments";
394 origin_path = argv[0];
396 persistent = toupper(*argv[2]);
398 if (persistent != 'P' && persistent != 'N') {
399 ti->error = "Persistent flag is not P or N";
404 chunk_size = simple_strtoul(argv[3], &value, 10);
405 if (chunk_size == 0 || value == NULL) {
406 ti->error = "Invalid chunk size";
411 s = kmalloc(sizeof(*s), GFP_KERNEL);
413 ti->error = "Cannot allocate snapshot context private "
419 r = dm_get_device(ti, origin_path, 0, ti->len, FMODE_READ, &s->origin);
421 ti->error = "Cannot get origin device";
425 r = dm_get_device(ti, cow_path, 0, 0,
426 FMODE_READ | FMODE_WRITE, &s->cow);
428 dm_put_device(ti, s->origin);
429 ti->error = "Cannot get COW device";
434 * Chunk size must be multiple of page size. Silently
435 * round up if it's not.
437 chunk_size = round_up(chunk_size, PAGE_SIZE >> 9);
439 /* Validate the chunk size against the device block size */
440 blocksize = s->cow->bdev->bd_disk->queue->hardsect_size;
441 if (chunk_size % (blocksize >> 9)) {
442 ti->error = "Chunk size is not a multiple of device blocksize";
447 /* Check chunk_size is a power of 2 */
448 if (chunk_size & (chunk_size - 1)) {
449 ti->error = "Chunk size is not a power of 2";
454 s->chunk_size = chunk_size;
455 s->chunk_mask = chunk_size - 1;
456 s->type = persistent;
457 s->chunk_shift = ffs(chunk_size) - 1;
460 s->have_metadata = 0;
462 init_rwsem(&s->lock);
463 s->table = ti->table;
465 /* Allocate hash table for COW data */
466 if (init_hash_tables(s)) {
467 ti->error = "Unable to allocate hash table space";
473 * Check the persistent flag - done here because we need the iobuf
474 * to check the LV header
478 if (persistent == 'P')
479 r = dm_create_persistent(&s->store, chunk_size);
481 r = dm_create_transient(&s->store, s, blocksize);
484 ti->error = "Couldn't create exception store";
489 r = kcopyd_client_create(SNAPSHOT_PAGES, &s->kcopyd_client);
491 ti->error = "Could not create kcopyd client";
495 /* Add snapshot to the list of snapshots for this origin */
496 if (register_snapshot(s)) {
498 ti->error = "Cannot register snapshot origin";
503 ti->split_io = chunk_size;
508 kcopyd_client_destroy(s->kcopyd_client);
511 s->store.destroy(&s->store);
514 exit_exception_table(&s->pending, pending_cache);
515 exit_exception_table(&s->complete, exception_cache);
518 dm_put_device(ti, s->cow);
519 dm_put_device(ti, s->origin);
528 static void snapshot_dtr(struct dm_target *ti)
530 struct dm_snapshot *s = (struct dm_snapshot *) ti->private;
532 unregister_snapshot(s);
534 exit_exception_table(&s->pending, pending_cache);
535 exit_exception_table(&s->complete, exception_cache);
537 /* Deallocate memory used */
538 s->store.destroy(&s->store);
540 dm_put_device(ti, s->origin);
541 dm_put_device(ti, s->cow);
542 kcopyd_client_destroy(s->kcopyd_client);
547 * Flush a list of buffers.
549 static void flush_bios(struct bio *bio)
556 generic_make_request(bio);
562 * Error a list of buffers.
564 static void error_bios(struct bio *bio)
571 bio_io_error(bio, bio->bi_size);
576 static struct bio *__flush_bios(struct pending_exception *pe)
578 struct pending_exception *sibling;
580 if (list_empty(&pe->siblings))
581 return bio_list_get(&pe->origin_bios);
583 sibling = list_entry(pe->siblings.next,
584 struct pending_exception, siblings);
586 list_del(&pe->siblings);
588 /* This is fine as long as kcopyd is single-threaded. If kcopyd
589 * becomes multi-threaded, we'll need some locking here.
591 bio_list_merge(&sibling->origin_bios, &pe->origin_bios);
596 static void pending_complete(struct pending_exception *pe, int success)
599 struct dm_snapshot *s = pe->snap;
600 struct bio *flush = NULL;
603 e = alloc_exception();
605 DMWARN("Unable to allocate exception.");
606 down_write(&s->lock);
607 s->store.drop_snapshot(&s->store);
609 flush = __flush_bios(pe);
612 error_bios(bio_list_get(&pe->snapshot_bios));
618 * Add a proper exception, and remove the
619 * in-flight exception from the list.
621 down_write(&s->lock);
622 insert_exception(&s->complete, e);
623 remove_exception(&pe->e);
624 flush = __flush_bios(pe);
626 /* Submit any pending write bios */
629 flush_bios(bio_list_get(&pe->snapshot_bios));
631 /* Read/write error - snapshot is unusable */
632 down_write(&s->lock);
634 DMERR("Error reading/writing snapshot");
635 s->store.drop_snapshot(&s->store);
637 remove_exception(&pe->e);
638 flush = __flush_bios(pe);
641 error_bios(bio_list_get(&pe->snapshot_bios));
643 dm_table_event(s->table);
647 free_pending_exception(pe);
653 static void commit_callback(void *context, int success)
655 struct pending_exception *pe = (struct pending_exception *) context;
656 pending_complete(pe, success);
660 * Called when the copy I/O has finished. kcopyd actually runs
661 * this code so don't block.
663 static void copy_callback(int read_err, unsigned int write_err, void *context)
665 struct pending_exception *pe = (struct pending_exception *) context;
666 struct dm_snapshot *s = pe->snap;
668 if (read_err || write_err)
669 pending_complete(pe, 0);
672 /* Update the metadata if we are persistent */
673 s->store.commit_exception(&s->store, &pe->e, commit_callback,
678 * Dispatches the copy operation to kcopyd.
680 static inline void start_copy(struct pending_exception *pe)
682 struct dm_snapshot *s = pe->snap;
683 struct io_region src, dest;
684 struct block_device *bdev = s->origin->bdev;
687 dev_size = get_dev_size(bdev);
690 src.sector = chunk_to_sector(s, pe->e.old_chunk);
691 src.count = min(s->chunk_size, dev_size - src.sector);
693 dest.bdev = s->cow->bdev;
694 dest.sector = chunk_to_sector(s, pe->e.new_chunk);
695 dest.count = src.count;
697 /* Hand over to kcopyd */
698 kcopyd_copy(s->kcopyd_client,
699 &src, 1, &dest, 0, copy_callback, pe);
703 * Looks to see if this snapshot already has a pending exception
704 * for this chunk, otherwise it allocates a new one and inserts
705 * it into the pending table.
707 * NOTE: a write lock must be held on snap->lock before calling
710 static struct pending_exception *
711 __find_pending_exception(struct dm_snapshot *s, struct bio *bio)
714 struct pending_exception *pe;
715 chunk_t chunk = sector_to_chunk(s, bio->bi_sector);
718 * Is there a pending exception for this already ?
720 e = lookup_exception(&s->pending, chunk);
722 /* cast the exception to a pending exception */
723 pe = container_of(e, struct pending_exception, e);
727 * Create a new pending exception, we don't want
728 * to hold the lock while we do this.
731 pe = alloc_pending_exception();
732 down_write(&s->lock);
734 e = lookup_exception(&s->pending, chunk);
736 free_pending_exception(pe);
737 pe = container_of(e, struct pending_exception, e);
739 pe->e.old_chunk = chunk;
740 bio_list_init(&pe->origin_bios);
741 bio_list_init(&pe->snapshot_bios);
742 INIT_LIST_HEAD(&pe->siblings);
746 if (s->store.prepare_exception(&s->store, &pe->e)) {
747 free_pending_exception(pe);
752 insert_exception(&s->pending, &pe->e);
759 static inline void remap_exception(struct dm_snapshot *s, struct exception *e,
762 bio->bi_bdev = s->cow->bdev;
763 bio->bi_sector = chunk_to_sector(s, e->new_chunk) +
764 (bio->bi_sector & s->chunk_mask);
767 static int snapshot_map(struct dm_target *ti, struct bio *bio,
768 union map_info *map_context)
771 struct dm_snapshot *s = (struct dm_snapshot *) ti->private;
774 struct pending_exception *pe;
776 chunk = sector_to_chunk(s, bio->bi_sector);
778 /* Full snapshots are not usable */
783 * Write to snapshot - higher level takes care of RW/RO
784 * flags so we should only get this if we are
787 if (bio_rw(bio) == WRITE) {
789 /* FIXME: should only take write lock if we need
790 * to copy an exception */
791 down_write(&s->lock);
793 /* If the block is already remapped - use that, else remap it */
794 e = lookup_exception(&s->complete, chunk);
796 remap_exception(s, e, bio);
800 pe = __find_pending_exception(s, bio);
803 if (s->store.drop_snapshot)
804 s->store.drop_snapshot(&s->store);
809 remap_exception(s, &pe->e, bio);
810 bio_list_add(&pe->snapshot_bios, bio);
813 /* this is protected by snap->lock */
825 * FIXME: this read path scares me because we
826 * always use the origin when we have a pending
827 * exception. However I can't think of a
828 * situation where this is wrong - ejt.
834 /* See if it it has been remapped */
835 e = lookup_exception(&s->complete, chunk);
837 remap_exception(s, e, bio);
839 bio->bi_bdev = s->origin->bdev;
847 static void snapshot_resume(struct dm_target *ti)
849 struct dm_snapshot *s = (struct dm_snapshot *) ti->private;
851 if (s->have_metadata)
854 if (s->store.read_metadata(&s->store)) {
855 down_write(&s->lock);
860 s->have_metadata = 1;
863 static int snapshot_status(struct dm_target *ti, status_type_t type,
864 char *result, unsigned int maxlen)
866 struct dm_snapshot *snap = (struct dm_snapshot *) ti->private;
869 case STATUSTYPE_INFO:
871 snprintf(result, maxlen, "Invalid");
873 if (snap->store.fraction_full) {
874 sector_t numerator, denominator;
875 snap->store.fraction_full(&snap->store,
878 snprintf(result, maxlen,
879 SECTOR_FORMAT "/" SECTOR_FORMAT,
880 numerator, denominator);
883 snprintf(result, maxlen, "Unknown");
887 case STATUSTYPE_TABLE:
889 * kdevname returns a static pointer so we need
890 * to make private copies if the output is to
893 snprintf(result, maxlen, "%s %s %c " SECTOR_FORMAT,
894 snap->origin->name, snap->cow->name,
895 snap->type, snap->chunk_size);
902 /*-----------------------------------------------------------------
904 *---------------------------------------------------------------*/
905 static void list_merge(struct list_head *l1, struct list_head *l2)
907 struct list_head *l1_n, *l2_p;
919 static int __origin_write(struct list_head *snapshots, struct bio *bio)
921 int r = 1, first = 1;
922 struct dm_snapshot *snap;
924 struct pending_exception *pe, *last = NULL;
927 /* Do all the snapshots on this origin */
928 list_for_each_entry (snap, snapshots, list) {
930 /* Only deal with valid snapshots */
934 /* Nothing to do if writing beyond end of snapshot */
935 if (bio->bi_sector >= dm_table_get_size(snap->table))
938 down_write(&snap->lock);
941 * Remember, different snapshots can have
942 * different chunk sizes.
944 chunk = sector_to_chunk(snap, bio->bi_sector);
947 * Check exception table to see if block
948 * is already remapped in this snapshot
949 * and trigger an exception if not.
951 e = lookup_exception(&snap->complete, chunk);
953 pe = __find_pending_exception(snap, bio);
955 snap->store.drop_snapshot(&snap->store);
960 list_merge(&pe->siblings,
968 up_write(&snap->lock);
972 * Now that we have a complete pe list we can start the copying.
977 down_write(&pe->snap->lock);
979 bio_list_add(&pe->origin_bios, bio);
982 up_write(&pe->snap->lock);
985 up_write(&pe->snap->lock);
987 pe = list_entry(pe->siblings.next,
988 struct pending_exception, siblings);
990 } while (pe != last);
997 * Called on a write from the origin driver.
999 static int do_origin(struct dm_dev *origin, struct bio *bio)
1004 down_read(&_origins_lock);
1005 o = __lookup_origin(origin->bdev);
1007 r = __origin_write(&o->snapshots, bio);
1008 up_read(&_origins_lock);
1014 * Origin: maps a linear range of a device, with hooks for snapshotting.
1018 * Construct an origin mapping: <dev_path>
1019 * The context for an origin is merely a 'struct dm_dev *'
1020 * pointing to the real device.
1022 static int origin_ctr(struct dm_target *ti, unsigned int argc, char **argv)
1028 ti->error = "dm-origin: incorrect number of arguments";
1032 r = dm_get_device(ti, argv[0], 0, ti->len,
1033 dm_table_get_mode(ti->table), &dev);
1035 ti->error = "Cannot get target device";
1043 static void origin_dtr(struct dm_target *ti)
1045 struct dm_dev *dev = (struct dm_dev *) ti->private;
1046 dm_put_device(ti, dev);
1049 static int origin_map(struct dm_target *ti, struct bio *bio,
1050 union map_info *map_context)
1052 struct dm_dev *dev = (struct dm_dev *) ti->private;
1053 bio->bi_bdev = dev->bdev;
1055 /* Only tell snapshots if this is a write */
1056 return (bio_rw(bio) == WRITE) ? do_origin(dev, bio) : 1;
1059 #define min_not_zero(l, r) (l == 0) ? r : ((r == 0) ? l : min(l, r))
1062 * Set the target "split_io" field to the minimum of all the snapshots'
1065 static void origin_resume(struct dm_target *ti)
1067 struct dm_dev *dev = (struct dm_dev *) ti->private;
1068 struct dm_snapshot *snap;
1070 chunk_t chunk_size = 0;
1072 down_read(&_origins_lock);
1073 o = __lookup_origin(dev->bdev);
1075 list_for_each_entry (snap, &o->snapshots, list)
1076 chunk_size = min_not_zero(chunk_size, snap->chunk_size);
1077 up_read(&_origins_lock);
1079 ti->split_io = chunk_size;
1082 static int origin_status(struct dm_target *ti, status_type_t type, char *result,
1083 unsigned int maxlen)
1085 struct dm_dev *dev = (struct dm_dev *) ti->private;
1088 case STATUSTYPE_INFO:
1092 case STATUSTYPE_TABLE:
1093 snprintf(result, maxlen, "%s", dev->name);
1100 static struct target_type origin_target = {
1101 .name = "snapshot-origin",
1102 .version = {1, 0, 1},
1103 .module = THIS_MODULE,
1107 .resume = origin_resume,
1108 .status = origin_status,
1111 static struct target_type snapshot_target = {
1113 .version = {1, 0, 1},
1114 .module = THIS_MODULE,
1115 .ctr = snapshot_ctr,
1116 .dtr = snapshot_dtr,
1117 .map = snapshot_map,
1118 .resume = snapshot_resume,
1119 .status = snapshot_status,
1122 static int __init dm_snapshot_init(void)
1126 r = dm_register_target(&snapshot_target);
1128 DMERR("snapshot target register failed %d", r);
1132 r = dm_register_target(&origin_target);
1134 DMERR("Device mapper: Origin: register failed %d\n", r);
1138 r = init_origin_hash();
1140 DMERR("init_origin_hash failed.");
1144 exception_cache = kmem_cache_create("dm-snapshot-ex",
1145 sizeof(struct exception),
1146 __alignof__(struct exception),
1148 if (!exception_cache) {
1149 DMERR("Couldn't create exception cache.");
1155 kmem_cache_create("dm-snapshot-in",
1156 sizeof(struct pending_exception),
1157 __alignof__(struct pending_exception),
1159 if (!pending_cache) {
1160 DMERR("Couldn't create pending cache.");
1165 pending_pool = mempool_create(128, mempool_alloc_slab,
1166 mempool_free_slab, pending_cache);
1167 if (!pending_pool) {
1168 DMERR("Couldn't create pending pool.");
1176 kmem_cache_destroy(pending_cache);
1178 kmem_cache_destroy(exception_cache);
1182 dm_unregister_target(&origin_target);
1184 dm_unregister_target(&snapshot_target);
1188 static void __exit dm_snapshot_exit(void)
1192 r = dm_unregister_target(&snapshot_target);
1194 DMERR("snapshot unregister failed %d", r);
1196 r = dm_unregister_target(&origin_target);
1198 DMERR("origin unregister failed %d", r);
1201 mempool_destroy(pending_pool);
1202 kmem_cache_destroy(pending_cache);
1203 kmem_cache_destroy(exception_cache);
1207 module_init(dm_snapshot_init);
1208 module_exit(dm_snapshot_exit);
1210 MODULE_DESCRIPTION(DM_NAME " snapshot target");
1211 MODULE_AUTHOR("Joe Thornber");
1212 MODULE_LICENSE("GPL");