DVB: fix nxt200x rf input switching
[linux-2.6/linux-acpi-2.6/ibm-acpi-2.6.git] / drivers / md / dm-snap.c
blob0821a2b68a73a98719cb931c82196a74bfe471d4
1 /*
2 * dm-snapshot.c
4 * Copyright (C) 2001-2002 Sistina Software (UK) Limited.
6 * This file is released under the GPL.
7 */
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>
21 #include "dm-snap.h"
22 #include "dm-bio-list.h"
23 #include "kcopyd.h"
25 #define DM_MSG_PREFIX "snapshots"
28 * The percentage increment we will wake up users at
30 #define WAKE_UP_PERCENT 5
33 * kcopyd priority of snapshot operations
35 #define SNAPSHOT_COPY_PRIORITY 2
38 * Each snapshot reserves this many pages for io
40 #define SNAPSHOT_PAGES 256
42 static struct workqueue_struct *ksnapd;
43 static void flush_queued_bios(struct work_struct *work);
45 struct pending_exception {
46 struct exception e;
49 * Origin buffers waiting for this to complete are held
50 * in a bio list
52 struct bio_list origin_bios;
53 struct bio_list snapshot_bios;
56 * Short-term queue of pending exceptions prior to submission.
58 struct list_head list;
61 * The primary pending_exception is the one that holds
62 * the ref_count and the list of origin_bios for a
63 * group of pending_exceptions. It is always last to get freed.
64 * These fields get set up when writing to the origin.
66 struct pending_exception *primary_pe;
69 * Number of pending_exceptions processing this chunk.
70 * When this drops to zero we must complete the origin bios.
71 * If incrementing or decrementing this, hold pe->snap->lock for
72 * the sibling concerned and not pe->primary_pe->snap->lock unless
73 * they are the same.
75 atomic_t ref_count;
77 /* Pointer back to snapshot context */
78 struct dm_snapshot *snap;
81 * 1 indicates the exception has already been sent to
82 * kcopyd.
84 int started;
88 * Hash table mapping origin volumes to lists of snapshots and
89 * a lock to protect it
91 static struct kmem_cache *exception_cache;
92 static struct kmem_cache *pending_cache;
93 static mempool_t *pending_pool;
96 * One of these per registered origin, held in the snapshot_origins hash
98 struct origin {
99 /* The origin device */
100 struct block_device *bdev;
102 struct list_head hash_list;
104 /* List of snapshots for this origin */
105 struct list_head snapshots;
109 * Size of the hash table for origin volumes. If we make this
110 * the size of the minors list then it should be nearly perfect
112 #define ORIGIN_HASH_SIZE 256
113 #define ORIGIN_MASK 0xFF
114 static struct list_head *_origins;
115 static struct rw_semaphore _origins_lock;
117 static int init_origin_hash(void)
119 int i;
121 _origins = kmalloc(ORIGIN_HASH_SIZE * sizeof(struct list_head),
122 GFP_KERNEL);
123 if (!_origins) {
124 DMERR("unable to allocate memory");
125 return -ENOMEM;
128 for (i = 0; i < ORIGIN_HASH_SIZE; i++)
129 INIT_LIST_HEAD(_origins + i);
130 init_rwsem(&_origins_lock);
132 return 0;
135 static void exit_origin_hash(void)
137 kfree(_origins);
140 static inline unsigned int origin_hash(struct block_device *bdev)
142 return bdev->bd_dev & ORIGIN_MASK;
145 static struct origin *__lookup_origin(struct block_device *origin)
147 struct list_head *ol;
148 struct origin *o;
150 ol = &_origins[origin_hash(origin)];
151 list_for_each_entry (o, ol, hash_list)
152 if (bdev_equal(o->bdev, origin))
153 return o;
155 return NULL;
158 static void __insert_origin(struct origin *o)
160 struct list_head *sl = &_origins[origin_hash(o->bdev)];
161 list_add_tail(&o->hash_list, sl);
165 * Make a note of the snapshot and its origin so we can look it
166 * up when the origin has a write on it.
168 static int register_snapshot(struct dm_snapshot *snap)
170 struct origin *o;
171 struct block_device *bdev = snap->origin->bdev;
173 down_write(&_origins_lock);
174 o = __lookup_origin(bdev);
176 if (!o) {
177 /* New origin */
178 o = kmalloc(sizeof(*o), GFP_KERNEL);
179 if (!o) {
180 up_write(&_origins_lock);
181 return -ENOMEM;
184 /* Initialise the struct */
185 INIT_LIST_HEAD(&o->snapshots);
186 o->bdev = bdev;
188 __insert_origin(o);
191 list_add_tail(&snap->list, &o->snapshots);
193 up_write(&_origins_lock);
194 return 0;
197 static void unregister_snapshot(struct dm_snapshot *s)
199 struct origin *o;
201 down_write(&_origins_lock);
202 o = __lookup_origin(s->origin->bdev);
204 list_del(&s->list);
205 if (list_empty(&o->snapshots)) {
206 list_del(&o->hash_list);
207 kfree(o);
210 up_write(&_origins_lock);
214 * Implementation of the exception hash tables.
216 static int init_exception_table(struct exception_table *et, uint32_t size)
218 unsigned int i;
220 et->hash_mask = size - 1;
221 et->table = dm_vcalloc(size, sizeof(struct list_head));
222 if (!et->table)
223 return -ENOMEM;
225 for (i = 0; i < size; i++)
226 INIT_LIST_HEAD(et->table + i);
228 return 0;
231 static void exit_exception_table(struct exception_table *et, struct kmem_cache *mem)
233 struct list_head *slot;
234 struct exception *ex, *next;
235 int i, size;
237 size = et->hash_mask + 1;
238 for (i = 0; i < size; i++) {
239 slot = et->table + i;
241 list_for_each_entry_safe (ex, next, slot, hash_list)
242 kmem_cache_free(mem, ex);
245 vfree(et->table);
248 static inline uint32_t exception_hash(struct exception_table *et, chunk_t chunk)
250 return chunk & et->hash_mask;
253 static void insert_exception(struct exception_table *eh, struct exception *e)
255 struct list_head *l = &eh->table[exception_hash(eh, e->old_chunk)];
256 list_add(&e->hash_list, l);
259 static inline void remove_exception(struct exception *e)
261 list_del(&e->hash_list);
265 * Return the exception data for a sector, or NULL if not
266 * remapped.
268 static struct exception *lookup_exception(struct exception_table *et,
269 chunk_t chunk)
271 struct list_head *slot;
272 struct exception *e;
274 slot = &et->table[exception_hash(et, chunk)];
275 list_for_each_entry (e, slot, hash_list)
276 if (e->old_chunk == chunk)
277 return e;
279 return NULL;
282 static inline struct exception *alloc_exception(void)
284 struct exception *e;
286 e = kmem_cache_alloc(exception_cache, GFP_NOIO);
287 if (!e)
288 e = kmem_cache_alloc(exception_cache, GFP_ATOMIC);
290 return e;
293 static inline void free_exception(struct exception *e)
295 kmem_cache_free(exception_cache, e);
298 static inline struct pending_exception *alloc_pending_exception(void)
300 return mempool_alloc(pending_pool, GFP_NOIO);
303 static inline void free_pending_exception(struct pending_exception *pe)
305 mempool_free(pe, pending_pool);
308 int dm_add_exception(struct dm_snapshot *s, chunk_t old, chunk_t new)
310 struct exception *e;
312 e = alloc_exception();
313 if (!e)
314 return -ENOMEM;
316 e->old_chunk = old;
317 e->new_chunk = new;
318 insert_exception(&s->complete, e);
319 return 0;
323 * Hard coded magic.
325 static int calc_max_buckets(void)
327 /* use a fixed size of 2MB */
328 unsigned long mem = 2 * 1024 * 1024;
329 mem /= sizeof(struct list_head);
331 return mem;
335 * Rounds a number down to a power of 2.
337 static inline uint32_t round_down(uint32_t n)
339 while (n & (n - 1))
340 n &= (n - 1);
341 return n;
345 * Allocate room for a suitable hash table.
347 static int init_hash_tables(struct dm_snapshot *s)
349 sector_t hash_size, cow_dev_size, origin_dev_size, max_buckets;
352 * Calculate based on the size of the original volume or
353 * the COW volume...
355 cow_dev_size = get_dev_size(s->cow->bdev);
356 origin_dev_size = get_dev_size(s->origin->bdev);
357 max_buckets = calc_max_buckets();
359 hash_size = min(origin_dev_size, cow_dev_size) >> s->chunk_shift;
360 hash_size = min(hash_size, max_buckets);
362 /* Round it down to a power of 2 */
363 hash_size = round_down(hash_size);
364 if (init_exception_table(&s->complete, hash_size))
365 return -ENOMEM;
368 * Allocate hash table for in-flight exceptions
369 * Make this smaller than the real hash table
371 hash_size >>= 3;
372 if (hash_size < 64)
373 hash_size = 64;
375 if (init_exception_table(&s->pending, hash_size)) {
376 exit_exception_table(&s->complete, exception_cache);
377 return -ENOMEM;
380 return 0;
384 * Round a number up to the nearest 'size' boundary. size must
385 * be a power of 2.
387 static inline ulong round_up(ulong n, ulong size)
389 size--;
390 return (n + size) & ~size;
393 static int set_chunk_size(struct dm_snapshot *s, const char *chunk_size_arg,
394 char **error)
396 unsigned long chunk_size;
397 char *value;
399 chunk_size = simple_strtoul(chunk_size_arg, &value, 10);
400 if (*chunk_size_arg == '\0' || *value != '\0') {
401 *error = "Invalid chunk size";
402 return -EINVAL;
405 if (!chunk_size) {
406 s->chunk_size = s->chunk_mask = s->chunk_shift = 0;
407 return 0;
411 * Chunk size must be multiple of page size. Silently
412 * round up if it's not.
414 chunk_size = round_up(chunk_size, PAGE_SIZE >> 9);
416 /* Check chunk_size is a power of 2 */
417 if (chunk_size & (chunk_size - 1)) {
418 *error = "Chunk size is not a power of 2";
419 return -EINVAL;
422 /* Validate the chunk size against the device block size */
423 if (chunk_size % (bdev_hardsect_size(s->cow->bdev) >> 9)) {
424 *error = "Chunk size is not a multiple of device blocksize";
425 return -EINVAL;
428 s->chunk_size = chunk_size;
429 s->chunk_mask = chunk_size - 1;
430 s->chunk_shift = ffs(chunk_size) - 1;
432 return 0;
436 * Construct a snapshot mapping: <origin_dev> <COW-dev> <p/n> <chunk-size>
438 static int snapshot_ctr(struct dm_target *ti, unsigned int argc, char **argv)
440 struct dm_snapshot *s;
441 int r = -EINVAL;
442 char persistent;
443 char *origin_path;
444 char *cow_path;
446 if (argc != 4) {
447 ti->error = "requires exactly 4 arguments";
448 r = -EINVAL;
449 goto bad1;
452 origin_path = argv[0];
453 cow_path = argv[1];
454 persistent = toupper(*argv[2]);
456 if (persistent != 'P' && persistent != 'N') {
457 ti->error = "Persistent flag is not P or N";
458 r = -EINVAL;
459 goto bad1;
462 s = kmalloc(sizeof(*s), GFP_KERNEL);
463 if (s == NULL) {
464 ti->error = "Cannot allocate snapshot context private "
465 "structure";
466 r = -ENOMEM;
467 goto bad1;
470 r = dm_get_device(ti, origin_path, 0, ti->len, FMODE_READ, &s->origin);
471 if (r) {
472 ti->error = "Cannot get origin device";
473 goto bad2;
476 r = dm_get_device(ti, cow_path, 0, 0,
477 FMODE_READ | FMODE_WRITE, &s->cow);
478 if (r) {
479 dm_put_device(ti, s->origin);
480 ti->error = "Cannot get COW device";
481 goto bad2;
484 r = set_chunk_size(s, argv[3], &ti->error);
485 if (r)
486 goto bad3;
488 s->type = persistent;
490 s->valid = 1;
491 s->active = 0;
492 s->last_percent = 0;
493 init_rwsem(&s->lock);
494 spin_lock_init(&s->pe_lock);
495 s->table = ti->table;
497 /* Allocate hash table for COW data */
498 if (init_hash_tables(s)) {
499 ti->error = "Unable to allocate hash table space";
500 r = -ENOMEM;
501 goto bad3;
504 s->store.snap = s;
506 if (persistent == 'P')
507 r = dm_create_persistent(&s->store);
508 else
509 r = dm_create_transient(&s->store);
511 if (r) {
512 ti->error = "Couldn't create exception store";
513 r = -EINVAL;
514 goto bad4;
517 r = kcopyd_client_create(SNAPSHOT_PAGES, &s->kcopyd_client);
518 if (r) {
519 ti->error = "Could not create kcopyd client";
520 goto bad5;
523 /* Metadata must only be loaded into one table at once */
524 r = s->store.read_metadata(&s->store);
525 if (r) {
526 ti->error = "Failed to read snapshot metadata";
527 goto bad6;
530 bio_list_init(&s->queued_bios);
531 INIT_WORK(&s->queued_bios_work, flush_queued_bios);
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;
541 ti->private = s;
542 ti->split_io = s->chunk_size;
544 return 0;
546 bad6:
547 kcopyd_client_destroy(s->kcopyd_client);
549 bad5:
550 s->store.destroy(&s->store);
552 bad4:
553 exit_exception_table(&s->pending, pending_cache);
554 exit_exception_table(&s->complete, exception_cache);
556 bad3:
557 dm_put_device(ti, s->cow);
558 dm_put_device(ti, s->origin);
560 bad2:
561 kfree(s);
563 bad1:
564 return r;
567 static void __free_exceptions(struct dm_snapshot *s)
569 kcopyd_client_destroy(s->kcopyd_client);
570 s->kcopyd_client = NULL;
572 exit_exception_table(&s->pending, pending_cache);
573 exit_exception_table(&s->complete, exception_cache);
575 s->store.destroy(&s->store);
578 static void snapshot_dtr(struct dm_target *ti)
580 struct dm_snapshot *s = (struct dm_snapshot *) ti->private;
582 flush_workqueue(ksnapd);
584 /* Prevent further origin writes from using this snapshot. */
585 /* After this returns there can be no new kcopyd jobs. */
586 unregister_snapshot(s);
588 __free_exceptions(s);
590 dm_put_device(ti, s->origin);
591 dm_put_device(ti, s->cow);
593 kfree(s);
597 * Flush a list of buffers.
599 static void flush_bios(struct bio *bio)
601 struct bio *n;
603 while (bio) {
604 n = bio->bi_next;
605 bio->bi_next = NULL;
606 generic_make_request(bio);
607 bio = n;
611 static void flush_queued_bios(struct work_struct *work)
613 struct dm_snapshot *s =
614 container_of(work, struct dm_snapshot, queued_bios_work);
615 struct bio *queued_bios;
616 unsigned long flags;
618 spin_lock_irqsave(&s->pe_lock, flags);
619 queued_bios = bio_list_get(&s->queued_bios);
620 spin_unlock_irqrestore(&s->pe_lock, flags);
622 flush_bios(queued_bios);
626 * Error a list of buffers.
628 static void error_bios(struct bio *bio)
630 struct bio *n;
632 while (bio) {
633 n = bio->bi_next;
634 bio->bi_next = NULL;
635 bio_io_error(bio, bio->bi_size);
636 bio = n;
640 static void __invalidate_snapshot(struct dm_snapshot *s, int err)
642 if (!s->valid)
643 return;
645 if (err == -EIO)
646 DMERR("Invalidating snapshot: Error reading/writing.");
647 else if (err == -ENOMEM)
648 DMERR("Invalidating snapshot: Unable to allocate exception.");
650 if (s->store.drop_snapshot)
651 s->store.drop_snapshot(&s->store);
653 s->valid = 0;
655 dm_table_event(s->table);
658 static void get_pending_exception(struct pending_exception *pe)
660 atomic_inc(&pe->ref_count);
663 static struct bio *put_pending_exception(struct pending_exception *pe)
665 struct pending_exception *primary_pe;
666 struct bio *origin_bios = NULL;
668 primary_pe = pe->primary_pe;
671 * If this pe is involved in a write to the origin and
672 * it is the last sibling to complete then release
673 * the bios for the original write to the origin.
675 if (primary_pe &&
676 atomic_dec_and_test(&primary_pe->ref_count))
677 origin_bios = bio_list_get(&primary_pe->origin_bios);
680 * Free the pe if it's not linked to an origin write or if
681 * it's not itself a primary pe.
683 if (!primary_pe || primary_pe != pe)
684 free_pending_exception(pe);
687 * Free the primary pe if nothing references it.
689 if (primary_pe && !atomic_read(&primary_pe->ref_count))
690 free_pending_exception(primary_pe);
692 return origin_bios;
695 static void pending_complete(struct pending_exception *pe, int success)
697 struct exception *e;
698 struct dm_snapshot *s = pe->snap;
699 struct bio *origin_bios = NULL;
700 struct bio *snapshot_bios = NULL;
701 int error = 0;
703 if (!success) {
704 /* Read/write error - snapshot is unusable */
705 down_write(&s->lock);
706 __invalidate_snapshot(s, -EIO);
707 error = 1;
708 goto out;
711 e = alloc_exception();
712 if (!e) {
713 down_write(&s->lock);
714 __invalidate_snapshot(s, -ENOMEM);
715 error = 1;
716 goto out;
718 *e = pe->e;
720 down_write(&s->lock);
721 if (!s->valid) {
722 free_exception(e);
723 error = 1;
724 goto out;
728 * Add a proper exception, and remove the
729 * in-flight exception from the list.
731 insert_exception(&s->complete, e);
733 out:
734 remove_exception(&pe->e);
735 snapshot_bios = bio_list_get(&pe->snapshot_bios);
736 origin_bios = put_pending_exception(pe);
738 up_write(&s->lock);
740 /* Submit any pending write bios */
741 if (error)
742 error_bios(snapshot_bios);
743 else
744 flush_bios(snapshot_bios);
746 flush_bios(origin_bios);
749 static void commit_callback(void *context, int success)
751 struct pending_exception *pe = (struct pending_exception *) context;
752 pending_complete(pe, success);
756 * Called when the copy I/O has finished. kcopyd actually runs
757 * this code so don't block.
759 static void copy_callback(int read_err, unsigned int write_err, void *context)
761 struct pending_exception *pe = (struct pending_exception *) context;
762 struct dm_snapshot *s = pe->snap;
764 if (read_err || write_err)
765 pending_complete(pe, 0);
767 else
768 /* Update the metadata if we are persistent */
769 s->store.commit_exception(&s->store, &pe->e, commit_callback,
770 pe);
774 * Dispatches the copy operation to kcopyd.
776 static void start_copy(struct pending_exception *pe)
778 struct dm_snapshot *s = pe->snap;
779 struct io_region src, dest;
780 struct block_device *bdev = s->origin->bdev;
781 sector_t dev_size;
783 dev_size = get_dev_size(bdev);
785 src.bdev = bdev;
786 src.sector = chunk_to_sector(s, pe->e.old_chunk);
787 src.count = min(s->chunk_size, dev_size - src.sector);
789 dest.bdev = s->cow->bdev;
790 dest.sector = chunk_to_sector(s, pe->e.new_chunk);
791 dest.count = src.count;
793 /* Hand over to kcopyd */
794 kcopyd_copy(s->kcopyd_client,
795 &src, 1, &dest, 0, copy_callback, pe);
799 * Looks to see if this snapshot already has a pending exception
800 * for this chunk, otherwise it allocates a new one and inserts
801 * it into the pending table.
803 * NOTE: a write lock must be held on snap->lock before calling
804 * this.
806 static struct pending_exception *
807 __find_pending_exception(struct dm_snapshot *s, struct bio *bio)
809 struct exception *e;
810 struct pending_exception *pe;
811 chunk_t chunk = sector_to_chunk(s, bio->bi_sector);
814 * Is there a pending exception for this already ?
816 e = lookup_exception(&s->pending, chunk);
817 if (e) {
818 /* cast the exception to a pending exception */
819 pe = container_of(e, struct pending_exception, e);
820 goto out;
824 * Create a new pending exception, we don't want
825 * to hold the lock while we do this.
827 up_write(&s->lock);
828 pe = alloc_pending_exception();
829 down_write(&s->lock);
831 if (!s->valid) {
832 free_pending_exception(pe);
833 return NULL;
836 e = lookup_exception(&s->pending, chunk);
837 if (e) {
838 free_pending_exception(pe);
839 pe = container_of(e, struct pending_exception, e);
840 goto out;
843 pe->e.old_chunk = chunk;
844 bio_list_init(&pe->origin_bios);
845 bio_list_init(&pe->snapshot_bios);
846 pe->primary_pe = NULL;
847 atomic_set(&pe->ref_count, 0);
848 pe->snap = s;
849 pe->started = 0;
851 if (s->store.prepare_exception(&s->store, &pe->e)) {
852 free_pending_exception(pe);
853 return NULL;
856 get_pending_exception(pe);
857 insert_exception(&s->pending, &pe->e);
859 out:
860 return pe;
863 static inline void remap_exception(struct dm_snapshot *s, struct exception *e,
864 struct bio *bio)
866 bio->bi_bdev = s->cow->bdev;
867 bio->bi_sector = chunk_to_sector(s, e->new_chunk) +
868 (bio->bi_sector & s->chunk_mask);
871 static int snapshot_map(struct dm_target *ti, struct bio *bio,
872 union map_info *map_context)
874 struct exception *e;
875 struct dm_snapshot *s = (struct dm_snapshot *) ti->private;
876 int r = DM_MAPIO_REMAPPED;
877 chunk_t chunk;
878 struct pending_exception *pe = NULL;
880 chunk = sector_to_chunk(s, bio->bi_sector);
882 /* Full snapshots are not usable */
883 /* To get here the table must be live so s->active is always set. */
884 if (!s->valid)
885 return -EIO;
887 if (unlikely(bio_barrier(bio)))
888 return -EOPNOTSUPP;
890 /* FIXME: should only take write lock if we need
891 * to copy an exception */
892 down_write(&s->lock);
894 if (!s->valid) {
895 r = -EIO;
896 goto out_unlock;
899 /* If the block is already remapped - use that, else remap it */
900 e = lookup_exception(&s->complete, chunk);
901 if (e) {
902 remap_exception(s, e, bio);
903 goto out_unlock;
907 * Write to snapshot - higher level takes care of RW/RO
908 * flags so we should only get this if we are
909 * writeable.
911 if (bio_rw(bio) == WRITE) {
912 pe = __find_pending_exception(s, bio);
913 if (!pe) {
914 __invalidate_snapshot(s, -ENOMEM);
915 r = -EIO;
916 goto out_unlock;
919 remap_exception(s, &pe->e, bio);
920 bio_list_add(&pe->snapshot_bios, bio);
922 r = DM_MAPIO_SUBMITTED;
924 if (!pe->started) {
925 /* this is protected by snap->lock */
926 pe->started = 1;
927 up_write(&s->lock);
928 start_copy(pe);
929 goto out;
931 } else
933 * FIXME: this read path scares me because we
934 * always use the origin when we have a pending
935 * exception. However I can't think of a
936 * situation where this is wrong - ejt.
938 bio->bi_bdev = s->origin->bdev;
940 out_unlock:
941 up_write(&s->lock);
942 out:
943 return r;
946 static void snapshot_resume(struct dm_target *ti)
948 struct dm_snapshot *s = (struct dm_snapshot *) ti->private;
950 down_write(&s->lock);
951 s->active = 1;
952 up_write(&s->lock);
955 static int snapshot_status(struct dm_target *ti, status_type_t type,
956 char *result, unsigned int maxlen)
958 struct dm_snapshot *snap = (struct dm_snapshot *) ti->private;
960 switch (type) {
961 case STATUSTYPE_INFO:
962 if (!snap->valid)
963 snprintf(result, maxlen, "Invalid");
964 else {
965 if (snap->store.fraction_full) {
966 sector_t numerator, denominator;
967 snap->store.fraction_full(&snap->store,
968 &numerator,
969 &denominator);
970 snprintf(result, maxlen, "%llu/%llu",
971 (unsigned long long)numerator,
972 (unsigned long long)denominator);
974 else
975 snprintf(result, maxlen, "Unknown");
977 break;
979 case STATUSTYPE_TABLE:
981 * kdevname returns a static pointer so we need
982 * to make private copies if the output is to
983 * make sense.
985 snprintf(result, maxlen, "%s %s %c %llu",
986 snap->origin->name, snap->cow->name,
987 snap->type,
988 (unsigned long long)snap->chunk_size);
989 break;
992 return 0;
995 /*-----------------------------------------------------------------
996 * Origin methods
997 *---------------------------------------------------------------*/
998 static int __origin_write(struct list_head *snapshots, struct bio *bio)
1000 int r = DM_MAPIO_REMAPPED, first = 0;
1001 struct dm_snapshot *snap;
1002 struct exception *e;
1003 struct pending_exception *pe, *next_pe, *primary_pe = NULL;
1004 chunk_t chunk;
1005 LIST_HEAD(pe_queue);
1007 /* Do all the snapshots on this origin */
1008 list_for_each_entry (snap, snapshots, list) {
1010 down_write(&snap->lock);
1012 /* Only deal with valid and active snapshots */
1013 if (!snap->valid || !snap->active)
1014 goto next_snapshot;
1016 /* Nothing to do if writing beyond end of snapshot */
1017 if (bio->bi_sector >= dm_table_get_size(snap->table))
1018 goto next_snapshot;
1021 * Remember, different snapshots can have
1022 * different chunk sizes.
1024 chunk = sector_to_chunk(snap, bio->bi_sector);
1027 * Check exception table to see if block
1028 * is already remapped in this snapshot
1029 * and trigger an exception if not.
1031 * ref_count is initialised to 1 so pending_complete()
1032 * won't destroy the primary_pe while we're inside this loop.
1034 e = lookup_exception(&snap->complete, chunk);
1035 if (e)
1036 goto next_snapshot;
1038 pe = __find_pending_exception(snap, bio);
1039 if (!pe) {
1040 __invalidate_snapshot(snap, -ENOMEM);
1041 goto next_snapshot;
1044 if (!primary_pe) {
1046 * Either every pe here has same
1047 * primary_pe or none has one yet.
1049 if (pe->primary_pe)
1050 primary_pe = pe->primary_pe;
1051 else {
1052 primary_pe = pe;
1053 first = 1;
1056 bio_list_add(&primary_pe->origin_bios, bio);
1058 r = DM_MAPIO_SUBMITTED;
1061 if (!pe->primary_pe) {
1062 pe->primary_pe = primary_pe;
1063 get_pending_exception(primary_pe);
1066 if (!pe->started) {
1067 pe->started = 1;
1068 list_add_tail(&pe->list, &pe_queue);
1071 next_snapshot:
1072 up_write(&snap->lock);
1075 if (!primary_pe)
1076 return r;
1079 * If this is the first time we're processing this chunk and
1080 * ref_count is now 1 it means all the pending exceptions
1081 * got completed while we were in the loop above, so it falls to
1082 * us here to remove the primary_pe and submit any origin_bios.
1085 if (first && atomic_dec_and_test(&primary_pe->ref_count)) {
1086 flush_bios(bio_list_get(&primary_pe->origin_bios));
1087 free_pending_exception(primary_pe);
1088 /* If we got here, pe_queue is necessarily empty. */
1089 return r;
1093 * Now that we have a complete pe list we can start the copying.
1095 list_for_each_entry_safe(pe, next_pe, &pe_queue, list)
1096 start_copy(pe);
1098 return r;
1102 * Called on a write from the origin driver.
1104 static int do_origin(struct dm_dev *origin, struct bio *bio)
1106 struct origin *o;
1107 int r = DM_MAPIO_REMAPPED;
1109 down_read(&_origins_lock);
1110 o = __lookup_origin(origin->bdev);
1111 if (o)
1112 r = __origin_write(&o->snapshots, bio);
1113 up_read(&_origins_lock);
1115 return r;
1119 * Origin: maps a linear range of a device, with hooks for snapshotting.
1123 * Construct an origin mapping: <dev_path>
1124 * The context for an origin is merely a 'struct dm_dev *'
1125 * pointing to the real device.
1127 static int origin_ctr(struct dm_target *ti, unsigned int argc, char **argv)
1129 int r;
1130 struct dm_dev *dev;
1132 if (argc != 1) {
1133 ti->error = "origin: incorrect number of arguments";
1134 return -EINVAL;
1137 r = dm_get_device(ti, argv[0], 0, ti->len,
1138 dm_table_get_mode(ti->table), &dev);
1139 if (r) {
1140 ti->error = "Cannot get target device";
1141 return r;
1144 ti->private = dev;
1145 return 0;
1148 static void origin_dtr(struct dm_target *ti)
1150 struct dm_dev *dev = (struct dm_dev *) ti->private;
1151 dm_put_device(ti, dev);
1154 static int origin_map(struct dm_target *ti, struct bio *bio,
1155 union map_info *map_context)
1157 struct dm_dev *dev = (struct dm_dev *) ti->private;
1158 bio->bi_bdev = dev->bdev;
1160 if (unlikely(bio_barrier(bio)))
1161 return -EOPNOTSUPP;
1163 /* Only tell snapshots if this is a write */
1164 return (bio_rw(bio) == WRITE) ? do_origin(dev, bio) : DM_MAPIO_REMAPPED;
1167 #define min_not_zero(l, r) (l == 0) ? r : ((r == 0) ? l : min(l, r))
1170 * Set the target "split_io" field to the minimum of all the snapshots'
1171 * chunk sizes.
1173 static void origin_resume(struct dm_target *ti)
1175 struct dm_dev *dev = (struct dm_dev *) ti->private;
1176 struct dm_snapshot *snap;
1177 struct origin *o;
1178 chunk_t chunk_size = 0;
1180 down_read(&_origins_lock);
1181 o = __lookup_origin(dev->bdev);
1182 if (o)
1183 list_for_each_entry (snap, &o->snapshots, list)
1184 chunk_size = min_not_zero(chunk_size, snap->chunk_size);
1185 up_read(&_origins_lock);
1187 ti->split_io = chunk_size;
1190 static int origin_status(struct dm_target *ti, status_type_t type, char *result,
1191 unsigned int maxlen)
1193 struct dm_dev *dev = (struct dm_dev *) ti->private;
1195 switch (type) {
1196 case STATUSTYPE_INFO:
1197 result[0] = '\0';
1198 break;
1200 case STATUSTYPE_TABLE:
1201 snprintf(result, maxlen, "%s", dev->name);
1202 break;
1205 return 0;
1208 static struct target_type origin_target = {
1209 .name = "snapshot-origin",
1210 .version = {1, 5, 0},
1211 .module = THIS_MODULE,
1212 .ctr = origin_ctr,
1213 .dtr = origin_dtr,
1214 .map = origin_map,
1215 .resume = origin_resume,
1216 .status = origin_status,
1219 static struct target_type snapshot_target = {
1220 .name = "snapshot",
1221 .version = {1, 5, 0},
1222 .module = THIS_MODULE,
1223 .ctr = snapshot_ctr,
1224 .dtr = snapshot_dtr,
1225 .map = snapshot_map,
1226 .resume = snapshot_resume,
1227 .status = snapshot_status,
1230 static int __init dm_snapshot_init(void)
1232 int r;
1234 r = dm_register_target(&snapshot_target);
1235 if (r) {
1236 DMERR("snapshot target register failed %d", r);
1237 return r;
1240 r = dm_register_target(&origin_target);
1241 if (r < 0) {
1242 DMERR("Origin target register failed %d", r);
1243 goto bad1;
1246 r = init_origin_hash();
1247 if (r) {
1248 DMERR("init_origin_hash failed.");
1249 goto bad2;
1252 exception_cache = kmem_cache_create("dm-snapshot-ex",
1253 sizeof(struct exception),
1254 __alignof__(struct exception),
1255 0, NULL, NULL);
1256 if (!exception_cache) {
1257 DMERR("Couldn't create exception cache.");
1258 r = -ENOMEM;
1259 goto bad3;
1262 pending_cache =
1263 kmem_cache_create("dm-snapshot-in",
1264 sizeof(struct pending_exception),
1265 __alignof__(struct pending_exception),
1266 0, NULL, NULL);
1267 if (!pending_cache) {
1268 DMERR("Couldn't create pending cache.");
1269 r = -ENOMEM;
1270 goto bad4;
1273 pending_pool = mempool_create_slab_pool(128, pending_cache);
1274 if (!pending_pool) {
1275 DMERR("Couldn't create pending pool.");
1276 r = -ENOMEM;
1277 goto bad5;
1280 ksnapd = create_singlethread_workqueue("ksnapd");
1281 if (!ksnapd) {
1282 DMERR("Failed to create ksnapd workqueue.");
1283 r = -ENOMEM;
1284 goto bad6;
1287 return 0;
1289 bad6:
1290 mempool_destroy(pending_pool);
1291 bad5:
1292 kmem_cache_destroy(pending_cache);
1293 bad4:
1294 kmem_cache_destroy(exception_cache);
1295 bad3:
1296 exit_origin_hash();
1297 bad2:
1298 dm_unregister_target(&origin_target);
1299 bad1:
1300 dm_unregister_target(&snapshot_target);
1301 return r;
1304 static void __exit dm_snapshot_exit(void)
1306 int r;
1308 destroy_workqueue(ksnapd);
1310 r = dm_unregister_target(&snapshot_target);
1311 if (r)
1312 DMERR("snapshot unregister failed %d", r);
1314 r = dm_unregister_target(&origin_target);
1315 if (r)
1316 DMERR("origin unregister failed %d", r);
1318 exit_origin_hash();
1319 mempool_destroy(pending_pool);
1320 kmem_cache_destroy(pending_cache);
1321 kmem_cache_destroy(exception_cache);
1324 /* Module hooks */
1325 module_init(dm_snapshot_init);
1326 module_exit(dm_snapshot_exit);
1328 MODULE_DESCRIPTION(DM_NAME " snapshot target");
1329 MODULE_AUTHOR("Joe Thornber");
1330 MODULE_LICENSE("GPL");