Linux Audio

Check our new training course

Loading...
v3.1
 
   1/*
   2 * dm-snapshot.c
   3 *
   4 * Copyright (C) 2001-2002 Sistina Software (UK) Limited.
   5 *
   6 * This file is released under the GPL.
   7 */
   8
   9#include <linux/blkdev.h>
  10#include <linux/device-mapper.h>
  11#include <linux/delay.h>
  12#include <linux/fs.h>
  13#include <linux/init.h>
  14#include <linux/kdev_t.h>
  15#include <linux/list.h>
 
  16#include <linux/mempool.h>
  17#include <linux/module.h>
  18#include <linux/slab.h>
  19#include <linux/vmalloc.h>
  20#include <linux/log2.h>
  21#include <linux/dm-kcopyd.h>
  22
 
 
  23#include "dm-exception-store.h"
  24
  25#define DM_MSG_PREFIX "snapshots"
  26
  27static const char dm_snapshot_merge_target_name[] = "snapshot-merge";
  28
  29#define dm_target_is_snapshot_merge(ti) \
  30	((ti)->type->name == dm_snapshot_merge_target_name)
  31
  32/*
  33 * The size of the mempool used to track chunks in use.
  34 */
  35#define MIN_IOS 256
  36
  37#define DM_TRACKED_CHUNK_HASH_SIZE	16
  38#define DM_TRACKED_CHUNK_HASH(x)	((unsigned long)(x) & \
  39					 (DM_TRACKED_CHUNK_HASH_SIZE - 1))
  40
  41struct dm_exception_table {
  42	uint32_t hash_mask;
  43	unsigned hash_shift;
  44	struct list_head *table;
  45};
  46
  47struct dm_snapshot {
  48	struct rw_semaphore lock;
  49
  50	struct dm_dev *origin;
  51	struct dm_dev *cow;
  52
  53	struct dm_target *ti;
  54
  55	/* List of snapshots per Origin */
  56	struct list_head list;
  57
  58	/*
  59	 * You can't use a snapshot if this is 0 (e.g. if full).
  60	 * A snapshot-merge target never clears this.
  61	 */
  62	int valid;
  63
 
 
 
 
 
 
 
  64	/* Origin writes don't trigger exceptions until this is set */
  65	int active;
  66
  67	atomic_t pending_exceptions_count;
  68
  69	mempool_t *pending_pool;
 
 
 
 
 
 
 
 
 
 
 
 
 
 
  70
  71	struct dm_exception_table pending;
  72	struct dm_exception_table complete;
  73
  74	/*
  75	 * pe_lock protects all pending_exception operations and access
  76	 * as well as the snapshot_bios list.
  77	 */
  78	spinlock_t pe_lock;
  79
  80	/* Chunks with outstanding reads */
  81	spinlock_t tracked_chunk_lock;
  82	mempool_t *tracked_chunk_pool;
  83	struct hlist_head tracked_chunk_hash[DM_TRACKED_CHUNK_HASH_SIZE];
  84
  85	/* The on disk metadata handler */
  86	struct dm_exception_store *store;
  87
 
 
 
  88	struct dm_kcopyd_client *kcopyd_client;
  89
  90	/* Wait for events based on state_bits */
  91	unsigned long state_bits;
  92
  93	/* Range of chunks currently being merged. */
  94	chunk_t first_merging_chunk;
  95	int num_merging_chunks;
  96
  97	/*
  98	 * The merge operation failed if this flag is set.
  99	 * Failure modes are handled as follows:
 100	 * - I/O error reading the header
 101	 *   	=> don't load the target; abort.
 102	 * - Header does not have "valid" flag set
 103	 *   	=> use the origin; forget about the snapshot.
 104	 * - I/O error when reading exceptions
 105	 *   	=> don't load the target; abort.
 106	 *         (We can't use the intermediate origin state.)
 107	 * - I/O error while merging
 108	 *	=> stop merging; set merge_failed; process I/O normally.
 109	 */
 110	int merge_failed;
 
 
 
 111
 112	/*
 113	 * Incoming bios that overlap with chunks being merged must wait
 114	 * for them to be committed.
 115	 */
 116	struct bio_list bios_queued_during_merge;
 117};
 118
 119/*
 120 * state_bits:
 121 *   RUNNING_MERGE  - Merge operation is in progress.
 122 *   SHUTDOWN_MERGE - Set to signal that merge needs to be stopped;
 123 *                    cleared afterwards.
 124 */
 125#define RUNNING_MERGE          0
 126#define SHUTDOWN_MERGE         1
 127
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 128struct dm_dev *dm_snap_origin(struct dm_snapshot *s)
 129{
 130	return s->origin;
 131}
 132EXPORT_SYMBOL(dm_snap_origin);
 133
 134struct dm_dev *dm_snap_cow(struct dm_snapshot *s)
 135{
 136	return s->cow;
 137}
 138EXPORT_SYMBOL(dm_snap_cow);
 139
 140static sector_t chunk_to_sector(struct dm_exception_store *store,
 141				chunk_t chunk)
 142{
 143	return chunk << store->chunk_shift;
 144}
 145
 146static int bdev_equal(struct block_device *lhs, struct block_device *rhs)
 147{
 148	/*
 149	 * There is only ever one instance of a particular block
 150	 * device so we can compare pointers safely.
 151	 */
 152	return lhs == rhs;
 153}
 154
 155struct dm_snap_pending_exception {
 156	struct dm_exception e;
 157
 158	/*
 159	 * Origin buffers waiting for this to complete are held
 160	 * in a bio list
 161	 */
 162	struct bio_list origin_bios;
 163	struct bio_list snapshot_bios;
 164
 165	/* Pointer back to snapshot context */
 166	struct dm_snapshot *snap;
 167
 168	/*
 169	 * 1 indicates the exception has already been sent to
 170	 * kcopyd.
 171	 */
 172	int started;
 173
 
 
 
 
 
 
 
 
 174	/*
 175	 * For writing a complete chunk, bypassing the copy.
 176	 */
 177	struct bio *full_bio;
 178	bio_end_io_t *full_bio_end_io;
 179	void *full_bio_private;
 180};
 181
 182/*
 183 * Hash table mapping origin volumes to lists of snapshots and
 184 * a lock to protect it
 185 */
 186static struct kmem_cache *exception_cache;
 187static struct kmem_cache *pending_cache;
 188
 189struct dm_snap_tracked_chunk {
 190	struct hlist_node node;
 191	chunk_t chunk;
 192};
 193
 194static struct kmem_cache *tracked_chunk_cache;
 
 
 
 
 
 195
 196static struct dm_snap_tracked_chunk *track_chunk(struct dm_snapshot *s,
 197						 chunk_t chunk)
 198{
 199	struct dm_snap_tracked_chunk *c = mempool_alloc(s->tracked_chunk_pool,
 200							GFP_NOIO);
 201	unsigned long flags;
 
 
 
 
 
 202
 203	c->chunk = chunk;
 204
 205	spin_lock_irqsave(&s->tracked_chunk_lock, flags);
 206	hlist_add_head(&c->node,
 207		       &s->tracked_chunk_hash[DM_TRACKED_CHUNK_HASH(chunk)]);
 208	spin_unlock_irqrestore(&s->tracked_chunk_lock, flags);
 209
 210	return c;
 211}
 212
 213static void stop_tracking_chunk(struct dm_snapshot *s,
 214				struct dm_snap_tracked_chunk *c)
 215{
 
 216	unsigned long flags;
 217
 218	spin_lock_irqsave(&s->tracked_chunk_lock, flags);
 219	hlist_del(&c->node);
 220	spin_unlock_irqrestore(&s->tracked_chunk_lock, flags);
 221
 222	mempool_free(c, s->tracked_chunk_pool);
 223}
 224
 225static int __chunk_is_tracked(struct dm_snapshot *s, chunk_t chunk)
 226{
 227	struct dm_snap_tracked_chunk *c;
 228	struct hlist_node *hn;
 229	int found = 0;
 230
 231	spin_lock_irq(&s->tracked_chunk_lock);
 232
 233	hlist_for_each_entry(c, hn,
 234	    &s->tracked_chunk_hash[DM_TRACKED_CHUNK_HASH(chunk)], node) {
 235		if (c->chunk == chunk) {
 236			found = 1;
 237			break;
 238		}
 239	}
 240
 241	spin_unlock_irq(&s->tracked_chunk_lock);
 242
 243	return found;
 244}
 245
 246/*
 247 * This conflicting I/O is extremely improbable in the caller,
 248 * so msleep(1) is sufficient and there is no need for a wait queue.
 249 */
 250static void __check_for_conflicting_io(struct dm_snapshot *s, chunk_t chunk)
 251{
 252	while (__chunk_is_tracked(s, chunk))
 253		msleep(1);
 254}
 255
 256/*
 257 * One of these per registered origin, held in the snapshot_origins hash
 258 */
 259struct origin {
 260	/* The origin device */
 261	struct block_device *bdev;
 262
 263	struct list_head hash_list;
 264
 265	/* List of snapshots for this origin */
 266	struct list_head snapshots;
 267};
 268
 269/*
 
 
 
 
 
 
 
 
 
 
 270 * Size of the hash table for origin volumes. If we make this
 271 * the size of the minors list then it should be nearly perfect
 272 */
 273#define ORIGIN_HASH_SIZE 256
 274#define ORIGIN_MASK      0xFF
 275static struct list_head *_origins;
 
 276static struct rw_semaphore _origins_lock;
 277
 278static DECLARE_WAIT_QUEUE_HEAD(_pending_exceptions_done);
 279static DEFINE_SPINLOCK(_pending_exceptions_done_spinlock);
 280static uint64_t _pending_exceptions_done_count;
 281
 282static int init_origin_hash(void)
 283{
 284	int i;
 285
 286	_origins = kmalloc(ORIGIN_HASH_SIZE * sizeof(struct list_head),
 287			   GFP_KERNEL);
 288	if (!_origins) {
 289		DMERR("unable to allocate memory");
 290		return -ENOMEM;
 291	}
 292
 293	for (i = 0; i < ORIGIN_HASH_SIZE; i++)
 294		INIT_LIST_HEAD(_origins + i);
 
 
 
 
 
 
 
 
 
 
 
 
 295	init_rwsem(&_origins_lock);
 296
 297	return 0;
 298}
 299
 300static void exit_origin_hash(void)
 301{
 302	kfree(_origins);
 
 303}
 304
 305static unsigned origin_hash(struct block_device *bdev)
 306{
 307	return bdev->bd_dev & ORIGIN_MASK;
 308}
 309
 310static struct origin *__lookup_origin(struct block_device *origin)
 311{
 312	struct list_head *ol;
 313	struct origin *o;
 314
 315	ol = &_origins[origin_hash(origin)];
 316	list_for_each_entry (o, ol, hash_list)
 317		if (bdev_equal(o->bdev, origin))
 318			return o;
 319
 320	return NULL;
 321}
 322
 323static void __insert_origin(struct origin *o)
 324{
 325	struct list_head *sl = &_origins[origin_hash(o->bdev)];
 
 326	list_add_tail(&o->hash_list, sl);
 327}
 328
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 329/*
 330 * _origins_lock must be held when calling this function.
 331 * Returns number of snapshots registered using the supplied cow device, plus:
 332 * snap_src - a snapshot suitable for use as a source of exception handover
 333 * snap_dest - a snapshot capable of receiving exception handover.
 334 * snap_merge - an existing snapshot-merge target linked to the same origin.
 335 *   There can be at most one snapshot-merge target. The parameter is optional.
 336 *
 337 * Possible return values and states of snap_src and snap_dest.
 338 *   0: NULL, NULL  - first new snapshot
 339 *   1: snap_src, NULL - normal snapshot
 340 *   2: snap_src, snap_dest  - waiting for handover
 341 *   2: snap_src, NULL - handed over, waiting for old to be deleted
 342 *   1: NULL, snap_dest - source got destroyed without handover
 343 */
 344static int __find_snapshots_sharing_cow(struct dm_snapshot *snap,
 345					struct dm_snapshot **snap_src,
 346					struct dm_snapshot **snap_dest,
 347					struct dm_snapshot **snap_merge)
 348{
 349	struct dm_snapshot *s;
 350	struct origin *o;
 351	int count = 0;
 352	int active;
 353
 354	o = __lookup_origin(snap->origin->bdev);
 355	if (!o)
 356		goto out;
 357
 358	list_for_each_entry(s, &o->snapshots, list) {
 359		if (dm_target_is_snapshot_merge(s->ti) && snap_merge)
 360			*snap_merge = s;
 361		if (!bdev_equal(s->cow->bdev, snap->cow->bdev))
 362			continue;
 363
 364		down_read(&s->lock);
 365		active = s->active;
 366		up_read(&s->lock);
 367
 368		if (active) {
 369			if (snap_src)
 370				*snap_src = s;
 371		} else if (snap_dest)
 372			*snap_dest = s;
 373
 374		count++;
 375	}
 376
 377out:
 378	return count;
 379}
 380
 381/*
 382 * On success, returns 1 if this snapshot is a handover destination,
 383 * otherwise returns 0.
 384 */
 385static int __validate_exception_handover(struct dm_snapshot *snap)
 386{
 387	struct dm_snapshot *snap_src = NULL, *snap_dest = NULL;
 388	struct dm_snapshot *snap_merge = NULL;
 389
 390	/* Does snapshot need exceptions handed over to it? */
 391	if ((__find_snapshots_sharing_cow(snap, &snap_src, &snap_dest,
 392					  &snap_merge) == 2) ||
 393	    snap_dest) {
 394		snap->ti->error = "Snapshot cow pairing for exception "
 395				  "table handover failed";
 396		return -EINVAL;
 397	}
 398
 399	/*
 400	 * If no snap_src was found, snap cannot become a handover
 401	 * destination.
 402	 */
 403	if (!snap_src)
 404		return 0;
 405
 406	/*
 407	 * Non-snapshot-merge handover?
 408	 */
 409	if (!dm_target_is_snapshot_merge(snap->ti))
 410		return 1;
 411
 412	/*
 413	 * Do not allow more than one merging snapshot.
 414	 */
 415	if (snap_merge) {
 416		snap->ti->error = "A snapshot is already merging.";
 417		return -EINVAL;
 418	}
 419
 420	if (!snap_src->store->type->prepare_merge ||
 421	    !snap_src->store->type->commit_merge) {
 422		snap->ti->error = "Snapshot exception store does not "
 423				  "support snapshot-merge.";
 424		return -EINVAL;
 425	}
 426
 427	return 1;
 428}
 429
 430static void __insert_snapshot(struct origin *o, struct dm_snapshot *s)
 431{
 432	struct dm_snapshot *l;
 433
 434	/* Sort the list according to chunk size, largest-first smallest-last */
 435	list_for_each_entry(l, &o->snapshots, list)
 436		if (l->store->chunk_size < s->store->chunk_size)
 437			break;
 438	list_add_tail(&s->list, &l->list);
 439}
 440
 441/*
 442 * Make a note of the snapshot and its origin so we can look it
 443 * up when the origin has a write on it.
 444 *
 445 * Also validate snapshot exception store handovers.
 446 * On success, returns 1 if this registration is a handover destination,
 447 * otherwise returns 0.
 448 */
 449static int register_snapshot(struct dm_snapshot *snap)
 450{
 451	struct origin *o, *new_o = NULL;
 452	struct block_device *bdev = snap->origin->bdev;
 453	int r = 0;
 454
 455	new_o = kmalloc(sizeof(*new_o), GFP_KERNEL);
 456	if (!new_o)
 457		return -ENOMEM;
 458
 459	down_write(&_origins_lock);
 460
 461	r = __validate_exception_handover(snap);
 462	if (r < 0) {
 463		kfree(new_o);
 464		goto out;
 465	}
 466
 467	o = __lookup_origin(bdev);
 468	if (o)
 469		kfree(new_o);
 470	else {
 471		/* New origin */
 472		o = new_o;
 473
 474		/* Initialise the struct */
 475		INIT_LIST_HEAD(&o->snapshots);
 476		o->bdev = bdev;
 477
 478		__insert_origin(o);
 479	}
 480
 481	__insert_snapshot(o, snap);
 482
 483out:
 484	up_write(&_origins_lock);
 485
 486	return r;
 487}
 488
 489/*
 490 * Move snapshot to correct place in list according to chunk size.
 491 */
 492static void reregister_snapshot(struct dm_snapshot *s)
 493{
 494	struct block_device *bdev = s->origin->bdev;
 495
 496	down_write(&_origins_lock);
 497
 498	list_del(&s->list);
 499	__insert_snapshot(__lookup_origin(bdev), s);
 500
 501	up_write(&_origins_lock);
 502}
 503
 504static void unregister_snapshot(struct dm_snapshot *s)
 505{
 506	struct origin *o;
 507
 508	down_write(&_origins_lock);
 509	o = __lookup_origin(s->origin->bdev);
 510
 511	list_del(&s->list);
 512	if (o && list_empty(&o->snapshots)) {
 513		list_del(&o->hash_list);
 514		kfree(o);
 515	}
 516
 517	up_write(&_origins_lock);
 518}
 519
 520/*
 521 * Implementation of the exception hash tables.
 522 * The lowest hash_shift bits of the chunk number are ignored, allowing
 523 * some consecutive chunks to be grouped together.
 524 */
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 525static int dm_exception_table_init(struct dm_exception_table *et,
 526				   uint32_t size, unsigned hash_shift)
 527{
 528	unsigned int i;
 529
 530	et->hash_shift = hash_shift;
 531	et->hash_mask = size - 1;
 532	et->table = dm_vcalloc(size, sizeof(struct list_head));
 
 533	if (!et->table)
 534		return -ENOMEM;
 535
 536	for (i = 0; i < size; i++)
 537		INIT_LIST_HEAD(et->table + i);
 538
 539	return 0;
 540}
 541
 542static void dm_exception_table_exit(struct dm_exception_table *et,
 543				    struct kmem_cache *mem)
 544{
 545	struct list_head *slot;
 546	struct dm_exception *ex, *next;
 
 547	int i, size;
 548
 549	size = et->hash_mask + 1;
 550	for (i = 0; i < size; i++) {
 551		slot = et->table + i;
 552
 553		list_for_each_entry_safe (ex, next, slot, hash_list)
 554			kmem_cache_free(mem, ex);
 
 
 555	}
 556
 557	vfree(et->table);
 558}
 559
 560static uint32_t exception_hash(struct dm_exception_table *et, chunk_t chunk)
 561{
 562	return (chunk >> et->hash_shift) & et->hash_mask;
 563}
 564
 565static void dm_remove_exception(struct dm_exception *e)
 566{
 567	list_del(&e->hash_list);
 568}
 569
 570/*
 571 * Return the exception data for a sector, or NULL if not
 572 * remapped.
 573 */
 574static struct dm_exception *dm_lookup_exception(struct dm_exception_table *et,
 575						chunk_t chunk)
 576{
 577	struct list_head *slot;
 
 578	struct dm_exception *e;
 579
 580	slot = &et->table[exception_hash(et, chunk)];
 581	list_for_each_entry (e, slot, hash_list)
 582		if (chunk >= e->old_chunk &&
 583		    chunk <= e->old_chunk + dm_consecutive_chunk_count(e))
 584			return e;
 585
 586	return NULL;
 587}
 588
 589static struct dm_exception *alloc_completed_exception(void)
 590{
 591	struct dm_exception *e;
 592
 593	e = kmem_cache_alloc(exception_cache, GFP_NOIO);
 594	if (!e)
 595		e = kmem_cache_alloc(exception_cache, GFP_ATOMIC);
 596
 597	return e;
 598}
 599
 600static void free_completed_exception(struct dm_exception *e)
 601{
 602	kmem_cache_free(exception_cache, e);
 603}
 604
 605static struct dm_snap_pending_exception *alloc_pending_exception(struct dm_snapshot *s)
 606{
 607	struct dm_snap_pending_exception *pe = mempool_alloc(s->pending_pool,
 608							     GFP_NOIO);
 609
 610	atomic_inc(&s->pending_exceptions_count);
 611	pe->snap = s;
 612
 613	return pe;
 614}
 615
 616static void free_pending_exception(struct dm_snap_pending_exception *pe)
 617{
 618	struct dm_snapshot *s = pe->snap;
 619
 620	mempool_free(pe, s->pending_pool);
 621	smp_mb__before_atomic_dec();
 622	atomic_dec(&s->pending_exceptions_count);
 623}
 624
 625static void dm_insert_exception(struct dm_exception_table *eh,
 626				struct dm_exception *new_e)
 627{
 628	struct list_head *l;
 
 629	struct dm_exception *e = NULL;
 630
 631	l = &eh->table[exception_hash(eh, new_e->old_chunk)];
 632
 633	/* Add immediately if this table doesn't support consecutive chunks */
 634	if (!eh->hash_shift)
 635		goto out;
 636
 637	/* List is ordered by old_chunk */
 638	list_for_each_entry_reverse(e, l, hash_list) {
 639		/* Insert after an existing chunk? */
 640		if (new_e->old_chunk == (e->old_chunk +
 641					 dm_consecutive_chunk_count(e) + 1) &&
 642		    new_e->new_chunk == (dm_chunk_number(e->new_chunk) +
 643					 dm_consecutive_chunk_count(e) + 1)) {
 644			dm_consecutive_chunk_count_inc(e);
 645			free_completed_exception(new_e);
 646			return;
 647		}
 648
 649		/* Insert before an existing chunk? */
 650		if (new_e->old_chunk == (e->old_chunk - 1) &&
 651		    new_e->new_chunk == (dm_chunk_number(e->new_chunk) - 1)) {
 652			dm_consecutive_chunk_count_inc(e);
 653			e->old_chunk--;
 654			e->new_chunk--;
 655			free_completed_exception(new_e);
 656			return;
 657		}
 658
 659		if (new_e->old_chunk > e->old_chunk)
 660			break;
 661	}
 662
 663out:
 664	list_add(&new_e->hash_list, e ? &e->hash_list : l);
 
 
 
 
 
 
 
 
 
 
 
 
 665}
 666
 667/*
 668 * Callback used by the exception stores to load exceptions when
 669 * initialising.
 670 */
 671static int dm_add_exception(void *context, chunk_t old, chunk_t new)
 672{
 
 673	struct dm_snapshot *s = context;
 674	struct dm_exception *e;
 675
 676	e = alloc_completed_exception();
 677	if (!e)
 678		return -ENOMEM;
 679
 680	e->old_chunk = old;
 681
 682	/* Consecutive_count is implicitly initialised to zero */
 683	e->new_chunk = new;
 684
 
 
 
 
 
 
 
 
 
 685	dm_insert_exception(&s->complete, e);
 
 686
 687	return 0;
 688}
 689
 690/*
 691 * Return a minimum chunk size of all snapshots that have the specified origin.
 692 * Return zero if the origin has no snapshots.
 693 */
 694static sector_t __minimum_chunk_size(struct origin *o)
 695{
 696	struct dm_snapshot *snap;
 697	unsigned chunk_size = 0;
 698
 699	if (o)
 700		list_for_each_entry(snap, &o->snapshots, list)
 701			chunk_size = min_not_zero(chunk_size,
 702						  snap->store->chunk_size);
 703
 704	return chunk_size;
 705}
 706
 707/*
 708 * Hard coded magic.
 709 */
 710static int calc_max_buckets(void)
 711{
 712	/* use a fixed size of 2MB */
 713	unsigned long mem = 2 * 1024 * 1024;
 714	mem /= sizeof(struct list_head);
 
 715
 716	return mem;
 717}
 718
 719/*
 720 * Allocate room for a suitable hash table.
 721 */
 722static int init_hash_tables(struct dm_snapshot *s)
 723{
 724	sector_t hash_size, cow_dev_size, origin_dev_size, max_buckets;
 725
 726	/*
 727	 * Calculate based on the size of the original volume or
 728	 * the COW volume...
 729	 */
 730	cow_dev_size = get_dev_size(s->cow->bdev);
 731	origin_dev_size = get_dev_size(s->origin->bdev);
 732	max_buckets = calc_max_buckets();
 733
 734	hash_size = min(origin_dev_size, cow_dev_size) >> s->store->chunk_shift;
 735	hash_size = min(hash_size, max_buckets);
 736
 737	if (hash_size < 64)
 738		hash_size = 64;
 739	hash_size = rounddown_pow_of_two(hash_size);
 740	if (dm_exception_table_init(&s->complete, hash_size,
 741				    DM_CHUNK_CONSECUTIVE_BITS))
 742		return -ENOMEM;
 743
 744	/*
 745	 * Allocate hash table for in-flight exceptions
 746	 * Make this smaller than the real hash table
 747	 */
 748	hash_size >>= 3;
 749	if (hash_size < 64)
 750		hash_size = 64;
 751
 752	if (dm_exception_table_init(&s->pending, hash_size, 0)) {
 753		dm_exception_table_exit(&s->complete, exception_cache);
 754		return -ENOMEM;
 755	}
 756
 757	return 0;
 758}
 759
 760static void merge_shutdown(struct dm_snapshot *s)
 761{
 762	clear_bit_unlock(RUNNING_MERGE, &s->state_bits);
 763	smp_mb__after_clear_bit();
 764	wake_up_bit(&s->state_bits, RUNNING_MERGE);
 765}
 766
 767static struct bio *__release_queued_bios_after_merge(struct dm_snapshot *s)
 768{
 769	s->first_merging_chunk = 0;
 770	s->num_merging_chunks = 0;
 771
 772	return bio_list_get(&s->bios_queued_during_merge);
 773}
 774
 775/*
 776 * Remove one chunk from the index of completed exceptions.
 777 */
 778static int __remove_single_exception_chunk(struct dm_snapshot *s,
 779					   chunk_t old_chunk)
 780{
 781	struct dm_exception *e;
 782
 783	e = dm_lookup_exception(&s->complete, old_chunk);
 784	if (!e) {
 785		DMERR("Corruption detected: exception for block %llu is "
 786		      "on disk but not in memory",
 787		      (unsigned long long)old_chunk);
 788		return -EINVAL;
 789	}
 790
 791	/*
 792	 * If this is the only chunk using this exception, remove exception.
 793	 */
 794	if (!dm_consecutive_chunk_count(e)) {
 795		dm_remove_exception(e);
 796		free_completed_exception(e);
 797		return 0;
 798	}
 799
 800	/*
 801	 * The chunk may be either at the beginning or the end of a
 802	 * group of consecutive chunks - never in the middle.  We are
 803	 * removing chunks in the opposite order to that in which they
 804	 * were added, so this should always be true.
 805	 * Decrement the consecutive chunk counter and adjust the
 806	 * starting point if necessary.
 807	 */
 808	if (old_chunk == e->old_chunk) {
 809		e->old_chunk++;
 810		e->new_chunk++;
 811	} else if (old_chunk != e->old_chunk +
 812		   dm_consecutive_chunk_count(e)) {
 813		DMERR("Attempt to merge block %llu from the "
 814		      "middle of a chunk range [%llu - %llu]",
 815		      (unsigned long long)old_chunk,
 816		      (unsigned long long)e->old_chunk,
 817		      (unsigned long long)
 818		      e->old_chunk + dm_consecutive_chunk_count(e));
 819		return -EINVAL;
 820	}
 821
 822	dm_consecutive_chunk_count_dec(e);
 823
 824	return 0;
 825}
 826
 827static void flush_bios(struct bio *bio);
 828
 829static int remove_single_exception_chunk(struct dm_snapshot *s)
 830{
 831	struct bio *b = NULL;
 832	int r;
 833	chunk_t old_chunk = s->first_merging_chunk + s->num_merging_chunks - 1;
 834
 835	down_write(&s->lock);
 836
 837	/*
 838	 * Process chunks (and associated exceptions) in reverse order
 839	 * so that dm_consecutive_chunk_count_dec() accounting works.
 840	 */
 841	do {
 842		r = __remove_single_exception_chunk(s, old_chunk);
 843		if (r)
 844			goto out;
 845	} while (old_chunk-- > s->first_merging_chunk);
 846
 847	b = __release_queued_bios_after_merge(s);
 848
 849out:
 850	up_write(&s->lock);
 851	if (b)
 852		flush_bios(b);
 853
 854	return r;
 855}
 856
 857static int origin_write_extent(struct dm_snapshot *merging_snap,
 858			       sector_t sector, unsigned chunk_size);
 859
 860static void merge_callback(int read_err, unsigned long write_err,
 861			   void *context);
 862
 863static uint64_t read_pending_exceptions_done_count(void)
 864{
 865	uint64_t pending_exceptions_done;
 866
 867	spin_lock(&_pending_exceptions_done_spinlock);
 868	pending_exceptions_done = _pending_exceptions_done_count;
 869	spin_unlock(&_pending_exceptions_done_spinlock);
 870
 871	return pending_exceptions_done;
 872}
 873
 874static void increment_pending_exceptions_done_count(void)
 875{
 876	spin_lock(&_pending_exceptions_done_spinlock);
 877	_pending_exceptions_done_count++;
 878	spin_unlock(&_pending_exceptions_done_spinlock);
 879
 880	wake_up_all(&_pending_exceptions_done);
 881}
 882
 883static void snapshot_merge_next_chunks(struct dm_snapshot *s)
 884{
 885	int i, linear_chunks;
 886	chunk_t old_chunk, new_chunk;
 887	struct dm_io_region src, dest;
 888	sector_t io_size;
 889	uint64_t previous_count;
 890
 891	BUG_ON(!test_bit(RUNNING_MERGE, &s->state_bits));
 892	if (unlikely(test_bit(SHUTDOWN_MERGE, &s->state_bits)))
 893		goto shut;
 894
 895	/*
 896	 * valid flag never changes during merge, so no lock required.
 897	 */
 898	if (!s->valid) {
 899		DMERR("Snapshot is invalid: can't merge");
 900		goto shut;
 901	}
 902
 903	linear_chunks = s->store->type->prepare_merge(s->store, &old_chunk,
 904						      &new_chunk);
 905	if (linear_chunks <= 0) {
 906		if (linear_chunks < 0) {
 907			DMERR("Read error in exception store: "
 908			      "shutting down merge");
 909			down_write(&s->lock);
 910			s->merge_failed = 1;
 911			up_write(&s->lock);
 912		}
 913		goto shut;
 914	}
 915
 916	/* Adjust old_chunk and new_chunk to reflect start of linear region */
 917	old_chunk = old_chunk + 1 - linear_chunks;
 918	new_chunk = new_chunk + 1 - linear_chunks;
 919
 920	/*
 921	 * Use one (potentially large) I/O to copy all 'linear_chunks'
 922	 * from the exception store to the origin
 923	 */
 924	io_size = linear_chunks * s->store->chunk_size;
 925
 926	dest.bdev = s->origin->bdev;
 927	dest.sector = chunk_to_sector(s->store, old_chunk);
 928	dest.count = min(io_size, get_dev_size(dest.bdev) - dest.sector);
 929
 930	src.bdev = s->cow->bdev;
 931	src.sector = chunk_to_sector(s->store, new_chunk);
 932	src.count = dest.count;
 933
 934	/*
 935	 * Reallocate any exceptions needed in other snapshots then
 936	 * wait for the pending exceptions to complete.
 937	 * Each time any pending exception (globally on the system)
 938	 * completes we are woken and repeat the process to find out
 939	 * if we can proceed.  While this may not seem a particularly
 940	 * efficient algorithm, it is not expected to have any
 941	 * significant impact on performance.
 942	 */
 943	previous_count = read_pending_exceptions_done_count();
 944	while (origin_write_extent(s, dest.sector, io_size)) {
 945		wait_event(_pending_exceptions_done,
 946			   (read_pending_exceptions_done_count() !=
 947			    previous_count));
 948		/* Retry after the wait, until all exceptions are done. */
 949		previous_count = read_pending_exceptions_done_count();
 950	}
 951
 952	down_write(&s->lock);
 953	s->first_merging_chunk = old_chunk;
 954	s->num_merging_chunks = linear_chunks;
 955	up_write(&s->lock);
 956
 957	/* Wait until writes to all 'linear_chunks' drain */
 958	for (i = 0; i < linear_chunks; i++)
 959		__check_for_conflicting_io(s, old_chunk + i);
 960
 961	dm_kcopyd_copy(s->kcopyd_client, &src, 1, &dest, 0, merge_callback, s);
 962	return;
 963
 964shut:
 965	merge_shutdown(s);
 966}
 967
 968static void error_bios(struct bio *bio);
 969
 970static void merge_callback(int read_err, unsigned long write_err, void *context)
 971{
 972	struct dm_snapshot *s = context;
 973	struct bio *b = NULL;
 974
 975	if (read_err || write_err) {
 976		if (read_err)
 977			DMERR("Read error: shutting down merge.");
 978		else
 979			DMERR("Write error: shutting down merge.");
 980		goto shut;
 981	}
 982
 
 
 
 
 
 983	if (s->store->type->commit_merge(s->store,
 984					 s->num_merging_chunks) < 0) {
 985		DMERR("Write error in exception store: shutting down merge");
 986		goto shut;
 987	}
 988
 989	if (remove_single_exception_chunk(s) < 0)
 990		goto shut;
 991
 992	snapshot_merge_next_chunks(s);
 993
 994	return;
 995
 996shut:
 997	down_write(&s->lock);
 998	s->merge_failed = 1;
 999	b = __release_queued_bios_after_merge(s);
1000	up_write(&s->lock);
1001	error_bios(b);
1002
1003	merge_shutdown(s);
1004}
1005
1006static void start_merge(struct dm_snapshot *s)
1007{
1008	if (!test_and_set_bit(RUNNING_MERGE, &s->state_bits))
1009		snapshot_merge_next_chunks(s);
1010}
1011
1012static int wait_schedule(void *ptr)
1013{
1014	schedule();
1015
1016	return 0;
1017}
1018
1019/*
1020 * Stop the merging process and wait until it finishes.
1021 */
1022static void stop_merge(struct dm_snapshot *s)
1023{
1024	set_bit(SHUTDOWN_MERGE, &s->state_bits);
1025	wait_on_bit(&s->state_bits, RUNNING_MERGE, wait_schedule,
1026		    TASK_UNINTERRUPTIBLE);
1027	clear_bit(SHUTDOWN_MERGE, &s->state_bits);
1028}
1029
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1030/*
1031 * Construct a snapshot mapping: <origin_dev> <COW-dev> <p/n> <chunk-size>
 
1032 */
1033static int snapshot_ctr(struct dm_target *ti, unsigned int argc, char **argv)
1034{
1035	struct dm_snapshot *s;
 
1036	int i;
1037	int r = -EINVAL;
1038	char *origin_path, *cow_path;
1039	unsigned args_used, num_flush_requests = 1;
1040	fmode_t origin_mode = FMODE_READ;
1041
1042	if (argc != 4) {
1043		ti->error = "requires exactly 4 arguments";
1044		r = -EINVAL;
1045		goto bad;
1046	}
1047
1048	if (dm_target_is_snapshot_merge(ti)) {
1049		num_flush_requests = 2;
1050		origin_mode = FMODE_WRITE;
1051	}
1052
1053	s = kmalloc(sizeof(*s), GFP_KERNEL);
1054	if (!s) {
1055		ti->error = "Cannot allocate private snapshot structure";
1056		r = -ENOMEM;
1057		goto bad;
1058	}
1059
 
 
 
 
 
 
 
1060	origin_path = argv[0];
1061	argv++;
1062	argc--;
1063
1064	r = dm_get_device(ti, origin_path, origin_mode, &s->origin);
1065	if (r) {
1066		ti->error = "Cannot get origin device";
1067		goto bad_origin;
1068	}
1069
1070	cow_path = argv[0];
1071	argv++;
1072	argc--;
1073
1074	r = dm_get_device(ti, cow_path, dm_table_get_mode(ti->table), &s->cow);
1075	if (r) {
1076		ti->error = "Cannot get COW device";
1077		goto bad_cow;
1078	}
 
 
 
 
 
1079
1080	r = dm_exception_store_create(ti, argc, argv, s, &args_used, &s->store);
1081	if (r) {
1082		ti->error = "Couldn't create exception store";
1083		r = -EINVAL;
1084		goto bad_store;
1085	}
1086
1087	argv += args_used;
1088	argc -= args_used;
1089
1090	s->ti = ti;
1091	s->valid = 1;
 
1092	s->active = 0;
1093	atomic_set(&s->pending_exceptions_count, 0);
 
 
 
 
1094	init_rwsem(&s->lock);
1095	INIT_LIST_HEAD(&s->list);
1096	spin_lock_init(&s->pe_lock);
1097	s->state_bits = 0;
1098	s->merge_failed = 0;
1099	s->first_merging_chunk = 0;
1100	s->num_merging_chunks = 0;
1101	bio_list_init(&s->bios_queued_during_merge);
1102
1103	/* Allocate hash table for COW data */
1104	if (init_hash_tables(s)) {
1105		ti->error = "Unable to allocate hash table space";
1106		r = -ENOMEM;
1107		goto bad_hash_tables;
1108	}
1109
1110	s->kcopyd_client = dm_kcopyd_client_create();
 
 
1111	if (IS_ERR(s->kcopyd_client)) {
1112		r = PTR_ERR(s->kcopyd_client);
1113		ti->error = "Could not create kcopyd client";
1114		goto bad_kcopyd;
1115	}
1116
1117	s->pending_pool = mempool_create_slab_pool(MIN_IOS, pending_cache);
1118	if (!s->pending_pool) {
1119		ti->error = "Could not allocate mempool for pending exceptions";
1120		goto bad_pending_pool;
1121	}
1122
1123	s->tracked_chunk_pool = mempool_create_slab_pool(MIN_IOS,
1124							 tracked_chunk_cache);
1125	if (!s->tracked_chunk_pool) {
1126		ti->error = "Could not allocate tracked_chunk mempool for "
1127			    "tracking reads";
1128		goto bad_tracked_chunk_pool;
1129	}
1130
1131	for (i = 0; i < DM_TRACKED_CHUNK_HASH_SIZE; i++)
1132		INIT_HLIST_HEAD(&s->tracked_chunk_hash[i]);
1133
1134	spin_lock_init(&s->tracked_chunk_lock);
1135
1136	ti->private = s;
1137	ti->num_flush_requests = num_flush_requests;
 
 
 
1138
1139	/* Add snapshot to the list of snapshots for this origin */
1140	/* Exceptions aren't triggered till snapshot_resume() is called */
1141	r = register_snapshot(s);
1142	if (r == -ENOMEM) {
1143		ti->error = "Snapshot origin struct allocation failed";
1144		goto bad_load_and_register;
1145	} else if (r < 0) {
1146		/* invalid handover, register_snapshot has set ti->error */
1147		goto bad_load_and_register;
1148	}
1149
1150	/*
1151	 * Metadata must only be loaded into one table at once, so skip this
1152	 * if metadata will be handed over during resume.
1153	 * Chunk size will be set during the handover - set it to zero to
1154	 * ensure it's ignored.
1155	 */
1156	if (r > 0) {
1157		s->store->chunk_size = 0;
1158		return 0;
1159	}
1160
1161	r = s->store->type->read_metadata(s->store, dm_add_exception,
1162					  (void *)s);
1163	if (r < 0) {
1164		ti->error = "Failed to read snapshot metadata";
1165		goto bad_read_metadata;
1166	} else if (r > 0) {
1167		s->valid = 0;
1168		DMWARN("Snapshot is marked invalid.");
1169	}
1170
1171	if (!s->store->chunk_size) {
1172		ti->error = "Chunk size not set";
 
1173		goto bad_read_metadata;
1174	}
1175	ti->split_io = s->store->chunk_size;
 
 
 
1176
1177	return 0;
1178
1179bad_read_metadata:
1180	unregister_snapshot(s);
1181
1182bad_load_and_register:
1183	mempool_destroy(s->tracked_chunk_pool);
1184
1185bad_tracked_chunk_pool:
1186	mempool_destroy(s->pending_pool);
1187
1188bad_pending_pool:
1189	dm_kcopyd_client_destroy(s->kcopyd_client);
1190
1191bad_kcopyd:
1192	dm_exception_table_exit(&s->pending, pending_cache);
1193	dm_exception_table_exit(&s->complete, exception_cache);
1194
1195bad_hash_tables:
1196	dm_exception_store_destroy(s->store);
1197
1198bad_store:
1199	dm_put_device(ti, s->cow);
1200
1201bad_cow:
1202	dm_put_device(ti, s->origin);
1203
1204bad_origin:
 
1205	kfree(s);
1206
1207bad:
1208	return r;
1209}
1210
1211static void __free_exceptions(struct dm_snapshot *s)
1212{
1213	dm_kcopyd_client_destroy(s->kcopyd_client);
1214	s->kcopyd_client = NULL;
1215
1216	dm_exception_table_exit(&s->pending, pending_cache);
1217	dm_exception_table_exit(&s->complete, exception_cache);
1218}
1219
1220static void __handover_exceptions(struct dm_snapshot *snap_src,
1221				  struct dm_snapshot *snap_dest)
1222{
1223	union {
1224		struct dm_exception_table table_swap;
1225		struct dm_exception_store *store_swap;
1226	} u;
1227
1228	/*
1229	 * Swap all snapshot context information between the two instances.
1230	 */
1231	u.table_swap = snap_dest->complete;
1232	snap_dest->complete = snap_src->complete;
1233	snap_src->complete = u.table_swap;
1234
1235	u.store_swap = snap_dest->store;
1236	snap_dest->store = snap_src->store;
 
1237	snap_src->store = u.store_swap;
1238
1239	snap_dest->store->snap = snap_dest;
1240	snap_src->store->snap = snap_src;
1241
1242	snap_dest->ti->split_io = snap_dest->store->chunk_size;
1243	snap_dest->valid = snap_src->valid;
 
1244
1245	/*
1246	 * Set source invalid to ensure it receives no further I/O.
1247	 */
1248	snap_src->valid = 0;
1249}
1250
1251static void snapshot_dtr(struct dm_target *ti)
1252{
1253#ifdef CONFIG_DM_DEBUG
1254	int i;
1255#endif
1256	struct dm_snapshot *s = ti->private;
1257	struct dm_snapshot *snap_src = NULL, *snap_dest = NULL;
1258
1259	down_read(&_origins_lock);
1260	/* Check whether exception handover must be cancelled */
1261	(void) __find_snapshots_sharing_cow(s, &snap_src, &snap_dest, NULL);
1262	if (snap_src && snap_dest && (s == snap_src)) {
1263		down_write(&snap_dest->lock);
1264		snap_dest->valid = 0;
1265		up_write(&snap_dest->lock);
1266		DMERR("Cancelling snapshot handover.");
1267	}
1268	up_read(&_origins_lock);
1269
1270	if (dm_target_is_snapshot_merge(ti))
1271		stop_merge(s);
1272
1273	/* Prevent further origin writes from using this snapshot. */
1274	/* After this returns there can be no new kcopyd jobs. */
1275	unregister_snapshot(s);
1276
1277	while (atomic_read(&s->pending_exceptions_count))
1278		msleep(1);
1279	/*
1280	 * Ensure instructions in mempool_destroy aren't reordered
1281	 * before atomic_read.
1282	 */
1283	smp_mb();
1284
1285#ifdef CONFIG_DM_DEBUG
1286	for (i = 0; i < DM_TRACKED_CHUNK_HASH_SIZE; i++)
1287		BUG_ON(!hlist_empty(&s->tracked_chunk_hash[i]));
1288#endif
1289
1290	mempool_destroy(s->tracked_chunk_pool);
1291
1292	__free_exceptions(s);
1293
1294	mempool_destroy(s->pending_pool);
1295
1296	dm_exception_store_destroy(s->store);
1297
1298	dm_put_device(ti, s->cow);
1299
1300	dm_put_device(ti, s->origin);
1301
 
 
1302	kfree(s);
1303}
1304
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1305/*
1306 * Flush a list of buffers.
1307 */
1308static void flush_bios(struct bio *bio)
1309{
1310	struct bio *n;
1311
1312	while (bio) {
1313		n = bio->bi_next;
1314		bio->bi_next = NULL;
1315		generic_make_request(bio);
1316		bio = n;
1317	}
1318}
1319
1320static int do_origin(struct dm_dev *origin, struct bio *bio);
1321
1322/*
1323 * Flush a list of buffers.
1324 */
1325static void retry_origin_bios(struct dm_snapshot *s, struct bio *bio)
1326{
1327	struct bio *n;
1328	int r;
1329
1330	while (bio) {
1331		n = bio->bi_next;
1332		bio->bi_next = NULL;
1333		r = do_origin(s->origin, bio);
1334		if (r == DM_MAPIO_REMAPPED)
1335			generic_make_request(bio);
1336		bio = n;
1337	}
1338}
1339
1340/*
1341 * Error a list of buffers.
1342 */
1343static void error_bios(struct bio *bio)
1344{
1345	struct bio *n;
1346
1347	while (bio) {
1348		n = bio->bi_next;
1349		bio->bi_next = NULL;
1350		bio_io_error(bio);
1351		bio = n;
1352	}
1353}
1354
1355static void __invalidate_snapshot(struct dm_snapshot *s, int err)
1356{
1357	if (!s->valid)
1358		return;
1359
1360	if (err == -EIO)
1361		DMERR("Invalidating snapshot: Error reading/writing.");
1362	else if (err == -ENOMEM)
1363		DMERR("Invalidating snapshot: Unable to allocate exception.");
1364
1365	if (s->store->type->drop_snapshot)
1366		s->store->type->drop_snapshot(s->store);
1367
1368	s->valid = 0;
1369
1370	dm_table_event(s->ti->table);
1371}
1372
1373static void pending_complete(struct dm_snap_pending_exception *pe, int success)
 
 
 
 
 
 
 
1374{
 
1375	struct dm_exception *e;
1376	struct dm_snapshot *s = pe->snap;
1377	struct bio *origin_bios = NULL;
1378	struct bio *snapshot_bios = NULL;
1379	struct bio *full_bio = NULL;
 
1380	int error = 0;
1381
 
 
1382	if (!success) {
1383		/* Read/write error - snapshot is unusable */
1384		down_write(&s->lock);
1385		__invalidate_snapshot(s, -EIO);
1386		error = 1;
 
 
1387		goto out;
1388	}
1389
1390	e = alloc_completed_exception();
1391	if (!e) {
1392		down_write(&s->lock);
1393		__invalidate_snapshot(s, -ENOMEM);
1394		error = 1;
 
 
1395		goto out;
1396	}
1397	*e = pe->e;
1398
1399	down_write(&s->lock);
 
1400	if (!s->valid) {
 
1401		free_completed_exception(e);
1402		error = 1;
 
1403		goto out;
1404	}
1405
1406	/* Check for conflicting reads */
1407	__check_for_conflicting_io(s, pe->e.old_chunk);
1408
1409	/*
1410	 * Add a proper exception, and remove the
1411	 * in-flight exception from the list.
 
 
 
1412	 */
1413	dm_insert_exception(&s->complete, e);
 
 
 
 
 
 
 
 
1414
1415out:
 
1416	dm_remove_exception(&pe->e);
 
 
 
1417	snapshot_bios = bio_list_get(&pe->snapshot_bios);
1418	origin_bios = bio_list_get(&pe->origin_bios);
1419	full_bio = pe->full_bio;
1420	if (full_bio) {
1421		full_bio->bi_end_io = pe->full_bio_end_io;
1422		full_bio->bi_private = pe->full_bio_private;
1423	}
1424	free_pending_exception(pe);
1425
1426	increment_pending_exceptions_done_count();
1427
1428	up_write(&s->lock);
1429
1430	/* Submit any pending write bios */
1431	if (error) {
1432		if (full_bio)
1433			bio_io_error(full_bio);
1434		error_bios(snapshot_bios);
1435	} else {
1436		if (full_bio)
1437			bio_endio(full_bio, 0);
1438		flush_bios(snapshot_bios);
1439	}
1440
1441	retry_origin_bios(s, origin_bios);
 
 
1442}
1443
1444static void commit_callback(void *context, int success)
1445{
1446	struct dm_snap_pending_exception *pe = context;
1447
1448	pending_complete(pe, success);
 
 
1449}
1450
1451/*
1452 * Called when the copy I/O has finished.  kcopyd actually runs
1453 * this code so don't block.
1454 */
1455static void copy_callback(int read_err, unsigned long write_err, void *context)
1456{
1457	struct dm_snap_pending_exception *pe = context;
1458	struct dm_snapshot *s = pe->snap;
1459
1460	if (read_err || write_err)
1461		pending_complete(pe, 0);
1462
1463	else
1464		/* Update the metadata if we are persistent */
1465		s->store->type->commit_exception(s->store, &pe->e,
1466						 commit_callback, pe);
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1467}
1468
1469/*
1470 * Dispatches the copy operation to kcopyd.
1471 */
1472static void start_copy(struct dm_snap_pending_exception *pe)
1473{
1474	struct dm_snapshot *s = pe->snap;
1475	struct dm_io_region src, dest;
1476	struct block_device *bdev = s->origin->bdev;
1477	sector_t dev_size;
1478
1479	dev_size = get_dev_size(bdev);
1480
1481	src.bdev = bdev;
1482	src.sector = chunk_to_sector(s->store, pe->e.old_chunk);
1483	src.count = min((sector_t)s->store->chunk_size, dev_size - src.sector);
1484
1485	dest.bdev = s->cow->bdev;
1486	dest.sector = chunk_to_sector(s->store, pe->e.new_chunk);
1487	dest.count = src.count;
1488
1489	/* Hand over to kcopyd */
 
1490	dm_kcopyd_copy(s->kcopyd_client, &src, 1, &dest, 0, copy_callback, pe);
1491}
1492
1493static void full_bio_end_io(struct bio *bio, int error)
1494{
1495	void *callback_data = bio->bi_private;
1496
1497	dm_kcopyd_do_callback(callback_data, 0, error ? 1 : 0);
1498}
1499
1500static void start_full_bio(struct dm_snap_pending_exception *pe,
1501			   struct bio *bio)
1502{
1503	struct dm_snapshot *s = pe->snap;
1504	void *callback_data;
1505
1506	pe->full_bio = bio;
1507	pe->full_bio_end_io = bio->bi_end_io;
1508	pe->full_bio_private = bio->bi_private;
1509
 
1510	callback_data = dm_kcopyd_prepare_callback(s->kcopyd_client,
1511						   copy_callback, pe);
1512
1513	bio->bi_end_io = full_bio_end_io;
1514	bio->bi_private = callback_data;
1515
1516	generic_make_request(bio);
1517}
1518
1519static struct dm_snap_pending_exception *
1520__lookup_pending_exception(struct dm_snapshot *s, chunk_t chunk)
1521{
1522	struct dm_exception *e = dm_lookup_exception(&s->pending, chunk);
1523
1524	if (!e)
1525		return NULL;
1526
1527	return container_of(e, struct dm_snap_pending_exception, e);
1528}
1529
1530/*
1531 * Looks to see if this snapshot already has a pending exception
1532 * for this chunk, otherwise it allocates a new one and inserts
1533 * it into the pending table.
1534 *
1535 * NOTE: a write lock must be held on snap->lock before calling
1536 * this.
1537 */
1538static struct dm_snap_pending_exception *
1539__find_pending_exception(struct dm_snapshot *s,
1540			 struct dm_snap_pending_exception *pe, chunk_t chunk)
1541{
1542	struct dm_snap_pending_exception *pe2;
1543
1544	pe2 = __lookup_pending_exception(s, chunk);
1545	if (pe2) {
1546		free_pending_exception(pe);
1547		return pe2;
1548	}
1549
1550	pe->e.old_chunk = chunk;
1551	bio_list_init(&pe->origin_bios);
1552	bio_list_init(&pe->snapshot_bios);
1553	pe->started = 0;
1554	pe->full_bio = NULL;
1555
 
1556	if (s->store->type->prepare_exception(s->store, &pe->e)) {
 
1557		free_pending_exception(pe);
1558		return NULL;
1559	}
1560
 
 
 
1561	dm_insert_exception(&s->pending, &pe->e);
1562
1563	return pe;
1564}
1565
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1566static void remap_exception(struct dm_snapshot *s, struct dm_exception *e,
1567			    struct bio *bio, chunk_t chunk)
1568{
1569	bio->bi_bdev = s->cow->bdev;
1570	bio->bi_sector = chunk_to_sector(s->store,
1571					 dm_chunk_number(e->new_chunk) +
1572					 (chunk - e->old_chunk)) +
1573					 (bio->bi_sector &
1574					  s->store->chunk_mask);
1575}
1576
1577static int snapshot_map(struct dm_target *ti, struct bio *bio,
1578			union map_info *map_context)
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1579{
1580	struct dm_exception *e;
1581	struct dm_snapshot *s = ti->private;
1582	int r = DM_MAPIO_REMAPPED;
1583	chunk_t chunk;
1584	struct dm_snap_pending_exception *pe = NULL;
 
1585
1586	if (bio->bi_rw & REQ_FLUSH) {
1587		bio->bi_bdev = s->cow->bdev;
 
 
1588		return DM_MAPIO_REMAPPED;
1589	}
1590
1591	chunk = sector_to_chunk(s->store, bio->bi_sector);
 
1592
1593	/* Full snapshots are not usable */
1594	/* To get here the table must be live so s->active is always set. */
1595	if (!s->valid)
1596		return -EIO;
1597
1598	/* FIXME: should only take write lock if we need
1599	 * to copy an exception */
1600	down_write(&s->lock);
 
1601
1602	if (!s->valid) {
1603		r = -EIO;
 
 
 
 
1604		goto out_unlock;
1605	}
1606
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1607	/* If the block is already remapped - use that, else remap it */
1608	e = dm_lookup_exception(&s->complete, chunk);
1609	if (e) {
1610		remap_exception(s, e, bio, chunk);
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1611		goto out_unlock;
1612	}
1613
1614	/*
1615	 * Write to snapshot - higher level takes care of RW/RO
1616	 * flags so we should only get this if we are
1617	 * writeable.
1618	 */
1619	if (bio_rw(bio) == WRITE) {
1620		pe = __lookup_pending_exception(s, chunk);
1621		if (!pe) {
1622			up_write(&s->lock);
1623			pe = alloc_pending_exception(s);
1624			down_write(&s->lock);
1625
1626			if (!s->valid) {
1627				free_pending_exception(pe);
1628				r = -EIO;
1629				goto out_unlock;
1630			}
1631
1632			e = dm_lookup_exception(&s->complete, chunk);
1633			if (e) {
1634				free_pending_exception(pe);
1635				remap_exception(s, e, bio, chunk);
1636				goto out_unlock;
1637			}
1638
1639			pe = __find_pending_exception(s, pe, chunk);
1640			if (!pe) {
1641				__invalidate_snapshot(s, -ENOMEM);
1642				r = -EIO;
1643				goto out_unlock;
 
 
 
 
 
 
 
 
 
 
 
 
 
1644			}
1645		}
1646
1647		remap_exception(s, &pe->e, bio, chunk);
1648
1649		r = DM_MAPIO_SUBMITTED;
1650
1651		if (!pe->started &&
1652		    bio->bi_size == (s->store->chunk_size << SECTOR_SHIFT)) {
1653			pe->started = 1;
1654			up_write(&s->lock);
 
 
 
1655			start_full_bio(pe, bio);
1656			goto out;
1657		}
1658
1659		bio_list_add(&pe->snapshot_bios, bio);
1660
1661		if (!pe->started) {
1662			/* this is protected by snap->lock */
1663			pe->started = 1;
1664			up_write(&s->lock);
 
 
 
1665			start_copy(pe);
1666			goto out;
1667		}
1668	} else {
1669		bio->bi_bdev = s->origin->bdev;
1670		map_context->ptr = track_chunk(s, chunk);
1671	}
1672
1673out_unlock:
1674	up_write(&s->lock);
 
1675out:
1676	return r;
1677}
1678
1679/*
1680 * A snapshot-merge target behaves like a combination of a snapshot
1681 * target and a snapshot-origin target.  It only generates new
1682 * exceptions in other snapshots and not in the one that is being
1683 * merged.
1684 *
1685 * For each chunk, if there is an existing exception, it is used to
1686 * redirect I/O to the cow device.  Otherwise I/O is sent to the origin,
1687 * which in turn might generate exceptions in other snapshots.
1688 * If merging is currently taking place on the chunk in question, the
1689 * I/O is deferred by adding it to s->bios_queued_during_merge.
1690 */
1691static int snapshot_merge_map(struct dm_target *ti, struct bio *bio,
1692			      union map_info *map_context)
1693{
1694	struct dm_exception *e;
1695	struct dm_snapshot *s = ti->private;
1696	int r = DM_MAPIO_REMAPPED;
1697	chunk_t chunk;
1698
1699	if (bio->bi_rw & REQ_FLUSH) {
1700		if (!map_context->target_request_nr)
1701			bio->bi_bdev = s->origin->bdev;
 
 
1702		else
1703			bio->bi_bdev = s->cow->bdev;
1704		map_context->ptr = NULL;
1705		return DM_MAPIO_REMAPPED;
1706	}
1707
1708	chunk = sector_to_chunk(s->store, bio->bi_sector);
 
 
 
 
 
 
1709
1710	down_write(&s->lock);
1711
1712	/* Full merging snapshots are redirected to the origin */
1713	if (!s->valid)
1714		goto redirect_to_origin;
1715
1716	/* If the block is already remapped - use that */
1717	e = dm_lookup_exception(&s->complete, chunk);
1718	if (e) {
1719		/* Queue writes overlapping with chunks being merged */
1720		if (bio_rw(bio) == WRITE &&
1721		    chunk >= s->first_merging_chunk &&
1722		    chunk < (s->first_merging_chunk +
1723			     s->num_merging_chunks)) {
1724			bio->bi_bdev = s->origin->bdev;
1725			bio_list_add(&s->bios_queued_during_merge, bio);
1726			r = DM_MAPIO_SUBMITTED;
1727			goto out_unlock;
1728		}
1729
1730		remap_exception(s, e, bio, chunk);
1731
1732		if (bio_rw(bio) == WRITE)
1733			map_context->ptr = track_chunk(s, chunk);
1734		goto out_unlock;
1735	}
1736
1737redirect_to_origin:
1738	bio->bi_bdev = s->origin->bdev;
1739
1740	if (bio_rw(bio) == WRITE) {
1741		up_write(&s->lock);
1742		return do_origin(s->origin, bio);
1743	}
1744
1745out_unlock:
1746	up_write(&s->lock);
1747
1748	return r;
1749}
1750
1751static int snapshot_end_io(struct dm_target *ti, struct bio *bio,
1752			   int error, union map_info *map_context)
1753{
1754	struct dm_snapshot *s = ti->private;
1755	struct dm_snap_tracked_chunk *c = map_context->ptr;
1756
1757	if (c)
1758		stop_tracking_chunk(s, c);
1759
1760	return 0;
1761}
1762
1763static void snapshot_merge_presuspend(struct dm_target *ti)
1764{
1765	struct dm_snapshot *s = ti->private;
1766
1767	stop_merge(s);
1768}
1769
1770static int snapshot_preresume(struct dm_target *ti)
1771{
1772	int r = 0;
1773	struct dm_snapshot *s = ti->private;
1774	struct dm_snapshot *snap_src = NULL, *snap_dest = NULL;
1775
1776	down_read(&_origins_lock);
1777	(void) __find_snapshots_sharing_cow(s, &snap_src, &snap_dest, NULL);
1778	if (snap_src && snap_dest) {
1779		down_read(&snap_src->lock);
1780		if (s == snap_src) {
1781			DMERR("Unable to resume snapshot source until "
1782			      "handover completes.");
1783			r = -EINVAL;
1784		} else if (!dm_suspended(snap_src->ti)) {
1785			DMERR("Unable to perform snapshot handover until "
1786			      "source is suspended.");
1787			r = -EINVAL;
1788		}
1789		up_read(&snap_src->lock);
1790	}
1791	up_read(&_origins_lock);
1792
1793	return r;
1794}
1795
1796static void snapshot_resume(struct dm_target *ti)
1797{
1798	struct dm_snapshot *s = ti->private;
1799	struct dm_snapshot *snap_src = NULL, *snap_dest = NULL;
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1800
1801	down_read(&_origins_lock);
 
1802	(void) __find_snapshots_sharing_cow(s, &snap_src, &snap_dest, NULL);
1803	if (snap_src && snap_dest) {
1804		down_write(&snap_src->lock);
1805		down_write_nested(&snap_dest->lock, SINGLE_DEPTH_NESTING);
1806		__handover_exceptions(snap_src, snap_dest);
1807		up_write(&snap_dest->lock);
1808		up_write(&snap_src->lock);
1809	}
 
1810	up_read(&_origins_lock);
1811
 
 
 
 
 
 
 
1812	/* Now we have correct chunk size, reregister */
1813	reregister_snapshot(s);
1814
1815	down_write(&s->lock);
1816	s->active = 1;
1817	up_write(&s->lock);
1818}
1819
1820static sector_t get_origin_minimum_chunksize(struct block_device *bdev)
1821{
1822	sector_t min_chunksize;
1823
1824	down_read(&_origins_lock);
1825	min_chunksize = __minimum_chunk_size(__lookup_origin(bdev));
1826	up_read(&_origins_lock);
1827
1828	return min_chunksize;
1829}
1830
1831static void snapshot_merge_resume(struct dm_target *ti)
1832{
1833	struct dm_snapshot *s = ti->private;
1834
1835	/*
1836	 * Handover exceptions from existing snapshot.
1837	 */
1838	snapshot_resume(ti);
1839
1840	/*
1841	 * snapshot-merge acts as an origin, so set ti->split_io
1842	 */
1843	ti->split_io = get_origin_minimum_chunksize(s->origin->bdev);
1844
1845	start_merge(s);
1846}
1847
1848static int snapshot_status(struct dm_target *ti, status_type_t type,
1849			   char *result, unsigned int maxlen)
1850{
1851	unsigned sz = 0;
1852	struct dm_snapshot *snap = ti->private;
 
1853
1854	switch (type) {
1855	case STATUSTYPE_INFO:
1856
1857		down_write(&snap->lock);
1858
1859		if (!snap->valid)
1860			DMEMIT("Invalid");
1861		else if (snap->merge_failed)
1862			DMEMIT("Merge failed");
 
 
1863		else {
1864			if (snap->store->type->usage) {
1865				sector_t total_sectors, sectors_allocated,
1866					 metadata_sectors;
1867				snap->store->type->usage(snap->store,
1868							 &total_sectors,
1869							 &sectors_allocated,
1870							 &metadata_sectors);
1871				DMEMIT("%llu/%llu %llu",
1872				       (unsigned long long)sectors_allocated,
1873				       (unsigned long long)total_sectors,
1874				       (unsigned long long)metadata_sectors);
1875			}
1876			else
1877				DMEMIT("Unknown");
1878		}
1879
1880		up_write(&snap->lock);
1881
1882		break;
1883
1884	case STATUSTYPE_TABLE:
1885		/*
1886		 * kdevname returns a static pointer so we need
1887		 * to make private copies if the output is to
1888		 * make sense.
1889		 */
1890		DMEMIT("%s %s", snap->origin->name, snap->cow->name);
1891		snap->store->type->status(snap->store, type, result + sz,
1892					  maxlen - sz);
 
 
 
 
 
 
 
 
1893		break;
1894	}
1895
1896	return 0;
 
 
 
 
 
 
 
 
 
1897}
1898
1899static int snapshot_iterate_devices(struct dm_target *ti,
1900				    iterate_devices_callout_fn fn, void *data)
1901{
1902	struct dm_snapshot *snap = ti->private;
1903	int r;
1904
1905	r = fn(ti, snap->origin, 0, ti->len, data);
1906
1907	if (!r)
1908		r = fn(ti, snap->cow, 0, get_dev_size(snap->cow->bdev), data);
1909
1910	return r;
1911}
1912
 
 
 
 
 
 
1913
1914/*-----------------------------------------------------------------
1915 * Origin methods
1916 *---------------------------------------------------------------*/
 
 
 
 
 
 
 
 
 
 
1917
1918/*
 
 
 
 
 
1919 * If no exceptions need creating, DM_MAPIO_REMAPPED is returned and any
1920 * supplied bio was ignored.  The caller may submit it immediately.
1921 * (No remapping actually occurs as the origin is always a direct linear
1922 * map.)
1923 *
1924 * If further exceptions are required, DM_MAPIO_SUBMITTED is returned
1925 * and any supplied bio is added to a list to be submitted once all
1926 * the necessary exceptions exist.
1927 */
1928static int __origin_write(struct list_head *snapshots, sector_t sector,
1929			  struct bio *bio)
1930{
1931	int r = DM_MAPIO_REMAPPED;
1932	struct dm_snapshot *snap;
1933	struct dm_exception *e;
1934	struct dm_snap_pending_exception *pe;
1935	struct dm_snap_pending_exception *pe_to_start_now = NULL;
1936	struct dm_snap_pending_exception *pe_to_start_last = NULL;
 
1937	chunk_t chunk;
1938
1939	/* Do all the snapshots on this origin */
1940	list_for_each_entry (snap, snapshots, list) {
1941		/*
1942		 * Don't make new exceptions in a merging snapshot
1943		 * because it has effectively been deleted
1944		 */
1945		if (dm_target_is_snapshot_merge(snap->ti))
1946			continue;
1947
1948		down_write(&snap->lock);
1949
1950		/* Only deal with valid and active snapshots */
1951		if (!snap->valid || !snap->active)
1952			goto next_snapshot;
1953
1954		/* Nothing to do if writing beyond end of snapshot */
1955		if (sector >= dm_table_get_size(snap->ti->table))
1956			goto next_snapshot;
1957
1958		/*
1959		 * Remember, different snapshots can have
1960		 * different chunk sizes.
1961		 */
1962		chunk = sector_to_chunk(snap->store, sector);
 
1963
1964		/*
1965		 * Check exception table to see if block
1966		 * is already remapped in this snapshot
1967		 * and trigger an exception if not.
1968		 */
1969		e = dm_lookup_exception(&snap->complete, chunk);
1970		if (e)
1971			goto next_snapshot;
1972
1973		pe = __lookup_pending_exception(snap, chunk);
1974		if (!pe) {
1975			up_write(&snap->lock);
 
 
 
 
 
 
 
 
 
1976			pe = alloc_pending_exception(snap);
1977			down_write(&snap->lock);
1978
1979			if (!snap->valid) {
1980				free_pending_exception(pe);
1981				goto next_snapshot;
1982			}
1983
1984			e = dm_lookup_exception(&snap->complete, chunk);
1985			if (e) {
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1986				free_pending_exception(pe);
1987				goto next_snapshot;
1988			}
1989
1990			pe = __find_pending_exception(snap, pe, chunk);
1991			if (!pe) {
1992				__invalidate_snapshot(snap, -ENOMEM);
1993				goto next_snapshot;
1994			}
1995		}
1996
1997		r = DM_MAPIO_SUBMITTED;
1998
1999		/*
2000		 * If an origin bio was supplied, queue it to wait for the
2001		 * completion of this exception, and start this one last,
2002		 * at the end of the function.
2003		 */
2004		if (bio) {
2005			bio_list_add(&pe->origin_bios, bio);
2006			bio = NULL;
2007
2008			if (!pe->started) {
2009				pe->started = 1;
2010				pe_to_start_last = pe;
2011			}
2012		}
2013
2014		if (!pe->started) {
2015			pe->started = 1;
2016			pe_to_start_now = pe;
2017		}
2018
2019next_snapshot:
2020		up_write(&snap->lock);
 
2021
2022		if (pe_to_start_now) {
2023			start_copy(pe_to_start_now);
2024			pe_to_start_now = NULL;
2025		}
2026	}
2027
2028	/*
2029	 * Submit the exception against which the bio is queued last,
2030	 * to give the other exceptions a head start.
2031	 */
2032	if (pe_to_start_last)
2033		start_copy(pe_to_start_last);
2034
2035	return r;
2036}
2037
2038/*
2039 * Called on a write from the origin driver.
2040 */
2041static int do_origin(struct dm_dev *origin, struct bio *bio)
2042{
2043	struct origin *o;
2044	int r = DM_MAPIO_REMAPPED;
2045
 
2046	down_read(&_origins_lock);
2047	o = __lookup_origin(origin->bdev);
2048	if (o)
2049		r = __origin_write(&o->snapshots, bio->bi_sector, bio);
 
 
 
 
 
 
 
 
 
2050	up_read(&_origins_lock);
2051
2052	return r;
2053}
2054
2055/*
2056 * Trigger exceptions in all non-merging snapshots.
2057 *
2058 * The chunk size of the merging snapshot may be larger than the chunk
2059 * size of some other snapshot so we may need to reallocate multiple
2060 * chunks in other snapshots.
2061 *
2062 * We scan all the overlapping exceptions in the other snapshots.
2063 * Returns 1 if anything was reallocated and must be waited for,
2064 * otherwise returns 0.
2065 *
2066 * size must be a multiple of merging_snap's chunk_size.
2067 */
2068static int origin_write_extent(struct dm_snapshot *merging_snap,
2069			       sector_t sector, unsigned size)
2070{
2071	int must_wait = 0;
2072	sector_t n;
2073	struct origin *o;
2074
2075	/*
2076	 * The origin's __minimum_chunk_size() got stored in split_io
2077	 * by snapshot_merge_resume().
2078	 */
2079	down_read(&_origins_lock);
2080	o = __lookup_origin(merging_snap->origin->bdev);
2081	for (n = 0; n < size; n += merging_snap->ti->split_io)
2082		if (__origin_write(&o->snapshots, sector + n, NULL) ==
2083		    DM_MAPIO_SUBMITTED)
2084			must_wait = 1;
2085	up_read(&_origins_lock);
2086
2087	return must_wait;
2088}
2089
2090/*
2091 * Origin: maps a linear range of a device, with hooks for snapshotting.
2092 */
2093
2094/*
2095 * Construct an origin mapping: <dev_path>
2096 * The context for an origin is merely a 'struct dm_dev *'
2097 * pointing to the real device.
2098 */
2099static int origin_ctr(struct dm_target *ti, unsigned int argc, char **argv)
2100{
2101	int r;
2102	struct dm_dev *dev;
2103
2104	if (argc != 1) {
2105		ti->error = "origin: incorrect number of arguments";
2106		return -EINVAL;
2107	}
2108
2109	r = dm_get_device(ti, argv[0], dm_table_get_mode(ti->table), &dev);
 
 
 
 
 
 
 
2110	if (r) {
2111		ti->error = "Cannot get target device";
2112		return r;
2113	}
2114
2115	ti->private = dev;
2116	ti->num_flush_requests = 1;
 
2117
2118	return 0;
 
 
 
 
 
2119}
2120
2121static void origin_dtr(struct dm_target *ti)
2122{
2123	struct dm_dev *dev = ti->private;
2124	dm_put_device(ti, dev);
 
 
2125}
2126
2127static int origin_map(struct dm_target *ti, struct bio *bio,
2128		      union map_info *map_context)
2129{
2130	struct dm_dev *dev = ti->private;
2131	bio->bi_bdev = dev->bdev;
 
 
2132
2133	if (bio->bi_rw & REQ_FLUSH)
2134		return DM_MAPIO_REMAPPED;
2135
 
 
 
 
 
 
 
 
 
2136	/* Only tell snapshots if this is a write */
2137	return (bio_rw(bio) == WRITE) ? do_origin(dev, bio) : DM_MAPIO_REMAPPED;
2138}
2139
2140/*
2141 * Set the target "split_io" field to the minimum of all the snapshots'
2142 * chunk sizes.
2143 */
2144static void origin_resume(struct dm_target *ti)
2145{
2146	struct dm_dev *dev = ti->private;
 
 
 
 
 
 
 
 
 
 
 
2147
2148	ti->split_io = get_origin_minimum_chunksize(dev->bdev);
 
 
2149}
2150
2151static int origin_status(struct dm_target *ti, status_type_t type, char *result,
2152			 unsigned int maxlen)
2153{
2154	struct dm_dev *dev = ti->private;
2155
2156	switch (type) {
2157	case STATUSTYPE_INFO:
2158		result[0] = '\0';
2159		break;
2160
2161	case STATUSTYPE_TABLE:
2162		snprintf(result, maxlen, "%s", dev->name);
 
 
 
2163		break;
2164	}
2165
2166	return 0;
2167}
2168
2169static int origin_merge(struct dm_target *ti, struct bvec_merge_data *bvm,
2170			struct bio_vec *biovec, int max_size)
2171{
2172	struct dm_dev *dev = ti->private;
2173	struct request_queue *q = bdev_get_queue(dev->bdev);
2174
2175	if (!q->merge_bvec_fn)
2176		return max_size;
2177
2178	bvm->bi_bdev = dev->bdev;
2179	bvm->bi_sector = bvm->bi_sector;
2180
2181	return min(max_size, q->merge_bvec_fn(q, bvm, biovec));
2182}
2183
2184static int origin_iterate_devices(struct dm_target *ti,
2185				  iterate_devices_callout_fn fn, void *data)
2186{
2187	struct dm_dev *dev = ti->private;
2188
2189	return fn(ti, dev, 0, ti->len, data);
2190}
2191
2192static struct target_type origin_target = {
2193	.name    = "snapshot-origin",
2194	.version = {1, 7, 1},
2195	.module  = THIS_MODULE,
2196	.ctr     = origin_ctr,
2197	.dtr     = origin_dtr,
2198	.map     = origin_map,
2199	.resume  = origin_resume,
 
2200	.status  = origin_status,
2201	.merge	 = origin_merge,
2202	.iterate_devices = origin_iterate_devices,
2203};
2204
2205static struct target_type snapshot_target = {
2206	.name    = "snapshot",
2207	.version = {1, 10, 0},
2208	.module  = THIS_MODULE,
2209	.ctr     = snapshot_ctr,
2210	.dtr     = snapshot_dtr,
2211	.map     = snapshot_map,
2212	.end_io  = snapshot_end_io,
2213	.preresume  = snapshot_preresume,
2214	.resume  = snapshot_resume,
2215	.status  = snapshot_status,
2216	.iterate_devices = snapshot_iterate_devices,
 
2217};
2218
2219static struct target_type merge_target = {
2220	.name    = dm_snapshot_merge_target_name,
2221	.version = {1, 1, 0},
2222	.module  = THIS_MODULE,
2223	.ctr     = snapshot_ctr,
2224	.dtr     = snapshot_dtr,
2225	.map     = snapshot_merge_map,
2226	.end_io  = snapshot_end_io,
2227	.presuspend = snapshot_merge_presuspend,
2228	.preresume  = snapshot_preresume,
2229	.resume  = snapshot_merge_resume,
2230	.status  = snapshot_status,
2231	.iterate_devices = snapshot_iterate_devices,
 
2232};
2233
2234static int __init dm_snapshot_init(void)
2235{
2236	int r;
2237
2238	r = dm_exception_store_init();
2239	if (r) {
2240		DMERR("Failed to initialize exception stores");
2241		return r;
2242	}
2243
2244	r = dm_register_target(&snapshot_target);
2245	if (r < 0) {
2246		DMERR("snapshot target register failed %d", r);
2247		goto bad_register_snapshot_target;
2248	}
2249
2250	r = dm_register_target(&origin_target);
2251	if (r < 0) {
2252		DMERR("Origin target register failed %d", r);
2253		goto bad_register_origin_target;
2254	}
2255
2256	r = dm_register_target(&merge_target);
2257	if (r < 0) {
2258		DMERR("Merge target register failed %d", r);
2259		goto bad_register_merge_target;
2260	}
2261
2262	r = init_origin_hash();
2263	if (r) {
2264		DMERR("init_origin_hash failed.");
2265		goto bad_origin_hash;
2266	}
2267
2268	exception_cache = KMEM_CACHE(dm_exception, 0);
2269	if (!exception_cache) {
2270		DMERR("Couldn't create exception cache.");
2271		r = -ENOMEM;
2272		goto bad_exception_cache;
2273	}
2274
2275	pending_cache = KMEM_CACHE(dm_snap_pending_exception, 0);
2276	if (!pending_cache) {
2277		DMERR("Couldn't create pending cache.");
2278		r = -ENOMEM;
2279		goto bad_pending_cache;
2280	}
2281
2282	tracked_chunk_cache = KMEM_CACHE(dm_snap_tracked_chunk, 0);
2283	if (!tracked_chunk_cache) {
2284		DMERR("Couldn't create cache to track chunks in use.");
2285		r = -ENOMEM;
2286		goto bad_tracked_chunk_cache;
2287	}
 
 
 
 
 
2288
2289	return 0;
2290
2291bad_tracked_chunk_cache:
 
 
 
 
2292	kmem_cache_destroy(pending_cache);
2293bad_pending_cache:
2294	kmem_cache_destroy(exception_cache);
2295bad_exception_cache:
2296	exit_origin_hash();
2297bad_origin_hash:
2298	dm_unregister_target(&merge_target);
2299bad_register_merge_target:
2300	dm_unregister_target(&origin_target);
2301bad_register_origin_target:
2302	dm_unregister_target(&snapshot_target);
2303bad_register_snapshot_target:
2304	dm_exception_store_exit();
2305
2306	return r;
2307}
2308
2309static void __exit dm_snapshot_exit(void)
2310{
2311	dm_unregister_target(&snapshot_target);
2312	dm_unregister_target(&origin_target);
2313	dm_unregister_target(&merge_target);
2314
2315	exit_origin_hash();
2316	kmem_cache_destroy(pending_cache);
2317	kmem_cache_destroy(exception_cache);
2318	kmem_cache_destroy(tracked_chunk_cache);
2319
2320	dm_exception_store_exit();
2321}
2322
2323/* Module hooks */
2324module_init(dm_snapshot_init);
2325module_exit(dm_snapshot_exit);
2326
2327MODULE_DESCRIPTION(DM_NAME " snapshot target");
2328MODULE_AUTHOR("Joe Thornber");
2329MODULE_LICENSE("GPL");
v6.9.4
   1// SPDX-License-Identifier: GPL-2.0-only
   2/*
 
 
   3 * Copyright (C) 2001-2002 Sistina Software (UK) Limited.
   4 *
   5 * This file is released under the GPL.
   6 */
   7
   8#include <linux/blkdev.h>
   9#include <linux/device-mapper.h>
  10#include <linux/delay.h>
  11#include <linux/fs.h>
  12#include <linux/init.h>
  13#include <linux/kdev_t.h>
  14#include <linux/list.h>
  15#include <linux/list_bl.h>
  16#include <linux/mempool.h>
  17#include <linux/module.h>
  18#include <linux/slab.h>
  19#include <linux/vmalloc.h>
  20#include <linux/log2.h>
  21#include <linux/dm-kcopyd.h>
  22
  23#include "dm.h"
  24
  25#include "dm-exception-store.h"
  26
  27#define DM_MSG_PREFIX "snapshots"
  28
  29static const char dm_snapshot_merge_target_name[] = "snapshot-merge";
  30
  31#define dm_target_is_snapshot_merge(ti) \
  32	((ti)->type->name == dm_snapshot_merge_target_name)
  33
  34/*
  35 * The size of the mempool used to track chunks in use.
  36 */
  37#define MIN_IOS 256
  38
  39#define DM_TRACKED_CHUNK_HASH_SIZE	16
  40#define DM_TRACKED_CHUNK_HASH(x)	((unsigned long)(x) & \
  41					 (DM_TRACKED_CHUNK_HASH_SIZE - 1))
  42
  43struct dm_exception_table {
  44	uint32_t hash_mask;
  45	unsigned int hash_shift;
  46	struct hlist_bl_head *table;
  47};
  48
  49struct dm_snapshot {
  50	struct rw_semaphore lock;
  51
  52	struct dm_dev *origin;
  53	struct dm_dev *cow;
  54
  55	struct dm_target *ti;
  56
  57	/* List of snapshots per Origin */
  58	struct list_head list;
  59
  60	/*
  61	 * You can't use a snapshot if this is 0 (e.g. if full).
  62	 * A snapshot-merge target never clears this.
  63	 */
  64	int valid;
  65
  66	/*
  67	 * The snapshot overflowed because of a write to the snapshot device.
  68	 * We don't have to invalidate the snapshot in this case, but we need
  69	 * to prevent further writes.
  70	 */
  71	int snapshot_overflowed;
  72
  73	/* Origin writes don't trigger exceptions until this is set */
  74	int active;
  75
  76	atomic_t pending_exceptions_count;
  77
  78	spinlock_t pe_allocation_lock;
  79
  80	/* Protected by "pe_allocation_lock" */
  81	sector_t exception_start_sequence;
  82
  83	/* Protected by kcopyd single-threaded callback */
  84	sector_t exception_complete_sequence;
  85
  86	/*
  87	 * A list of pending exceptions that completed out of order.
  88	 * Protected by kcopyd single-threaded callback.
  89	 */
  90	struct rb_root out_of_order_tree;
  91
  92	mempool_t pending_pool;
  93
  94	struct dm_exception_table pending;
  95	struct dm_exception_table complete;
  96
  97	/*
  98	 * pe_lock protects all pending_exception operations and access
  99	 * as well as the snapshot_bios list.
 100	 */
 101	spinlock_t pe_lock;
 102
 103	/* Chunks with outstanding reads */
 104	spinlock_t tracked_chunk_lock;
 
 105	struct hlist_head tracked_chunk_hash[DM_TRACKED_CHUNK_HASH_SIZE];
 106
 107	/* The on disk metadata handler */
 108	struct dm_exception_store *store;
 109
 110	unsigned int in_progress;
 111	struct wait_queue_head in_progress_wait;
 112
 113	struct dm_kcopyd_client *kcopyd_client;
 114
 115	/* Wait for events based on state_bits */
 116	unsigned long state_bits;
 117
 118	/* Range of chunks currently being merged. */
 119	chunk_t first_merging_chunk;
 120	int num_merging_chunks;
 121
 122	/*
 123	 * The merge operation failed if this flag is set.
 124	 * Failure modes are handled as follows:
 125	 * - I/O error reading the header
 126	 *	=> don't load the target; abort.
 127	 * - Header does not have "valid" flag set
 128	 *	=> use the origin; forget about the snapshot.
 129	 * - I/O error when reading exceptions
 130	 *	=> don't load the target; abort.
 131	 *         (We can't use the intermediate origin state.)
 132	 * - I/O error while merging
 133	 *	=> stop merging; set merge_failed; process I/O normally.
 134	 */
 135	bool merge_failed:1;
 136
 137	bool discard_zeroes_cow:1;
 138	bool discard_passdown_origin:1;
 139
 140	/*
 141	 * Incoming bios that overlap with chunks being merged must wait
 142	 * for them to be committed.
 143	 */
 144	struct bio_list bios_queued_during_merge;
 145};
 146
 147/*
 148 * state_bits:
 149 *   RUNNING_MERGE  - Merge operation is in progress.
 150 *   SHUTDOWN_MERGE - Set to signal that merge needs to be stopped;
 151 *                    cleared afterwards.
 152 */
 153#define RUNNING_MERGE          0
 154#define SHUTDOWN_MERGE         1
 155
 156/*
 157 * Maximum number of chunks being copied on write.
 158 *
 159 * The value was decided experimentally as a trade-off between memory
 160 * consumption, stalling the kernel's workqueues and maintaining a high enough
 161 * throughput.
 162 */
 163#define DEFAULT_COW_THRESHOLD 2048
 164
 165static unsigned int cow_threshold = DEFAULT_COW_THRESHOLD;
 166module_param_named(snapshot_cow_threshold, cow_threshold, uint, 0644);
 167MODULE_PARM_DESC(snapshot_cow_threshold, "Maximum number of chunks being copied on write");
 168
 169DECLARE_DM_KCOPYD_THROTTLE_WITH_MODULE_PARM(snapshot_copy_throttle,
 170		"A percentage of time allocated for copy on write");
 171
 172struct dm_dev *dm_snap_origin(struct dm_snapshot *s)
 173{
 174	return s->origin;
 175}
 176EXPORT_SYMBOL(dm_snap_origin);
 177
 178struct dm_dev *dm_snap_cow(struct dm_snapshot *s)
 179{
 180	return s->cow;
 181}
 182EXPORT_SYMBOL(dm_snap_cow);
 183
 184static sector_t chunk_to_sector(struct dm_exception_store *store,
 185				chunk_t chunk)
 186{
 187	return chunk << store->chunk_shift;
 188}
 189
 190static int bdev_equal(struct block_device *lhs, struct block_device *rhs)
 191{
 192	/*
 193	 * There is only ever one instance of a particular block
 194	 * device so we can compare pointers safely.
 195	 */
 196	return lhs == rhs;
 197}
 198
 199struct dm_snap_pending_exception {
 200	struct dm_exception e;
 201
 202	/*
 203	 * Origin buffers waiting for this to complete are held
 204	 * in a bio list
 205	 */
 206	struct bio_list origin_bios;
 207	struct bio_list snapshot_bios;
 208
 209	/* Pointer back to snapshot context */
 210	struct dm_snapshot *snap;
 211
 212	/*
 213	 * 1 indicates the exception has already been sent to
 214	 * kcopyd.
 215	 */
 216	int started;
 217
 218	/* There was copying error. */
 219	int copy_error;
 220
 221	/* A sequence number, it is used for in-order completion. */
 222	sector_t exception_sequence;
 223
 224	struct rb_node out_of_order_node;
 225
 226	/*
 227	 * For writing a complete chunk, bypassing the copy.
 228	 */
 229	struct bio *full_bio;
 230	bio_end_io_t *full_bio_end_io;
 
 231};
 232
 233/*
 234 * Hash table mapping origin volumes to lists of snapshots and
 235 * a lock to protect it
 236 */
 237static struct kmem_cache *exception_cache;
 238static struct kmem_cache *pending_cache;
 239
 240struct dm_snap_tracked_chunk {
 241	struct hlist_node node;
 242	chunk_t chunk;
 243};
 244
 245static void init_tracked_chunk(struct bio *bio)
 246{
 247	struct dm_snap_tracked_chunk *c = dm_per_bio_data(bio, sizeof(struct dm_snap_tracked_chunk));
 248
 249	INIT_HLIST_NODE(&c->node);
 250}
 251
 252static bool is_bio_tracked(struct bio *bio)
 
 253{
 254	struct dm_snap_tracked_chunk *c = dm_per_bio_data(bio, sizeof(struct dm_snap_tracked_chunk));
 255
 256	return !hlist_unhashed(&c->node);
 257}
 258
 259static void track_chunk(struct dm_snapshot *s, struct bio *bio, chunk_t chunk)
 260{
 261	struct dm_snap_tracked_chunk *c = dm_per_bio_data(bio, sizeof(struct dm_snap_tracked_chunk));
 262
 263	c->chunk = chunk;
 264
 265	spin_lock_irq(&s->tracked_chunk_lock);
 266	hlist_add_head(&c->node,
 267		       &s->tracked_chunk_hash[DM_TRACKED_CHUNK_HASH(chunk)]);
 268	spin_unlock_irq(&s->tracked_chunk_lock);
 
 
 269}
 270
 271static void stop_tracking_chunk(struct dm_snapshot *s, struct bio *bio)
 
 272{
 273	struct dm_snap_tracked_chunk *c = dm_per_bio_data(bio, sizeof(struct dm_snap_tracked_chunk));
 274	unsigned long flags;
 275
 276	spin_lock_irqsave(&s->tracked_chunk_lock, flags);
 277	hlist_del(&c->node);
 278	spin_unlock_irqrestore(&s->tracked_chunk_lock, flags);
 
 
 279}
 280
 281static int __chunk_is_tracked(struct dm_snapshot *s, chunk_t chunk)
 282{
 283	struct dm_snap_tracked_chunk *c;
 
 284	int found = 0;
 285
 286	spin_lock_irq(&s->tracked_chunk_lock);
 287
 288	hlist_for_each_entry(c,
 289	    &s->tracked_chunk_hash[DM_TRACKED_CHUNK_HASH(chunk)], node) {
 290		if (c->chunk == chunk) {
 291			found = 1;
 292			break;
 293		}
 294	}
 295
 296	spin_unlock_irq(&s->tracked_chunk_lock);
 297
 298	return found;
 299}
 300
 301/*
 302 * This conflicting I/O is extremely improbable in the caller,
 303 * so fsleep(1000) is sufficient and there is no need for a wait queue.
 304 */
 305static void __check_for_conflicting_io(struct dm_snapshot *s, chunk_t chunk)
 306{
 307	while (__chunk_is_tracked(s, chunk))
 308		fsleep(1000);
 309}
 310
 311/*
 312 * One of these per registered origin, held in the snapshot_origins hash
 313 */
 314struct origin {
 315	/* The origin device */
 316	struct block_device *bdev;
 317
 318	struct list_head hash_list;
 319
 320	/* List of snapshots for this origin */
 321	struct list_head snapshots;
 322};
 323
 324/*
 325 * This structure is allocated for each origin target
 326 */
 327struct dm_origin {
 328	struct dm_dev *dev;
 329	struct dm_target *ti;
 330	unsigned int split_boundary;
 331	struct list_head hash_list;
 332};
 333
 334/*
 335 * Size of the hash table for origin volumes. If we make this
 336 * the size of the minors list then it should be nearly perfect
 337 */
 338#define ORIGIN_HASH_SIZE 256
 339#define ORIGIN_MASK      0xFF
 340static struct list_head *_origins;
 341static struct list_head *_dm_origins;
 342static struct rw_semaphore _origins_lock;
 343
 344static DECLARE_WAIT_QUEUE_HEAD(_pending_exceptions_done);
 345static DEFINE_SPINLOCK(_pending_exceptions_done_spinlock);
 346static uint64_t _pending_exceptions_done_count;
 347
 348static int init_origin_hash(void)
 349{
 350	int i;
 351
 352	_origins = kmalloc_array(ORIGIN_HASH_SIZE, sizeof(struct list_head),
 353				 GFP_KERNEL);
 354	if (!_origins) {
 355		DMERR("unable to allocate memory for _origins");
 356		return -ENOMEM;
 357	}
 
 358	for (i = 0; i < ORIGIN_HASH_SIZE; i++)
 359		INIT_LIST_HEAD(_origins + i);
 360
 361	_dm_origins = kmalloc_array(ORIGIN_HASH_SIZE,
 362				    sizeof(struct list_head),
 363				    GFP_KERNEL);
 364	if (!_dm_origins) {
 365		DMERR("unable to allocate memory for _dm_origins");
 366		kfree(_origins);
 367		return -ENOMEM;
 368	}
 369	for (i = 0; i < ORIGIN_HASH_SIZE; i++)
 370		INIT_LIST_HEAD(_dm_origins + i);
 371
 372	init_rwsem(&_origins_lock);
 373
 374	return 0;
 375}
 376
 377static void exit_origin_hash(void)
 378{
 379	kfree(_origins);
 380	kfree(_dm_origins);
 381}
 382
 383static unsigned int origin_hash(struct block_device *bdev)
 384{
 385	return bdev->bd_dev & ORIGIN_MASK;
 386}
 387
 388static struct origin *__lookup_origin(struct block_device *origin)
 389{
 390	struct list_head *ol;
 391	struct origin *o;
 392
 393	ol = &_origins[origin_hash(origin)];
 394	list_for_each_entry(o, ol, hash_list)
 395		if (bdev_equal(o->bdev, origin))
 396			return o;
 397
 398	return NULL;
 399}
 400
 401static void __insert_origin(struct origin *o)
 402{
 403	struct list_head *sl = &_origins[origin_hash(o->bdev)];
 404
 405	list_add_tail(&o->hash_list, sl);
 406}
 407
 408static struct dm_origin *__lookup_dm_origin(struct block_device *origin)
 409{
 410	struct list_head *ol;
 411	struct dm_origin *o;
 412
 413	ol = &_dm_origins[origin_hash(origin)];
 414	list_for_each_entry(o, ol, hash_list)
 415		if (bdev_equal(o->dev->bdev, origin))
 416			return o;
 417
 418	return NULL;
 419}
 420
 421static void __insert_dm_origin(struct dm_origin *o)
 422{
 423	struct list_head *sl = &_dm_origins[origin_hash(o->dev->bdev)];
 424
 425	list_add_tail(&o->hash_list, sl);
 426}
 427
 428static void __remove_dm_origin(struct dm_origin *o)
 429{
 430	list_del(&o->hash_list);
 431}
 432
 433/*
 434 * _origins_lock must be held when calling this function.
 435 * Returns number of snapshots registered using the supplied cow device, plus:
 436 * snap_src - a snapshot suitable for use as a source of exception handover
 437 * snap_dest - a snapshot capable of receiving exception handover.
 438 * snap_merge - an existing snapshot-merge target linked to the same origin.
 439 *   There can be at most one snapshot-merge target. The parameter is optional.
 440 *
 441 * Possible return values and states of snap_src and snap_dest.
 442 *   0: NULL, NULL  - first new snapshot
 443 *   1: snap_src, NULL - normal snapshot
 444 *   2: snap_src, snap_dest  - waiting for handover
 445 *   2: snap_src, NULL - handed over, waiting for old to be deleted
 446 *   1: NULL, snap_dest - source got destroyed without handover
 447 */
 448static int __find_snapshots_sharing_cow(struct dm_snapshot *snap,
 449					struct dm_snapshot **snap_src,
 450					struct dm_snapshot **snap_dest,
 451					struct dm_snapshot **snap_merge)
 452{
 453	struct dm_snapshot *s;
 454	struct origin *o;
 455	int count = 0;
 456	int active;
 457
 458	o = __lookup_origin(snap->origin->bdev);
 459	if (!o)
 460		goto out;
 461
 462	list_for_each_entry(s, &o->snapshots, list) {
 463		if (dm_target_is_snapshot_merge(s->ti) && snap_merge)
 464			*snap_merge = s;
 465		if (!bdev_equal(s->cow->bdev, snap->cow->bdev))
 466			continue;
 467
 468		down_read(&s->lock);
 469		active = s->active;
 470		up_read(&s->lock);
 471
 472		if (active) {
 473			if (snap_src)
 474				*snap_src = s;
 475		} else if (snap_dest)
 476			*snap_dest = s;
 477
 478		count++;
 479	}
 480
 481out:
 482	return count;
 483}
 484
 485/*
 486 * On success, returns 1 if this snapshot is a handover destination,
 487 * otherwise returns 0.
 488 */
 489static int __validate_exception_handover(struct dm_snapshot *snap)
 490{
 491	struct dm_snapshot *snap_src = NULL, *snap_dest = NULL;
 492	struct dm_snapshot *snap_merge = NULL;
 493
 494	/* Does snapshot need exceptions handed over to it? */
 495	if ((__find_snapshots_sharing_cow(snap, &snap_src, &snap_dest,
 496					  &snap_merge) == 2) ||
 497	    snap_dest) {
 498		snap->ti->error = "Snapshot cow pairing for exception table handover failed";
 
 499		return -EINVAL;
 500	}
 501
 502	/*
 503	 * If no snap_src was found, snap cannot become a handover
 504	 * destination.
 505	 */
 506	if (!snap_src)
 507		return 0;
 508
 509	/*
 510	 * Non-snapshot-merge handover?
 511	 */
 512	if (!dm_target_is_snapshot_merge(snap->ti))
 513		return 1;
 514
 515	/*
 516	 * Do not allow more than one merging snapshot.
 517	 */
 518	if (snap_merge) {
 519		snap->ti->error = "A snapshot is already merging.";
 520		return -EINVAL;
 521	}
 522
 523	if (!snap_src->store->type->prepare_merge ||
 524	    !snap_src->store->type->commit_merge) {
 525		snap->ti->error = "Snapshot exception store does not support snapshot-merge.";
 
 526		return -EINVAL;
 527	}
 528
 529	return 1;
 530}
 531
 532static void __insert_snapshot(struct origin *o, struct dm_snapshot *s)
 533{
 534	struct dm_snapshot *l;
 535
 536	/* Sort the list according to chunk size, largest-first smallest-last */
 537	list_for_each_entry(l, &o->snapshots, list)
 538		if (l->store->chunk_size < s->store->chunk_size)
 539			break;
 540	list_add_tail(&s->list, &l->list);
 541}
 542
 543/*
 544 * Make a note of the snapshot and its origin so we can look it
 545 * up when the origin has a write on it.
 546 *
 547 * Also validate snapshot exception store handovers.
 548 * On success, returns 1 if this registration is a handover destination,
 549 * otherwise returns 0.
 550 */
 551static int register_snapshot(struct dm_snapshot *snap)
 552{
 553	struct origin *o, *new_o = NULL;
 554	struct block_device *bdev = snap->origin->bdev;
 555	int r = 0;
 556
 557	new_o = kmalloc(sizeof(*new_o), GFP_KERNEL);
 558	if (!new_o)
 559		return -ENOMEM;
 560
 561	down_write(&_origins_lock);
 562
 563	r = __validate_exception_handover(snap);
 564	if (r < 0) {
 565		kfree(new_o);
 566		goto out;
 567	}
 568
 569	o = __lookup_origin(bdev);
 570	if (o)
 571		kfree(new_o);
 572	else {
 573		/* New origin */
 574		o = new_o;
 575
 576		/* Initialise the struct */
 577		INIT_LIST_HEAD(&o->snapshots);
 578		o->bdev = bdev;
 579
 580		__insert_origin(o);
 581	}
 582
 583	__insert_snapshot(o, snap);
 584
 585out:
 586	up_write(&_origins_lock);
 587
 588	return r;
 589}
 590
 591/*
 592 * Move snapshot to correct place in list according to chunk size.
 593 */
 594static void reregister_snapshot(struct dm_snapshot *s)
 595{
 596	struct block_device *bdev = s->origin->bdev;
 597
 598	down_write(&_origins_lock);
 599
 600	list_del(&s->list);
 601	__insert_snapshot(__lookup_origin(bdev), s);
 602
 603	up_write(&_origins_lock);
 604}
 605
 606static void unregister_snapshot(struct dm_snapshot *s)
 607{
 608	struct origin *o;
 609
 610	down_write(&_origins_lock);
 611	o = __lookup_origin(s->origin->bdev);
 612
 613	list_del(&s->list);
 614	if (o && list_empty(&o->snapshots)) {
 615		list_del(&o->hash_list);
 616		kfree(o);
 617	}
 618
 619	up_write(&_origins_lock);
 620}
 621
 622/*
 623 * Implementation of the exception hash tables.
 624 * The lowest hash_shift bits of the chunk number are ignored, allowing
 625 * some consecutive chunks to be grouped together.
 626 */
 627static uint32_t exception_hash(struct dm_exception_table *et, chunk_t chunk);
 628
 629/* Lock to protect access to the completed and pending exception hash tables. */
 630struct dm_exception_table_lock {
 631	struct hlist_bl_head *complete_slot;
 632	struct hlist_bl_head *pending_slot;
 633};
 634
 635static void dm_exception_table_lock_init(struct dm_snapshot *s, chunk_t chunk,
 636					 struct dm_exception_table_lock *lock)
 637{
 638	struct dm_exception_table *complete = &s->complete;
 639	struct dm_exception_table *pending = &s->pending;
 640
 641	lock->complete_slot = &complete->table[exception_hash(complete, chunk)];
 642	lock->pending_slot = &pending->table[exception_hash(pending, chunk)];
 643}
 644
 645static void dm_exception_table_lock(struct dm_exception_table_lock *lock)
 646{
 647	hlist_bl_lock(lock->complete_slot);
 648	hlist_bl_lock(lock->pending_slot);
 649}
 650
 651static void dm_exception_table_unlock(struct dm_exception_table_lock *lock)
 652{
 653	hlist_bl_unlock(lock->pending_slot);
 654	hlist_bl_unlock(lock->complete_slot);
 655}
 656
 657static int dm_exception_table_init(struct dm_exception_table *et,
 658				   uint32_t size, unsigned int hash_shift)
 659{
 660	unsigned int i;
 661
 662	et->hash_shift = hash_shift;
 663	et->hash_mask = size - 1;
 664	et->table = kvmalloc_array(size, sizeof(struct hlist_bl_head),
 665				   GFP_KERNEL);
 666	if (!et->table)
 667		return -ENOMEM;
 668
 669	for (i = 0; i < size; i++)
 670		INIT_HLIST_BL_HEAD(et->table + i);
 671
 672	return 0;
 673}
 674
 675static void dm_exception_table_exit(struct dm_exception_table *et,
 676				    struct kmem_cache *mem)
 677{
 678	struct hlist_bl_head *slot;
 679	struct dm_exception *ex;
 680	struct hlist_bl_node *pos, *n;
 681	int i, size;
 682
 683	size = et->hash_mask + 1;
 684	for (i = 0; i < size; i++) {
 685		slot = et->table + i;
 686
 687		hlist_bl_for_each_entry_safe(ex, pos, n, slot, hash_list) {
 688			kmem_cache_free(mem, ex);
 689			cond_resched();
 690		}
 691	}
 692
 693	kvfree(et->table);
 694}
 695
 696static uint32_t exception_hash(struct dm_exception_table *et, chunk_t chunk)
 697{
 698	return (chunk >> et->hash_shift) & et->hash_mask;
 699}
 700
 701static void dm_remove_exception(struct dm_exception *e)
 702{
 703	hlist_bl_del(&e->hash_list);
 704}
 705
 706/*
 707 * Return the exception data for a sector, or NULL if not
 708 * remapped.
 709 */
 710static struct dm_exception *dm_lookup_exception(struct dm_exception_table *et,
 711						chunk_t chunk)
 712{
 713	struct hlist_bl_head *slot;
 714	struct hlist_bl_node *pos;
 715	struct dm_exception *e;
 716
 717	slot = &et->table[exception_hash(et, chunk)];
 718	hlist_bl_for_each_entry(e, pos, slot, hash_list)
 719		if (chunk >= e->old_chunk &&
 720		    chunk <= e->old_chunk + dm_consecutive_chunk_count(e))
 721			return e;
 722
 723	return NULL;
 724}
 725
 726static struct dm_exception *alloc_completed_exception(gfp_t gfp)
 727{
 728	struct dm_exception *e;
 729
 730	e = kmem_cache_alloc(exception_cache, gfp);
 731	if (!e && gfp == GFP_NOIO)
 732		e = kmem_cache_alloc(exception_cache, GFP_ATOMIC);
 733
 734	return e;
 735}
 736
 737static void free_completed_exception(struct dm_exception *e)
 738{
 739	kmem_cache_free(exception_cache, e);
 740}
 741
 742static struct dm_snap_pending_exception *alloc_pending_exception(struct dm_snapshot *s)
 743{
 744	struct dm_snap_pending_exception *pe = mempool_alloc(&s->pending_pool,
 745							     GFP_NOIO);
 746
 747	atomic_inc(&s->pending_exceptions_count);
 748	pe->snap = s;
 749
 750	return pe;
 751}
 752
 753static void free_pending_exception(struct dm_snap_pending_exception *pe)
 754{
 755	struct dm_snapshot *s = pe->snap;
 756
 757	mempool_free(pe, &s->pending_pool);
 758	smp_mb__before_atomic();
 759	atomic_dec(&s->pending_exceptions_count);
 760}
 761
 762static void dm_insert_exception(struct dm_exception_table *eh,
 763				struct dm_exception *new_e)
 764{
 765	struct hlist_bl_head *l;
 766	struct hlist_bl_node *pos;
 767	struct dm_exception *e = NULL;
 768
 769	l = &eh->table[exception_hash(eh, new_e->old_chunk)];
 770
 771	/* Add immediately if this table doesn't support consecutive chunks */
 772	if (!eh->hash_shift)
 773		goto out;
 774
 775	/* List is ordered by old_chunk */
 776	hlist_bl_for_each_entry(e, pos, l, hash_list) {
 777		/* Insert after an existing chunk? */
 778		if (new_e->old_chunk == (e->old_chunk +
 779					 dm_consecutive_chunk_count(e) + 1) &&
 780		    new_e->new_chunk == (dm_chunk_number(e->new_chunk) +
 781					 dm_consecutive_chunk_count(e) + 1)) {
 782			dm_consecutive_chunk_count_inc(e);
 783			free_completed_exception(new_e);
 784			return;
 785		}
 786
 787		/* Insert before an existing chunk? */
 788		if (new_e->old_chunk == (e->old_chunk - 1) &&
 789		    new_e->new_chunk == (dm_chunk_number(e->new_chunk) - 1)) {
 790			dm_consecutive_chunk_count_inc(e);
 791			e->old_chunk--;
 792			e->new_chunk--;
 793			free_completed_exception(new_e);
 794			return;
 795		}
 796
 797		if (new_e->old_chunk < e->old_chunk)
 798			break;
 799	}
 800
 801out:
 802	if (!e) {
 803		/*
 804		 * Either the table doesn't support consecutive chunks or slot
 805		 * l is empty.
 806		 */
 807		hlist_bl_add_head(&new_e->hash_list, l);
 808	} else if (new_e->old_chunk < e->old_chunk) {
 809		/* Add before an existing exception */
 810		hlist_bl_add_before(&new_e->hash_list, &e->hash_list);
 811	} else {
 812		/* Add to l's tail: e is the last exception in this slot */
 813		hlist_bl_add_behind(&new_e->hash_list, &e->hash_list);
 814	}
 815}
 816
 817/*
 818 * Callback used by the exception stores to load exceptions when
 819 * initialising.
 820 */
 821static int dm_add_exception(void *context, chunk_t old, chunk_t new)
 822{
 823	struct dm_exception_table_lock lock;
 824	struct dm_snapshot *s = context;
 825	struct dm_exception *e;
 826
 827	e = alloc_completed_exception(GFP_KERNEL);
 828	if (!e)
 829		return -ENOMEM;
 830
 831	e->old_chunk = old;
 832
 833	/* Consecutive_count is implicitly initialised to zero */
 834	e->new_chunk = new;
 835
 836	/*
 837	 * Although there is no need to lock access to the exception tables
 838	 * here, if we don't then hlist_bl_add_head(), called by
 839	 * dm_insert_exception(), will complain about accessing the
 840	 * corresponding list without locking it first.
 841	 */
 842	dm_exception_table_lock_init(s, old, &lock);
 843
 844	dm_exception_table_lock(&lock);
 845	dm_insert_exception(&s->complete, e);
 846	dm_exception_table_unlock(&lock);
 847
 848	return 0;
 849}
 850
 851/*
 852 * Return a minimum chunk size of all snapshots that have the specified origin.
 853 * Return zero if the origin has no snapshots.
 854 */
 855static uint32_t __minimum_chunk_size(struct origin *o)
 856{
 857	struct dm_snapshot *snap;
 858	unsigned int chunk_size = rounddown_pow_of_two(UINT_MAX);
 859
 860	if (o)
 861		list_for_each_entry(snap, &o->snapshots, list)
 862			chunk_size = min_not_zero(chunk_size,
 863						  snap->store->chunk_size);
 864
 865	return (uint32_t) chunk_size;
 866}
 867
 868/*
 869 * Hard coded magic.
 870 */
 871static int calc_max_buckets(void)
 872{
 873	/* use a fixed size of 2MB */
 874	unsigned long mem = 2 * 1024 * 1024;
 875
 876	mem /= sizeof(struct hlist_bl_head);
 877
 878	return mem;
 879}
 880
 881/*
 882 * Allocate room for a suitable hash table.
 883 */
 884static int init_hash_tables(struct dm_snapshot *s)
 885{
 886	sector_t hash_size, cow_dev_size, max_buckets;
 887
 888	/*
 889	 * Calculate based on the size of the original volume or
 890	 * the COW volume...
 891	 */
 892	cow_dev_size = get_dev_size(s->cow->bdev);
 
 893	max_buckets = calc_max_buckets();
 894
 895	hash_size = cow_dev_size >> s->store->chunk_shift;
 896	hash_size = min(hash_size, max_buckets);
 897
 898	if (hash_size < 64)
 899		hash_size = 64;
 900	hash_size = rounddown_pow_of_two(hash_size);
 901	if (dm_exception_table_init(&s->complete, hash_size,
 902				    DM_CHUNK_CONSECUTIVE_BITS))
 903		return -ENOMEM;
 904
 905	/*
 906	 * Allocate hash table for in-flight exceptions
 907	 * Make this smaller than the real hash table
 908	 */
 909	hash_size >>= 3;
 910	if (hash_size < 64)
 911		hash_size = 64;
 912
 913	if (dm_exception_table_init(&s->pending, hash_size, 0)) {
 914		dm_exception_table_exit(&s->complete, exception_cache);
 915		return -ENOMEM;
 916	}
 917
 918	return 0;
 919}
 920
 921static void merge_shutdown(struct dm_snapshot *s)
 922{
 923	clear_bit_unlock(RUNNING_MERGE, &s->state_bits);
 924	smp_mb__after_atomic();
 925	wake_up_bit(&s->state_bits, RUNNING_MERGE);
 926}
 927
 928static struct bio *__release_queued_bios_after_merge(struct dm_snapshot *s)
 929{
 930	s->first_merging_chunk = 0;
 931	s->num_merging_chunks = 0;
 932
 933	return bio_list_get(&s->bios_queued_during_merge);
 934}
 935
 936/*
 937 * Remove one chunk from the index of completed exceptions.
 938 */
 939static int __remove_single_exception_chunk(struct dm_snapshot *s,
 940					   chunk_t old_chunk)
 941{
 942	struct dm_exception *e;
 943
 944	e = dm_lookup_exception(&s->complete, old_chunk);
 945	if (!e) {
 946		DMERR("Corruption detected: exception for block %llu is on disk but not in memory",
 
 947		      (unsigned long long)old_chunk);
 948		return -EINVAL;
 949	}
 950
 951	/*
 952	 * If this is the only chunk using this exception, remove exception.
 953	 */
 954	if (!dm_consecutive_chunk_count(e)) {
 955		dm_remove_exception(e);
 956		free_completed_exception(e);
 957		return 0;
 958	}
 959
 960	/*
 961	 * The chunk may be either at the beginning or the end of a
 962	 * group of consecutive chunks - never in the middle.  We are
 963	 * removing chunks in the opposite order to that in which they
 964	 * were added, so this should always be true.
 965	 * Decrement the consecutive chunk counter and adjust the
 966	 * starting point if necessary.
 967	 */
 968	if (old_chunk == e->old_chunk) {
 969		e->old_chunk++;
 970		e->new_chunk++;
 971	} else if (old_chunk != e->old_chunk +
 972		   dm_consecutive_chunk_count(e)) {
 973		DMERR("Attempt to merge block %llu from the middle of a chunk range [%llu - %llu]",
 
 974		      (unsigned long long)old_chunk,
 975		      (unsigned long long)e->old_chunk,
 976		      (unsigned long long)
 977		      e->old_chunk + dm_consecutive_chunk_count(e));
 978		return -EINVAL;
 979	}
 980
 981	dm_consecutive_chunk_count_dec(e);
 982
 983	return 0;
 984}
 985
 986static void flush_bios(struct bio *bio);
 987
 988static int remove_single_exception_chunk(struct dm_snapshot *s)
 989{
 990	struct bio *b = NULL;
 991	int r;
 992	chunk_t old_chunk = s->first_merging_chunk + s->num_merging_chunks - 1;
 993
 994	down_write(&s->lock);
 995
 996	/*
 997	 * Process chunks (and associated exceptions) in reverse order
 998	 * so that dm_consecutive_chunk_count_dec() accounting works.
 999	 */
1000	do {
1001		r = __remove_single_exception_chunk(s, old_chunk);
1002		if (r)
1003			goto out;
1004	} while (old_chunk-- > s->first_merging_chunk);
1005
1006	b = __release_queued_bios_after_merge(s);
1007
1008out:
1009	up_write(&s->lock);
1010	if (b)
1011		flush_bios(b);
1012
1013	return r;
1014}
1015
1016static int origin_write_extent(struct dm_snapshot *merging_snap,
1017			       sector_t sector, unsigned int chunk_size);
1018
1019static void merge_callback(int read_err, unsigned long write_err,
1020			   void *context);
1021
1022static uint64_t read_pending_exceptions_done_count(void)
1023{
1024	uint64_t pending_exceptions_done;
1025
1026	spin_lock(&_pending_exceptions_done_spinlock);
1027	pending_exceptions_done = _pending_exceptions_done_count;
1028	spin_unlock(&_pending_exceptions_done_spinlock);
1029
1030	return pending_exceptions_done;
1031}
1032
1033static void increment_pending_exceptions_done_count(void)
1034{
1035	spin_lock(&_pending_exceptions_done_spinlock);
1036	_pending_exceptions_done_count++;
1037	spin_unlock(&_pending_exceptions_done_spinlock);
1038
1039	wake_up_all(&_pending_exceptions_done);
1040}
1041
1042static void snapshot_merge_next_chunks(struct dm_snapshot *s)
1043{
1044	int i, linear_chunks;
1045	chunk_t old_chunk, new_chunk;
1046	struct dm_io_region src, dest;
1047	sector_t io_size;
1048	uint64_t previous_count;
1049
1050	BUG_ON(!test_bit(RUNNING_MERGE, &s->state_bits));
1051	if (unlikely(test_bit(SHUTDOWN_MERGE, &s->state_bits)))
1052		goto shut;
1053
1054	/*
1055	 * valid flag never changes during merge, so no lock required.
1056	 */
1057	if (!s->valid) {
1058		DMERR("Snapshot is invalid: can't merge");
1059		goto shut;
1060	}
1061
1062	linear_chunks = s->store->type->prepare_merge(s->store, &old_chunk,
1063						      &new_chunk);
1064	if (linear_chunks <= 0) {
1065		if (linear_chunks < 0) {
1066			DMERR("Read error in exception store: shutting down merge");
 
1067			down_write(&s->lock);
1068			s->merge_failed = true;
1069			up_write(&s->lock);
1070		}
1071		goto shut;
1072	}
1073
1074	/* Adjust old_chunk and new_chunk to reflect start of linear region */
1075	old_chunk = old_chunk + 1 - linear_chunks;
1076	new_chunk = new_chunk + 1 - linear_chunks;
1077
1078	/*
1079	 * Use one (potentially large) I/O to copy all 'linear_chunks'
1080	 * from the exception store to the origin
1081	 */
1082	io_size = linear_chunks * s->store->chunk_size;
1083
1084	dest.bdev = s->origin->bdev;
1085	dest.sector = chunk_to_sector(s->store, old_chunk);
1086	dest.count = min(io_size, get_dev_size(dest.bdev) - dest.sector);
1087
1088	src.bdev = s->cow->bdev;
1089	src.sector = chunk_to_sector(s->store, new_chunk);
1090	src.count = dest.count;
1091
1092	/*
1093	 * Reallocate any exceptions needed in other snapshots then
1094	 * wait for the pending exceptions to complete.
1095	 * Each time any pending exception (globally on the system)
1096	 * completes we are woken and repeat the process to find out
1097	 * if we can proceed.  While this may not seem a particularly
1098	 * efficient algorithm, it is not expected to have any
1099	 * significant impact on performance.
1100	 */
1101	previous_count = read_pending_exceptions_done_count();
1102	while (origin_write_extent(s, dest.sector, io_size)) {
1103		wait_event(_pending_exceptions_done,
1104			   (read_pending_exceptions_done_count() !=
1105			    previous_count));
1106		/* Retry after the wait, until all exceptions are done. */
1107		previous_count = read_pending_exceptions_done_count();
1108	}
1109
1110	down_write(&s->lock);
1111	s->first_merging_chunk = old_chunk;
1112	s->num_merging_chunks = linear_chunks;
1113	up_write(&s->lock);
1114
1115	/* Wait until writes to all 'linear_chunks' drain */
1116	for (i = 0; i < linear_chunks; i++)
1117		__check_for_conflicting_io(s, old_chunk + i);
1118
1119	dm_kcopyd_copy(s->kcopyd_client, &src, 1, &dest, 0, merge_callback, s);
1120	return;
1121
1122shut:
1123	merge_shutdown(s);
1124}
1125
1126static void error_bios(struct bio *bio);
1127
1128static void merge_callback(int read_err, unsigned long write_err, void *context)
1129{
1130	struct dm_snapshot *s = context;
1131	struct bio *b = NULL;
1132
1133	if (read_err || write_err) {
1134		if (read_err)
1135			DMERR("Read error: shutting down merge.");
1136		else
1137			DMERR("Write error: shutting down merge.");
1138		goto shut;
1139	}
1140
1141	if (blkdev_issue_flush(s->origin->bdev) < 0) {
1142		DMERR("Flush after merge failed: shutting down merge");
1143		goto shut;
1144	}
1145
1146	if (s->store->type->commit_merge(s->store,
1147					 s->num_merging_chunks) < 0) {
1148		DMERR("Write error in exception store: shutting down merge");
1149		goto shut;
1150	}
1151
1152	if (remove_single_exception_chunk(s) < 0)
1153		goto shut;
1154
1155	snapshot_merge_next_chunks(s);
1156
1157	return;
1158
1159shut:
1160	down_write(&s->lock);
1161	s->merge_failed = true;
1162	b = __release_queued_bios_after_merge(s);
1163	up_write(&s->lock);
1164	error_bios(b);
1165
1166	merge_shutdown(s);
1167}
1168
1169static void start_merge(struct dm_snapshot *s)
1170{
1171	if (!test_and_set_bit(RUNNING_MERGE, &s->state_bits))
1172		snapshot_merge_next_chunks(s);
1173}
1174
 
 
 
 
 
 
 
1175/*
1176 * Stop the merging process and wait until it finishes.
1177 */
1178static void stop_merge(struct dm_snapshot *s)
1179{
1180	set_bit(SHUTDOWN_MERGE, &s->state_bits);
1181	wait_on_bit(&s->state_bits, RUNNING_MERGE, TASK_UNINTERRUPTIBLE);
 
1182	clear_bit(SHUTDOWN_MERGE, &s->state_bits);
1183}
1184
1185static int parse_snapshot_features(struct dm_arg_set *as, struct dm_snapshot *s,
1186				   struct dm_target *ti)
1187{
1188	int r;
1189	unsigned int argc;
1190	const char *arg_name;
1191
1192	static const struct dm_arg _args[] = {
1193		{0, 2, "Invalid number of feature arguments"},
1194	};
1195
1196	/*
1197	 * No feature arguments supplied.
1198	 */
1199	if (!as->argc)
1200		return 0;
1201
1202	r = dm_read_arg_group(_args, as, &argc, &ti->error);
1203	if (r)
1204		return -EINVAL;
1205
1206	while (argc && !r) {
1207		arg_name = dm_shift_arg(as);
1208		argc--;
1209
1210		if (!strcasecmp(arg_name, "discard_zeroes_cow"))
1211			s->discard_zeroes_cow = true;
1212
1213		else if (!strcasecmp(arg_name, "discard_passdown_origin"))
1214			s->discard_passdown_origin = true;
1215
1216		else {
1217			ti->error = "Unrecognised feature requested";
1218			r = -EINVAL;
1219			break;
1220		}
1221	}
1222
1223	if (!s->discard_zeroes_cow && s->discard_passdown_origin) {
1224		/*
1225		 * TODO: really these are disjoint.. but ti->num_discard_bios
1226		 * and dm_bio_get_target_bio_nr() require rigid constraints.
1227		 */
1228		ti->error = "discard_passdown_origin feature depends on discard_zeroes_cow";
1229		r = -EINVAL;
1230	}
1231
1232	return r;
1233}
1234
1235/*
1236 * Construct a snapshot mapping:
1237 * <origin_dev> <COW-dev> <p|po|n> <chunk-size> [<# feature args> [<arg>]*]
1238 */
1239static int snapshot_ctr(struct dm_target *ti, unsigned int argc, char **argv)
1240{
1241	struct dm_snapshot *s;
1242	struct dm_arg_set as;
1243	int i;
1244	int r = -EINVAL;
1245	char *origin_path, *cow_path;
1246	unsigned int args_used, num_flush_bios = 1;
1247	blk_mode_t origin_mode = BLK_OPEN_READ;
1248
1249	if (argc < 4) {
1250		ti->error = "requires 4 or more arguments";
1251		r = -EINVAL;
1252		goto bad;
1253	}
1254
1255	if (dm_target_is_snapshot_merge(ti)) {
1256		num_flush_bios = 2;
1257		origin_mode = BLK_OPEN_WRITE;
1258	}
1259
1260	s = kzalloc(sizeof(*s), GFP_KERNEL);
1261	if (!s) {
1262		ti->error = "Cannot allocate private snapshot structure";
1263		r = -ENOMEM;
1264		goto bad;
1265	}
1266
1267	as.argc = argc;
1268	as.argv = argv;
1269	dm_consume_args(&as, 4);
1270	r = parse_snapshot_features(&as, s, ti);
1271	if (r)
1272		goto bad_features;
1273
1274	origin_path = argv[0];
1275	argv++;
1276	argc--;
1277
1278	r = dm_get_device(ti, origin_path, origin_mode, &s->origin);
1279	if (r) {
1280		ti->error = "Cannot get origin device";
1281		goto bad_origin;
1282	}
1283
1284	cow_path = argv[0];
1285	argv++;
1286	argc--;
1287
1288	r = dm_get_device(ti, cow_path, dm_table_get_mode(ti->table), &s->cow);
1289	if (r) {
1290		ti->error = "Cannot get COW device";
1291		goto bad_cow;
1292	}
1293	if (s->cow->bdev && s->cow->bdev == s->origin->bdev) {
1294		ti->error = "COW device cannot be the same as origin device";
1295		r = -EINVAL;
1296		goto bad_store;
1297	}
1298
1299	r = dm_exception_store_create(ti, argc, argv, s, &args_used, &s->store);
1300	if (r) {
1301		ti->error = "Couldn't create exception store";
1302		r = -EINVAL;
1303		goto bad_store;
1304	}
1305
1306	argv += args_used;
1307	argc -= args_used;
1308
1309	s->ti = ti;
1310	s->valid = 1;
1311	s->snapshot_overflowed = 0;
1312	s->active = 0;
1313	atomic_set(&s->pending_exceptions_count, 0);
1314	spin_lock_init(&s->pe_allocation_lock);
1315	s->exception_start_sequence = 0;
1316	s->exception_complete_sequence = 0;
1317	s->out_of_order_tree = RB_ROOT;
1318	init_rwsem(&s->lock);
1319	INIT_LIST_HEAD(&s->list);
1320	spin_lock_init(&s->pe_lock);
1321	s->state_bits = 0;
1322	s->merge_failed = false;
1323	s->first_merging_chunk = 0;
1324	s->num_merging_chunks = 0;
1325	bio_list_init(&s->bios_queued_during_merge);
1326
1327	/* Allocate hash table for COW data */
1328	if (init_hash_tables(s)) {
1329		ti->error = "Unable to allocate hash table space";
1330		r = -ENOMEM;
1331		goto bad_hash_tables;
1332	}
1333
1334	init_waitqueue_head(&s->in_progress_wait);
1335
1336	s->kcopyd_client = dm_kcopyd_client_create(&dm_kcopyd_throttle);
1337	if (IS_ERR(s->kcopyd_client)) {
1338		r = PTR_ERR(s->kcopyd_client);
1339		ti->error = "Could not create kcopyd client";
1340		goto bad_kcopyd;
1341	}
1342
1343	r = mempool_init_slab_pool(&s->pending_pool, MIN_IOS, pending_cache);
1344	if (r) {
1345		ti->error = "Could not allocate mempool for pending exceptions";
1346		goto bad_pending_pool;
1347	}
1348
 
 
 
 
 
 
 
 
1349	for (i = 0; i < DM_TRACKED_CHUNK_HASH_SIZE; i++)
1350		INIT_HLIST_HEAD(&s->tracked_chunk_hash[i]);
1351
1352	spin_lock_init(&s->tracked_chunk_lock);
1353
1354	ti->private = s;
1355	ti->num_flush_bios = num_flush_bios;
1356	if (s->discard_zeroes_cow)
1357		ti->num_discard_bios = (s->discard_passdown_origin ? 2 : 1);
1358	ti->per_io_data_size = sizeof(struct dm_snap_tracked_chunk);
1359
1360	/* Add snapshot to the list of snapshots for this origin */
1361	/* Exceptions aren't triggered till snapshot_resume() is called */
1362	r = register_snapshot(s);
1363	if (r == -ENOMEM) {
1364		ti->error = "Snapshot origin struct allocation failed";
1365		goto bad_load_and_register;
1366	} else if (r < 0) {
1367		/* invalid handover, register_snapshot has set ti->error */
1368		goto bad_load_and_register;
1369	}
1370
1371	/*
1372	 * Metadata must only be loaded into one table at once, so skip this
1373	 * if metadata will be handed over during resume.
1374	 * Chunk size will be set during the handover - set it to zero to
1375	 * ensure it's ignored.
1376	 */
1377	if (r > 0) {
1378		s->store->chunk_size = 0;
1379		return 0;
1380	}
1381
1382	r = s->store->type->read_metadata(s->store, dm_add_exception,
1383					  (void *)s);
1384	if (r < 0) {
1385		ti->error = "Failed to read snapshot metadata";
1386		goto bad_read_metadata;
1387	} else if (r > 0) {
1388		s->valid = 0;
1389		DMWARN("Snapshot is marked invalid.");
1390	}
1391
1392	if (!s->store->chunk_size) {
1393		ti->error = "Chunk size not set";
1394		r = -EINVAL;
1395		goto bad_read_metadata;
1396	}
1397
1398	r = dm_set_target_max_io_len(ti, s->store->chunk_size);
1399	if (r)
1400		goto bad_read_metadata;
1401
1402	return 0;
1403
1404bad_read_metadata:
1405	unregister_snapshot(s);
 
1406bad_load_and_register:
1407	mempool_exit(&s->pending_pool);
 
 
 
 
1408bad_pending_pool:
1409	dm_kcopyd_client_destroy(s->kcopyd_client);
 
1410bad_kcopyd:
1411	dm_exception_table_exit(&s->pending, pending_cache);
1412	dm_exception_table_exit(&s->complete, exception_cache);
 
1413bad_hash_tables:
1414	dm_exception_store_destroy(s->store);
 
1415bad_store:
1416	dm_put_device(ti, s->cow);
 
1417bad_cow:
1418	dm_put_device(ti, s->origin);
 
1419bad_origin:
1420bad_features:
1421	kfree(s);
 
1422bad:
1423	return r;
1424}
1425
1426static void __free_exceptions(struct dm_snapshot *s)
1427{
1428	dm_kcopyd_client_destroy(s->kcopyd_client);
1429	s->kcopyd_client = NULL;
1430
1431	dm_exception_table_exit(&s->pending, pending_cache);
1432	dm_exception_table_exit(&s->complete, exception_cache);
1433}
1434
1435static void __handover_exceptions(struct dm_snapshot *snap_src,
1436				  struct dm_snapshot *snap_dest)
1437{
1438	union {
1439		struct dm_exception_table table_swap;
1440		struct dm_exception_store *store_swap;
1441	} u;
1442
1443	/*
1444	 * Swap all snapshot context information between the two instances.
1445	 */
1446	u.table_swap = snap_dest->complete;
1447	snap_dest->complete = snap_src->complete;
1448	snap_src->complete = u.table_swap;
1449
1450	u.store_swap = snap_dest->store;
1451	snap_dest->store = snap_src->store;
1452	snap_dest->store->userspace_supports_overflow = u.store_swap->userspace_supports_overflow;
1453	snap_src->store = u.store_swap;
1454
1455	snap_dest->store->snap = snap_dest;
1456	snap_src->store->snap = snap_src;
1457
1458	snap_dest->ti->max_io_len = snap_dest->store->chunk_size;
1459	snap_dest->valid = snap_src->valid;
1460	snap_dest->snapshot_overflowed = snap_src->snapshot_overflowed;
1461
1462	/*
1463	 * Set source invalid to ensure it receives no further I/O.
1464	 */
1465	snap_src->valid = 0;
1466}
1467
1468static void snapshot_dtr(struct dm_target *ti)
1469{
1470#ifdef CONFIG_DM_DEBUG
1471	int i;
1472#endif
1473	struct dm_snapshot *s = ti->private;
1474	struct dm_snapshot *snap_src = NULL, *snap_dest = NULL;
1475
1476	down_read(&_origins_lock);
1477	/* Check whether exception handover must be cancelled */
1478	(void) __find_snapshots_sharing_cow(s, &snap_src, &snap_dest, NULL);
1479	if (snap_src && snap_dest && (s == snap_src)) {
1480		down_write(&snap_dest->lock);
1481		snap_dest->valid = 0;
1482		up_write(&snap_dest->lock);
1483		DMERR("Cancelling snapshot handover.");
1484	}
1485	up_read(&_origins_lock);
1486
1487	if (dm_target_is_snapshot_merge(ti))
1488		stop_merge(s);
1489
1490	/* Prevent further origin writes from using this snapshot. */
1491	/* After this returns there can be no new kcopyd jobs. */
1492	unregister_snapshot(s);
1493
1494	while (atomic_read(&s->pending_exceptions_count))
1495		fsleep(1000);
1496	/*
1497	 * Ensure instructions in mempool_exit aren't reordered
1498	 * before atomic_read.
1499	 */
1500	smp_mb();
1501
1502#ifdef CONFIG_DM_DEBUG
1503	for (i = 0; i < DM_TRACKED_CHUNK_HASH_SIZE; i++)
1504		BUG_ON(!hlist_empty(&s->tracked_chunk_hash[i]));
1505#endif
1506
 
 
1507	__free_exceptions(s);
1508
1509	mempool_exit(&s->pending_pool);
1510
1511	dm_exception_store_destroy(s->store);
1512
1513	dm_put_device(ti, s->cow);
1514
1515	dm_put_device(ti, s->origin);
1516
1517	WARN_ON(s->in_progress);
1518
1519	kfree(s);
1520}
1521
1522static void account_start_copy(struct dm_snapshot *s)
1523{
1524	spin_lock(&s->in_progress_wait.lock);
1525	s->in_progress++;
1526	spin_unlock(&s->in_progress_wait.lock);
1527}
1528
1529static void account_end_copy(struct dm_snapshot *s)
1530{
1531	spin_lock(&s->in_progress_wait.lock);
1532	BUG_ON(!s->in_progress);
1533	s->in_progress--;
1534	if (likely(s->in_progress <= cow_threshold) &&
1535	    unlikely(waitqueue_active(&s->in_progress_wait)))
1536		wake_up_locked(&s->in_progress_wait);
1537	spin_unlock(&s->in_progress_wait.lock);
1538}
1539
1540static bool wait_for_in_progress(struct dm_snapshot *s, bool unlock_origins)
1541{
1542	if (unlikely(s->in_progress > cow_threshold)) {
1543		spin_lock(&s->in_progress_wait.lock);
1544		if (likely(s->in_progress > cow_threshold)) {
1545			/*
1546			 * NOTE: this throttle doesn't account for whether
1547			 * the caller is servicing an IO that will trigger a COW
1548			 * so excess throttling may result for chunks not required
1549			 * to be COW'd.  But if cow_threshold was reached, extra
1550			 * throttling is unlikely to negatively impact performance.
1551			 */
1552			DECLARE_WAITQUEUE(wait, current);
1553
1554			__add_wait_queue(&s->in_progress_wait, &wait);
1555			__set_current_state(TASK_UNINTERRUPTIBLE);
1556			spin_unlock(&s->in_progress_wait.lock);
1557			if (unlock_origins)
1558				up_read(&_origins_lock);
1559			io_schedule();
1560			remove_wait_queue(&s->in_progress_wait, &wait);
1561			return false;
1562		}
1563		spin_unlock(&s->in_progress_wait.lock);
1564	}
1565	return true;
1566}
1567
1568/*
1569 * Flush a list of buffers.
1570 */
1571static void flush_bios(struct bio *bio)
1572{
1573	struct bio *n;
1574
1575	while (bio) {
1576		n = bio->bi_next;
1577		bio->bi_next = NULL;
1578		submit_bio_noacct(bio);
1579		bio = n;
1580	}
1581}
1582
1583static int do_origin(struct dm_dev *origin, struct bio *bio, bool limit);
1584
1585/*
1586 * Flush a list of buffers.
1587 */
1588static void retry_origin_bios(struct dm_snapshot *s, struct bio *bio)
1589{
1590	struct bio *n;
1591	int r;
1592
1593	while (bio) {
1594		n = bio->bi_next;
1595		bio->bi_next = NULL;
1596		r = do_origin(s->origin, bio, false);
1597		if (r == DM_MAPIO_REMAPPED)
1598			submit_bio_noacct(bio);
1599		bio = n;
1600	}
1601}
1602
1603/*
1604 * Error a list of buffers.
1605 */
1606static void error_bios(struct bio *bio)
1607{
1608	struct bio *n;
1609
1610	while (bio) {
1611		n = bio->bi_next;
1612		bio->bi_next = NULL;
1613		bio_io_error(bio);
1614		bio = n;
1615	}
1616}
1617
1618static void __invalidate_snapshot(struct dm_snapshot *s, int err)
1619{
1620	if (!s->valid)
1621		return;
1622
1623	if (err == -EIO)
1624		DMERR("Invalidating snapshot: Error reading/writing.");
1625	else if (err == -ENOMEM)
1626		DMERR("Invalidating snapshot: Unable to allocate exception.");
1627
1628	if (s->store->type->drop_snapshot)
1629		s->store->type->drop_snapshot(s->store);
1630
1631	s->valid = 0;
1632
1633	dm_table_event(s->ti->table);
1634}
1635
1636static void invalidate_snapshot(struct dm_snapshot *s, int err)
1637{
1638	down_write(&s->lock);
1639	__invalidate_snapshot(s, err);
1640	up_write(&s->lock);
1641}
1642
1643static void pending_complete(void *context, int success)
1644{
1645	struct dm_snap_pending_exception *pe = context;
1646	struct dm_exception *e;
1647	struct dm_snapshot *s = pe->snap;
1648	struct bio *origin_bios = NULL;
1649	struct bio *snapshot_bios = NULL;
1650	struct bio *full_bio = NULL;
1651	struct dm_exception_table_lock lock;
1652	int error = 0;
1653
1654	dm_exception_table_lock_init(s, pe->e.old_chunk, &lock);
1655
1656	if (!success) {
1657		/* Read/write error - snapshot is unusable */
1658		invalidate_snapshot(s, -EIO);
 
1659		error = 1;
1660
1661		dm_exception_table_lock(&lock);
1662		goto out;
1663	}
1664
1665	e = alloc_completed_exception(GFP_NOIO);
1666	if (!e) {
1667		invalidate_snapshot(s, -ENOMEM);
 
1668		error = 1;
1669
1670		dm_exception_table_lock(&lock);
1671		goto out;
1672	}
1673	*e = pe->e;
1674
1675	down_read(&s->lock);
1676	dm_exception_table_lock(&lock);
1677	if (!s->valid) {
1678		up_read(&s->lock);
1679		free_completed_exception(e);
1680		error = 1;
1681
1682		goto out;
1683	}
1684
 
 
 
1685	/*
1686	 * Add a proper exception. After inserting the completed exception all
1687	 * subsequent snapshot reads to this chunk will be redirected to the
1688	 * COW device.  This ensures that we do not starve. Moreover, as long
1689	 * as the pending exception exists, neither origin writes nor snapshot
1690	 * merging can overwrite the chunk in origin.
1691	 */
1692	dm_insert_exception(&s->complete, e);
1693	up_read(&s->lock);
1694
1695	/* Wait for conflicting reads to drain */
1696	if (__chunk_is_tracked(s, pe->e.old_chunk)) {
1697		dm_exception_table_unlock(&lock);
1698		__check_for_conflicting_io(s, pe->e.old_chunk);
1699		dm_exception_table_lock(&lock);
1700	}
1701
1702out:
1703	/* Remove the in-flight exception from the list */
1704	dm_remove_exception(&pe->e);
1705
1706	dm_exception_table_unlock(&lock);
1707
1708	snapshot_bios = bio_list_get(&pe->snapshot_bios);
1709	origin_bios = bio_list_get(&pe->origin_bios);
1710	full_bio = pe->full_bio;
1711	if (full_bio)
1712		full_bio->bi_end_io = pe->full_bio_end_io;
 
 
 
 
1713	increment_pending_exceptions_done_count();
1714
 
 
1715	/* Submit any pending write bios */
1716	if (error) {
1717		if (full_bio)
1718			bio_io_error(full_bio);
1719		error_bios(snapshot_bios);
1720	} else {
1721		if (full_bio)
1722			bio_endio(full_bio);
1723		flush_bios(snapshot_bios);
1724	}
1725
1726	retry_origin_bios(s, origin_bios);
1727
1728	free_pending_exception(pe);
1729}
1730
1731static void complete_exception(struct dm_snap_pending_exception *pe)
1732{
1733	struct dm_snapshot *s = pe->snap;
1734
1735	/* Update the metadata if we are persistent */
1736	s->store->type->commit_exception(s->store, &pe->e, !pe->copy_error,
1737					 pending_complete, pe);
1738}
1739
1740/*
1741 * Called when the copy I/O has finished.  kcopyd actually runs
1742 * this code so don't block.
1743 */
1744static void copy_callback(int read_err, unsigned long write_err, void *context)
1745{
1746	struct dm_snap_pending_exception *pe = context;
1747	struct dm_snapshot *s = pe->snap;
1748
1749	pe->copy_error = read_err || write_err;
 
1750
1751	if (pe->exception_sequence == s->exception_complete_sequence) {
1752		struct rb_node *next;
1753
1754		s->exception_complete_sequence++;
1755		complete_exception(pe);
1756
1757		next = rb_first(&s->out_of_order_tree);
1758		while (next) {
1759			pe = rb_entry(next, struct dm_snap_pending_exception,
1760					out_of_order_node);
1761			if (pe->exception_sequence != s->exception_complete_sequence)
1762				break;
1763			next = rb_next(next);
1764			s->exception_complete_sequence++;
1765			rb_erase(&pe->out_of_order_node, &s->out_of_order_tree);
1766			complete_exception(pe);
1767			cond_resched();
1768		}
1769	} else {
1770		struct rb_node *parent = NULL;
1771		struct rb_node **p = &s->out_of_order_tree.rb_node;
1772		struct dm_snap_pending_exception *pe2;
1773
1774		while (*p) {
1775			pe2 = rb_entry(*p, struct dm_snap_pending_exception, out_of_order_node);
1776			parent = *p;
1777
1778			BUG_ON(pe->exception_sequence == pe2->exception_sequence);
1779			if (pe->exception_sequence < pe2->exception_sequence)
1780				p = &((*p)->rb_left);
1781			else
1782				p = &((*p)->rb_right);
1783		}
1784
1785		rb_link_node(&pe->out_of_order_node, parent, p);
1786		rb_insert_color(&pe->out_of_order_node, &s->out_of_order_tree);
1787	}
1788	account_end_copy(s);
1789}
1790
1791/*
1792 * Dispatches the copy operation to kcopyd.
1793 */
1794static void start_copy(struct dm_snap_pending_exception *pe)
1795{
1796	struct dm_snapshot *s = pe->snap;
1797	struct dm_io_region src, dest;
1798	struct block_device *bdev = s->origin->bdev;
1799	sector_t dev_size;
1800
1801	dev_size = get_dev_size(bdev);
1802
1803	src.bdev = bdev;
1804	src.sector = chunk_to_sector(s->store, pe->e.old_chunk);
1805	src.count = min((sector_t)s->store->chunk_size, dev_size - src.sector);
1806
1807	dest.bdev = s->cow->bdev;
1808	dest.sector = chunk_to_sector(s->store, pe->e.new_chunk);
1809	dest.count = src.count;
1810
1811	/* Hand over to kcopyd */
1812	account_start_copy(s);
1813	dm_kcopyd_copy(s->kcopyd_client, &src, 1, &dest, 0, copy_callback, pe);
1814}
1815
1816static void full_bio_end_io(struct bio *bio)
1817{
1818	void *callback_data = bio->bi_private;
1819
1820	dm_kcopyd_do_callback(callback_data, 0, bio->bi_status ? 1 : 0);
1821}
1822
1823static void start_full_bio(struct dm_snap_pending_exception *pe,
1824			   struct bio *bio)
1825{
1826	struct dm_snapshot *s = pe->snap;
1827	void *callback_data;
1828
1829	pe->full_bio = bio;
1830	pe->full_bio_end_io = bio->bi_end_io;
 
1831
1832	account_start_copy(s);
1833	callback_data = dm_kcopyd_prepare_callback(s->kcopyd_client,
1834						   copy_callback, pe);
1835
1836	bio->bi_end_io = full_bio_end_io;
1837	bio->bi_private = callback_data;
1838
1839	submit_bio_noacct(bio);
1840}
1841
1842static struct dm_snap_pending_exception *
1843__lookup_pending_exception(struct dm_snapshot *s, chunk_t chunk)
1844{
1845	struct dm_exception *e = dm_lookup_exception(&s->pending, chunk);
1846
1847	if (!e)
1848		return NULL;
1849
1850	return container_of(e, struct dm_snap_pending_exception, e);
1851}
1852
1853/*
1854 * Inserts a pending exception into the pending table.
 
 
1855 *
1856 * NOTE: a write lock must be held on the chunk's pending exception table slot
1857 * before calling this.
1858 */
1859static struct dm_snap_pending_exception *
1860__insert_pending_exception(struct dm_snapshot *s,
1861			   struct dm_snap_pending_exception *pe, chunk_t chunk)
1862{
 
 
 
 
 
 
 
 
1863	pe->e.old_chunk = chunk;
1864	bio_list_init(&pe->origin_bios);
1865	bio_list_init(&pe->snapshot_bios);
1866	pe->started = 0;
1867	pe->full_bio = NULL;
1868
1869	spin_lock(&s->pe_allocation_lock);
1870	if (s->store->type->prepare_exception(s->store, &pe->e)) {
1871		spin_unlock(&s->pe_allocation_lock);
1872		free_pending_exception(pe);
1873		return NULL;
1874	}
1875
1876	pe->exception_sequence = s->exception_start_sequence++;
1877	spin_unlock(&s->pe_allocation_lock);
1878
1879	dm_insert_exception(&s->pending, &pe->e);
1880
1881	return pe;
1882}
1883
1884/*
1885 * Looks to see if this snapshot already has a pending exception
1886 * for this chunk, otherwise it allocates a new one and inserts
1887 * it into the pending table.
1888 *
1889 * NOTE: a write lock must be held on the chunk's pending exception table slot
1890 * before calling this.
1891 */
1892static struct dm_snap_pending_exception *
1893__find_pending_exception(struct dm_snapshot *s,
1894			 struct dm_snap_pending_exception *pe, chunk_t chunk)
1895{
1896	struct dm_snap_pending_exception *pe2;
1897
1898	pe2 = __lookup_pending_exception(s, chunk);
1899	if (pe2) {
1900		free_pending_exception(pe);
1901		return pe2;
1902	}
1903
1904	return __insert_pending_exception(s, pe, chunk);
1905}
1906
1907static void remap_exception(struct dm_snapshot *s, struct dm_exception *e,
1908			    struct bio *bio, chunk_t chunk)
1909{
1910	bio_set_dev(bio, s->cow->bdev);
1911	bio->bi_iter.bi_sector =
1912		chunk_to_sector(s->store, dm_chunk_number(e->new_chunk) +
1913				(chunk - e->old_chunk)) +
1914		(bio->bi_iter.bi_sector & s->store->chunk_mask);
 
1915}
1916
1917static void zero_callback(int read_err, unsigned long write_err, void *context)
1918{
1919	struct bio *bio = context;
1920	struct dm_snapshot *s = bio->bi_private;
1921
1922	account_end_copy(s);
1923	bio->bi_status = write_err ? BLK_STS_IOERR : 0;
1924	bio_endio(bio);
1925}
1926
1927static void zero_exception(struct dm_snapshot *s, struct dm_exception *e,
1928			   struct bio *bio, chunk_t chunk)
1929{
1930	struct dm_io_region dest;
1931
1932	dest.bdev = s->cow->bdev;
1933	dest.sector = bio->bi_iter.bi_sector;
1934	dest.count = s->store->chunk_size;
1935
1936	account_start_copy(s);
1937	WARN_ON_ONCE(bio->bi_private);
1938	bio->bi_private = s;
1939	dm_kcopyd_zero(s->kcopyd_client, 1, &dest, 0, zero_callback, bio);
1940}
1941
1942static bool io_overlaps_chunk(struct dm_snapshot *s, struct bio *bio)
1943{
1944	return bio->bi_iter.bi_size ==
1945		(s->store->chunk_size << SECTOR_SHIFT);
1946}
1947
1948static int snapshot_map(struct dm_target *ti, struct bio *bio)
1949{
1950	struct dm_exception *e;
1951	struct dm_snapshot *s = ti->private;
1952	int r = DM_MAPIO_REMAPPED;
1953	chunk_t chunk;
1954	struct dm_snap_pending_exception *pe = NULL;
1955	struct dm_exception_table_lock lock;
1956
1957	init_tracked_chunk(bio);
1958
1959	if (bio->bi_opf & REQ_PREFLUSH) {
1960		bio_set_dev(bio, s->cow->bdev);
1961		return DM_MAPIO_REMAPPED;
1962	}
1963
1964	chunk = sector_to_chunk(s->store, bio->bi_iter.bi_sector);
1965	dm_exception_table_lock_init(s, chunk, &lock);
1966
1967	/* Full snapshots are not usable */
1968	/* To get here the table must be live so s->active is always set. */
1969	if (!s->valid)
1970		return DM_MAPIO_KILL;
1971
1972	if (bio_data_dir(bio) == WRITE) {
1973		while (unlikely(!wait_for_in_progress(s, false)))
1974			; /* wait_for_in_progress() has slept */
1975	}
1976
1977	down_read(&s->lock);
1978	dm_exception_table_lock(&lock);
1979
1980	if (!s->valid || (unlikely(s->snapshot_overflowed) &&
1981	    bio_data_dir(bio) == WRITE)) {
1982		r = DM_MAPIO_KILL;
1983		goto out_unlock;
1984	}
1985
1986	if (unlikely(bio_op(bio) == REQ_OP_DISCARD)) {
1987		if (s->discard_passdown_origin && dm_bio_get_target_bio_nr(bio)) {
1988			/*
1989			 * passdown discard to origin (without triggering
1990			 * snapshot exceptions via do_origin; doing so would
1991			 * defeat the goal of freeing space in origin that is
1992			 * implied by the "discard_passdown_origin" feature)
1993			 */
1994			bio_set_dev(bio, s->origin->bdev);
1995			track_chunk(s, bio, chunk);
1996			goto out_unlock;
1997		}
1998		/* discard to snapshot (target_bio_nr == 0) zeroes exceptions */
1999	}
2000
2001	/* If the block is already remapped - use that, else remap it */
2002	e = dm_lookup_exception(&s->complete, chunk);
2003	if (e) {
2004		remap_exception(s, e, bio, chunk);
2005		if (unlikely(bio_op(bio) == REQ_OP_DISCARD) &&
2006		    io_overlaps_chunk(s, bio)) {
2007			dm_exception_table_unlock(&lock);
2008			up_read(&s->lock);
2009			zero_exception(s, e, bio, chunk);
2010			r = DM_MAPIO_SUBMITTED; /* discard is not issued */
2011			goto out;
2012		}
2013		goto out_unlock;
2014	}
2015
2016	if (unlikely(bio_op(bio) == REQ_OP_DISCARD)) {
2017		/*
2018		 * If no exception exists, complete discard immediately
2019		 * otherwise it'll trigger copy-out.
2020		 */
2021		bio_endio(bio);
2022		r = DM_MAPIO_SUBMITTED;
2023		goto out_unlock;
2024	}
2025
2026	/*
2027	 * Write to snapshot - higher level takes care of RW/RO
2028	 * flags so we should only get this if we are
2029	 * writable.
2030	 */
2031	if (bio_data_dir(bio) == WRITE) {
2032		pe = __lookup_pending_exception(s, chunk);
2033		if (!pe) {
2034			dm_exception_table_unlock(&lock);
2035			pe = alloc_pending_exception(s);
2036			dm_exception_table_lock(&lock);
 
 
 
 
 
 
2037
2038			e = dm_lookup_exception(&s->complete, chunk);
2039			if (e) {
2040				free_pending_exception(pe);
2041				remap_exception(s, e, bio, chunk);
2042				goto out_unlock;
2043			}
2044
2045			pe = __find_pending_exception(s, pe, chunk);
2046			if (!pe) {
2047				dm_exception_table_unlock(&lock);
2048				up_read(&s->lock);
2049
2050				down_write(&s->lock);
2051
2052				if (s->store->userspace_supports_overflow) {
2053					if (s->valid && !s->snapshot_overflowed) {
2054						s->snapshot_overflowed = 1;
2055						DMERR("Snapshot overflowed: Unable to allocate exception.");
2056					}
2057				} else
2058					__invalidate_snapshot(s, -ENOMEM);
2059				up_write(&s->lock);
2060
2061				r = DM_MAPIO_KILL;
2062				goto out;
2063			}
2064		}
2065
2066		remap_exception(s, &pe->e, bio, chunk);
2067
2068		r = DM_MAPIO_SUBMITTED;
2069
2070		if (!pe->started && io_overlaps_chunk(s, bio)) {
 
2071			pe->started = 1;
2072
2073			dm_exception_table_unlock(&lock);
2074			up_read(&s->lock);
2075
2076			start_full_bio(pe, bio);
2077			goto out;
2078		}
2079
2080		bio_list_add(&pe->snapshot_bios, bio);
2081
2082		if (!pe->started) {
2083			/* this is protected by the exception table lock */
2084			pe->started = 1;
2085
2086			dm_exception_table_unlock(&lock);
2087			up_read(&s->lock);
2088
2089			start_copy(pe);
2090			goto out;
2091		}
2092	} else {
2093		bio_set_dev(bio, s->origin->bdev);
2094		track_chunk(s, bio, chunk);
2095	}
2096
2097out_unlock:
2098	dm_exception_table_unlock(&lock);
2099	up_read(&s->lock);
2100out:
2101	return r;
2102}
2103
2104/*
2105 * A snapshot-merge target behaves like a combination of a snapshot
2106 * target and a snapshot-origin target.  It only generates new
2107 * exceptions in other snapshots and not in the one that is being
2108 * merged.
2109 *
2110 * For each chunk, if there is an existing exception, it is used to
2111 * redirect I/O to the cow device.  Otherwise I/O is sent to the origin,
2112 * which in turn might generate exceptions in other snapshots.
2113 * If merging is currently taking place on the chunk in question, the
2114 * I/O is deferred by adding it to s->bios_queued_during_merge.
2115 */
2116static int snapshot_merge_map(struct dm_target *ti, struct bio *bio)
 
2117{
2118	struct dm_exception *e;
2119	struct dm_snapshot *s = ti->private;
2120	int r = DM_MAPIO_REMAPPED;
2121	chunk_t chunk;
2122
2123	init_tracked_chunk(bio);
2124
2125	if (bio->bi_opf & REQ_PREFLUSH) {
2126		if (!dm_bio_get_target_bio_nr(bio))
2127			bio_set_dev(bio, s->origin->bdev);
2128		else
2129			bio_set_dev(bio, s->cow->bdev);
 
2130		return DM_MAPIO_REMAPPED;
2131	}
2132
2133	if (unlikely(bio_op(bio) == REQ_OP_DISCARD)) {
2134		/* Once merging, discards no longer effect change */
2135		bio_endio(bio);
2136		return DM_MAPIO_SUBMITTED;
2137	}
2138
2139	chunk = sector_to_chunk(s->store, bio->bi_iter.bi_sector);
2140
2141	down_write(&s->lock);
2142
2143	/* Full merging snapshots are redirected to the origin */
2144	if (!s->valid)
2145		goto redirect_to_origin;
2146
2147	/* If the block is already remapped - use that */
2148	e = dm_lookup_exception(&s->complete, chunk);
2149	if (e) {
2150		/* Queue writes overlapping with chunks being merged */
2151		if (bio_data_dir(bio) == WRITE &&
2152		    chunk >= s->first_merging_chunk &&
2153		    chunk < (s->first_merging_chunk +
2154			     s->num_merging_chunks)) {
2155			bio_set_dev(bio, s->origin->bdev);
2156			bio_list_add(&s->bios_queued_during_merge, bio);
2157			r = DM_MAPIO_SUBMITTED;
2158			goto out_unlock;
2159		}
2160
2161		remap_exception(s, e, bio, chunk);
2162
2163		if (bio_data_dir(bio) == WRITE)
2164			track_chunk(s, bio, chunk);
2165		goto out_unlock;
2166	}
2167
2168redirect_to_origin:
2169	bio_set_dev(bio, s->origin->bdev);
2170
2171	if (bio_data_dir(bio) == WRITE) {
2172		up_write(&s->lock);
2173		return do_origin(s->origin, bio, false);
2174	}
2175
2176out_unlock:
2177	up_write(&s->lock);
2178
2179	return r;
2180}
2181
2182static int snapshot_end_io(struct dm_target *ti, struct bio *bio,
2183		blk_status_t *error)
2184{
2185	struct dm_snapshot *s = ti->private;
 
2186
2187	if (is_bio_tracked(bio))
2188		stop_tracking_chunk(s, bio);
2189
2190	return DM_ENDIO_DONE;
2191}
2192
2193static void snapshot_merge_presuspend(struct dm_target *ti)
2194{
2195	struct dm_snapshot *s = ti->private;
2196
2197	stop_merge(s);
2198}
2199
2200static int snapshot_preresume(struct dm_target *ti)
2201{
2202	int r = 0;
2203	struct dm_snapshot *s = ti->private;
2204	struct dm_snapshot *snap_src = NULL, *snap_dest = NULL;
2205
2206	down_read(&_origins_lock);
2207	(void) __find_snapshots_sharing_cow(s, &snap_src, &snap_dest, NULL);
2208	if (snap_src && snap_dest) {
2209		down_read(&snap_src->lock);
2210		if (s == snap_src) {
2211			DMERR("Unable to resume snapshot source until handover completes.");
 
2212			r = -EINVAL;
2213		} else if (!dm_suspended(snap_src->ti)) {
2214			DMERR("Unable to perform snapshot handover until source is suspended.");
 
2215			r = -EINVAL;
2216		}
2217		up_read(&snap_src->lock);
2218	}
2219	up_read(&_origins_lock);
2220
2221	return r;
2222}
2223
2224static void snapshot_resume(struct dm_target *ti)
2225{
2226	struct dm_snapshot *s = ti->private;
2227	struct dm_snapshot *snap_src = NULL, *snap_dest = NULL, *snap_merging = NULL;
2228	struct dm_origin *o;
2229	struct mapped_device *origin_md = NULL;
2230	bool must_restart_merging = false;
2231
2232	down_read(&_origins_lock);
2233
2234	o = __lookup_dm_origin(s->origin->bdev);
2235	if (o)
2236		origin_md = dm_table_get_md(o->ti->table);
2237	if (!origin_md) {
2238		(void) __find_snapshots_sharing_cow(s, NULL, NULL, &snap_merging);
2239		if (snap_merging)
2240			origin_md = dm_table_get_md(snap_merging->ti->table);
2241	}
2242	if (origin_md == dm_table_get_md(ti->table))
2243		origin_md = NULL;
2244	if (origin_md) {
2245		if (dm_hold(origin_md))
2246			origin_md = NULL;
2247	}
2248
2249	up_read(&_origins_lock);
2250
2251	if (origin_md) {
2252		dm_internal_suspend_fast(origin_md);
2253		if (snap_merging && test_bit(RUNNING_MERGE, &snap_merging->state_bits)) {
2254			must_restart_merging = true;
2255			stop_merge(snap_merging);
2256		}
2257	}
2258
2259	down_read(&_origins_lock);
2260
2261	(void) __find_snapshots_sharing_cow(s, &snap_src, &snap_dest, NULL);
2262	if (snap_src && snap_dest) {
2263		down_write(&snap_src->lock);
2264		down_write_nested(&snap_dest->lock, SINGLE_DEPTH_NESTING);
2265		__handover_exceptions(snap_src, snap_dest);
2266		up_write(&snap_dest->lock);
2267		up_write(&snap_src->lock);
2268	}
2269
2270	up_read(&_origins_lock);
2271
2272	if (origin_md) {
2273		if (must_restart_merging)
2274			start_merge(snap_merging);
2275		dm_internal_resume_fast(origin_md);
2276		dm_put(origin_md);
2277	}
2278
2279	/* Now we have correct chunk size, reregister */
2280	reregister_snapshot(s);
2281
2282	down_write(&s->lock);
2283	s->active = 1;
2284	up_write(&s->lock);
2285}
2286
2287static uint32_t get_origin_minimum_chunksize(struct block_device *bdev)
2288{
2289	uint32_t min_chunksize;
2290
2291	down_read(&_origins_lock);
2292	min_chunksize = __minimum_chunk_size(__lookup_origin(bdev));
2293	up_read(&_origins_lock);
2294
2295	return min_chunksize;
2296}
2297
2298static void snapshot_merge_resume(struct dm_target *ti)
2299{
2300	struct dm_snapshot *s = ti->private;
2301
2302	/*
2303	 * Handover exceptions from existing snapshot.
2304	 */
2305	snapshot_resume(ti);
2306
2307	/*
2308	 * snapshot-merge acts as an origin, so set ti->max_io_len
2309	 */
2310	ti->max_io_len = get_origin_minimum_chunksize(s->origin->bdev);
2311
2312	start_merge(s);
2313}
2314
2315static void snapshot_status(struct dm_target *ti, status_type_t type,
2316			    unsigned int status_flags, char *result, unsigned int maxlen)
2317{
2318	unsigned int sz = 0;
2319	struct dm_snapshot *snap = ti->private;
2320	unsigned int num_features;
2321
2322	switch (type) {
2323	case STATUSTYPE_INFO:
2324
2325		down_write(&snap->lock);
2326
2327		if (!snap->valid)
2328			DMEMIT("Invalid");
2329		else if (snap->merge_failed)
2330			DMEMIT("Merge failed");
2331		else if (snap->snapshot_overflowed)
2332			DMEMIT("Overflow");
2333		else {
2334			if (snap->store->type->usage) {
2335				sector_t total_sectors, sectors_allocated,
2336					 metadata_sectors;
2337				snap->store->type->usage(snap->store,
2338							 &total_sectors,
2339							 &sectors_allocated,
2340							 &metadata_sectors);
2341				DMEMIT("%llu/%llu %llu",
2342				       (unsigned long long)sectors_allocated,
2343				       (unsigned long long)total_sectors,
2344				       (unsigned long long)metadata_sectors);
2345			} else
 
2346				DMEMIT("Unknown");
2347		}
2348
2349		up_write(&snap->lock);
2350
2351		break;
2352
2353	case STATUSTYPE_TABLE:
2354		/*
2355		 * kdevname returns a static pointer so we need
2356		 * to make private copies if the output is to
2357		 * make sense.
2358		 */
2359		DMEMIT("%s %s", snap->origin->name, snap->cow->name);
2360		sz += snap->store->type->status(snap->store, type, result + sz,
2361						maxlen - sz);
2362		num_features = snap->discard_zeroes_cow + snap->discard_passdown_origin;
2363		if (num_features) {
2364			DMEMIT(" %u", num_features);
2365			if (snap->discard_zeroes_cow)
2366				DMEMIT(" discard_zeroes_cow");
2367			if (snap->discard_passdown_origin)
2368				DMEMIT(" discard_passdown_origin");
2369		}
2370		break;
 
2371
2372	case STATUSTYPE_IMA:
2373		DMEMIT_TARGET_NAME_VERSION(ti->type);
2374		DMEMIT(",snap_origin_name=%s", snap->origin->name);
2375		DMEMIT(",snap_cow_name=%s", snap->cow->name);
2376		DMEMIT(",snap_valid=%c", snap->valid ? 'y' : 'n');
2377		DMEMIT(",snap_merge_failed=%c", snap->merge_failed ? 'y' : 'n');
2378		DMEMIT(",snapshot_overflowed=%c", snap->snapshot_overflowed ? 'y' : 'n');
2379		DMEMIT(";");
2380		break;
2381	}
2382}
2383
2384static int snapshot_iterate_devices(struct dm_target *ti,
2385				    iterate_devices_callout_fn fn, void *data)
2386{
2387	struct dm_snapshot *snap = ti->private;
2388	int r;
2389
2390	r = fn(ti, snap->origin, 0, ti->len, data);
2391
2392	if (!r)
2393		r = fn(ti, snap->cow, 0, get_dev_size(snap->cow->bdev), data);
2394
2395	return r;
2396}
2397
2398static void snapshot_io_hints(struct dm_target *ti, struct queue_limits *limits)
2399{
2400	struct dm_snapshot *snap = ti->private;
2401
2402	if (snap->discard_zeroes_cow) {
2403		struct dm_snapshot *snap_src = NULL, *snap_dest = NULL;
2404
2405		down_read(&_origins_lock);
2406
2407		(void) __find_snapshots_sharing_cow(snap, &snap_src, &snap_dest, NULL);
2408		if (snap_src && snap_dest)
2409			snap = snap_src;
2410
2411		/* All discards are split on chunk_size boundary */
2412		limits->discard_granularity = snap->store->chunk_size;
2413		limits->max_discard_sectors = snap->store->chunk_size;
2414
2415		up_read(&_origins_lock);
2416	}
2417}
2418
2419/*
2420 *---------------------------------------------------------------
2421 * Origin methods
2422 *---------------------------------------------------------------
2423 */
2424/*
2425 * If no exceptions need creating, DM_MAPIO_REMAPPED is returned and any
2426 * supplied bio was ignored.  The caller may submit it immediately.
2427 * (No remapping actually occurs as the origin is always a direct linear
2428 * map.)
2429 *
2430 * If further exceptions are required, DM_MAPIO_SUBMITTED is returned
2431 * and any supplied bio is added to a list to be submitted once all
2432 * the necessary exceptions exist.
2433 */
2434static int __origin_write(struct list_head *snapshots, sector_t sector,
2435			  struct bio *bio)
2436{
2437	int r = DM_MAPIO_REMAPPED;
2438	struct dm_snapshot *snap;
2439	struct dm_exception *e;
2440	struct dm_snap_pending_exception *pe, *pe2;
2441	struct dm_snap_pending_exception *pe_to_start_now = NULL;
2442	struct dm_snap_pending_exception *pe_to_start_last = NULL;
2443	struct dm_exception_table_lock lock;
2444	chunk_t chunk;
2445
2446	/* Do all the snapshots on this origin */
2447	list_for_each_entry(snap, snapshots, list) {
2448		/*
2449		 * Don't make new exceptions in a merging snapshot
2450		 * because it has effectively been deleted
2451		 */
2452		if (dm_target_is_snapshot_merge(snap->ti))
2453			continue;
2454
 
 
 
 
 
 
2455		/* Nothing to do if writing beyond end of snapshot */
2456		if (sector >= dm_table_get_size(snap->ti->table))
2457			continue;
2458
2459		/*
2460		 * Remember, different snapshots can have
2461		 * different chunk sizes.
2462		 */
2463		chunk = sector_to_chunk(snap->store, sector);
2464		dm_exception_table_lock_init(snap, chunk, &lock);
2465
2466		down_read(&snap->lock);
2467		dm_exception_table_lock(&lock);
2468
2469		/* Only deal with valid and active snapshots */
2470		if (!snap->valid || !snap->active)
 
 
2471			goto next_snapshot;
2472
2473		pe = __lookup_pending_exception(snap, chunk);
2474		if (!pe) {
2475			/*
2476			 * Check exception table to see if block is already
2477			 * remapped in this snapshot and trigger an exception
2478			 * if not.
2479			 */
2480			e = dm_lookup_exception(&snap->complete, chunk);
2481			if (e)
2482				goto next_snapshot;
2483
2484			dm_exception_table_unlock(&lock);
2485			pe = alloc_pending_exception(snap);
2486			dm_exception_table_lock(&lock);
2487
2488			pe2 = __lookup_pending_exception(snap, chunk);
 
 
 
2489
2490			if (!pe2) {
2491				e = dm_lookup_exception(&snap->complete, chunk);
2492				if (e) {
2493					free_pending_exception(pe);
2494					goto next_snapshot;
2495				}
2496
2497				pe = __insert_pending_exception(snap, pe, chunk);
2498				if (!pe) {
2499					dm_exception_table_unlock(&lock);
2500					up_read(&snap->lock);
2501
2502					invalidate_snapshot(snap, -ENOMEM);
2503					continue;
2504				}
2505			} else {
2506				free_pending_exception(pe);
2507				pe = pe2;
 
 
 
 
 
 
2508			}
2509		}
2510
2511		r = DM_MAPIO_SUBMITTED;
2512
2513		/*
2514		 * If an origin bio was supplied, queue it to wait for the
2515		 * completion of this exception, and start this one last,
2516		 * at the end of the function.
2517		 */
2518		if (bio) {
2519			bio_list_add(&pe->origin_bios, bio);
2520			bio = NULL;
2521
2522			if (!pe->started) {
2523				pe->started = 1;
2524				pe_to_start_last = pe;
2525			}
2526		}
2527
2528		if (!pe->started) {
2529			pe->started = 1;
2530			pe_to_start_now = pe;
2531		}
2532
2533next_snapshot:
2534		dm_exception_table_unlock(&lock);
2535		up_read(&snap->lock);
2536
2537		if (pe_to_start_now) {
2538			start_copy(pe_to_start_now);
2539			pe_to_start_now = NULL;
2540		}
2541	}
2542
2543	/*
2544	 * Submit the exception against which the bio is queued last,
2545	 * to give the other exceptions a head start.
2546	 */
2547	if (pe_to_start_last)
2548		start_copy(pe_to_start_last);
2549
2550	return r;
2551}
2552
2553/*
2554 * Called on a write from the origin driver.
2555 */
2556static int do_origin(struct dm_dev *origin, struct bio *bio, bool limit)
2557{
2558	struct origin *o;
2559	int r = DM_MAPIO_REMAPPED;
2560
2561again:
2562	down_read(&_origins_lock);
2563	o = __lookup_origin(origin->bdev);
2564	if (o) {
2565		if (limit) {
2566			struct dm_snapshot *s;
2567
2568			list_for_each_entry(s, &o->snapshots, list)
2569				if (unlikely(!wait_for_in_progress(s, true)))
2570					goto again;
2571		}
2572
2573		r = __origin_write(&o->snapshots, bio->bi_iter.bi_sector, bio);
2574	}
2575	up_read(&_origins_lock);
2576
2577	return r;
2578}
2579
2580/*
2581 * Trigger exceptions in all non-merging snapshots.
2582 *
2583 * The chunk size of the merging snapshot may be larger than the chunk
2584 * size of some other snapshot so we may need to reallocate multiple
2585 * chunks in other snapshots.
2586 *
2587 * We scan all the overlapping exceptions in the other snapshots.
2588 * Returns 1 if anything was reallocated and must be waited for,
2589 * otherwise returns 0.
2590 *
2591 * size must be a multiple of merging_snap's chunk_size.
2592 */
2593static int origin_write_extent(struct dm_snapshot *merging_snap,
2594			       sector_t sector, unsigned int size)
2595{
2596	int must_wait = 0;
2597	sector_t n;
2598	struct origin *o;
2599
2600	/*
2601	 * The origin's __minimum_chunk_size() got stored in max_io_len
2602	 * by snapshot_merge_resume().
2603	 */
2604	down_read(&_origins_lock);
2605	o = __lookup_origin(merging_snap->origin->bdev);
2606	for (n = 0; n < size; n += merging_snap->ti->max_io_len)
2607		if (__origin_write(&o->snapshots, sector + n, NULL) ==
2608		    DM_MAPIO_SUBMITTED)
2609			must_wait = 1;
2610	up_read(&_origins_lock);
2611
2612	return must_wait;
2613}
2614
2615/*
2616 * Origin: maps a linear range of a device, with hooks for snapshotting.
2617 */
2618
2619/*
2620 * Construct an origin mapping: <dev_path>
2621 * The context for an origin is merely a 'struct dm_dev *'
2622 * pointing to the real device.
2623 */
2624static int origin_ctr(struct dm_target *ti, unsigned int argc, char **argv)
2625{
2626	int r;
2627	struct dm_origin *o;
2628
2629	if (argc != 1) {
2630		ti->error = "origin: incorrect number of arguments";
2631		return -EINVAL;
2632	}
2633
2634	o = kmalloc(sizeof(struct dm_origin), GFP_KERNEL);
2635	if (!o) {
2636		ti->error = "Cannot allocate private origin structure";
2637		r = -ENOMEM;
2638		goto bad_alloc;
2639	}
2640
2641	r = dm_get_device(ti, argv[0], dm_table_get_mode(ti->table), &o->dev);
2642	if (r) {
2643		ti->error = "Cannot get target device";
2644		goto bad_open;
2645	}
2646
2647	o->ti = ti;
2648	ti->private = o;
2649	ti->num_flush_bios = 1;
2650
2651	return 0;
2652
2653bad_open:
2654	kfree(o);
2655bad_alloc:
2656	return r;
2657}
2658
2659static void origin_dtr(struct dm_target *ti)
2660{
2661	struct dm_origin *o = ti->private;
2662
2663	dm_put_device(ti, o->dev);
2664	kfree(o);
2665}
2666
2667static int origin_map(struct dm_target *ti, struct bio *bio)
 
2668{
2669	struct dm_origin *o = ti->private;
2670	unsigned int available_sectors;
2671
2672	bio_set_dev(bio, o->dev->bdev);
2673
2674	if (unlikely(bio->bi_opf & REQ_PREFLUSH))
2675		return DM_MAPIO_REMAPPED;
2676
2677	if (bio_data_dir(bio) != WRITE)
2678		return DM_MAPIO_REMAPPED;
2679
2680	available_sectors = o->split_boundary -
2681		((unsigned int)bio->bi_iter.bi_sector & (o->split_boundary - 1));
2682
2683	if (bio_sectors(bio) > available_sectors)
2684		dm_accept_partial_bio(bio, available_sectors);
2685
2686	/* Only tell snapshots if this is a write */
2687	return do_origin(o->dev, bio, true);
2688}
2689
2690/*
2691 * Set the target "max_io_len" field to the minimum of all the snapshots'
2692 * chunk sizes.
2693 */
2694static void origin_resume(struct dm_target *ti)
2695{
2696	struct dm_origin *o = ti->private;
2697
2698	o->split_boundary = get_origin_minimum_chunksize(o->dev->bdev);
2699
2700	down_write(&_origins_lock);
2701	__insert_dm_origin(o);
2702	up_write(&_origins_lock);
2703}
2704
2705static void origin_postsuspend(struct dm_target *ti)
2706{
2707	struct dm_origin *o = ti->private;
2708
2709	down_write(&_origins_lock);
2710	__remove_dm_origin(o);
2711	up_write(&_origins_lock);
2712}
2713
2714static void origin_status(struct dm_target *ti, status_type_t type,
2715			  unsigned int status_flags, char *result, unsigned int maxlen)
2716{
2717	struct dm_origin *o = ti->private;
2718
2719	switch (type) {
2720	case STATUSTYPE_INFO:
2721		result[0] = '\0';
2722		break;
2723
2724	case STATUSTYPE_TABLE:
2725		snprintf(result, maxlen, "%s", o->dev->name);
2726		break;
2727	case STATUSTYPE_IMA:
2728		result[0] = '\0';
2729		break;
2730	}
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
2731}
2732
2733static int origin_iterate_devices(struct dm_target *ti,
2734				  iterate_devices_callout_fn fn, void *data)
2735{
2736	struct dm_origin *o = ti->private;
2737
2738	return fn(ti, o->dev, 0, ti->len, data);
2739}
2740
2741static struct target_type origin_target = {
2742	.name    = "snapshot-origin",
2743	.version = {1, 9, 0},
2744	.module  = THIS_MODULE,
2745	.ctr     = origin_ctr,
2746	.dtr     = origin_dtr,
2747	.map     = origin_map,
2748	.resume  = origin_resume,
2749	.postsuspend = origin_postsuspend,
2750	.status  = origin_status,
 
2751	.iterate_devices = origin_iterate_devices,
2752};
2753
2754static struct target_type snapshot_target = {
2755	.name    = "snapshot",
2756	.version = {1, 16, 0},
2757	.module  = THIS_MODULE,
2758	.ctr     = snapshot_ctr,
2759	.dtr     = snapshot_dtr,
2760	.map     = snapshot_map,
2761	.end_io  = snapshot_end_io,
2762	.preresume  = snapshot_preresume,
2763	.resume  = snapshot_resume,
2764	.status  = snapshot_status,
2765	.iterate_devices = snapshot_iterate_devices,
2766	.io_hints = snapshot_io_hints,
2767};
2768
2769static struct target_type merge_target = {
2770	.name    = dm_snapshot_merge_target_name,
2771	.version = {1, 5, 0},
2772	.module  = THIS_MODULE,
2773	.ctr     = snapshot_ctr,
2774	.dtr     = snapshot_dtr,
2775	.map     = snapshot_merge_map,
2776	.end_io  = snapshot_end_io,
2777	.presuspend = snapshot_merge_presuspend,
2778	.preresume  = snapshot_preresume,
2779	.resume  = snapshot_merge_resume,
2780	.status  = snapshot_status,
2781	.iterate_devices = snapshot_iterate_devices,
2782	.io_hints = snapshot_io_hints,
2783};
2784
2785static int __init dm_snapshot_init(void)
2786{
2787	int r;
2788
2789	r = dm_exception_store_init();
2790	if (r) {
2791		DMERR("Failed to initialize exception stores");
2792		return r;
2793	}
2794
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
2795	r = init_origin_hash();
2796	if (r) {
2797		DMERR("init_origin_hash failed.");
2798		goto bad_origin_hash;
2799	}
2800
2801	exception_cache = KMEM_CACHE(dm_exception, 0);
2802	if (!exception_cache) {
2803		DMERR("Couldn't create exception cache.");
2804		r = -ENOMEM;
2805		goto bad_exception_cache;
2806	}
2807
2808	pending_cache = KMEM_CACHE(dm_snap_pending_exception, 0);
2809	if (!pending_cache) {
2810		DMERR("Couldn't create pending cache.");
2811		r = -ENOMEM;
2812		goto bad_pending_cache;
2813	}
2814
2815	r = dm_register_target(&snapshot_target);
2816	if (r < 0)
2817		goto bad_register_snapshot_target;
2818
2819	r = dm_register_target(&origin_target);
2820	if (r < 0)
2821		goto bad_register_origin_target;
2822
2823	r = dm_register_target(&merge_target);
2824	if (r < 0)
2825		goto bad_register_merge_target;
2826
2827	return 0;
2828
2829bad_register_merge_target:
2830	dm_unregister_target(&origin_target);
2831bad_register_origin_target:
2832	dm_unregister_target(&snapshot_target);
2833bad_register_snapshot_target:
2834	kmem_cache_destroy(pending_cache);
2835bad_pending_cache:
2836	kmem_cache_destroy(exception_cache);
2837bad_exception_cache:
2838	exit_origin_hash();
2839bad_origin_hash:
 
 
 
 
 
 
2840	dm_exception_store_exit();
2841
2842	return r;
2843}
2844
2845static void __exit dm_snapshot_exit(void)
2846{
2847	dm_unregister_target(&snapshot_target);
2848	dm_unregister_target(&origin_target);
2849	dm_unregister_target(&merge_target);
2850
2851	exit_origin_hash();
2852	kmem_cache_destroy(pending_cache);
2853	kmem_cache_destroy(exception_cache);
 
2854
2855	dm_exception_store_exit();
2856}
2857
2858/* Module hooks */
2859module_init(dm_snapshot_init);
2860module_exit(dm_snapshot_exit);
2861
2862MODULE_DESCRIPTION(DM_NAME " snapshot target");
2863MODULE_AUTHOR("Joe Thornber");
2864MODULE_LICENSE("GPL");
2865MODULE_ALIAS("dm-snapshot-origin");
2866MODULE_ALIAS("dm-snapshot-merge");