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;
374 static void read_snapshot_metadata(struct dm_snapshot *s)
376 if (s->store.read_metadata(&s->store)) {
377 down_write(&s->lock);
384 * Construct a snapshot mapping: <origin_dev> <COW-dev> <p/n> <chunk-size>
386 static int snapshot_ctr(struct dm_target *ti, unsigned int argc, char **argv)
388 struct dm_snapshot *s;
389 unsigned long chunk_size;
398 ti->error = "dm-snapshot: requires exactly 4 arguments";
403 origin_path = argv[0];
405 persistent = toupper(*argv[2]);
407 if (persistent != 'P' && persistent != 'N') {
408 ti->error = "Persistent flag is not P or N";
413 chunk_size = simple_strtoul(argv[3], &value, 10);
414 if (chunk_size == 0 || value == NULL) {
415 ti->error = "Invalid chunk size";
420 s = kmalloc(sizeof(*s), GFP_KERNEL);
422 ti->error = "Cannot allocate snapshot context private "
428 r = dm_get_device(ti, origin_path, 0, ti->len, FMODE_READ, &s->origin);
430 ti->error = "Cannot get origin device";
434 r = dm_get_device(ti, cow_path, 0, 0,
435 FMODE_READ | FMODE_WRITE, &s->cow);
437 dm_put_device(ti, s->origin);
438 ti->error = "Cannot get COW device";
443 * Chunk size must be multiple of page size. Silently
444 * round up if it's not.
446 chunk_size = round_up(chunk_size, PAGE_SIZE >> 9);
448 /* Validate the chunk size against the device block size */
449 blocksize = s->cow->bdev->bd_disk->queue->hardsect_size;
450 if (chunk_size % (blocksize >> 9)) {
451 ti->error = "Chunk size is not a multiple of device blocksize";
456 /* Check chunk_size is a power of 2 */
457 if (chunk_size & (chunk_size - 1)) {
458 ti->error = "Chunk size is not a power of 2";
463 s->chunk_size = chunk_size;
464 s->chunk_mask = chunk_size - 1;
465 s->type = persistent;
466 s->chunk_shift = ffs(chunk_size) - 1;
471 init_rwsem(&s->lock);
472 s->table = ti->table;
474 /* Allocate hash table for COW data */
475 if (init_hash_tables(s)) {
476 ti->error = "Unable to allocate hash table space";
482 * Check the persistent flag - done here because we need the iobuf
483 * to check the LV header
487 if (persistent == 'P')
488 r = dm_create_persistent(&s->store, chunk_size);
490 r = dm_create_transient(&s->store, s, blocksize);
493 ti->error = "Couldn't create exception store";
498 r = kcopyd_client_create(SNAPSHOT_PAGES, &s->kcopyd_client);
500 ti->error = "Could not create kcopyd client";
504 /* Metadata must only be loaded into one table at once */
505 read_snapshot_metadata(s);
507 /* Add snapshot to the list of snapshots for this origin */
508 /* Exceptions aren't triggered till snapshot_resume() is called */
509 if (register_snapshot(s)) {
511 ti->error = "Cannot register snapshot origin";
516 ti->split_io = chunk_size;
521 kcopyd_client_destroy(s->kcopyd_client);
524 s->store.destroy(&s->store);
527 exit_exception_table(&s->pending, pending_cache);
528 exit_exception_table(&s->complete, exception_cache);
531 dm_put_device(ti, s->cow);
532 dm_put_device(ti, s->origin);
541 static void snapshot_dtr(struct dm_target *ti)
543 struct dm_snapshot *s = (struct dm_snapshot *) ti->private;
545 unregister_snapshot(s);
547 exit_exception_table(&s->pending, pending_cache);
548 exit_exception_table(&s->complete, exception_cache);
550 /* Deallocate memory used */
551 s->store.destroy(&s->store);
553 dm_put_device(ti, s->origin);
554 dm_put_device(ti, s->cow);
555 kcopyd_client_destroy(s->kcopyd_client);
560 * Flush a list of buffers.
562 static void flush_bios(struct bio *bio)
569 generic_make_request(bio);
575 * Error a list of buffers.
577 static void error_bios(struct bio *bio)
584 bio_io_error(bio, bio->bi_size);
589 static struct bio *__flush_bios(struct pending_exception *pe)
591 struct pending_exception *sibling;
593 if (list_empty(&pe->siblings))
594 return bio_list_get(&pe->origin_bios);
596 sibling = list_entry(pe->siblings.next,
597 struct pending_exception, siblings);
599 list_del(&pe->siblings);
601 /* This is fine as long as kcopyd is single-threaded. If kcopyd
602 * becomes multi-threaded, we'll need some locking here.
604 bio_list_merge(&sibling->origin_bios, &pe->origin_bios);
609 static void pending_complete(struct pending_exception *pe, int success)
612 struct dm_snapshot *s = pe->snap;
613 struct bio *flush = NULL;
616 e = alloc_exception();
618 DMWARN("Unable to allocate exception.");
619 down_write(&s->lock);
620 s->store.drop_snapshot(&s->store);
622 flush = __flush_bios(pe);
625 error_bios(bio_list_get(&pe->snapshot_bios));
631 * Add a proper exception, and remove the
632 * in-flight exception from the list.
634 down_write(&s->lock);
635 insert_exception(&s->complete, e);
636 remove_exception(&pe->e);
637 flush = __flush_bios(pe);
639 /* Submit any pending write bios */
642 flush_bios(bio_list_get(&pe->snapshot_bios));
644 /* Read/write error - snapshot is unusable */
645 down_write(&s->lock);
647 DMERR("Error reading/writing snapshot");
648 s->store.drop_snapshot(&s->store);
650 remove_exception(&pe->e);
651 flush = __flush_bios(pe);
654 error_bios(bio_list_get(&pe->snapshot_bios));
656 dm_table_event(s->table);
660 free_pending_exception(pe);
666 static void commit_callback(void *context, int success)
668 struct pending_exception *pe = (struct pending_exception *) context;
669 pending_complete(pe, success);
673 * Called when the copy I/O has finished. kcopyd actually runs
674 * this code so don't block.
676 static void copy_callback(int read_err, unsigned int write_err, void *context)
678 struct pending_exception *pe = (struct pending_exception *) context;
679 struct dm_snapshot *s = pe->snap;
681 if (read_err || write_err)
682 pending_complete(pe, 0);
685 /* Update the metadata if we are persistent */
686 s->store.commit_exception(&s->store, &pe->e, commit_callback,
691 * Dispatches the copy operation to kcopyd.
693 static void start_copy(struct pending_exception *pe)
695 struct dm_snapshot *s = pe->snap;
696 struct io_region src, dest;
697 struct block_device *bdev = s->origin->bdev;
700 dev_size = get_dev_size(bdev);
703 src.sector = chunk_to_sector(s, pe->e.old_chunk);
704 src.count = min(s->chunk_size, dev_size - src.sector);
706 dest.bdev = s->cow->bdev;
707 dest.sector = chunk_to_sector(s, pe->e.new_chunk);
708 dest.count = src.count;
710 /* Hand over to kcopyd */
711 kcopyd_copy(s->kcopyd_client,
712 &src, 1, &dest, 0, copy_callback, pe);
716 * Looks to see if this snapshot already has a pending exception
717 * for this chunk, otherwise it allocates a new one and inserts
718 * it into the pending table.
720 * NOTE: a write lock must be held on snap->lock before calling
723 static struct pending_exception *
724 __find_pending_exception(struct dm_snapshot *s, struct bio *bio)
727 struct pending_exception *pe;
728 chunk_t chunk = sector_to_chunk(s, bio->bi_sector);
731 * Is there a pending exception for this already ?
733 e = lookup_exception(&s->pending, chunk);
735 /* cast the exception to a pending exception */
736 pe = container_of(e, struct pending_exception, e);
740 * Create a new pending exception, we don't want
741 * to hold the lock while we do this.
744 pe = alloc_pending_exception();
745 down_write(&s->lock);
747 e = lookup_exception(&s->pending, chunk);
749 free_pending_exception(pe);
750 pe = container_of(e, struct pending_exception, e);
752 pe->e.old_chunk = chunk;
753 bio_list_init(&pe->origin_bios);
754 bio_list_init(&pe->snapshot_bios);
755 INIT_LIST_HEAD(&pe->siblings);
759 if (s->store.prepare_exception(&s->store, &pe->e)) {
760 free_pending_exception(pe);
765 insert_exception(&s->pending, &pe->e);
772 static inline void remap_exception(struct dm_snapshot *s, struct exception *e,
775 bio->bi_bdev = s->cow->bdev;
776 bio->bi_sector = chunk_to_sector(s, e->new_chunk) +
777 (bio->bi_sector & s->chunk_mask);
780 static int snapshot_map(struct dm_target *ti, struct bio *bio,
781 union map_info *map_context)
784 struct dm_snapshot *s = (struct dm_snapshot *) ti->private;
787 struct pending_exception *pe;
789 chunk = sector_to_chunk(s, bio->bi_sector);
791 /* Full snapshots are not usable */
795 if (unlikely(bio_barrier(bio)))
799 * Write to snapshot - higher level takes care of RW/RO
800 * flags so we should only get this if we are
803 if (bio_rw(bio) == WRITE) {
805 /* FIXME: should only take write lock if we need
806 * to copy an exception */
807 down_write(&s->lock);
809 /* If the block is already remapped - use that, else remap it */
810 e = lookup_exception(&s->complete, chunk);
812 remap_exception(s, e, bio);
816 pe = __find_pending_exception(s, bio);
819 if (s->store.drop_snapshot)
820 s->store.drop_snapshot(&s->store);
825 remap_exception(s, &pe->e, bio);
826 bio_list_add(&pe->snapshot_bios, bio);
829 /* this is protected by snap->lock */
841 * FIXME: this read path scares me because we
842 * always use the origin when we have a pending
843 * exception. However I can't think of a
844 * situation where this is wrong - ejt.
850 /* See if it it has been remapped */
851 e = lookup_exception(&s->complete, chunk);
853 remap_exception(s, e, bio);
855 bio->bi_bdev = s->origin->bdev;
863 static void snapshot_resume(struct dm_target *ti)
865 struct dm_snapshot *s = (struct dm_snapshot *) ti->private;
867 down_write(&s->lock);
872 static int snapshot_status(struct dm_target *ti, status_type_t type,
873 char *result, unsigned int maxlen)
875 struct dm_snapshot *snap = (struct dm_snapshot *) ti->private;
878 case STATUSTYPE_INFO:
880 snprintf(result, maxlen, "Invalid");
882 if (snap->store.fraction_full) {
883 sector_t numerator, denominator;
884 snap->store.fraction_full(&snap->store,
887 snprintf(result, maxlen,
888 SECTOR_FORMAT "/" SECTOR_FORMAT,
889 numerator, denominator);
892 snprintf(result, maxlen, "Unknown");
896 case STATUSTYPE_TABLE:
898 * kdevname returns a static pointer so we need
899 * to make private copies if the output is to
902 snprintf(result, maxlen, "%s %s %c " SECTOR_FORMAT,
903 snap->origin->name, snap->cow->name,
904 snap->type, snap->chunk_size);
911 /*-----------------------------------------------------------------
913 *---------------------------------------------------------------*/
914 static void list_merge(struct list_head *l1, struct list_head *l2)
916 struct list_head *l1_n, *l2_p;
928 static int __origin_write(struct list_head *snapshots, struct bio *bio)
930 int r = 1, first = 1;
931 struct dm_snapshot *snap;
933 struct pending_exception *pe, *last = NULL;
936 /* Do all the snapshots on this origin */
937 list_for_each_entry (snap, snapshots, list) {
939 /* Only deal with valid and active snapshots */
940 if (!snap->valid || !snap->active)
943 /* Nothing to do if writing beyond end of snapshot */
944 if (bio->bi_sector >= dm_table_get_size(snap->table))
947 down_write(&snap->lock);
950 * Remember, different snapshots can have
951 * different chunk sizes.
953 chunk = sector_to_chunk(snap, bio->bi_sector);
956 * Check exception table to see if block
957 * is already remapped in this snapshot
958 * and trigger an exception if not.
960 e = lookup_exception(&snap->complete, chunk);
962 pe = __find_pending_exception(snap, bio);
964 snap->store.drop_snapshot(&snap->store);
969 list_merge(&pe->siblings,
977 up_write(&snap->lock);
981 * Now that we have a complete pe list we can start the copying.
986 down_write(&pe->snap->lock);
988 bio_list_add(&pe->origin_bios, bio);
991 up_write(&pe->snap->lock);
994 up_write(&pe->snap->lock);
996 pe = list_entry(pe->siblings.next,
997 struct pending_exception, siblings);
999 } while (pe != last);
1006 * Called on a write from the origin driver.
1008 static int do_origin(struct dm_dev *origin, struct bio *bio)
1013 down_read(&_origins_lock);
1014 o = __lookup_origin(origin->bdev);
1016 r = __origin_write(&o->snapshots, bio);
1017 up_read(&_origins_lock);
1023 * Origin: maps a linear range of a device, with hooks for snapshotting.
1027 * Construct an origin mapping: <dev_path>
1028 * The context for an origin is merely a 'struct dm_dev *'
1029 * pointing to the real device.
1031 static int origin_ctr(struct dm_target *ti, unsigned int argc, char **argv)
1037 ti->error = "dm-origin: incorrect number of arguments";
1041 r = dm_get_device(ti, argv[0], 0, ti->len,
1042 dm_table_get_mode(ti->table), &dev);
1044 ti->error = "Cannot get target device";
1052 static void origin_dtr(struct dm_target *ti)
1054 struct dm_dev *dev = (struct dm_dev *) ti->private;
1055 dm_put_device(ti, dev);
1058 static int origin_map(struct dm_target *ti, struct bio *bio,
1059 union map_info *map_context)
1061 struct dm_dev *dev = (struct dm_dev *) ti->private;
1062 bio->bi_bdev = dev->bdev;
1064 if (unlikely(bio_barrier(bio)))
1067 /* Only tell snapshots if this is a write */
1068 return (bio_rw(bio) == WRITE) ? do_origin(dev, bio) : 1;
1071 #define min_not_zero(l, r) (l == 0) ? r : ((r == 0) ? l : min(l, r))
1074 * Set the target "split_io" field to the minimum of all the snapshots'
1077 static void origin_resume(struct dm_target *ti)
1079 struct dm_dev *dev = (struct dm_dev *) ti->private;
1080 struct dm_snapshot *snap;
1082 chunk_t chunk_size = 0;
1084 down_read(&_origins_lock);
1085 o = __lookup_origin(dev->bdev);
1087 list_for_each_entry (snap, &o->snapshots, list)
1088 chunk_size = min_not_zero(chunk_size, snap->chunk_size);
1089 up_read(&_origins_lock);
1091 ti->split_io = chunk_size;
1094 static int origin_status(struct dm_target *ti, status_type_t type, char *result,
1095 unsigned int maxlen)
1097 struct dm_dev *dev = (struct dm_dev *) ti->private;
1100 case STATUSTYPE_INFO:
1104 case STATUSTYPE_TABLE:
1105 snprintf(result, maxlen, "%s", dev->name);
1112 static struct target_type origin_target = {
1113 .name = "snapshot-origin",
1114 .version = {1, 1, 0},
1115 .module = THIS_MODULE,
1119 .resume = origin_resume,
1120 .status = origin_status,
1123 static struct target_type snapshot_target = {
1125 .version = {1, 1, 0},
1126 .module = THIS_MODULE,
1127 .ctr = snapshot_ctr,
1128 .dtr = snapshot_dtr,
1129 .map = snapshot_map,
1130 .resume = snapshot_resume,
1131 .status = snapshot_status,
1134 static int __init dm_snapshot_init(void)
1138 r = dm_register_target(&snapshot_target);
1140 DMERR("snapshot target register failed %d", r);
1144 r = dm_register_target(&origin_target);
1146 DMERR("Device mapper: Origin: register failed %d\n", r);
1150 r = init_origin_hash();
1152 DMERR("init_origin_hash failed.");
1156 exception_cache = kmem_cache_create("dm-snapshot-ex",
1157 sizeof(struct exception),
1158 __alignof__(struct exception),
1160 if (!exception_cache) {
1161 DMERR("Couldn't create exception cache.");
1167 kmem_cache_create("dm-snapshot-in",
1168 sizeof(struct pending_exception),
1169 __alignof__(struct pending_exception),
1171 if (!pending_cache) {
1172 DMERR("Couldn't create pending cache.");
1177 pending_pool = mempool_create(128, mempool_alloc_slab,
1178 mempool_free_slab, pending_cache);
1179 if (!pending_pool) {
1180 DMERR("Couldn't create pending pool.");
1188 kmem_cache_destroy(pending_cache);
1190 kmem_cache_destroy(exception_cache);
1194 dm_unregister_target(&origin_target);
1196 dm_unregister_target(&snapshot_target);
1200 static void __exit dm_snapshot_exit(void)
1204 r = dm_unregister_target(&snapshot_target);
1206 DMERR("snapshot unregister failed %d", r);
1208 r = dm_unregister_target(&origin_target);
1210 DMERR("origin unregister failed %d", r);
1213 mempool_destroy(pending_pool);
1214 kmem_cache_destroy(pending_cache);
1215 kmem_cache_destroy(exception_cache);
1219 module_init(dm_snapshot_init);
1220 module_exit(dm_snapshot_exit);
1222 MODULE_DESCRIPTION(DM_NAME " snapshot target");
1223 MODULE_AUTHOR("Joe Thornber");
1224 MODULE_LICENSE("GPL");