dm snapshot: rename dm_snap_exception to dm_exception
[linux-2.6.git] / 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/device-mapper.h>
11 #include <linux/delay.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 #include <linux/log2.h>
21 #include <linux/dm-kcopyd.h>
22 #include <linux/workqueue.h>
23
24 #include "dm-exception-store.h"
25
26 #define DM_MSG_PREFIX "snapshots"
27
28 /*
29  * The percentage increment we will wake up users at
30  */
31 #define WAKE_UP_PERCENT 5
32
33 /*
34  * kcopyd priority of snapshot operations
35  */
36 #define SNAPSHOT_COPY_PRIORITY 2
37
38 /*
39  * Reserve 1MB for each snapshot initially (with minimum of 1 page).
40  */
41 #define SNAPSHOT_PAGES (((1UL << 20) >> PAGE_SHIFT) ? : 1)
42
43 /*
44  * The size of the mempool used to track chunks in use.
45  */
46 #define MIN_IOS 256
47
48 #define DM_TRACKED_CHUNK_HASH_SIZE      16
49 #define DM_TRACKED_CHUNK_HASH(x)        ((unsigned long)(x) & \
50                                          (DM_TRACKED_CHUNK_HASH_SIZE - 1))
51
52 struct exception_table {
53         uint32_t hash_mask;
54         unsigned hash_shift;
55         struct list_head *table;
56 };
57
58 struct dm_snapshot {
59         struct rw_semaphore lock;
60
61         struct dm_dev *origin;
62
63         /* List of snapshots per Origin */
64         struct list_head list;
65
66         /* You can't use a snapshot if this is 0 (e.g. if full) */
67         int valid;
68
69         /* Origin writes don't trigger exceptions until this is set */
70         int active;
71
72         mempool_t *pending_pool;
73
74         atomic_t pending_exceptions_count;
75
76         struct exception_table pending;
77         struct exception_table complete;
78
79         /*
80          * pe_lock protects all pending_exception operations and access
81          * as well as the snapshot_bios list.
82          */
83         spinlock_t pe_lock;
84
85         /* The on disk metadata handler */
86         struct dm_exception_store *store;
87
88         struct dm_kcopyd_client *kcopyd_client;
89
90         /* Queue of snapshot writes for ksnapd to flush */
91         struct bio_list queued_bios;
92         struct work_struct queued_bios_work;
93
94         /* Chunks with outstanding reads */
95         mempool_t *tracked_chunk_pool;
96         spinlock_t tracked_chunk_lock;
97         struct hlist_head tracked_chunk_hash[DM_TRACKED_CHUNK_HASH_SIZE];
98 };
99
100 static struct workqueue_struct *ksnapd;
101 static void flush_queued_bios(struct work_struct *work);
102
103 static sector_t chunk_to_sector(struct dm_exception_store *store,
104                                 chunk_t chunk)
105 {
106         return chunk << store->chunk_shift;
107 }
108
109 static int bdev_equal(struct block_device *lhs, struct block_device *rhs)
110 {
111         /*
112          * There is only ever one instance of a particular block
113          * device so we can compare pointers safely.
114          */
115         return lhs == rhs;
116 }
117
118 struct dm_snap_pending_exception {
119         struct dm_exception e;
120
121         /*
122          * Origin buffers waiting for this to complete are held
123          * in a bio list
124          */
125         struct bio_list origin_bios;
126         struct bio_list snapshot_bios;
127
128         /*
129          * Short-term queue of pending exceptions prior to submission.
130          */
131         struct list_head list;
132
133         /*
134          * The primary pending_exception is the one that holds
135          * the ref_count and the list of origin_bios for a
136          * group of pending_exceptions.  It is always last to get freed.
137          * These fields get set up when writing to the origin.
138          */
139         struct dm_snap_pending_exception *primary_pe;
140
141         /*
142          * Number of pending_exceptions processing this chunk.
143          * When this drops to zero we must complete the origin bios.
144          * If incrementing or decrementing this, hold pe->snap->lock for
145          * the sibling concerned and not pe->primary_pe->snap->lock unless
146          * they are the same.
147          */
148         atomic_t ref_count;
149
150         /* Pointer back to snapshot context */
151         struct dm_snapshot *snap;
152
153         /*
154          * 1 indicates the exception has already been sent to
155          * kcopyd.
156          */
157         int started;
158 };
159
160 /*
161  * Hash table mapping origin volumes to lists of snapshots and
162  * a lock to protect it
163  */
164 static struct kmem_cache *exception_cache;
165 static struct kmem_cache *pending_cache;
166
167 struct dm_snap_tracked_chunk {
168         struct hlist_node node;
169         chunk_t chunk;
170 };
171
172 static struct kmem_cache *tracked_chunk_cache;
173
174 static struct dm_snap_tracked_chunk *track_chunk(struct dm_snapshot *s,
175                                                  chunk_t chunk)
176 {
177         struct dm_snap_tracked_chunk *c = mempool_alloc(s->tracked_chunk_pool,
178                                                         GFP_NOIO);
179         unsigned long flags;
180
181         c->chunk = chunk;
182
183         spin_lock_irqsave(&s->tracked_chunk_lock, flags);
184         hlist_add_head(&c->node,
185                        &s->tracked_chunk_hash[DM_TRACKED_CHUNK_HASH(chunk)]);
186         spin_unlock_irqrestore(&s->tracked_chunk_lock, flags);
187
188         return c;
189 }
190
191 static void stop_tracking_chunk(struct dm_snapshot *s,
192                                 struct dm_snap_tracked_chunk *c)
193 {
194         unsigned long flags;
195
196         spin_lock_irqsave(&s->tracked_chunk_lock, flags);
197         hlist_del(&c->node);
198         spin_unlock_irqrestore(&s->tracked_chunk_lock, flags);
199
200         mempool_free(c, s->tracked_chunk_pool);
201 }
202
203 static int __chunk_is_tracked(struct dm_snapshot *s, chunk_t chunk)
204 {
205         struct dm_snap_tracked_chunk *c;
206         struct hlist_node *hn;
207         int found = 0;
208
209         spin_lock_irq(&s->tracked_chunk_lock);
210
211         hlist_for_each_entry(c, hn,
212             &s->tracked_chunk_hash[DM_TRACKED_CHUNK_HASH(chunk)], node) {
213                 if (c->chunk == chunk) {
214                         found = 1;
215                         break;
216                 }
217         }
218
219         spin_unlock_irq(&s->tracked_chunk_lock);
220
221         return found;
222 }
223
224 /*
225  * One of these per registered origin, held in the snapshot_origins hash
226  */
227 struct origin {
228         /* The origin device */
229         struct block_device *bdev;
230
231         struct list_head hash_list;
232
233         /* List of snapshots for this origin */
234         struct list_head snapshots;
235 };
236
237 /*
238  * Size of the hash table for origin volumes. If we make this
239  * the size of the minors list then it should be nearly perfect
240  */
241 #define ORIGIN_HASH_SIZE 256
242 #define ORIGIN_MASK      0xFF
243 static struct list_head *_origins;
244 static struct rw_semaphore _origins_lock;
245
246 static int init_origin_hash(void)
247 {
248         int i;
249
250         _origins = kmalloc(ORIGIN_HASH_SIZE * sizeof(struct list_head),
251                            GFP_KERNEL);
252         if (!_origins) {
253                 DMERR("unable to allocate memory");
254                 return -ENOMEM;
255         }
256
257         for (i = 0; i < ORIGIN_HASH_SIZE; i++)
258                 INIT_LIST_HEAD(_origins + i);
259         init_rwsem(&_origins_lock);
260
261         return 0;
262 }
263
264 static void exit_origin_hash(void)
265 {
266         kfree(_origins);
267 }
268
269 static unsigned origin_hash(struct block_device *bdev)
270 {
271         return bdev->bd_dev & ORIGIN_MASK;
272 }
273
274 static struct origin *__lookup_origin(struct block_device *origin)
275 {
276         struct list_head *ol;
277         struct origin *o;
278
279         ol = &_origins[origin_hash(origin)];
280         list_for_each_entry (o, ol, hash_list)
281                 if (bdev_equal(o->bdev, origin))
282                         return o;
283
284         return NULL;
285 }
286
287 static void __insert_origin(struct origin *o)
288 {
289         struct list_head *sl = &_origins[origin_hash(o->bdev)];
290         list_add_tail(&o->hash_list, sl);
291 }
292
293 /*
294  * Make a note of the snapshot and its origin so we can look it
295  * up when the origin has a write on it.
296  */
297 static int register_snapshot(struct dm_snapshot *snap)
298 {
299         struct dm_snapshot *l;
300         struct origin *o, *new_o;
301         struct block_device *bdev = snap->origin->bdev;
302
303         new_o = kmalloc(sizeof(*new_o), GFP_KERNEL);
304         if (!new_o)
305                 return -ENOMEM;
306
307         down_write(&_origins_lock);
308         o = __lookup_origin(bdev);
309
310         if (o)
311                 kfree(new_o);
312         else {
313                 /* New origin */
314                 o = new_o;
315
316                 /* Initialise the struct */
317                 INIT_LIST_HEAD(&o->snapshots);
318                 o->bdev = bdev;
319
320                 __insert_origin(o);
321         }
322
323         /* Sort the list according to chunk size, largest-first smallest-last */
324         list_for_each_entry(l, &o->snapshots, list)
325                 if (l->store->chunk_size < snap->store->chunk_size)
326                         break;
327         list_add_tail(&snap->list, &l->list);
328
329         up_write(&_origins_lock);
330         return 0;
331 }
332
333 static void unregister_snapshot(struct dm_snapshot *s)
334 {
335         struct origin *o;
336
337         down_write(&_origins_lock);
338         o = __lookup_origin(s->origin->bdev);
339
340         list_del(&s->list);
341         if (list_empty(&o->snapshots)) {
342                 list_del(&o->hash_list);
343                 kfree(o);
344         }
345
346         up_write(&_origins_lock);
347 }
348
349 /*
350  * Implementation of the exception hash tables.
351  * The lowest hash_shift bits of the chunk number are ignored, allowing
352  * some consecutive chunks to be grouped together.
353  */
354 static int init_exception_table(struct exception_table *et, uint32_t size,
355                                 unsigned hash_shift)
356 {
357         unsigned int i;
358
359         et->hash_shift = hash_shift;
360         et->hash_mask = size - 1;
361         et->table = dm_vcalloc(size, sizeof(struct list_head));
362         if (!et->table)
363                 return -ENOMEM;
364
365         for (i = 0; i < size; i++)
366                 INIT_LIST_HEAD(et->table + i);
367
368         return 0;
369 }
370
371 static void exit_exception_table(struct exception_table *et, struct kmem_cache *mem)
372 {
373         struct list_head *slot;
374         struct dm_exception *ex, *next;
375         int i, size;
376
377         size = et->hash_mask + 1;
378         for (i = 0; i < size; i++) {
379                 slot = et->table + i;
380
381                 list_for_each_entry_safe (ex, next, slot, hash_list)
382                         kmem_cache_free(mem, ex);
383         }
384
385         vfree(et->table);
386 }
387
388 static uint32_t exception_hash(struct exception_table *et, chunk_t chunk)
389 {
390         return (chunk >> et->hash_shift) & et->hash_mask;
391 }
392
393 static void remove_exception(struct dm_exception *e)
394 {
395         list_del(&e->hash_list);
396 }
397
398 /*
399  * Return the exception data for a sector, or NULL if not
400  * remapped.
401  */
402 static struct dm_exception *lookup_exception(struct exception_table *et,
403                                                   chunk_t chunk)
404 {
405         struct list_head *slot;
406         struct dm_exception *e;
407
408         slot = &et->table[exception_hash(et, chunk)];
409         list_for_each_entry (e, slot, hash_list)
410                 if (chunk >= e->old_chunk &&
411                     chunk <= e->old_chunk + dm_consecutive_chunk_count(e))
412                         return e;
413
414         return NULL;
415 }
416
417 static struct dm_exception *alloc_exception(void)
418 {
419         struct dm_exception *e;
420
421         e = kmem_cache_alloc(exception_cache, GFP_NOIO);
422         if (!e)
423                 e = kmem_cache_alloc(exception_cache, GFP_ATOMIC);
424
425         return e;
426 }
427
428 static void free_exception(struct dm_exception *e)
429 {
430         kmem_cache_free(exception_cache, e);
431 }
432
433 static struct dm_snap_pending_exception *alloc_pending_exception(struct dm_snapshot *s)
434 {
435         struct dm_snap_pending_exception *pe = mempool_alloc(s->pending_pool,
436                                                              GFP_NOIO);
437
438         atomic_inc(&s->pending_exceptions_count);
439         pe->snap = s;
440
441         return pe;
442 }
443
444 static void free_pending_exception(struct dm_snap_pending_exception *pe)
445 {
446         struct dm_snapshot *s = pe->snap;
447
448         mempool_free(pe, s->pending_pool);
449         smp_mb__before_atomic_dec();
450         atomic_dec(&s->pending_exceptions_count);
451 }
452
453 static void insert_exception(struct exception_table *eh,
454                              struct dm_exception *new_e)
455 {
456         struct list_head *l;
457         struct dm_exception *e = NULL;
458
459         l = &eh->table[exception_hash(eh, new_e->old_chunk)];
460
461         /* Add immediately if this table doesn't support consecutive chunks */
462         if (!eh->hash_shift)
463                 goto out;
464
465         /* List is ordered by old_chunk */
466         list_for_each_entry_reverse(e, l, hash_list) {
467                 /* Insert after an existing chunk? */
468                 if (new_e->old_chunk == (e->old_chunk +
469                                          dm_consecutive_chunk_count(e) + 1) &&
470                     new_e->new_chunk == (dm_chunk_number(e->new_chunk) +
471                                          dm_consecutive_chunk_count(e) + 1)) {
472                         dm_consecutive_chunk_count_inc(e);
473                         free_exception(new_e);
474                         return;
475                 }
476
477                 /* Insert before an existing chunk? */
478                 if (new_e->old_chunk == (e->old_chunk - 1) &&
479                     new_e->new_chunk == (dm_chunk_number(e->new_chunk) - 1)) {
480                         dm_consecutive_chunk_count_inc(e);
481                         e->old_chunk--;
482                         e->new_chunk--;
483                         free_exception(new_e);
484                         return;
485                 }
486
487                 if (new_e->old_chunk > e->old_chunk)
488                         break;
489         }
490
491 out:
492         list_add(&new_e->hash_list, e ? &e->hash_list : l);
493 }
494
495 /*
496  * Callback used by the exception stores to load exceptions when
497  * initialising.
498  */
499 static int dm_add_exception(void *context, chunk_t old, chunk_t new)
500 {
501         struct dm_snapshot *s = context;
502         struct dm_exception *e;
503
504         e = alloc_exception();
505         if (!e)
506                 return -ENOMEM;
507
508         e->old_chunk = old;
509
510         /* Consecutive_count is implicitly initialised to zero */
511         e->new_chunk = new;
512
513         insert_exception(&s->complete, e);
514
515         return 0;
516 }
517
518 #define min_not_zero(l, r) (((l) == 0) ? (r) : (((r) == 0) ? (l) : min(l, r)))
519
520 /*
521  * Return a minimum chunk size of all snapshots that have the specified origin.
522  * Return zero if the origin has no snapshots.
523  */
524 static sector_t __minimum_chunk_size(struct origin *o)
525 {
526         struct dm_snapshot *snap;
527         unsigned chunk_size = 0;
528
529         if (o)
530                 list_for_each_entry(snap, &o->snapshots, list)
531                         chunk_size = min_not_zero(chunk_size,
532                                                   snap->store->chunk_size);
533
534         return chunk_size;
535 }
536
537 /*
538  * Hard coded magic.
539  */
540 static int calc_max_buckets(void)
541 {
542         /* use a fixed size of 2MB */
543         unsigned long mem = 2 * 1024 * 1024;
544         mem /= sizeof(struct list_head);
545
546         return mem;
547 }
548
549 /*
550  * Allocate room for a suitable hash table.
551  */
552 static int init_hash_tables(struct dm_snapshot *s)
553 {
554         sector_t hash_size, cow_dev_size, origin_dev_size, max_buckets;
555
556         /*
557          * Calculate based on the size of the original volume or
558          * the COW volume...
559          */
560         cow_dev_size = get_dev_size(s->store->cow->bdev);
561         origin_dev_size = get_dev_size(s->origin->bdev);
562         max_buckets = calc_max_buckets();
563
564         hash_size = min(origin_dev_size, cow_dev_size) >> s->store->chunk_shift;
565         hash_size = min(hash_size, max_buckets);
566
567         if (hash_size < 64)
568                 hash_size = 64;
569         hash_size = rounddown_pow_of_two(hash_size);
570         if (init_exception_table(&s->complete, hash_size,
571                                  DM_CHUNK_CONSECUTIVE_BITS))
572                 return -ENOMEM;
573
574         /*
575          * Allocate hash table for in-flight exceptions
576          * Make this smaller than the real hash table
577          */
578         hash_size >>= 3;
579         if (hash_size < 64)
580                 hash_size = 64;
581
582         if (init_exception_table(&s->pending, hash_size, 0)) {
583                 exit_exception_table(&s->complete, exception_cache);
584                 return -ENOMEM;
585         }
586
587         return 0;
588 }
589
590 /*
591  * Construct a snapshot mapping: <origin_dev> <COW-dev> <p/n> <chunk-size>
592  */
593 static int snapshot_ctr(struct dm_target *ti, unsigned int argc, char **argv)
594 {
595         struct dm_snapshot *s;
596         int i;
597         int r = -EINVAL;
598         char *origin_path;
599         struct dm_exception_store *store;
600         unsigned args_used;
601
602         if (argc != 4) {
603                 ti->error = "requires exactly 4 arguments";
604                 r = -EINVAL;
605                 goto bad_args;
606         }
607
608         origin_path = argv[0];
609         argv++;
610         argc--;
611
612         r = dm_exception_store_create(ti, argc, argv, &args_used, &store);
613         if (r) {
614                 ti->error = "Couldn't create exception store";
615                 r = -EINVAL;
616                 goto bad_args;
617         }
618
619         argv += args_used;
620         argc -= args_used;
621
622         s = kmalloc(sizeof(*s), GFP_KERNEL);
623         if (!s) {
624                 ti->error = "Cannot allocate snapshot context private "
625                     "structure";
626                 r = -ENOMEM;
627                 goto bad_snap;
628         }
629
630         r = dm_get_device(ti, origin_path, 0, ti->len, FMODE_READ, &s->origin);
631         if (r) {
632                 ti->error = "Cannot get origin device";
633                 goto bad_origin;
634         }
635
636         s->store = store;
637         s->valid = 1;
638         s->active = 0;
639         atomic_set(&s->pending_exceptions_count, 0);
640         init_rwsem(&s->lock);
641         spin_lock_init(&s->pe_lock);
642
643         /* Allocate hash table for COW data */
644         if (init_hash_tables(s)) {
645                 ti->error = "Unable to allocate hash table space";
646                 r = -ENOMEM;
647                 goto bad_hash_tables;
648         }
649
650         r = dm_kcopyd_client_create(SNAPSHOT_PAGES, &s->kcopyd_client);
651         if (r) {
652                 ti->error = "Could not create kcopyd client";
653                 goto bad_kcopyd;
654         }
655
656         s->pending_pool = mempool_create_slab_pool(MIN_IOS, pending_cache);
657         if (!s->pending_pool) {
658                 ti->error = "Could not allocate mempool for pending exceptions";
659                 goto bad_pending_pool;
660         }
661
662         s->tracked_chunk_pool = mempool_create_slab_pool(MIN_IOS,
663                                                          tracked_chunk_cache);
664         if (!s->tracked_chunk_pool) {
665                 ti->error = "Could not allocate tracked_chunk mempool for "
666                             "tracking reads";
667                 goto bad_tracked_chunk_pool;
668         }
669
670         for (i = 0; i < DM_TRACKED_CHUNK_HASH_SIZE; i++)
671                 INIT_HLIST_HEAD(&s->tracked_chunk_hash[i]);
672
673         spin_lock_init(&s->tracked_chunk_lock);
674
675         /* Metadata must only be loaded into one table at once */
676         r = s->store->type->read_metadata(s->store, dm_add_exception,
677                                           (void *)s);
678         if (r < 0) {
679                 ti->error = "Failed to read snapshot metadata";
680                 goto bad_load_and_register;
681         } else if (r > 0) {
682                 s->valid = 0;
683                 DMWARN("Snapshot is marked invalid.");
684         }
685
686         bio_list_init(&s->queued_bios);
687         INIT_WORK(&s->queued_bios_work, flush_queued_bios);
688
689         if (!s->store->chunk_size) {
690                 ti->error = "Chunk size not set";
691                 goto bad_load_and_register;
692         }
693
694         /* Add snapshot to the list of snapshots for this origin */
695         /* Exceptions aren't triggered till snapshot_resume() is called */
696         if (register_snapshot(s)) {
697                 r = -EINVAL;
698                 ti->error = "Cannot register snapshot origin";
699                 goto bad_load_and_register;
700         }
701
702         ti->private = s;
703         ti->split_io = s->store->chunk_size;
704         ti->num_flush_requests = 1;
705
706         return 0;
707
708 bad_load_and_register:
709         mempool_destroy(s->tracked_chunk_pool);
710
711 bad_tracked_chunk_pool:
712         mempool_destroy(s->pending_pool);
713
714 bad_pending_pool:
715         dm_kcopyd_client_destroy(s->kcopyd_client);
716
717 bad_kcopyd:
718         exit_exception_table(&s->pending, pending_cache);
719         exit_exception_table(&s->complete, exception_cache);
720
721 bad_hash_tables:
722         dm_put_device(ti, s->origin);
723
724 bad_origin:
725         kfree(s);
726
727 bad_snap:
728         dm_exception_store_destroy(store);
729
730 bad_args:
731         return r;
732 }
733
734 static void __free_exceptions(struct dm_snapshot *s)
735 {
736         dm_kcopyd_client_destroy(s->kcopyd_client);
737         s->kcopyd_client = NULL;
738
739         exit_exception_table(&s->pending, pending_cache);
740         exit_exception_table(&s->complete, exception_cache);
741 }
742
743 static void snapshot_dtr(struct dm_target *ti)
744 {
745 #ifdef CONFIG_DM_DEBUG
746         int i;
747 #endif
748         struct dm_snapshot *s = ti->private;
749
750         flush_workqueue(ksnapd);
751
752         /* Prevent further origin writes from using this snapshot. */
753         /* After this returns there can be no new kcopyd jobs. */
754         unregister_snapshot(s);
755
756         while (atomic_read(&s->pending_exceptions_count))
757                 msleep(1);
758         /*
759          * Ensure instructions in mempool_destroy aren't reordered
760          * before atomic_read.
761          */
762         smp_mb();
763
764 #ifdef CONFIG_DM_DEBUG
765         for (i = 0; i < DM_TRACKED_CHUNK_HASH_SIZE; i++)
766                 BUG_ON(!hlist_empty(&s->tracked_chunk_hash[i]));
767 #endif
768
769         mempool_destroy(s->tracked_chunk_pool);
770
771         __free_exceptions(s);
772
773         mempool_destroy(s->pending_pool);
774
775         dm_put_device(ti, s->origin);
776
777         dm_exception_store_destroy(s->store);
778
779         kfree(s);
780 }
781
782 /*
783  * Flush a list of buffers.
784  */
785 static void flush_bios(struct bio *bio)
786 {
787         struct bio *n;
788
789         while (bio) {
790                 n = bio->bi_next;
791                 bio->bi_next = NULL;
792                 generic_make_request(bio);
793                 bio = n;
794         }
795 }
796
797 static void flush_queued_bios(struct work_struct *work)
798 {
799         struct dm_snapshot *s =
800                 container_of(work, struct dm_snapshot, queued_bios_work);
801         struct bio *queued_bios;
802         unsigned long flags;
803
804         spin_lock_irqsave(&s->pe_lock, flags);
805         queued_bios = bio_list_get(&s->queued_bios);
806         spin_unlock_irqrestore(&s->pe_lock, flags);
807
808         flush_bios(queued_bios);
809 }
810
811 /*
812  * Error a list of buffers.
813  */
814 static void error_bios(struct bio *bio)
815 {
816         struct bio *n;
817
818         while (bio) {
819                 n = bio->bi_next;
820                 bio->bi_next = NULL;
821                 bio_io_error(bio);
822                 bio = n;
823         }
824 }
825
826 static void __invalidate_snapshot(struct dm_snapshot *s, int err)
827 {
828         if (!s->valid)
829                 return;
830
831         if (err == -EIO)
832                 DMERR("Invalidating snapshot: Error reading/writing.");
833         else if (err == -ENOMEM)
834                 DMERR("Invalidating snapshot: Unable to allocate exception.");
835
836         if (s->store->type->drop_snapshot)
837                 s->store->type->drop_snapshot(s->store);
838
839         s->valid = 0;
840
841         dm_table_event(s->store->ti->table);
842 }
843
844 static void get_pending_exception(struct dm_snap_pending_exception *pe)
845 {
846         atomic_inc(&pe->ref_count);
847 }
848
849 static struct bio *put_pending_exception(struct dm_snap_pending_exception *pe)
850 {
851         struct dm_snap_pending_exception *primary_pe;
852         struct bio *origin_bios = NULL;
853
854         primary_pe = pe->primary_pe;
855
856         /*
857          * If this pe is involved in a write to the origin and
858          * it is the last sibling to complete then release
859          * the bios for the original write to the origin.
860          */
861         if (primary_pe &&
862             atomic_dec_and_test(&primary_pe->ref_count)) {
863                 origin_bios = bio_list_get(&primary_pe->origin_bios);
864                 free_pending_exception(primary_pe);
865         }
866
867         /*
868          * Free the pe if it's not linked to an origin write or if
869          * it's not itself a primary pe.
870          */
871         if (!primary_pe || primary_pe != pe)
872                 free_pending_exception(pe);
873
874         return origin_bios;
875 }
876
877 static void pending_complete(struct dm_snap_pending_exception *pe, int success)
878 {
879         struct dm_exception *e;
880         struct dm_snapshot *s = pe->snap;
881         struct bio *origin_bios = NULL;
882         struct bio *snapshot_bios = NULL;
883         int error = 0;
884
885         if (!success) {
886                 /* Read/write error - snapshot is unusable */
887                 down_write(&s->lock);
888                 __invalidate_snapshot(s, -EIO);
889                 error = 1;
890                 goto out;
891         }
892
893         e = alloc_exception();
894         if (!e) {
895                 down_write(&s->lock);
896                 __invalidate_snapshot(s, -ENOMEM);
897                 error = 1;
898                 goto out;
899         }
900         *e = pe->e;
901
902         down_write(&s->lock);
903         if (!s->valid) {
904                 free_exception(e);
905                 error = 1;
906                 goto out;
907         }
908
909         /*
910          * Check for conflicting reads. This is extremely improbable,
911          * so msleep(1) is sufficient and there is no need for a wait queue.
912          */
913         while (__chunk_is_tracked(s, pe->e.old_chunk))
914                 msleep(1);
915
916         /*
917          * Add a proper exception, and remove the
918          * in-flight exception from the list.
919          */
920         insert_exception(&s->complete, e);
921
922  out:
923         remove_exception(&pe->e);
924         snapshot_bios = bio_list_get(&pe->snapshot_bios);
925         origin_bios = put_pending_exception(pe);
926
927         up_write(&s->lock);
928
929         /* Submit any pending write bios */
930         if (error)
931                 error_bios(snapshot_bios);
932         else
933                 flush_bios(snapshot_bios);
934
935         flush_bios(origin_bios);
936 }
937
938 static void commit_callback(void *context, int success)
939 {
940         struct dm_snap_pending_exception *pe = context;
941
942         pending_complete(pe, success);
943 }
944
945 /*
946  * Called when the copy I/O has finished.  kcopyd actually runs
947  * this code so don't block.
948  */
949 static void copy_callback(int read_err, unsigned long write_err, void *context)
950 {
951         struct dm_snap_pending_exception *pe = context;
952         struct dm_snapshot *s = pe->snap;
953
954         if (read_err || write_err)
955                 pending_complete(pe, 0);
956
957         else
958                 /* Update the metadata if we are persistent */
959                 s->store->type->commit_exception(s->store, &pe->e,
960                                                  commit_callback, pe);
961 }
962
963 /*
964  * Dispatches the copy operation to kcopyd.
965  */
966 static void start_copy(struct dm_snap_pending_exception *pe)
967 {
968         struct dm_snapshot *s = pe->snap;
969         struct dm_io_region src, dest;
970         struct block_device *bdev = s->origin->bdev;
971         sector_t dev_size;
972
973         dev_size = get_dev_size(bdev);
974
975         src.bdev = bdev;
976         src.sector = chunk_to_sector(s->store, pe->e.old_chunk);
977         src.count = min((sector_t)s->store->chunk_size, dev_size - src.sector);
978
979         dest.bdev = s->store->cow->bdev;
980         dest.sector = chunk_to_sector(s->store, pe->e.new_chunk);
981         dest.count = src.count;
982
983         /* Hand over to kcopyd */
984         dm_kcopyd_copy(s->kcopyd_client,
985                     &src, 1, &dest, 0, copy_callback, pe);
986 }
987
988 static struct dm_snap_pending_exception *
989 __lookup_pending_exception(struct dm_snapshot *s, chunk_t chunk)
990 {
991         struct dm_exception *e = lookup_exception(&s->pending, chunk);
992
993         if (!e)
994                 return NULL;
995
996         return container_of(e, struct dm_snap_pending_exception, e);
997 }
998
999 /*
1000  * Looks to see if this snapshot already has a pending exception
1001  * for this chunk, otherwise it allocates a new one and inserts
1002  * it into the pending table.
1003  *
1004  * NOTE: a write lock must be held on snap->lock before calling
1005  * this.
1006  */
1007 static struct dm_snap_pending_exception *
1008 __find_pending_exception(struct dm_snapshot *s,
1009                          struct dm_snap_pending_exception *pe, chunk_t chunk)
1010 {
1011         struct dm_snap_pending_exception *pe2;
1012
1013         pe2 = __lookup_pending_exception(s, chunk);
1014         if (pe2) {
1015                 free_pending_exception(pe);
1016                 return pe2;
1017         }
1018
1019         pe->e.old_chunk = chunk;
1020         bio_list_init(&pe->origin_bios);
1021         bio_list_init(&pe->snapshot_bios);
1022         pe->primary_pe = NULL;
1023         atomic_set(&pe->ref_count, 0);
1024         pe->started = 0;
1025
1026         if (s->store->type->prepare_exception(s->store, &pe->e)) {
1027                 free_pending_exception(pe);
1028                 return NULL;
1029         }
1030
1031         get_pending_exception(pe);
1032         insert_exception(&s->pending, &pe->e);
1033
1034         return pe;
1035 }
1036
1037 static void remap_exception(struct dm_snapshot *s, struct dm_exception *e,
1038                             struct bio *bio, chunk_t chunk)
1039 {
1040         bio->bi_bdev = s->store->cow->bdev;
1041         bio->bi_sector = chunk_to_sector(s->store,
1042                                          dm_chunk_number(e->new_chunk) +
1043                                          (chunk - e->old_chunk)) +
1044                                          (bio->bi_sector &
1045                                           s->store->chunk_mask);
1046 }
1047
1048 static int snapshot_map(struct dm_target *ti, struct bio *bio,
1049                         union map_info *map_context)
1050 {
1051         struct dm_exception *e;
1052         struct dm_snapshot *s = ti->private;
1053         int r = DM_MAPIO_REMAPPED;
1054         chunk_t chunk;
1055         struct dm_snap_pending_exception *pe = NULL;
1056
1057         if (unlikely(bio_empty_barrier(bio))) {
1058                 bio->bi_bdev = s->store->cow->bdev;
1059                 return DM_MAPIO_REMAPPED;
1060         }
1061
1062         chunk = sector_to_chunk(s->store, bio->bi_sector);
1063
1064         /* Full snapshots are not usable */
1065         /* To get here the table must be live so s->active is always set. */
1066         if (!s->valid)
1067                 return -EIO;
1068
1069         /* FIXME: should only take write lock if we need
1070          * to copy an exception */
1071         down_write(&s->lock);
1072
1073         if (!s->valid) {
1074                 r = -EIO;
1075                 goto out_unlock;
1076         }
1077
1078         /* If the block is already remapped - use that, else remap it */
1079         e = lookup_exception(&s->complete, chunk);
1080         if (e) {
1081                 remap_exception(s, e, bio, chunk);
1082                 goto out_unlock;
1083         }
1084
1085         /*
1086          * Write to snapshot - higher level takes care of RW/RO
1087          * flags so we should only get this if we are
1088          * writeable.
1089          */
1090         if (bio_rw(bio) == WRITE) {
1091                 pe = __lookup_pending_exception(s, chunk);
1092                 if (!pe) {
1093                         up_write(&s->lock);
1094                         pe = alloc_pending_exception(s);
1095                         down_write(&s->lock);
1096
1097                         if (!s->valid) {
1098                                 free_pending_exception(pe);
1099                                 r = -EIO;
1100                                 goto out_unlock;
1101                         }
1102
1103                         e = lookup_exception(&s->complete, chunk);
1104                         if (e) {
1105                                 free_pending_exception(pe);
1106                                 remap_exception(s, e, bio, chunk);
1107                                 goto out_unlock;
1108                         }
1109
1110                         pe = __find_pending_exception(s, pe, chunk);
1111                         if (!pe) {
1112                                 __invalidate_snapshot(s, -ENOMEM);
1113                                 r = -EIO;
1114                                 goto out_unlock;
1115                         }
1116                 }
1117
1118                 remap_exception(s, &pe->e, bio, chunk);
1119                 bio_list_add(&pe->snapshot_bios, bio);
1120
1121                 r = DM_MAPIO_SUBMITTED;
1122
1123                 if (!pe->started) {
1124                         /* this is protected by snap->lock */
1125                         pe->started = 1;
1126                         up_write(&s->lock);
1127                         start_copy(pe);
1128                         goto out;
1129                 }
1130         } else {
1131                 bio->bi_bdev = s->origin->bdev;
1132                 map_context->ptr = track_chunk(s, chunk);
1133         }
1134
1135  out_unlock:
1136         up_write(&s->lock);
1137  out:
1138         return r;
1139 }
1140
1141 static int snapshot_end_io(struct dm_target *ti, struct bio *bio,
1142                            int error, union map_info *map_context)
1143 {
1144         struct dm_snapshot *s = ti->private;
1145         struct dm_snap_tracked_chunk *c = map_context->ptr;
1146
1147         if (c)
1148                 stop_tracking_chunk(s, c);
1149
1150         return 0;
1151 }
1152
1153 static void snapshot_resume(struct dm_target *ti)
1154 {
1155         struct dm_snapshot *s = ti->private;
1156
1157         down_write(&s->lock);
1158         s->active = 1;
1159         up_write(&s->lock);
1160 }
1161
1162 static int snapshot_status(struct dm_target *ti, status_type_t type,
1163                            char *result, unsigned int maxlen)
1164 {
1165         unsigned sz = 0;
1166         struct dm_snapshot *snap = ti->private;
1167
1168         switch (type) {
1169         case STATUSTYPE_INFO:
1170
1171                 down_write(&snap->lock);
1172
1173                 if (!snap->valid)
1174                         DMEMIT("Invalid");
1175                 else {
1176                         if (snap->store->type->fraction_full) {
1177                                 sector_t numerator, denominator;
1178                                 snap->store->type->fraction_full(snap->store,
1179                                                                  &numerator,
1180                                                                  &denominator);
1181                                 DMEMIT("%llu/%llu",
1182                                        (unsigned long long)numerator,
1183                                        (unsigned long long)denominator);
1184                         }
1185                         else
1186                                 DMEMIT("Unknown");
1187                 }
1188
1189                 up_write(&snap->lock);
1190
1191                 break;
1192
1193         case STATUSTYPE_TABLE:
1194                 /*
1195                  * kdevname returns a static pointer so we need
1196                  * to make private copies if the output is to
1197                  * make sense.
1198                  */
1199                 DMEMIT("%s", snap->origin->name);
1200                 snap->store->type->status(snap->store, type, result + sz,
1201                                           maxlen - sz);
1202                 break;
1203         }
1204
1205         return 0;
1206 }
1207
1208 static int snapshot_iterate_devices(struct dm_target *ti,
1209                                     iterate_devices_callout_fn fn, void *data)
1210 {
1211         struct dm_snapshot *snap = ti->private;
1212
1213         return fn(ti, snap->origin, 0, ti->len, data);
1214 }
1215
1216
1217 /*-----------------------------------------------------------------
1218  * Origin methods
1219  *---------------------------------------------------------------*/
1220 static int __origin_write(struct list_head *snapshots, struct bio *bio)
1221 {
1222         int r = DM_MAPIO_REMAPPED, first = 0;
1223         struct dm_snapshot *snap;
1224         struct dm_exception *e;
1225         struct dm_snap_pending_exception *pe, *next_pe, *primary_pe = NULL;
1226         chunk_t chunk;
1227         LIST_HEAD(pe_queue);
1228
1229         /* Do all the snapshots on this origin */
1230         list_for_each_entry (snap, snapshots, list) {
1231
1232                 down_write(&snap->lock);
1233
1234                 /* Only deal with valid and active snapshots */
1235                 if (!snap->valid || !snap->active)
1236                         goto next_snapshot;
1237
1238                 /* Nothing to do if writing beyond end of snapshot */
1239                 if (bio->bi_sector >= dm_table_get_size(snap->store->ti->table))
1240                         goto next_snapshot;
1241
1242                 /*
1243                  * Remember, different snapshots can have
1244                  * different chunk sizes.
1245                  */
1246                 chunk = sector_to_chunk(snap->store, bio->bi_sector);
1247
1248                 /*
1249                  * Check exception table to see if block
1250                  * is already remapped in this snapshot
1251                  * and trigger an exception if not.
1252                  *
1253                  * ref_count is initialised to 1 so pending_complete()
1254                  * won't destroy the primary_pe while we're inside this loop.
1255                  */
1256                 e = lookup_exception(&snap->complete, chunk);
1257                 if (e)
1258                         goto next_snapshot;
1259
1260                 pe = __lookup_pending_exception(snap, chunk);
1261                 if (!pe) {
1262                         up_write(&snap->lock);
1263                         pe = alloc_pending_exception(snap);
1264                         down_write(&snap->lock);
1265
1266                         if (!snap->valid) {
1267                                 free_pending_exception(pe);
1268                                 goto next_snapshot;
1269                         }
1270
1271                         e = lookup_exception(&snap->complete, chunk);
1272                         if (e) {
1273                                 free_pending_exception(pe);
1274                                 goto next_snapshot;
1275                         }
1276
1277                         pe = __find_pending_exception(snap, pe, chunk);
1278                         if (!pe) {
1279                                 __invalidate_snapshot(snap, -ENOMEM);
1280                                 goto next_snapshot;
1281                         }
1282                 }
1283
1284                 if (!primary_pe) {
1285                         /*
1286                          * Either every pe here has same
1287                          * primary_pe or none has one yet.
1288                          */
1289                         if (pe->primary_pe)
1290                                 primary_pe = pe->primary_pe;
1291                         else {
1292                                 primary_pe = pe;
1293                                 first = 1;
1294                         }
1295
1296                         bio_list_add(&primary_pe->origin_bios, bio);
1297
1298                         r = DM_MAPIO_SUBMITTED;
1299                 }
1300
1301                 if (!pe->primary_pe) {
1302                         pe->primary_pe = primary_pe;
1303                         get_pending_exception(primary_pe);
1304                 }
1305
1306                 if (!pe->started) {
1307                         pe->started = 1;
1308                         list_add_tail(&pe->list, &pe_queue);
1309                 }
1310
1311  next_snapshot:
1312                 up_write(&snap->lock);
1313         }
1314
1315         if (!primary_pe)
1316                 return r;
1317
1318         /*
1319          * If this is the first time we're processing this chunk and
1320          * ref_count is now 1 it means all the pending exceptions
1321          * got completed while we were in the loop above, so it falls to
1322          * us here to remove the primary_pe and submit any origin_bios.
1323          */
1324
1325         if (first && atomic_dec_and_test(&primary_pe->ref_count)) {
1326                 flush_bios(bio_list_get(&primary_pe->origin_bios));
1327                 free_pending_exception(primary_pe);
1328                 /* If we got here, pe_queue is necessarily empty. */
1329                 return r;
1330         }
1331
1332         /*
1333          * Now that we have a complete pe list we can start the copying.
1334          */
1335         list_for_each_entry_safe(pe, next_pe, &pe_queue, list)
1336                 start_copy(pe);
1337
1338         return r;
1339 }
1340
1341 /*
1342  * Called on a write from the origin driver.
1343  */
1344 static int do_origin(struct dm_dev *origin, struct bio *bio)
1345 {
1346         struct origin *o;
1347         int r = DM_MAPIO_REMAPPED;
1348
1349         down_read(&_origins_lock);
1350         o = __lookup_origin(origin->bdev);
1351         if (o)
1352                 r = __origin_write(&o->snapshots, bio);
1353         up_read(&_origins_lock);
1354
1355         return r;
1356 }
1357
1358 /*
1359  * Origin: maps a linear range of a device, with hooks for snapshotting.
1360  */
1361
1362 /*
1363  * Construct an origin mapping: <dev_path>
1364  * The context for an origin is merely a 'struct dm_dev *'
1365  * pointing to the real device.
1366  */
1367 static int origin_ctr(struct dm_target *ti, unsigned int argc, char **argv)
1368 {
1369         int r;
1370         struct dm_dev *dev;
1371
1372         if (argc != 1) {
1373                 ti->error = "origin: incorrect number of arguments";
1374                 return -EINVAL;
1375         }
1376
1377         r = dm_get_device(ti, argv[0], 0, ti->len,
1378                           dm_table_get_mode(ti->table), &dev);
1379         if (r) {
1380                 ti->error = "Cannot get target device";
1381                 return r;
1382         }
1383
1384         ti->private = dev;
1385         ti->num_flush_requests = 1;
1386
1387         return 0;
1388 }
1389
1390 static void origin_dtr(struct dm_target *ti)
1391 {
1392         struct dm_dev *dev = ti->private;
1393         dm_put_device(ti, dev);
1394 }
1395
1396 static int origin_map(struct dm_target *ti, struct bio *bio,
1397                       union map_info *map_context)
1398 {
1399         struct dm_dev *dev = ti->private;
1400         bio->bi_bdev = dev->bdev;
1401
1402         if (unlikely(bio_empty_barrier(bio)))
1403                 return DM_MAPIO_REMAPPED;
1404
1405         /* Only tell snapshots if this is a write */
1406         return (bio_rw(bio) == WRITE) ? do_origin(dev, bio) : DM_MAPIO_REMAPPED;
1407 }
1408
1409 /*
1410  * Set the target "split_io" field to the minimum of all the snapshots'
1411  * chunk sizes.
1412  */
1413 static void origin_resume(struct dm_target *ti)
1414 {
1415         struct dm_dev *dev = ti->private;
1416
1417         down_read(&_origins_lock);
1418
1419         ti->split_io = __minimum_chunk_size(__lookup_origin(dev->bdev));
1420
1421         up_read(&_origins_lock);
1422 }
1423
1424 static int origin_status(struct dm_target *ti, status_type_t type, char *result,
1425                          unsigned int maxlen)
1426 {
1427         struct dm_dev *dev = ti->private;
1428
1429         switch (type) {
1430         case STATUSTYPE_INFO:
1431                 result[0] = '\0';
1432                 break;
1433
1434         case STATUSTYPE_TABLE:
1435                 snprintf(result, maxlen, "%s", dev->name);
1436                 break;
1437         }
1438
1439         return 0;
1440 }
1441
1442 static int origin_iterate_devices(struct dm_target *ti,
1443                                   iterate_devices_callout_fn fn, void *data)
1444 {
1445         struct dm_dev *dev = ti->private;
1446
1447         return fn(ti, dev, 0, ti->len, data);
1448 }
1449
1450 static struct target_type origin_target = {
1451         .name    = "snapshot-origin",
1452         .version = {1, 7, 0},
1453         .module  = THIS_MODULE,
1454         .ctr     = origin_ctr,
1455         .dtr     = origin_dtr,
1456         .map     = origin_map,
1457         .resume  = origin_resume,
1458         .status  = origin_status,
1459         .iterate_devices = origin_iterate_devices,
1460 };
1461
1462 static struct target_type snapshot_target = {
1463         .name    = "snapshot",
1464         .version = {1, 7, 0},
1465         .module  = THIS_MODULE,
1466         .ctr     = snapshot_ctr,
1467         .dtr     = snapshot_dtr,
1468         .map     = snapshot_map,
1469         .end_io  = snapshot_end_io,
1470         .resume  = snapshot_resume,
1471         .status  = snapshot_status,
1472         .iterate_devices = snapshot_iterate_devices,
1473 };
1474
1475 static int __init dm_snapshot_init(void)
1476 {
1477         int r;
1478
1479         r = dm_exception_store_init();
1480         if (r) {
1481                 DMERR("Failed to initialize exception stores");
1482                 return r;
1483         }
1484
1485         r = dm_register_target(&snapshot_target);
1486         if (r) {
1487                 DMERR("snapshot target register failed %d", r);
1488                 goto bad_register_snapshot_target;
1489         }
1490
1491         r = dm_register_target(&origin_target);
1492         if (r < 0) {
1493                 DMERR("Origin target register failed %d", r);
1494                 goto bad1;
1495         }
1496
1497         r = init_origin_hash();
1498         if (r) {
1499                 DMERR("init_origin_hash failed.");
1500                 goto bad2;
1501         }
1502
1503         exception_cache = KMEM_CACHE(dm_exception, 0);
1504         if (!exception_cache) {
1505                 DMERR("Couldn't create exception cache.");
1506                 r = -ENOMEM;
1507                 goto bad3;
1508         }
1509
1510         pending_cache = KMEM_CACHE(dm_snap_pending_exception, 0);
1511         if (!pending_cache) {
1512                 DMERR("Couldn't create pending cache.");
1513                 r = -ENOMEM;
1514                 goto bad4;
1515         }
1516
1517         tracked_chunk_cache = KMEM_CACHE(dm_snap_tracked_chunk, 0);
1518         if (!tracked_chunk_cache) {
1519                 DMERR("Couldn't create cache to track chunks in use.");
1520                 r = -ENOMEM;
1521                 goto bad5;
1522         }
1523
1524         ksnapd = create_singlethread_workqueue("ksnapd");
1525         if (!ksnapd) {
1526                 DMERR("Failed to create ksnapd workqueue.");
1527                 r = -ENOMEM;
1528                 goto bad_pending_pool;
1529         }
1530
1531         return 0;
1532
1533 bad_pending_pool:
1534         kmem_cache_destroy(tracked_chunk_cache);
1535 bad5:
1536         kmem_cache_destroy(pending_cache);
1537 bad4:
1538         kmem_cache_destroy(exception_cache);
1539 bad3:
1540         exit_origin_hash();
1541 bad2:
1542         dm_unregister_target(&origin_target);
1543 bad1:
1544         dm_unregister_target(&snapshot_target);
1545
1546 bad_register_snapshot_target:
1547         dm_exception_store_exit();
1548         return r;
1549 }
1550
1551 static void __exit dm_snapshot_exit(void)
1552 {
1553         destroy_workqueue(ksnapd);
1554
1555         dm_unregister_target(&snapshot_target);
1556         dm_unregister_target(&origin_target);
1557
1558         exit_origin_hash();
1559         kmem_cache_destroy(pending_cache);
1560         kmem_cache_destroy(exception_cache);
1561         kmem_cache_destroy(tracked_chunk_cache);
1562
1563         dm_exception_store_exit();
1564 }
1565
1566 /* Module hooks */
1567 module_init(dm_snapshot_init);
1568 module_exit(dm_snapshot_exit);
1569
1570 MODULE_DESCRIPTION(DM_NAME " snapshot target");
1571 MODULE_AUTHOR("Joe Thornber");
1572 MODULE_LICENSE("GPL");