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