dm.c 84.7 KB
Newer Older
L
Linus Torvalds 已提交
1 2
/*
 * Copyright (C) 2001, 2002 Sistina Software (UK) Limited.
M
Milan Broz 已提交
3
 * Copyright (C) 2004-2008 Red Hat, Inc. All rights reserved.
L
Linus Torvalds 已提交
4 5 6 7 8
 *
 * This file is released under the GPL.
 */

#include "dm.h"
M
Mike Anderson 已提交
9
#include "dm-uevent.h"
L
Linus Torvalds 已提交
10 11 12

#include <linux/init.h>
#include <linux/module.h>
A
Arjan van de Ven 已提交
13
#include <linux/mutex.h>
L
Linus Torvalds 已提交
14 15 16 17 18 19
#include <linux/moduleparam.h>
#include <linux/blkpg.h>
#include <linux/bio.h>
#include <linux/mempool.h>
#include <linux/slab.h>
#include <linux/idr.h>
D
Darrick J. Wong 已提交
20
#include <linux/hdreg.h>
21
#include <linux/delay.h>
22
#include <linux/wait.h>
23
#include <linux/kthread.h>
24
#include <linux/ktime.h>
25
#include <linux/elevator.h> /* for rq_end_sector() */
26
#include <linux/blk-mq.h>
27
#include <linux/pr.h>
28 29

#include <trace/events/block.h>
L
Linus Torvalds 已提交
30

31 32
#define DM_MSG_PREFIX "core"

N
Namhyung Kim 已提交
33 34 35 36 37 38 39 40 41 42
#ifdef CONFIG_PRINTK
/*
 * ratelimit state to be used in DMXXX_LIMIT().
 */
DEFINE_RATELIMIT_STATE(dm_ratelimit_state,
		       DEFAULT_RATELIMIT_INTERVAL,
		       DEFAULT_RATELIMIT_BURST);
EXPORT_SYMBOL(dm_ratelimit_state);
#endif

M
Milan Broz 已提交
43 44 45 46 47 48 49
/*
 * Cookies are numeric values sent with CHANGE and REMOVE
 * uevents while resuming, removing or renaming the device.
 */
#define DM_COOKIE_ENV_VAR_NAME "DM_COOKIE"
#define DM_COOKIE_LENGTH 24

L
Linus Torvalds 已提交
50 51 52 53 54
static const char *_name = DM_NAME;

static unsigned int major = 0;
static unsigned int _major = 0;

55 56
static DEFINE_IDR(_minor_idr);

57
static DEFINE_SPINLOCK(_minor_lock);
M
Mikulas Patocka 已提交
58 59 60 61 62

static void do_deferred_remove(struct work_struct *w);

static DECLARE_WORK(deferred_remove_work, do_deferred_remove);

63 64
static struct workqueue_struct *deferred_remove_workqueue;

L
Linus Torvalds 已提交
65
/*
K
Kiyoshi Ueda 已提交
66
 * For bio-based dm.
L
Linus Torvalds 已提交
67 68 69 70 71 72
 * One of these is allocated per bio.
 */
struct dm_io {
	struct mapped_device *md;
	int error;
	atomic_t io_count;
R
Richard Kennedy 已提交
73
	struct bio *bio;
74
	unsigned long start_time;
75
	spinlock_t endio_lock;
M
Mikulas Patocka 已提交
76
	struct dm_stats_aux stats_aux;
L
Linus Torvalds 已提交
77 78
};

K
Kiyoshi Ueda 已提交
79 80 81 82 83 84 85
/*
 * For request-based dm.
 * One of these is allocated per request.
 */
struct dm_rq_target_io {
	struct mapped_device *md;
	struct dm_target *ti;
86
	struct request *orig, *clone;
87
	struct kthread_work work;
K
Kiyoshi Ueda 已提交
88 89
	int error;
	union map_info info;
90 91 92
	struct dm_stats_aux stats_aux;
	unsigned long duration_jiffies;
	unsigned n_sectors;
K
Kiyoshi Ueda 已提交
93 94 95
};

/*
96 97 98 99 100 101
 * For request-based dm - the bio clones we allocate are embedded in these
 * structs.
 *
 * We allocate these with bio_alloc_bioset, using the front_pad parameter when
 * the bioset is created - this means the bio has to come at the end of the
 * struct.
K
Kiyoshi Ueda 已提交
102 103 104
 */
struct dm_rq_clone_bio_info {
	struct bio *orig;
105
	struct dm_rq_target_io *tio;
106
	struct bio clone;
K
Kiyoshi Ueda 已提交
107 108
};

109 110
#define MINOR_ALLOCED ((void *)-1)

L
Linus Torvalds 已提交
111 112 113
/*
 * Bits for the md->flags field.
 */
114
#define DMF_BLOCK_IO_FOR_SUSPEND 0
L
Linus Torvalds 已提交
115
#define DMF_SUSPENDED 1
116
#define DMF_FROZEN 2
J
Jeff Mahoney 已提交
117
#define DMF_FREEING 3
118
#define DMF_DELETING 4
119
#define DMF_NOFLUSH_SUSPENDING 5
120 121
#define DMF_DEFERRED_REMOVE 6
#define DMF_SUSPENDED_INTERNALLY 7
L
Linus Torvalds 已提交
122

M
Mikulas Patocka 已提交
123 124 125 126 127 128 129 130
/*
 * A dummy definition to make RCU happy.
 * struct dm_table should never be dereferenced in this file.
 */
struct dm_table {
	int undefined__;
};

131 132 133
/*
 * Work processed by per-device workqueue.
 */
L
Linus Torvalds 已提交
134
struct mapped_device {
M
Mikulas Patocka 已提交
135
	struct srcu_struct io_barrier;
136
	struct mutex suspend_lock;
L
Linus Torvalds 已提交
137
	atomic_t holders;
138
	atomic_t open_count;
L
Linus Torvalds 已提交
139

M
Mikulas Patocka 已提交
140 141 142 143 144
	/*
	 * The current mapping.
	 * Use dm_get_live_table{_fast} or take suspend_lock for
	 * dereference.
	 */
145
	struct dm_table __rcu *map;
M
Mikulas Patocka 已提交
146

147 148 149
	struct list_head table_devices;
	struct mutex table_devices_lock;

L
Linus Torvalds 已提交
150 151
	unsigned long flags;

152
	struct request_queue *queue;
153
	unsigned type;
154
	/* Protect queue and type against concurrent access. */
155 156
	struct mutex type_lock;

157 158
	struct target_type *immutable_target_type;

L
Linus Torvalds 已提交
159
	struct gendisk *disk;
M
Mike Anderson 已提交
160
	char name[16];
L
Linus Torvalds 已提交
161 162 163 164 165 166

	void *interface_ptr;

	/*
	 * A list of ios that arrived while we were suspended.
	 */
167
	atomic_t pending[2];
L
Linus Torvalds 已提交
168
	wait_queue_head_t wait;
169
	struct work_struct work;
K
Kiyoshi Ueda 已提交
170
	struct bio_list deferred;
171
	spinlock_t deferred_lock;
L
Linus Torvalds 已提交
172

173
	/*
174
	 * Processing queue (flush)
175 176 177
	 */
	struct workqueue_struct *wq;

L
Linus Torvalds 已提交
178 179 180 181
	/*
	 * io objects are allocated from here.
	 */
	mempool_t *io_pool;
182
	mempool_t *rq_pool;
L
Linus Torvalds 已提交
183

S
Stefan Bader 已提交
184 185
	struct bio_set *bs;

L
Linus Torvalds 已提交
186 187 188 189 190
	/*
	 * Event handling.
	 */
	atomic_t event_nr;
	wait_queue_head_t eventq;
M
Mike Anderson 已提交
191 192 193
	atomic_t uevent_seq;
	struct list_head uevent_list;
	spinlock_t uevent_lock; /* Protect access to uevent_list */
L
Linus Torvalds 已提交
194 195 196 197 198

	/*
	 * freeze/thaw support require holding onto a super block
	 */
	struct super_block *frozen_sb;
199
	struct block_device *bdev;
D
Darrick J. Wong 已提交
200 201 202

	/* forced geometry settings */
	struct hd_geometry geometry;
M
Milan Broz 已提交
203

204 205
	/* kobject and completion */
	struct dm_kobject_holder kobj_holder;
206

207 208
	/* zero-length flush that will be cloned and submitted to targets */
	struct bio flush_bio;
M
Mikulas Patocka 已提交
209

210 211 212
	/* the number of internal suspends */
	unsigned internal_suspend_count;

M
Mikulas Patocka 已提交
213
	struct dm_stats stats;
214 215 216

	struct kthread_worker kworker;
	struct task_struct *kworker_task;
217 218

	/* for request-based merge heuristic in dm_request_fn() */
219
	unsigned seq_rq_merge_deadline_usecs;
220
	int last_rq_rw;
221 222
	sector_t last_rq_pos;
	ktime_t last_rq_start_time;
223 224 225

	/* for blk-mq request-based DM support */
	struct blk_mq_tag_set tag_set;
226
	bool use_blk_mq;
L
Linus Torvalds 已提交
227 228
};

229 230 231 232 233 234 235 236 237 238 239
#ifdef CONFIG_DM_MQ_DEFAULT
static bool use_blk_mq = true;
#else
static bool use_blk_mq = false;
#endif

bool dm_use_blk_mq(struct mapped_device *md)
{
	return md->use_blk_mq;
}

K
Kiyoshi Ueda 已提交
240 241 242 243 244
/*
 * For mempools pre-allocation at the table loading time.
 */
struct dm_md_mempools {
	mempool_t *io_pool;
245
	mempool_t *rq_pool;
K
Kiyoshi Ueda 已提交
246 247 248
	struct bio_set *bs;
};

249 250 251 252 253 254
struct table_device {
	struct list_head list;
	atomic_t count;
	struct dm_dev dm_dev;
};

255 256
#define RESERVED_BIO_BASED_IOS		16
#define RESERVED_REQUEST_BASED_IOS	256
257
#define RESERVED_MAX_IOS		1024
258
static struct kmem_cache *_io_cache;
K
Kiyoshi Ueda 已提交
259
static struct kmem_cache *_rq_tio_cache;
260
static struct kmem_cache *_rq_cache;
261

262 263 264 265 266
/*
 * Bio-based DM's mempools' reserved IOs set by the user.
 */
static unsigned reserved_bio_based_ios = RESERVED_BIO_BASED_IOS;

267 268 269 270 271
/*
 * Request-based DM's mempools' reserved IOs set by the user.
 */
static unsigned reserved_rq_based_ios = RESERVED_REQUEST_BASED_IOS;

272
static unsigned __dm_get_module_param(unsigned *module_param,
273 274
				      unsigned def, unsigned max)
{
275 276
	unsigned param = ACCESS_ONCE(*module_param);
	unsigned modified_param = 0;
277

278 279 280 281
	if (!param)
		modified_param = def;
	else if (param > max)
		modified_param = max;
282

283 284 285
	if (modified_param) {
		(void)cmpxchg(module_param, param, modified_param);
		param = modified_param;
286 287
	}

288
	return param;
289 290
}

291 292
unsigned dm_get_reserved_bio_based_ios(void)
{
293
	return __dm_get_module_param(&reserved_bio_based_ios,
294 295 296 297
				     RESERVED_BIO_BASED_IOS, RESERVED_MAX_IOS);
}
EXPORT_SYMBOL_GPL(dm_get_reserved_bio_based_ios);

298 299
unsigned dm_get_reserved_rq_based_ios(void)
{
300
	return __dm_get_module_param(&reserved_rq_based_ios,
301 302 303 304
				     RESERVED_REQUEST_BASED_IOS, RESERVED_MAX_IOS);
}
EXPORT_SYMBOL_GPL(dm_get_reserved_rq_based_ios);

L
Linus Torvalds 已提交
305 306
static int __init local_init(void)
{
K
Kiyoshi Ueda 已提交
307
	int r = -ENOMEM;
L
Linus Torvalds 已提交
308 309

	/* allocate a slab for the dm_ios */
A
Alasdair G Kergon 已提交
310
	_io_cache = KMEM_CACHE(dm_io, 0);
L
Linus Torvalds 已提交
311
	if (!_io_cache)
K
Kiyoshi Ueda 已提交
312
		return r;
L
Linus Torvalds 已提交
313

K
Kiyoshi Ueda 已提交
314 315
	_rq_tio_cache = KMEM_CACHE(dm_rq_target_io, 0);
	if (!_rq_tio_cache)
316
		goto out_free_io_cache;
K
Kiyoshi Ueda 已提交
317

318 319 320 321 322
	_rq_cache = kmem_cache_create("dm_clone_request", sizeof(struct request),
				      __alignof__(struct request), 0, NULL);
	if (!_rq_cache)
		goto out_free_rq_tio_cache;

M
Mike Anderson 已提交
323
	r = dm_uevent_init();
K
Kiyoshi Ueda 已提交
324
	if (r)
325
		goto out_free_rq_cache;
M
Mike Anderson 已提交
326

327 328 329 330 331 332
	deferred_remove_workqueue = alloc_workqueue("kdmremove", WQ_UNBOUND, 1);
	if (!deferred_remove_workqueue) {
		r = -ENOMEM;
		goto out_uevent_exit;
	}

L
Linus Torvalds 已提交
333 334
	_major = major;
	r = register_blkdev(_major, _name);
K
Kiyoshi Ueda 已提交
335
	if (r < 0)
336
		goto out_free_workqueue;
L
Linus Torvalds 已提交
337 338 339 340 341

	if (!_major)
		_major = r;

	return 0;
K
Kiyoshi Ueda 已提交
342

343 344
out_free_workqueue:
	destroy_workqueue(deferred_remove_workqueue);
K
Kiyoshi Ueda 已提交
345 346
out_uevent_exit:
	dm_uevent_exit();
347 348
out_free_rq_cache:
	kmem_cache_destroy(_rq_cache);
K
Kiyoshi Ueda 已提交
349 350
out_free_rq_tio_cache:
	kmem_cache_destroy(_rq_tio_cache);
K
Kiyoshi Ueda 已提交
351 352 353 354
out_free_io_cache:
	kmem_cache_destroy(_io_cache);

	return r;
L
Linus Torvalds 已提交
355 356 357 358
}

static void local_exit(void)
{
M
Mikulas Patocka 已提交
359
	flush_scheduled_work();
360
	destroy_workqueue(deferred_remove_workqueue);
M
Mikulas Patocka 已提交
361

362
	kmem_cache_destroy(_rq_cache);
K
Kiyoshi Ueda 已提交
363
	kmem_cache_destroy(_rq_tio_cache);
L
Linus Torvalds 已提交
364
	kmem_cache_destroy(_io_cache);
365
	unregister_blkdev(_major, _name);
M
Mike Anderson 已提交
366
	dm_uevent_exit();
L
Linus Torvalds 已提交
367 368 369 370 371 372

	_major = 0;

	DMINFO("cleaned up");
}

373
static int (*_inits[])(void) __initdata = {
L
Linus Torvalds 已提交
374 375 376 377
	local_init,
	dm_target_init,
	dm_linear_init,
	dm_stripe_init,
M
Mikulas Patocka 已提交
378
	dm_io_init,
379
	dm_kcopyd_init,
L
Linus Torvalds 已提交
380
	dm_interface_init,
M
Mikulas Patocka 已提交
381
	dm_statistics_init,
L
Linus Torvalds 已提交
382 383
};

384
static void (*_exits[])(void) = {
L
Linus Torvalds 已提交
385 386 387 388
	local_exit,
	dm_target_exit,
	dm_linear_exit,
	dm_stripe_exit,
M
Mikulas Patocka 已提交
389
	dm_io_exit,
390
	dm_kcopyd_exit,
L
Linus Torvalds 已提交
391
	dm_interface_exit,
M
Mikulas Patocka 已提交
392
	dm_statistics_exit,
L
Linus Torvalds 已提交
393 394 395 396 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
};

static int __init dm_init(void)
{
	const int count = ARRAY_SIZE(_inits);

	int r, i;

	for (i = 0; i < count; i++) {
		r = _inits[i]();
		if (r)
			goto bad;
	}

	return 0;

      bad:
	while (i--)
		_exits[i]();

	return r;
}

static void __exit dm_exit(void)
{
	int i = ARRAY_SIZE(_exits);

	while (i--)
		_exits[i]();
422 423 424 425 426

	/*
	 * Should be empty by this point.
	 */
	idr_destroy(&_minor_idr);
L
Linus Torvalds 已提交
427 428 429 430 431
}

/*
 * Block device functions
 */
M
Mike Anderson 已提交
432 433 434 435 436
int dm_deleting_md(struct mapped_device *md)
{
	return test_bit(DMF_DELETING, &md->flags);
}

A
Al Viro 已提交
437
static int dm_blk_open(struct block_device *bdev, fmode_t mode)
L
Linus Torvalds 已提交
438 439 440
{
	struct mapped_device *md;

J
Jeff Mahoney 已提交
441 442
	spin_lock(&_minor_lock);

A
Al Viro 已提交
443
	md = bdev->bd_disk->private_data;
J
Jeff Mahoney 已提交
444 445 446
	if (!md)
		goto out;

447
	if (test_bit(DMF_FREEING, &md->flags) ||
M
Mike Anderson 已提交
448
	    dm_deleting_md(md)) {
J
Jeff Mahoney 已提交
449 450 451 452
		md = NULL;
		goto out;
	}

L
Linus Torvalds 已提交
453
	dm_get(md);
454
	atomic_inc(&md->open_count);
J
Jeff Mahoney 已提交
455 456 457 458
out:
	spin_unlock(&_minor_lock);

	return md ? 0 : -ENXIO;
L
Linus Torvalds 已提交
459 460
}

461
static void dm_blk_close(struct gendisk *disk, fmode_t mode)
L
Linus Torvalds 已提交
462
{
463
	struct mapped_device *md;
464

465 466
	spin_lock(&_minor_lock);

467 468 469 470
	md = disk->private_data;
	if (WARN_ON(!md))
		goto out;

M
Mikulas Patocka 已提交
471 472
	if (atomic_dec_and_test(&md->open_count) &&
	    (test_bit(DMF_DEFERRED_REMOVE, &md->flags)))
473
		queue_work(deferred_remove_workqueue, &deferred_remove_work);
M
Mikulas Patocka 已提交
474

L
Linus Torvalds 已提交
475
	dm_put(md);
476
out:
477
	spin_unlock(&_minor_lock);
L
Linus Torvalds 已提交
478 479
}

480 481 482 483 484 485 486 487
int dm_open_count(struct mapped_device *md)
{
	return atomic_read(&md->open_count);
}

/*
 * Guarantees nothing is using the device before it's deleted.
 */
M
Mikulas Patocka 已提交
488
int dm_lock_for_deletion(struct mapped_device *md, bool mark_deferred, bool only_deferred)
489 490 491 492 493
{
	int r = 0;

	spin_lock(&_minor_lock);

M
Mikulas Patocka 已提交
494
	if (dm_open_count(md)) {
495
		r = -EBUSY;
M
Mikulas Patocka 已提交
496 497 498 499
		if (mark_deferred)
			set_bit(DMF_DEFERRED_REMOVE, &md->flags);
	} else if (only_deferred && !test_bit(DMF_DEFERRED_REMOVE, &md->flags))
		r = -EEXIST;
500 501 502 503 504 505 506 507
	else
		set_bit(DMF_DELETING, &md->flags);

	spin_unlock(&_minor_lock);

	return r;
}

M
Mikulas Patocka 已提交
508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528
int dm_cancel_deferred_remove(struct mapped_device *md)
{
	int r = 0;

	spin_lock(&_minor_lock);

	if (test_bit(DMF_DELETING, &md->flags))
		r = -EBUSY;
	else
		clear_bit(DMF_DEFERRED_REMOVE, &md->flags);

	spin_unlock(&_minor_lock);

	return r;
}

static void do_deferred_remove(struct work_struct *w)
{
	dm_deferred_remove();
}

M
Mikulas Patocka 已提交
529 530 531 532 533
sector_t dm_get_size(struct mapped_device *md)
{
	return get_capacity(md->disk);
}

534 535 536 537 538
struct request_queue *dm_get_md_queue(struct mapped_device *md)
{
	return md->queue;
}

M
Mikulas Patocka 已提交
539 540 541 542 543
struct dm_stats *dm_get_stats(struct mapped_device *md)
{
	return &md->stats;
}

D
Darrick J. Wong 已提交
544 545 546 547 548 549 550
static int dm_blk_getgeo(struct block_device *bdev, struct hd_geometry *geo)
{
	struct mapped_device *md = bdev->bd_disk->private_data;

	return dm_get_geometry(md, geo);
}

551 552 553
static int dm_grab_bdev_for_ioctl(struct mapped_device *md,
				  struct block_device **bdev,
				  fmode_t *mode)
554
{
555
	struct dm_target *tgt;
556
	struct dm_table *map;
557
	int srcu_idx, r;
558

559
retry:
C
Christoph Hellwig 已提交
560
	r = -ENOTTY;
561
	map = dm_get_live_table(md, &srcu_idx);
562 563 564 565 566 567 568
	if (!map || !dm_table_get_size(map))
		goto out;

	/* We only support devices that have a single target */
	if (dm_table_get_num_targets(map) != 1)
		goto out;

569 570
	tgt = dm_table_get_target(map, 0);
	if (!tgt->type->prepare_ioctl)
571
		goto out;
572

573
	if (dm_suspended_md(md)) {
574 575 576 577
		r = -EAGAIN;
		goto out;
	}

578
	r = tgt->type->prepare_ioctl(tgt, bdev, mode);
C
Christoph Hellwig 已提交
579 580
	if (r < 0)
		goto out;
581

582 583
	bdgrab(*bdev);
	dm_put_live_table(md, srcu_idx);
C
Christoph Hellwig 已提交
584
	return r;
585 586

out:
587
	dm_put_live_table(md, srcu_idx);
588
	if (r == -ENOTCONN && !fatal_signal_pending(current)) {
589 590 591
		msleep(10);
		goto retry;
	}
C
Christoph Hellwig 已提交
592 593 594 595 596 597 598
	return r;
}

static int dm_blk_ioctl(struct block_device *bdev, fmode_t mode,
			unsigned int cmd, unsigned long arg)
{
	struct mapped_device *md = bdev->bd_disk->private_data;
599
	int r;
C
Christoph Hellwig 已提交
600

601
	r = dm_grab_bdev_for_ioctl(md, &bdev, &mode);
C
Christoph Hellwig 已提交
602 603
	if (r < 0)
		return r;
604

C
Christoph Hellwig 已提交
605 606 607 608 609 610 611 612 613 614
	if (r > 0) {
		/*
		 * Target determined this ioctl is being issued against
		 * a logical partition of the parent bdev; so extra
		 * validation is needed.
		 */
		r = scsi_verify_blk_ioctl(NULL, cmd);
		if (r)
			goto out;
	}
615

616
	r =  __blkdev_driver_ioctl(bdev, mode, cmd, arg);
C
Christoph Hellwig 已提交
617
out:
618
	bdput(bdev);
619 620 621
	return r;
}

A
Alasdair G Kergon 已提交
622
static struct dm_io *alloc_io(struct mapped_device *md)
L
Linus Torvalds 已提交
623 624 625 626
{
	return mempool_alloc(md->io_pool, GFP_NOIO);
}

A
Alasdair G Kergon 已提交
627
static void free_io(struct mapped_device *md, struct dm_io *io)
L
Linus Torvalds 已提交
628 629 630 631
{
	mempool_free(io, md->io_pool);
}

A
Alasdair G Kergon 已提交
632
static void free_tio(struct mapped_device *md, struct dm_target_io *tio)
L
Linus Torvalds 已提交
633
{
634
	bio_put(&tio->clone);
L
Linus Torvalds 已提交
635 636
}

K
Kiyoshi Ueda 已提交
637 638
static struct dm_rq_target_io *alloc_rq_tio(struct mapped_device *md,
					    gfp_t gfp_mask)
639
{
J
Jun'ichi Nomura 已提交
640
	return mempool_alloc(md->io_pool, gfp_mask);
641 642 643 644
}

static void free_rq_tio(struct dm_rq_target_io *tio)
{
J
Jun'ichi Nomura 已提交
645
	mempool_free(tio, tio->md->io_pool);
646 647
}

648 649 650 651 652 653 654 655 656 657 658
static struct request *alloc_clone_request(struct mapped_device *md,
					   gfp_t gfp_mask)
{
	return mempool_alloc(md->rq_pool, gfp_mask);
}

static void free_clone_request(struct mapped_device *md, struct request *rq)
{
	mempool_free(rq, md->rq_pool);
}

K
Kiyoshi Ueda 已提交
659 660 661 662 663 664
static int md_in_flight(struct mapped_device *md)
{
	return atomic_read(&md->pending[READ]) +
	       atomic_read(&md->pending[WRITE]);
}

665 666 667
static void start_io_acct(struct dm_io *io)
{
	struct mapped_device *md = io->md;
M
Mikulas Patocka 已提交
668
	struct bio *bio = io->bio;
T
Tejun Heo 已提交
669
	int cpu;
M
Mikulas Patocka 已提交
670
	int rw = bio_data_dir(bio);
671 672 673

	io->start_time = jiffies;

T
Tejun Heo 已提交
674 675 676
	cpu = part_stat_lock();
	part_round_stats(cpu, &dm_disk(md)->part0);
	part_stat_unlock();
677 678
	atomic_set(&dm_disk(md)->part0.in_flight[rw],
		atomic_inc_return(&md->pending[rw]));
M
Mikulas Patocka 已提交
679 680

	if (unlikely(dm_stats_used(&md->stats)))
681
		dm_stats_account_io(&md->stats, bio->bi_rw, bio->bi_iter.bi_sector,
M
Mikulas Patocka 已提交
682
				    bio_sectors(bio), false, 0, &io->stats_aux);
683 684
}

685
static void end_io_acct(struct dm_io *io)
686 687 688 689
{
	struct mapped_device *md = io->md;
	struct bio *bio = io->bio;
	unsigned long duration = jiffies - io->start_time;
690
	int pending;
691 692
	int rw = bio_data_dir(bio);

693
	generic_end_io_acct(rw, &dm_disk(md)->part0, io->start_time);
694

M
Mikulas Patocka 已提交
695
	if (unlikely(dm_stats_used(&md->stats)))
696
		dm_stats_account_io(&md->stats, bio->bi_rw, bio->bi_iter.bi_sector,
M
Mikulas Patocka 已提交
697 698
				    bio_sectors(bio), true, duration, &io->stats_aux);

699 700
	/*
	 * After this is decremented the bio must not be touched if it is
701
	 * a flush.
702
	 */
703 704
	pending = atomic_dec_return(&md->pending[rw]);
	atomic_set(&dm_disk(md)->part0.in_flight[rw], pending);
705
	pending += atomic_read(&md->pending[rw^0x1]);
706

707 708 709
	/* nudge anyone waiting on suspend queue */
	if (!pending)
		wake_up(&md->wait);
710 711
}

L
Linus Torvalds 已提交
712 713 714
/*
 * Add the bio to the list of deferred io.
 */
M
Mikulas Patocka 已提交
715
static void queue_io(struct mapped_device *md, struct bio *bio)
L
Linus Torvalds 已提交
716
{
717
	unsigned long flags;
L
Linus Torvalds 已提交
718

719
	spin_lock_irqsave(&md->deferred_lock, flags);
L
Linus Torvalds 已提交
720
	bio_list_add(&md->deferred, bio);
721
	spin_unlock_irqrestore(&md->deferred_lock, flags);
722
	queue_work(md->wq, &md->work);
L
Linus Torvalds 已提交
723 724 725 726 727
}

/*
 * Everyone (including functions in this file), should use this
 * function to access the md->map field, and make sure they call
M
Mikulas Patocka 已提交
728
 * dm_put_live_table() when finished.
L
Linus Torvalds 已提交
729
 */
M
Mikulas Patocka 已提交
730
struct dm_table *dm_get_live_table(struct mapped_device *md, int *srcu_idx) __acquires(md->io_barrier)
L
Linus Torvalds 已提交
731
{
M
Mikulas Patocka 已提交
732 733 734 735
	*srcu_idx = srcu_read_lock(&md->io_barrier);

	return srcu_dereference(md->map, &md->io_barrier);
}
L
Linus Torvalds 已提交
736

M
Mikulas Patocka 已提交
737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756
void dm_put_live_table(struct mapped_device *md, int srcu_idx) __releases(md->io_barrier)
{
	srcu_read_unlock(&md->io_barrier, srcu_idx);
}

void dm_sync_table(struct mapped_device *md)
{
	synchronize_srcu(&md->io_barrier);
	synchronize_rcu_expedited();
}

/*
 * A fast alternative to dm_get_live_table/dm_put_live_table.
 * The caller must not block between these two functions.
 */
static struct dm_table *dm_get_live_table_fast(struct mapped_device *md) __acquires(RCU)
{
	rcu_read_lock();
	return rcu_dereference(md->map);
}
L
Linus Torvalds 已提交
757

M
Mikulas Patocka 已提交
758 759 760
static void dm_put_live_table_fast(struct mapped_device *md) __releases(RCU)
{
	rcu_read_unlock();
L
Linus Torvalds 已提交
761 762
}

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 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876
/*
 * Open a table device so we can use it as a map destination.
 */
static int open_table_device(struct table_device *td, dev_t dev,
			     struct mapped_device *md)
{
	static char *_claim_ptr = "I belong to device-mapper";
	struct block_device *bdev;

	int r;

	BUG_ON(td->dm_dev.bdev);

	bdev = blkdev_get_by_dev(dev, td->dm_dev.mode | FMODE_EXCL, _claim_ptr);
	if (IS_ERR(bdev))
		return PTR_ERR(bdev);

	r = bd_link_disk_holder(bdev, dm_disk(md));
	if (r) {
		blkdev_put(bdev, td->dm_dev.mode | FMODE_EXCL);
		return r;
	}

	td->dm_dev.bdev = bdev;
	return 0;
}

/*
 * Close a table device that we've been using.
 */
static void close_table_device(struct table_device *td, struct mapped_device *md)
{
	if (!td->dm_dev.bdev)
		return;

	bd_unlink_disk_holder(td->dm_dev.bdev, dm_disk(md));
	blkdev_put(td->dm_dev.bdev, td->dm_dev.mode | FMODE_EXCL);
	td->dm_dev.bdev = NULL;
}

static struct table_device *find_table_device(struct list_head *l, dev_t dev,
					      fmode_t mode) {
	struct table_device *td;

	list_for_each_entry(td, l, list)
		if (td->dm_dev.bdev->bd_dev == dev && td->dm_dev.mode == mode)
			return td;

	return NULL;
}

int dm_get_table_device(struct mapped_device *md, dev_t dev, fmode_t mode,
			struct dm_dev **result) {
	int r;
	struct table_device *td;

	mutex_lock(&md->table_devices_lock);
	td = find_table_device(&md->table_devices, dev, mode);
	if (!td) {
		td = kmalloc(sizeof(*td), GFP_KERNEL);
		if (!td) {
			mutex_unlock(&md->table_devices_lock);
			return -ENOMEM;
		}

		td->dm_dev.mode = mode;
		td->dm_dev.bdev = NULL;

		if ((r = open_table_device(td, dev, md))) {
			mutex_unlock(&md->table_devices_lock);
			kfree(td);
			return r;
		}

		format_dev_t(td->dm_dev.name, dev);

		atomic_set(&td->count, 0);
		list_add(&td->list, &md->table_devices);
	}
	atomic_inc(&td->count);
	mutex_unlock(&md->table_devices_lock);

	*result = &td->dm_dev;
	return 0;
}
EXPORT_SYMBOL_GPL(dm_get_table_device);

void dm_put_table_device(struct mapped_device *md, struct dm_dev *d)
{
	struct table_device *td = container_of(d, struct table_device, dm_dev);

	mutex_lock(&md->table_devices_lock);
	if (atomic_dec_and_test(&td->count)) {
		close_table_device(td, md);
		list_del(&td->list);
		kfree(td);
	}
	mutex_unlock(&md->table_devices_lock);
}
EXPORT_SYMBOL(dm_put_table_device);

static void free_table_devices(struct list_head *devices)
{
	struct list_head *tmp, *next;

	list_for_each_safe(tmp, next, devices) {
		struct table_device *td = list_entry(tmp, struct table_device, list);

		DMWARN("dm_destroy: %s still exists with %d references",
		       td->dm_dev.name, atomic_read(&td->count));
		kfree(td);
	}
}

D
Darrick J. Wong 已提交
877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903
/*
 * Get the geometry associated with a dm device
 */
int dm_get_geometry(struct mapped_device *md, struct hd_geometry *geo)
{
	*geo = md->geometry;

	return 0;
}

/*
 * Set the geometry of a device.
 */
int dm_set_geometry(struct mapped_device *md, struct hd_geometry *geo)
{
	sector_t sz = (sector_t)geo->cylinders * geo->heads * geo->sectors;

	if (geo->start > sz) {
		DMWARN("Start sector is beyond the geometry limits.");
		return -EINVAL;
	}

	md->geometry = *geo;

	return 0;
}

L
Linus Torvalds 已提交
904 905 906 907 908 909 910 911 912
/*-----------------------------------------------------------------
 * CRUD START:
 *   A more elegant soln is in the works that uses the queue
 *   merge fn, unfortunately there are a couple of changes to
 *   the block layer that I want to make for this.  So in the
 *   interests of getting something for people to use I give
 *   you this clearly demarcated crap.
 *---------------------------------------------------------------*/

913 914 915 916 917
static int __noflush_suspending(struct mapped_device *md)
{
	return test_bit(DMF_NOFLUSH_SUSPENDING, &md->flags);
}

L
Linus Torvalds 已提交
918 919 920 921
/*
 * Decrements the number of outstanding ios that a bio has been
 * cloned into, completing the original io if necc.
 */
922
static void dec_pending(struct dm_io *io, int error)
L
Linus Torvalds 已提交
923
{
924
	unsigned long flags;
925 926 927
	int io_error;
	struct bio *bio;
	struct mapped_device *md = io->md;
928 929

	/* Push-back supersedes any I/O errors */
930 931 932 933 934 935
	if (unlikely(error)) {
		spin_lock_irqsave(&io->endio_lock, flags);
		if (!(io->error > 0 && __noflush_suspending(md)))
			io->error = error;
		spin_unlock_irqrestore(&io->endio_lock, flags);
	}
L
Linus Torvalds 已提交
936 937

	if (atomic_dec_and_test(&io->io_count)) {
938 939 940 941
		if (io->error == DM_ENDIO_REQUEUE) {
			/*
			 * Target requested pushing back the I/O.
			 */
942
			spin_lock_irqsave(&md->deferred_lock, flags);
943 944 945
			if (__noflush_suspending(md))
				bio_list_add_head(&md->deferred, io->bio);
			else
946 947
				/* noflush suspend was interrupted. */
				io->error = -EIO;
948
			spin_unlock_irqrestore(&md->deferred_lock, flags);
949 950
		}

951 952
		io_error = io->error;
		bio = io->bio;
953 954 955 956 957
		end_io_acct(io);
		free_io(md, io);

		if (io_error == DM_ENDIO_REQUEUE)
			return;
958

959
		if ((bio->bi_rw & REQ_FLUSH) && bio->bi_iter.bi_size) {
960
			/*
961 962
			 * Preflush done for flush with data, reissue
			 * without REQ_FLUSH.
963
			 */
964 965
			bio->bi_rw &= ~REQ_FLUSH;
			queue_io(md, bio);
966
		} else {
967
			/* done with normal IO or empty flush */
968
			trace_block_bio_complete(md->queue, bio, io_error);
969 970
			bio->bi_error = io_error;
			bio_endio(bio);
971
		}
L
Linus Torvalds 已提交
972 973 974
	}
}

975 976 977 978 979 980 981 982
static void disable_write_same(struct mapped_device *md)
{
	struct queue_limits *limits = dm_get_queue_limits(md);

	/* device doesn't really support WRITE SAME, disable it */
	limits->max_write_same_sectors = 0;
}

983
static void clone_endio(struct bio *bio)
L
Linus Torvalds 已提交
984
{
985
	int error = bio->bi_error;
986
	int r = error;
M
Mikulas Patocka 已提交
987
	struct dm_target_io *tio = container_of(bio, struct dm_target_io, clone);
988
	struct dm_io *io = tio->io;
S
Stefan Bader 已提交
989
	struct mapped_device *md = tio->io->md;
L
Linus Torvalds 已提交
990 991 992
	dm_endio_fn endio = tio->ti->type->end_io;

	if (endio) {
M
Mikulas Patocka 已提交
993
		r = endio(tio->ti, bio, error);
994 995 996 997 998
		if (r < 0 || r == DM_ENDIO_REQUEUE)
			/*
			 * error and requeue request are handled
			 * in dec_pending().
			 */
L
Linus Torvalds 已提交
999
			error = r;
1000 1001
		else if (r == DM_ENDIO_INCOMPLETE)
			/* The target will handle the io */
1002
			return;
1003 1004 1005 1006
		else if (r) {
			DMWARN("unimplemented target endio return value: %d", r);
			BUG();
		}
L
Linus Torvalds 已提交
1007 1008
	}

1009 1010 1011 1012
	if (unlikely(r == -EREMOTEIO && (bio->bi_rw & REQ_WRITE_SAME) &&
		     !bdev_get_queue(bio->bi_bdev)->limits.max_write_same_sectors))
		disable_write_same(md);

S
Stefan Bader 已提交
1013
	free_tio(md, tio);
1014
	dec_pending(io, error);
L
Linus Torvalds 已提交
1015 1016
}

1017 1018 1019
/*
 * Partial completion handling for request-based dm
 */
1020
static void end_clone_bio(struct bio *clone)
1021 1022 1023 1024 1025 1026
{
	struct dm_rq_clone_bio_info *info =
		container_of(clone, struct dm_rq_clone_bio_info, clone);
	struct dm_rq_target_io *tio = info->tio;
	struct bio *bio = info->orig;
	unsigned int nr_bytes = info->orig->bi_iter.bi_size;
1027
	int error = clone->bi_error;
1028 1029 1030 1031 1032 1033 1034 1035 1036 1037

	bio_put(clone);

	if (tio->error)
		/*
		 * An error has already been detected on the request.
		 * Once error occurred, just let clone->end_io() handle
		 * the remainder.
		 */
		return;
1038
	else if (error) {
1039 1040 1041 1042 1043
		/*
		 * Don't notice the error to the upper layer yet.
		 * The error handling decision is made by the target driver,
		 * when the request is completed.
		 */
1044
		tio->error = error;
1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068
		return;
	}

	/*
	 * I/O for the bio successfully completed.
	 * Notice the data completion to the upper layer.
	 */

	/*
	 * bios are processed from the head of the list.
	 * So the completing bio should always be rq->bio.
	 * If it's not, something wrong is happening.
	 */
	if (tio->orig->bio != bio)
		DMERR("bio completion is going in the middle of the request");

	/*
	 * Update the original request.
	 * Do not use blk_end_request() here, because it may complete
	 * the original request before the clone, and break the ordering.
	 */
	blk_update_request(tio->orig, 0, nr_bytes);
}

1069 1070 1071 1072 1073
static struct dm_rq_target_io *tio_from_request(struct request *rq)
{
	return (rq->q->mq_ops ? blk_mq_rq_to_pdu(rq) : rq->special);
}

1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084
static void rq_end_stats(struct mapped_device *md, struct request *orig)
{
	if (unlikely(dm_stats_used(&md->stats))) {
		struct dm_rq_target_io *tio = tio_from_request(orig);
		tio->duration_jiffies = jiffies - tio->duration_jiffies;
		dm_stats_account_io(&md->stats, orig->cmd_flags, blk_rq_pos(orig),
				    tio->n_sectors, true, tio->duration_jiffies,
				    &tio->stats_aux);
	}
}

1085 1086 1087 1088 1089
/*
 * Don't touch any member of the md after calling this function because
 * the md may be freed in dm_put() at the end of this function.
 * Or do dm_get() before calling this function and dm_put() later.
 */
1090
static void rq_completed(struct mapped_device *md, int rw, bool run_queue)
1091
{
1092
	atomic_dec(&md->pending[rw]);
1093 1094

	/* nudge anyone waiting on suspend queue */
1095
	if (!md_in_flight(md))
1096 1097
		wake_up(&md->wait);

1098 1099 1100 1101 1102 1103
	/*
	 * Run this off this callpath, as drivers could invoke end_io while
	 * inside their request_fn (and holding the queue lock). Calling
	 * back into ->request_fn() could deadlock attempting to grab the
	 * queue lock again.
	 */
1104 1105
	if (!md->queue->mq_ops && run_queue)
		blk_run_queue_async(md->queue);
1106 1107 1108 1109 1110 1111 1112

	/*
	 * dm_put() must be at the end of this function. See the comment above
	 */
	dm_put(md);
}

1113
static void free_rq_clone(struct request *clone)
1114 1115
{
	struct dm_rq_target_io *tio = clone->end_io_data;
1116
	struct mapped_device *md = tio->md;
1117

1118 1119
	blk_rq_unprep_clone(clone);

1120 1121
	if (md->type == DM_TYPE_MQ_REQUEST_BASED)
		/* stacked on blk-mq queue(s) */
1122
		tio->ti->type->release_clone_rq(clone);
1123 1124
	else if (!md->queue->mq_ops)
		/* request_fn queue stacked on request_fn queue(s) */
1125
		free_clone_request(md, clone);
1126 1127 1128 1129 1130
	/*
	 * NOTE: for the blk-mq queue stacked on request_fn queue(s) case:
	 * no need to call free_clone_request() because we leverage blk-mq by
	 * allocating the clone at the end of the blk-mq pdu (see: clone_rq)
	 */
1131 1132 1133

	if (!md->queue->mq_ops)
		free_rq_tio(tio);
1134 1135
}

K
Kiyoshi Ueda 已提交
1136 1137
/*
 * Complete the clone and the original request.
1138 1139
 * Must be called without clone's queue lock held,
 * see end_clone_request() for more details.
K
Kiyoshi Ueda 已提交
1140 1141 1142 1143 1144 1145 1146 1147
 */
static void dm_end_request(struct request *clone, int error)
{
	int rw = rq_data_dir(clone);
	struct dm_rq_target_io *tio = clone->end_io_data;
	struct mapped_device *md = tio->md;
	struct request *rq = tio->orig;

1148
	if (rq->cmd_type == REQ_TYPE_BLOCK_PC) {
K
Kiyoshi Ueda 已提交
1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160
		rq->errors = clone->errors;
		rq->resid_len = clone->resid_len;

		if (rq->sense)
			/*
			 * We are using the sense buffer of the original
			 * request.
			 * So setting the length of the sense data is enough.
			 */
			rq->sense_len = clone->sense_len;
	}

1161
	free_rq_clone(clone);
1162
	rq_end_stats(md, rq);
1163 1164 1165 1166
	if (!rq->q->mq_ops)
		blk_end_request_all(rq, error);
	else
		blk_mq_end_request(rq, error);
1167
	rq_completed(md, rw, true);
K
Kiyoshi Ueda 已提交
1168 1169
}

1170 1171
static void dm_unprep_request(struct request *rq)
{
1172
	struct dm_rq_target_io *tio = tio_from_request(rq);
1173
	struct request *clone = tio->clone;
1174

1175 1176 1177 1178
	if (!rq->q->mq_ops) {
		rq->special = NULL;
		rq->cmd_flags &= ~REQ_DONTPREP;
	}
1179

1180
	if (clone)
1181
		free_rq_clone(clone);
1182 1183
	else if (!tio->md->queue->mq_ops)
		free_rq_tio(tio);
1184 1185 1186 1187 1188
}

/*
 * Requeue the original request of a clone.
 */
1189
static void old_requeue_request(struct request *rq)
1190 1191 1192 1193 1194 1195
{
	struct request_queue *q = rq->q;
	unsigned long flags;

	spin_lock_irqsave(q->queue_lock, flags);
	blk_requeue_request(q, rq);
J
Junichi Nomura 已提交
1196
	blk_run_queue_async(q);
1197
	spin_unlock_irqrestore(q->queue_lock, flags);
1198 1199
}

1200 1201
static void dm_requeue_original_request(struct mapped_device *md,
					struct request *rq)
1202 1203 1204 1205 1206
{
	int rw = rq_data_dir(rq);

	dm_unprep_request(rq);

1207
	rq_end_stats(md, rq);
1208 1209 1210 1211 1212 1213
	if (!rq->q->mq_ops)
		old_requeue_request(rq);
	else {
		blk_mq_requeue_request(rq);
		blk_mq_kick_requeue_list(rq->q);
	}
1214

1215 1216 1217
	rq_completed(md, rw, false);
}

1218
static void old_stop_queue(struct request_queue *q)
1219 1220 1221
{
	unsigned long flags;

1222 1223 1224
	if (blk_queue_stopped(q))
		return;

1225
	spin_lock_irqsave(q->queue_lock, flags);
1226
	blk_stop_queue(q);
1227 1228 1229
	spin_unlock_irqrestore(q->queue_lock, flags);
}

1230
static void stop_queue(struct request_queue *q)
1231
{
1232 1233 1234 1235
	if (!q->mq_ops)
		old_stop_queue(q);
	else
		blk_mq_stop_hw_queues(q);
1236 1237
}

1238
static void old_start_queue(struct request_queue *q)
1239 1240 1241 1242
{
	unsigned long flags;

	spin_lock_irqsave(q->queue_lock, flags);
1243 1244
	if (blk_queue_stopped(q))
		blk_start_queue(q);
1245 1246 1247
	spin_unlock_irqrestore(q->queue_lock, flags);
}

1248 1249 1250 1251 1252 1253 1254 1255
static void start_queue(struct request_queue *q)
{
	if (!q->mq_ops)
		old_start_queue(q);
	else
		blk_mq_start_stopped_hw_queues(q, true);
}

1256
static void dm_done(struct request *clone, int error, bool mapped)
1257
{
1258
	int r = error;
1259
	struct dm_rq_target_io *tio = clone->end_io_data;
1260
	dm_request_endio_fn rq_end_io = NULL;
1261

1262 1263 1264 1265 1266 1267
	if (tio->ti) {
		rq_end_io = tio->ti->type->rq_end_io;

		if (mapped && rq_end_io)
			r = rq_end_io(tio->ti, clone, error, &tio->info);
	}
1268

1269 1270 1271 1272
	if (unlikely(r == -EREMOTEIO && (clone->cmd_flags & REQ_WRITE_SAME) &&
		     !clone->q->limits.max_write_same_sectors))
		disable_write_same(tio->md);

1273
	if (r <= 0)
1274
		/* The target wants to complete the I/O */
1275 1276
		dm_end_request(clone, r);
	else if (r == DM_ENDIO_INCOMPLETE)
1277 1278
		/* The target will handle the I/O */
		return;
1279
	else if (r == DM_ENDIO_REQUEUE)
1280
		/* The target wants to requeue the I/O */
1281
		dm_requeue_original_request(tio->md, tio->orig);
1282
	else {
1283
		DMWARN("unimplemented target endio return value: %d", r);
1284 1285 1286 1287
		BUG();
	}
}

1288 1289 1290 1291 1292 1293
/*
 * Request completion handler for request-based dm
 */
static void dm_softirq_done(struct request *rq)
{
	bool mapped = true;
1294
	struct dm_rq_target_io *tio = tio_from_request(rq);
1295
	struct request *clone = tio->clone;
1296
	int rw;
1297

1298
	if (!clone) {
1299
		rq_end_stats(tio->md, rq);
1300 1301 1302 1303 1304 1305 1306 1307 1308
		rw = rq_data_dir(rq);
		if (!rq->q->mq_ops) {
			blk_end_request_all(rq, tio->error);
			rq_completed(tio->md, rw, false);
			free_rq_tio(tio);
		} else {
			blk_mq_end_request(rq, tio->error);
			rq_completed(tio->md, rw, false);
		}
1309 1310
		return;
	}
1311 1312 1313 1314 1315 1316 1317

	if (rq->cmd_flags & REQ_FAILED)
		mapped = false;

	dm_done(clone, tio->error, mapped);
}

1318 1319 1320 1321
/*
 * Complete the clone and the original request with the error status
 * through softirq context.
 */
1322
static void dm_complete_request(struct request *rq, int error)
1323
{
1324
	struct dm_rq_target_io *tio = tio_from_request(rq);
1325 1326

	tio->error = error;
1327 1328 1329 1330
	if (!rq->q->mq_ops)
		blk_complete_request(rq);
	else
		blk_mq_complete_request(rq, error);
1331 1332 1333 1334 1335 1336
}

/*
 * Complete the not-mapped clone and the original request with the error status
 * through softirq context.
 * Target's rq_end_io() function isn't called.
1337
 * This may be used when the target's map_rq() or clone_and_map_rq() functions fail.
1338
 */
1339
static void dm_kill_unmapped_request(struct request *rq, int error)
1340 1341
{
	rq->cmd_flags |= REQ_FAILED;
1342
	dm_complete_request(rq, error);
1343 1344 1345
}

/*
1346
 * Called with the clone's queue lock held (for non-blk-mq)
1347 1348 1349
 */
static void end_clone_request(struct request *clone, int error)
{
1350 1351
	struct dm_rq_target_io *tio = clone->end_io_data;

1352 1353 1354 1355 1356 1357 1358 1359 1360
	if (!clone->q->mq_ops) {
		/*
		 * For just cleaning up the information of the queue in which
		 * the clone was dispatched.
		 * The clone is *NOT* freed actually here because it is alloced
		 * from dm own mempool (REQ_ALLOCED isn't set).
		 */
		__blk_put_request(clone->q, clone);
	}
1361 1362 1363

	/*
	 * Actual request completion is done in a softirq context which doesn't
1364
	 * hold the clone's queue lock.  Otherwise, deadlock could occur because:
1365 1366 1367
	 *     - another request may be submitted by the upper level driver
	 *       of the stacking during the completion
	 *     - the submission which requires queue lock may be done
1368
	 *       against this clone's queue
1369
	 */
1370
	dm_complete_request(tio->orig, error);
1371 1372
}

1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384
/*
 * Return maximum size of I/O possible at the supplied sector up to the current
 * target boundary.
 */
static sector_t max_io_len_target_boundary(sector_t sector, struct dm_target *ti)
{
	sector_t target_offset = dm_target_offset(ti, sector);

	return ti->len - target_offset;
}

static sector_t max_io_len(sector_t sector, struct dm_target *ti)
L
Linus Torvalds 已提交
1385
{
1386
	sector_t len = max_io_len_target_boundary(sector, ti);
1387
	sector_t offset, max_len;
L
Linus Torvalds 已提交
1388 1389

	/*
1390
	 * Does the target need to split even further?
L
Linus Torvalds 已提交
1391
	 */
1392 1393 1394 1395 1396 1397 1398 1399 1400 1401
	if (ti->max_io_len) {
		offset = dm_target_offset(ti, sector);
		if (unlikely(ti->max_io_len & (ti->max_io_len - 1)))
			max_len = sector_div(offset, ti->max_io_len);
		else
			max_len = offset & (ti->max_io_len - 1);
		max_len = ti->max_io_len - max_len;

		if (len > max_len)
			len = max_len;
L
Linus Torvalds 已提交
1402 1403 1404 1405 1406
	}

	return len;
}

1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421
int dm_set_target_max_io_len(struct dm_target *ti, sector_t len)
{
	if (len > UINT_MAX) {
		DMERR("Specified maximum size of target IO (%llu) exceeds limit (%u)",
		      (unsigned long long)len, UINT_MAX);
		ti->error = "Maximum size of target IO is too large";
		return -EINVAL;
	}

	ti->max_io_len = (uint32_t) len;

	return 0;
}
EXPORT_SYMBOL_GPL(dm_set_target_max_io_len);

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 1460 1461
/*
 * A target may call dm_accept_partial_bio only from the map routine.  It is
 * allowed for all bio types except REQ_FLUSH.
 *
 * dm_accept_partial_bio informs the dm that the target only wants to process
 * additional n_sectors sectors of the bio and the rest of the data should be
 * sent in a next bio.
 *
 * A diagram that explains the arithmetics:
 * +--------------------+---------------+-------+
 * |         1          |       2       |   3   |
 * +--------------------+---------------+-------+
 *
 * <-------------- *tio->len_ptr --------------->
 *                      <------- bi_size ------->
 *                      <-- n_sectors -->
 *
 * Region 1 was already iterated over with bio_advance or similar function.
 *	(it may be empty if the target doesn't use bio_advance)
 * Region 2 is the remaining bio size that the target wants to process.
 *	(it may be empty if region 1 is non-empty, although there is no reason
 *	 to make it empty)
 * The target requires that region 3 is to be sent in the next bio.
 *
 * If the target wants to receive multiple copies of the bio (via num_*bios, etc),
 * the partially processed part (the sum of regions 1+2) must be the same for all
 * copies of the bio.
 */
void dm_accept_partial_bio(struct bio *bio, unsigned n_sectors)
{
	struct dm_target_io *tio = container_of(bio, struct dm_target_io, clone);
	unsigned bi_size = bio->bi_iter.bi_size >> SECTOR_SHIFT;
	BUG_ON(bio->bi_rw & REQ_FLUSH);
	BUG_ON(bi_size > *tio->len_ptr);
	BUG_ON(n_sectors > bi_size);
	*tio->len_ptr -= bi_size - n_sectors;
	bio->bi_iter.bi_size = n_sectors << SECTOR_SHIFT;
}
EXPORT_SYMBOL_GPL(dm_accept_partial_bio);

A
Alasdair G Kergon 已提交
1462
static void __map_bio(struct dm_target_io *tio)
L
Linus Torvalds 已提交
1463 1464
{
	int r;
1465
	sector_t sector;
S
Stefan Bader 已提交
1466
	struct mapped_device *md;
1467
	struct bio *clone = &tio->clone;
A
Alasdair G Kergon 已提交
1468
	struct dm_target *ti = tio->ti;
L
Linus Torvalds 已提交
1469 1470 1471 1472 1473 1474 1475 1476 1477

	clone->bi_end_io = clone_endio;

	/*
	 * Map the clone.  If r == 0 we don't need to do
	 * anything, the target has assumed ownership of
	 * this io.
	 */
	atomic_inc(&tio->io->io_count);
1478
	sector = clone->bi_iter.bi_sector;
M
Mikulas Patocka 已提交
1479
	r = ti->type->map(ti, clone);
1480
	if (r == DM_MAPIO_REMAPPED) {
L
Linus Torvalds 已提交
1481
		/* the bio has been remapped so dispatch it */
1482

1483 1484
		trace_block_bio_remap(bdev_get_queue(clone->bi_bdev), clone,
				      tio->io->bio->bi_bdev->bd_dev, sector);
1485

L
Linus Torvalds 已提交
1486
		generic_make_request(clone);
1487 1488
	} else if (r < 0 || r == DM_MAPIO_REQUEUE) {
		/* error the io and bail out, or requeue it if needed */
S
Stefan Bader 已提交
1489 1490 1491
		md = tio->io->md;
		dec_pending(tio->io, r);
		free_tio(md, tio);
1492
	} else if (r != DM_MAPIO_SUBMITTED) {
1493 1494
		DMWARN("unimplemented target map return value: %d", r);
		BUG();
L
Linus Torvalds 已提交
1495 1496 1497 1498 1499 1500 1501 1502 1503
	}
}

struct clone_info {
	struct mapped_device *md;
	struct dm_table *map;
	struct bio *bio;
	struct dm_io *io;
	sector_t sector;
1504
	unsigned sector_count;
L
Linus Torvalds 已提交
1505 1506
};

1507
static void bio_setup_sector(struct bio *bio, sector_t sector, unsigned len)
A
Alasdair G Kergon 已提交
1508
{
1509 1510
	bio->bi_iter.bi_sector = sector;
	bio->bi_iter.bi_size = to_bytes(len);
L
Linus Torvalds 已提交
1511 1512 1513 1514 1515
}

/*
 * Creates a bio that consists of range of complete bvecs.
 */
1516
static void clone_bio(struct dm_target_io *tio, struct bio *bio,
1517
		      sector_t sector, unsigned len)
L
Linus Torvalds 已提交
1518
{
1519
	struct bio *clone = &tio->clone;
L
Linus Torvalds 已提交
1520

1521 1522 1523 1524
	__bio_clone_fast(clone, bio);

	if (bio_integrity(bio))
		bio_integrity_clone(clone, bio, GFP_NOIO);
A
Alasdair G Kergon 已提交
1525

1526 1527 1528 1529 1530
	bio_advance(clone, to_bytes(sector - clone->bi_iter.bi_sector));
	clone->bi_iter.bi_size = to_bytes(len);

	if (bio_integrity(bio))
		bio_integrity_trim(clone, 0, len);
L
Linus Torvalds 已提交
1531 1532
}

1533
static struct dm_target_io *alloc_tio(struct clone_info *ci,
1534
				      struct dm_target *ti,
1535
				      unsigned target_bio_nr)
1536
{
1537 1538 1539
	struct dm_target_io *tio;
	struct bio *clone;

1540
	clone = bio_alloc_bioset(GFP_NOIO, 0, ci->md->bs);
1541
	tio = container_of(clone, struct dm_target_io, clone);
1542 1543 1544

	tio->io = ci->io;
	tio->ti = ti;
1545
	tio->target_bio_nr = target_bio_nr;
1546 1547 1548 1549

	return tio;
}

1550 1551
static void __clone_and_map_simple_bio(struct clone_info *ci,
				       struct dm_target *ti,
1552
				       unsigned target_bio_nr, unsigned *len)
1553
{
1554
	struct dm_target_io *tio = alloc_tio(ci, ti, target_bio_nr);
1555
	struct bio *clone = &tio->clone;
1556

1557 1558
	tio->len_ptr = len;

1559
	__bio_clone_fast(clone, ci->bio);
A
Alasdair G Kergon 已提交
1560
	if (len)
1561
		bio_setup_sector(clone, ci->sector, *len);
1562

A
Alasdair G Kergon 已提交
1563
	__map_bio(tio);
1564 1565
}

1566
static void __send_duplicate_bios(struct clone_info *ci, struct dm_target *ti,
1567
				  unsigned num_bios, unsigned *len)
1568
{
1569
	unsigned target_bio_nr;
1570

1571
	for (target_bio_nr = 0; target_bio_nr < num_bios; target_bio_nr++)
1572
		__clone_and_map_simple_bio(ci, ti, target_bio_nr, len);
1573 1574
}

1575
static int __send_empty_flush(struct clone_info *ci)
1576
{
1577
	unsigned target_nr = 0;
1578 1579
	struct dm_target *ti;

1580
	BUG_ON(bio_has_data(ci->bio));
1581
	while ((ti = dm_table_get_target(ci->map, target_nr++)))
1582
		__send_duplicate_bios(ci, ti, ti->num_flush_bios, NULL);
1583 1584 1585 1586

	return 0;
}

A
Alasdair G Kergon 已提交
1587
static void __clone_and_map_data_bio(struct clone_info *ci, struct dm_target *ti,
1588
				     sector_t sector, unsigned *len)
M
Mike Snitzer 已提交
1589
{
1590
	struct bio *bio = ci->bio;
M
Mike Snitzer 已提交
1591
	struct dm_target_io *tio;
1592 1593
	unsigned target_bio_nr;
	unsigned num_target_bios = 1;
M
Mike Snitzer 已提交
1594

1595 1596 1597 1598 1599
	/*
	 * Does the target want to receive duplicate copies of the bio?
	 */
	if (bio_data_dir(bio) == WRITE && ti->num_write_bios)
		num_target_bios = ti->num_write_bios(ti, bio);
A
Alasdair G Kergon 已提交
1600

1601
	for (target_bio_nr = 0; target_bio_nr < num_target_bios; target_bio_nr++) {
1602
		tio = alloc_tio(ci, ti, target_bio_nr);
1603 1604
		tio->len_ptr = len;
		clone_bio(tio, bio, sector, *len);
1605 1606
		__map_bio(tio);
	}
M
Mike Snitzer 已提交
1607 1608
}

1609
typedef unsigned (*get_num_bios_fn)(struct dm_target *ti);
M
Mike Snitzer 已提交
1610

1611
static unsigned get_num_discard_bios(struct dm_target *ti)
M
Mike Snitzer 已提交
1612
{
1613
	return ti->num_discard_bios;
M
Mike Snitzer 已提交
1614 1615
}

1616
static unsigned get_num_write_same_bios(struct dm_target *ti)
M
Mike Snitzer 已提交
1617
{
1618
	return ti->num_write_same_bios;
M
Mike Snitzer 已提交
1619 1620 1621 1622 1623 1624
}

typedef bool (*is_split_required_fn)(struct dm_target *ti);

static bool is_split_required_for_discard(struct dm_target *ti)
{
1625
	return ti->split_discard_bios;
M
Mike Snitzer 已提交
1626 1627
}

1628 1629 1630
static int __send_changing_extent_only(struct clone_info *ci,
				       get_num_bios_fn get_num_bios,
				       is_split_required_fn is_split_required)
M
Mike Snitzer 已提交
1631 1632
{
	struct dm_target *ti;
1633
	unsigned len;
1634
	unsigned num_bios;
M
Mike Snitzer 已提交
1635

1636 1637 1638 1639
	do {
		ti = dm_table_find_target(ci->map, ci->sector);
		if (!dm_target_is_valid(ti))
			return -EIO;
M
Mike Snitzer 已提交
1640 1641

		/*
M
Mike Snitzer 已提交
1642 1643
		 * Even though the device advertised support for this type of
		 * request, that does not mean every target supports it, and
M
Mike Snitzer 已提交
1644
		 * reconfiguration might also have changed that since the
1645
		 * check was performed.
M
Mike Snitzer 已提交
1646
		 */
1647 1648
		num_bios = get_num_bios ? get_num_bios(ti) : 0;
		if (!num_bios)
1649
			return -EOPNOTSUPP;
M
Mike Snitzer 已提交
1650

M
Mike Snitzer 已提交
1651
		if (is_split_required && !is_split_required(ti))
1652
			len = min((sector_t)ci->sector_count, max_io_len_target_boundary(ci->sector, ti));
1653
		else
1654
			len = min((sector_t)ci->sector_count, max_io_len(ci->sector, ti));
1655

1656
		__send_duplicate_bios(ci, ti, num_bios, &len);
1657 1658 1659

		ci->sector += len;
	} while (ci->sector_count -= len);
M
Mike Snitzer 已提交
1660 1661 1662 1663

	return 0;
}

1664
static int __send_discard(struct clone_info *ci)
M
Mike Snitzer 已提交
1665
{
1666 1667
	return __send_changing_extent_only(ci, get_num_discard_bios,
					   is_split_required_for_discard);
M
Mike Snitzer 已提交
1668 1669
}

1670
static int __send_write_same(struct clone_info *ci)
M
Mike Snitzer 已提交
1671
{
1672
	return __send_changing_extent_only(ci, get_num_write_same_bios, NULL);
M
Mike Snitzer 已提交
1673 1674
}

A
Alasdair G Kergon 已提交
1675 1676 1677
/*
 * Select the correct strategy for processing a non-flush bio.
 */
1678
static int __split_and_process_non_flush(struct clone_info *ci)
L
Linus Torvalds 已提交
1679
{
1680
	struct bio *bio = ci->bio;
1681
	struct dm_target *ti;
1682
	unsigned len;
L
Linus Torvalds 已提交
1683

M
Mike Snitzer 已提交
1684
	if (unlikely(bio->bi_rw & REQ_DISCARD))
1685
		return __send_discard(ci);
M
Mike Snitzer 已提交
1686
	else if (unlikely(bio->bi_rw & REQ_WRITE_SAME))
1687
		return __send_write_same(ci);
M
Mike Snitzer 已提交
1688

1689 1690 1691 1692
	ti = dm_table_find_target(ci->map, ci->sector);
	if (!dm_target_is_valid(ti))
		return -EIO;

1693
	len = min_t(sector_t, max_io_len(ci->sector, ti), ci->sector_count);
L
Linus Torvalds 已提交
1694

1695
	__clone_and_map_data_bio(ci, ti, ci->sector, &len);
L
Linus Torvalds 已提交
1696

1697 1698
	ci->sector += len;
	ci->sector_count -= len;
L
Linus Torvalds 已提交
1699

1700
	return 0;
L
Linus Torvalds 已提交
1701 1702 1703
}

/*
1704
 * Entry point to split a bio into clones and submit them to the targets.
L
Linus Torvalds 已提交
1705
 */
M
Mikulas Patocka 已提交
1706 1707
static void __split_and_process_bio(struct mapped_device *md,
				    struct dm_table *map, struct bio *bio)
L
Linus Torvalds 已提交
1708 1709
{
	struct clone_info ci;
1710
	int error = 0;
L
Linus Torvalds 已提交
1711

M
Mikulas Patocka 已提交
1712
	if (unlikely(!map)) {
1713
		bio_io_error(bio);
1714 1715
		return;
	}
1716

M
Mikulas Patocka 已提交
1717
	ci.map = map;
L
Linus Torvalds 已提交
1718 1719 1720 1721 1722 1723
	ci.md = md;
	ci.io = alloc_io(md);
	ci.io->error = 0;
	atomic_set(&ci.io->io_count, 1);
	ci.io->bio = bio;
	ci.io->md = md;
1724
	spin_lock_init(&ci.io->endio_lock);
1725
	ci.sector = bio->bi_iter.bi_sector;
L
Linus Torvalds 已提交
1726

1727
	start_io_acct(ci.io);
A
Alasdair G Kergon 已提交
1728

1729 1730 1731
	if (bio->bi_rw & REQ_FLUSH) {
		ci.bio = &ci.md->flush_bio;
		ci.sector_count = 0;
1732
		error = __send_empty_flush(&ci);
1733 1734
		/* dec_pending submits any data associated with flush */
	} else {
1735
		ci.bio = bio;
1736
		ci.sector_count = bio_sectors(bio);
1737
		while (ci.sector_count && !error)
1738
			error = __split_and_process_non_flush(&ci);
1739
	}
L
Linus Torvalds 已提交
1740 1741

	/* drop the extra reference count */
1742
	dec_pending(ci.io, error);
L
Linus Torvalds 已提交
1743 1744 1745 1746 1747 1748 1749 1750 1751
}
/*-----------------------------------------------------------------
 * CRUD END
 *---------------------------------------------------------------*/

/*
 * The request function that just remaps the bio built up by
 * dm_merge_bvec.
 */
1752
static blk_qc_t dm_make_request(struct request_queue *q, struct bio *bio)
L
Linus Torvalds 已提交
1753
{
1754
	int rw = bio_data_dir(bio);
L
Linus Torvalds 已提交
1755
	struct mapped_device *md = q->queuedata;
M
Mikulas Patocka 已提交
1756 1757
	int srcu_idx;
	struct dm_table *map;
L
Linus Torvalds 已提交
1758

M
Mikulas Patocka 已提交
1759
	map = dm_get_live_table(md, &srcu_idx);
L
Linus Torvalds 已提交
1760

1761
	generic_start_io_acct(rw, bio_sectors(bio), &dm_disk(md)->part0);
1762

1763 1764
	/* if we're suspended, we have to queue this io for later */
	if (unlikely(test_bit(DMF_BLOCK_IO_FOR_SUSPEND, &md->flags))) {
M
Mikulas Patocka 已提交
1765
		dm_put_live_table(md, srcu_idx);
L
Linus Torvalds 已提交
1766

1767 1768 1769
		if (bio_rw(bio) != READA)
			queue_io(md, bio);
		else
A
Alasdair G Kergon 已提交
1770
			bio_io_error(bio);
1771
		return BLK_QC_T_NONE;
L
Linus Torvalds 已提交
1772 1773
	}

M
Mikulas Patocka 已提交
1774 1775
	__split_and_process_bio(md, map, bio);
	dm_put_live_table(md, srcu_idx);
1776
	return BLK_QC_T_NONE;
1777 1778
}

M
Mikulas Patocka 已提交
1779
int dm_request_based(struct mapped_device *md)
1780 1781 1782 1783
{
	return blk_queue_stackable(md->queue);
}

1784
static void dm_dispatch_clone_request(struct request *clone, struct request *rq)
1785 1786 1787
{
	int r;

1788 1789
	if (blk_queue_io_stat(clone->q))
		clone->cmd_flags |= REQ_IO_STAT;
1790

1791 1792
	clone->start_time = jiffies;
	r = blk_insert_cloned_request(clone->q, clone);
1793
	if (r)
1794
		/* must complete clone in terms of original request */
1795 1796 1797
		dm_complete_request(rq, r);
}

1798 1799
static int dm_rq_bio_constructor(struct bio *bio, struct bio *bio_orig,
				 void *data)
1800
{
1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813
	struct dm_rq_target_io *tio = data;
	struct dm_rq_clone_bio_info *info =
		container_of(bio, struct dm_rq_clone_bio_info, clone);

	info->orig = bio_orig;
	info->tio = tio;
	bio->bi_end_io = end_clone_bio;

	return 0;
}

static int setup_clone(struct request *clone, struct request *rq,
		       struct dm_rq_target_io *tio, gfp_t gfp_mask)
1814
{
1815 1816 1817 1818 1819 1820 1821 1822 1823 1824
	int r;

	r = blk_rq_prep_clone(clone, rq, tio->md->bs, gfp_mask,
			      dm_rq_bio_constructor, tio);
	if (r)
		return r;

	clone->cmd = rq->cmd;
	clone->cmd_len = rq->cmd_len;
	clone->sense = rq->sense;
1825 1826
	clone->end_io = end_clone_request;
	clone->end_io_data = tio;
1827

1828
	tio->clone = clone;
1829 1830

	return 0;
1831 1832
}

K
Kiyoshi Ueda 已提交
1833
static struct request *clone_rq(struct request *rq, struct mapped_device *md,
1834
				struct dm_rq_target_io *tio, gfp_t gfp_mask)
1835
{
1836 1837 1838 1839 1840 1841
	/*
	 * Do not allocate a clone if tio->clone was already set
	 * (see: dm_mq_queue_rq).
	 */
	bool alloc_clone = !tio->clone;
	struct request *clone;
1842

1843 1844 1845 1846 1847 1848
	if (alloc_clone) {
		clone = alloc_clone_request(md, gfp_mask);
		if (!clone)
			return NULL;
	} else
		clone = tio->clone;
1849 1850

	blk_rq_init(NULL, clone);
1851 1852 1853 1854 1855 1856
	if (setup_clone(clone, rq, tio, gfp_mask)) {
		/* -ENOMEM */
		if (alloc_clone)
			free_clone_request(md, clone);
		return NULL;
	}
1857 1858 1859 1860

	return clone;
}

1861 1862
static void map_tio_request(struct kthread_work *work);

1863 1864 1865 1866 1867 1868 1869 1870 1871
static void init_tio(struct dm_rq_target_io *tio, struct request *rq,
		     struct mapped_device *md)
{
	tio->md = md;
	tio->ti = NULL;
	tio->clone = NULL;
	tio->orig = rq;
	tio->error = 0;
	memset(&tio->info, 0, sizeof(tio->info));
1872 1873
	if (md->kworker_task)
		init_kthread_work(&tio->work, map_tio_request);
1874 1875
}

1876 1877
static struct dm_rq_target_io *prep_tio(struct request *rq,
					struct mapped_device *md, gfp_t gfp_mask)
K
Kiyoshi Ueda 已提交
1878 1879
{
	struct dm_rq_target_io *tio;
1880 1881
	int srcu_idx;
	struct dm_table *table;
K
Kiyoshi Ueda 已提交
1882 1883 1884 1885 1886

	tio = alloc_rq_tio(md, gfp_mask);
	if (!tio)
		return NULL;

1887
	init_tio(tio, rq, md);
K
Kiyoshi Ueda 已提交
1888

1889 1890 1891 1892 1893 1894 1895
	table = dm_get_live_table(md, &srcu_idx);
	if (!dm_table_mq_request_based(table)) {
		if (!clone_rq(rq, md, tio, gfp_mask)) {
			dm_put_live_table(md, srcu_idx);
			free_rq_tio(tio);
			return NULL;
		}
K
Kiyoshi Ueda 已提交
1896
	}
1897
	dm_put_live_table(md, srcu_idx);
K
Kiyoshi Ueda 已提交
1898

1899
	return tio;
K
Kiyoshi Ueda 已提交
1900 1901
}

1902 1903 1904 1905 1906 1907
/*
 * Called with the queue lock held.
 */
static int dm_prep_fn(struct request_queue *q, struct request *rq)
{
	struct mapped_device *md = q->queuedata;
1908
	struct dm_rq_target_io *tio;
1909 1910 1911 1912 1913 1914

	if (unlikely(rq->special)) {
		DMWARN("Already has something in rq->special.");
		return BLKPREP_KILL;
	}

1915 1916
	tio = prep_tio(rq, md, GFP_ATOMIC);
	if (!tio)
1917 1918
		return BLKPREP_DEFER;

1919
	rq->special = tio;
1920 1921 1922 1923 1924
	rq->cmd_flags |= REQ_DONTPREP;

	return BLKPREP_OK;
}

1925 1926
/*
 * Returns:
1927 1928 1929
 * 0                : the request has been processed
 * DM_MAPIO_REQUEUE : the original request needs to be requeued
 * < 0              : the request was completed due to failure
1930
 */
1931
static int map_request(struct dm_rq_target_io *tio, struct request *rq,
1932
		       struct mapped_device *md)
1933
{
1934
	int r;
1935
	struct dm_target *ti = tio->ti;
1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947
	struct request *clone = NULL;

	if (tio->clone) {
		clone = tio->clone;
		r = ti->type->map_rq(ti, clone, &tio->info);
	} else {
		r = ti->type->clone_and_map_rq(ti, rq, &tio->info, &clone);
		if (r < 0) {
			/* The target wants to complete the I/O */
			dm_kill_unmapped_request(rq, r);
			return r;
		}
1948 1949
		if (r != DM_MAPIO_REMAPPED)
			return r;
1950 1951 1952 1953 1954
		if (setup_clone(clone, rq, tio, GFP_ATOMIC)) {
			/* -ENOMEM */
			ti->type->release_clone_rq(clone);
			return DM_MAPIO_REQUEUE;
		}
1955
	}
1956 1957 1958 1959 1960 1961 1962

	switch (r) {
	case DM_MAPIO_SUBMITTED:
		/* The target has taken the I/O to submit by itself later */
		break;
	case DM_MAPIO_REMAPPED:
		/* The target has remapped the I/O so dispatch it */
1963
		trace_block_rq_remap(clone->q, clone, disk_devt(dm_disk(md)),
1964 1965
				     blk_rq_pos(rq));
		dm_dispatch_clone_request(clone, rq);
1966 1967 1968
		break;
	case DM_MAPIO_REQUEUE:
		/* The target wants to requeue the I/O */
1969
		dm_requeue_original_request(md, tio->orig);
1970 1971 1972 1973 1974 1975 1976 1977
		break;
	default:
		if (r > 0) {
			DMWARN("unimplemented target map return value: %d", r);
			BUG();
		}

		/* The target wants to complete the I/O */
1978
		dm_kill_unmapped_request(rq, r);
1979
		return r;
1980
	}
1981

1982
	return 0;
1983 1984
}

1985
static void map_tio_request(struct kthread_work *work)
1986
{
1987
	struct dm_rq_target_io *tio = container_of(work, struct dm_rq_target_io, work);
1988 1989
	struct request *rq = tio->orig;
	struct mapped_device *md = tio->md;
1990

1991
	if (map_request(tio, rq, md) == DM_MAPIO_REQUEUE)
1992
		dm_requeue_original_request(md, rq);
1993 1994
}

1995
static void dm_start_request(struct mapped_device *md, struct request *orig)
1996
{
1997 1998 1999 2000
	if (!orig->q->mq_ops)
		blk_start_request(orig);
	else
		blk_mq_start_request(orig);
2001
	atomic_inc(&md->pending[rq_data_dir(orig)]);
2002

2003 2004 2005 2006 2007
	if (md->seq_rq_merge_deadline_usecs) {
		md->last_rq_pos = rq_end_sector(orig);
		md->last_rq_rw = rq_data_dir(orig);
		md->last_rq_start_time = ktime_get();
	}
2008

2009 2010 2011 2012 2013 2014 2015 2016
	if (unlikely(dm_stats_used(&md->stats))) {
		struct dm_rq_target_io *tio = tio_from_request(orig);
		tio->duration_jiffies = jiffies;
		tio->n_sectors = blk_rq_sectors(orig);
		dm_stats_account_io(&md->stats, orig->cmd_flags, blk_rq_pos(orig),
				    tio->n_sectors, false, 0, &tio->stats_aux);
	}

2017 2018 2019 2020 2021 2022 2023 2024 2025 2026
	/*
	 * Hold the md reference here for the in-flight I/O.
	 * We can't rely on the reference count by device opener,
	 * because the device may be closed during the request completion
	 * when all bios are completed.
	 * See the comment in rq_completed() too.
	 */
	dm_get(md);
}

2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038
#define MAX_SEQ_RQ_MERGE_DEADLINE_USECS 100000

ssize_t dm_attr_rq_based_seq_io_merge_deadline_show(struct mapped_device *md, char *buf)
{
	return sprintf(buf, "%u\n", md->seq_rq_merge_deadline_usecs);
}

ssize_t dm_attr_rq_based_seq_io_merge_deadline_store(struct mapped_device *md,
						     const char *buf, size_t count)
{
	unsigned deadline;

2039
	if (!dm_request_based(md) || md->use_blk_mq)
2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065
		return count;

	if (kstrtouint(buf, 10, &deadline))
		return -EINVAL;

	if (deadline > MAX_SEQ_RQ_MERGE_DEADLINE_USECS)
		deadline = MAX_SEQ_RQ_MERGE_DEADLINE_USECS;

	md->seq_rq_merge_deadline_usecs = deadline;

	return count;
}

static bool dm_request_peeked_before_merge_deadline(struct mapped_device *md)
{
	ktime_t kt_deadline;

	if (!md->seq_rq_merge_deadline_usecs)
		return false;

	kt_deadline = ns_to_ktime((u64)md->seq_rq_merge_deadline_usecs * NSEC_PER_USEC);
	kt_deadline = ktime_add_safe(md->last_rq_start_time, kt_deadline);

	return !ktime_after(ktime_get(), kt_deadline);
}

2066 2067 2068 2069 2070 2071 2072
/*
 * q->request_fn for request-based dm.
 * Called with the queue lock held.
 */
static void dm_request_fn(struct request_queue *q)
{
	struct mapped_device *md = q->queuedata;
M
Mikulas Patocka 已提交
2073 2074
	int srcu_idx;
	struct dm_table *map = dm_get_live_table(md, &srcu_idx);
2075
	struct dm_target *ti;
2076
	struct request *rq;
2077
	struct dm_rq_target_io *tio;
2078
	sector_t pos;
2079 2080

	/*
2081 2082 2083 2084
	 * For suspend, check blk_queue_stopped() and increment
	 * ->pending within a single queue_lock not to increment the
	 * number of in-flight I/Os after the queue is stopped in
	 * dm_suspend().
2085
	 */
J
Jens Axboe 已提交
2086
	while (!blk_queue_stopped(q)) {
2087 2088
		rq = blk_peek_request(q);
		if (!rq)
2089
			goto out;
2090

2091 2092 2093 2094 2095 2096
		/* always use block 0 to find the target for flushes for now */
		pos = 0;
		if (!(rq->cmd_flags & REQ_FLUSH))
			pos = blk_rq_pos(rq);

		ti = dm_table_find_target(map, pos);
2097 2098
		if (!dm_target_is_valid(ti)) {
			/*
2099
			 * Must perform setup, that rq_completed() requires,
2100 2101 2102
			 * before calling dm_kill_unmapped_request
			 */
			DMERR_LIMIT("request attempted access beyond the end of device");
2103 2104
			dm_start_request(md, rq);
			dm_kill_unmapped_request(rq, -EIO);
2105 2106
			continue;
		}
2107

2108 2109
		if (dm_request_peeked_before_merge_deadline(md) &&
		    md_in_flight(md) && rq->bio && rq->bio->bi_vcnt == 1 &&
2110 2111 2112
		    md->last_rq_pos == pos && md->last_rq_rw == rq_data_dir(rq))
			goto delay_and_out;

2113
		if (ti->type->busy && ti->type->busy(ti))
J
Jens Axboe 已提交
2114
			goto delay_and_out;
2115

2116
		dm_start_request(md, rq);
2117

2118
		tio = tio_from_request(rq);
2119 2120 2121
		/* Establish tio->ti before queuing work (map_tio_request) */
		tio->ti = ti;
		queue_kthread_work(&md->kworker, &tio->work);
2122
		BUG_ON(!irqs_disabled());
2123 2124 2125 2126
	}

	goto out;

J
Jens Axboe 已提交
2127
delay_and_out:
2128
	blk_delay_queue(q, HZ / 100);
2129
out:
M
Mikulas Patocka 已提交
2130
	dm_put_live_table(md, srcu_idx);
2131 2132
}

L
Linus Torvalds 已提交
2133 2134
static int dm_any_congested(void *congested_data, int bdi_bits)
{
2135 2136 2137
	int r = bdi_bits;
	struct mapped_device *md = congested_data;
	struct dm_table *map;
L
Linus Torvalds 已提交
2138

2139
	if (!test_bit(DMF_BLOCK_IO_FOR_SUSPEND, &md->flags)) {
M
Mike Snitzer 已提交
2140
		if (dm_request_based(md)) {
2141
			/*
M
Mike Snitzer 已提交
2142 2143
			 * With request-based DM we only need to check the
			 * top-level queue for congestion.
2144
			 */
M
Mike Snitzer 已提交
2145 2146 2147 2148
			r = md->queue->backing_dev_info.wb.state & bdi_bits;
		} else {
			map = dm_get_live_table_fast(md);
			if (map)
2149
				r = dm_table_any_congested(map, bdi_bits);
M
Mike Snitzer 已提交
2150
			dm_put_live_table_fast(md);
2151 2152 2153
		}
	}

L
Linus Torvalds 已提交
2154 2155 2156 2157 2158 2159
	return r;
}

/*-----------------------------------------------------------------
 * An IDR is used to keep track of allocated minor numbers.
 *---------------------------------------------------------------*/
2160
static void free_minor(int minor)
L
Linus Torvalds 已提交
2161
{
2162
	spin_lock(&_minor_lock);
L
Linus Torvalds 已提交
2163
	idr_remove(&_minor_idr, minor);
2164
	spin_unlock(&_minor_lock);
L
Linus Torvalds 已提交
2165 2166 2167 2168 2169
}

/*
 * See if the device with a specific minor # is free.
 */
2170
static int specific_minor(int minor)
L
Linus Torvalds 已提交
2171
{
T
Tejun Heo 已提交
2172
	int r;
L
Linus Torvalds 已提交
2173 2174 2175 2176

	if (minor >= (1 << MINORBITS))
		return -EINVAL;

T
Tejun Heo 已提交
2177
	idr_preload(GFP_KERNEL);
2178
	spin_lock(&_minor_lock);
L
Linus Torvalds 已提交
2179

T
Tejun Heo 已提交
2180
	r = idr_alloc(&_minor_idr, MINOR_ALLOCED, minor, minor + 1, GFP_NOWAIT);
L
Linus Torvalds 已提交
2181

2182
	spin_unlock(&_minor_lock);
T
Tejun Heo 已提交
2183 2184 2185 2186
	idr_preload_end();
	if (r < 0)
		return r == -ENOSPC ? -EBUSY : r;
	return 0;
L
Linus Torvalds 已提交
2187 2188
}

2189
static int next_free_minor(int *minor)
L
Linus Torvalds 已提交
2190
{
T
Tejun Heo 已提交
2191
	int r;
J
Jeff Mahoney 已提交
2192

T
Tejun Heo 已提交
2193
	idr_preload(GFP_KERNEL);
2194
	spin_lock(&_minor_lock);
L
Linus Torvalds 已提交
2195

T
Tejun Heo 已提交
2196
	r = idr_alloc(&_minor_idr, MINOR_ALLOCED, 0, 1 << MINORBITS, GFP_NOWAIT);
L
Linus Torvalds 已提交
2197

2198
	spin_unlock(&_minor_lock);
T
Tejun Heo 已提交
2199 2200 2201 2202 2203
	idr_preload_end();
	if (r < 0)
		return r;
	*minor = r;
	return 0;
L
Linus Torvalds 已提交
2204 2205
}

2206
static const struct block_device_operations dm_blk_dops;
L
Linus Torvalds 已提交
2207

2208 2209
static void dm_wq_work(struct work_struct *work);

2210 2211 2212 2213
static void dm_init_md_queue(struct mapped_device *md)
{
	/*
	 * Request-based dm devices cannot be stacked on top of bio-based dm
2214
	 * devices.  The type of this dm device may not have been decided yet.
2215 2216 2217 2218 2219 2220 2221
	 * The type is decided at the first table loading time.
	 * To prevent problematic device stacking, clear the queue flag
	 * for request stacking support until then.
	 *
	 * This queue is new, so no concurrency on the queue_flags.
	 */
	queue_flag_clear_unlocked(QUEUE_FLAG_STACKABLE, md->queue);
2222 2223 2224 2225 2226 2227 2228

	/*
	 * Initialize data that will only be used by a non-blk-mq DM queue
	 * - must do so here (in alloc_dev callchain) before queue is used
	 */
	md->queue->queuedata = md;
	md->queue->backing_dev_info.congested_data = md;
2229
}
2230

2231 2232
static void dm_init_old_md_queue(struct mapped_device *md)
{
2233
	md->use_blk_mq = false;
2234 2235 2236 2237 2238
	dm_init_md_queue(md);

	/*
	 * Initialize aspects of queue that aren't relevant for blk-mq
	 */
2239 2240 2241 2242
	md->queue->backing_dev_info.congested_fn = dm_any_congested;
	blk_queue_bounce_limit(md->queue, BLK_BOUNCE_ANY);
}

2243 2244 2245 2246 2247 2248
static void cleanup_mapped_device(struct mapped_device *md)
{
	if (md->wq)
		destroy_workqueue(md->wq);
	if (md->kworker_task)
		kthread_stop(md->kworker_task);
2249 2250
	mempool_destroy(md->io_pool);
	mempool_destroy(md->rq_pool);
2251 2252 2253
	if (md->bs)
		bioset_free(md->bs);

2254 2255
	cleanup_srcu_struct(&md->io_barrier);

2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272
	if (md->disk) {
		spin_lock(&_minor_lock);
		md->disk->private_data = NULL;
		spin_unlock(&_minor_lock);
		del_gendisk(md->disk);
		put_disk(md->disk);
	}

	if (md->queue)
		blk_cleanup_queue(md->queue);

	if (md->bdev) {
		bdput(md->bdev);
		md->bdev = NULL;
	}
}

L
Linus Torvalds 已提交
2273 2274 2275
/*
 * Allocate and initialise a blank device with a given minor.
 */
2276
static struct mapped_device *alloc_dev(int minor)
L
Linus Torvalds 已提交
2277 2278
{
	int r;
2279
	struct mapped_device *md = kzalloc(sizeof(*md), GFP_KERNEL);
2280
	void *old_md;
L
Linus Torvalds 已提交
2281 2282 2283 2284 2285 2286

	if (!md) {
		DMWARN("unable to allocate device, out of memory.");
		return NULL;
	}

2287
	if (!try_module_get(THIS_MODULE))
M
Milan Broz 已提交
2288
		goto bad_module_get;
2289

L
Linus Torvalds 已提交
2290
	/* get a minor number for the dev */
2291
	if (minor == DM_ANY_MINOR)
2292
		r = next_free_minor(&minor);
2293
	else
2294
		r = specific_minor(minor);
L
Linus Torvalds 已提交
2295
	if (r < 0)
M
Milan Broz 已提交
2296
		goto bad_minor;
L
Linus Torvalds 已提交
2297

M
Mikulas Patocka 已提交
2298 2299 2300 2301
	r = init_srcu_struct(&md->io_barrier);
	if (r < 0)
		goto bad_io_barrier;

2302
	md->use_blk_mq = use_blk_mq;
2303
	md->type = DM_TYPE_NONE;
2304
	mutex_init(&md->suspend_lock);
2305
	mutex_init(&md->type_lock);
2306
	mutex_init(&md->table_devices_lock);
2307
	spin_lock_init(&md->deferred_lock);
L
Linus Torvalds 已提交
2308
	atomic_set(&md->holders, 1);
2309
	atomic_set(&md->open_count, 0);
L
Linus Torvalds 已提交
2310
	atomic_set(&md->event_nr, 0);
M
Mike Anderson 已提交
2311 2312
	atomic_set(&md->uevent_seq, 0);
	INIT_LIST_HEAD(&md->uevent_list);
2313
	INIT_LIST_HEAD(&md->table_devices);
M
Mike Anderson 已提交
2314
	spin_lock_init(&md->uevent_lock);
L
Linus Torvalds 已提交
2315

2316
	md->queue = blk_alloc_queue(GFP_KERNEL);
L
Linus Torvalds 已提交
2317
	if (!md->queue)
2318
		goto bad;
L
Linus Torvalds 已提交
2319

2320
	dm_init_md_queue(md);
S
Stefan Bader 已提交
2321

L
Linus Torvalds 已提交
2322 2323
	md->disk = alloc_disk(1);
	if (!md->disk)
2324
		goto bad;
L
Linus Torvalds 已提交
2325

2326 2327
	atomic_set(&md->pending[0], 0);
	atomic_set(&md->pending[1], 0);
2328
	init_waitqueue_head(&md->wait);
2329
	INIT_WORK(&md->work, dm_wq_work);
2330
	init_waitqueue_head(&md->eventq);
2331
	init_completion(&md->kobj_holder.completion);
2332
	md->kworker_task = NULL;
2333

L
Linus Torvalds 已提交
2334 2335 2336 2337 2338 2339 2340
	md->disk->major = _major;
	md->disk->first_minor = minor;
	md->disk->fops = &dm_blk_dops;
	md->disk->queue = md->queue;
	md->disk->private_data = md;
	sprintf(md->disk->disk_name, "dm-%d", minor);
	add_disk(md->disk);
M
Mike Anderson 已提交
2341
	format_dev_t(md->name, MKDEV(_major, minor));
L
Linus Torvalds 已提交
2342

T
Tejun Heo 已提交
2343
	md->wq = alloc_workqueue("kdmflush", WQ_MEM_RECLAIM, 0);
2344
	if (!md->wq)
2345
		goto bad;
2346

M
Mikulas Patocka 已提交
2347 2348
	md->bdev = bdget_disk(md->disk, 0);
	if (!md->bdev)
2349
		goto bad;
M
Mikulas Patocka 已提交
2350

2351 2352 2353 2354
	bio_init(&md->flush_bio);
	md->flush_bio.bi_bdev = md->bdev;
	md->flush_bio.bi_rw = WRITE_FLUSH;

M
Mikulas Patocka 已提交
2355 2356
	dm_stats_init(&md->stats);

2357
	/* Populate the mapping, nobody knows we exist yet */
2358
	spin_lock(&_minor_lock);
2359
	old_md = idr_replace(&_minor_idr, md, minor);
2360
	spin_unlock(&_minor_lock);
2361 2362 2363

	BUG_ON(old_md != MINOR_ALLOCED);

L
Linus Torvalds 已提交
2364 2365
	return md;

2366 2367
bad:
	cleanup_mapped_device(md);
M
Mikulas Patocka 已提交
2368
bad_io_barrier:
L
Linus Torvalds 已提交
2369
	free_minor(minor);
M
Milan Broz 已提交
2370
bad_minor:
2371
	module_put(THIS_MODULE);
M
Milan Broz 已提交
2372
bad_module_get:
L
Linus Torvalds 已提交
2373 2374 2375 2376
	kfree(md);
	return NULL;
}

J
Jun'ichi Nomura 已提交
2377 2378
static void unlock_fs(struct mapped_device *md);

L
Linus Torvalds 已提交
2379 2380
static void free_dev(struct mapped_device *md)
{
2381
	int minor = MINOR(disk_devt(md->disk));
2382

M
Mikulas Patocka 已提交
2383
	unlock_fs(md);
2384

2385 2386 2387
	cleanup_mapped_device(md);
	if (md->use_blk_mq)
		blk_mq_free_tag_set(&md->tag_set);
2388

2389
	free_table_devices(&md->table_devices);
2390 2391 2392
	dm_stats_cleanup(&md->stats);
	free_minor(minor);

2393
	module_put(THIS_MODULE);
L
Linus Torvalds 已提交
2394 2395 2396
	kfree(md);
}

K
Kiyoshi Ueda 已提交
2397 2398
static void __bind_mempools(struct mapped_device *md, struct dm_table *t)
{
M
Mikulas Patocka 已提交
2399
	struct dm_md_mempools *p = dm_table_get_md_mempools(t);
K
Kiyoshi Ueda 已提交
2400

2401 2402 2403
	if (md->bs) {
		/* The md already has necessary mempools. */
		if (dm_table_get_type(t) == DM_TYPE_BIO_BASED) {
2404 2405 2406 2407 2408 2409 2410 2411
			/*
			 * Reload bioset because front_pad may have changed
			 * because a different table was loaded.
			 */
			bioset_free(md->bs);
			md->bs = p->bs;
			p->bs = NULL;
		}
2412 2413 2414 2415 2416 2417 2418 2419 2420
		/*
		 * There's no need to reload with request-based dm
		 * because the size of front_pad doesn't change.
		 * Note for future: If you are to reload bioset,
		 * prep-ed requests in the queue may refer
		 * to bio from the old bioset, so you must walk
		 * through the queue to unprep.
		 */
		goto out;
M
Mikulas Patocka 已提交
2421
	}
K
Kiyoshi Ueda 已提交
2422

2423 2424
	BUG_ON(!p || md->io_pool || md->rq_pool || md->bs);

K
Kiyoshi Ueda 已提交
2425 2426
	md->io_pool = p->io_pool;
	p->io_pool = NULL;
2427 2428
	md->rq_pool = p->rq_pool;
	p->rq_pool = NULL;
K
Kiyoshi Ueda 已提交
2429 2430
	md->bs = p->bs;
	p->bs = NULL;
2431

K
Kiyoshi Ueda 已提交
2432
out:
2433
	/* mempool bind completed, no longer need any mempools in the table */
K
Kiyoshi Ueda 已提交
2434 2435 2436
	dm_table_free_md_mempools(t);
}

L
Linus Torvalds 已提交
2437 2438 2439 2440 2441
/*
 * Bind a table to the device.
 */
static void event_callback(void *context)
{
M
Mike Anderson 已提交
2442 2443
	unsigned long flags;
	LIST_HEAD(uevents);
L
Linus Torvalds 已提交
2444 2445
	struct mapped_device *md = (struct mapped_device *) context;

M
Mike Anderson 已提交
2446 2447 2448 2449
	spin_lock_irqsave(&md->uevent_lock, flags);
	list_splice_init(&md->uevent_list, &uevents);
	spin_unlock_irqrestore(&md->uevent_lock, flags);

2450
	dm_send_uevents(&uevents, &disk_to_dev(md->disk)->kobj);
M
Mike Anderson 已提交
2451

L
Linus Torvalds 已提交
2452 2453 2454 2455
	atomic_inc(&md->event_nr);
	wake_up(&md->eventq);
}

2456 2457 2458
/*
 * Protected by md->suspend_lock obtained by dm_swap_table().
 */
2459
static void __set_size(struct mapped_device *md, sector_t size)
L
Linus Torvalds 已提交
2460
{
2461
	set_capacity(md->disk, size);
L
Linus Torvalds 已提交
2462

2463
	i_size_write(md->bdev->bd_inode, (loff_t)size << SECTOR_SHIFT);
L
Linus Torvalds 已提交
2464 2465
}

2466 2467 2468 2469 2470
/*
 * Returns old map, which caller must destroy.
 */
static struct dm_table *__bind(struct mapped_device *md, struct dm_table *t,
			       struct queue_limits *limits)
L
Linus Torvalds 已提交
2471
{
2472
	struct dm_table *old_map;
2473
	struct request_queue *q = md->queue;
L
Linus Torvalds 已提交
2474 2475 2476
	sector_t size;

	size = dm_table_get_size(t);
D
Darrick J. Wong 已提交
2477 2478 2479 2480

	/*
	 * Wipe any geometry if the size of the table changed.
	 */
M
Mikulas Patocka 已提交
2481
	if (size != dm_get_size(md))
D
Darrick J. Wong 已提交
2482 2483
		memset(&md->geometry, 0, sizeof(md->geometry));

M
Mikulas Patocka 已提交
2484
	__set_size(md, size);
2485

2486 2487
	dm_table_event_callback(t, event_callback, md);

K
Kiyoshi Ueda 已提交
2488 2489 2490 2491 2492 2493 2494
	/*
	 * The queue hasn't been stopped yet, if the old table type wasn't
	 * for request-based during suspension.  So stop it to prevent
	 * I/O mapping before resume.
	 * This must be done before setting the queue restrictions,
	 * because request-based dm may be run just after the setting.
	 */
2495
	if (dm_table_request_based(t))
K
Kiyoshi Ueda 已提交
2496 2497 2498 2499
		stop_queue(q);

	__bind_mempools(md, t);

2500
	old_map = rcu_dereference_protected(md->map, lockdep_is_held(&md->suspend_lock));
M
Mikulas Patocka 已提交
2501
	rcu_assign_pointer(md->map, t);
2502 2503
	md->immutable_target_type = dm_table_get_immutable_target_type(t);

2504
	dm_table_set_restrictions(t, q, limits);
2505 2506
	if (old_map)
		dm_sync_table(md);
L
Linus Torvalds 已提交
2507

2508
	return old_map;
L
Linus Torvalds 已提交
2509 2510
}

2511 2512 2513 2514
/*
 * Returns unbound table for the caller to free.
 */
static struct dm_table *__unbind(struct mapped_device *md)
L
Linus Torvalds 已提交
2515
{
2516
	struct dm_table *map = rcu_dereference_protected(md->map, 1);
L
Linus Torvalds 已提交
2517 2518

	if (!map)
2519
		return NULL;
L
Linus Torvalds 已提交
2520 2521

	dm_table_event_callback(map, NULL, NULL);
2522
	RCU_INIT_POINTER(md->map, NULL);
M
Mikulas Patocka 已提交
2523
	dm_sync_table(md);
2524 2525

	return map;
L
Linus Torvalds 已提交
2526 2527 2528 2529 2530
}

/*
 * Constructor for a new device.
 */
2531
int dm_create(int minor, struct mapped_device **result)
L
Linus Torvalds 已提交
2532 2533 2534
{
	struct mapped_device *md;

2535
	md = alloc_dev(minor);
L
Linus Torvalds 已提交
2536 2537 2538
	if (!md)
		return -ENXIO;

M
Milan Broz 已提交
2539 2540
	dm_sysfs_init(md);

L
Linus Torvalds 已提交
2541 2542 2543 2544
	*result = md;
	return 0;
}

2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560
/*
 * Functions to manage md->type.
 * All are required to hold md->type_lock.
 */
void dm_lock_md_type(struct mapped_device *md)
{
	mutex_lock(&md->type_lock);
}

void dm_unlock_md_type(struct mapped_device *md)
{
	mutex_unlock(&md->type_lock);
}

void dm_set_md_type(struct mapped_device *md, unsigned type)
{
2561
	BUG_ON(!mutex_is_locked(&md->type_lock));
2562 2563 2564 2565 2566
	md->type = type;
}

unsigned dm_get_md_type(struct mapped_device *md)
{
2567
	BUG_ON(!mutex_is_locked(&md->type_lock));
2568 2569 2570
	return md->type;
}

2571 2572 2573 2574 2575
struct target_type *dm_get_immutable_target_type(struct mapped_device *md)
{
	return md->immutable_target_type;
}

2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586
/*
 * The queue_limits are only valid as long as you have a reference
 * count on 'md'.
 */
struct queue_limits *dm_get_queue_limits(struct mapped_device *md)
{
	BUG_ON(!atomic_read(&md->holders));
	return &md->queue->limits;
}
EXPORT_SYMBOL_GPL(dm_get_queue_limits);

2587 2588 2589 2590 2591 2592 2593 2594
static void init_rq_based_worker_thread(struct mapped_device *md)
{
	/* Initialize the request-based DM worker thread */
	init_kthread_worker(&md->kworker);
	md->kworker_task = kthread_run(kthread_worker_fn, &md->kworker,
				       "kdmwork-%s", dm_device_name(md));
}

2595 2596 2597 2598 2599 2600 2601 2602 2603 2604
/*
 * Fully initialize a request-based queue (->elevator, ->request_fn, etc).
 */
static int dm_init_request_based_queue(struct mapped_device *md)
{
	struct request_queue *q = NULL;

	/* Fully initialize the queue */
	q = blk_init_allocated_queue(md->queue, dm_request_fn, NULL);
	if (!q)
2605
		return -EINVAL;
2606

2607 2608 2609
	/* disable dm_request_fn's merge heuristic by default */
	md->seq_rq_merge_deadline_usecs = 0;

2610
	md->queue = q;
2611
	dm_init_old_md_queue(md);
2612 2613 2614
	blk_queue_softirq_done(md->queue, dm_softirq_done);
	blk_queue_prep_rq(md->queue, dm_prep_fn);

2615
	init_rq_based_worker_thread(md);
2616

2617 2618
	elv_register_queue(md->queue);

2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 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 2667 2668 2669 2670 2671 2672 2673 2674
	return 0;
}

static int dm_mq_init_request(void *data, struct request *rq,
			      unsigned int hctx_idx, unsigned int request_idx,
			      unsigned int numa_node)
{
	struct mapped_device *md = data;
	struct dm_rq_target_io *tio = blk_mq_rq_to_pdu(rq);

	/*
	 * Must initialize md member of tio, otherwise it won't
	 * be available in dm_mq_queue_rq.
	 */
	tio->md = md;

	return 0;
}

static int dm_mq_queue_rq(struct blk_mq_hw_ctx *hctx,
			  const struct blk_mq_queue_data *bd)
{
	struct request *rq = bd->rq;
	struct dm_rq_target_io *tio = blk_mq_rq_to_pdu(rq);
	struct mapped_device *md = tio->md;
	int srcu_idx;
	struct dm_table *map = dm_get_live_table(md, &srcu_idx);
	struct dm_target *ti;
	sector_t pos;

	/* always use block 0 to find the target for flushes for now */
	pos = 0;
	if (!(rq->cmd_flags & REQ_FLUSH))
		pos = blk_rq_pos(rq);

	ti = dm_table_find_target(map, pos);
	if (!dm_target_is_valid(ti)) {
		dm_put_live_table(md, srcu_idx);
		DMERR_LIMIT("request attempted access beyond the end of device");
		/*
		 * Must perform setup, that rq_completed() requires,
		 * before returning BLK_MQ_RQ_QUEUE_ERROR
		 */
		dm_start_request(md, rq);
		return BLK_MQ_RQ_QUEUE_ERROR;
	}
	dm_put_live_table(md, srcu_idx);

	if (ti->type->busy && ti->type->busy(ti))
		return BLK_MQ_RQ_QUEUE_BUSY;

	dm_start_request(md, rq);

	/* Init tio using md established in .init_request */
	init_tio(tio, rq, md);

2675 2676 2677 2678
	/*
	 * Establish tio->ti before queuing work (map_tio_request)
	 * or making direct call to map_request().
	 */
2679
	tio->ti = ti;
2680 2681 2682 2683 2684

	/* Clone the request if underlying devices aren't blk-mq */
	if (dm_table_get_type(map) == DM_TYPE_REQUEST_BASED) {
		/* clone request is allocated at the end of the pdu */
		tio->clone = (void *)blk_mq_rq_to_pdu(rq) + sizeof(struct dm_rq_target_io);
2685
		(void) clone_rq(rq, md, tio, GFP_ATOMIC);
2686 2687 2688
		queue_kthread_work(&md->kworker, &tio->work);
	} else {
		/* Direct call is fine since .queue_rq allows allocations */
2689 2690
		if (map_request(tio, rq, md) == DM_MAPIO_REQUEUE) {
			/* Undo dm_start_request() before requeuing */
2691
			rq_end_stats(md, rq);
2692 2693 2694
			rq_completed(md, rq_data_dir(rq), false);
			return BLK_MQ_RQ_QUEUE_BUSY;
		}
2695
	}
2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708

	return BLK_MQ_RQ_QUEUE_OK;
}

static struct blk_mq_ops dm_mq_ops = {
	.queue_rq = dm_mq_queue_rq,
	.map_queue = blk_mq_map_queue,
	.complete = dm_softirq_done,
	.init_request = dm_mq_init_request,
};

static int dm_init_request_based_blk_mq_queue(struct mapped_device *md)
{
2709
	unsigned md_type = dm_get_md_type(md);
2710 2711 2712 2713 2714 2715 2716 2717 2718
	struct request_queue *q;
	int err;

	memset(&md->tag_set, 0, sizeof(md->tag_set));
	md->tag_set.ops = &dm_mq_ops;
	md->tag_set.queue_depth = BLKDEV_MAX_RQ;
	md->tag_set.numa_node = NUMA_NO_NODE;
	md->tag_set.flags = BLK_MQ_F_SHOULD_MERGE | BLK_MQ_F_SG_MERGE;
	md->tag_set.nr_hw_queues = 1;
2719 2720 2721 2722 2723
	if (md_type == DM_TYPE_REQUEST_BASED) {
		/* make the memory for non-blk-mq clone part of the pdu */
		md->tag_set.cmd_size = sizeof(struct dm_rq_target_io) + sizeof(struct request);
	} else
		md->tag_set.cmd_size = sizeof(struct dm_rq_target_io);
2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740
	md->tag_set.driver_data = md;

	err = blk_mq_alloc_tag_set(&md->tag_set);
	if (err)
		return err;

	q = blk_mq_init_allocated_queue(&md->tag_set, md->queue);
	if (IS_ERR(q)) {
		err = PTR_ERR(q);
		goto out_tag_set;
	}
	md->queue = q;
	dm_init_md_queue(md);

	/* backfill 'mq' sysfs registration normally done in blk_register_queue */
	blk_mq_register_disk(md->disk);

2741 2742
	if (md_type == DM_TYPE_REQUEST_BASED)
		init_rq_based_worker_thread(md);
2743 2744 2745 2746 2747 2748

	return 0;

out_tag_set:
	blk_mq_free_tag_set(&md->tag_set);
	return err;
2749 2750
}

2751 2752 2753 2754 2755 2756 2757 2758
static unsigned filter_md_type(unsigned type, struct mapped_device *md)
{
	if (type == DM_TYPE_BIO_BASED)
		return type;

	return !md->use_blk_mq ? DM_TYPE_REQUEST_BASED : DM_TYPE_MQ_REQUEST_BASED;
}

2759 2760 2761 2762 2763
/*
 * Setup the DM device's queue based on md's type
 */
int dm_setup_md_queue(struct mapped_device *md)
{
2764
	int r;
2765
	unsigned md_type = filter_md_type(dm_get_md_type(md), md);
2766 2767 2768 2769 2770

	switch (md_type) {
	case DM_TYPE_REQUEST_BASED:
		r = dm_init_request_based_queue(md);
		if (r) {
2771
			DMWARN("Cannot initialize queue for request-based mapped device");
2772
			return r;
2773
		}
2774 2775 2776 2777 2778 2779 2780 2781 2782 2783
		break;
	case DM_TYPE_MQ_REQUEST_BASED:
		r = dm_init_request_based_blk_mq_queue(md);
		if (r) {
			DMWARN("Cannot initialize queue for request-based blk-mq mapped device");
			return r;
		}
		break;
	case DM_TYPE_BIO_BASED:
		dm_init_old_md_queue(md);
2784
		blk_queue_make_request(md->queue, dm_make_request);
2785 2786 2787 2788 2789 2790
		/*
		 * DM handles splitting bios as needed.  Free the bio_split bioset
		 * since it won't be used (saves 1 process per bio-based DM device).
		 */
		bioset_free(md->queue->bio_split);
		md->queue->bio_split = NULL;
2791
		break;
2792 2793 2794 2795 2796
	}

	return 0;
}

2797
struct mapped_device *dm_get_md(dev_t dev)
L
Linus Torvalds 已提交
2798 2799 2800 2801 2802 2803 2804
{
	struct mapped_device *md;
	unsigned minor = MINOR(dev);

	if (MAJOR(dev) != _major || minor >= (1 << MINORBITS))
		return NULL;

2805
	spin_lock(&_minor_lock);
L
Linus Torvalds 已提交
2806 2807

	md = idr_find(&_minor_idr, minor);
2808 2809 2810 2811 2812 2813 2814 2815 2816
	if (md) {
		if ((md == MINOR_ALLOCED ||
		     (MINOR(disk_devt(dm_disk(md))) != minor) ||
		     dm_deleting_md(md) ||
		     test_bit(DMF_FREEING, &md->flags))) {
			md = NULL;
			goto out;
		}
		dm_get(md);
J
Jeff Mahoney 已提交
2817
	}
L
Linus Torvalds 已提交
2818

J
Jeff Mahoney 已提交
2819
out:
2820
	spin_unlock(&_minor_lock);
L
Linus Torvalds 已提交
2821

2822 2823
	return md;
}
A
Alasdair G Kergon 已提交
2824
EXPORT_SYMBOL_GPL(dm_get_md);
2825

A
Alasdair G Kergon 已提交
2826
void *dm_get_mdptr(struct mapped_device *md)
2827
{
A
Alasdair G Kergon 已提交
2828
	return md->interface_ptr;
L
Linus Torvalds 已提交
2829 2830 2831 2832 2833 2834 2835 2836 2837 2838
}

void dm_set_mdptr(struct mapped_device *md, void *ptr)
{
	md->interface_ptr = ptr;
}

void dm_get(struct mapped_device *md)
{
	atomic_inc(&md->holders);
2839
	BUG_ON(test_bit(DMF_FREEING, &md->flags));
L
Linus Torvalds 已提交
2840 2841
}

2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854
int dm_hold(struct mapped_device *md)
{
	spin_lock(&_minor_lock);
	if (test_bit(DMF_FREEING, &md->flags)) {
		spin_unlock(&_minor_lock);
		return -EBUSY;
	}
	dm_get(md);
	spin_unlock(&_minor_lock);
	return 0;
}
EXPORT_SYMBOL_GPL(dm_hold);

2855 2856 2857 2858 2859 2860
const char *dm_device_name(struct mapped_device *md)
{
	return md->name;
}
EXPORT_SYMBOL_GPL(dm_device_name);

2861
static void __dm_destroy(struct mapped_device *md, bool wait)
L
Linus Torvalds 已提交
2862
{
M
Mike Anderson 已提交
2863
	struct dm_table *map;
M
Mikulas Patocka 已提交
2864
	int srcu_idx;
L
Linus Torvalds 已提交
2865

2866
	might_sleep();
J
Jeff Mahoney 已提交
2867

2868
	spin_lock(&_minor_lock);
2869 2870 2871 2872
	idr_replace(&_minor_idr, MINOR_ALLOCED, MINOR(disk_devt(dm_disk(md))));
	set_bit(DMF_FREEING, &md->flags);
	spin_unlock(&_minor_lock);

2873
	if (dm_request_based(md) && md->kworker_task)
2874 2875
		flush_kthread_worker(&md->kworker);

2876 2877 2878 2879 2880
	/*
	 * Take suspend_lock so that presuspend and postsuspend methods
	 * do not race with internal suspend.
	 */
	mutex_lock(&md->suspend_lock);
2881
	map = dm_get_live_table(md, &srcu_idx);
2882 2883 2884
	if (!dm_suspended_md(md)) {
		dm_table_presuspend_targets(map);
		dm_table_postsuspend_targets(map);
L
Linus Torvalds 已提交
2885
	}
M
Mikulas Patocka 已提交
2886 2887
	/* dm_put_live_table must be before msleep, otherwise deadlock is possible */
	dm_put_live_table(md, srcu_idx);
2888
	mutex_unlock(&md->suspend_lock);
M
Mikulas Patocka 已提交
2889

2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920
	/*
	 * Rare, but there may be I/O requests still going to complete,
	 * for example.  Wait for all references to disappear.
	 * No one should increment the reference count of the mapped_device,
	 * after the mapped_device state becomes DMF_FREEING.
	 */
	if (wait)
		while (atomic_read(&md->holders))
			msleep(1);
	else if (atomic_read(&md->holders))
		DMWARN("%s: Forcibly removing mapped_device still in use! (%d users)",
		       dm_device_name(md), atomic_read(&md->holders));

	dm_sysfs_exit(md);
	dm_table_destroy(__unbind(md));
	free_dev(md);
}

void dm_destroy(struct mapped_device *md)
{
	__dm_destroy(md, true);
}

void dm_destroy_immediate(struct mapped_device *md)
{
	__dm_destroy(md, false);
}

void dm_put(struct mapped_device *md)
{
	atomic_dec(&md->holders);
L
Linus Torvalds 已提交
2921
}
E
Edward Goggin 已提交
2922
EXPORT_SYMBOL_GPL(dm_put);
L
Linus Torvalds 已提交
2923

2924
static int dm_wait_for_completion(struct mapped_device *md, int interruptible)
2925 2926
{
	int r = 0;
2927 2928 2929
	DECLARE_WAITQUEUE(wait, current);

	add_wait_queue(&md->wait, &wait);
2930 2931

	while (1) {
2932
		set_current_state(interruptible);
2933

2934
		if (!md_in_flight(md))
2935 2936
			break;

2937 2938
		if (interruptible == TASK_INTERRUPTIBLE &&
		    signal_pending(current)) {
2939 2940 2941 2942 2943 2944 2945 2946
			r = -EINTR;
			break;
		}

		io_schedule();
	}
	set_current_state(TASK_RUNNING);

2947 2948
	remove_wait_queue(&md->wait, &wait);

2949 2950 2951
	return r;
}

L
Linus Torvalds 已提交
2952 2953 2954
/*
 * Process the deferred bios
 */
2955
static void dm_wq_work(struct work_struct *work)
L
Linus Torvalds 已提交
2956
{
2957 2958
	struct mapped_device *md = container_of(work, struct mapped_device,
						work);
2959
	struct bio *c;
M
Mikulas Patocka 已提交
2960 2961
	int srcu_idx;
	struct dm_table *map;
L
Linus Torvalds 已提交
2962

M
Mikulas Patocka 已提交
2963
	map = dm_get_live_table(md, &srcu_idx);
2964

2965
	while (!test_bit(DMF_BLOCK_IO_FOR_SUSPEND, &md->flags)) {
A
Alasdair G Kergon 已提交
2966 2967 2968 2969
		spin_lock_irq(&md->deferred_lock);
		c = bio_list_pop(&md->deferred);
		spin_unlock_irq(&md->deferred_lock);

2970
		if (!c)
A
Alasdair G Kergon 已提交
2971
			break;
2972

K
Kiyoshi Ueda 已提交
2973 2974
		if (dm_request_based(md))
			generic_make_request(c);
2975
		else
M
Mikulas Patocka 已提交
2976
			__split_and_process_bio(md, map, c);
2977
	}
M
Milan Broz 已提交
2978

M
Mikulas Patocka 已提交
2979
	dm_put_live_table(md, srcu_idx);
L
Linus Torvalds 已提交
2980 2981
}

2982
static void dm_queue_flush(struct mapped_device *md)
2983
{
2984
	clear_bit(DMF_BLOCK_IO_FOR_SUSPEND, &md->flags);
2985
	smp_mb__after_atomic();
2986
	queue_work(md->wq, &md->work);
2987 2988
}

L
Linus Torvalds 已提交
2989
/*
2990
 * Swap in a new table, returning the old one for the caller to destroy.
L
Linus Torvalds 已提交
2991
 */
2992
struct dm_table *dm_swap_table(struct mapped_device *md, struct dm_table *table)
L
Linus Torvalds 已提交
2993
{
2994
	struct dm_table *live_map = NULL, *map = ERR_PTR(-EINVAL);
2995
	struct queue_limits limits;
2996
	int r;
L
Linus Torvalds 已提交
2997

2998
	mutex_lock(&md->suspend_lock);
L
Linus Torvalds 已提交
2999 3000

	/* device must be suspended */
3001
	if (!dm_suspended_md(md))
3002
		goto out;
L
Linus Torvalds 已提交
3003

3004 3005 3006 3007 3008 3009 3010
	/*
	 * If the new table has no data devices, retain the existing limits.
	 * This helps multipath with queue_if_no_path if all paths disappear,
	 * then new I/O is queued based on these limits, and then some paths
	 * reappear.
	 */
	if (dm_table_has_no_data_devices(table)) {
M
Mikulas Patocka 已提交
3011
		live_map = dm_get_live_table_fast(md);
3012 3013
		if (live_map)
			limits = md->queue->limits;
M
Mikulas Patocka 已提交
3014
		dm_put_live_table_fast(md);
3015 3016
	}

3017 3018 3019 3020 3021 3022
	if (!live_map) {
		r = dm_calculate_queue_limits(table, &limits);
		if (r) {
			map = ERR_PTR(r);
			goto out;
		}
3023
	}
3024

3025
	map = __bind(md, table, &limits);
L
Linus Torvalds 已提交
3026

3027
out:
3028
	mutex_unlock(&md->suspend_lock);
3029
	return map;
L
Linus Torvalds 已提交
3030 3031 3032 3033 3034 3035
}

/*
 * Functions to lock and unlock any filesystem running on the
 * device.
 */
3036
static int lock_fs(struct mapped_device *md)
L
Linus Torvalds 已提交
3037
{
3038
	int r;
L
Linus Torvalds 已提交
3039 3040

	WARN_ON(md->frozen_sb);
3041

3042
	md->frozen_sb = freeze_bdev(md->bdev);
3043
	if (IS_ERR(md->frozen_sb)) {
3044
		r = PTR_ERR(md->frozen_sb);
3045 3046
		md->frozen_sb = NULL;
		return r;
3047 3048
	}

3049 3050
	set_bit(DMF_FROZEN, &md->flags);

L
Linus Torvalds 已提交
3051 3052 3053
	return 0;
}

3054
static void unlock_fs(struct mapped_device *md)
L
Linus Torvalds 已提交
3055
{
3056 3057 3058
	if (!test_bit(DMF_FROZEN, &md->flags))
		return;

3059
	thaw_bdev(md->bdev, md->frozen_sb);
L
Linus Torvalds 已提交
3060
	md->frozen_sb = NULL;
3061
	clear_bit(DMF_FROZEN, &md->flags);
L
Linus Torvalds 已提交
3062 3063 3064
}

/*
3065 3066 3067
 * If __dm_suspend returns 0, the device is completely quiescent
 * now. There is no request-processing activity. All new requests
 * are being added to md->deferred list.
3068
 *
3069
 * Caller must hold md->suspend_lock
3070
 */
3071 3072
static int __dm_suspend(struct mapped_device *md, struct dm_table *map,
			unsigned suspend_flags, int interruptible)
L
Linus Torvalds 已提交
3073
{
3074 3075 3076
	bool do_lockfs = suspend_flags & DM_SUSPEND_LOCKFS_FLAG;
	bool noflush = suspend_flags & DM_SUSPEND_NOFLUSH_FLAG;
	int r;
L
Linus Torvalds 已提交
3077

3078 3079 3080 3081 3082 3083 3084
	/*
	 * DMF_NOFLUSH_SUSPENDING must be set before presuspend.
	 * This flag is cleared before dm_suspend returns.
	 */
	if (noflush)
		set_bit(DMF_NOFLUSH_SUSPENDING, &md->flags);

3085 3086 3087 3088
	/*
	 * This gets reverted if there's an error later and the targets
	 * provide the .presuspend_undo hook.
	 */
3089 3090
	dm_table_presuspend_targets(map);

M
Mikulas Patocka 已提交
3091
	/*
K
Kiyoshi Ueda 已提交
3092 3093 3094 3095
	 * Flush I/O to the device.
	 * Any I/O submitted after lock_fs() may not be flushed.
	 * noflush takes precedence over do_lockfs.
	 * (lock_fs() flushes I/Os and waits for them to complete.)
M
Mikulas Patocka 已提交
3096 3097 3098
	 */
	if (!noflush && do_lockfs) {
		r = lock_fs(md);
3099 3100
		if (r) {
			dm_table_presuspend_undo_targets(map);
3101
			return r;
3102
		}
3103
	}
L
Linus Torvalds 已提交
3104 3105

	/*
3106 3107 3108 3109 3110 3111 3112
	 * Here we must make sure that no processes are submitting requests
	 * to target drivers i.e. no one may be executing
	 * __split_and_process_bio. This is called from dm_request and
	 * dm_wq_work.
	 *
	 * To get all processes out of __split_and_process_bio in dm_request,
	 * we take the write lock. To prevent any process from reentering
3113 3114 3115
	 * __split_and_process_bio from dm_request and quiesce the thread
	 * (dm_wq_work), we set BMF_BLOCK_IO_FOR_SUSPEND and call
	 * flush_workqueue(md->wq).
L
Linus Torvalds 已提交
3116
	 */
3117
	set_bit(DMF_BLOCK_IO_FOR_SUSPEND, &md->flags);
3118 3119
	if (map)
		synchronize_srcu(&md->io_barrier);
L
Linus Torvalds 已提交
3120

3121
	/*
3122 3123
	 * Stop md->queue before flushing md->wq in case request-based
	 * dm defers requests to md->wq from md->queue.
3124
	 */
3125
	if (dm_request_based(md)) {
K
Kiyoshi Ueda 已提交
3126
		stop_queue(md->queue);
3127 3128
		if (md->kworker_task)
			flush_kthread_worker(&md->kworker);
3129
	}
3130

3131 3132
	flush_workqueue(md->wq);

L
Linus Torvalds 已提交
3133
	/*
3134 3135 3136
	 * At this point no more requests are entering target request routines.
	 * We call dm_wait_for_completion to wait for all existing requests
	 * to finish.
L
Linus Torvalds 已提交
3137
	 */
3138
	r = dm_wait_for_completion(md, interruptible);
L
Linus Torvalds 已提交
3139

3140
	if (noflush)
3141
		clear_bit(DMF_NOFLUSH_SUSPENDING, &md->flags);
3142 3143
	if (map)
		synchronize_srcu(&md->io_barrier);
3144

L
Linus Torvalds 已提交
3145
	/* were we interrupted ? */
3146
	if (r < 0) {
3147
		dm_queue_flush(md);
M
Milan Broz 已提交
3148

3149
		if (dm_request_based(md))
K
Kiyoshi Ueda 已提交
3150
			start_queue(md->queue);
3151

3152
		unlock_fs(md);
3153
		dm_table_presuspend_undo_targets(map);
3154
		/* pushback list is already flushed, so skip flush */
3155
	}
L
Linus Torvalds 已提交
3156

3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197
	return r;
}

/*
 * We need to be able to change a mapping table under a mounted
 * filesystem.  For example we might want to move some data in
 * the background.  Before the table can be swapped with
 * dm_bind_table, dm_suspend must be called to flush any in
 * flight bios and ensure that any further io gets deferred.
 */
/*
 * Suspend mechanism in request-based dm.
 *
 * 1. Flush all I/Os by lock_fs() if needed.
 * 2. Stop dispatching any I/O by stopping the request_queue.
 * 3. Wait for all in-flight I/Os to be completed or requeued.
 *
 * To abort suspend, start the request_queue.
 */
int dm_suspend(struct mapped_device *md, unsigned suspend_flags)
{
	struct dm_table *map = NULL;
	int r = 0;

retry:
	mutex_lock_nested(&md->suspend_lock, SINGLE_DEPTH_NESTING);

	if (dm_suspended_md(md)) {
		r = -EINVAL;
		goto out_unlock;
	}

	if (dm_suspended_internally_md(md)) {
		/* already internally suspended, wait for internal resume */
		mutex_unlock(&md->suspend_lock);
		r = wait_on_bit(&md->flags, DMF_SUSPENDED_INTERNALLY, TASK_INTERRUPTIBLE);
		if (r)
			return r;
		goto retry;
	}

3198
	map = rcu_dereference_protected(md->map, lockdep_is_held(&md->suspend_lock));
3199 3200 3201 3202

	r = __dm_suspend(md, map, suspend_flags, TASK_INTERRUPTIBLE);
	if (r)
		goto out_unlock;
3203

3204
	set_bit(DMF_SUSPENDED, &md->flags);
3205

3206 3207
	dm_table_postsuspend_targets(map);

3208
out_unlock:
3209
	mutex_unlock(&md->suspend_lock);
3210
	return r;
L
Linus Torvalds 已提交
3211 3212
}

3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235
static int __dm_resume(struct mapped_device *md, struct dm_table *map)
{
	if (map) {
		int r = dm_table_resume_targets(map);
		if (r)
			return r;
	}

	dm_queue_flush(md);

	/*
	 * Flushing deferred I/Os must be done after targets are resumed
	 * so that mapping of targets can work correctly.
	 * Request-based dm is queueing the deferred I/Os in its request_queue.
	 */
	if (dm_request_based(md))
		start_queue(md->queue);

	unlock_fs(md);

	return 0;
}

L
Linus Torvalds 已提交
3236 3237
int dm_resume(struct mapped_device *md)
{
3238 3239
	int r = -EINVAL;
	struct dm_table *map = NULL;
L
Linus Torvalds 已提交
3240

3241 3242 3243
retry:
	mutex_lock_nested(&md->suspend_lock, SINGLE_DEPTH_NESTING);

3244
	if (!dm_suspended_md(md))
3245 3246
		goto out;

3247 3248 3249 3250 3251 3252 3253 3254 3255
	if (dm_suspended_internally_md(md)) {
		/* already internally suspended, wait for internal resume */
		mutex_unlock(&md->suspend_lock);
		r = wait_on_bit(&md->flags, DMF_SUSPENDED_INTERNALLY, TASK_INTERRUPTIBLE);
		if (r)
			return r;
		goto retry;
	}

3256
	map = rcu_dereference_protected(md->map, lockdep_is_held(&md->suspend_lock));
3257
	if (!map || !dm_table_get_size(map))
3258
		goto out;
L
Linus Torvalds 已提交
3259

3260
	r = __dm_resume(md, map);
3261 3262
	if (r)
		goto out;
3263 3264 3265

	clear_bit(DMF_SUSPENDED, &md->flags);

3266 3267
	r = 0;
out:
3268
	mutex_unlock(&md->suspend_lock);
3269

3270
	return r;
L
Linus Torvalds 已提交
3271 3272
}

M
Mikulas Patocka 已提交
3273 3274 3275 3276 3277 3278
/*
 * Internal suspend/resume works like userspace-driven suspend. It waits
 * until all bios finish and prevents issuing new bios to the target drivers.
 * It may be used only from the kernel.
 */

3279
static void __dm_internal_suspend(struct mapped_device *md, unsigned suspend_flags)
M
Mikulas Patocka 已提交
3280
{
3281 3282
	struct dm_table *map = NULL;

3283
	if (md->internal_suspend_count++)
3284 3285 3286 3287 3288 3289 3290
		return; /* nested internal suspend */

	if (dm_suspended_md(md)) {
		set_bit(DMF_SUSPENDED_INTERNALLY, &md->flags);
		return; /* nest suspend */
	}

3291
	map = rcu_dereference_protected(md->map, lockdep_is_held(&md->suspend_lock));
3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307

	/*
	 * Using TASK_UNINTERRUPTIBLE because only NOFLUSH internal suspend is
	 * supported.  Properly supporting a TASK_INTERRUPTIBLE internal suspend
	 * would require changing .presuspend to return an error -- avoid this
	 * until there is a need for more elaborate variants of internal suspend.
	 */
	(void) __dm_suspend(md, map, suspend_flags, TASK_UNINTERRUPTIBLE);

	set_bit(DMF_SUSPENDED_INTERNALLY, &md->flags);

	dm_table_postsuspend_targets(map);
}

static void __dm_internal_resume(struct mapped_device *md)
{
3308 3309 3310
	BUG_ON(!md->internal_suspend_count);

	if (--md->internal_suspend_count)
3311 3312
		return; /* resume from nested internal suspend */

M
Mikulas Patocka 已提交
3313
	if (dm_suspended_md(md))
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 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352
		goto done; /* resume from nested suspend */

	/*
	 * NOTE: existing callers don't need to call dm_table_resume_targets
	 * (which may fail -- so best to avoid it for now by passing NULL map)
	 */
	(void) __dm_resume(md, NULL);

done:
	clear_bit(DMF_SUSPENDED_INTERNALLY, &md->flags);
	smp_mb__after_atomic();
	wake_up_bit(&md->flags, DMF_SUSPENDED_INTERNALLY);
}

void dm_internal_suspend_noflush(struct mapped_device *md)
{
	mutex_lock(&md->suspend_lock);
	__dm_internal_suspend(md, DM_SUSPEND_NOFLUSH_FLAG);
	mutex_unlock(&md->suspend_lock);
}
EXPORT_SYMBOL_GPL(dm_internal_suspend_noflush);

void dm_internal_resume(struct mapped_device *md)
{
	mutex_lock(&md->suspend_lock);
	__dm_internal_resume(md);
	mutex_unlock(&md->suspend_lock);
}
EXPORT_SYMBOL_GPL(dm_internal_resume);

/*
 * Fast variants of internal suspend/resume hold md->suspend_lock,
 * which prevents interaction with userspace-driven suspend.
 */

void dm_internal_suspend_fast(struct mapped_device *md)
{
	mutex_lock(&md->suspend_lock);
	if (dm_suspended_md(md) || dm_suspended_internally_md(md))
M
Mikulas Patocka 已提交
3353 3354 3355 3356 3357 3358 3359
		return;

	set_bit(DMF_BLOCK_IO_FOR_SUSPEND, &md->flags);
	synchronize_srcu(&md->io_barrier);
	flush_workqueue(md->wq);
	dm_wait_for_completion(md, TASK_UNINTERRUPTIBLE);
}
3360
EXPORT_SYMBOL_GPL(dm_internal_suspend_fast);
M
Mikulas Patocka 已提交
3361

3362
void dm_internal_resume_fast(struct mapped_device *md)
M
Mikulas Patocka 已提交
3363
{
3364
	if (dm_suspended_md(md) || dm_suspended_internally_md(md))
M
Mikulas Patocka 已提交
3365 3366 3367 3368 3369 3370 3371
		goto done;

	dm_queue_flush(md);

done:
	mutex_unlock(&md->suspend_lock);
}
3372
EXPORT_SYMBOL_GPL(dm_internal_resume_fast);
M
Mikulas Patocka 已提交
3373

L
Linus Torvalds 已提交
3374 3375 3376
/*-----------------------------------------------------------------
 * Event notification.
 *---------------------------------------------------------------*/
3377
int dm_kobject_uevent(struct mapped_device *md, enum kobject_action action,
M
Milan Broz 已提交
3378
		       unsigned cookie)
3379
{
M
Milan Broz 已提交
3380 3381 3382 3383
	char udev_cookie[DM_COOKIE_LENGTH];
	char *envp[] = { udev_cookie, NULL };

	if (!cookie)
3384
		return kobject_uevent(&disk_to_dev(md->disk)->kobj, action);
M
Milan Broz 已提交
3385 3386 3387
	else {
		snprintf(udev_cookie, DM_COOKIE_LENGTH, "%s=%u",
			 DM_COOKIE_ENV_VAR_NAME, cookie);
3388 3389
		return kobject_uevent_env(&disk_to_dev(md->disk)->kobj,
					  action, envp);
M
Milan Broz 已提交
3390
	}
3391 3392
}

M
Mike Anderson 已提交
3393 3394 3395 3396 3397
uint32_t dm_next_uevent_seq(struct mapped_device *md)
{
	return atomic_add_return(1, &md->uevent_seq);
}

L
Linus Torvalds 已提交
3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408
uint32_t dm_get_event_nr(struct mapped_device *md)
{
	return atomic_read(&md->event_nr);
}

int dm_wait_event(struct mapped_device *md, int event_nr)
{
	return wait_event_interruptible(md->eventq,
			(event_nr != atomic_read(&md->event_nr)));
}

M
Mike Anderson 已提交
3409 3410 3411 3412 3413 3414 3415 3416 3417
void dm_uevent_add(struct mapped_device *md, struct list_head *elist)
{
	unsigned long flags;

	spin_lock_irqsave(&md->uevent_lock, flags);
	list_add(elist, &md->uevent_list);
	spin_unlock_irqrestore(&md->uevent_lock, flags);
}

L
Linus Torvalds 已提交
3418 3419 3420 3421 3422 3423 3424 3425
/*
 * The gendisk is only valid as long as you have a reference
 * count on 'md'.
 */
struct gendisk *dm_disk(struct mapped_device *md)
{
	return md->disk;
}
3426
EXPORT_SYMBOL_GPL(dm_disk);
L
Linus Torvalds 已提交
3427

M
Milan Broz 已提交
3428 3429
struct kobject *dm_kobject(struct mapped_device *md)
{
3430
	return &md->kobj_holder.kobj;
M
Milan Broz 已提交
3431 3432 3433 3434 3435 3436
}

struct mapped_device *dm_get_from_kobject(struct kobject *kobj)
{
	struct mapped_device *md;

3437
	md = container_of(kobj, struct mapped_device, kobj_holder.kobj);
M
Milan Broz 已提交
3438

3439
	if (test_bit(DMF_FREEING, &md->flags) ||
M
Mike Anderson 已提交
3440
	    dm_deleting_md(md))
3441 3442
		return NULL;

M
Milan Broz 已提交
3443 3444 3445 3446
	dm_get(md);
	return md;
}

3447
int dm_suspended_md(struct mapped_device *md)
L
Linus Torvalds 已提交
3448 3449 3450 3451
{
	return test_bit(DMF_SUSPENDED, &md->flags);
}

3452 3453 3454 3455 3456
int dm_suspended_internally_md(struct mapped_device *md)
{
	return test_bit(DMF_SUSPENDED_INTERNALLY, &md->flags);
}

M
Mikulas Patocka 已提交
3457 3458 3459 3460 3461
int dm_test_deferred_remove_flag(struct mapped_device *md)
{
	return test_bit(DMF_DEFERRED_REMOVE, &md->flags);
}

3462 3463
int dm_suspended(struct dm_target *ti)
{
3464
	return dm_suspended_md(dm_table_get_md(ti->table));
3465 3466 3467
}
EXPORT_SYMBOL_GPL(dm_suspended);

3468 3469
int dm_noflush_suspending(struct dm_target *ti)
{
3470
	return __noflush_suspending(dm_table_get_md(ti->table));
3471 3472 3473
}
EXPORT_SYMBOL_GPL(dm_noflush_suspending);

3474 3475
struct dm_md_mempools *dm_alloc_md_mempools(struct mapped_device *md, unsigned type,
					    unsigned integrity, unsigned per_bio_data_size)
K
Kiyoshi Ueda 已提交
3476
{
3477 3478 3479
	struct dm_md_mempools *pools = kzalloc(sizeof(*pools), GFP_KERNEL);
	struct kmem_cache *cachep = NULL;
	unsigned int pool_size = 0;
J
Jun'ichi Nomura 已提交
3480
	unsigned int front_pad;
K
Kiyoshi Ueda 已提交
3481 3482

	if (!pools)
3483
		return NULL;
K
Kiyoshi Ueda 已提交
3484

3485
	type = filter_md_type(type, md);
3486

3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515
	switch (type) {
	case DM_TYPE_BIO_BASED:
		cachep = _io_cache;
		pool_size = dm_get_reserved_bio_based_ios();
		front_pad = roundup(per_bio_data_size, __alignof__(struct dm_target_io)) + offsetof(struct dm_target_io, clone);
		break;
	case DM_TYPE_REQUEST_BASED:
		cachep = _rq_tio_cache;
		pool_size = dm_get_reserved_rq_based_ios();
		pools->rq_pool = mempool_create_slab_pool(pool_size, _rq_cache);
		if (!pools->rq_pool)
			goto out;
		/* fall through to setup remaining rq-based pools */
	case DM_TYPE_MQ_REQUEST_BASED:
		if (!pool_size)
			pool_size = dm_get_reserved_rq_based_ios();
		front_pad = offsetof(struct dm_rq_clone_bio_info, clone);
		/* per_bio_data_size is not used. See __bind_mempools(). */
		WARN_ON(per_bio_data_size != 0);
		break;
	default:
		BUG();
	}

	if (cachep) {
		pools->io_pool = mempool_create_slab_pool(pool_size, cachep);
		if (!pools->io_pool)
			goto out;
	}
K
Kiyoshi Ueda 已提交
3516

J
Junichi Nomura 已提交
3517
	pools->bs = bioset_create_nobvec(pool_size, front_pad);
K
Kiyoshi Ueda 已提交
3518
	if (!pools->bs)
J
Jun'ichi Nomura 已提交
3519
		goto out;
K
Kiyoshi Ueda 已提交
3520

3521
	if (integrity && bioset_integrity_create(pools->bs, pool_size))
J
Jun'ichi Nomura 已提交
3522
		goto out;
3523

K
Kiyoshi Ueda 已提交
3524
	return pools;
3525 3526 3527

out:
	dm_free_md_mempools(pools);
3528

3529
	return NULL;
K
Kiyoshi Ueda 已提交
3530 3531 3532 3533 3534 3535 3536
}

void dm_free_md_mempools(struct dm_md_mempools *pools)
{
	if (!pools)
		return;

3537 3538
	mempool_destroy(pools->io_pool);
	mempool_destroy(pools->rq_pool);
3539

K
Kiyoshi Ueda 已提交
3540 3541 3542 3543 3544 3545
	if (pools->bs)
		bioset_free(pools->bs);

	kfree(pools);
}

3546
static int dm_pr_register(struct block_device *bdev, u64 old_key, u64 new_key,
3547
			  u32 flags)
3548 3549 3550 3551
{
	struct mapped_device *md = bdev->bd_disk->private_data;
	const struct pr_ops *ops;
	fmode_t mode;
3552
	int r;
3553

3554
	r = dm_grab_bdev_for_ioctl(md, &bdev, &mode);
3555 3556 3557 3558 3559 3560 3561 3562 3563
	if (r < 0)
		return r;

	ops = bdev->bd_disk->fops->pr_ops;
	if (ops && ops->pr_register)
		r = ops->pr_register(bdev, old_key, new_key, flags);
	else
		r = -EOPNOTSUPP;

3564
	bdput(bdev);
3565 3566 3567 3568
	return r;
}

static int dm_pr_reserve(struct block_device *bdev, u64 key, enum pr_type type,
3569
			 u32 flags)
3570 3571 3572 3573
{
	struct mapped_device *md = bdev->bd_disk->private_data;
	const struct pr_ops *ops;
	fmode_t mode;
3574
	int r;
3575

3576
	r = dm_grab_bdev_for_ioctl(md, &bdev, &mode);
3577 3578 3579 3580 3581 3582 3583 3584 3585
	if (r < 0)
		return r;

	ops = bdev->bd_disk->fops->pr_ops;
	if (ops && ops->pr_reserve)
		r = ops->pr_reserve(bdev, key, type, flags);
	else
		r = -EOPNOTSUPP;

3586
	bdput(bdev);
3587 3588 3589 3590 3591 3592 3593 3594
	return r;
}

static int dm_pr_release(struct block_device *bdev, u64 key, enum pr_type type)
{
	struct mapped_device *md = bdev->bd_disk->private_data;
	const struct pr_ops *ops;
	fmode_t mode;
3595
	int r;
3596

3597
	r = dm_grab_bdev_for_ioctl(md, &bdev, &mode);
3598 3599 3600 3601 3602 3603 3604 3605 3606
	if (r < 0)
		return r;

	ops = bdev->bd_disk->fops->pr_ops;
	if (ops && ops->pr_release)
		r = ops->pr_release(bdev, key, type);
	else
		r = -EOPNOTSUPP;

3607
	bdput(bdev);
3608 3609 3610 3611
	return r;
}

static int dm_pr_preempt(struct block_device *bdev, u64 old_key, u64 new_key,
3612
			 enum pr_type type, bool abort)
3613 3614 3615 3616
{
	struct mapped_device *md = bdev->bd_disk->private_data;
	const struct pr_ops *ops;
	fmode_t mode;
3617
	int r;
3618

3619
	r = dm_grab_bdev_for_ioctl(md, &bdev, &mode);
3620 3621 3622 3623 3624 3625 3626 3627 3628
	if (r < 0)
		return r;

	ops = bdev->bd_disk->fops->pr_ops;
	if (ops && ops->pr_preempt)
		r = ops->pr_preempt(bdev, old_key, new_key, type, abort);
	else
		r = -EOPNOTSUPP;

3629
	bdput(bdev);
3630 3631 3632 3633 3634 3635 3636 3637
	return r;
}

static int dm_pr_clear(struct block_device *bdev, u64 key)
{
	struct mapped_device *md = bdev->bd_disk->private_data;
	const struct pr_ops *ops;
	fmode_t mode;
3638
	int r;
3639

3640
	r = dm_grab_bdev_for_ioctl(md, &bdev, &mode);
3641 3642 3643 3644 3645 3646 3647 3648 3649
	if (r < 0)
		return r;

	ops = bdev->bd_disk->fops->pr_ops;
	if (ops && ops->pr_clear)
		r = ops->pr_clear(bdev, key);
	else
		r = -EOPNOTSUPP;

3650
	bdput(bdev);
3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661
	return r;
}

static const struct pr_ops dm_pr_ops = {
	.pr_register	= dm_pr_register,
	.pr_reserve	= dm_pr_reserve,
	.pr_release	= dm_pr_release,
	.pr_preempt	= dm_pr_preempt,
	.pr_clear	= dm_pr_clear,
};

3662
static const struct block_device_operations dm_blk_dops = {
L
Linus Torvalds 已提交
3663 3664
	.open = dm_blk_open,
	.release = dm_blk_close,
3665
	.ioctl = dm_blk_ioctl,
D
Darrick J. Wong 已提交
3666
	.getgeo = dm_blk_getgeo,
3667
	.pr_ops = &dm_pr_ops,
L
Linus Torvalds 已提交
3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678
	.owner = THIS_MODULE
};

/*
 * module hooks
 */
module_init(dm_init);
module_exit(dm_exit);

module_param(major, uint, 0);
MODULE_PARM_DESC(major, "The major number of the device mapper");
3679

3680 3681 3682
module_param(reserved_bio_based_ios, uint, S_IRUGO | S_IWUSR);
MODULE_PARM_DESC(reserved_bio_based_ios, "Reserved IOs in bio-based mempools");

3683 3684 3685
module_param(reserved_rq_based_ios, uint, S_IRUGO | S_IWUSR);
MODULE_PARM_DESC(reserved_rq_based_ios, "Reserved IOs in request-based mempools");

3686 3687 3688
module_param(use_blk_mq, bool, S_IRUGO | S_IWUSR);
MODULE_PARM_DESC(use_blk_mq, "Use block multiqueue for request-based DM devices");

L
Linus Torvalds 已提交
3689 3690 3691
MODULE_DESCRIPTION(DM_NAME " driver");
MODULE_AUTHOR("Joe Thornber <dm-devel@redhat.com>");
MODULE_LICENSE("GPL");