dm-snap.c 41.5 KB
Newer Older
L
Linus Torvalds 已提交
1 2 3 4 5 6 7 8 9 10
/*
 * dm-snapshot.c
 *
 * Copyright (C) 2001-2002 Sistina Software (UK) Limited.
 *
 * This file is released under the GPL.
 */

#include <linux/blkdev.h>
#include <linux/device-mapper.h>
11
#include <linux/delay.h>
L
Linus Torvalds 已提交
12 13 14 15 16 17 18 19
#include <linux/fs.h>
#include <linux/init.h>
#include <linux/kdev_t.h>
#include <linux/list.h>
#include <linux/mempool.h>
#include <linux/module.h>
#include <linux/slab.h>
#include <linux/vmalloc.h>
V
vignesh babu 已提交
20
#include <linux/log2.h>
A
Alasdair G Kergon 已提交
21
#include <linux/dm-kcopyd.h>
22
#include <linux/workqueue.h>
L
Linus Torvalds 已提交
23

24
#include "dm-exception-store.h"
L
Linus Torvalds 已提交
25

26 27
#define DM_MSG_PREFIX "snapshots"

M
Mikulas Patocka 已提交
28 29 30 31 32
static const char dm_snapshot_merge_target_name[] = "snapshot-merge";

#define dm_target_is_snapshot_merge(ti) \
	((ti)->type->name == dm_snapshot_merge_target_name)

L
Linus Torvalds 已提交
33 34 35 36 37 38 39 40 41 42 43
/*
 * The percentage increment we will wake up users at
 */
#define WAKE_UP_PERCENT 5

/*
 * kcopyd priority of snapshot operations
 */
#define SNAPSHOT_COPY_PRIORITY 2

/*
44
 * Reserve 1MB for each snapshot initially (with minimum of 1 page).
L
Linus Torvalds 已提交
45
 */
46
#define SNAPSHOT_PAGES (((1UL << 20) >> PAGE_SHIFT) ? : 1)
L
Linus Torvalds 已提交
47

48 49 50 51 52
/*
 * The size of the mempool used to track chunks in use.
 */
#define MIN_IOS 256

53 54 55 56
#define DM_TRACKED_CHUNK_HASH_SIZE	16
#define DM_TRACKED_CHUNK_HASH(x)	((unsigned long)(x) & \
					 (DM_TRACKED_CHUNK_HASH_SIZE - 1))

57
struct dm_exception_table {
58 59 60 61 62 63 64 65 66
	uint32_t hash_mask;
	unsigned hash_shift;
	struct list_head *table;
};

struct dm_snapshot {
	struct rw_semaphore lock;

	struct dm_dev *origin;
67 68 69
	struct dm_dev *cow;

	struct dm_target *ti;
70 71 72 73 74 75 76 77 78 79

	/* List of snapshots per Origin */
	struct list_head list;

	/* You can't use a snapshot if this is 0 (e.g. if full) */
	int valid;

	/* Origin writes don't trigger exceptions until this is set */
	int active;

80 81 82
	/* Whether or not owning mapped_device is suspended */
	int suspended;

83 84 85 86
	mempool_t *pending_pool;

	atomic_t pending_exceptions_count;

87 88
	struct dm_exception_table pending;
	struct dm_exception_table complete;
89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110

	/*
	 * pe_lock protects all pending_exception operations and access
	 * as well as the snapshot_bios list.
	 */
	spinlock_t pe_lock;

	/* The on disk metadata handler */
	struct dm_exception_store *store;

	struct dm_kcopyd_client *kcopyd_client;

	/* Queue of snapshot writes for ksnapd to flush */
	struct bio_list queued_bios;
	struct work_struct queued_bios_work;

	/* Chunks with outstanding reads */
	mempool_t *tracked_chunk_pool;
	spinlock_t tracked_chunk_lock;
	struct hlist_head tracked_chunk_hash[DM_TRACKED_CHUNK_HASH_SIZE];
};

111 112 113 114 115 116
struct dm_dev *dm_snap_cow(struct dm_snapshot *s)
{
	return s->cow;
}
EXPORT_SYMBOL(dm_snap_cow);

117
static struct workqueue_struct *ksnapd;
D
David Howells 已提交
118
static void flush_queued_bios(struct work_struct *work);
119

120 121 122 123 124 125 126 127 128 129 130 131 132 133 134
static sector_t chunk_to_sector(struct dm_exception_store *store,
				chunk_t chunk)
{
	return chunk << store->chunk_shift;
}

static int bdev_equal(struct block_device *lhs, struct block_device *rhs)
{
	/*
	 * There is only ever one instance of a particular block
	 * device so we can compare pointers safely.
	 */
	return lhs == rhs;
}

A
Alasdair G Kergon 已提交
135
struct dm_snap_pending_exception {
136
	struct dm_exception e;
L
Linus Torvalds 已提交
137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158

	/*
	 * Origin buffers waiting for this to complete are held
	 * in a bio list
	 */
	struct bio_list origin_bios;
	struct bio_list snapshot_bios;

	/* Pointer back to snapshot context */
	struct dm_snapshot *snap;

	/*
	 * 1 indicates the exception has already been sent to
	 * kcopyd.
	 */
	int started;
};

/*
 * Hash table mapping origin volumes to lists of snapshots and
 * a lock to protect it
 */
159 160
static struct kmem_cache *exception_cache;
static struct kmem_cache *pending_cache;
L
Linus Torvalds 已提交
161

162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197
struct dm_snap_tracked_chunk {
	struct hlist_node node;
	chunk_t chunk;
};

static struct kmem_cache *tracked_chunk_cache;

static struct dm_snap_tracked_chunk *track_chunk(struct dm_snapshot *s,
						 chunk_t chunk)
{
	struct dm_snap_tracked_chunk *c = mempool_alloc(s->tracked_chunk_pool,
							GFP_NOIO);
	unsigned long flags;

	c->chunk = chunk;

	spin_lock_irqsave(&s->tracked_chunk_lock, flags);
	hlist_add_head(&c->node,
		       &s->tracked_chunk_hash[DM_TRACKED_CHUNK_HASH(chunk)]);
	spin_unlock_irqrestore(&s->tracked_chunk_lock, flags);

	return c;
}

static void stop_tracking_chunk(struct dm_snapshot *s,
				struct dm_snap_tracked_chunk *c)
{
	unsigned long flags;

	spin_lock_irqsave(&s->tracked_chunk_lock, flags);
	hlist_del(&c->node);
	spin_unlock_irqrestore(&s->tracked_chunk_lock, flags);

	mempool_free(c, s->tracked_chunk_pool);
}

198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218
static int __chunk_is_tracked(struct dm_snapshot *s, chunk_t chunk)
{
	struct dm_snap_tracked_chunk *c;
	struct hlist_node *hn;
	int found = 0;

	spin_lock_irq(&s->tracked_chunk_lock);

	hlist_for_each_entry(c, hn,
	    &s->tracked_chunk_hash[DM_TRACKED_CHUNK_HASH(chunk)], node) {
		if (c->chunk == chunk) {
			found = 1;
			break;
		}
	}

	spin_unlock_irq(&s->tracked_chunk_lock);

	return found;
}

219 220 221 222 223 224 225 226 227 228
/*
 * This conflicting I/O is extremely improbable in the caller,
 * so msleep(1) is sufficient and there is no need for a wait queue.
 */
static void __check_for_conflicting_io(struct dm_snapshot *s, chunk_t chunk)
{
	while (__chunk_is_tracked(s, chunk))
		msleep(1);
}

L
Linus Torvalds 已提交
229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257
/*
 * One of these per registered origin, held in the snapshot_origins hash
 */
struct origin {
	/* The origin device */
	struct block_device *bdev;

	struct list_head hash_list;

	/* List of snapshots for this origin */
	struct list_head snapshots;
};

/*
 * Size of the hash table for origin volumes. If we make this
 * the size of the minors list then it should be nearly perfect
 */
#define ORIGIN_HASH_SIZE 256
#define ORIGIN_MASK      0xFF
static struct list_head *_origins;
static struct rw_semaphore _origins_lock;

static int init_origin_hash(void)
{
	int i;

	_origins = kmalloc(ORIGIN_HASH_SIZE * sizeof(struct list_head),
			   GFP_KERNEL);
	if (!_origins) {
258
		DMERR("unable to allocate memory");
L
Linus Torvalds 已提交
259 260 261 262 263 264 265 266 267 268 269 270 271 272 273
		return -ENOMEM;
	}

	for (i = 0; i < ORIGIN_HASH_SIZE; i++)
		INIT_LIST_HEAD(_origins + i);
	init_rwsem(&_origins_lock);

	return 0;
}

static void exit_origin_hash(void)
{
	kfree(_origins);
}

A
Alasdair G Kergon 已提交
274
static unsigned origin_hash(struct block_device *bdev)
L
Linus Torvalds 已提交
275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297
{
	return bdev->bd_dev & ORIGIN_MASK;
}

static struct origin *__lookup_origin(struct block_device *origin)
{
	struct list_head *ol;
	struct origin *o;

	ol = &_origins[origin_hash(origin)];
	list_for_each_entry (o, ol, hash_list)
		if (bdev_equal(o->bdev, origin))
			return o;

	return NULL;
}

static void __insert_origin(struct origin *o)
{
	struct list_head *sl = &_origins[origin_hash(o->bdev)];
	list_add_tail(&o->hash_list, sl);
}

298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381
/*
 * _origins_lock must be held when calling this function.
 * Returns number of snapshots registered using the supplied cow device, plus:
 * snap_src - a snapshot suitable for use as a source of exception handover
 * snap_dest - a snapshot capable of receiving exception handover.
 *
 * Possible return values and states:
 *   0: NULL, NULL  - first new snapshot
 *   1: snap_src, NULL - normal snapshot
 *   2: snap_src, snap_dest  - waiting for handover
 *   2: snap_src, NULL - handed over, waiting for old to be deleted
 *   1: NULL, snap_dest - source got destroyed without handover
 */
static int __find_snapshots_sharing_cow(struct dm_snapshot *snap,
					struct dm_snapshot **snap_src,
					struct dm_snapshot **snap_dest)
{
	struct dm_snapshot *s;
	struct origin *o;
	int count = 0;
	int active;

	o = __lookup_origin(snap->origin->bdev);
	if (!o)
		goto out;

	list_for_each_entry(s, &o->snapshots, list) {
		if (!bdev_equal(s->cow->bdev, snap->cow->bdev))
			continue;

		down_read(&s->lock);
		active = s->active;
		up_read(&s->lock);

		if (active) {
			if (snap_src)
				*snap_src = s;
		} else if (snap_dest)
			*snap_dest = s;

		count++;
	}

out:
	return count;
}

/*
 * On success, returns 1 if this snapshot is a handover destination,
 * otherwise returns 0.
 */
static int __validate_exception_handover(struct dm_snapshot *snap)
{
	struct dm_snapshot *snap_src = NULL, *snap_dest = NULL;

	/* Does snapshot need exceptions handed over to it? */
	if ((__find_snapshots_sharing_cow(snap, &snap_src, &snap_dest) == 2) ||
	    snap_dest) {
		snap->ti->error = "Snapshot cow pairing for exception "
				  "table handover failed";
		return -EINVAL;
	}

	/*
	 * If no snap_src was found, snap cannot become a handover
	 * destination.
	 */
	if (!snap_src)
		return 0;

	return 1;
}

static void __insert_snapshot(struct origin *o, struct dm_snapshot *s)
{
	struct dm_snapshot *l;

	/* Sort the list according to chunk size, largest-first smallest-last */
	list_for_each_entry(l, &o->snapshots, list)
		if (l->store->chunk_size < s->store->chunk_size)
			break;
	list_add_tail(&s->list, &l->list);
}

L
Linus Torvalds 已提交
382 383 384
/*
 * Make a note of the snapshot and its origin so we can look it
 * up when the origin has a write on it.
385 386 387 388
 *
 * Also validate snapshot exception store handovers.
 * On success, returns 1 if this registration is a handover destination,
 * otherwise returns 0.
L
Linus Torvalds 已提交
389 390 391
 */
static int register_snapshot(struct dm_snapshot *snap)
{
392
	struct origin *o, *new_o = NULL;
L
Linus Torvalds 已提交
393
	struct block_device *bdev = snap->origin->bdev;
394
	int r = 0;
L
Linus Torvalds 已提交
395

396 397 398 399
	new_o = kmalloc(sizeof(*new_o), GFP_KERNEL);
	if (!new_o)
		return -ENOMEM;

L
Linus Torvalds 已提交
400 401
	down_write(&_origins_lock);

402 403 404 405 406 407 408
	r = __validate_exception_handover(snap);
	if (r < 0) {
		kfree(new_o);
		goto out;
	}

	o = __lookup_origin(bdev);
409 410 411
	if (o)
		kfree(new_o);
	else {
L
Linus Torvalds 已提交
412
		/* New origin */
413
		o = new_o;
L
Linus Torvalds 已提交
414 415 416 417 418 419 420 421

		/* Initialise the struct */
		INIT_LIST_HEAD(&o->snapshots);
		o->bdev = bdev;

		__insert_origin(o);
	}

422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440
	__insert_snapshot(o, snap);

out:
	up_write(&_origins_lock);

	return r;
}

/*
 * Move snapshot to correct place in list according to chunk size.
 */
static void reregister_snapshot(struct dm_snapshot *s)
{
	struct block_device *bdev = s->origin->bdev;

	down_write(&_origins_lock);

	list_del(&s->list);
	__insert_snapshot(__lookup_origin(bdev), s);
L
Linus Torvalds 已提交
441 442 443 444 445 446 447 448 449 450 451 452

	up_write(&_origins_lock);
}

static void unregister_snapshot(struct dm_snapshot *s)
{
	struct origin *o;

	down_write(&_origins_lock);
	o = __lookup_origin(s->origin->bdev);

	list_del(&s->list);
453
	if (o && list_empty(&o->snapshots)) {
L
Linus Torvalds 已提交
454 455 456 457 458 459 460 461 462
		list_del(&o->hash_list);
		kfree(o);
	}

	up_write(&_origins_lock);
}

/*
 * Implementation of the exception hash tables.
463 464
 * The lowest hash_shift bits of the chunk number are ignored, allowing
 * some consecutive chunks to be grouped together.
L
Linus Torvalds 已提交
465
 */
466 467
static int dm_exception_table_init(struct dm_exception_table *et,
				   uint32_t size, unsigned hash_shift)
L
Linus Torvalds 已提交
468 469 470
{
	unsigned int i;

471
	et->hash_shift = hash_shift;
L
Linus Torvalds 已提交
472 473 474 475 476 477 478 479 480 481 482
	et->hash_mask = size - 1;
	et->table = dm_vcalloc(size, sizeof(struct list_head));
	if (!et->table)
		return -ENOMEM;

	for (i = 0; i < size; i++)
		INIT_LIST_HEAD(et->table + i);

	return 0;
}

483 484
static void dm_exception_table_exit(struct dm_exception_table *et,
				    struct kmem_cache *mem)
L
Linus Torvalds 已提交
485 486
{
	struct list_head *slot;
487
	struct dm_exception *ex, *next;
L
Linus Torvalds 已提交
488 489 490 491 492 493 494 495 496 497 498 499 500
	int i, size;

	size = et->hash_mask + 1;
	for (i = 0; i < size; i++) {
		slot = et->table + i;

		list_for_each_entry_safe (ex, next, slot, hash_list)
			kmem_cache_free(mem, ex);
	}

	vfree(et->table);
}

501
static uint32_t exception_hash(struct dm_exception_table *et, chunk_t chunk)
L
Linus Torvalds 已提交
502
{
503
	return (chunk >> et->hash_shift) & et->hash_mask;
L
Linus Torvalds 已提交
504 505
}

506
static void dm_remove_exception(struct dm_exception *e)
L
Linus Torvalds 已提交
507 508 509 510 511 512 513 514
{
	list_del(&e->hash_list);
}

/*
 * Return the exception data for a sector, or NULL if not
 * remapped.
 */
515 516
static struct dm_exception *dm_lookup_exception(struct dm_exception_table *et,
						chunk_t chunk)
L
Linus Torvalds 已提交
517 518
{
	struct list_head *slot;
519
	struct dm_exception *e;
L
Linus Torvalds 已提交
520 521 522

	slot = &et->table[exception_hash(et, chunk)];
	list_for_each_entry (e, slot, hash_list)
523 524
		if (chunk >= e->old_chunk &&
		    chunk <= e->old_chunk + dm_consecutive_chunk_count(e))
L
Linus Torvalds 已提交
525 526 527 528 529
			return e;

	return NULL;
}

530
static struct dm_exception *alloc_completed_exception(void)
L
Linus Torvalds 已提交
531
{
532
	struct dm_exception *e;
L
Linus Torvalds 已提交
533 534 535 536 537 538 539 540

	e = kmem_cache_alloc(exception_cache, GFP_NOIO);
	if (!e)
		e = kmem_cache_alloc(exception_cache, GFP_ATOMIC);

	return e;
}

541
static void free_completed_exception(struct dm_exception *e)
L
Linus Torvalds 已提交
542 543 544 545
{
	kmem_cache_free(exception_cache, e);
}

546
static struct dm_snap_pending_exception *alloc_pending_exception(struct dm_snapshot *s)
L
Linus Torvalds 已提交
547
{
548 549 550
	struct dm_snap_pending_exception *pe = mempool_alloc(s->pending_pool,
							     GFP_NOIO);

551
	atomic_inc(&s->pending_exceptions_count);
552 553 554
	pe->snap = s;

	return pe;
L
Linus Torvalds 已提交
555 556
}

A
Alasdair G Kergon 已提交
557
static void free_pending_exception(struct dm_snap_pending_exception *pe)
L
Linus Torvalds 已提交
558
{
559 560 561 562 563
	struct dm_snapshot *s = pe->snap;

	mempool_free(pe, s->pending_pool);
	smp_mb__before_atomic_dec();
	atomic_dec(&s->pending_exceptions_count);
L
Linus Torvalds 已提交
564 565
}

566 567
static void dm_insert_exception(struct dm_exception_table *eh,
				struct dm_exception *new_e)
568 569
{
	struct list_head *l;
570
	struct dm_exception *e = NULL;
571 572 573 574 575 576 577 578 579 580 581 582 583 584 585

	l = &eh->table[exception_hash(eh, new_e->old_chunk)];

	/* Add immediately if this table doesn't support consecutive chunks */
	if (!eh->hash_shift)
		goto out;

	/* List is ordered by old_chunk */
	list_for_each_entry_reverse(e, l, hash_list) {
		/* Insert after an existing chunk? */
		if (new_e->old_chunk == (e->old_chunk +
					 dm_consecutive_chunk_count(e) + 1) &&
		    new_e->new_chunk == (dm_chunk_number(e->new_chunk) +
					 dm_consecutive_chunk_count(e) + 1)) {
			dm_consecutive_chunk_count_inc(e);
586
			free_completed_exception(new_e);
587 588 589 590 591 592 593 594 595
			return;
		}

		/* Insert before an existing chunk? */
		if (new_e->old_chunk == (e->old_chunk - 1) &&
		    new_e->new_chunk == (dm_chunk_number(e->new_chunk) - 1)) {
			dm_consecutive_chunk_count_inc(e);
			e->old_chunk--;
			e->new_chunk--;
596
			free_completed_exception(new_e);
597 598 599 600 601 602 603 604 605 606 607
			return;
		}

		if (new_e->old_chunk > e->old_chunk)
			break;
	}

out:
	list_add(&new_e->hash_list, e ? &e->hash_list : l);
}

608 609 610 611 612
/*
 * Callback used by the exception stores to load exceptions when
 * initialising.
 */
static int dm_add_exception(void *context, chunk_t old, chunk_t new)
L
Linus Torvalds 已提交
613
{
614
	struct dm_snapshot *s = context;
615
	struct dm_exception *e;
L
Linus Torvalds 已提交
616

617
	e = alloc_completed_exception();
L
Linus Torvalds 已提交
618 619 620 621
	if (!e)
		return -ENOMEM;

	e->old_chunk = old;
622 623

	/* Consecutive_count is implicitly initialised to zero */
L
Linus Torvalds 已提交
624
	e->new_chunk = new;
625

626
	dm_insert_exception(&s->complete, e);
627

L
Linus Torvalds 已提交
628 629 630
	return 0;
}

631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649
#define min_not_zero(l, r) (((l) == 0) ? (r) : (((r) == 0) ? (l) : min(l, r)))

/*
 * Return a minimum chunk size of all snapshots that have the specified origin.
 * Return zero if the origin has no snapshots.
 */
static sector_t __minimum_chunk_size(struct origin *o)
{
	struct dm_snapshot *snap;
	unsigned chunk_size = 0;

	if (o)
		list_for_each_entry(snap, &o->snapshots, list)
			chunk_size = min_not_zero(chunk_size,
						  snap->store->chunk_size);

	return chunk_size;
}

L
Linus Torvalds 已提交
650 651 652 653 654 655 656 657 658 659 660 661 662 663 664
/*
 * Hard coded magic.
 */
static int calc_max_buckets(void)
{
	/* use a fixed size of 2MB */
	unsigned long mem = 2 * 1024 * 1024;
	mem /= sizeof(struct list_head);

	return mem;
}

/*
 * Allocate room for a suitable hash table.
 */
665
static int init_hash_tables(struct dm_snapshot *s)
L
Linus Torvalds 已提交
666 667 668 669 670 671 672
{
	sector_t hash_size, cow_dev_size, origin_dev_size, max_buckets;

	/*
	 * Calculate based on the size of the original volume or
	 * the COW volume...
	 */
673
	cow_dev_size = get_dev_size(s->cow->bdev);
L
Linus Torvalds 已提交
674 675 676
	origin_dev_size = get_dev_size(s->origin->bdev);
	max_buckets = calc_max_buckets();

677
	hash_size = min(origin_dev_size, cow_dev_size) >> s->store->chunk_shift;
L
Linus Torvalds 已提交
678 679
	hash_size = min(hash_size, max_buckets);

680 681
	if (hash_size < 64)
		hash_size = 64;
682
	hash_size = rounddown_pow_of_two(hash_size);
683 684
	if (dm_exception_table_init(&s->complete, hash_size,
				    DM_CHUNK_CONSECUTIVE_BITS))
L
Linus Torvalds 已提交
685 686 687 688 689 690 691 692 693 694
		return -ENOMEM;

	/*
	 * Allocate hash table for in-flight exceptions
	 * Make this smaller than the real hash table
	 */
	hash_size >>= 3;
	if (hash_size < 64)
		hash_size = 64;

695 696
	if (dm_exception_table_init(&s->pending, hash_size, 0)) {
		dm_exception_table_exit(&s->complete, exception_cache);
L
Linus Torvalds 已提交
697 698 699 700 701 702 703 704 705 706 707 708
		return -ENOMEM;
	}

	return 0;
}

/*
 * Construct a snapshot mapping: <origin_dev> <COW-dev> <p/n> <chunk-size>
 */
static int snapshot_ctr(struct dm_target *ti, unsigned int argc, char **argv)
{
	struct dm_snapshot *s;
709
	int i;
L
Linus Torvalds 已提交
710
	int r = -EINVAL;
711
	char *origin_path, *cow_path;
712 713
	unsigned args_used, num_flush_requests = 1;
	fmode_t origin_mode = FMODE_READ;
L
Linus Torvalds 已提交
714

715
	if (argc != 4) {
716
		ti->error = "requires exactly 4 arguments";
L
Linus Torvalds 已提交
717
		r = -EINVAL;
718
		goto bad;
L
Linus Torvalds 已提交
719 720
	}

721 722 723 724 725
	if (dm_target_is_snapshot_merge(ti)) {
		num_flush_requests = 2;
		origin_mode = FMODE_WRITE;
	}

L
Linus Torvalds 已提交
726
	origin_path = argv[0];
727 728
	argv++;
	argc--;
L
Linus Torvalds 已提交
729

730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749
	s = kmalloc(sizeof(*s), GFP_KERNEL);
	if (!s) {
		ti->error = "Cannot allocate snapshot context private "
		    "structure";
		r = -ENOMEM;
		goto bad;
	}

	cow_path = argv[0];
	argv++;
	argc--;

	r = dm_get_device(ti, cow_path, 0, 0,
			  FMODE_READ | FMODE_WRITE, &s->cow);
	if (r) {
		ti->error = "Cannot get COW device";
		goto bad_cow;
	}

	r = dm_exception_store_create(ti, argc, argv, s, &args_used, &s->store);
750 751
	if (r) {
		ti->error = "Couldn't create exception store";
L
Linus Torvalds 已提交
752
		r = -EINVAL;
753
		goto bad_store;
L
Linus Torvalds 已提交
754 755
	}

756 757 758
	argv += args_used;
	argc -= args_used;

759
	r = dm_get_device(ti, origin_path, 0, ti->len, origin_mode, &s->origin);
L
Linus Torvalds 已提交
760 761
	if (r) {
		ti->error = "Cannot get origin device";
762
		goto bad_origin;
L
Linus Torvalds 已提交
763 764
	}

765
	s->ti = ti;
L
Linus Torvalds 已提交
766
	s->valid = 1;
767
	s->active = 0;
768
	s->suspended = 0;
769
	atomic_set(&s->pending_exceptions_count, 0);
L
Linus Torvalds 已提交
770
	init_rwsem(&s->lock);
771
	INIT_LIST_HEAD(&s->list);
772
	spin_lock_init(&s->pe_lock);
L
Linus Torvalds 已提交
773 774

	/* Allocate hash table for COW data */
775
	if (init_hash_tables(s)) {
L
Linus Torvalds 已提交
776 777
		ti->error = "Unable to allocate hash table space";
		r = -ENOMEM;
778
		goto bad_hash_tables;
L
Linus Torvalds 已提交
779 780
	}

H
Heinz Mauelshagen 已提交
781
	r = dm_kcopyd_client_create(SNAPSHOT_PAGES, &s->kcopyd_client);
L
Linus Torvalds 已提交
782 783
	if (r) {
		ti->error = "Could not create kcopyd client";
784
		goto bad_kcopyd;
L
Linus Torvalds 已提交
785 786
	}

787 788 789
	s->pending_pool = mempool_create_slab_pool(MIN_IOS, pending_cache);
	if (!s->pending_pool) {
		ti->error = "Could not allocate mempool for pending exceptions";
790
		goto bad_pending_pool;
791 792
	}

793 794 795 796 797
	s->tracked_chunk_pool = mempool_create_slab_pool(MIN_IOS,
							 tracked_chunk_cache);
	if (!s->tracked_chunk_pool) {
		ti->error = "Could not allocate tracked_chunk mempool for "
			    "tracking reads";
798
		goto bad_tracked_chunk_pool;
799 800 801 802 803 804 805
	}

	for (i = 0; i < DM_TRACKED_CHUNK_HASH_SIZE; i++)
		INIT_HLIST_HEAD(&s->tracked_chunk_hash[i]);

	spin_lock_init(&s->tracked_chunk_lock);

806 807 808 809
	bio_list_init(&s->queued_bios);
	INIT_WORK(&s->queued_bios_work, flush_queued_bios);

	ti->private = s;
810
	ti->num_flush_requests = num_flush_requests;
811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833

	/* Add snapshot to the list of snapshots for this origin */
	/* Exceptions aren't triggered till snapshot_resume() is called */
	r = register_snapshot(s);
	if (r == -ENOMEM) {
		ti->error = "Snapshot origin struct allocation failed";
		goto bad_load_and_register;
	} else if (r < 0) {
		/* invalid handover, register_snapshot has set ti->error */
		goto bad_load_and_register;
	}

	/*
	 * Metadata must only be loaded into one table at once, so skip this
	 * if metadata will be handed over during resume.
	 * Chunk size will be set during the handover - set it to zero to
	 * ensure it's ignored.
	 */
	if (r > 0) {
		s->store->chunk_size = 0;
		return 0;
	}

834 835
	r = s->store->type->read_metadata(s->store, dm_add_exception,
					  (void *)s);
836
	if (r < 0) {
837
		ti->error = "Failed to read snapshot metadata";
838
		goto bad_read_metadata;
839 840 841
	} else if (r > 0) {
		s->valid = 0;
		DMWARN("Snapshot is marked invalid.");
842
	}
843

844 845
	if (!s->store->chunk_size) {
		ti->error = "Chunk size not set";
846
		goto bad_read_metadata;
L
Linus Torvalds 已提交
847
	}
848
	ti->split_io = s->store->chunk_size;
L
Linus Torvalds 已提交
849 850 851

	return 0;

852 853 854
bad_read_metadata:
	unregister_snapshot(s);

855
bad_load_and_register:
856 857
	mempool_destroy(s->tracked_chunk_pool);

858
bad_tracked_chunk_pool:
859 860
	mempool_destroy(s->pending_pool);

861
bad_pending_pool:
H
Heinz Mauelshagen 已提交
862
	dm_kcopyd_client_destroy(s->kcopyd_client);
L
Linus Torvalds 已提交
863

864
bad_kcopyd:
865 866
	dm_exception_table_exit(&s->pending, pending_cache);
	dm_exception_table_exit(&s->complete, exception_cache);
L
Linus Torvalds 已提交
867

868
bad_hash_tables:
L
Linus Torvalds 已提交
869 870
	dm_put_device(ti, s->origin);

871
bad_origin:
872
	dm_exception_store_destroy(s->store);
L
Linus Torvalds 已提交
873

874 875
bad_store:
	dm_put_device(ti, s->cow);
876

877 878 879 880
bad_cow:
	kfree(s);

bad:
L
Linus Torvalds 已提交
881 882 883
	return r;
}

884 885
static void __free_exceptions(struct dm_snapshot *s)
{
H
Heinz Mauelshagen 已提交
886
	dm_kcopyd_client_destroy(s->kcopyd_client);
887 888
	s->kcopyd_client = NULL;

889 890
	dm_exception_table_exit(&s->pending, pending_cache);
	dm_exception_table_exit(&s->complete, exception_cache);
891 892
}

893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923
static void __handover_exceptions(struct dm_snapshot *snap_src,
				  struct dm_snapshot *snap_dest)
{
	union {
		struct dm_exception_table table_swap;
		struct dm_exception_store *store_swap;
	} u;

	/*
	 * Swap all snapshot context information between the two instances.
	 */
	u.table_swap = snap_dest->complete;
	snap_dest->complete = snap_src->complete;
	snap_src->complete = u.table_swap;

	u.store_swap = snap_dest->store;
	snap_dest->store = snap_src->store;
	snap_src->store = u.store_swap;

	snap_dest->store->snap = snap_dest;
	snap_src->store->snap = snap_src;

	snap_dest->ti->split_io = snap_dest->store->chunk_size;
	snap_dest->valid = snap_src->valid;

	/*
	 * Set source invalid to ensure it receives no further I/O.
	 */
	snap_src->valid = 0;
}

L
Linus Torvalds 已提交
924 925
static void snapshot_dtr(struct dm_target *ti)
{
926 927 928
#ifdef CONFIG_DM_DEBUG
	int i;
#endif
A
Alasdair G Kergon 已提交
929
	struct dm_snapshot *s = ti->private;
930
	struct dm_snapshot *snap_src = NULL, *snap_dest = NULL;
L
Linus Torvalds 已提交
931

932 933
	flush_workqueue(ksnapd);

934 935 936 937 938 939 940 941 942 943 944
	down_read(&_origins_lock);
	/* Check whether exception handover must be cancelled */
	(void) __find_snapshots_sharing_cow(s, &snap_src, &snap_dest);
	if (snap_src && snap_dest && (s == snap_src)) {
		down_write(&snap_dest->lock);
		snap_dest->valid = 0;
		up_write(&snap_dest->lock);
		DMERR("Cancelling snapshot handover.");
	}
	up_read(&_origins_lock);

945 946
	/* Prevent further origin writes from using this snapshot. */
	/* After this returns there can be no new kcopyd jobs. */
L
Linus Torvalds 已提交
947 948
	unregister_snapshot(s);

949
	while (atomic_read(&s->pending_exceptions_count))
950
		msleep(1);
951 952 953 954 955 956
	/*
	 * Ensure instructions in mempool_destroy aren't reordered
	 * before atomic_read.
	 */
	smp_mb();

957 958 959 960 961 962 963
#ifdef CONFIG_DM_DEBUG
	for (i = 0; i < DM_TRACKED_CHUNK_HASH_SIZE; i++)
		BUG_ON(!hlist_empty(&s->tracked_chunk_hash[i]));
#endif

	mempool_destroy(s->tracked_chunk_pool);

964
	__free_exceptions(s);
L
Linus Torvalds 已提交
965

966 967
	mempool_destroy(s->pending_pool);

L
Linus Torvalds 已提交
968
	dm_put_device(ti, s->origin);
969 970

	dm_exception_store_destroy(s->store);
971

972 973
	dm_put_device(ti, s->cow);

L
Linus Torvalds 已提交
974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991
	kfree(s);
}

/*
 * Flush a list of buffers.
 */
static void flush_bios(struct bio *bio)
{
	struct bio *n;

	while (bio) {
		n = bio->bi_next;
		bio->bi_next = NULL;
		generic_make_request(bio);
		bio = n;
	}
}

D
David Howells 已提交
992
static void flush_queued_bios(struct work_struct *work)
993
{
D
David Howells 已提交
994 995
	struct dm_snapshot *s =
		container_of(work, struct dm_snapshot, queued_bios_work);
996 997 998 999 1000 1001 1002 1003 1004 1005
	struct bio *queued_bios;
	unsigned long flags;

	spin_lock_irqsave(&s->pe_lock, flags);
	queued_bios = bio_list_get(&s->queued_bios);
	spin_unlock_irqrestore(&s->pe_lock, flags);

	flush_bios(queued_bios);
}

1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025
static int do_origin(struct dm_dev *origin, struct bio *bio);

/*
 * Flush a list of buffers.
 */
static void retry_origin_bios(struct dm_snapshot *s, struct bio *bio)
{
	struct bio *n;
	int r;

	while (bio) {
		n = bio->bi_next;
		bio->bi_next = NULL;
		r = do_origin(s->origin, bio);
		if (r == DM_MAPIO_REMAPPED)
			generic_make_request(bio);
		bio = n;
	}
}

L
Linus Torvalds 已提交
1026 1027 1028 1029 1030 1031 1032 1033 1034 1035
/*
 * Error a list of buffers.
 */
static void error_bios(struct bio *bio)
{
	struct bio *n;

	while (bio) {
		n = bio->bi_next;
		bio->bi_next = NULL;
1036
		bio_io_error(bio);
L
Linus Torvalds 已提交
1037 1038 1039 1040
		bio = n;
	}
}

1041
static void __invalidate_snapshot(struct dm_snapshot *s, int err)
1042 1043 1044 1045 1046 1047 1048 1049 1050
{
	if (!s->valid)
		return;

	if (err == -EIO)
		DMERR("Invalidating snapshot: Error reading/writing.");
	else if (err == -ENOMEM)
		DMERR("Invalidating snapshot: Unable to allocate exception.");

1051 1052
	if (s->store->type->drop_snapshot)
		s->store->type->drop_snapshot(s->store);
1053 1054 1055

	s->valid = 0;

1056
	dm_table_event(s->ti->table);
1057 1058
}

A
Alasdair G Kergon 已提交
1059
static void pending_complete(struct dm_snap_pending_exception *pe, int success)
L
Linus Torvalds 已提交
1060
{
1061
	struct dm_exception *e;
L
Linus Torvalds 已提交
1062
	struct dm_snapshot *s = pe->snap;
1063 1064 1065
	struct bio *origin_bios = NULL;
	struct bio *snapshot_bios = NULL;
	int error = 0;
L
Linus Torvalds 已提交
1066

1067 1068
	if (!success) {
		/* Read/write error - snapshot is unusable */
L
Linus Torvalds 已提交
1069
		down_write(&s->lock);
1070
		__invalidate_snapshot(s, -EIO);
1071
		error = 1;
1072 1073 1074
		goto out;
	}

1075
	e = alloc_completed_exception();
1076
	if (!e) {
L
Linus Torvalds 已提交
1077
		down_write(&s->lock);
1078
		__invalidate_snapshot(s, -ENOMEM);
1079
		error = 1;
1080 1081 1082
		goto out;
	}
	*e = pe->e;
L
Linus Torvalds 已提交
1083

1084 1085
	down_write(&s->lock);
	if (!s->valid) {
1086
		free_completed_exception(e);
1087
		error = 1;
1088
		goto out;
L
Linus Torvalds 已提交
1089 1090
	}

1091 1092
	/* Check for conflicting reads */
	__check_for_conflicting_io(s, pe->e.old_chunk);
1093

1094 1095 1096 1097
	/*
	 * Add a proper exception, and remove the
	 * in-flight exception from the list.
	 */
1098
	dm_insert_exception(&s->complete, e);
1099

L
Linus Torvalds 已提交
1100
 out:
1101
	dm_remove_exception(&pe->e);
1102
	snapshot_bios = bio_list_get(&pe->snapshot_bios);
1103 1104
	origin_bios = bio_list_get(&pe->origin_bios);
	free_pending_exception(pe);
L
Linus Torvalds 已提交
1105

1106 1107 1108 1109 1110 1111 1112 1113
	up_write(&s->lock);

	/* Submit any pending write bios */
	if (error)
		error_bios(snapshot_bios);
	else
		flush_bios(snapshot_bios);

1114
	retry_origin_bios(s, origin_bios);
L
Linus Torvalds 已提交
1115 1116 1117 1118
}

static void commit_callback(void *context, int success)
{
A
Alasdair G Kergon 已提交
1119 1120
	struct dm_snap_pending_exception *pe = context;

L
Linus Torvalds 已提交
1121 1122 1123 1124 1125 1126 1127
	pending_complete(pe, success);
}

/*
 * Called when the copy I/O has finished.  kcopyd actually runs
 * this code so don't block.
 */
1128
static void copy_callback(int read_err, unsigned long write_err, void *context)
L
Linus Torvalds 已提交
1129
{
A
Alasdair G Kergon 已提交
1130
	struct dm_snap_pending_exception *pe = context;
L
Linus Torvalds 已提交
1131 1132 1133 1134 1135 1136 1137
	struct dm_snapshot *s = pe->snap;

	if (read_err || write_err)
		pending_complete(pe, 0);

	else
		/* Update the metadata if we are persistent */
1138 1139
		s->store->type->commit_exception(s->store, &pe->e,
						 commit_callback, pe);
L
Linus Torvalds 已提交
1140 1141 1142 1143 1144
}

/*
 * Dispatches the copy operation to kcopyd.
 */
A
Alasdair G Kergon 已提交
1145
static void start_copy(struct dm_snap_pending_exception *pe)
L
Linus Torvalds 已提交
1146 1147
{
	struct dm_snapshot *s = pe->snap;
H
Heinz Mauelshagen 已提交
1148
	struct dm_io_region src, dest;
L
Linus Torvalds 已提交
1149 1150 1151 1152 1153 1154
	struct block_device *bdev = s->origin->bdev;
	sector_t dev_size;

	dev_size = get_dev_size(bdev);

	src.bdev = bdev;
1155
	src.sector = chunk_to_sector(s->store, pe->e.old_chunk);
1156
	src.count = min((sector_t)s->store->chunk_size, dev_size - src.sector);
L
Linus Torvalds 已提交
1157

1158
	dest.bdev = s->cow->bdev;
1159
	dest.sector = chunk_to_sector(s->store, pe->e.new_chunk);
L
Linus Torvalds 已提交
1160 1161 1162
	dest.count = src.count;

	/* Hand over to kcopyd */
H
Heinz Mauelshagen 已提交
1163
	dm_kcopyd_copy(s->kcopyd_client,
L
Linus Torvalds 已提交
1164 1165 1166
		    &src, 1, &dest, 0, copy_callback, pe);
}

1167 1168 1169
static struct dm_snap_pending_exception *
__lookup_pending_exception(struct dm_snapshot *s, chunk_t chunk)
{
1170
	struct dm_exception *e = dm_lookup_exception(&s->pending, chunk);
1171 1172 1173 1174 1175 1176 1177

	if (!e)
		return NULL;

	return container_of(e, struct dm_snap_pending_exception, e);
}

L
Linus Torvalds 已提交
1178 1179 1180 1181 1182 1183 1184 1185
/*
 * Looks to see if this snapshot already has a pending exception
 * for this chunk, otherwise it allocates a new one and inserts
 * it into the pending table.
 *
 * NOTE: a write lock must be held on snap->lock before calling
 * this.
 */
A
Alasdair G Kergon 已提交
1186
static struct dm_snap_pending_exception *
1187 1188
__find_pending_exception(struct dm_snapshot *s,
			 struct dm_snap_pending_exception *pe, chunk_t chunk)
L
Linus Torvalds 已提交
1189
{
1190
	struct dm_snap_pending_exception *pe2;
L
Linus Torvalds 已提交
1191

1192 1193
	pe2 = __lookup_pending_exception(s, chunk);
	if (pe2) {
1194
		free_pending_exception(pe);
1195
		return pe2;
L
Linus Torvalds 已提交
1196 1197
	}

1198 1199 1200 1201 1202
	pe->e.old_chunk = chunk;
	bio_list_init(&pe->origin_bios);
	bio_list_init(&pe->snapshot_bios);
	pe->started = 0;

1203
	if (s->store->type->prepare_exception(s->store, &pe->e)) {
1204 1205 1206 1207
		free_pending_exception(pe);
		return NULL;
	}

1208
	dm_insert_exception(&s->pending, &pe->e);
1209

L
Linus Torvalds 已提交
1210 1211 1212
	return pe;
}

1213
static void remap_exception(struct dm_snapshot *s, struct dm_exception *e,
1214
			    struct bio *bio, chunk_t chunk)
L
Linus Torvalds 已提交
1215
{
1216
	bio->bi_bdev = s->cow->bdev;
1217 1218 1219 1220 1221
	bio->bi_sector = chunk_to_sector(s->store,
					 dm_chunk_number(e->new_chunk) +
					 (chunk - e->old_chunk)) +
					 (bio->bi_sector &
					  s->store->chunk_mask);
L
Linus Torvalds 已提交
1222 1223 1224 1225 1226
}

static int snapshot_map(struct dm_target *ti, struct bio *bio,
			union map_info *map_context)
{
1227
	struct dm_exception *e;
A
Alasdair G Kergon 已提交
1228
	struct dm_snapshot *s = ti->private;
1229
	int r = DM_MAPIO_REMAPPED;
L
Linus Torvalds 已提交
1230
	chunk_t chunk;
A
Alasdair G Kergon 已提交
1231
	struct dm_snap_pending_exception *pe = NULL;
L
Linus Torvalds 已提交
1232

M
Mikulas Patocka 已提交
1233
	if (unlikely(bio_empty_barrier(bio))) {
1234
		bio->bi_bdev = s->cow->bdev;
M
Mikulas Patocka 已提交
1235 1236 1237
		return DM_MAPIO_REMAPPED;
	}

1238
	chunk = sector_to_chunk(s->store, bio->bi_sector);
L
Linus Torvalds 已提交
1239 1240

	/* Full snapshots are not usable */
1241
	/* To get here the table must be live so s->active is always set. */
L
Linus Torvalds 已提交
1242
	if (!s->valid)
1243
		return -EIO;
L
Linus Torvalds 已提交
1244

1245 1246 1247 1248 1249 1250 1251 1252 1253 1254
	/* FIXME: should only take write lock if we need
	 * to copy an exception */
	down_write(&s->lock);

	if (!s->valid) {
		r = -EIO;
		goto out_unlock;
	}

	/* If the block is already remapped - use that, else remap it */
1255
	e = dm_lookup_exception(&s->complete, chunk);
1256
	if (e) {
1257
		remap_exception(s, e, bio, chunk);
1258 1259 1260
		goto out_unlock;
	}

L
Linus Torvalds 已提交
1261 1262 1263 1264 1265 1266
	/*
	 * Write to snapshot - higher level takes care of RW/RO
	 * flags so we should only get this if we are
	 * writeable.
	 */
	if (bio_rw(bio) == WRITE) {
1267
		pe = __lookup_pending_exception(s, chunk);
1268
		if (!pe) {
1269 1270 1271 1272 1273 1274 1275 1276 1277 1278
			up_write(&s->lock);
			pe = alloc_pending_exception(s);
			down_write(&s->lock);

			if (!s->valid) {
				free_pending_exception(pe);
				r = -EIO;
				goto out_unlock;
			}

1279
			e = dm_lookup_exception(&s->complete, chunk);
1280 1281 1282 1283 1284 1285
			if (e) {
				free_pending_exception(pe);
				remap_exception(s, e, bio, chunk);
				goto out_unlock;
			}

1286
			pe = __find_pending_exception(s, pe, chunk);
1287 1288 1289 1290 1291
			if (!pe) {
				__invalidate_snapshot(s, -ENOMEM);
				r = -EIO;
				goto out_unlock;
			}
L
Linus Torvalds 已提交
1292 1293
		}

1294
		remap_exception(s, &pe->e, bio, chunk);
1295 1296
		bio_list_add(&pe->snapshot_bios, bio);

1297
		r = DM_MAPIO_SUBMITTED;
1298

1299 1300 1301
		if (!pe->started) {
			/* this is protected by snap->lock */
			pe->started = 1;
1302
			up_write(&s->lock);
1303
			start_copy(pe);
1304 1305
			goto out;
		}
1306
	} else {
1307
		bio->bi_bdev = s->origin->bdev;
1308 1309
		map_context->ptr = track_chunk(s, chunk);
	}
L
Linus Torvalds 已提交
1310

1311 1312 1313
 out_unlock:
	up_write(&s->lock);
 out:
L
Linus Torvalds 已提交
1314 1315 1316
	return r;
}

1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334
/*
 * A snapshot-merge target behaves like a combination of a snapshot
 * target and a snapshot-origin target.  It only generates new
 * exceptions in other snapshots and not in the one that is being
 * merged.
 *
 * For each chunk, if there is an existing exception, it is used to
 * redirect I/O to the cow device.  Otherwise I/O is sent to the origin,
 * which in turn might generate exceptions in other snapshots.
 */
static int snapshot_merge_map(struct dm_target *ti, struct bio *bio,
			      union map_info *map_context)
{
	struct dm_exception *e;
	struct dm_snapshot *s = ti->private;
	int r = DM_MAPIO_REMAPPED;
	chunk_t chunk;

1335 1336 1337 1338 1339 1340 1341 1342 1343
	if (unlikely(bio_empty_barrier(bio))) {
		if (!map_context->flush_request)
			bio->bi_bdev = s->origin->bdev;
		else
			bio->bi_bdev = s->cow->bdev;
		map_context->ptr = NULL;
		return DM_MAPIO_REMAPPED;
	}

1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373
	chunk = sector_to_chunk(s->store, bio->bi_sector);

	down_read(&s->lock);

	/* Full snapshots are not usable */
	if (!s->valid) {
		r = -EIO;
		goto out_unlock;
	}

	/* If the block is already remapped - use that */
	e = dm_lookup_exception(&s->complete, chunk);
	if (e) {
		remap_exception(s, e, bio, chunk);
		goto out_unlock;
	}

	bio->bi_bdev = s->origin->bdev;

	if (bio_rw(bio) == WRITE) {
		up_read(&s->lock);
		return do_origin(s->origin, bio);
	}

out_unlock:
	up_read(&s->lock);

	return r;
}

1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385
static int snapshot_end_io(struct dm_target *ti, struct bio *bio,
			   int error, union map_info *map_context)
{
	struct dm_snapshot *s = ti->private;
	struct dm_snap_tracked_chunk *c = map_context->ptr;

	if (c)
		stop_tracking_chunk(s, c);

	return 0;
}

1386 1387 1388 1389 1390 1391 1392 1393 1394
static void snapshot_postsuspend(struct dm_target *ti)
{
	struct dm_snapshot *s = ti->private;

	down_write(&s->lock);
	s->suspended = 1;
	up_write(&s->lock);
}

1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420
static int snapshot_preresume(struct dm_target *ti)
{
	int r = 0;
	struct dm_snapshot *s = ti->private;
	struct dm_snapshot *snap_src = NULL, *snap_dest = NULL;

	down_read(&_origins_lock);
	(void) __find_snapshots_sharing_cow(s, &snap_src, &snap_dest);
	if (snap_src && snap_dest) {
		down_read(&snap_src->lock);
		if (s == snap_src) {
			DMERR("Unable to resume snapshot source until "
			      "handover completes.");
			r = -EINVAL;
		} else if (!snap_src->suspended) {
			DMERR("Unable to perform snapshot handover until "
			      "source is suspended.");
			r = -EINVAL;
		}
		up_read(&snap_src->lock);
	}
	up_read(&_origins_lock);

	return r;
}

L
Linus Torvalds 已提交
1421 1422
static void snapshot_resume(struct dm_target *ti)
{
A
Alasdair G Kergon 已提交
1423
	struct dm_snapshot *s = ti->private;
1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438
	struct dm_snapshot *snap_src = NULL, *snap_dest = NULL;

	down_read(&_origins_lock);
	(void) __find_snapshots_sharing_cow(s, &snap_src, &snap_dest);
	if (snap_src && snap_dest) {
		down_write(&snap_src->lock);
		down_write_nested(&snap_dest->lock, SINGLE_DEPTH_NESTING);
		__handover_exceptions(snap_src, snap_dest);
		up_write(&snap_dest->lock);
		up_write(&snap_src->lock);
	}
	up_read(&_origins_lock);

	/* Now we have correct chunk size, reregister */
	reregister_snapshot(s);
L
Linus Torvalds 已提交
1439

1440 1441
	down_write(&s->lock);
	s->active = 1;
1442
	s->suspended = 0;
1443
	up_write(&s->lock);
L
Linus Torvalds 已提交
1444 1445 1446 1447 1448
}

static int snapshot_status(struct dm_target *ti, status_type_t type,
			   char *result, unsigned int maxlen)
{
1449
	unsigned sz = 0;
A
Alasdair G Kergon 已提交
1450
	struct dm_snapshot *snap = ti->private;
L
Linus Torvalds 已提交
1451 1452 1453

	switch (type) {
	case STATUSTYPE_INFO:
1454 1455 1456

		down_write(&snap->lock);

L
Linus Torvalds 已提交
1457
		if (!snap->valid)
1458
			DMEMIT("Invalid");
L
Linus Torvalds 已提交
1459
		else {
1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470
			if (snap->store->type->usage) {
				sector_t total_sectors, sectors_allocated,
					 metadata_sectors;
				snap->store->type->usage(snap->store,
							 &total_sectors,
							 &sectors_allocated,
							 &metadata_sectors);
				DMEMIT("%llu/%llu %llu",
				       (unsigned long long)sectors_allocated,
				       (unsigned long long)total_sectors,
				       (unsigned long long)metadata_sectors);
L
Linus Torvalds 已提交
1471 1472
			}
			else
1473
				DMEMIT("Unknown");
L
Linus Torvalds 已提交
1474
		}
1475 1476 1477

		up_write(&snap->lock);

L
Linus Torvalds 已提交
1478 1479 1480 1481 1482 1483 1484 1485
		break;

	case STATUSTYPE_TABLE:
		/*
		 * kdevname returns a static pointer so we need
		 * to make private copies if the output is to
		 * make sense.
		 */
1486
		DMEMIT("%s %s", snap->origin->name, snap->cow->name);
1487 1488
		snap->store->type->status(snap->store, type, result + sz,
					  maxlen - sz);
L
Linus Torvalds 已提交
1489 1490 1491 1492 1493 1494
		break;
	}

	return 0;
}

1495 1496 1497 1498 1499 1500 1501 1502 1503
static int snapshot_iterate_devices(struct dm_target *ti,
				    iterate_devices_callout_fn fn, void *data)
{
	struct dm_snapshot *snap = ti->private;

	return fn(ti, snap->origin, 0, ti->len, data);
}


L
Linus Torvalds 已提交
1504 1505 1506
/*-----------------------------------------------------------------
 * Origin methods
 *---------------------------------------------------------------*/
1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519

/*
 * If no exceptions need creating, DM_MAPIO_REMAPPED is returned and any
 * supplied bio was ignored.  The caller may submit it immediately.
 * (No remapping actually occurs as the origin is always a direct linear
 * map.)
 *
 * If further exceptions are required, DM_MAPIO_SUBMITTED is returned
 * and any supplied bio is added to a list to be submitted once all
 * the necessary exceptions exist.
 */
static int __origin_write(struct list_head *snapshots, sector_t sector,
			  struct bio *bio)
L
Linus Torvalds 已提交
1520
{
1521
	int r = DM_MAPIO_REMAPPED;
L
Linus Torvalds 已提交
1522
	struct dm_snapshot *snap;
1523
	struct dm_exception *e;
1524 1525 1526
	struct dm_snap_pending_exception *pe;
	struct dm_snap_pending_exception *pe_to_start_now = NULL;
	struct dm_snap_pending_exception *pe_to_start_last = NULL;
L
Linus Torvalds 已提交
1527 1528 1529 1530
	chunk_t chunk;

	/* Do all the snapshots on this origin */
	list_for_each_entry (snap, snapshots, list) {
1531 1532 1533 1534 1535 1536 1537
		/*
		 * Don't make new exceptions in a merging snapshot
		 * because it has effectively been deleted
		 */
		if (dm_target_is_snapshot_merge(snap->ti))
			continue;

1538 1539
		down_write(&snap->lock);

1540 1541
		/* Only deal with valid and active snapshots */
		if (!snap->valid || !snap->active)
1542
			goto next_snapshot;
L
Linus Torvalds 已提交
1543

1544
		/* Nothing to do if writing beyond end of snapshot */
1545
		if (sector >= dm_table_get_size(snap->ti->table))
1546
			goto next_snapshot;
L
Linus Torvalds 已提交
1547 1548 1549 1550 1551

		/*
		 * Remember, different snapshots can have
		 * different chunk sizes.
		 */
1552
		chunk = sector_to_chunk(snap->store, sector);
L
Linus Torvalds 已提交
1553 1554 1555 1556 1557 1558

		/*
		 * Check exception table to see if block
		 * is already remapped in this snapshot
		 * and trigger an exception if not.
		 */
1559
		e = dm_lookup_exception(&snap->complete, chunk);
1560 1561 1562
		if (e)
			goto next_snapshot;

1563
		pe = __lookup_pending_exception(snap, chunk);
1564
		if (!pe) {
1565 1566 1567 1568 1569 1570 1571 1572 1573
			up_write(&snap->lock);
			pe = alloc_pending_exception(snap);
			down_write(&snap->lock);

			if (!snap->valid) {
				free_pending_exception(pe);
				goto next_snapshot;
			}

1574
			e = dm_lookup_exception(&snap->complete, chunk);
1575 1576 1577 1578 1579
			if (e) {
				free_pending_exception(pe);
				goto next_snapshot;
			}

1580
			pe = __find_pending_exception(snap, pe, chunk);
1581 1582 1583 1584
			if (!pe) {
				__invalidate_snapshot(snap, -ENOMEM);
				goto next_snapshot;
			}
1585 1586
		}

1587
		r = DM_MAPIO_SUBMITTED;
1588

1589 1590 1591 1592 1593 1594 1595 1596
		/*
		 * If an origin bio was supplied, queue it to wait for the
		 * completion of this exception, and start this one last,
		 * at the end of the function.
		 */
		if (bio) {
			bio_list_add(&pe->origin_bios, bio);
			bio = NULL;
1597

1598 1599 1600 1601
			if (!pe->started) {
				pe->started = 1;
				pe_to_start_last = pe;
			}
1602 1603 1604 1605
		}

		if (!pe->started) {
			pe->started = 1;
1606
			pe_to_start_now = pe;
L
Linus Torvalds 已提交
1607 1608
		}

1609
 next_snapshot:
L
Linus Torvalds 已提交
1610 1611
		up_write(&snap->lock);

1612 1613 1614 1615
		if (pe_to_start_now) {
			start_copy(pe_to_start_now);
			pe_to_start_now = NULL;
		}
1616 1617
	}

L
Linus Torvalds 已提交
1618
	/*
1619 1620
	 * Submit the exception against which the bio is queued last,
	 * to give the other exceptions a head start.
L
Linus Torvalds 已提交
1621
	 */
1622 1623
	if (pe_to_start_last)
		start_copy(pe_to_start_last);
L
Linus Torvalds 已提交
1624 1625 1626 1627 1628 1629 1630 1631 1632 1633

	return r;
}

/*
 * Called on a write from the origin driver.
 */
static int do_origin(struct dm_dev *origin, struct bio *bio)
{
	struct origin *o;
1634
	int r = DM_MAPIO_REMAPPED;
L
Linus Torvalds 已提交
1635 1636 1637 1638

	down_read(&_origins_lock);
	o = __lookup_origin(origin->bdev);
	if (o)
1639
		r = __origin_write(&o->snapshots, bio->bi_sector, bio);
L
Linus Torvalds 已提交
1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659
	up_read(&_origins_lock);

	return r;
}

/*
 * Origin: maps a linear range of a device, with hooks for snapshotting.
 */

/*
 * Construct an origin mapping: <dev_path>
 * The context for an origin is merely a 'struct dm_dev *'
 * pointing to the real device.
 */
static int origin_ctr(struct dm_target *ti, unsigned int argc, char **argv)
{
	int r;
	struct dm_dev *dev;

	if (argc != 1) {
1660
		ti->error = "origin: incorrect number of arguments";
L
Linus Torvalds 已提交
1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671
		return -EINVAL;
	}

	r = dm_get_device(ti, argv[0], 0, ti->len,
			  dm_table_get_mode(ti->table), &dev);
	if (r) {
		ti->error = "Cannot get target device";
		return r;
	}

	ti->private = dev;
M
Mikulas Patocka 已提交
1672 1673
	ti->num_flush_requests = 1;

L
Linus Torvalds 已提交
1674 1675 1676 1677 1678
	return 0;
}

static void origin_dtr(struct dm_target *ti)
{
A
Alasdair G Kergon 已提交
1679
	struct dm_dev *dev = ti->private;
L
Linus Torvalds 已提交
1680 1681 1682 1683 1684 1685
	dm_put_device(ti, dev);
}

static int origin_map(struct dm_target *ti, struct bio *bio,
		      union map_info *map_context)
{
A
Alasdair G Kergon 已提交
1686
	struct dm_dev *dev = ti->private;
L
Linus Torvalds 已提交
1687 1688
	bio->bi_bdev = dev->bdev;

M
Mikulas Patocka 已提交
1689 1690 1691
	if (unlikely(bio_empty_barrier(bio)))
		return DM_MAPIO_REMAPPED;

L
Linus Torvalds 已提交
1692
	/* Only tell snapshots if this is a write */
1693
	return (bio_rw(bio) == WRITE) ? do_origin(dev, bio) : DM_MAPIO_REMAPPED;
L
Linus Torvalds 已提交
1694 1695 1696 1697 1698 1699 1700 1701
}

/*
 * Set the target "split_io" field to the minimum of all the snapshots'
 * chunk sizes.
 */
static void origin_resume(struct dm_target *ti)
{
A
Alasdair G Kergon 已提交
1702
	struct dm_dev *dev = ti->private;
L
Linus Torvalds 已提交
1703 1704 1705

	down_read(&_origins_lock);

1706 1707 1708
	ti->split_io = __minimum_chunk_size(__lookup_origin(dev->bdev));

	up_read(&_origins_lock);
L
Linus Torvalds 已提交
1709 1710 1711 1712 1713
}

static int origin_status(struct dm_target *ti, status_type_t type, char *result,
			 unsigned int maxlen)
{
A
Alasdair G Kergon 已提交
1714
	struct dm_dev *dev = ti->private;
L
Linus Torvalds 已提交
1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728

	switch (type) {
	case STATUSTYPE_INFO:
		result[0] = '\0';
		break;

	case STATUSTYPE_TABLE:
		snprintf(result, maxlen, "%s", dev->name);
		break;
	}

	return 0;
}

1729 1730 1731 1732 1733 1734 1735 1736
static int origin_iterate_devices(struct dm_target *ti,
				  iterate_devices_callout_fn fn, void *data)
{
	struct dm_dev *dev = ti->private;

	return fn(ti, dev, 0, ti->len, data);
}

L
Linus Torvalds 已提交
1737 1738
static struct target_type origin_target = {
	.name    = "snapshot-origin",
1739
	.version = {1, 7, 0},
L
Linus Torvalds 已提交
1740 1741 1742 1743 1744 1745
	.module  = THIS_MODULE,
	.ctr     = origin_ctr,
	.dtr     = origin_dtr,
	.map     = origin_map,
	.resume  = origin_resume,
	.status  = origin_status,
1746
	.iterate_devices = origin_iterate_devices,
L
Linus Torvalds 已提交
1747 1748 1749 1750
};

static struct target_type snapshot_target = {
	.name    = "snapshot",
1751
	.version = {1, 9, 0},
L
Linus Torvalds 已提交
1752 1753 1754 1755
	.module  = THIS_MODULE,
	.ctr     = snapshot_ctr,
	.dtr     = snapshot_dtr,
	.map     = snapshot_map,
1756
	.end_io  = snapshot_end_io,
1757
	.postsuspend = snapshot_postsuspend,
1758
	.preresume  = snapshot_preresume,
L
Linus Torvalds 已提交
1759 1760
	.resume  = snapshot_resume,
	.status  = snapshot_status,
1761
	.iterate_devices = snapshot_iterate_devices,
L
Linus Torvalds 已提交
1762 1763
};

M
Mikulas Patocka 已提交
1764 1765 1766 1767 1768 1769
static struct target_type merge_target = {
	.name    = dm_snapshot_merge_target_name,
	.version = {1, 0, 0},
	.module  = THIS_MODULE,
	.ctr     = snapshot_ctr,
	.dtr     = snapshot_dtr,
1770
	.map     = snapshot_merge_map,
M
Mikulas Patocka 已提交
1771 1772 1773 1774 1775 1776 1777 1778
	.end_io  = snapshot_end_io,
	.postsuspend = snapshot_postsuspend,
	.preresume  = snapshot_preresume,
	.resume  = snapshot_resume,
	.status  = snapshot_status,
	.iterate_devices = snapshot_iterate_devices,
};

L
Linus Torvalds 已提交
1779 1780 1781 1782
static int __init dm_snapshot_init(void)
{
	int r;

1783 1784 1785 1786 1787 1788
	r = dm_exception_store_init();
	if (r) {
		DMERR("Failed to initialize exception stores");
		return r;
	}

L
Linus Torvalds 已提交
1789
	r = dm_register_target(&snapshot_target);
M
Mikulas Patocka 已提交
1790
	if (r < 0) {
L
Linus Torvalds 已提交
1791
		DMERR("snapshot target register failed %d", r);
1792
		goto bad_register_snapshot_target;
L
Linus Torvalds 已提交
1793 1794 1795 1796
	}

	r = dm_register_target(&origin_target);
	if (r < 0) {
1797
		DMERR("Origin target register failed %d", r);
M
Mikulas Patocka 已提交
1798 1799 1800 1801 1802 1803 1804
		goto bad_register_origin_target;
	}

	r = dm_register_target(&merge_target);
	if (r < 0) {
		DMERR("Merge target register failed %d", r);
		goto bad_register_merge_target;
L
Linus Torvalds 已提交
1805 1806 1807 1808 1809
	}

	r = init_origin_hash();
	if (r) {
		DMERR("init_origin_hash failed.");
M
Mikulas Patocka 已提交
1810
		goto bad_origin_hash;
L
Linus Torvalds 已提交
1811 1812
	}

1813
	exception_cache = KMEM_CACHE(dm_exception, 0);
L
Linus Torvalds 已提交
1814 1815 1816
	if (!exception_cache) {
		DMERR("Couldn't create exception cache.");
		r = -ENOMEM;
M
Mikulas Patocka 已提交
1817
		goto bad_exception_cache;
L
Linus Torvalds 已提交
1818 1819
	}

A
Alasdair G Kergon 已提交
1820
	pending_cache = KMEM_CACHE(dm_snap_pending_exception, 0);
L
Linus Torvalds 已提交
1821 1822 1823
	if (!pending_cache) {
		DMERR("Couldn't create pending cache.");
		r = -ENOMEM;
M
Mikulas Patocka 已提交
1824
		goto bad_pending_cache;
L
Linus Torvalds 已提交
1825 1826
	}

1827 1828 1829 1830
	tracked_chunk_cache = KMEM_CACHE(dm_snap_tracked_chunk, 0);
	if (!tracked_chunk_cache) {
		DMERR("Couldn't create cache to track chunks in use.");
		r = -ENOMEM;
M
Mikulas Patocka 已提交
1831
		goto bad_tracked_chunk_cache;
1832 1833
	}

1834 1835 1836 1837
	ksnapd = create_singlethread_workqueue("ksnapd");
	if (!ksnapd) {
		DMERR("Failed to create ksnapd workqueue.");
		r = -ENOMEM;
1838
		goto bad_pending_pool;
1839 1840
	}

L
Linus Torvalds 已提交
1841 1842
	return 0;

1843
bad_pending_pool:
1844
	kmem_cache_destroy(tracked_chunk_cache);
M
Mikulas Patocka 已提交
1845
bad_tracked_chunk_cache:
L
Linus Torvalds 已提交
1846
	kmem_cache_destroy(pending_cache);
M
Mikulas Patocka 已提交
1847
bad_pending_cache:
L
Linus Torvalds 已提交
1848
	kmem_cache_destroy(exception_cache);
M
Mikulas Patocka 已提交
1849
bad_exception_cache:
L
Linus Torvalds 已提交
1850
	exit_origin_hash();
M
Mikulas Patocka 已提交
1851 1852 1853
bad_origin_hash:
	dm_unregister_target(&merge_target);
bad_register_merge_target:
L
Linus Torvalds 已提交
1854
	dm_unregister_target(&origin_target);
M
Mikulas Patocka 已提交
1855
bad_register_origin_target:
L
Linus Torvalds 已提交
1856
	dm_unregister_target(&snapshot_target);
1857 1858
bad_register_snapshot_target:
	dm_exception_store_exit();
M
Mikulas Patocka 已提交
1859

L
Linus Torvalds 已提交
1860 1861 1862 1863 1864
	return r;
}

static void __exit dm_snapshot_exit(void)
{
1865 1866
	destroy_workqueue(ksnapd);

1867 1868
	dm_unregister_target(&snapshot_target);
	dm_unregister_target(&origin_target);
M
Mikulas Patocka 已提交
1869
	dm_unregister_target(&merge_target);
L
Linus Torvalds 已提交
1870 1871 1872 1873

	exit_origin_hash();
	kmem_cache_destroy(pending_cache);
	kmem_cache_destroy(exception_cache);
1874
	kmem_cache_destroy(tracked_chunk_cache);
1875 1876

	dm_exception_store_exit();
L
Linus Torvalds 已提交
1877 1878 1879 1880 1881 1882 1883 1884 1885
}

/* Module hooks */
module_init(dm_snapshot_init);
module_exit(dm_snapshot_exit);

MODULE_DESCRIPTION(DM_NAME " snapshot target");
MODULE_AUTHOR("Joe Thornber");
MODULE_LICENSE("GPL");