dm-thin.c 101.7 KB
Newer Older
J
Joe Thornber 已提交
1
/*
2
 * Copyright (C) 2011-2012 Red Hat UK.
J
Joe Thornber 已提交
3 4 5 6 7
 *
 * This file is released under the GPL.
 */

#include "dm-thin-metadata.h"
8
#include "dm-bio-prison.h"
9
#include "dm.h"
J
Joe Thornber 已提交
10 11 12 13

#include <linux/device-mapper.h>
#include <linux/dm-io.h>
#include <linux/dm-kcopyd.h>
14
#include <linux/log2.h>
J
Joe Thornber 已提交
15
#include <linux/list.h>
16
#include <linux/rculist.h>
J
Joe Thornber 已提交
17 18 19
#include <linux/init.h>
#include <linux/module.h>
#include <linux/slab.h>
J
Joe Thornber 已提交
20
#include <linux/sort.h>
21
#include <linux/rbtree.h>
J
Joe Thornber 已提交
22 23 24 25 26 27

#define	DM_MSG_PREFIX	"thin"

/*
 * Tunable constants
 */
28
#define ENDIO_HOOK_POOL_SIZE 1024
J
Joe Thornber 已提交
29
#define MAPPING_POOL_SIZE 1024
30
#define COMMIT_PERIOD HZ
31 32 33
#define NO_SPACE_TIMEOUT_SECS 60

static unsigned no_space_timeout_secs = NO_SPACE_TIMEOUT_SECS;
J
Joe Thornber 已提交
34

35 36 37
DECLARE_DM_KCOPYD_THROTTLE_WITH_MODULE_PARM(snapshot_copy_throttle,
		"A percentage of time allocated for copy on write");

J
Joe Thornber 已提交
38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69
/*
 * The block size of the device holding pool data must be
 * between 64KB and 1GB.
 */
#define DATA_DEV_BLOCK_SIZE_MIN_SECTORS (64 * 1024 >> SECTOR_SHIFT)
#define DATA_DEV_BLOCK_SIZE_MAX_SECTORS (1024 * 1024 * 1024 >> SECTOR_SHIFT)

/*
 * Device id is restricted to 24 bits.
 */
#define MAX_DEV_ID ((1 << 24) - 1)

/*
 * How do we handle breaking sharing of data blocks?
 * =================================================
 *
 * We use a standard copy-on-write btree to store the mappings for the
 * devices (note I'm talking about copy-on-write of the metadata here, not
 * the data).  When you take an internal snapshot you clone the root node
 * of the origin btree.  After this there is no concept of an origin or a
 * snapshot.  They are just two device trees that happen to point to the
 * same data blocks.
 *
 * When we get a write in we decide if it's to a shared data block using
 * some timestamp magic.  If it is, we have to break sharing.
 *
 * Let's say we write to a shared block in what was the origin.  The
 * steps are:
 *
 * i) plug io further to this physical block. (see bio_prison code).
 *
 * ii) quiesce any read io to that shared data block.  Obviously
70
 * including all devices that share this block.  (see dm_deferred_set code)
J
Joe Thornber 已提交
71 72 73 74 75
 *
 * iii) copy the data block to a newly allocate block.  This step can be
 * missed out if the io covers the block. (schedule_copy).
 *
 * iv) insert the new mapping into the origin's btree
J
Joe Thornber 已提交
76
 * (process_prepared_mapping).  This act of inserting breaks some
J
Joe Thornber 已提交
77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113
 * sharing of btree nodes between the two devices.  Breaking sharing only
 * effects the btree of that specific device.  Btrees for the other
 * devices that share the block never change.  The btree for the origin
 * device as it was after the last commit is untouched, ie. we're using
 * persistent data structures in the functional programming sense.
 *
 * v) unplug io to this physical block, including the io that triggered
 * the breaking of sharing.
 *
 * Steps (ii) and (iii) occur in parallel.
 *
 * The metadata _doesn't_ need to be committed before the io continues.  We
 * get away with this because the io is always written to a _new_ block.
 * If there's a crash, then:
 *
 * - The origin mapping will point to the old origin block (the shared
 * one).  This will contain the data as it was before the io that triggered
 * the breaking of sharing came in.
 *
 * - The snap mapping still points to the old block.  As it would after
 * the commit.
 *
 * The downside of this scheme is the timestamp magic isn't perfect, and
 * will continue to think that data block in the snapshot device is shared
 * even after the write to the origin has broken sharing.  I suspect data
 * blocks will typically be shared by many different devices, so we're
 * breaking sharing n + 1 times, rather than n, where n is the number of
 * devices that reference this data block.  At the moment I think the
 * benefits far, far outweigh the disadvantages.
 */

/*----------------------------------------------------------------*/

/*
 * Key building.
 */
static void build_data_key(struct dm_thin_device *td,
114
			   dm_block_t b, struct dm_cell_key *key)
J
Joe Thornber 已提交
115 116 117
{
	key->virtual = 0;
	key->dev = dm_thin_dev_id(td);
118 119
	key->block_begin = b;
	key->block_end = b + 1ULL;
J
Joe Thornber 已提交
120 121 122
}

static void build_virtual_key(struct dm_thin_device *td, dm_block_t b,
123
			      struct dm_cell_key *key)
J
Joe Thornber 已提交
124 125 126
{
	key->virtual = 1;
	key->dev = dm_thin_dev_id(td);
127 128
	key->block_begin = b;
	key->block_end = b + 1ULL;
J
Joe Thornber 已提交
129 130 131 132
}

/*----------------------------------------------------------------*/

J
Joe Thornber 已提交
133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179
#define THROTTLE_THRESHOLD (1 * HZ)

struct throttle {
	struct rw_semaphore lock;
	unsigned long threshold;
	bool throttle_applied;
};

static void throttle_init(struct throttle *t)
{
	init_rwsem(&t->lock);
	t->throttle_applied = false;
}

static void throttle_work_start(struct throttle *t)
{
	t->threshold = jiffies + THROTTLE_THRESHOLD;
}

static void throttle_work_update(struct throttle *t)
{
	if (!t->throttle_applied && jiffies > t->threshold) {
		down_write(&t->lock);
		t->throttle_applied = true;
	}
}

static void throttle_work_complete(struct throttle *t)
{
	if (t->throttle_applied) {
		t->throttle_applied = false;
		up_write(&t->lock);
	}
}

static void throttle_lock(struct throttle *t)
{
	down_read(&t->lock);
}

static void throttle_unlock(struct throttle *t)
{
	up_read(&t->lock);
}

/*----------------------------------------------------------------*/

J
Joe Thornber 已提交
180 181 182 183 184
/*
 * A pool device ties together a metadata device and a data device.  It
 * also provides the interface for creating and destroying internal
 * devices.
 */
M
Mike Snitzer 已提交
185
struct dm_thin_new_mapping;
186

187
/*
188
 * The pool runs in 4 modes.  Ordered in degraded order for comparisons.
189 190 191
 */
enum pool_mode {
	PM_WRITE,		/* metadata may be changed */
192
	PM_OUT_OF_DATA_SPACE,	/* metadata may be changed, though data may not be allocated */
193 194 195 196
	PM_READ_ONLY,		/* metadata may not be changed */
	PM_FAIL,		/* all I/O fails */
};

197
struct pool_features {
198 199
	enum pool_mode mode;

M
Mike Snitzer 已提交
200 201 202
	bool zero_new_blocks:1;
	bool discard_enabled:1;
	bool discard_passdown:1;
203
	bool error_if_no_space:1;
204 205
};

206 207
struct thin_c;
typedef void (*process_bio_fn)(struct thin_c *tc, struct bio *bio);
208
typedef void (*process_cell_fn)(struct thin_c *tc, struct dm_bio_prison_cell *cell);
209 210
typedef void (*process_mapping_fn)(struct dm_thin_new_mapping *m);

J
Joe Thornber 已提交
211 212
#define CELL_SORT_ARRAY_SIZE 8192

J
Joe Thornber 已提交
213 214 215 216 217 218 219 220 221
struct pool {
	struct list_head list;
	struct dm_target *ti;	/* Only set if a pool target is bound */

	struct mapped_device *pool_md;
	struct block_device *md_dev;
	struct dm_pool_metadata *pmd;

	dm_block_t low_water_blocks;
222
	uint32_t sectors_per_block;
223
	int sectors_per_block_shift;
J
Joe Thornber 已提交
224

225
	struct pool_features pf;
226
	bool low_water_triggered:1;	/* A dm event has been sent */
227
	bool suspended:1;
J
Joe Thornber 已提交
228

229
	struct dm_bio_prison *prison;
J
Joe Thornber 已提交
230 231 232
	struct dm_kcopyd_client *copier;

	struct workqueue_struct *wq;
J
Joe Thornber 已提交
233
	struct throttle throttle;
J
Joe Thornber 已提交
234
	struct work_struct worker;
235
	struct delayed_work waker;
236
	struct delayed_work no_space_timeout;
J
Joe Thornber 已提交
237

238
	unsigned long last_commit_jiffies;
239
	unsigned ref_count;
J
Joe Thornber 已提交
240 241 242 243

	spinlock_t lock;
	struct bio_list deferred_flush_bios;
	struct list_head prepared_mappings;
J
Joe Thornber 已提交
244
	struct list_head prepared_discards;
245
	struct list_head active_thins;
J
Joe Thornber 已提交
246

247 248
	struct dm_deferred_set *shared_read_ds;
	struct dm_deferred_set *all_io_ds;
J
Joe Thornber 已提交
249

M
Mike Snitzer 已提交
250
	struct dm_thin_new_mapping *next_mapping;
J
Joe Thornber 已提交
251
	mempool_t *mapping_pool;
252 253 254 255

	process_bio_fn process_bio;
	process_bio_fn process_discard;

256 257 258
	process_cell_fn process_cell;
	process_cell_fn process_discard_cell;

259 260
	process_mapping_fn process_prepared_mapping;
	process_mapping_fn process_prepared_discard;
J
Joe Thornber 已提交
261 262

	struct dm_bio_prison_cell *cell_sort_array[CELL_SORT_ARRAY_SIZE];
J
Joe Thornber 已提交
263 264
};

265
static enum pool_mode get_pool_mode(struct pool *pool);
266
static void metadata_operation_failed(struct pool *pool, const char *op, int r);
267

J
Joe Thornber 已提交
268 269 270 271 272 273 274 275 276 277 278
/*
 * Target context for a pool.
 */
struct pool_c {
	struct dm_target *ti;
	struct pool *pool;
	struct dm_dev *data_dev;
	struct dm_dev *metadata_dev;
	struct dm_target_callbacks callbacks;

	dm_block_t low_water_blocks;
279 280
	struct pool_features requested_pf; /* Features requested during table load */
	struct pool_features adjusted_pf;  /* Features used after adjusting for constituent devices */
J
Joe Thornber 已提交
281 282 283 284 285 286
};

/*
 * Target context for a thin.
 */
struct thin_c {
287
	struct list_head list;
J
Joe Thornber 已提交
288
	struct dm_dev *pool_dev;
289
	struct dm_dev *origin_dev;
290
	sector_t origin_size;
J
Joe Thornber 已提交
291 292 293 294
	dm_thin_id dev_id;

	struct pool *pool;
	struct dm_thin_device *td;
295 296
	struct mapped_device *thin_md;

297
	bool requeue_mode:1;
298
	spinlock_t lock;
299
	struct list_head deferred_cells;
300 301
	struct bio_list deferred_bio_list;
	struct bio_list retry_on_resume_list;
302
	struct rb_root sort_bio_list; /* sorted list of deferred bios */
303 304 305 306 307 308 309

	/*
	 * Ensures the thin is not destroyed until the worker has finished
	 * iterating the active_thins list.
	 */
	atomic_t refcount;
	struct completion can_destroy;
J
Joe Thornber 已提交
310 311 312 313
};

/*----------------------------------------------------------------*/

J
Joe Thornber 已提交
314 315 316 317 318 319 320 321 322 323 324
/*
 * wake_worker() is used when new work is queued and when pool_resume is
 * ready to continue deferred IO processing.
 */
static void wake_worker(struct pool *pool)
{
	queue_work(pool->wq, &pool->worker);
}

/*----------------------------------------------------------------*/

325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355
static int bio_detain(struct pool *pool, struct dm_cell_key *key, struct bio *bio,
		      struct dm_bio_prison_cell **cell_result)
{
	int r;
	struct dm_bio_prison_cell *cell_prealloc;

	/*
	 * Allocate a cell from the prison's mempool.
	 * This might block but it can't fail.
	 */
	cell_prealloc = dm_bio_prison_alloc_cell(pool->prison, GFP_NOIO);

	r = dm_bio_detain(pool->prison, key, bio, cell_prealloc, cell_result);
	if (r)
		/*
		 * We reused an old cell; we can get rid of
		 * the new one.
		 */
		dm_bio_prison_free_cell(pool->prison, cell_prealloc);

	return r;
}

static void cell_release(struct pool *pool,
			 struct dm_bio_prison_cell *cell,
			 struct bio_list *bios)
{
	dm_cell_release(pool->prison, cell, bios);
	dm_bio_prison_free_cell(pool->prison, cell);
}

356 357 358 359 360 361 362 363 364
static void cell_visit_release(struct pool *pool,
			       void (*fn)(void *, struct dm_bio_prison_cell *),
			       void *context,
			       struct dm_bio_prison_cell *cell)
{
	dm_cell_visit_release(pool->prison, fn, context, cell);
	dm_bio_prison_free_cell(pool->prison, cell);
}

365 366 367 368 369 370 371 372
static void cell_release_no_holder(struct pool *pool,
				   struct dm_bio_prison_cell *cell,
				   struct bio_list *bios)
{
	dm_cell_release_no_holder(pool->prison, cell, bios);
	dm_bio_prison_free_cell(pool->prison, cell);
}

373 374
static void cell_error_with_code(struct pool *pool,
				 struct dm_bio_prison_cell *cell, int error_code)
375
{
376
	dm_cell_error(pool->prison, cell, error_code);
377 378 379
	dm_bio_prison_free_cell(pool->prison, cell);
}

380 381 382 383 384
static void cell_error(struct pool *pool, struct dm_bio_prison_cell *cell)
{
	cell_error_with_code(pool, cell, -EIO);
}

385 386 387 388 389 390 391 392 393 394
static void cell_success(struct pool *pool, struct dm_bio_prison_cell *cell)
{
	cell_error_with_code(pool, cell, 0);
}

static void cell_requeue(struct pool *pool, struct dm_bio_prison_cell *cell)
{
	cell_error_with_code(pool, cell, DM_ENDIO_REQUEUE);
}

395 396
/*----------------------------------------------------------------*/

J
Joe Thornber 已提交
397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456
/*
 * A global list of pools that uses a struct mapped_device as a key.
 */
static struct dm_thin_pool_table {
	struct mutex mutex;
	struct list_head pools;
} dm_thin_pool_table;

static void pool_table_init(void)
{
	mutex_init(&dm_thin_pool_table.mutex);
	INIT_LIST_HEAD(&dm_thin_pool_table.pools);
}

static void __pool_table_insert(struct pool *pool)
{
	BUG_ON(!mutex_is_locked(&dm_thin_pool_table.mutex));
	list_add(&pool->list, &dm_thin_pool_table.pools);
}

static void __pool_table_remove(struct pool *pool)
{
	BUG_ON(!mutex_is_locked(&dm_thin_pool_table.mutex));
	list_del(&pool->list);
}

static struct pool *__pool_table_lookup(struct mapped_device *md)
{
	struct pool *pool = NULL, *tmp;

	BUG_ON(!mutex_is_locked(&dm_thin_pool_table.mutex));

	list_for_each_entry(tmp, &dm_thin_pool_table.pools, list) {
		if (tmp->pool_md == md) {
			pool = tmp;
			break;
		}
	}

	return pool;
}

static struct pool *__pool_table_lookup_metadata_dev(struct block_device *md_dev)
{
	struct pool *pool = NULL, *tmp;

	BUG_ON(!mutex_is_locked(&dm_thin_pool_table.mutex));

	list_for_each_entry(tmp, &dm_thin_pool_table.pools, list) {
		if (tmp->md_dev == md_dev) {
			pool = tmp;
			break;
		}
	}

	return pool;
}

/*----------------------------------------------------------------*/

M
Mike Snitzer 已提交
457
struct dm_thin_endio_hook {
458
	struct thin_c *tc;
459 460
	struct dm_deferred_entry *shared_read_entry;
	struct dm_deferred_entry *all_io_entry;
M
Mike Snitzer 已提交
461
	struct dm_thin_new_mapping *overwrite_mapping;
462
	struct rb_node rb_node;
463 464
};

465 466 467 468 469 470 471
static void __merge_bio_list(struct bio_list *bios, struct bio_list *master)
{
	bio_list_merge(bios, master);
	bio_list_init(master);
}

static void error_bio_list(struct bio_list *bios, int error)
J
Joe Thornber 已提交
472 473
{
	struct bio *bio;
474 475 476 477 478 479 480

	while ((bio = bio_list_pop(bios)))
		bio_endio(bio, error);
}

static void error_thin_bio_list(struct thin_c *tc, struct bio_list *master, int error)
{
J
Joe Thornber 已提交
481
	struct bio_list bios;
482
	unsigned long flags;
J
Joe Thornber 已提交
483 484

	bio_list_init(&bios);
485

486
	spin_lock_irqsave(&tc->lock, flags);
487
	__merge_bio_list(&bios, master);
488
	spin_unlock_irqrestore(&tc->lock, flags);
J
Joe Thornber 已提交
489

490
	error_bio_list(&bios, error);
J
Joe Thornber 已提交
491 492
}

493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509
static void requeue_deferred_cells(struct thin_c *tc)
{
	struct pool *pool = tc->pool;
	unsigned long flags;
	struct list_head cells;
	struct dm_bio_prison_cell *cell, *tmp;

	INIT_LIST_HEAD(&cells);

	spin_lock_irqsave(&tc->lock, flags);
	list_splice_init(&tc->deferred_cells, &cells);
	spin_unlock_irqrestore(&tc->lock, flags);

	list_for_each_entry_safe(cell, tmp, &cells, user_list)
		cell_requeue(pool, cell);
}

J
Joe Thornber 已提交
510 511
static void requeue_io(struct thin_c *tc)
{
512
	struct bio_list bios;
513
	unsigned long flags;
514 515 516

	bio_list_init(&bios);

517
	spin_lock_irqsave(&tc->lock, flags);
518 519
	__merge_bio_list(&bios, &tc->deferred_bio_list);
	__merge_bio_list(&bios, &tc->retry_on_resume_list);
520
	spin_unlock_irqrestore(&tc->lock, flags);
521

522 523
	error_bio_list(&bios, DM_ENDIO_REQUEUE);
	requeue_deferred_cells(tc);
524 525
}

526 527 528 529 530 531
static void error_retry_list(struct pool *pool)
{
	struct thin_c *tc;

	rcu_read_lock();
	list_for_each_entry_rcu(tc, &pool->active_thins, list)
532
		error_thin_bio_list(tc, &tc->retry_on_resume_list, -EIO);
533 534 535
	rcu_read_unlock();
}

J
Joe Thornber 已提交
536 537 538 539 540 541 542
/*
 * This section of code contains the logic for processing a thin device's IO.
 * Much of the code depends on pool object resources (lists, workqueues, etc)
 * but most is exclusively called from the thin target rather than the thin-pool
 * target.
 */

543 544 545 546 547
static bool block_size_is_power_of_two(struct pool *pool)
{
	return pool->sectors_per_block_shift >= 0;
}

J
Joe Thornber 已提交
548 549
static dm_block_t get_bio_block(struct thin_c *tc, struct bio *bio)
{
550
	struct pool *pool = tc->pool;
551
	sector_t block_nr = bio->bi_iter.bi_sector;
552

553 554
	if (block_size_is_power_of_two(pool))
		block_nr >>= pool->sectors_per_block_shift;
555
	else
556
		(void) sector_div(block_nr, pool->sectors_per_block);
557 558

	return block_nr;
J
Joe Thornber 已提交
559 560 561 562 563
}

static void remap(struct thin_c *tc, struct bio *bio, dm_block_t block)
{
	struct pool *pool = tc->pool;
564
	sector_t bi_sector = bio->bi_iter.bi_sector;
J
Joe Thornber 已提交
565 566

	bio->bi_bdev = tc->pool_dev->bdev;
567
	if (block_size_is_power_of_two(pool))
568 569 570
		bio->bi_iter.bi_sector =
			(block << pool->sectors_per_block_shift) |
			(bi_sector & (pool->sectors_per_block - 1));
571
	else
572
		bio->bi_iter.bi_sector = (block * pool->sectors_per_block) +
573
				 sector_div(bi_sector, pool->sectors_per_block);
J
Joe Thornber 已提交
574 575
}

576 577 578 579 580
static void remap_to_origin(struct thin_c *tc, struct bio *bio)
{
	bio->bi_bdev = tc->origin_dev->bdev;
}

581 582 583 584 585 586
static int bio_triggers_commit(struct thin_c *tc, struct bio *bio)
{
	return (bio->bi_rw & (REQ_FLUSH | REQ_FUA)) &&
		dm_thin_changed_this_transaction(tc->td);
}

587 588 589 590 591 592 593
static void inc_all_io_entry(struct pool *pool, struct bio *bio)
{
	struct dm_thin_endio_hook *h;

	if (bio->bi_rw & REQ_DISCARD)
		return;

M
Mikulas Patocka 已提交
594
	h = dm_per_bio_data(bio, sizeof(struct dm_thin_endio_hook));
595 596 597
	h->all_io_entry = dm_deferred_entry_inc(pool->all_io_ds);
}

598
static void issue(struct thin_c *tc, struct bio *bio)
J
Joe Thornber 已提交
599 600 601 602
{
	struct pool *pool = tc->pool;
	unsigned long flags;

603 604 605 606 607
	if (!bio_triggers_commit(tc, bio)) {
		generic_make_request(bio);
		return;
	}

J
Joe Thornber 已提交
608
	/*
609 610 611
	 * Complete bio with an error if earlier I/O caused changes to
	 * the metadata that can't be committed e.g, due to I/O errors
	 * on the metadata device.
J
Joe Thornber 已提交
612
	 */
613 614 615 616 617 618 619 620 621 622 623 624
	if (dm_thin_aborted_changes(tc->td)) {
		bio_io_error(bio);
		return;
	}

	/*
	 * Batch together any bios that trigger commits and then issue a
	 * single commit for them in process_deferred_bios().
	 */
	spin_lock_irqsave(&pool->lock, flags);
	bio_list_add(&pool->deferred_flush_bios, bio);
	spin_unlock_irqrestore(&pool->lock, flags);
J
Joe Thornber 已提交
625 626
}

627 628 629 630 631 632 633 634 635 636 637 638 639
static void remap_to_origin_and_issue(struct thin_c *tc, struct bio *bio)
{
	remap_to_origin(tc, bio);
	issue(tc, bio);
}

static void remap_and_issue(struct thin_c *tc, struct bio *bio,
			    dm_block_t block)
{
	remap(tc, bio, block);
	issue(tc, bio);
}

J
Joe Thornber 已提交
640 641 642 643 644
/*----------------------------------------------------------------*/

/*
 * Bio endio functions.
 */
M
Mike Snitzer 已提交
645
struct dm_thin_new_mapping {
J
Joe Thornber 已提交
646 647
	struct list_head list;

648 649
	bool pass_discard:1;
	bool definitely_not_shared:1;
J
Joe Thornber 已提交
650

651 652 653 654 655 656 657
	/*
	 * Track quiescing, copying and zeroing preparation actions.  When this
	 * counter hits zero the block is prepared and can be inserted into the
	 * btree.
	 */
	atomic_t prepare_actions;

658
	int err;
J
Joe Thornber 已提交
659 660 661
	struct thin_c *tc;
	dm_block_t virt_block;
	dm_block_t data_block;
M
Mike Snitzer 已提交
662
	struct dm_bio_prison_cell *cell, *cell2;
J
Joe Thornber 已提交
663 664 665 666 667 668 669 670 671 672 673

	/*
	 * If the bio covers the whole area of a block then we can avoid
	 * zeroing or copying.  Instead this bio is hooked.  The bio will
	 * still be in the cell, so care has to be taken to avoid issuing
	 * the bio twice.
	 */
	struct bio *bio;
	bio_end_io_t *saved_bi_end_io;
};

674
static void __complete_mapping_preparation(struct dm_thin_new_mapping *m)
J
Joe Thornber 已提交
675 676 677
{
	struct pool *pool = m->tc->pool;

678
	if (atomic_dec_and_test(&m->prepare_actions)) {
679
		list_add_tail(&m->list, &pool->prepared_mappings);
J
Joe Thornber 已提交
680 681 682 683
		wake_worker(pool);
	}
}

684
static void complete_mapping_preparation(struct dm_thin_new_mapping *m)
J
Joe Thornber 已提交
685 686 687 688 689
{
	unsigned long flags;
	struct pool *pool = m->tc->pool;

	spin_lock_irqsave(&pool->lock, flags);
690
	__complete_mapping_preparation(m);
J
Joe Thornber 已提交
691 692 693
	spin_unlock_irqrestore(&pool->lock, flags);
}

694 695 696 697 698 699 700 701
static void copy_complete(int read_err, unsigned long write_err, void *context)
{
	struct dm_thin_new_mapping *m = context;

	m->err = read_err || write_err ? -EIO : 0;
	complete_mapping_preparation(m);
}

J
Joe Thornber 已提交
702 703
static void overwrite_endio(struct bio *bio, int err)
{
M
Mikulas Patocka 已提交
704
	struct dm_thin_endio_hook *h = dm_per_bio_data(bio, sizeof(struct dm_thin_endio_hook));
M
Mike Snitzer 已提交
705
	struct dm_thin_new_mapping *m = h->overwrite_mapping;
J
Joe Thornber 已提交
706 707

	m->err = err;
708
	complete_mapping_preparation(m);
J
Joe Thornber 已提交
709 710 711 712 713 714 715 716 717 718 719 720 721
}

/*----------------------------------------------------------------*/

/*
 * Workqueue.
 */

/*
 * Prepared mapping jobs.
 */

/*
722 723
 * This sends the bios in the cell, except the original holder, back
 * to the deferred_bios list.
J
Joe Thornber 已提交
724
 */
725
static void cell_defer_no_holder(struct thin_c *tc, struct dm_bio_prison_cell *cell)
J
Joe Thornber 已提交
726 727 728 729
{
	struct pool *pool = tc->pool;
	unsigned long flags;

730 731 732
	spin_lock_irqsave(&tc->lock, flags);
	cell_release_no_holder(pool, cell, &tc->deferred_bio_list);
	spin_unlock_irqrestore(&tc->lock, flags);
J
Joe Thornber 已提交
733 734 735 736

	wake_worker(pool);
}

737 738
static void thin_defer_bio(struct thin_c *tc, struct bio *bio);

739 740 741 742 743 744 745 746
struct remap_info {
	struct thin_c *tc;
	struct bio_list defer_bios;
	struct bio_list issue_bios;
};

static void __inc_remap_and_issue_cell(void *context,
				       struct dm_bio_prison_cell *cell)
747
{
748
	struct remap_info *info = context;
749 750
	struct bio *bio;

751
	while ((bio = bio_list_pop(&cell->bios))) {
752
		if (bio->bi_rw & (REQ_DISCARD | REQ_FLUSH | REQ_FUA))
753
			bio_list_add(&info->defer_bios, bio);
754
		else {
755 756 757 758 759 760 761 762
			inc_all_io_entry(info->tc->pool, bio);

			/*
			 * We can't issue the bios with the bio prison lock
			 * held, so we add them to a list to issue on
			 * return from this function.
			 */
			bio_list_add(&info->issue_bios, bio);
763 764 765 766
		}
	}
}

767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792
static void inc_remap_and_issue_cell(struct thin_c *tc,
				     struct dm_bio_prison_cell *cell,
				     dm_block_t block)
{
	struct bio *bio;
	struct remap_info info;

	info.tc = tc;
	bio_list_init(&info.defer_bios);
	bio_list_init(&info.issue_bios);

	/*
	 * We have to be careful to inc any bios we're about to issue
	 * before the cell is released, and avoid a race with new bios
	 * being added to the cell.
	 */
	cell_visit_release(tc->pool, __inc_remap_and_issue_cell,
			   &info, cell);

	while ((bio = bio_list_pop(&info.defer_bios)))
		thin_defer_bio(tc, bio);

	while ((bio = bio_list_pop(&info.issue_bios)))
		remap_and_issue(info.tc, bio, block);
}

793 794
static void process_prepared_mapping_fail(struct dm_thin_new_mapping *m)
{
K
Kent Overstreet 已提交
795
	if (m->bio) {
796
		m->bio->bi_end_io = m->saved_bi_end_io;
K
Kent Overstreet 已提交
797 798
		atomic_inc(&m->bio->bi_remaining);
	}
799
	cell_error(m->tc->pool, m->cell);
800 801 802
	list_del(&m->list);
	mempool_free(m, m->tc->pool->mapping_pool);
}
J
Joe Thornber 已提交
803

M
Mike Snitzer 已提交
804
static void process_prepared_mapping(struct dm_thin_new_mapping *m)
J
Joe Thornber 已提交
805 806
{
	struct thin_c *tc = m->tc;
807
	struct pool *pool = tc->pool;
J
Joe Thornber 已提交
808 809 810 811
	struct bio *bio;
	int r;

	bio = m->bio;
K
Kent Overstreet 已提交
812
	if (bio) {
J
Joe Thornber 已提交
813
		bio->bi_end_io = m->saved_bi_end_io;
K
Kent Overstreet 已提交
814 815
		atomic_inc(&bio->bi_remaining);
	}
J
Joe Thornber 已提交
816 817

	if (m->err) {
818
		cell_error(pool, m->cell);
819
		goto out;
J
Joe Thornber 已提交
820 821 822 823 824 825 826 827 828
	}

	/*
	 * Commit the prepared block into the mapping btree.
	 * Any I/O for this block arriving after this point will get
	 * remapped to it directly.
	 */
	r = dm_thin_insert_block(tc->td, m->virt_block, m->data_block);
	if (r) {
829
		metadata_operation_failed(pool, "dm_thin_insert_block", r);
830
		cell_error(pool, m->cell);
831
		goto out;
J
Joe Thornber 已提交
832 833 834 835 836 837 838 839 840
	}

	/*
	 * Release any bios held while the block was being provisioned.
	 * If we are processing a write bio that completely covers the block,
	 * we already processed it so can ignore it now when processing
	 * the bios in the cell.
	 */
	if (bio) {
841
		inc_remap_and_issue_cell(tc, m->cell, m->data_block);
J
Joe Thornber 已提交
842
		bio_endio(bio, 0);
843 844 845 846 847
	} else {
		inc_all_io_entry(tc->pool, m->cell->holder);
		remap_and_issue(tc, m->cell->holder, m->data_block);
		inc_remap_and_issue_cell(tc, m->cell, m->data_block);
	}
J
Joe Thornber 已提交
848

849
out:
J
Joe Thornber 已提交
850
	list_del(&m->list);
851
	mempool_free(m, pool->mapping_pool);
J
Joe Thornber 已提交
852 853
}

854
static void process_prepared_discard_fail(struct dm_thin_new_mapping *m)
J
Joe Thornber 已提交
855 856 857
{
	struct thin_c *tc = m->tc;

858
	bio_io_error(m->bio);
859 860
	cell_defer_no_holder(tc, m->cell);
	cell_defer_no_holder(tc, m->cell2);
861 862 863 864 865 866
	mempool_free(m, tc->pool->mapping_pool);
}

static void process_prepared_discard_passdown(struct dm_thin_new_mapping *m)
{
	struct thin_c *tc = m->tc;
J
Joe Thornber 已提交
867

868
	inc_all_io_entry(tc->pool, m->bio);
869 870
	cell_defer_no_holder(tc, m->cell);
	cell_defer_no_holder(tc, m->cell2);
871

J
Joe Thornber 已提交
872
	if (m->pass_discard)
873 874 875 876 877 878 879 880 881
		if (m->definitely_not_shared)
			remap_and_issue(tc, m->bio, m->data_block);
		else {
			bool used = false;
			if (dm_pool_block_is_used(tc->pool->pmd, m->data_block, &used) || used)
				bio_endio(m->bio, 0);
			else
				remap_and_issue(tc, m->bio, m->data_block);
		}
J
Joe Thornber 已提交
882 883 884 885 886 887
	else
		bio_endio(m->bio, 0);

	mempool_free(m, tc->pool->mapping_pool);
}

888 889 890 891 892 893 894
static void process_prepared_discard(struct dm_thin_new_mapping *m)
{
	int r;
	struct thin_c *tc = m->tc;

	r = dm_thin_remove_block(tc->td, m->virt_block);
	if (r)
M
Mike Snitzer 已提交
895
		DMERR_LIMIT("dm_thin_remove_block() failed");
896 897 898 899

	process_prepared_discard_passdown(m);
}

J
Joe Thornber 已提交
900
static void process_prepared(struct pool *pool, struct list_head *head,
901
			     process_mapping_fn *fn)
J
Joe Thornber 已提交
902 903 904
{
	unsigned long flags;
	struct list_head maps;
M
Mike Snitzer 已提交
905
	struct dm_thin_new_mapping *m, *tmp;
J
Joe Thornber 已提交
906 907 908

	INIT_LIST_HEAD(&maps);
	spin_lock_irqsave(&pool->lock, flags);
J
Joe Thornber 已提交
909
	list_splice_init(head, &maps);
J
Joe Thornber 已提交
910 911 912
	spin_unlock_irqrestore(&pool->lock, flags);

	list_for_each_entry_safe(m, tmp, &maps, list)
913
		(*fn)(m);
J
Joe Thornber 已提交
914 915 916 917 918
}

/*
 * Deferred bio jobs.
 */
J
Joe Thornber 已提交
919
static int io_overlaps_block(struct pool *pool, struct bio *bio)
J
Joe Thornber 已提交
920
{
921 922
	return bio->bi_iter.bi_size ==
		(pool->sectors_per_block << SECTOR_SHIFT);
J
Joe Thornber 已提交
923 924 925 926 927 928
}

static int io_overwrites_block(struct pool *pool, struct bio *bio)
{
	return (bio_data_dir(bio) == WRITE) &&
		io_overlaps_block(pool, bio);
J
Joe Thornber 已提交
929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947
}

static void save_and_set_endio(struct bio *bio, bio_end_io_t **save,
			       bio_end_io_t *fn)
{
	*save = bio->bi_end_io;
	bio->bi_end_io = fn;
}

static int ensure_next_mapping(struct pool *pool)
{
	if (pool->next_mapping)
		return 0;

	pool->next_mapping = mempool_alloc(pool->mapping_pool, GFP_ATOMIC);

	return pool->next_mapping ? 0 : -ENOMEM;
}

M
Mike Snitzer 已提交
948
static struct dm_thin_new_mapping *get_next_mapping(struct pool *pool)
J
Joe Thornber 已提交
949
{
950
	struct dm_thin_new_mapping *m = pool->next_mapping;
J
Joe Thornber 已提交
951 952 953

	BUG_ON(!pool->next_mapping);

954 955 956 957
	memset(m, 0, sizeof(struct dm_thin_new_mapping));
	INIT_LIST_HEAD(&m->list);
	m->bio = NULL;

J
Joe Thornber 已提交
958 959
	pool->next_mapping = NULL;

960
	return m;
J
Joe Thornber 已提交
961 962
}

963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979
static void ll_zero(struct thin_c *tc, struct dm_thin_new_mapping *m,
		    sector_t begin, sector_t end)
{
	int r;
	struct dm_io_region to;

	to.bdev = tc->pool_dev->bdev;
	to.sector = begin;
	to.count = end - begin;

	r = dm_kcopyd_zero(tc->pool->copier, 1, &to, 0, copy_complete, m);
	if (r < 0) {
		DMERR_LIMIT("dm_kcopyd_zero() failed");
		copy_complete(1, 1, m);
	}
}

980 981 982 983 984 985 986 987 988 989 990 991 992 993
static void remap_and_issue_overwrite(struct thin_c *tc, struct bio *bio,
				      dm_block_t data_block,
				      struct dm_thin_new_mapping *m)
{
	struct pool *pool = tc->pool;
	struct dm_thin_endio_hook *h = dm_per_bio_data(bio, sizeof(struct dm_thin_endio_hook));

	h->overwrite_mapping = m;
	m->bio = bio;
	save_and_set_endio(bio, &m->saved_bi_end_io, overwrite_endio);
	inc_all_io_entry(pool, bio);
	remap_and_issue(tc, bio, data_block);
}

994 995 996
/*
 * A partial copy also needs to zero the uncopied region.
 */
J
Joe Thornber 已提交
997
static void schedule_copy(struct thin_c *tc, dm_block_t virt_block,
998 999
			  struct dm_dev *origin, dm_block_t data_origin,
			  dm_block_t data_dest,
1000 1001
			  struct dm_bio_prison_cell *cell, struct bio *bio,
			  sector_t len)
J
Joe Thornber 已提交
1002 1003 1004
{
	int r;
	struct pool *pool = tc->pool;
M
Mike Snitzer 已提交
1005
	struct dm_thin_new_mapping *m = get_next_mapping(pool);
J
Joe Thornber 已提交
1006 1007 1008 1009 1010 1011

	m->tc = tc;
	m->virt_block = virt_block;
	m->data_block = data_dest;
	m->cell = cell;

1012 1013 1014 1015 1016 1017 1018
	/*
	 * quiesce action + copy action + an extra reference held for the
	 * duration of this function (we may need to inc later for a
	 * partial zero).
	 */
	atomic_set(&m->prepare_actions, 3);

1019
	if (!dm_deferred_set_add_work(pool->shared_read_ds, &m->list))
1020
		complete_mapping_preparation(m); /* already quiesced */
J
Joe Thornber 已提交
1021 1022 1023 1024 1025 1026 1027

	/*
	 * IO to pool_dev remaps to the pool target's data_dev.
	 *
	 * If the whole block of data is being overwritten, we can issue the
	 * bio immediately. Otherwise we use kcopyd to clone the data first.
	 */
1028 1029 1030
	if (io_overwrites_block(pool, bio))
		remap_and_issue_overwrite(tc, bio, data_dest, m);
	else {
J
Joe Thornber 已提交
1031 1032
		struct dm_io_region from, to;

1033
		from.bdev = origin->bdev;
J
Joe Thornber 已提交
1034
		from.sector = data_origin * pool->sectors_per_block;
1035
		from.count = len;
J
Joe Thornber 已提交
1036 1037 1038

		to.bdev = tc->pool_dev->bdev;
		to.sector = data_dest * pool->sectors_per_block;
1039
		to.count = len;
J
Joe Thornber 已提交
1040 1041 1042 1043

		r = dm_kcopyd_copy(pool->copier, &from, 1, &to,
				   0, copy_complete, m);
		if (r < 0) {
M
Mike Snitzer 已提交
1044
			DMERR_LIMIT("dm_kcopyd_copy() failed");
1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062
			copy_complete(1, 1, m);

			/*
			 * We allow the zero to be issued, to simplify the
			 * error path.  Otherwise we'd need to start
			 * worrying about decrementing the prepare_actions
			 * counter.
			 */
		}

		/*
		 * Do we need to zero a tail region?
		 */
		if (len < pool->sectors_per_block && pool->pf.zero_new_blocks) {
			atomic_inc(&m->prepare_actions);
			ll_zero(tc, m,
				data_dest * pool->sectors_per_block + len,
				(data_dest + 1) * pool->sectors_per_block);
J
Joe Thornber 已提交
1063 1064
		}
	}
1065 1066

	complete_mapping_preparation(m); /* drop our ref */
J
Joe Thornber 已提交
1067 1068
}

1069 1070
static void schedule_internal_copy(struct thin_c *tc, dm_block_t virt_block,
				   dm_block_t data_origin, dm_block_t data_dest,
M
Mike Snitzer 已提交
1071
				   struct dm_bio_prison_cell *cell, struct bio *bio)
1072 1073
{
	schedule_copy(tc, virt_block, tc->pool_dev,
1074 1075
		      data_origin, data_dest, cell, bio,
		      tc->pool->sectors_per_block);
1076 1077
}

J
Joe Thornber 已提交
1078
static void schedule_zero(struct thin_c *tc, dm_block_t virt_block,
M
Mike Snitzer 已提交
1079
			  dm_block_t data_block, struct dm_bio_prison_cell *cell,
J
Joe Thornber 已提交
1080 1081 1082
			  struct bio *bio)
{
	struct pool *pool = tc->pool;
M
Mike Snitzer 已提交
1083
	struct dm_thin_new_mapping *m = get_next_mapping(pool);
J
Joe Thornber 已提交
1084

1085
	atomic_set(&m->prepare_actions, 1); /* no need to quiesce */
J
Joe Thornber 已提交
1086 1087 1088 1089 1090 1091 1092 1093 1094 1095
	m->tc = tc;
	m->virt_block = virt_block;
	m->data_block = data_block;
	m->cell = cell;

	/*
	 * If the whole block of data is being overwritten or we are not
	 * zeroing pre-existing data, we can issue the bio immediately.
	 * Otherwise we use kcopyd to zero the data first.
	 */
1096
	if (!pool->pf.zero_new_blocks)
J
Joe Thornber 已提交
1097 1098
		process_prepared_mapping(m);

1099 1100
	else if (io_overwrites_block(pool, bio))
		remap_and_issue_overwrite(tc, bio, data_block, m);
J
Joe Thornber 已提交
1101

1102
	else
1103 1104 1105 1106
		ll_zero(tc, m,
			data_block * pool->sectors_per_block,
			(data_block + 1) * pool->sectors_per_block);
}
J
Joe Thornber 已提交
1107

1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127
static void schedule_external_copy(struct thin_c *tc, dm_block_t virt_block,
				   dm_block_t data_dest,
				   struct dm_bio_prison_cell *cell, struct bio *bio)
{
	struct pool *pool = tc->pool;
	sector_t virt_block_begin = virt_block * pool->sectors_per_block;
	sector_t virt_block_end = (virt_block + 1) * pool->sectors_per_block;

	if (virt_block_end <= tc->origin_size)
		schedule_copy(tc, virt_block, tc->origin_dev,
			      virt_block, data_dest, cell, bio,
			      pool->sectors_per_block);

	else if (virt_block_begin < tc->origin_size)
		schedule_copy(tc, virt_block, tc->origin_dev,
			      virt_block, data_dest, cell, bio,
			      tc->origin_size - virt_block_begin);

	else
		schedule_zero(tc, virt_block, data_dest, cell, bio);
J
Joe Thornber 已提交
1128 1129
}

1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147
static void set_pool_mode(struct pool *pool, enum pool_mode new_mode);

static void check_for_space(struct pool *pool)
{
	int r;
	dm_block_t nr_free;

	if (get_pool_mode(pool) != PM_OUT_OF_DATA_SPACE)
		return;

	r = dm_pool_get_free_block_count(pool->pmd, &nr_free);
	if (r)
		return;

	if (nr_free)
		set_pool_mode(pool, PM_WRITE);
}

1148 1149 1150 1151
/*
 * A non-zero return indicates read_only or fail_io mode.
 * Many callers don't care about the return value.
 */
1152
static int commit(struct pool *pool)
1153 1154 1155
{
	int r;

1156
	if (get_pool_mode(pool) >= PM_READ_ONLY)
1157 1158
		return -EINVAL;

1159
	r = dm_pool_commit_metadata(pool->pmd);
1160 1161
	if (r)
		metadata_operation_failed(pool, "dm_pool_commit_metadata", r);
1162 1163
	else
		check_for_space(pool);
1164 1165 1166 1167

	return r;
}

1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181
static void check_low_water_mark(struct pool *pool, dm_block_t free_blocks)
{
	unsigned long flags;

	if (free_blocks <= pool->low_water_blocks && !pool->low_water_triggered) {
		DMWARN("%s: reached low water mark for data device: sending event.",
		       dm_device_name(pool->pool_md));
		spin_lock_irqsave(&pool->lock, flags);
		pool->low_water_triggered = true;
		spin_unlock_irqrestore(&pool->lock, flags);
		dm_table_event(pool->ti->table);
	}
}

J
Joe Thornber 已提交
1182 1183 1184 1185 1186 1187
static int alloc_data_block(struct thin_c *tc, dm_block_t *result)
{
	int r;
	dm_block_t free_blocks;
	struct pool *pool = tc->pool;

1188
	if (WARN_ON(get_pool_mode(pool) != PM_WRITE))
1189 1190
		return -EINVAL;

J
Joe Thornber 已提交
1191
	r = dm_pool_get_free_block_count(pool->pmd, &free_blocks);
1192 1193
	if (r) {
		metadata_operation_failed(pool, "dm_pool_get_free_block_count", r);
J
Joe Thornber 已提交
1194
		return r;
1195
	}
J
Joe Thornber 已提交
1196

1197
	check_low_water_mark(pool, free_blocks);
J
Joe Thornber 已提交
1198 1199

	if (!free_blocks) {
1200 1201 1202 1203
		/*
		 * Try to commit to see if that will free up some
		 * more space.
		 */
1204 1205 1206
		r = commit(pool);
		if (r)
			return r;
J
Joe Thornber 已提交
1207

1208
		r = dm_pool_get_free_block_count(pool->pmd, &free_blocks);
1209 1210
		if (r) {
			metadata_operation_failed(pool, "dm_pool_get_free_block_count", r);
1211
			return r;
1212
		}
J
Joe Thornber 已提交
1213

1214
		if (!free_blocks) {
1215
			set_pool_mode(pool, PM_OUT_OF_DATA_SPACE);
1216
			return -ENOSPC;
J
Joe Thornber 已提交
1217 1218 1219 1220
		}
	}

	r = dm_pool_alloc_data_block(pool->pmd, result);
1221
	if (r) {
1222
		metadata_operation_failed(pool, "dm_pool_alloc_data_block", r);
J
Joe Thornber 已提交
1223
		return r;
1224
	}
J
Joe Thornber 已提交
1225 1226 1227 1228 1229 1230 1231 1232 1233 1234

	return 0;
}

/*
 * If we have run out of space, queue bios until the device is
 * resumed, presumably after having been reloaded with more space.
 */
static void retry_on_resume(struct bio *bio)
{
M
Mikulas Patocka 已提交
1235
	struct dm_thin_endio_hook *h = dm_per_bio_data(bio, sizeof(struct dm_thin_endio_hook));
1236
	struct thin_c *tc = h->tc;
J
Joe Thornber 已提交
1237 1238
	unsigned long flags;

1239 1240 1241
	spin_lock_irqsave(&tc->lock, flags);
	bio_list_add(&tc->retry_on_resume_list, bio);
	spin_unlock_irqrestore(&tc->lock, flags);
J
Joe Thornber 已提交
1242 1243
}

1244
static int should_error_unserviceable_bio(struct pool *pool)
1245
{
1246 1247 1248 1249 1250 1251
	enum pool_mode m = get_pool_mode(pool);

	switch (m) {
	case PM_WRITE:
		/* Shouldn't get here */
		DMERR_LIMIT("bio unserviceable, yet pool is in PM_WRITE mode");
1252
		return -EIO;
1253 1254

	case PM_OUT_OF_DATA_SPACE:
1255
		return pool->pf.error_if_no_space ? -ENOSPC : 0;
1256 1257 1258

	case PM_READ_ONLY:
	case PM_FAIL:
1259
		return -EIO;
1260 1261 1262
	default:
		/* Shouldn't get here */
		DMERR_LIMIT("bio unserviceable, yet pool has an unknown mode");
1263
		return -EIO;
1264 1265
	}
}
1266

1267 1268
static void handle_unserviceable_bio(struct pool *pool, struct bio *bio)
{
1269 1270 1271 1272
	int error = should_error_unserviceable_bio(pool);

	if (error)
		bio_endio(bio, error);
1273 1274
	else
		retry_on_resume(bio);
1275 1276
}

1277
static void retry_bios_on_resume(struct pool *pool, struct dm_bio_prison_cell *cell)
J
Joe Thornber 已提交
1278 1279 1280
{
	struct bio *bio;
	struct bio_list bios;
1281
	int error;
J
Joe Thornber 已提交
1282

1283 1284 1285
	error = should_error_unserviceable_bio(pool);
	if (error) {
		cell_error_with_code(pool, cell, error);
1286 1287 1288
		return;
	}

J
Joe Thornber 已提交
1289
	bio_list_init(&bios);
1290
	cell_release(pool, cell, &bios);
J
Joe Thornber 已提交
1291

1292 1293
	while ((bio = bio_list_pop(&bios)))
		retry_on_resume(bio);
J
Joe Thornber 已提交
1294 1295
}

1296
static void process_discard_cell(struct thin_c *tc, struct dm_bio_prison_cell *cell)
J
Joe Thornber 已提交
1297 1298
{
	int r;
1299
	struct bio *bio = cell->holder;
J
Joe Thornber 已提交
1300
	struct pool *pool = tc->pool;
1301 1302
	struct dm_bio_prison_cell *cell2;
	struct dm_cell_key key2;
J
Joe Thornber 已提交
1303 1304
	dm_block_t block = get_bio_block(tc, bio);
	struct dm_thin_lookup_result lookup_result;
M
Mike Snitzer 已提交
1305
	struct dm_thin_new_mapping *m;
J
Joe Thornber 已提交
1306

1307 1308
	if (tc->requeue_mode) {
		cell_requeue(pool, cell);
J
Joe Thornber 已提交
1309
		return;
1310
	}
J
Joe Thornber 已提交
1311 1312 1313 1314 1315 1316 1317 1318 1319 1320

	r = dm_thin_find_block(tc->td, block, 1, &lookup_result);
	switch (r) {
	case 0:
		/*
		 * Check nobody is fiddling with this pool block.  This can
		 * happen if someone's in the process of breaking sharing
		 * on this block.
		 */
		build_data_key(tc->td, lookup_result.block, &key2);
1321
		if (bio_detain(tc->pool, &key2, bio, &cell2)) {
1322
			cell_defer_no_holder(tc, cell);
J
Joe Thornber 已提交
1323 1324 1325 1326 1327 1328 1329 1330 1331 1332
			break;
		}

		if (io_overlaps_block(pool, bio)) {
			/*
			 * IO may still be going to the destination block.  We must
			 * quiesce before we can do the removal.
			 */
			m = get_next_mapping(pool);
			m->tc = tc;
1333 1334
			m->pass_discard = pool->pf.discard_passdown;
			m->definitely_not_shared = !lookup_result.shared;
J
Joe Thornber 已提交
1335 1336 1337 1338 1339 1340
			m->virt_block = block;
			m->data_block = lookup_result.block;
			m->cell = cell;
			m->cell2 = cell2;
			m->bio = bio;

1341 1342 1343
			if (!dm_deferred_set_add_work(pool->all_io_ds, &m->list))
				pool->process_prepared_discard(m);

J
Joe Thornber 已提交
1344
		} else {
1345
			inc_all_io_entry(pool, bio);
1346 1347
			cell_defer_no_holder(tc, cell);
			cell_defer_no_holder(tc, cell2);
1348

J
Joe Thornber 已提交
1349
			/*
1350 1351 1352
			 * The DM core makes sure that the discard doesn't span
			 * a block boundary.  So we submit the discard of a
			 * partial block appropriately.
J
Joe Thornber 已提交
1353
			 */
1354 1355 1356 1357
			if ((!lookup_result.shared) && pool->pf.discard_passdown)
				remap_and_issue(tc, bio, lookup_result.block);
			else
				bio_endio(bio, 0);
J
Joe Thornber 已提交
1358 1359 1360 1361 1362 1363 1364
		}
		break;

	case -ENODATA:
		/*
		 * It isn't provisioned, just forget it.
		 */
1365
		cell_defer_no_holder(tc, cell);
J
Joe Thornber 已提交
1366 1367 1368 1369
		bio_endio(bio, 0);
		break;

	default:
M
Mike Snitzer 已提交
1370 1371
		DMERR_LIMIT("%s: dm_thin_find_block() failed: error = %d",
			    __func__, r);
1372
		cell_defer_no_holder(tc, cell);
J
Joe Thornber 已提交
1373 1374 1375 1376 1377
		bio_io_error(bio);
		break;
	}
}

1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390
static void process_discard_bio(struct thin_c *tc, struct bio *bio)
{
	struct dm_bio_prison_cell *cell;
	struct dm_cell_key key;
	dm_block_t block = get_bio_block(tc, bio);

	build_virtual_key(tc->td, block, &key);
	if (bio_detain(tc->pool, &key, bio, &cell))
		return;

	process_discard_cell(tc, cell);
}

J
Joe Thornber 已提交
1391
static void break_sharing(struct thin_c *tc, struct bio *bio, dm_block_t block,
1392
			  struct dm_cell_key *key,
J
Joe Thornber 已提交
1393
			  struct dm_thin_lookup_result *lookup_result,
M
Mike Snitzer 已提交
1394
			  struct dm_bio_prison_cell *cell)
J
Joe Thornber 已提交
1395 1396 1397
{
	int r;
	dm_block_t data_block;
1398
	struct pool *pool = tc->pool;
J
Joe Thornber 已提交
1399 1400 1401 1402

	r = alloc_data_block(tc, &data_block);
	switch (r) {
	case 0:
1403 1404
		schedule_internal_copy(tc, block, lookup_result->block,
				       data_block, cell, bio);
J
Joe Thornber 已提交
1405 1406 1407
		break;

	case -ENOSPC:
1408
		retry_bios_on_resume(pool, cell);
J
Joe Thornber 已提交
1409 1410 1411
		break;

	default:
M
Mike Snitzer 已提交
1412 1413
		DMERR_LIMIT("%s: alloc_data_block() failed: error = %d",
			    __func__, r);
1414
		cell_error(pool, cell);
J
Joe Thornber 已提交
1415 1416 1417 1418
		break;
	}
}

1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459
static void __remap_and_issue_shared_cell(void *context,
					  struct dm_bio_prison_cell *cell)
{
	struct remap_info *info = context;
	struct bio *bio;

	while ((bio = bio_list_pop(&cell->bios))) {
		if ((bio_data_dir(bio) == WRITE) ||
		    (bio->bi_rw & (REQ_DISCARD | REQ_FLUSH | REQ_FUA)))
			bio_list_add(&info->defer_bios, bio);
		else {
			struct dm_thin_endio_hook *h = dm_per_bio_data(bio, sizeof(struct dm_thin_endio_hook));;

			h->shared_read_entry = dm_deferred_entry_inc(info->tc->pool->shared_read_ds);
			inc_all_io_entry(info->tc->pool, bio);
			bio_list_add(&info->issue_bios, bio);
		}
	}
}

static void remap_and_issue_shared_cell(struct thin_c *tc,
					struct dm_bio_prison_cell *cell,
					dm_block_t block)
{
	struct bio *bio;
	struct remap_info info;

	info.tc = tc;
	bio_list_init(&info.defer_bios);
	bio_list_init(&info.issue_bios);

	cell_visit_release(tc->pool, __remap_and_issue_shared_cell,
			   &info, cell);

	while ((bio = bio_list_pop(&info.defer_bios)))
		thin_defer_bio(tc, bio);

	while ((bio = bio_list_pop(&info.issue_bios)))
		remap_and_issue(tc, bio, block);
}

J
Joe Thornber 已提交
1460 1461
static void process_shared_bio(struct thin_c *tc, struct bio *bio,
			       dm_block_t block,
1462 1463
			       struct dm_thin_lookup_result *lookup_result,
			       struct dm_bio_prison_cell *virt_cell)
J
Joe Thornber 已提交
1464
{
1465
	struct dm_bio_prison_cell *data_cell;
J
Joe Thornber 已提交
1466
	struct pool *pool = tc->pool;
1467
	struct dm_cell_key key;
J
Joe Thornber 已提交
1468 1469 1470 1471 1472 1473

	/*
	 * If cell is already occupied, then sharing is already in the process
	 * of being broken so we have nothing further to do here.
	 */
	build_data_key(tc->td, lookup_result->block, &key);
1474 1475
	if (bio_detain(pool, &key, bio, &data_cell)) {
		cell_defer_no_holder(tc, virt_cell);
J
Joe Thornber 已提交
1476
		return;
1477
	}
J
Joe Thornber 已提交
1478

1479 1480 1481 1482
	if (bio_data_dir(bio) == WRITE && bio->bi_iter.bi_size) {
		break_sharing(tc, bio, block, &key, lookup_result, data_cell);
		cell_defer_no_holder(tc, virt_cell);
	} else {
M
Mikulas Patocka 已提交
1483
		struct dm_thin_endio_hook *h = dm_per_bio_data(bio, sizeof(struct dm_thin_endio_hook));
J
Joe Thornber 已提交
1484

1485
		h->shared_read_entry = dm_deferred_entry_inc(pool->shared_read_ds);
1486
		inc_all_io_entry(pool, bio);
J
Joe Thornber 已提交
1487
		remap_and_issue(tc, bio, lookup_result->block);
1488 1489 1490

		remap_and_issue_shared_cell(tc, data_cell, lookup_result->block);
		remap_and_issue_shared_cell(tc, virt_cell, lookup_result->block);
J
Joe Thornber 已提交
1491 1492 1493 1494
	}
}

static void provision_block(struct thin_c *tc, struct bio *bio, dm_block_t block,
M
Mike Snitzer 已提交
1495
			    struct dm_bio_prison_cell *cell)
J
Joe Thornber 已提交
1496 1497 1498
{
	int r;
	dm_block_t data_block;
1499
	struct pool *pool = tc->pool;
J
Joe Thornber 已提交
1500 1501 1502 1503

	/*
	 * Remap empty bios (flushes) immediately, without provisioning.
	 */
1504
	if (!bio->bi_iter.bi_size) {
1505
		inc_all_io_entry(pool, bio);
1506
		cell_defer_no_holder(tc, cell);
1507

J
Joe Thornber 已提交
1508 1509 1510 1511 1512 1513 1514 1515 1516
		remap_and_issue(tc, bio, 0);
		return;
	}

	/*
	 * Fill read bios with zeroes and complete them immediately.
	 */
	if (bio_data_dir(bio) == READ) {
		zero_fill_bio(bio);
1517
		cell_defer_no_holder(tc, cell);
J
Joe Thornber 已提交
1518 1519 1520 1521 1522 1523 1524
		bio_endio(bio, 0);
		return;
	}

	r = alloc_data_block(tc, &data_block);
	switch (r) {
	case 0:
1525 1526 1527 1528
		if (tc->origin_dev)
			schedule_external_copy(tc, block, data_block, cell, bio);
		else
			schedule_zero(tc, block, data_block, cell, bio);
J
Joe Thornber 已提交
1529 1530 1531
		break;

	case -ENOSPC:
1532
		retry_bios_on_resume(pool, cell);
J
Joe Thornber 已提交
1533 1534 1535
		break;

	default:
M
Mike Snitzer 已提交
1536 1537
		DMERR_LIMIT("%s: alloc_data_block() failed: error = %d",
			    __func__, r);
1538
		cell_error(pool, cell);
J
Joe Thornber 已提交
1539 1540 1541 1542
		break;
	}
}

1543
static void process_cell(struct thin_c *tc, struct dm_bio_prison_cell *cell)
J
Joe Thornber 已提交
1544 1545
{
	int r;
1546
	struct pool *pool = tc->pool;
1547
	struct bio *bio = cell->holder;
J
Joe Thornber 已提交
1548 1549 1550
	dm_block_t block = get_bio_block(tc, bio);
	struct dm_thin_lookup_result lookup_result;

1551 1552
	if (tc->requeue_mode) {
		cell_requeue(pool, cell);
J
Joe Thornber 已提交
1553
		return;
1554
	}
J
Joe Thornber 已提交
1555 1556 1557 1558

	r = dm_thin_find_block(tc->td, block, 1, &lookup_result);
	switch (r) {
	case 0:
1559 1560 1561
		if (lookup_result.shared)
			process_shared_bio(tc, bio, block, &lookup_result, cell);
		else {
1562
			inc_all_io_entry(pool, bio);
J
Joe Thornber 已提交
1563
			remap_and_issue(tc, bio, lookup_result.block);
1564
			inc_remap_and_issue_cell(tc, cell, lookup_result.block);
1565
		}
J
Joe Thornber 已提交
1566 1567 1568
		break;

	case -ENODATA:
1569
		if (bio_data_dir(bio) == READ && tc->origin_dev) {
1570
			inc_all_io_entry(pool, bio);
1571
			cell_defer_no_holder(tc, cell);
1572

1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584
			if (bio_end_sector(bio) <= tc->origin_size)
				remap_to_origin_and_issue(tc, bio);

			else if (bio->bi_iter.bi_sector < tc->origin_size) {
				zero_fill_bio(bio);
				bio->bi_iter.bi_size = (tc->origin_size - bio->bi_iter.bi_sector) << SECTOR_SHIFT;
				remap_to_origin_and_issue(tc, bio);

			} else {
				zero_fill_bio(bio);
				bio_endio(bio, 0);
			}
1585 1586
		} else
			provision_block(tc, bio, block, cell);
J
Joe Thornber 已提交
1587 1588 1589
		break;

	default:
M
Mike Snitzer 已提交
1590 1591
		DMERR_LIMIT("%s: dm_thin_find_block() failed: error = %d",
			    __func__, r);
1592
		cell_defer_no_holder(tc, cell);
J
Joe Thornber 已提交
1593 1594 1595 1596 1597
		bio_io_error(bio);
		break;
	}
}

1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617
static void process_bio(struct thin_c *tc, struct bio *bio)
{
	struct pool *pool = tc->pool;
	dm_block_t block = get_bio_block(tc, bio);
	struct dm_bio_prison_cell *cell;
	struct dm_cell_key key;

	/*
	 * If cell is already occupied, then the block is already
	 * being provisioned so we have nothing further to do here.
	 */
	build_virtual_key(tc->td, block, &key);
	if (bio_detain(pool, &key, bio, &cell))
		return;

	process_cell(tc, cell);
}

static void __process_bio_read_only(struct thin_c *tc, struct bio *bio,
				    struct dm_bio_prison_cell *cell)
1618 1619 1620 1621 1622 1623 1624 1625 1626
{
	int r;
	int rw = bio_data_dir(bio);
	dm_block_t block = get_bio_block(tc, bio);
	struct dm_thin_lookup_result lookup_result;

	r = dm_thin_find_block(tc->td, block, 1, &lookup_result);
	switch (r) {
	case 0:
1627
		if (lookup_result.shared && (rw == WRITE) && bio->bi_iter.bi_size) {
1628
			handle_unserviceable_bio(tc->pool, bio);
1629 1630 1631
			if (cell)
				cell_defer_no_holder(tc, cell);
		} else {
1632
			inc_all_io_entry(tc->pool, bio);
1633
			remap_and_issue(tc, bio, lookup_result.block);
1634 1635
			if (cell)
				inc_remap_and_issue_cell(tc, cell, lookup_result.block);
1636
		}
1637 1638 1639
		break;

	case -ENODATA:
1640 1641
		if (cell)
			cell_defer_no_holder(tc, cell);
1642
		if (rw != READ) {
1643
			handle_unserviceable_bio(tc->pool, bio);
1644 1645 1646 1647
			break;
		}

		if (tc->origin_dev) {
1648
			inc_all_io_entry(tc->pool, bio);
1649 1650 1651 1652 1653 1654 1655 1656 1657
			remap_to_origin_and_issue(tc, bio);
			break;
		}

		zero_fill_bio(bio);
		bio_endio(bio, 0);
		break;

	default:
M
Mike Snitzer 已提交
1658 1659
		DMERR_LIMIT("%s: dm_thin_find_block() failed: error = %d",
			    __func__, r);
1660 1661
		if (cell)
			cell_defer_no_holder(tc, cell);
1662 1663 1664 1665 1666
		bio_io_error(bio);
		break;
	}
}

1667 1668 1669 1670 1671 1672 1673 1674 1675 1676
static void process_bio_read_only(struct thin_c *tc, struct bio *bio)
{
	__process_bio_read_only(tc, bio, NULL);
}

static void process_cell_read_only(struct thin_c *tc, struct dm_bio_prison_cell *cell)
{
	__process_bio_read_only(tc, cell->holder, cell);
}

1677 1678 1679 1680 1681
static void process_bio_success(struct thin_c *tc, struct bio *bio)
{
	bio_endio(bio, 0);
}

1682 1683 1684 1685 1686
static void process_bio_fail(struct thin_c *tc, struct bio *bio)
{
	bio_io_error(bio);
}

1687 1688 1689 1690 1691 1692 1693 1694 1695 1696
static void process_cell_success(struct thin_c *tc, struct dm_bio_prison_cell *cell)
{
	cell_success(tc->pool, cell);
}

static void process_cell_fail(struct thin_c *tc, struct dm_bio_prison_cell *cell)
{
	cell_error(tc->pool, cell);
}

1697 1698 1699 1700
/*
 * FIXME: should we also commit due to size of transaction, measured in
 * metadata blocks?
 */
1701 1702 1703 1704 1705 1706
static int need_commit_due_to_time(struct pool *pool)
{
	return jiffies < pool->last_commit_jiffies ||
	       jiffies > pool->last_commit_jiffies + COMMIT_PERIOD;
}

1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770
#define thin_pbd(node) rb_entry((node), struct dm_thin_endio_hook, rb_node)
#define thin_bio(pbd) dm_bio_from_per_bio_data((pbd), sizeof(struct dm_thin_endio_hook))

static void __thin_bio_rb_add(struct thin_c *tc, struct bio *bio)
{
	struct rb_node **rbp, *parent;
	struct dm_thin_endio_hook *pbd;
	sector_t bi_sector = bio->bi_iter.bi_sector;

	rbp = &tc->sort_bio_list.rb_node;
	parent = NULL;
	while (*rbp) {
		parent = *rbp;
		pbd = thin_pbd(parent);

		if (bi_sector < thin_bio(pbd)->bi_iter.bi_sector)
			rbp = &(*rbp)->rb_left;
		else
			rbp = &(*rbp)->rb_right;
	}

	pbd = dm_per_bio_data(bio, sizeof(struct dm_thin_endio_hook));
	rb_link_node(&pbd->rb_node, parent, rbp);
	rb_insert_color(&pbd->rb_node, &tc->sort_bio_list);
}

static void __extract_sorted_bios(struct thin_c *tc)
{
	struct rb_node *node;
	struct dm_thin_endio_hook *pbd;
	struct bio *bio;

	for (node = rb_first(&tc->sort_bio_list); node; node = rb_next(node)) {
		pbd = thin_pbd(node);
		bio = thin_bio(pbd);

		bio_list_add(&tc->deferred_bio_list, bio);
		rb_erase(&pbd->rb_node, &tc->sort_bio_list);
	}

	WARN_ON(!RB_EMPTY_ROOT(&tc->sort_bio_list));
}

static void __sort_thin_deferred_bios(struct thin_c *tc)
{
	struct bio *bio;
	struct bio_list bios;

	bio_list_init(&bios);
	bio_list_merge(&bios, &tc->deferred_bio_list);
	bio_list_init(&tc->deferred_bio_list);

	/* Sort deferred_bio_list using rb-tree */
	while ((bio = bio_list_pop(&bios)))
		__thin_bio_rb_add(tc, bio);

	/*
	 * Transfer the sorted bios in sort_bio_list back to
	 * deferred_bio_list to allow lockless submission of
	 * all bios.
	 */
	__extract_sorted_bios(tc);
}

1771
static void process_thin_deferred_bios(struct thin_c *tc)
J
Joe Thornber 已提交
1772
{
1773
	struct pool *pool = tc->pool;
J
Joe Thornber 已提交
1774 1775 1776
	unsigned long flags;
	struct bio *bio;
	struct bio_list bios;
1777
	struct blk_plug plug;
1778
	unsigned count = 0;
J
Joe Thornber 已提交
1779

1780
	if (tc->requeue_mode) {
1781
		error_thin_bio_list(tc, &tc->deferred_bio_list, DM_ENDIO_REQUEUE);
1782 1783 1784
		return;
	}

J
Joe Thornber 已提交
1785 1786
	bio_list_init(&bios);

1787
	spin_lock_irqsave(&tc->lock, flags);
1788 1789 1790 1791 1792 1793 1794 1795

	if (bio_list_empty(&tc->deferred_bio_list)) {
		spin_unlock_irqrestore(&tc->lock, flags);
		return;
	}

	__sort_thin_deferred_bios(tc);

1796 1797
	bio_list_merge(&bios, &tc->deferred_bio_list);
	bio_list_init(&tc->deferred_bio_list);
1798

1799
	spin_unlock_irqrestore(&tc->lock, flags);
J
Joe Thornber 已提交
1800

1801
	blk_start_plug(&plug);
J
Joe Thornber 已提交
1802 1803 1804 1805 1806 1807 1808
	while ((bio = bio_list_pop(&bios))) {
		/*
		 * If we've got no free new_mapping structs, and processing
		 * this bio might require one, we pause until there are some
		 * prepared mappings to process.
		 */
		if (ensure_next_mapping(pool)) {
1809 1810 1811 1812
			spin_lock_irqsave(&tc->lock, flags);
			bio_list_add(&tc->deferred_bio_list, bio);
			bio_list_merge(&tc->deferred_bio_list, &bios);
			spin_unlock_irqrestore(&tc->lock, flags);
J
Joe Thornber 已提交
1813 1814
			break;
		}
J
Joe Thornber 已提交
1815 1816

		if (bio->bi_rw & REQ_DISCARD)
1817
			pool->process_discard(tc, bio);
J
Joe Thornber 已提交
1818
		else
1819
			pool->process_bio(tc, bio);
1820 1821

		if ((count++ & 127) == 0) {
J
Joe Thornber 已提交
1822
			throttle_work_update(&pool->throttle);
1823 1824
			dm_pool_issue_prefetches(pool->pmd);
		}
J
Joe Thornber 已提交
1825
	}
1826
	blk_finish_plug(&plug);
1827 1828
}

J
Joe Thornber 已提交
1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863
static int cmp_cells(const void *lhs, const void *rhs)
{
	struct dm_bio_prison_cell *lhs_cell = *((struct dm_bio_prison_cell **) lhs);
	struct dm_bio_prison_cell *rhs_cell = *((struct dm_bio_prison_cell **) rhs);

	BUG_ON(!lhs_cell->holder);
	BUG_ON(!rhs_cell->holder);

	if (lhs_cell->holder->bi_iter.bi_sector < rhs_cell->holder->bi_iter.bi_sector)
		return -1;

	if (lhs_cell->holder->bi_iter.bi_sector > rhs_cell->holder->bi_iter.bi_sector)
		return 1;

	return 0;
}

static unsigned sort_cells(struct pool *pool, struct list_head *cells)
{
	unsigned count = 0;
	struct dm_bio_prison_cell *cell, *tmp;

	list_for_each_entry_safe(cell, tmp, cells, user_list) {
		if (count >= CELL_SORT_ARRAY_SIZE)
			break;

		pool->cell_sort_array[count++] = cell;
		list_del(&cell->user_list);
	}

	sort(pool->cell_sort_array, count, sizeof(cell), cmp_cells, NULL);

	return count;
}

1864 1865 1866 1867 1868
static void process_thin_deferred_cells(struct thin_c *tc)
{
	struct pool *pool = tc->pool;
	unsigned long flags;
	struct list_head cells;
J
Joe Thornber 已提交
1869 1870
	struct dm_bio_prison_cell *cell;
	unsigned i, j, count;
1871 1872 1873 1874 1875 1876 1877 1878 1879 1880

	INIT_LIST_HEAD(&cells);

	spin_lock_irqsave(&tc->lock, flags);
	list_splice_init(&tc->deferred_cells, &cells);
	spin_unlock_irqrestore(&tc->lock, flags);

	if (list_empty(&cells))
		return;

J
Joe Thornber 已提交
1881 1882
	do {
		count = sort_cells(tc->pool, &cells);
1883

J
Joe Thornber 已提交
1884 1885 1886
		for (i = 0; i < count; i++) {
			cell = pool->cell_sort_array[i];
			BUG_ON(!cell->holder);
1887

J
Joe Thornber 已提交
1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908
			/*
			 * If we've got no free new_mapping structs, and processing
			 * this bio might require one, we pause until there are some
			 * prepared mappings to process.
			 */
			if (ensure_next_mapping(pool)) {
				for (j = i; j < count; j++)
					list_add(&pool->cell_sort_array[j]->user_list, &cells);

				spin_lock_irqsave(&tc->lock, flags);
				list_splice(&cells, &tc->deferred_cells);
				spin_unlock_irqrestore(&tc->lock, flags);
				return;
			}

			if (cell->holder->bi_rw & REQ_DISCARD)
				pool->process_discard_cell(tc, cell);
			else
				pool->process_cell(tc, cell);
		}
	} while (!list_empty(&cells));
1909 1910
}

1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949
static void thin_get(struct thin_c *tc);
static void thin_put(struct thin_c *tc);

/*
 * We can't hold rcu_read_lock() around code that can block.  So we
 * find a thin with the rcu lock held; bump a refcount; then drop
 * the lock.
 */
static struct thin_c *get_first_thin(struct pool *pool)
{
	struct thin_c *tc = NULL;

	rcu_read_lock();
	if (!list_empty(&pool->active_thins)) {
		tc = list_entry_rcu(pool->active_thins.next, struct thin_c, list);
		thin_get(tc);
	}
	rcu_read_unlock();

	return tc;
}

static struct thin_c *get_next_thin(struct pool *pool, struct thin_c *tc)
{
	struct thin_c *old_tc = tc;

	rcu_read_lock();
	list_for_each_entry_continue_rcu(tc, &pool->active_thins, list) {
		thin_get(tc);
		thin_put(old_tc);
		rcu_read_unlock();
		return tc;
	}
	thin_put(old_tc);
	rcu_read_unlock();

	return NULL;
}

1950 1951 1952 1953 1954 1955 1956
static void process_deferred_bios(struct pool *pool)
{
	unsigned long flags;
	struct bio *bio;
	struct bio_list bios;
	struct thin_c *tc;

1957 1958
	tc = get_first_thin(pool);
	while (tc) {
1959
		process_thin_deferred_cells(tc);
1960
		process_thin_deferred_bios(tc);
1961 1962
		tc = get_next_thin(pool, tc);
	}
J
Joe Thornber 已提交
1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973

	/*
	 * If there are any deferred flush bios, we must commit
	 * the metadata before issuing them.
	 */
	bio_list_init(&bios);
	spin_lock_irqsave(&pool->lock, flags);
	bio_list_merge(&bios, &pool->deferred_flush_bios);
	bio_list_init(&pool->deferred_flush_bios);
	spin_unlock_irqrestore(&pool->lock, flags);

1974 1975
	if (bio_list_empty(&bios) &&
	    !(dm_pool_changed_this_transaction(pool->pmd) && need_commit_due_to_time(pool)))
J
Joe Thornber 已提交
1976 1977
		return;

1978
	if (commit(pool)) {
J
Joe Thornber 已提交
1979 1980 1981 1982
		while ((bio = bio_list_pop(&bios)))
			bio_io_error(bio);
		return;
	}
1983
	pool->last_commit_jiffies = jiffies;
J
Joe Thornber 已提交
1984 1985 1986 1987 1988 1989 1990 1991 1992

	while ((bio = bio_list_pop(&bios)))
		generic_make_request(bio);
}

static void do_worker(struct work_struct *ws)
{
	struct pool *pool = container_of(ws, struct pool, worker);

J
Joe Thornber 已提交
1993
	throttle_work_start(&pool->throttle);
1994
	dm_pool_issue_prefetches(pool->pmd);
J
Joe Thornber 已提交
1995
	throttle_work_update(&pool->throttle);
1996
	process_prepared(pool, &pool->prepared_mappings, &pool->process_prepared_mapping);
J
Joe Thornber 已提交
1997
	throttle_work_update(&pool->throttle);
1998
	process_prepared(pool, &pool->prepared_discards, &pool->process_prepared_discard);
J
Joe Thornber 已提交
1999
	throttle_work_update(&pool->throttle);
J
Joe Thornber 已提交
2000
	process_deferred_bios(pool);
J
Joe Thornber 已提交
2001
	throttle_work_complete(&pool->throttle);
J
Joe Thornber 已提交
2002 2003
}

2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014
/*
 * We want to commit periodically so that not too much
 * unwritten data builds up.
 */
static void do_waker(struct work_struct *ws)
{
	struct pool *pool = container_of(to_delayed_work(ws), struct pool, waker);
	wake_worker(pool);
	queue_delayed_work(pool->wq, &pool->waker, COMMIT_PERIOD);
}

2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028
/*
 * We're holding onto IO to allow userland time to react.  After the
 * timeout either the pool will have been resized (and thus back in
 * PM_WRITE mode), or we degrade to PM_READ_ONLY and start erroring IO.
 */
static void do_no_space_timeout(struct work_struct *ws)
{
	struct pool *pool = container_of(to_delayed_work(ws), struct pool,
					 no_space_timeout);

	if (get_pool_mode(pool) == PM_OUT_OF_DATA_SPACE && !pool->pf.error_if_no_space)
		set_pool_mode(pool, PM_READ_ONLY);
}

J
Joe Thornber 已提交
2029 2030
/*----------------------------------------------------------------*/

2031
struct pool_work {
2032
	struct work_struct worker;
2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044
	struct completion complete;
};

static struct pool_work *to_pool_work(struct work_struct *ws)
{
	return container_of(ws, struct pool_work, worker);
}

static void pool_work_complete(struct pool_work *pw)
{
	complete(&pw->complete);
}
2045

2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059
static void pool_work_wait(struct pool_work *pw, struct pool *pool,
			   void (*fn)(struct work_struct *))
{
	INIT_WORK_ONSTACK(&pw->worker, fn);
	init_completion(&pw->complete);
	queue_work(pool->wq, &pw->worker);
	wait_for_completion(&pw->complete);
}

/*----------------------------------------------------------------*/

struct noflush_work {
	struct pool_work pw;
	struct thin_c *tc;
2060 2061
};

2062
static struct noflush_work *to_noflush(struct work_struct *ws)
2063
{
2064
	return container_of(to_pool_work(ws), struct noflush_work, pw);
2065 2066 2067 2068
}

static void do_noflush_start(struct work_struct *ws)
{
2069
	struct noflush_work *w = to_noflush(ws);
2070 2071
	w->tc->requeue_mode = true;
	requeue_io(w->tc);
2072
	pool_work_complete(&w->pw);
2073 2074 2075 2076
}

static void do_noflush_stop(struct work_struct *ws)
{
2077
	struct noflush_work *w = to_noflush(ws);
2078
	w->tc->requeue_mode = false;
2079
	pool_work_complete(&w->pw);
2080 2081 2082 2083 2084 2085 2086
}

static void noflush_work(struct thin_c *tc, void (*fn)(struct work_struct *))
{
	struct noflush_work w;

	w.tc = tc;
2087
	pool_work_wait(&w.pw, tc->pool, fn);
2088 2089 2090 2091
}

/*----------------------------------------------------------------*/

2092 2093 2094 2095 2096
static enum pool_mode get_pool_mode(struct pool *pool)
{
	return pool->pf.mode;
}

2097 2098 2099 2100 2101 2102 2103
static void notify_of_pool_mode_change(struct pool *pool, const char *new_mode)
{
	dm_table_event(pool->ti->table);
	DMINFO("%s: switching pool to %s mode",
	       dm_device_name(pool->pool_md), new_mode);
}

2104
static void set_pool_mode(struct pool *pool, enum pool_mode new_mode)
2105
{
2106
	struct pool_c *pt = pool->ti->private;
2107 2108
	bool needs_check = dm_pool_metadata_needs_check(pool->pmd);
	enum pool_mode old_mode = get_pool_mode(pool);
2109
	unsigned long no_space_timeout = ACCESS_ONCE(no_space_timeout_secs) * HZ;
2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129

	/*
	 * Never allow the pool to transition to PM_WRITE mode if user
	 * intervention is required to verify metadata and data consistency.
	 */
	if (new_mode == PM_WRITE && needs_check) {
		DMERR("%s: unable to switch pool to write mode until repaired.",
		      dm_device_name(pool->pool_md));
		if (old_mode != new_mode)
			new_mode = old_mode;
		else
			new_mode = PM_READ_ONLY;
	}
	/*
	 * If we were in PM_FAIL mode, rollback of metadata failed.  We're
	 * not going to recover without a thin_repair.	So we never let the
	 * pool move out of the old mode.
	 */
	if (old_mode == PM_FAIL)
		new_mode = old_mode;
2130

2131
	switch (new_mode) {
2132
	case PM_FAIL:
2133
		if (old_mode != new_mode)
2134
			notify_of_pool_mode_change(pool, "failure");
2135
		dm_pool_metadata_read_only(pool->pmd);
2136 2137
		pool->process_bio = process_bio_fail;
		pool->process_discard = process_bio_fail;
2138 2139
		pool->process_cell = process_cell_fail;
		pool->process_discard_cell = process_cell_fail;
2140 2141
		pool->process_prepared_mapping = process_prepared_mapping_fail;
		pool->process_prepared_discard = process_prepared_discard_fail;
2142 2143

		error_retry_list(pool);
2144 2145 2146
		break;

	case PM_READ_ONLY:
2147
		if (old_mode != new_mode)
2148 2149 2150 2151
			notify_of_pool_mode_change(pool, "read-only");
		dm_pool_metadata_read_only(pool->pmd);
		pool->process_bio = process_bio_read_only;
		pool->process_discard = process_bio_success;
2152 2153
		pool->process_cell = process_cell_read_only;
		pool->process_discard_cell = process_cell_success;
2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171
		pool->process_prepared_mapping = process_prepared_mapping_fail;
		pool->process_prepared_discard = process_prepared_discard_passdown;

		error_retry_list(pool);
		break;

	case PM_OUT_OF_DATA_SPACE:
		/*
		 * Ideally we'd never hit this state; the low water mark
		 * would trigger userland to extend the pool before we
		 * completely run out of data space.  However, many small
		 * IOs to unprovisioned space can consume data space at an
		 * alarming rate.  Adjust your low water mark if you're
		 * frequently seeing this mode.
		 */
		if (old_mode != new_mode)
			notify_of_pool_mode_change(pool, "out-of-data-space");
		pool->process_bio = process_bio_read_only;
2172 2173 2174
		pool->process_discard = process_discard_bio;
		pool->process_cell = process_cell_read_only;
		pool->process_discard_cell = process_discard_cell;
2175
		pool->process_prepared_mapping = process_prepared_mapping;
2176
		pool->process_prepared_discard = process_prepared_discard;
2177

2178 2179
		if (!pool->pf.error_if_no_space && no_space_timeout)
			queue_delayed_work(pool->wq, &pool->no_space_timeout, no_space_timeout);
2180 2181 2182
		break;

	case PM_WRITE:
2183
		if (old_mode != new_mode)
2184
			notify_of_pool_mode_change(pool, "write");
2185
		dm_pool_metadata_read_write(pool->pmd);
2186
		pool->process_bio = process_bio;
2187 2188 2189
		pool->process_discard = process_discard_bio;
		pool->process_cell = process_cell;
		pool->process_discard_cell = process_discard_cell;
2190 2191 2192 2193
		pool->process_prepared_mapping = process_prepared_mapping;
		pool->process_prepared_discard = process_prepared_discard;
		break;
	}
2194 2195

	pool->pf.mode = new_mode;
2196 2197 2198 2199 2200
	/*
	 * The pool mode may have changed, sync it so bind_control_target()
	 * doesn't cause an unexpected mode transition on resume.
	 */
	pt->adjusted_pf.mode = new_mode;
2201 2202
}

2203
static void abort_transaction(struct pool *pool)
2204
{
2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217
	const char *dev_name = dm_device_name(pool->pool_md);

	DMERR_LIMIT("%s: aborting current metadata transaction", dev_name);
	if (dm_pool_abort_metadata(pool->pmd)) {
		DMERR("%s: failed to abort metadata transaction", dev_name);
		set_pool_mode(pool, PM_FAIL);
	}

	if (dm_pool_metadata_set_needs_check(pool->pmd)) {
		DMERR("%s: failed to set 'needs_check' flag in metadata", dev_name);
		set_pool_mode(pool, PM_FAIL);
	}
}
2218

2219 2220
static void metadata_operation_failed(struct pool *pool, const char *op, int r)
{
2221 2222 2223
	DMERR_LIMIT("%s: metadata operation '%s' failed: error = %d",
		    dm_device_name(pool->pool_md), op, r);

2224
	abort_transaction(pool);
2225 2226 2227
	set_pool_mode(pool, PM_READ_ONLY);
}

2228 2229
/*----------------------------------------------------------------*/

J
Joe Thornber 已提交
2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241
/*
 * Mapping functions.
 */

/*
 * Called only while mapping a thin bio to hand it over to the workqueue.
 */
static void thin_defer_bio(struct thin_c *tc, struct bio *bio)
{
	unsigned long flags;
	struct pool *pool = tc->pool;

2242 2243 2244
	spin_lock_irqsave(&tc->lock, flags);
	bio_list_add(&tc->deferred_bio_list, bio);
	spin_unlock_irqrestore(&tc->lock, flags);
J
Joe Thornber 已提交
2245 2246 2247 2248

	wake_worker(pool);
}

J
Joe Thornber 已提交
2249 2250 2251 2252 2253 2254 2255 2256 2257
static void thin_defer_bio_with_throttle(struct thin_c *tc, struct bio *bio)
{
	struct pool *pool = tc->pool;

	throttle_lock(&pool->throttle);
	thin_defer_bio(tc, bio);
	throttle_unlock(&pool->throttle);
}

2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271
static void thin_defer_cell(struct thin_c *tc, struct dm_bio_prison_cell *cell)
{
	unsigned long flags;
	struct pool *pool = tc->pool;

	throttle_lock(&pool->throttle);
	spin_lock_irqsave(&tc->lock, flags);
	list_add_tail(&cell->user_list, &tc->deferred_cells);
	spin_unlock_irqrestore(&tc->lock, flags);
	throttle_unlock(&pool->throttle);

	wake_worker(pool);
}

M
Mikulas Patocka 已提交
2272
static void thin_hook_bio(struct thin_c *tc, struct bio *bio)
2273
{
M
Mikulas Patocka 已提交
2274
	struct dm_thin_endio_hook *h = dm_per_bio_data(bio, sizeof(struct dm_thin_endio_hook));
2275 2276 2277

	h->tc = tc;
	h->shared_read_entry = NULL;
2278
	h->all_io_entry = NULL;
2279 2280 2281
	h->overwrite_mapping = NULL;
}

J
Joe Thornber 已提交
2282 2283 2284
/*
 * Non-blocking function called from the thin target's map function.
 */
M
Mikulas Patocka 已提交
2285
static int thin_bio_map(struct dm_target *ti, struct bio *bio)
J
Joe Thornber 已提交
2286 2287 2288 2289 2290 2291
{
	int r;
	struct thin_c *tc = ti->private;
	dm_block_t block = get_bio_block(tc, bio);
	struct dm_thin_device *td = tc->td;
	struct dm_thin_lookup_result result;
2292
	struct dm_bio_prison_cell *virt_cell, *data_cell;
2293
	struct dm_cell_key key;
J
Joe Thornber 已提交
2294

M
Mikulas Patocka 已提交
2295
	thin_hook_bio(tc, bio);
2296

2297 2298 2299 2300 2301
	if (tc->requeue_mode) {
		bio_endio(bio, DM_ENDIO_REQUEUE);
		return DM_MAPIO_SUBMITTED;
	}

2302 2303 2304 2305 2306
	if (get_pool_mode(tc->pool) == PM_FAIL) {
		bio_io_error(bio);
		return DM_MAPIO_SUBMITTED;
	}

J
Joe Thornber 已提交
2307
	if (bio->bi_rw & (REQ_DISCARD | REQ_FLUSH | REQ_FUA)) {
J
Joe Thornber 已提交
2308
		thin_defer_bio_with_throttle(tc, bio);
J
Joe Thornber 已提交
2309 2310 2311
		return DM_MAPIO_SUBMITTED;
	}

2312 2313 2314 2315 2316
	/*
	 * We must hold the virtual cell before doing the lookup, otherwise
	 * there's a race with discard.
	 */
	build_virtual_key(tc->td, block, &key);
2317
	if (bio_detain(tc->pool, &key, bio, &virt_cell))
2318 2319
		return DM_MAPIO_SUBMITTED;

J
Joe Thornber 已提交
2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341
	r = dm_thin_find_block(td, block, 0, &result);

	/*
	 * Note that we defer readahead too.
	 */
	switch (r) {
	case 0:
		if (unlikely(result.shared)) {
			/*
			 * We have a race condition here between the
			 * result.shared value returned by the lookup and
			 * snapshot creation, which may cause new
			 * sharing.
			 *
			 * To avoid this always quiesce the origin before
			 * taking the snap.  You want to do this anyway to
			 * ensure a consistent application view
			 * (i.e. lockfs).
			 *
			 * More distant ancestors are irrelevant. The
			 * shared flag will be set in their case.
			 */
2342
			thin_defer_cell(tc, virt_cell);
2343
			return DM_MAPIO_SUBMITTED;
J
Joe Thornber 已提交
2344
		}
2345 2346

		build_data_key(tc->td, result.block, &key);
2347 2348
		if (bio_detain(tc->pool, &key, bio, &data_cell)) {
			cell_defer_no_holder(tc, virt_cell);
2349 2350 2351 2352
			return DM_MAPIO_SUBMITTED;
		}

		inc_all_io_entry(tc->pool, bio);
2353 2354
		cell_defer_no_holder(tc, data_cell);
		cell_defer_no_holder(tc, virt_cell);
2355 2356 2357

		remap(tc, bio, result.block);
		return DM_MAPIO_REMAPPED;
J
Joe Thornber 已提交
2358 2359

	case -ENODATA:
2360 2361 2362
		if (get_pool_mode(tc->pool) == PM_READ_ONLY) {
			/*
			 * This block isn't provisioned, and we have no way
2363
			 * of doing so.
2364
			 */
2365
			handle_unserviceable_bio(tc->pool, bio);
2366
			cell_defer_no_holder(tc, virt_cell);
J
Joe Thornber 已提交
2367
			return DM_MAPIO_SUBMITTED;
2368 2369 2370 2371
		}
		/* fall through */

	case -EWOULDBLOCK:
2372
		thin_defer_cell(tc, virt_cell);
J
Joe Thornber 已提交
2373
		return DM_MAPIO_SUBMITTED;
2374 2375 2376 2377 2378 2379 2380 2381

	default:
		/*
		 * Must always call bio_io_error on failure.
		 * dm_thin_find_block can fail with -EINVAL if the
		 * pool is switched to fail-io mode.
		 */
		bio_io_error(bio);
2382
		cell_defer_no_holder(tc, virt_cell);
J
Joe Thornber 已提交
2383
		return DM_MAPIO_SUBMITTED;
J
Joe Thornber 已提交
2384 2385 2386 2387 2388 2389
	}
}

static int pool_is_congested(struct dm_target_callbacks *cb, int bdi_bits)
{
	struct pool_c *pt = container_of(cb, struct pool_c, callbacks);
2390
	struct request_queue *q;
J
Joe Thornber 已提交
2391

2392 2393
	if (get_pool_mode(pt->pool) == PM_OUT_OF_DATA_SPACE)
		return 1;
J
Joe Thornber 已提交
2394

2395 2396
	q = bdev_get_queue(pt->data_dev->bdev);
	return bdi_congested(&q->backing_dev_info, bdi_bits);
J
Joe Thornber 已提交
2397 2398
}

2399
static void requeue_bios(struct pool *pool)
J
Joe Thornber 已提交
2400
{
2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411
	unsigned long flags;
	struct thin_c *tc;

	rcu_read_lock();
	list_for_each_entry_rcu(tc, &pool->active_thins, list) {
		spin_lock_irqsave(&tc->lock, flags);
		bio_list_merge(&tc->deferred_bio_list, &tc->retry_on_resume_list);
		bio_list_init(&tc->retry_on_resume_list);
		spin_unlock_irqrestore(&tc->lock, flags);
	}
	rcu_read_unlock();
J
Joe Thornber 已提交
2412 2413 2414 2415 2416
}

/*----------------------------------------------------------------
 * Binding of control targets to a pool object
 *--------------------------------------------------------------*/
M
Mike Snitzer 已提交
2417 2418 2419 2420 2421 2422 2423
static bool data_dev_supports_discard(struct pool_c *pt)
{
	struct request_queue *q = bdev_get_queue(pt->data_dev->bdev);

	return q && blk_queue_discard(q);
}

2424 2425 2426 2427 2428
static bool is_factor(sector_t block_size, uint32_t n)
{
	return !sector_div(block_size, n);
}

M
Mike Snitzer 已提交
2429 2430
/*
 * If discard_passdown was enabled verify that the data device
2431
 * supports discards.  Disable discard_passdown if not.
M
Mike Snitzer 已提交
2432
 */
2433
static void disable_passdown_if_not_supported(struct pool_c *pt)
M
Mike Snitzer 已提交
2434
{
2435 2436 2437 2438 2439
	struct pool *pool = pt->pool;
	struct block_device *data_bdev = pt->data_dev->bdev;
	struct queue_limits *data_limits = &bdev_get_queue(data_bdev)->limits;
	sector_t block_size = pool->sectors_per_block << SECTOR_SHIFT;
	const char *reason = NULL;
M
Mike Snitzer 已提交
2440 2441
	char buf[BDEVNAME_SIZE];

2442
	if (!pt->adjusted_pf.discard_passdown)
M
Mike Snitzer 已提交
2443 2444
		return;

2445 2446 2447 2448 2449
	if (!data_dev_supports_discard(pt))
		reason = "discard unsupported";

	else if (data_limits->max_discard_sectors < pool->sectors_per_block)
		reason = "max discard sectors smaller than a block";
M
Mike Snitzer 已提交
2450

2451 2452 2453
	else if (data_limits->discard_granularity > block_size)
		reason = "discard granularity larger than a block";

2454
	else if (!is_factor(block_size, data_limits->discard_granularity))
2455 2456 2457 2458 2459 2460
		reason = "discard granularity not a factor of block size";

	if (reason) {
		DMWARN("Data device (%s) %s: Disabling discard passdown.", bdevname(data_bdev, buf), reason);
		pt->adjusted_pf.discard_passdown = false;
	}
M
Mike Snitzer 已提交
2461 2462
}

J
Joe Thornber 已提交
2463 2464 2465 2466
static int bind_control_target(struct pool *pool, struct dm_target *ti)
{
	struct pool_c *pt = ti->private;

2467
	/*
2468
	 * We want to make sure that a pool in PM_FAIL mode is never upgraded.
2469
	 */
2470
	enum pool_mode old_mode = get_pool_mode(pool);
2471
	enum pool_mode new_mode = pt->adjusted_pf.mode;
2472

2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483
	/*
	 * Don't change the pool's mode until set_pool_mode() below.
	 * Otherwise the pool's process_* function pointers may
	 * not match the desired pool mode.
	 */
	pt->adjusted_pf.mode = old_mode;

	pool->ti = ti;
	pool->pf = pt->adjusted_pf;
	pool->low_water_blocks = pt->low_water_blocks;

M
Mike Snitzer 已提交
2484
	set_pool_mode(pool, new_mode);
2485

J
Joe Thornber 已提交
2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497
	return 0;
}

static void unbind_control_target(struct pool *pool, struct dm_target *ti)
{
	if (pool->ti == ti)
		pool->ti = NULL;
}

/*----------------------------------------------------------------
 * Pool creation
 *--------------------------------------------------------------*/
2498 2499 2500
/* Initialize pool features. */
static void pool_features_init(struct pool_features *pf)
{
2501
	pf->mode = PM_WRITE;
M
Mike Snitzer 已提交
2502 2503 2504
	pf->zero_new_blocks = true;
	pf->discard_enabled = true;
	pf->discard_passdown = true;
2505
	pf->error_if_no_space = false;
2506 2507
}

J
Joe Thornber 已提交
2508 2509 2510 2511 2512 2513 2514
static void __pool_destroy(struct pool *pool)
{
	__pool_table_remove(pool);

	if (dm_pool_metadata_close(pool->pmd) < 0)
		DMWARN("%s: dm_pool_metadata_close() failed.", __func__);

2515
	dm_bio_prison_destroy(pool->prison);
J
Joe Thornber 已提交
2516 2517 2518 2519 2520 2521 2522 2523
	dm_kcopyd_client_destroy(pool->copier);

	if (pool->wq)
		destroy_workqueue(pool->wq);

	if (pool->next_mapping)
		mempool_free(pool->next_mapping, pool->mapping_pool);
	mempool_destroy(pool->mapping_pool);
2524 2525
	dm_deferred_set_destroy(pool->shared_read_ds);
	dm_deferred_set_destroy(pool->all_io_ds);
J
Joe Thornber 已提交
2526 2527 2528
	kfree(pool);
}

M
Mike Snitzer 已提交
2529 2530
static struct kmem_cache *_new_mapping_cache;

J
Joe Thornber 已提交
2531 2532
static struct pool *pool_create(struct mapped_device *pool_md,
				struct block_device *metadata_dev,
2533 2534
				unsigned long block_size,
				int read_only, char **error)
J
Joe Thornber 已提交
2535 2536 2537 2538 2539
{
	int r;
	void *err_p;
	struct pool *pool;
	struct dm_pool_metadata *pmd;
2540
	bool format_device = read_only ? false : true;
J
Joe Thornber 已提交
2541

2542
	pmd = dm_pool_metadata_open(metadata_dev, block_size, format_device);
J
Joe Thornber 已提交
2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556
	if (IS_ERR(pmd)) {
		*error = "Error creating metadata object";
		return (struct pool *)pmd;
	}

	pool = kmalloc(sizeof(*pool), GFP_KERNEL);
	if (!pool) {
		*error = "Error allocating memory for pool";
		err_p = ERR_PTR(-ENOMEM);
		goto bad_pool;
	}

	pool->pmd = pmd;
	pool->sectors_per_block = block_size;
2557 2558 2559 2560
	if (block_size & (block_size - 1))
		pool->sectors_per_block_shift = -1;
	else
		pool->sectors_per_block_shift = __ffs(block_size);
J
Joe Thornber 已提交
2561
	pool->low_water_blocks = 0;
2562
	pool_features_init(&pool->pf);
2563
	pool->prison = dm_bio_prison_create();
J
Joe Thornber 已提交
2564 2565 2566 2567 2568 2569
	if (!pool->prison) {
		*error = "Error creating pool's bio prison";
		err_p = ERR_PTR(-ENOMEM);
		goto bad_prison;
	}

2570
	pool->copier = dm_kcopyd_client_create(&dm_kcopyd_throttle);
J
Joe Thornber 已提交
2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588
	if (IS_ERR(pool->copier)) {
		r = PTR_ERR(pool->copier);
		*error = "Error creating pool's kcopyd client";
		err_p = ERR_PTR(r);
		goto bad_kcopyd_client;
	}

	/*
	 * Create singlethreaded workqueue that will service all devices
	 * that use this metadata.
	 */
	pool->wq = alloc_ordered_workqueue("dm-" DM_MSG_PREFIX, WQ_MEM_RECLAIM);
	if (!pool->wq) {
		*error = "Error creating pool's workqueue";
		err_p = ERR_PTR(-ENOMEM);
		goto bad_wq;
	}

J
Joe Thornber 已提交
2589
	throttle_init(&pool->throttle);
J
Joe Thornber 已提交
2590
	INIT_WORK(&pool->worker, do_worker);
2591
	INIT_DELAYED_WORK(&pool->waker, do_waker);
2592
	INIT_DELAYED_WORK(&pool->no_space_timeout, do_no_space_timeout);
J
Joe Thornber 已提交
2593 2594 2595
	spin_lock_init(&pool->lock);
	bio_list_init(&pool->deferred_flush_bios);
	INIT_LIST_HEAD(&pool->prepared_mappings);
J
Joe Thornber 已提交
2596
	INIT_LIST_HEAD(&pool->prepared_discards);
2597
	INIT_LIST_HEAD(&pool->active_thins);
2598
	pool->low_water_triggered = false;
2599
	pool->suspended = true;
2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613

	pool->shared_read_ds = dm_deferred_set_create();
	if (!pool->shared_read_ds) {
		*error = "Error creating pool's shared read deferred set";
		err_p = ERR_PTR(-ENOMEM);
		goto bad_shared_read_ds;
	}

	pool->all_io_ds = dm_deferred_set_create();
	if (!pool->all_io_ds) {
		*error = "Error creating pool's all io deferred set";
		err_p = ERR_PTR(-ENOMEM);
		goto bad_all_io_ds;
	}
J
Joe Thornber 已提交
2614 2615

	pool->next_mapping = NULL;
M
Mike Snitzer 已提交
2616 2617
	pool->mapping_pool = mempool_create_slab_pool(MAPPING_POOL_SIZE,
						      _new_mapping_cache);
J
Joe Thornber 已提交
2618 2619 2620 2621 2622 2623 2624
	if (!pool->mapping_pool) {
		*error = "Error creating pool's mapping mempool";
		err_p = ERR_PTR(-ENOMEM);
		goto bad_mapping_pool;
	}

	pool->ref_count = 1;
2625
	pool->last_commit_jiffies = jiffies;
J
Joe Thornber 已提交
2626 2627 2628 2629 2630 2631 2632
	pool->pool_md = pool_md;
	pool->md_dev = metadata_dev;
	__pool_table_insert(pool);

	return pool;

bad_mapping_pool:
2633 2634 2635 2636
	dm_deferred_set_destroy(pool->all_io_ds);
bad_all_io_ds:
	dm_deferred_set_destroy(pool->shared_read_ds);
bad_shared_read_ds:
J
Joe Thornber 已提交
2637 2638 2639 2640
	destroy_workqueue(pool->wq);
bad_wq:
	dm_kcopyd_client_destroy(pool->copier);
bad_kcopyd_client:
2641
	dm_bio_prison_destroy(pool->prison);
J
Joe Thornber 已提交
2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666
bad_prison:
	kfree(pool);
bad_pool:
	if (dm_pool_metadata_close(pmd))
		DMWARN("%s: dm_pool_metadata_close() failed.", __func__);

	return err_p;
}

static void __pool_inc(struct pool *pool)
{
	BUG_ON(!mutex_is_locked(&dm_thin_pool_table.mutex));
	pool->ref_count++;
}

static void __pool_dec(struct pool *pool)
{
	BUG_ON(!mutex_is_locked(&dm_thin_pool_table.mutex));
	BUG_ON(!pool->ref_count);
	if (!--pool->ref_count)
		__pool_destroy(pool);
}

static struct pool *__pool_find(struct mapped_device *pool_md,
				struct block_device *metadata_dev,
2667 2668
				unsigned long block_size, int read_only,
				char **error, int *created)
J
Joe Thornber 已提交
2669 2670 2671 2672
{
	struct pool *pool = __pool_table_lookup_metadata_dev(metadata_dev);

	if (pool) {
2673 2674
		if (pool->pool_md != pool_md) {
			*error = "metadata device already in use by a pool";
J
Joe Thornber 已提交
2675
			return ERR_PTR(-EBUSY);
2676
		}
J
Joe Thornber 已提交
2677 2678 2679 2680 2681
		__pool_inc(pool);

	} else {
		pool = __pool_table_lookup(pool_md);
		if (pool) {
2682 2683
			if (pool->md_dev != metadata_dev) {
				*error = "different pool cannot replace a pool";
J
Joe Thornber 已提交
2684
				return ERR_PTR(-EINVAL);
2685
			}
J
Joe Thornber 已提交
2686 2687
			__pool_inc(pool);

2688
		} else {
2689
			pool = pool_create(pool_md, metadata_dev, block_size, read_only, error);
2690 2691
			*created = 1;
		}
J
Joe Thornber 已提交
2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722
	}

	return pool;
}

/*----------------------------------------------------------------
 * Pool target methods
 *--------------------------------------------------------------*/
static void pool_dtr(struct dm_target *ti)
{
	struct pool_c *pt = ti->private;

	mutex_lock(&dm_thin_pool_table.mutex);

	unbind_control_target(pt->pool, ti);
	__pool_dec(pt->pool);
	dm_put_device(ti, pt->metadata_dev);
	dm_put_device(ti, pt->data_dev);
	kfree(pt);

	mutex_unlock(&dm_thin_pool_table.mutex);
}

static int parse_pool_features(struct dm_arg_set *as, struct pool_features *pf,
			       struct dm_target *ti)
{
	int r;
	unsigned argc;
	const char *arg_name;

	static struct dm_arg _args[] = {
M
Mike Snitzer 已提交
2723
		{0, 4, "Invalid number of pool feature arguments"},
J
Joe Thornber 已提交
2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739
	};

	/*
	 * No feature arguments supplied.
	 */
	if (!as->argc)
		return 0;

	r = dm_read_arg_group(_args, as, &argc, &ti->error);
	if (r)
		return -EINVAL;

	while (argc && !r) {
		arg_name = dm_shift_arg(as);
		argc--;

2740
		if (!strcasecmp(arg_name, "skip_block_zeroing"))
M
Mike Snitzer 已提交
2741
			pf->zero_new_blocks = false;
2742 2743

		else if (!strcasecmp(arg_name, "ignore_discard"))
M
Mike Snitzer 已提交
2744
			pf->discard_enabled = false;
2745 2746

		else if (!strcasecmp(arg_name, "no_discard_passdown"))
M
Mike Snitzer 已提交
2747
			pf->discard_passdown = false;
J
Joe Thornber 已提交
2748

2749 2750 2751
		else if (!strcasecmp(arg_name, "read_only"))
			pf->mode = PM_READ_ONLY;

2752 2753 2754
		else if (!strcasecmp(arg_name, "error_if_no_space"))
			pf->error_if_no_space = true;

2755 2756 2757 2758 2759
		else {
			ti->error = "Unrecognised pool feature requested";
			r = -EINVAL;
			break;
		}
J
Joe Thornber 已提交
2760 2761 2762 2763 2764
	}

	return r;
}

2765 2766 2767 2768 2769 2770 2771 2772 2773 2774
static void metadata_low_callback(void *context)
{
	struct pool *pool = context;

	DMWARN("%s: reached low water mark for metadata device: sending event.",
	       dm_device_name(pool->pool_md));

	dm_table_event(pool->ti->table);
}

2775 2776 2777 2778 2779 2780
static sector_t get_dev_size(struct block_device *bdev)
{
	return i_size_read(bdev->bd_inode) >> SECTOR_SHIFT;
}

static void warn_if_metadata_device_too_big(struct block_device *bdev)
J
Joe Thornber 已提交
2781
{
2782
	sector_t metadata_dev_size = get_dev_size(bdev);
J
Joe Thornber 已提交
2783 2784
	char buffer[BDEVNAME_SIZE];

2785
	if (metadata_dev_size > THIN_METADATA_MAX_SECTORS_WARNING)
J
Joe Thornber 已提交
2786 2787
		DMWARN("Metadata device %s is larger than %u sectors: excess space will not be used.",
		       bdevname(bdev, buffer), THIN_METADATA_MAX_SECTORS);
2788 2789 2790 2791 2792 2793 2794 2795
}

static sector_t get_metadata_dev_size(struct block_device *bdev)
{
	sector_t metadata_dev_size = get_dev_size(bdev);

	if (metadata_dev_size > THIN_METADATA_MAX_SECTORS)
		metadata_dev_size = THIN_METADATA_MAX_SECTORS;
J
Joe Thornber 已提交
2796 2797 2798 2799

	return metadata_dev_size;
}

2800 2801 2802 2803
static dm_block_t get_metadata_dev_size_in_blocks(struct block_device *bdev)
{
	sector_t metadata_dev_size = get_metadata_dev_size(bdev);

2804
	sector_div(metadata_dev_size, THIN_METADATA_BLOCK_SIZE);
2805 2806 2807 2808

	return metadata_dev_size;
}

2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825
/*
 * When a metadata threshold is crossed a dm event is triggered, and
 * userland should respond by growing the metadata device.  We could let
 * userland set the threshold, like we do with the data threshold, but I'm
 * not sure they know enough to do this well.
 */
static dm_block_t calc_metadata_threshold(struct pool_c *pt)
{
	/*
	 * 4M is ample for all ops with the possible exception of thin
	 * device deletion which is harmless if it fails (just retry the
	 * delete after you've grown the device).
	 */
	dm_block_t quarter = get_metadata_dev_size_in_blocks(pt->metadata_dev->bdev) / 4;
	return min((dm_block_t)1024ULL /* 4M */, quarter);
}

J
Joe Thornber 已提交
2826 2827 2828 2829 2830 2831 2832 2833
/*
 * thin-pool <metadata dev> <data dev>
 *	     <data block size (sectors)>
 *	     <low water mark (blocks)>
 *	     [<#feature args> [<arg>]*]
 *
 * Optional feature arguments are:
 *	     skip_block_zeroing: skips the zeroing of newly-provisioned blocks.
2834 2835
 *	     ignore_discard: disable discard
 *	     no_discard_passdown: don't pass discards down to the data device
2836 2837
 *	     read_only: Don't allow any changes to be made to the pool metadata.
 *	     error_if_no_space: error IOs, instead of queueing, if no space.
J
Joe Thornber 已提交
2838 2839 2840
 */
static int pool_ctr(struct dm_target *ti, unsigned argc, char **argv)
{
2841
	int r, pool_created = 0;
J
Joe Thornber 已提交
2842 2843 2844 2845 2846 2847 2848 2849
	struct pool_c *pt;
	struct pool *pool;
	struct pool_features pf;
	struct dm_arg_set as;
	struct dm_dev *data_dev;
	unsigned long block_size;
	dm_block_t low_water_blocks;
	struct dm_dev *metadata_dev;
2850
	fmode_t metadata_mode;
J
Joe Thornber 已提交
2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861

	/*
	 * FIXME Remove validation from scope of lock.
	 */
	mutex_lock(&dm_thin_pool_table.mutex);

	if (argc < 4) {
		ti->error = "Invalid argument count";
		r = -EINVAL;
		goto out_unlock;
	}
2862

J
Joe Thornber 已提交
2863 2864 2865
	as.argc = argc;
	as.argv = argv;

2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877
	/*
	 * Set default pool features.
	 */
	pool_features_init(&pf);

	dm_consume_args(&as, 4);
	r = parse_pool_features(&as, &pf, ti);
	if (r)
		goto out_unlock;

	metadata_mode = FMODE_READ | ((pf.mode == PM_READ_ONLY) ? 0 : FMODE_WRITE);
	r = dm_get_device(ti, argv[0], metadata_mode, &metadata_dev);
J
Joe Thornber 已提交
2878 2879 2880 2881
	if (r) {
		ti->error = "Error opening metadata block device";
		goto out_unlock;
	}
2882
	warn_if_metadata_device_too_big(metadata_dev->bdev);
J
Joe Thornber 已提交
2883 2884 2885 2886 2887 2888 2889 2890 2891 2892

	r = dm_get_device(ti, argv[1], FMODE_READ | FMODE_WRITE, &data_dev);
	if (r) {
		ti->error = "Error getting data device";
		goto out_metadata;
	}

	if (kstrtoul(argv[2], 10, &block_size) || !block_size ||
	    block_size < DATA_DEV_BLOCK_SIZE_MIN_SECTORS ||
	    block_size > DATA_DEV_BLOCK_SIZE_MAX_SECTORS ||
2893
	    block_size & (DATA_DEV_BLOCK_SIZE_MIN_SECTORS - 1)) {
J
Joe Thornber 已提交
2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911
		ti->error = "Invalid block size";
		r = -EINVAL;
		goto out;
	}

	if (kstrtoull(argv[3], 10, (unsigned long long *)&low_water_blocks)) {
		ti->error = "Invalid low water mark";
		r = -EINVAL;
		goto out;
	}

	pt = kzalloc(sizeof(*pt), GFP_KERNEL);
	if (!pt) {
		r = -ENOMEM;
		goto out;
	}

	pool = __pool_find(dm_table_get_md(ti->table), metadata_dev->bdev,
2912
			   block_size, pf.mode == PM_READ_ONLY, &ti->error, &pool_created);
J
Joe Thornber 已提交
2913 2914 2915 2916 2917
	if (IS_ERR(pool)) {
		r = PTR_ERR(pool);
		goto out_free_pt;
	}

2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929
	/*
	 * 'pool_created' reflects whether this is the first table load.
	 * Top level discard support is not allowed to be changed after
	 * initial load.  This would require a pool reload to trigger thin
	 * device changes.
	 */
	if (!pool_created && pf.discard_enabled != pool->pf.discard_enabled) {
		ti->error = "Discard support cannot be disabled once enabled";
		r = -EINVAL;
		goto out_flags_changed;
	}

J
Joe Thornber 已提交
2930 2931 2932 2933 2934
	pt->pool = pool;
	pt->ti = ti;
	pt->metadata_dev = metadata_dev;
	pt->data_dev = data_dev;
	pt->low_water_blocks = low_water_blocks;
2935
	pt->adjusted_pf = pt->requested_pf = pf;
2936
	ti->num_flush_bios = 1;
M
Mike Snitzer 已提交
2937

2938 2939 2940 2941 2942
	/*
	 * Only need to enable discards if the pool should pass
	 * them down to the data device.  The thin device's discard
	 * processing will cause mappings to be removed from the btree.
	 */
2943
	ti->discard_zeroes_data_unsupported = true;
2944
	if (pf.discard_enabled && pf.discard_passdown) {
2945
		ti->num_discard_bios = 1;
M
Mike Snitzer 已提交
2946

2947 2948 2949 2950 2951
		/*
		 * Setting 'discards_supported' circumvents the normal
		 * stacking of discard limits (this keeps the pool and
		 * thin devices' discard limits consistent).
		 */
2952
		ti->discards_supported = true;
2953
	}
J
Joe Thornber 已提交
2954 2955
	ti->private = pt;

2956 2957 2958 2959 2960 2961 2962
	r = dm_pool_register_metadata_threshold(pt->pool->pmd,
						calc_metadata_threshold(pt),
						metadata_low_callback,
						pool);
	if (r)
		goto out_free_pt;

J
Joe Thornber 已提交
2963 2964 2965 2966 2967 2968 2969
	pt->callbacks.congested_fn = pool_is_congested;
	dm_table_add_target_callbacks(ti->table, &pt->callbacks);

	mutex_unlock(&dm_thin_pool_table.mutex);

	return 0;

2970 2971
out_flags_changed:
	__pool_dec(pool);
J
Joe Thornber 已提交
2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983
out_free_pt:
	kfree(pt);
out:
	dm_put_device(ti, data_dev);
out_metadata:
	dm_put_device(ti, metadata_dev);
out_unlock:
	mutex_unlock(&dm_thin_pool_table.mutex);

	return r;
}

M
Mikulas Patocka 已提交
2984
static int pool_map(struct dm_target *ti, struct bio *bio)
J
Joe Thornber 已提交
2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001
{
	int r;
	struct pool_c *pt = ti->private;
	struct pool *pool = pt->pool;
	unsigned long flags;

	/*
	 * As this is a singleton target, ti->begin is always zero.
	 */
	spin_lock_irqsave(&pool->lock, flags);
	bio->bi_bdev = pt->data_dev->bdev;
	r = DM_MAPIO_REMAPPED;
	spin_unlock_irqrestore(&pool->lock, flags);

	return r;
}

J
Joe Thornber 已提交
3002
static int maybe_resize_data_dev(struct dm_target *ti, bool *need_commit)
J
Joe Thornber 已提交
3003 3004 3005 3006
{
	int r;
	struct pool_c *pt = ti->private;
	struct pool *pool = pt->pool;
3007 3008
	sector_t data_size = ti->len;
	dm_block_t sb_data_size;
J
Joe Thornber 已提交
3009

J
Joe Thornber 已提交
3010
	*need_commit = false;
J
Joe Thornber 已提交
3011

3012 3013
	(void) sector_div(data_size, pool->sectors_per_block);

J
Joe Thornber 已提交
3014 3015
	r = dm_pool_get_data_dev_size(pool->pmd, &sb_data_size);
	if (r) {
3016 3017
		DMERR("%s: failed to retrieve data device size",
		      dm_device_name(pool->pool_md));
J
Joe Thornber 已提交
3018 3019 3020 3021
		return r;
	}

	if (data_size < sb_data_size) {
3022 3023
		DMERR("%s: pool target (%llu blocks) too small: expected %llu",
		      dm_device_name(pool->pool_md),
3024
		      (unsigned long long)data_size, sb_data_size);
J
Joe Thornber 已提交
3025 3026 3027
		return -EINVAL;

	} else if (data_size > sb_data_size) {
3028 3029 3030 3031 3032 3033
		if (dm_pool_metadata_needs_check(pool->pmd)) {
			DMERR("%s: unable to grow the data device until repaired.",
			      dm_device_name(pool->pool_md));
			return 0;
		}

3034 3035 3036 3037
		if (sb_data_size)
			DMINFO("%s: growing the data device from %llu to %llu blocks",
			       dm_device_name(pool->pool_md),
			       sb_data_size, (unsigned long long)data_size);
J
Joe Thornber 已提交
3038 3039
		r = dm_pool_resize_data_dev(pool->pmd, data_size);
		if (r) {
3040
			metadata_operation_failed(pool, "dm_pool_resize_data_dev", r);
J
Joe Thornber 已提交
3041 3042 3043
			return r;
		}

J
Joe Thornber 已提交
3044
		*need_commit = true;
J
Joe Thornber 已提交
3045 3046 3047 3048 3049
	}

	return 0;
}

3050 3051 3052 3053 3054 3055 3056 3057 3058
static int maybe_resize_metadata_dev(struct dm_target *ti, bool *need_commit)
{
	int r;
	struct pool_c *pt = ti->private;
	struct pool *pool = pt->pool;
	dm_block_t metadata_dev_size, sb_metadata_dev_size;

	*need_commit = false;

3059
	metadata_dev_size = get_metadata_dev_size_in_blocks(pool->md_dev);
3060 3061 3062

	r = dm_pool_get_metadata_dev_size(pool->pmd, &sb_metadata_dev_size);
	if (r) {
3063 3064
		DMERR("%s: failed to retrieve metadata device size",
		      dm_device_name(pool->pool_md));
3065 3066 3067 3068
		return r;
	}

	if (metadata_dev_size < sb_metadata_dev_size) {
3069 3070
		DMERR("%s: metadata device (%llu blocks) too small: expected %llu",
		      dm_device_name(pool->pool_md),
3071 3072 3073 3074
		      metadata_dev_size, sb_metadata_dev_size);
		return -EINVAL;

	} else if (metadata_dev_size > sb_metadata_dev_size) {
3075 3076 3077 3078 3079 3080
		if (dm_pool_metadata_needs_check(pool->pmd)) {
			DMERR("%s: unable to grow the metadata device until repaired.",
			      dm_device_name(pool->pool_md));
			return 0;
		}

3081
		warn_if_metadata_device_too_big(pool->md_dev);
3082 3083 3084
		DMINFO("%s: growing the metadata device from %llu to %llu blocks",
		       dm_device_name(pool->pool_md),
		       sb_metadata_dev_size, metadata_dev_size);
3085 3086
		r = dm_pool_resize_metadata_dev(pool->pmd, metadata_dev_size);
		if (r) {
3087
			metadata_operation_failed(pool, "dm_pool_resize_metadata_dev", r);
3088 3089 3090 3091 3092 3093 3094 3095 3096
			return r;
		}

		*need_commit = true;
	}

	return 0;
}

J
Joe Thornber 已提交
3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110
/*
 * Retrieves the number of blocks of the data device from
 * the superblock and compares it to the actual device size,
 * thus resizing the data device in case it has grown.
 *
 * This both copes with opening preallocated data devices in the ctr
 * being followed by a resume
 * -and-
 * calling the resume method individually after userspace has
 * grown the data device in reaction to a table event.
 */
static int pool_preresume(struct dm_target *ti)
{
	int r;
3111
	bool need_commit1, need_commit2;
J
Joe Thornber 已提交
3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125
	struct pool_c *pt = ti->private;
	struct pool *pool = pt->pool;

	/*
	 * Take control of the pool object.
	 */
	r = bind_control_target(pool, ti);
	if (r)
		return r;

	r = maybe_resize_data_dev(ti, &need_commit1);
	if (r)
		return r;

3126 3127 3128 3129 3130
	r = maybe_resize_metadata_dev(ti, &need_commit2);
	if (r)
		return r;

	if (need_commit1 || need_commit2)
3131
		(void) commit(pool);
J
Joe Thornber 已提交
3132 3133 3134 3135

	return 0;
}

3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159
static void pool_suspend_active_thins(struct pool *pool)
{
	struct thin_c *tc;

	/* Suspend all active thin devices */
	tc = get_first_thin(pool);
	while (tc) {
		dm_internal_suspend_noflush(tc->thin_md);
		tc = get_next_thin(pool, tc);
	}
}

static void pool_resume_active_thins(struct pool *pool)
{
	struct thin_c *tc;

	/* Resume all active thin devices */
	tc = get_first_thin(pool);
	while (tc) {
		dm_internal_resume(tc->thin_md);
		tc = get_next_thin(pool, tc);
	}
}

J
Joe Thornber 已提交
3160 3161 3162 3163 3164 3165
static void pool_resume(struct dm_target *ti)
{
	struct pool_c *pt = ti->private;
	struct pool *pool = pt->pool;
	unsigned long flags;

3166 3167 3168 3169 3170 3171 3172
	/*
	 * Must requeue active_thins' bios and then resume
	 * active_thins _before_ clearing 'suspend' flag.
	 */
	requeue_bios(pool);
	pool_resume_active_thins(pool);

J
Joe Thornber 已提交
3173
	spin_lock_irqsave(&pool->lock, flags);
3174
	pool->low_water_triggered = false;
3175
	pool->suspended = false;
J
Joe Thornber 已提交
3176
	spin_unlock_irqrestore(&pool->lock, flags);
3177

3178
	do_waker(&pool->waker.work);
J
Joe Thornber 已提交
3179 3180
}

3181 3182 3183 3184 3185 3186 3187 3188 3189
static void pool_presuspend(struct dm_target *ti)
{
	struct pool_c *pt = ti->private;
	struct pool *pool = pt->pool;
	unsigned long flags;

	spin_lock_irqsave(&pool->lock, flags);
	pool->suspended = true;
	spin_unlock_irqrestore(&pool->lock, flags);
3190 3191

	pool_suspend_active_thins(pool);
3192 3193 3194 3195 3196 3197 3198 3199
}

static void pool_presuspend_undo(struct dm_target *ti)
{
	struct pool_c *pt = ti->private;
	struct pool *pool = pt->pool;
	unsigned long flags;

3200 3201
	pool_resume_active_thins(pool);

3202 3203 3204 3205 3206
	spin_lock_irqsave(&pool->lock, flags);
	pool->suspended = false;
	spin_unlock_irqrestore(&pool->lock, flags);
}

J
Joe Thornber 已提交
3207 3208 3209 3210 3211
static void pool_postsuspend(struct dm_target *ti)
{
	struct pool_c *pt = ti->private;
	struct pool *pool = pt->pool;

3212
	cancel_delayed_work(&pool->waker);
3213
	cancel_delayed_work(&pool->no_space_timeout);
J
Joe Thornber 已提交
3214
	flush_workqueue(pool->wq);
3215
	(void) commit(pool);
J
Joe Thornber 已提交
3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340
}

static int check_arg_count(unsigned argc, unsigned args_required)
{
	if (argc != args_required) {
		DMWARN("Message received with %u arguments instead of %u.",
		       argc, args_required);
		return -EINVAL;
	}

	return 0;
}

static int read_dev_id(char *arg, dm_thin_id *dev_id, int warning)
{
	if (!kstrtoull(arg, 10, (unsigned long long *)dev_id) &&
	    *dev_id <= MAX_DEV_ID)
		return 0;

	if (warning)
		DMWARN("Message received with invalid device id: %s", arg);

	return -EINVAL;
}

static int process_create_thin_mesg(unsigned argc, char **argv, struct pool *pool)
{
	dm_thin_id dev_id;
	int r;

	r = check_arg_count(argc, 2);
	if (r)
		return r;

	r = read_dev_id(argv[1], &dev_id, 1);
	if (r)
		return r;

	r = dm_pool_create_thin(pool->pmd, dev_id);
	if (r) {
		DMWARN("Creation of new thinly-provisioned device with id %s failed.",
		       argv[1]);
		return r;
	}

	return 0;
}

static int process_create_snap_mesg(unsigned argc, char **argv, struct pool *pool)
{
	dm_thin_id dev_id;
	dm_thin_id origin_dev_id;
	int r;

	r = check_arg_count(argc, 3);
	if (r)
		return r;

	r = read_dev_id(argv[1], &dev_id, 1);
	if (r)
		return r;

	r = read_dev_id(argv[2], &origin_dev_id, 1);
	if (r)
		return r;

	r = dm_pool_create_snap(pool->pmd, dev_id, origin_dev_id);
	if (r) {
		DMWARN("Creation of new snapshot %s of device %s failed.",
		       argv[1], argv[2]);
		return r;
	}

	return 0;
}

static int process_delete_mesg(unsigned argc, char **argv, struct pool *pool)
{
	dm_thin_id dev_id;
	int r;

	r = check_arg_count(argc, 2);
	if (r)
		return r;

	r = read_dev_id(argv[1], &dev_id, 1);
	if (r)
		return r;

	r = dm_pool_delete_thin_device(pool->pmd, dev_id);
	if (r)
		DMWARN("Deletion of thin device %s failed.", argv[1]);

	return r;
}

static int process_set_transaction_id_mesg(unsigned argc, char **argv, struct pool *pool)
{
	dm_thin_id old_id, new_id;
	int r;

	r = check_arg_count(argc, 3);
	if (r)
		return r;

	if (kstrtoull(argv[1], 10, (unsigned long long *)&old_id)) {
		DMWARN("set_transaction_id message: Unrecognised id %s.", argv[1]);
		return -EINVAL;
	}

	if (kstrtoull(argv[2], 10, (unsigned long long *)&new_id)) {
		DMWARN("set_transaction_id message: Unrecognised new id %s.", argv[2]);
		return -EINVAL;
	}

	r = dm_pool_set_metadata_transaction_id(pool->pmd, old_id, new_id);
	if (r) {
		DMWARN("Failed to change transaction id from %s to %s.",
		       argv[1], argv[2]);
		return r;
	}

	return 0;
}

3341 3342 3343 3344 3345 3346 3347 3348
static int process_reserve_metadata_snap_mesg(unsigned argc, char **argv, struct pool *pool)
{
	int r;

	r = check_arg_count(argc, 1);
	if (r)
		return r;

3349
	(void) commit(pool);
3350

3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372
	r = dm_pool_reserve_metadata_snap(pool->pmd);
	if (r)
		DMWARN("reserve_metadata_snap message failed.");

	return r;
}

static int process_release_metadata_snap_mesg(unsigned argc, char **argv, struct pool *pool)
{
	int r;

	r = check_arg_count(argc, 1);
	if (r)
		return r;

	r = dm_pool_release_metadata_snap(pool->pmd);
	if (r)
		DMWARN("release_metadata_snap message failed.");

	return r;
}

J
Joe Thornber 已提交
3373 3374 3375 3376 3377 3378
/*
 * Messages supported:
 *   create_thin	<dev_id>
 *   create_snap	<dev_id> <origin_id>
 *   delete		<dev_id>
 *   set_transaction_id <current_trans_id> <new_trans_id>
3379 3380
 *   reserve_metadata_snap
 *   release_metadata_snap
J
Joe Thornber 已提交
3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399
 */
static int pool_message(struct dm_target *ti, unsigned argc, char **argv)
{
	int r = -EINVAL;
	struct pool_c *pt = ti->private;
	struct pool *pool = pt->pool;

	if (!strcasecmp(argv[0], "create_thin"))
		r = process_create_thin_mesg(argc, argv, pool);

	else if (!strcasecmp(argv[0], "create_snap"))
		r = process_create_snap_mesg(argc, argv, pool);

	else if (!strcasecmp(argv[0], "delete"))
		r = process_delete_mesg(argc, argv, pool);

	else if (!strcasecmp(argv[0], "set_transaction_id"))
		r = process_set_transaction_id_mesg(argc, argv, pool);

3400 3401 3402 3403 3404 3405
	else if (!strcasecmp(argv[0], "reserve_metadata_snap"))
		r = process_reserve_metadata_snap_mesg(argc, argv, pool);

	else if (!strcasecmp(argv[0], "release_metadata_snap"))
		r = process_release_metadata_snap_mesg(argc, argv, pool);

J
Joe Thornber 已提交
3406 3407 3408
	else
		DMWARN("Unrecognised thin pool target message received: %s", argv[0]);

3409
	if (!r)
3410
		(void) commit(pool);
J
Joe Thornber 已提交
3411 3412 3413 3414

	return r;
}

3415 3416 3417 3418
static void emit_flags(struct pool_features *pf, char *result,
		       unsigned sz, unsigned maxlen)
{
	unsigned count = !pf->zero_new_blocks + !pf->discard_enabled +
3419 3420
		!pf->discard_passdown + (pf->mode == PM_READ_ONLY) +
		pf->error_if_no_space;
3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433
	DMEMIT("%u ", count);

	if (!pf->zero_new_blocks)
		DMEMIT("skip_block_zeroing ");

	if (!pf->discard_enabled)
		DMEMIT("ignore_discard ");

	if (!pf->discard_passdown)
		DMEMIT("no_discard_passdown ");

	if (pf->mode == PM_READ_ONLY)
		DMEMIT("read_only ");
3434 3435 3436

	if (pf->error_if_no_space)
		DMEMIT("error_if_no_space ");
3437 3438
}

J
Joe Thornber 已提交
3439 3440 3441 3442 3443
/*
 * Status line is:
 *    <transaction id> <used metadata sectors>/<total metadata sectors>
 *    <used data sectors>/<total data sectors> <held metadata root>
 */
3444 3445
static void pool_status(struct dm_target *ti, status_type_t type,
			unsigned status_flags, char *result, unsigned maxlen)
J
Joe Thornber 已提交
3446
{
3447
	int r;
J
Joe Thornber 已提交
3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461
	unsigned sz = 0;
	uint64_t transaction_id;
	dm_block_t nr_free_blocks_data;
	dm_block_t nr_free_blocks_metadata;
	dm_block_t nr_blocks_data;
	dm_block_t nr_blocks_metadata;
	dm_block_t held_root;
	char buf[BDEVNAME_SIZE];
	char buf2[BDEVNAME_SIZE];
	struct pool_c *pt = ti->private;
	struct pool *pool = pt->pool;

	switch (type) {
	case STATUSTYPE_INFO:
3462 3463 3464 3465 3466
		if (get_pool_mode(pool) == PM_FAIL) {
			DMEMIT("Fail");
			break;
		}

3467 3468
		/* Commit to ensure statistics aren't out-of-date */
		if (!(status_flags & DM_STATUS_NOFLUSH_FLAG) && !dm_suspended(ti))
3469
			(void) commit(pool);
3470

3471 3472
		r = dm_pool_get_metadata_transaction_id(pool->pmd, &transaction_id);
		if (r) {
3473 3474
			DMERR("%s: dm_pool_get_metadata_transaction_id returned %d",
			      dm_device_name(pool->pool_md), r);
3475 3476
			goto err;
		}
J
Joe Thornber 已提交
3477

3478 3479
		r = dm_pool_get_free_metadata_block_count(pool->pmd, &nr_free_blocks_metadata);
		if (r) {
3480 3481
			DMERR("%s: dm_pool_get_free_metadata_block_count returned %d",
			      dm_device_name(pool->pool_md), r);
3482 3483
			goto err;
		}
J
Joe Thornber 已提交
3484 3485

		r = dm_pool_get_metadata_dev_size(pool->pmd, &nr_blocks_metadata);
3486
		if (r) {
3487 3488
			DMERR("%s: dm_pool_get_metadata_dev_size returned %d",
			      dm_device_name(pool->pool_md), r);
3489 3490
			goto err;
		}
J
Joe Thornber 已提交
3491

3492 3493
		r = dm_pool_get_free_block_count(pool->pmd, &nr_free_blocks_data);
		if (r) {
3494 3495
			DMERR("%s: dm_pool_get_free_block_count returned %d",
			      dm_device_name(pool->pool_md), r);
3496 3497
			goto err;
		}
J
Joe Thornber 已提交
3498 3499

		r = dm_pool_get_data_dev_size(pool->pmd, &nr_blocks_data);
3500
		if (r) {
3501 3502
			DMERR("%s: dm_pool_get_data_dev_size returned %d",
			      dm_device_name(pool->pool_md), r);
3503 3504
			goto err;
		}
J
Joe Thornber 已提交
3505

3506
		r = dm_pool_get_metadata_snap(pool->pmd, &held_root);
3507
		if (r) {
3508 3509
			DMERR("%s: dm_pool_get_metadata_snap returned %d",
			      dm_device_name(pool->pool_md), r);
3510 3511
			goto err;
		}
J
Joe Thornber 已提交
3512 3513 3514 3515 3516 3517 3518 3519 3520

		DMEMIT("%llu %llu/%llu %llu/%llu ",
		       (unsigned long long)transaction_id,
		       (unsigned long long)(nr_blocks_metadata - nr_free_blocks_metadata),
		       (unsigned long long)nr_blocks_metadata,
		       (unsigned long long)(nr_blocks_data - nr_free_blocks_data),
		       (unsigned long long)nr_blocks_data);

		if (held_root)
3521 3522 3523 3524
			DMEMIT("%llu ", held_root);
		else
			DMEMIT("- ");

3525 3526 3527
		if (pool->pf.mode == PM_OUT_OF_DATA_SPACE)
			DMEMIT("out_of_data_space ");
		else if (pool->pf.mode == PM_READ_ONLY)
3528
			DMEMIT("ro ");
J
Joe Thornber 已提交
3529
		else
3530 3531
			DMEMIT("rw ");

3532
		if (!pool->pf.discard_enabled)
3533
			DMEMIT("ignore_discard ");
3534
		else if (pool->pf.discard_passdown)
3535 3536 3537 3538 3539 3540
			DMEMIT("discard_passdown ");
		else
			DMEMIT("no_discard_passdown ");

		if (pool->pf.error_if_no_space)
			DMEMIT("error_if_no_space ");
3541
		else
3542
			DMEMIT("queue_if_no_space ");
J
Joe Thornber 已提交
3543 3544 3545 3546 3547 3548 3549 3550 3551

		break;

	case STATUSTYPE_TABLE:
		DMEMIT("%s %s %lu %llu ",
		       format_dev_t(buf, pt->metadata_dev->bdev->bd_dev),
		       format_dev_t(buf2, pt->data_dev->bdev->bd_dev),
		       (unsigned long)pool->sectors_per_block,
		       (unsigned long long)pt->low_water_blocks);
3552
		emit_flags(&pt->requested_pf, result, sz, maxlen);
J
Joe Thornber 已提交
3553 3554
		break;
	}
3555
	return;
J
Joe Thornber 已提交
3556

3557 3558
err:
	DMEMIT("Error");
J
Joe Thornber 已提交
3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582
}

static int pool_iterate_devices(struct dm_target *ti,
				iterate_devices_callout_fn fn, void *data)
{
	struct pool_c *pt = ti->private;

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

static int pool_merge(struct dm_target *ti, struct bvec_merge_data *bvm,
		      struct bio_vec *biovec, int max_size)
{
	struct pool_c *pt = ti->private;
	struct request_queue *q = bdev_get_queue(pt->data_dev->bdev);

	if (!q->merge_bvec_fn)
		return max_size;

	bvm->bi_bdev = pt->data_dev->bdev;

	return min(max_size, q->merge_bvec_fn(q, bvm, biovec));
}

3583
static void set_discard_limits(struct pool_c *pt, struct queue_limits *limits)
J
Joe Thornber 已提交
3584
{
3585 3586 3587
	struct pool *pool = pt->pool;
	struct queue_limits *data_limits;

J
Joe Thornber 已提交
3588 3589 3590
	limits->max_discard_sectors = pool->sectors_per_block;

	/*
3591
	 * discard_granularity is just a hint, and not enforced.
J
Joe Thornber 已提交
3592
	 */
3593 3594
	if (pt->adjusted_pf.discard_passdown) {
		data_limits = &bdev_get_queue(pt->data_dev->bdev)->limits;
3595 3596
		limits->discard_granularity = max(data_limits->discard_granularity,
						  pool->sectors_per_block << SECTOR_SHIFT);
3597
	} else
3598
		limits->discard_granularity = pool->sectors_per_block << SECTOR_SHIFT;
J
Joe Thornber 已提交
3599 3600
}

J
Joe Thornber 已提交
3601 3602 3603 3604
static void pool_io_hints(struct dm_target *ti, struct queue_limits *limits)
{
	struct pool_c *pt = ti->private;
	struct pool *pool = pt->pool;
3605 3606 3607
	sector_t io_opt_sectors = limits->io_opt >> SECTOR_SHIFT;

	/*
3608 3609 3610 3611 3612 3613 3614
	 * If max_sectors is smaller than pool->sectors_per_block adjust it
	 * to the highest possible power-of-2 factor of pool->sectors_per_block.
	 * This is especially beneficial when the pool's data device is a RAID
	 * device that has a full stripe width that matches pool->sectors_per_block
	 * -- because even though partial RAID stripe-sized IOs will be issued to a
	 *    single RAID stripe; when aggregated they will end on a full RAID stripe
	 *    boundary.. which avoids additional partial RAID stripe writes cascading
3615 3616 3617 3618 3619 3620 3621 3622
	 */
	if (limits->max_sectors < pool->sectors_per_block) {
		while (!is_factor(pool->sectors_per_block, limits->max_sectors)) {
			if ((limits->max_sectors & (limits->max_sectors - 1)) == 0)
				limits->max_sectors--;
			limits->max_sectors = rounddown_pow_of_two(limits->max_sectors);
		}
	}
J
Joe Thornber 已提交
3623

3624 3625 3626 3627 3628
	/*
	 * If the system-determined stacked limits are compatible with the
	 * pool's blocksize (io_opt is a factor) do not override them.
	 */
	if (io_opt_sectors < pool->sectors_per_block ||
3629 3630 3631 3632 3633
	    !is_factor(io_opt_sectors, pool->sectors_per_block)) {
		if (is_factor(pool->sectors_per_block, limits->max_sectors))
			blk_limits_io_min(limits, limits->max_sectors << SECTOR_SHIFT);
		else
			blk_limits_io_min(limits, pool->sectors_per_block << SECTOR_SHIFT);
3634 3635
		blk_limits_io_opt(limits, pool->sectors_per_block << SECTOR_SHIFT);
	}
3636 3637 3638 3639 3640 3641

	/*
	 * pt->adjusted_pf is a staging area for the actual features to use.
	 * They get transferred to the live pool in bind_control_target()
	 * called from pool_preresume().
	 */
3642 3643 3644 3645 3646 3647 3648 3649
	if (!pt->adjusted_pf.discard_enabled) {
		/*
		 * Must explicitly disallow stacking discard limits otherwise the
		 * block layer will stack them if pool's data device has support.
		 * QUEUE_FLAG_DISCARD wouldn't be set but there is no way for the
		 * user to see that, so make sure to set all discard limits to 0.
		 */
		limits->discard_granularity = 0;
3650
		return;
3651
	}
3652 3653 3654 3655

	disable_passdown_if_not_supported(pt);

	set_discard_limits(pt, limits);
J
Joe Thornber 已提交
3656 3657 3658 3659 3660 3661
}

static struct target_type pool_target = {
	.name = "thin-pool",
	.features = DM_TARGET_SINGLETON | DM_TARGET_ALWAYS_WRITEABLE |
		    DM_TARGET_IMMUTABLE,
M
Mike Snitzer 已提交
3662
	.version = {1, 14, 0},
J
Joe Thornber 已提交
3663 3664 3665 3666
	.module = THIS_MODULE,
	.ctr = pool_ctr,
	.dtr = pool_dtr,
	.map = pool_map,
3667 3668
	.presuspend = pool_presuspend,
	.presuspend_undo = pool_presuspend_undo,
J
Joe Thornber 已提交
3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681
	.postsuspend = pool_postsuspend,
	.preresume = pool_preresume,
	.resume = pool_resume,
	.message = pool_message,
	.status = pool_status,
	.merge = pool_merge,
	.iterate_devices = pool_iterate_devices,
	.io_hints = pool_io_hints,
};

/*----------------------------------------------------------------
 * Thin target methods
 *--------------------------------------------------------------*/
3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692
static void thin_get(struct thin_c *tc)
{
	atomic_inc(&tc->refcount);
}

static void thin_put(struct thin_c *tc)
{
	if (atomic_dec_and_test(&tc->refcount))
		complete(&tc->can_destroy);
}

J
Joe Thornber 已提交
3693 3694 3695
static void thin_dtr(struct dm_target *ti)
{
	struct thin_c *tc = ti->private;
3696 3697 3698 3699 3700 3701
	unsigned long flags;

	spin_lock_irqsave(&tc->pool->lock, flags);
	list_del_rcu(&tc->list);
	spin_unlock_irqrestore(&tc->pool->lock, flags);
	synchronize_rcu();
J
Joe Thornber 已提交
3702

M
Mikulas Patocka 已提交
3703 3704 3705
	thin_put(tc);
	wait_for_completion(&tc->can_destroy);

J
Joe Thornber 已提交
3706 3707 3708 3709 3710
	mutex_lock(&dm_thin_pool_table.mutex);

	__pool_dec(tc->pool);
	dm_pool_close_thin_device(tc->td);
	dm_put_device(ti, tc->pool_dev);
3711 3712
	if (tc->origin_dev)
		dm_put_device(ti, tc->origin_dev);
J
Joe Thornber 已提交
3713 3714 3715 3716 3717 3718 3719 3720
	kfree(tc);

	mutex_unlock(&dm_thin_pool_table.mutex);
}

/*
 * Thin target parameters:
 *
3721
 * <pool_dev> <dev_id> [origin_dev]
J
Joe Thornber 已提交
3722 3723 3724
 *
 * pool_dev: the path to the pool (eg, /dev/mapper/my_pool)
 * dev_id: the internal device identifier
3725
 * origin_dev: a device external to the pool that should act as the origin
3726 3727 3728
 *
 * If the pool device has discards disabled, they get disabled for the thin
 * device as well.
J
Joe Thornber 已提交
3729 3730 3731 3732 3733
 */
static int thin_ctr(struct dm_target *ti, unsigned argc, char **argv)
{
	int r;
	struct thin_c *tc;
3734
	struct dm_dev *pool_dev, *origin_dev;
J
Joe Thornber 已提交
3735
	struct mapped_device *pool_md;
3736
	unsigned long flags;
J
Joe Thornber 已提交
3737 3738 3739

	mutex_lock(&dm_thin_pool_table.mutex);

3740
	if (argc != 2 && argc != 3) {
J
Joe Thornber 已提交
3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751
		ti->error = "Invalid argument count";
		r = -EINVAL;
		goto out_unlock;
	}

	tc = ti->private = kzalloc(sizeof(*tc), GFP_KERNEL);
	if (!tc) {
		ti->error = "Out of memory";
		r = -ENOMEM;
		goto out_unlock;
	}
3752
	tc->thin_md = dm_table_get_md(ti->table);
3753
	spin_lock_init(&tc->lock);
3754
	INIT_LIST_HEAD(&tc->deferred_cells);
3755 3756
	bio_list_init(&tc->deferred_bio_list);
	bio_list_init(&tc->retry_on_resume_list);
3757
	tc->sort_bio_list = RB_ROOT;
J
Joe Thornber 已提交
3758

3759 3760 3761 3762 3763 3764 3765 3766 3767
	if (argc == 3) {
		r = dm_get_device(ti, argv[2], FMODE_READ, &origin_dev);
		if (r) {
			ti->error = "Error opening origin device";
			goto bad_origin_dev;
		}
		tc->origin_dev = origin_dev;
	}

J
Joe Thornber 已提交
3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795
	r = dm_get_device(ti, argv[0], dm_table_get_mode(ti->table), &pool_dev);
	if (r) {
		ti->error = "Error opening pool device";
		goto bad_pool_dev;
	}
	tc->pool_dev = pool_dev;

	if (read_dev_id(argv[1], (unsigned long long *)&tc->dev_id, 0)) {
		ti->error = "Invalid device id";
		r = -EINVAL;
		goto bad_common;
	}

	pool_md = dm_get_md(tc->pool_dev->bdev->bd_dev);
	if (!pool_md) {
		ti->error = "Couldn't get pool mapped device";
		r = -EINVAL;
		goto bad_common;
	}

	tc->pool = __pool_table_lookup(pool_md);
	if (!tc->pool) {
		ti->error = "Couldn't find pool object";
		r = -EINVAL;
		goto bad_pool_lookup;
	}
	__pool_inc(tc->pool);

3796 3797
	if (get_pool_mode(tc->pool) == PM_FAIL) {
		ti->error = "Couldn't open thin device, Pool is in fail mode";
3798
		r = -EINVAL;
3799
		goto bad_pool;
3800 3801
	}

J
Joe Thornber 已提交
3802 3803 3804
	r = dm_pool_open_thin_device(tc->pool->pmd, tc->dev_id, &tc->td);
	if (r) {
		ti->error = "Couldn't open thin internal device";
3805
		goto bad_pool;
J
Joe Thornber 已提交
3806 3807
	}

3808 3809
	r = dm_set_target_max_io_len(ti, tc->pool->sectors_per_block);
	if (r)
3810
		goto bad;
3811

3812
	ti->num_flush_bios = 1;
J
Joe Thornber 已提交
3813
	ti->flush_supported = true;
M
Mikulas Patocka 已提交
3814
	ti->per_bio_data_size = sizeof(struct dm_thin_endio_hook);
3815 3816

	/* In case the pool supports discards, pass them on. */
3817
	ti->discard_zeroes_data_unsupported = true;
3818
	if (tc->pool->pf.discard_enabled) {
3819
		ti->discards_supported = true;
3820 3821 3822
		ti->num_discard_bios = 1;
		/* Discard bios must be split on a block boundary */
		ti->split_discard_bios = true;
3823
	}
J
Joe Thornber 已提交
3824 3825 3826

	mutex_unlock(&dm_thin_pool_table.mutex);

3827
	spin_lock_irqsave(&tc->pool->lock, flags);
3828 3829 3830 3831 3832 3833 3834
	if (tc->pool->suspended) {
		spin_unlock_irqrestore(&tc->pool->lock, flags);
		mutex_lock(&dm_thin_pool_table.mutex); /* reacquire for __pool_dec */
		ti->error = "Unable to activate thin device while pool is suspended";
		r = -EINVAL;
		goto bad;
	}
3835 3836
	atomic_set(&tc->refcount, 1);
	init_completion(&tc->can_destroy);
3837
	list_add_tail_rcu(&tc->list, &tc->pool->active_thins);
3838
	spin_unlock_irqrestore(&tc->pool->lock, flags);
3839 3840 3841 3842 3843 3844 3845 3846
	/*
	 * This synchronize_rcu() call is needed here otherwise we risk a
	 * wake_worker() call finding no bios to process (because the newly
	 * added tc isn't yet visible).  So this reduces latency since we
	 * aren't then dependent on the periodic commit to wake_worker().
	 */
	synchronize_rcu();

3847 3848
	dm_put(pool_md);

J
Joe Thornber 已提交
3849 3850
	return 0;

3851
bad:
3852
	dm_pool_close_thin_device(tc->td);
3853
bad_pool:
J
Joe Thornber 已提交
3854 3855 3856 3857 3858 3859
	__pool_dec(tc->pool);
bad_pool_lookup:
	dm_put(pool_md);
bad_common:
	dm_put_device(ti, tc->pool_dev);
bad_pool_dev:
3860 3861 3862
	if (tc->origin_dev)
		dm_put_device(ti, tc->origin_dev);
bad_origin_dev:
J
Joe Thornber 已提交
3863 3864 3865 3866 3867 3868 3869
	kfree(tc);
out_unlock:
	mutex_unlock(&dm_thin_pool_table.mutex);

	return r;
}

M
Mikulas Patocka 已提交
3870
static int thin_map(struct dm_target *ti, struct bio *bio)
J
Joe Thornber 已提交
3871
{
3872
	bio->bi_iter.bi_sector = dm_target_offset(ti, bio->bi_iter.bi_sector);
J
Joe Thornber 已提交
3873

M
Mikulas Patocka 已提交
3874
	return thin_bio_map(ti, bio);
J
Joe Thornber 已提交
3875 3876
}

M
Mikulas Patocka 已提交
3877
static int thin_endio(struct dm_target *ti, struct bio *bio, int err)
3878 3879
{
	unsigned long flags;
M
Mikulas Patocka 已提交
3880
	struct dm_thin_endio_hook *h = dm_per_bio_data(bio, sizeof(struct dm_thin_endio_hook));
3881
	struct list_head work;
M
Mike Snitzer 已提交
3882
	struct dm_thin_new_mapping *m, *tmp;
3883 3884 3885 3886
	struct pool *pool = h->tc->pool;

	if (h->shared_read_entry) {
		INIT_LIST_HEAD(&work);
3887
		dm_deferred_entry_dec(h->shared_read_entry, &work);
3888 3889 3890 3891

		spin_lock_irqsave(&pool->lock, flags);
		list_for_each_entry_safe(m, tmp, &work, list) {
			list_del(&m->list);
3892
			__complete_mapping_preparation(m);
3893 3894 3895 3896
		}
		spin_unlock_irqrestore(&pool->lock, flags);
	}

J
Joe Thornber 已提交
3897 3898
	if (h->all_io_entry) {
		INIT_LIST_HEAD(&work);
3899
		dm_deferred_entry_dec(h->all_io_entry, &work);
3900 3901 3902
		if (!list_empty(&work)) {
			spin_lock_irqsave(&pool->lock, flags);
			list_for_each_entry_safe(m, tmp, &work, list)
3903
				list_add_tail(&m->list, &pool->prepared_discards);
3904 3905 3906
			spin_unlock_irqrestore(&pool->lock, flags);
			wake_worker(pool);
		}
J
Joe Thornber 已提交
3907 3908
	}

3909 3910 3911
	return 0;
}

3912
static void thin_presuspend(struct dm_target *ti)
J
Joe Thornber 已提交
3913
{
3914 3915
	struct thin_c *tc = ti->private;

J
Joe Thornber 已提交
3916
	if (dm_noflush_suspending(ti))
3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928
		noflush_work(tc, do_noflush_start);
}

static void thin_postsuspend(struct dm_target *ti)
{
	struct thin_c *tc = ti->private;

	/*
	 * The dm_noflush_suspending flag has been cleared by now, so
	 * unfortunately we must always run this.
	 */
	noflush_work(tc, do_noflush_stop);
J
Joe Thornber 已提交
3929 3930
}

3931 3932 3933 3934 3935 3936 3937 3938 3939 3940
static int thin_preresume(struct dm_target *ti)
{
	struct thin_c *tc = ti->private;

	if (tc->origin_dev)
		tc->origin_size = get_dev_size(tc->origin_dev->bdev);

	return 0;
}

J
Joe Thornber 已提交
3941 3942 3943
/*
 * <nr mapped sectors> <highest mapped sector>
 */
3944 3945
static void thin_status(struct dm_target *ti, status_type_t type,
			unsigned status_flags, char *result, unsigned maxlen)
J
Joe Thornber 已提交
3946 3947 3948 3949 3950 3951 3952
{
	int r;
	ssize_t sz = 0;
	dm_block_t mapped, highest;
	char buf[BDEVNAME_SIZE];
	struct thin_c *tc = ti->private;

3953 3954
	if (get_pool_mode(tc->pool) == PM_FAIL) {
		DMEMIT("Fail");
3955
		return;
3956 3957
	}

J
Joe Thornber 已提交
3958 3959 3960 3961 3962 3963
	if (!tc->td)
		DMEMIT("-");
	else {
		switch (type) {
		case STATUSTYPE_INFO:
			r = dm_thin_get_mapped_count(tc->td, &mapped);
3964 3965 3966 3967
			if (r) {
				DMERR("dm_thin_get_mapped_count returned %d", r);
				goto err;
			}
J
Joe Thornber 已提交
3968 3969

			r = dm_thin_get_highest_mapped_block(tc->td, &highest);
3970 3971 3972 3973
			if (r < 0) {
				DMERR("dm_thin_get_highest_mapped_block returned %d", r);
				goto err;
			}
J
Joe Thornber 已提交
3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986

			DMEMIT("%llu ", mapped * tc->pool->sectors_per_block);
			if (r)
				DMEMIT("%llu", ((highest + 1) *
						tc->pool->sectors_per_block) - 1);
			else
				DMEMIT("-");
			break;

		case STATUSTYPE_TABLE:
			DMEMIT("%s %lu",
			       format_dev_t(buf, tc->pool_dev->bdev->bd_dev),
			       (unsigned long) tc->dev_id);
3987 3988
			if (tc->origin_dev)
				DMEMIT(" %s", format_dev_t(buf, tc->origin_dev->bdev->bd_dev));
J
Joe Thornber 已提交
3989 3990 3991 3992
			break;
		}
	}

3993 3994 3995 3996
	return;

err:
	DMEMIT("Error");
J
Joe Thornber 已提交
3997 3998
}

M
Mike Snitzer 已提交
3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013
static int thin_merge(struct dm_target *ti, struct bvec_merge_data *bvm,
		      struct bio_vec *biovec, int max_size)
{
	struct thin_c *tc = ti->private;
	struct request_queue *q = bdev_get_queue(tc->pool_dev->bdev);

	if (!q->merge_bvec_fn)
		return max_size;

	bvm->bi_bdev = tc->pool_dev->bdev;
	bvm->bi_sector = dm_target_offset(ti, bvm->bi_sector);

	return min(max_size, q->merge_bvec_fn(q, bvm, biovec));
}

J
Joe Thornber 已提交
4014 4015 4016
static int thin_iterate_devices(struct dm_target *ti,
				iterate_devices_callout_fn fn, void *data)
{
4017
	sector_t blocks;
J
Joe Thornber 已提交
4018
	struct thin_c *tc = ti->private;
4019
	struct pool *pool = tc->pool;
J
Joe Thornber 已提交
4020 4021 4022 4023 4024

	/*
	 * We can't call dm_pool_get_data_dev_size() since that blocks.  So
	 * we follow a more convoluted path through to the pool's target.
	 */
4025
	if (!pool->ti)
J
Joe Thornber 已提交
4026 4027
		return 0;	/* nothing is bound */

4028 4029
	blocks = pool->ti->len;
	(void) sector_div(blocks, pool->sectors_per_block);
J
Joe Thornber 已提交
4030
	if (blocks)
4031
		return fn(ti, tc->pool_dev, 0, pool->sectors_per_block * blocks, data);
J
Joe Thornber 已提交
4032 4033 4034 4035 4036 4037

	return 0;
}

static struct target_type thin_target = {
	.name = "thin",
M
Mike Snitzer 已提交
4038
	.version = {1, 14, 0},
J
Joe Thornber 已提交
4039 4040 4041 4042
	.module	= THIS_MODULE,
	.ctr = thin_ctr,
	.dtr = thin_dtr,
	.map = thin_map,
4043
	.end_io = thin_endio,
4044
	.preresume = thin_preresume,
4045
	.presuspend = thin_presuspend,
J
Joe Thornber 已提交
4046 4047
	.postsuspend = thin_postsuspend,
	.status = thin_status,
M
Mike Snitzer 已提交
4048
	.merge = thin_merge,
J
Joe Thornber 已提交
4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065
	.iterate_devices = thin_iterate_devices,
};

/*----------------------------------------------------------------*/

static int __init dm_thin_init(void)
{
	int r;

	pool_table_init();

	r = dm_register_target(&thin_target);
	if (r)
		return r;

	r = dm_register_target(&pool_target);
	if (r)
M
Mike Snitzer 已提交
4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079
		goto bad_pool_target;

	r = -ENOMEM;

	_new_mapping_cache = KMEM_CACHE(dm_thin_new_mapping, 0);
	if (!_new_mapping_cache)
		goto bad_new_mapping_cache;

	return 0;

bad_new_mapping_cache:
	dm_unregister_target(&pool_target);
bad_pool_target:
	dm_unregister_target(&thin_target);
J
Joe Thornber 已提交
4080 4081 4082 4083 4084 4085 4086 4087

	return r;
}

static void dm_thin_exit(void)
{
	dm_unregister_target(&thin_target);
	dm_unregister_target(&pool_target);
M
Mike Snitzer 已提交
4088 4089

	kmem_cache_destroy(_new_mapping_cache);
J
Joe Thornber 已提交
4090 4091 4092 4093 4094
}

module_init(dm_thin_init);
module_exit(dm_thin_exit);

4095 4096 4097
module_param_named(no_space_timeout, no_space_timeout_secs, uint, S_IRUGO | S_IWUSR);
MODULE_PARM_DESC(no_space_timeout, "Out of data space queue IO timeout in seconds");

4098
MODULE_DESCRIPTION(DM_NAME " thin provisioning target");
J
Joe Thornber 已提交
4099 4100
MODULE_AUTHOR("Joe Thornber <dm-devel@redhat.com>");
MODULE_LICENSE("GPL");