dm-mpath.c 41.0 KB
Newer Older
L
Linus Torvalds 已提交
1 2 3 4 5 6 7
/*
 * Copyright (C) 2003 Sistina Software Limited.
 * Copyright (C) 2004-2005 Red Hat, Inc. All rights reserved.
 *
 * This file is released under the GPL.
 */

8 9
#include <linux/device-mapper.h>

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

14
#include <linux/blkdev.h>
L
Linus Torvalds 已提交
15 16 17 18 19 20 21 22
#include <linux/ctype.h>
#include <linux/init.h>
#include <linux/mempool.h>
#include <linux/module.h>
#include <linux/pagemap.h>
#include <linux/slab.h>
#include <linux/time.h>
#include <linux/workqueue.h>
23
#include <linux/delay.h>
24
#include <scsi/scsi_dh.h>
A
Arun Sharma 已提交
25
#include <linux/atomic.h>
26
#include <linux/blk-mq.h>
L
Linus Torvalds 已提交
27

28
#define DM_MSG_PREFIX "multipath"
29 30
#define DM_PG_INIT_DELAY_MSECS 2000
#define DM_PG_INIT_DELAY_DEFAULT ((unsigned) -1)
L
Linus Torvalds 已提交
31 32 33 34 35 36 37 38

/* Path properties */
struct pgpath {
	struct list_head list;

	struct priority_group *pg;	/* Owning PG */
	unsigned fail_count;		/* Cumulative failure count */

39
	struct dm_path path;
40
	struct delayed_work activate_path;
41 42

	bool is_active:1;		/* Path status */
L
Linus Torvalds 已提交
43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59
};

#define path_to_pgpath(__pgp) container_of((__pgp), struct pgpath, path)

/*
 * Paths are grouped into Priority Groups and numbered from 1 upwards.
 * Each has a path selector which controls which path gets used.
 */
struct priority_group {
	struct list_head list;

	struct multipath *m;		/* Owning multipath instance */
	struct path_selector ps;

	unsigned pg_num;		/* Reference number */
	unsigned nr_pgpaths;		/* Number of paths in PG */
	struct list_head pgpaths;
60 61

	bool bypassed:1;		/* Temporarily bypass this PG? */
L
Linus Torvalds 已提交
62 63 64 65 66 67 68
};

/* Multipath context */
struct multipath {
	struct list_head list;
	struct dm_target *ti;

69
	const char *hw_handler_name;
70
	char *hw_handler_params;
71

72 73
	spinlock_t lock;

L
Linus Torvalds 已提交
74 75
	unsigned nr_priority_groups;
	struct list_head priority_groups;
76 77 78

	wait_queue_head_t pg_init_wait;	/* Wait for pg_init completion */

79
	unsigned pg_init_in_progress;	/* Only one pg_init allowed at once */
L
Linus Torvalds 已提交
80 81 82 83 84 85

	unsigned nr_valid_paths;	/* Total number of usable paths */
	struct pgpath *current_pgpath;
	struct priority_group *current_pg;
	struct priority_group *next_pg;	/* Switch to this PG if set */

86 87 88 89 90 91 92
	bool queue_io:1;		/* Must we queue all I/O? */
	bool queue_if_no_path:1;	/* Queue I/O if last path fails? */
	bool saved_queue_if_no_path:1;	/* Saved state during suspension */
	bool retain_attached_hw_handler:1; /* If there's already a hw_handler present, don't change it. */
	bool pg_init_disabled:1;	/* pg_init is not currently allowed */
	bool pg_init_required:1;	/* pg_init needs calling? */
	bool pg_init_delay_retry:1;	/* Delay pg_init retry? */
93

D
Dave Wysochanski 已提交
94 95
	unsigned pg_init_retries;	/* Number of times to retry pg_init */
	unsigned pg_init_count;		/* Number of times pg_init called */
96
	unsigned pg_init_delay_msecs;	/* Number of msecs before pg_init retry */
L
Linus Torvalds 已提交
97 98 99 100

	struct work_struct trigger_event;

	/*
A
Alasdair G Kergon 已提交
101
	 * We must use a mempool of dm_mpath_io structs so that we
L
Linus Torvalds 已提交
102 103 104
	 * can resubmit bios on error.
	 */
	mempool_t *mpio_pool;
105 106

	struct mutex work_mutex;
L
Linus Torvalds 已提交
107 108 109 110 111
};

/*
 * Context information attached to each bio we process.
 */
A
Alasdair G Kergon 已提交
112
struct dm_mpath_io {
L
Linus Torvalds 已提交
113
	struct pgpath *pgpath;
114
	size_t nr_bytes;
L
Linus Torvalds 已提交
115 116 117 118
};

typedef int (*action_fn) (struct pgpath *pgpath);

119
static struct kmem_cache *_mpio_cache;
L
Linus Torvalds 已提交
120

121
static struct workqueue_struct *kmultipathd, *kmpath_handlerd;
D
David Howells 已提交
122
static void trigger_event(struct work_struct *work);
123
static void activate_path(struct work_struct *work);
L
Linus Torvalds 已提交
124 125 126 127 128 129 130 131


/*-----------------------------------------------
 * Allocation routines
 *-----------------------------------------------*/

static struct pgpath *alloc_pgpath(void)
{
M
Micha³ Miros³aw 已提交
132
	struct pgpath *pgpath = kzalloc(sizeof(*pgpath), GFP_KERNEL);
L
Linus Torvalds 已提交
133

134
	if (pgpath) {
135
		pgpath->is_active = true;
136
		INIT_DELAYED_WORK(&pgpath->activate_path, activate_path);
137
	}
L
Linus Torvalds 已提交
138 139 140 141

	return pgpath;
}

A
Alasdair G Kergon 已提交
142
static void free_pgpath(struct pgpath *pgpath)
L
Linus Torvalds 已提交
143 144 145 146 147 148 149 150
{
	kfree(pgpath);
}

static struct priority_group *alloc_priority_group(void)
{
	struct priority_group *pg;

M
Micha³ Miros³aw 已提交
151
	pg = kzalloc(sizeof(*pg), GFP_KERNEL);
L
Linus Torvalds 已提交
152

M
Micha³ Miros³aw 已提交
153 154
	if (pg)
		INIT_LIST_HEAD(&pg->pgpaths);
L
Linus Torvalds 已提交
155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183

	return pg;
}

static void free_pgpaths(struct list_head *pgpaths, struct dm_target *ti)
{
	struct pgpath *pgpath, *tmp;

	list_for_each_entry_safe(pgpath, tmp, pgpaths, list) {
		list_del(&pgpath->list);
		dm_put_device(ti, pgpath->path.dev);
		free_pgpath(pgpath);
	}
}

static void free_priority_group(struct priority_group *pg,
				struct dm_target *ti)
{
	struct path_selector *ps = &pg->ps;

	if (ps->type) {
		ps->type->destroy(ps);
		dm_put_path_selector(ps->type);
	}

	free_pgpaths(&pg->pgpaths, ti);
	kfree(pg);
}

184
static struct multipath *alloc_multipath(struct dm_target *ti, bool use_blk_mq)
L
Linus Torvalds 已提交
185 186 187
{
	struct multipath *m;

M
Micha³ Miros³aw 已提交
188
	m = kzalloc(sizeof(*m), GFP_KERNEL);
L
Linus Torvalds 已提交
189 190 191
	if (m) {
		INIT_LIST_HEAD(&m->priority_groups);
		spin_lock_init(&m->lock);
192
		m->queue_io = true;
193
		m->pg_init_delay_msecs = DM_PG_INIT_DELAY_DEFAULT;
D
David Howells 已提交
194
		INIT_WORK(&m->trigger_event, trigger_event);
195
		init_waitqueue_head(&m->pg_init_wait);
196
		mutex_init(&m->work_mutex);
197 198 199 200 201 202 203 204 205 206

		m->mpio_pool = NULL;
		if (!use_blk_mq) {
			unsigned min_ios = dm_get_reserved_rq_based_ios();

			m->mpio_pool = mempool_create_slab_pool(min_ios, _mpio_cache);
			if (!m->mpio_pool) {
				kfree(m);
				return NULL;
			}
L
Linus Torvalds 已提交
207
		}
208

M
Micha³ Miros³aw 已提交
209 210
		m->ti = ti;
		ti->private = m;
L
Linus Torvalds 已提交
211 212 213 214 215 216 217 218 219 220 221 222 223 224
	}

	return m;
}

static void free_multipath(struct multipath *m)
{
	struct priority_group *pg, *tmp;

	list_for_each_entry_safe(pg, tmp, &m->priority_groups, list) {
		list_del(&pg->list);
		free_priority_group(pg, m->ti);
	}

225
	kfree(m->hw_handler_name);
226
	kfree(m->hw_handler_params);
L
Linus Torvalds 已提交
227 228 229 230
	mempool_destroy(m->mpio_pool);
	kfree(m);
}

231 232 233 234 235 236
static struct dm_mpath_io *get_mpio(union map_info *info)
{
	return info->ptr;
}

static struct dm_mpath_io *set_mpio(struct multipath *m, union map_info *info)
237 238 239
{
	struct dm_mpath_io *mpio;

240 241
	if (!m->mpio_pool) {
		/* Use blk-mq pdu memory requested via per_io_data_size */
242
		mpio = get_mpio(info);
243 244 245 246
		memset(mpio, 0, sizeof(*mpio));
		return mpio;
	}

247 248
	mpio = mempool_alloc(m->mpio_pool, GFP_ATOMIC);
	if (!mpio)
249
		return NULL;
250 251 252 253

	memset(mpio, 0, sizeof(*mpio));
	info->ptr = mpio;

254
	return mpio;
255 256
}

257
static void clear_request_fn_mpio(struct multipath *m, union map_info *info)
258
{
259
	/* Only needed for non blk-mq (.request_fn) multipath */
260 261
	if (m->mpio_pool) {
		struct dm_mpath_io *mpio = info->ptr;
262

263 264 265
		info->ptr = NULL;
		mempool_free(mpio, m->mpio_pool);
	}
266
}
L
Linus Torvalds 已提交
267 268 269 270 271

/*-----------------------------------------------
 * Path selection
 *-----------------------------------------------*/

272
static int __pg_init_all_paths(struct multipath *m)
K
Kiyoshi Ueda 已提交
273 274
{
	struct pgpath *pgpath;
275
	unsigned long pg_init_delay = 0;
K
Kiyoshi Ueda 已提交
276

277
	if (m->pg_init_in_progress || m->pg_init_disabled)
278
		return 0;
279

K
Kiyoshi Ueda 已提交
280
	m->pg_init_count++;
281
	m->pg_init_required = false;
282 283 284 285 286

	/* Check here to reset pg_init_required */
	if (!m->current_pg)
		return 0;

287 288 289
	if (m->pg_init_delay_retry)
		pg_init_delay = msecs_to_jiffies(m->pg_init_delay_msecs != DM_PG_INIT_DELAY_DEFAULT ?
						 m->pg_init_delay_msecs : DM_PG_INIT_DELAY_MSECS);
K
Kiyoshi Ueda 已提交
290 291 292 293
	list_for_each_entry(pgpath, &m->current_pg->pgpaths, list) {
		/* Skip failed paths */
		if (!pgpath->is_active)
			continue;
294 295
		if (queue_delayed_work(kmpath_handlerd, &pgpath->activate_path,
				       pg_init_delay))
K
Kiyoshi Ueda 已提交
296 297
			m->pg_init_in_progress++;
	}
298
	return m->pg_init_in_progress;
K
Kiyoshi Ueda 已提交
299 300
}

L
Linus Torvalds 已提交
301 302 303 304 305
static void __switch_pg(struct multipath *m, struct pgpath *pgpath)
{
	m->current_pg = pgpath->pg;

	/* Must we initialise the PG first, and queue I/O till it's ready? */
306
	if (m->hw_handler_name) {
307 308
		m->pg_init_required = true;
		m->queue_io = true;
L
Linus Torvalds 已提交
309
	} else {
310 311
		m->pg_init_required = false;
		m->queue_io = false;
L
Linus Torvalds 已提交
312
	}
D
Dave Wysochanski 已提交
313 314

	m->pg_init_count = 0;
L
Linus Torvalds 已提交
315 316
}

317 318
static int __choose_path_in_pg(struct multipath *m, struct priority_group *pg,
			       size_t nr_bytes)
L
Linus Torvalds 已提交
319
{
320
	struct dm_path *path;
L
Linus Torvalds 已提交
321

322
	path = pg->ps.type->select_path(&pg->ps, nr_bytes);
L
Linus Torvalds 已提交
323 324 325 326 327 328 329 330 331 332 333
	if (!path)
		return -ENXIO;

	m->current_pgpath = path_to_pgpath(path);

	if (m->current_pg != pg)
		__switch_pg(m, m->current_pgpath);

	return 0;
}

334
static void __choose_pgpath(struct multipath *m, size_t nr_bytes)
L
Linus Torvalds 已提交
335 336
{
	struct priority_group *pg;
337
	bool bypassed = true;
L
Linus Torvalds 已提交
338

339
	if (!m->nr_valid_paths) {
340
		m->queue_io = false;
L
Linus Torvalds 已提交
341
		goto failed;
342
	}
L
Linus Torvalds 已提交
343 344 345 346 347

	/* Were we instructed to switch PG? */
	if (m->next_pg) {
		pg = m->next_pg;
		m->next_pg = NULL;
348
		if (!__choose_path_in_pg(m, pg, nr_bytes))
L
Linus Torvalds 已提交
349 350 351 352
			return;
	}

	/* Don't change PG until it has no remaining paths */
353
	if (m->current_pg && !__choose_path_in_pg(m, m->current_pg, nr_bytes))
L
Linus Torvalds 已提交
354 355 356 357 358
		return;

	/*
	 * Loop through priority groups until we find a valid path.
	 * First time we skip PGs marked 'bypassed'.
359 360
	 * Second time we only try the ones we skipped, but set
	 * pg_init_delay_retry so we do not hammer controllers.
L
Linus Torvalds 已提交
361 362 363 364 365
	 */
	do {
		list_for_each_entry(pg, &m->priority_groups, list) {
			if (pg->bypassed == bypassed)
				continue;
366 367
			if (!__choose_path_in_pg(m, pg, nr_bytes)) {
				if (!bypassed)
368
					m->pg_init_delay_retry = true;
L
Linus Torvalds 已提交
369
				return;
370
			}
L
Linus Torvalds 已提交
371 372 373 374 375 376 377 378
		}
	} while (bypassed--);

failed:
	m->current_pgpath = NULL;
	m->current_pg = NULL;
}

379 380 381 382 383 384 385 386 387 388 389 390 391
/*
 * Check whether bios must be queued in the device-mapper core rather
 * than here in the target.
 *
 * m->lock must be held on entry.
 *
 * If m->queue_if_no_path and m->saved_queue_if_no_path hold the
 * same value then we are not between multipath_presuspend()
 * and multipath_resume() calls and we have no need to check
 * for the DMF_NOFLUSH_SUSPENDING flag.
 */
static int __must_push_back(struct multipath *m)
{
392 393 394
	return (m->queue_if_no_path ||
		(m->queue_if_no_path != m->saved_queue_if_no_path &&
		 dm_noflush_suspending(m->ti)));
395 396
}

H
Hannes Reinecke 已提交
397 398 399
/*
 * Map cloned requests
 */
400 401 402
static int __multipath_map(struct dm_target *ti, struct request *clone,
			   union map_info *map_context,
			   struct request *rq, struct request **__clone)
L
Linus Torvalds 已提交
403
{
404
	struct multipath *m = ti->private;
405
	int r = DM_MAPIO_REQUEUE;
406
	size_t nr_bytes = clone ? blk_rq_bytes(clone) : blk_rq_bytes(rq);
L
Linus Torvalds 已提交
407
	struct pgpath *pgpath;
408
	struct block_device *bdev;
409
	struct dm_mpath_io *mpio;
L
Linus Torvalds 已提交
410

411
	spin_lock_irq(&m->lock);
L
Linus Torvalds 已提交
412 413

	/* Do we need to select a new pgpath? */
414
	if (!m->current_pgpath || !m->queue_io)
415
		__choose_pgpath(m, nr_bytes);
L
Linus Torvalds 已提交
416 417 418

	pgpath = m->current_pgpath;

419 420 421 422
	if (!pgpath) {
		if (!__must_push_back(m))
			r = -EIO;	/* Failed */
		goto out_unlock;
423
	} else if (m->queue_io || m->pg_init_required) {
424
		__pg_init_all_paths(m);
425 426
		goto out_unlock;
	}
427

428 429
	mpio = set_mpio(m, map_context);
	if (!mpio)
430 431 432
		/* ENOMEM, requeue */
		goto out_unlock;

433 434 435
	mpio->pgpath = pgpath;
	mpio->nr_bytes = nr_bytes;

436
	bdev = pgpath->path.dev->bdev;
437 438 439

	spin_unlock_irq(&m->lock);

440
	if (clone) {
441 442 443 444
		/*
		 * Old request-based interface: allocated clone is passed in.
		 * Used by: .request_fn stacked on .request_fn path(s).
		 */
445 446 447 448
		clone->q = bdev_get_queue(bdev);
		clone->rq_disk = bdev->bd_disk;
		clone->cmd_flags |= REQ_FAILFAST_TRANSPORT;
	} else {
449 450 451 452 453
		/*
		 * blk-mq request-based interface; used by both:
		 * .request_fn stacked on blk-mq path(s) and
		 * blk-mq stacked on blk-mq path(s).
		 */
454 455
		*__clone = blk_mq_alloc_request(bdev_get_queue(bdev),
						rq_data_dir(rq), BLK_MQ_REQ_NOWAIT);
456
		if (IS_ERR(*__clone)) {
457
			/* ENOMEM, requeue */
458
			clear_request_fn_mpio(m, map_context);
459
			return r;
460
		}
461 462 463 464 465
		(*__clone)->bio = (*__clone)->biotail = NULL;
		(*__clone)->rq_disk = bdev->bd_disk;
		(*__clone)->cmd_flags |= REQ_FAILFAST_TRANSPORT;
	}

466 467 468 469
	if (pgpath->pg->ps.type->start_io)
		pgpath->pg->ps.type->start_io(&pgpath->pg->ps,
					      &pgpath->path,
					      nr_bytes);
470
	return DM_MAPIO_REMAPPED;
L
Linus Torvalds 已提交
471

472
out_unlock:
473
	spin_unlock_irq(&m->lock);
L
Linus Torvalds 已提交
474 475 476 477

	return r;
}

478 479 480 481 482 483 484 485 486 487 488 489 490 491 492
static int multipath_map(struct dm_target *ti, struct request *clone,
			 union map_info *map_context)
{
	return __multipath_map(ti, clone, map_context, NULL, NULL);
}

static int multipath_clone_and_map(struct dm_target *ti, struct request *rq,
				   union map_info *map_context,
				   struct request **clone)
{
	return __multipath_map(ti, NULL, map_context, rq, clone);
}

static void multipath_release_clone(struct request *clone)
{
493
	blk_mq_free_request(clone);
494 495
}

L
Linus Torvalds 已提交
496 497 498
/*
 * If we run out of usable paths, should we queue I/O or error it?
 */
499 500
static int queue_if_no_path(struct multipath *m, bool queue_if_no_path,
			    bool save_old_value)
L
Linus Torvalds 已提交
501 502 503 504 505
{
	unsigned long flags;

	spin_lock_irqsave(&m->lock, flags);

506 507 508 509
	if (save_old_value)
		m->saved_queue_if_no_path = m->queue_if_no_path;
	else
		m->saved_queue_if_no_path = queue_if_no_path;
L
Linus Torvalds 已提交
510 511 512
	m->queue_if_no_path = queue_if_no_path;
	spin_unlock_irqrestore(&m->lock, flags);

513 514 515
	if (!queue_if_no_path)
		dm_table_run_md_queue_async(m->ti->table);

L
Linus Torvalds 已提交
516 517 518 519 520 521 522
	return 0;
}

/*
 * An event is triggered whenever a path is taken out of use.
 * Includes path failure and PG bypass.
 */
D
David Howells 已提交
523
static void trigger_event(struct work_struct *work)
L
Linus Torvalds 已提交
524
{
D
David Howells 已提交
525 526
	struct multipath *m =
		container_of(work, struct multipath, trigger_event);
L
Linus Torvalds 已提交
527 528 529 530 531 532 533 534 535 536 537 538 539 540

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

/*-----------------------------------------------------------------
 * Constructor/argument parsing:
 * <#multipath feature args> [<arg>]*
 * <#hw_handler args> [hw_handler [<arg>]*]
 * <#priority groups>
 * <initial priority group>
 *     [<selector> <#selector args> [<arg>]*
 *      <#paths> <#per-path selector args>
 *         [<path> [<arg>]* ]+ ]+
 *---------------------------------------------------------------*/
541
static int parse_path_selector(struct dm_arg_set *as, struct priority_group *pg,
L
Linus Torvalds 已提交
542 543 544 545 546 547
			       struct dm_target *ti)
{
	int r;
	struct path_selector_type *pst;
	unsigned ps_argc;

548
	static struct dm_arg _args[] = {
549
		{0, 1024, "invalid number of path selector args"},
L
Linus Torvalds 已提交
550 551
	};

552
	pst = dm_get_path_selector(dm_shift_arg(as));
L
Linus Torvalds 已提交
553
	if (!pst) {
554
		ti->error = "unknown path selector type";
L
Linus Torvalds 已提交
555 556 557
		return -EINVAL;
	}

558
	r = dm_read_arg_group(_args, as, &ps_argc, &ti->error);
559 560
	if (r) {
		dm_put_path_selector(pst);
L
Linus Torvalds 已提交
561
		return -EINVAL;
562
	}
L
Linus Torvalds 已提交
563 564 565 566

	r = pst->create(&pg->ps, ps_argc, as->argv);
	if (r) {
		dm_put_path_selector(pst);
567
		ti->error = "path selector constructor failed";
L
Linus Torvalds 已提交
568 569 570 571
		return r;
	}

	pg->ps.type = pst;
572
	dm_consume_args(as, ps_argc);
L
Linus Torvalds 已提交
573 574 575 576

	return 0;
}

577
static struct pgpath *parse_path(struct dm_arg_set *as, struct path_selector *ps,
L
Linus Torvalds 已提交
578 579 580 581
			       struct dm_target *ti)
{
	int r;
	struct pgpath *p;
582
	struct multipath *m = ti->private;
583 584
	struct request_queue *q = NULL;
	const char *attached_handler_name;
L
Linus Torvalds 已提交
585 586 587

	/* we need at least a path arg */
	if (as->argc < 1) {
588
		ti->error = "no device given";
589
		return ERR_PTR(-EINVAL);
L
Linus Torvalds 已提交
590 591 592 593
	}

	p = alloc_pgpath();
	if (!p)
594
		return ERR_PTR(-ENOMEM);
L
Linus Torvalds 已提交
595

596
	r = dm_get_device(ti, dm_shift_arg(as), dm_table_get_mode(ti->table),
597
			  &p->path.dev);
L
Linus Torvalds 已提交
598
	if (r) {
599
		ti->error = "error getting device";
L
Linus Torvalds 已提交
600 601 602
		goto bad;
	}

603 604 605 606
	if (m->retain_attached_hw_handler || m->hw_handler_name)
		q = bdev_get_queue(p->path.dev->bdev);

	if (m->retain_attached_hw_handler) {
607
retain:
608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624
		attached_handler_name = scsi_dh_attached_handler_name(q, GFP_KERNEL);
		if (attached_handler_name) {
			/*
			 * Reset hw_handler_name to match the attached handler
			 * and clear any hw_handler_params associated with the
			 * ignored handler.
			 *
			 * NB. This modifies the table line to show the actual
			 * handler instead of the original table passed in.
			 */
			kfree(m->hw_handler_name);
			m->hw_handler_name = attached_handler_name;

			kfree(m->hw_handler_params);
			m->hw_handler_params = NULL;
		}
	}
625

626
	if (m->hw_handler_name) {
627 628
		r = scsi_dh_attach(q, m->hw_handler_name);
		if (r == -EBUSY) {
629
			char b[BDEVNAME_SIZE];
630

631 632 633 634
			printk(KERN_INFO "dm-mpath: retaining handler on device %s\n",
				bdevname(p->path.dev->bdev, b));
			goto retain;
		}
635
		if (r < 0) {
636
			ti->error = "error attaching hardware handler";
637 638 639
			dm_put_device(ti, p->path.dev);
			goto bad;
		}
640 641 642 643 644 645 646 647 648 649

		if (m->hw_handler_params) {
			r = scsi_dh_set_params(q, m->hw_handler_params);
			if (r < 0) {
				ti->error = "unable to set hardware "
							"handler parameters";
				dm_put_device(ti, p->path.dev);
				goto bad;
			}
		}
650 651
	}

L
Linus Torvalds 已提交
652 653 654 655 656 657 658 659 660 661
	r = ps->type->add_path(ps, &p->path, as->argc, as->argv, &ti->error);
	if (r) {
		dm_put_device(ti, p->path.dev);
		goto bad;
	}

	return p;

 bad:
	free_pgpath(p);
662
	return ERR_PTR(r);
L
Linus Torvalds 已提交
663 664
}

665
static struct priority_group *parse_priority_group(struct dm_arg_set *as,
M
Micha³ Miros³aw 已提交
666
						   struct multipath *m)
L
Linus Torvalds 已提交
667
{
668
	static struct dm_arg _args[] = {
669 670
		{1, 1024, "invalid number of paths"},
		{0, 1024, "invalid number of selector args"}
L
Linus Torvalds 已提交
671 672 673
	};

	int r;
674
	unsigned i, nr_selector_args, nr_args;
L
Linus Torvalds 已提交
675
	struct priority_group *pg;
M
Micha³ Miros³aw 已提交
676
	struct dm_target *ti = m->ti;
L
Linus Torvalds 已提交
677 678 679

	if (as->argc < 2) {
		as->argc = 0;
680 681
		ti->error = "not enough priority group arguments";
		return ERR_PTR(-EINVAL);
L
Linus Torvalds 已提交
682 683 684 685
	}

	pg = alloc_priority_group();
	if (!pg) {
686
		ti->error = "couldn't allocate priority group";
687
		return ERR_PTR(-ENOMEM);
L
Linus Torvalds 已提交
688 689 690 691 692 693 694 695 696 697
	}
	pg->m = m;

	r = parse_path_selector(as, pg, ti);
	if (r)
		goto bad;

	/*
	 * read the paths
	 */
698
	r = dm_read_arg(_args, as, &pg->nr_pgpaths, &ti->error);
L
Linus Torvalds 已提交
699 700 701
	if (r)
		goto bad;

702
	r = dm_read_arg(_args + 1, as, &nr_selector_args, &ti->error);
L
Linus Torvalds 已提交
703 704 705
	if (r)
		goto bad;

706
	nr_args = 1 + nr_selector_args;
L
Linus Torvalds 已提交
707 708
	for (i = 0; i < pg->nr_pgpaths; i++) {
		struct pgpath *pgpath;
709
		struct dm_arg_set path_args;
L
Linus Torvalds 已提交
710

711
		if (as->argc < nr_args) {
712
			ti->error = "not enough path parameters";
713
			r = -EINVAL;
L
Linus Torvalds 已提交
714
			goto bad;
715
		}
L
Linus Torvalds 已提交
716

717
		path_args.argc = nr_args;
L
Linus Torvalds 已提交
718 719 720
		path_args.argv = as->argv;

		pgpath = parse_path(&path_args, &pg->ps, ti);
721 722
		if (IS_ERR(pgpath)) {
			r = PTR_ERR(pgpath);
L
Linus Torvalds 已提交
723
			goto bad;
724
		}
L
Linus Torvalds 已提交
725 726 727

		pgpath->pg = pg;
		list_add_tail(&pgpath->list, &pg->pgpaths);
728
		dm_consume_args(as, nr_args);
L
Linus Torvalds 已提交
729 730 731 732 733 734
	}

	return pg;

 bad:
	free_priority_group(pg, ti);
735
	return ERR_PTR(r);
L
Linus Torvalds 已提交
736 737
}

738
static int parse_hw_handler(struct dm_arg_set *as, struct multipath *m)
L
Linus Torvalds 已提交
739 740
{
	unsigned hw_argc;
741
	int ret;
M
Micha³ Miros³aw 已提交
742
	struct dm_target *ti = m->ti;
L
Linus Torvalds 已提交
743

744
	static struct dm_arg _args[] = {
745
		{0, 1024, "invalid number of hardware handler args"},
L
Linus Torvalds 已提交
746 747
	};

748
	if (dm_read_arg_group(_args, as, &hw_argc, &ti->error))
L
Linus Torvalds 已提交
749 750 751 752 753
		return -EINVAL;

	if (!hw_argc)
		return 0;

754
	m->hw_handler_name = kstrdup(dm_shift_arg(as), GFP_KERNEL);
755

756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771
	if (hw_argc > 1) {
		char *p;
		int i, j, len = 4;

		for (i = 0; i <= hw_argc - 2; i++)
			len += strlen(as->argv[i]) + 1;
		p = m->hw_handler_params = kzalloc(len, GFP_KERNEL);
		if (!p) {
			ti->error = "memory allocation failed";
			ret = -ENOMEM;
			goto fail;
		}
		j = sprintf(p, "%d", hw_argc - 1);
		for (i = 0, p+=j+1; i <= hw_argc - 2; i++, p+=j+1)
			j = sprintf(p, "%s", as->argv[i]);
	}
772
	dm_consume_args(as, hw_argc - 1);
L
Linus Torvalds 已提交
773 774

	return 0;
775 776 777 778
fail:
	kfree(m->hw_handler_name);
	m->hw_handler_name = NULL;
	return ret;
L
Linus Torvalds 已提交
779 780
}

781
static int parse_features(struct dm_arg_set *as, struct multipath *m)
L
Linus Torvalds 已提交
782 783 784
{
	int r;
	unsigned argc;
M
Micha³ Miros³aw 已提交
785
	struct dm_target *ti = m->ti;
786
	const char *arg_name;
L
Linus Torvalds 已提交
787

788
	static struct dm_arg _args[] = {
789
		{0, 6, "invalid number of feature args"},
D
Dave Wysochanski 已提交
790
		{1, 50, "pg_init_retries must be between 1 and 50"},
791
		{0, 60000, "pg_init_delay_msecs must be between 0 and 60000"},
L
Linus Torvalds 已提交
792 793
	};

794
	r = dm_read_arg_group(_args, as, &argc, &ti->error);
L
Linus Torvalds 已提交
795 796 797 798 799 800
	if (r)
		return -EINVAL;

	if (!argc)
		return 0;

D
Dave Wysochanski 已提交
801
	do {
802
		arg_name = dm_shift_arg(as);
D
Dave Wysochanski 已提交
803 804
		argc--;

805
		if (!strcasecmp(arg_name, "queue_if_no_path")) {
806
			r = queue_if_no_path(m, true, false);
D
Dave Wysochanski 已提交
807 808 809
			continue;
		}

810
		if (!strcasecmp(arg_name, "retain_attached_hw_handler")) {
811
			m->retain_attached_hw_handler = true;
812 813 814
			continue;
		}

815
		if (!strcasecmp(arg_name, "pg_init_retries") &&
D
Dave Wysochanski 已提交
816
		    (argc >= 1)) {
817
			r = dm_read_arg(_args + 1, as, &m->pg_init_retries, &ti->error);
D
Dave Wysochanski 已提交
818 819 820 821
			argc--;
			continue;
		}

822
		if (!strcasecmp(arg_name, "pg_init_delay_msecs") &&
823
		    (argc >= 1)) {
824
			r = dm_read_arg(_args + 2, as, &m->pg_init_delay_msecs, &ti->error);
825 826 827 828
			argc--;
			continue;
		}

L
Linus Torvalds 已提交
829
		ti->error = "Unrecognised multipath feature request";
D
Dave Wysochanski 已提交
830 831 832 833
		r = -EINVAL;
	} while (argc && !r);

	return r;
L
Linus Torvalds 已提交
834 835 836 837 838
}

static int multipath_ctr(struct dm_target *ti, unsigned int argc,
			 char **argv)
{
839 840
	/* target arguments */
	static struct dm_arg _args[] = {
841 842
		{0, 1024, "invalid number of priority groups"},
		{0, 1024, "invalid initial priority group number"},
L
Linus Torvalds 已提交
843 844 845 846
	};

	int r;
	struct multipath *m;
847
	struct dm_arg_set as;
L
Linus Torvalds 已提交
848 849
	unsigned pg_count = 0;
	unsigned next_pg_num;
850
	bool use_blk_mq = dm_use_blk_mq(dm_table_get_md(ti->table));
L
Linus Torvalds 已提交
851 852 853 854

	as.argc = argc;
	as.argv = argv;

855
	m = alloc_multipath(ti, use_blk_mq);
L
Linus Torvalds 已提交
856
	if (!m) {
857
		ti->error = "can't allocate multipath";
L
Linus Torvalds 已提交
858 859 860
		return -EINVAL;
	}

M
Micha³ Miros³aw 已提交
861
	r = parse_features(&as, m);
L
Linus Torvalds 已提交
862 863 864
	if (r)
		goto bad;

M
Micha³ Miros³aw 已提交
865
	r = parse_hw_handler(&as, m);
L
Linus Torvalds 已提交
866 867 868
	if (r)
		goto bad;

869
	r = dm_read_arg(_args, &as, &m->nr_priority_groups, &ti->error);
L
Linus Torvalds 已提交
870 871 872
	if (r)
		goto bad;

873
	r = dm_read_arg(_args + 1, &as, &next_pg_num, &ti->error);
L
Linus Torvalds 已提交
874 875 876
	if (r)
		goto bad;

877 878 879 880 881 882 883
	if ((!m->nr_priority_groups && next_pg_num) ||
	    (m->nr_priority_groups && !next_pg_num)) {
		ti->error = "invalid initial priority group";
		r = -EINVAL;
		goto bad;
	}

L
Linus Torvalds 已提交
884 885 886 887
	/* parse the priority groups */
	while (as.argc) {
		struct priority_group *pg;

M
Micha³ Miros³aw 已提交
888
		pg = parse_priority_group(&as, m);
889 890
		if (IS_ERR(pg)) {
			r = PTR_ERR(pg);
L
Linus Torvalds 已提交
891 892 893 894 895 896 897 898 899 900 901 902
			goto bad;
		}

		m->nr_valid_paths += pg->nr_pgpaths;
		list_add_tail(&pg->list, &m->priority_groups);
		pg_count++;
		pg->pg_num = pg_count;
		if (!--next_pg_num)
			m->next_pg = pg;
	}

	if (pg_count != m->nr_priority_groups) {
903
		ti->error = "priority group count mismatch";
L
Linus Torvalds 已提交
904 905 906 907
		r = -EINVAL;
		goto bad;
	}

908 909
	ti->num_flush_bios = 1;
	ti->num_discard_bios = 1;
910
	ti->num_write_same_bios = 1;
911 912
	if (use_blk_mq)
		ti->per_io_data_size = sizeof(struct dm_mpath_io);
M
Mikulas Patocka 已提交
913

L
Linus Torvalds 已提交
914 915 916 917 918 919 920
	return 0;

 bad:
	free_multipath(m);
	return r;
}

921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945
static void multipath_wait_for_pg_init_completion(struct multipath *m)
{
	DECLARE_WAITQUEUE(wait, current);
	unsigned long flags;

	add_wait_queue(&m->pg_init_wait, &wait);

	while (1) {
		set_current_state(TASK_UNINTERRUPTIBLE);

		spin_lock_irqsave(&m->lock, flags);
		if (!m->pg_init_in_progress) {
			spin_unlock_irqrestore(&m->lock, flags);
			break;
		}
		spin_unlock_irqrestore(&m->lock, flags);

		io_schedule();
	}
	set_current_state(TASK_RUNNING);

	remove_wait_queue(&m->pg_init_wait, &wait);
}

static void flush_multipath_work(struct multipath *m)
L
Linus Torvalds 已提交
946
{
947 948 949
	unsigned long flags;

	spin_lock_irqsave(&m->lock, flags);
950
	m->pg_init_disabled = true;
951 952
	spin_unlock_irqrestore(&m->lock, flags);

953
	flush_workqueue(kmpath_handlerd);
954
	multipath_wait_for_pg_init_completion(m);
955
	flush_workqueue(kmultipathd);
956
	flush_work(&m->trigger_event);
957 958

	spin_lock_irqsave(&m->lock, flags);
959
	m->pg_init_disabled = false;
960
	spin_unlock_irqrestore(&m->lock, flags);
961 962 963 964 965 966
}

static void multipath_dtr(struct dm_target *ti)
{
	struct multipath *m = ti->private;

967
	flush_multipath_work(m);
L
Linus Torvalds 已提交
968 969 970 971 972 973 974 975 976 977 978 979 980
	free_multipath(m);
}

/*
 * Take a path out of use.
 */
static int fail_path(struct pgpath *pgpath)
{
	unsigned long flags;
	struct multipath *m = pgpath->pg->m;

	spin_lock_irqsave(&m->lock, flags);

981
	if (!pgpath->is_active)
L
Linus Torvalds 已提交
982 983
		goto out;

984
	DMWARN("Failing path %s.", pgpath->path.dev->name);
L
Linus Torvalds 已提交
985 986

	pgpath->pg->ps.type->fail_path(&pgpath->pg->ps, &pgpath->path);
987
	pgpath->is_active = false;
L
Linus Torvalds 已提交
988 989 990 991 992 993 994
	pgpath->fail_count++;

	m->nr_valid_paths--;

	if (pgpath == m->current_pgpath)
		m->current_pgpath = NULL;

M
Mike Anderson 已提交
995 996 997
	dm_path_uevent(DM_UEVENT_PATH_FAILED, m->ti,
		      pgpath->path.dev->name, m->nr_valid_paths);

998
	schedule_work(&m->trigger_event);
L
Linus Torvalds 已提交
999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010

out:
	spin_unlock_irqrestore(&m->lock, flags);

	return 0;
}

/*
 * Reinstate a previously-failed path
 */
static int reinstate_path(struct pgpath *pgpath)
{
1011
	int r = 0, run_queue = 0;
L
Linus Torvalds 已提交
1012 1013 1014 1015 1016
	unsigned long flags;
	struct multipath *m = pgpath->pg->m;

	spin_lock_irqsave(&m->lock, flags);

1017
	if (pgpath->is_active)
L
Linus Torvalds 已提交
1018 1019
		goto out;

1020
	DMWARN("Reinstating path %s.", pgpath->path.dev->name);
L
Linus Torvalds 已提交
1021 1022 1023 1024 1025

	r = pgpath->pg->ps.type->reinstate_path(&pgpath->pg->ps, &pgpath->path);
	if (r)
		goto out;

1026
	pgpath->is_active = true;
L
Linus Torvalds 已提交
1027

1028
	if (!m->nr_valid_paths++) {
1029
		m->current_pgpath = NULL;
1030
		run_queue = 1;
1031
	} else if (m->hw_handler_name && (m->current_pg == pgpath->pg)) {
1032
		if (queue_work(kmpath_handlerd, &pgpath->activate_path.work))
1033 1034
			m->pg_init_in_progress++;
	}
L
Linus Torvalds 已提交
1035

M
Mike Anderson 已提交
1036 1037 1038
	dm_path_uevent(DM_UEVENT_PATH_REINSTATED, m->ti,
		      pgpath->path.dev->name, m->nr_valid_paths);

1039
	schedule_work(&m->trigger_event);
L
Linus Torvalds 已提交
1040 1041 1042

out:
	spin_unlock_irqrestore(&m->lock, flags);
1043 1044
	if (run_queue)
		dm_table_run_md_queue_async(m->ti->table);
L
Linus Torvalds 已提交
1045 1046 1047 1048 1049 1050 1051 1052 1053 1054

	return r;
}

/*
 * Fail or reinstate all paths that match the provided struct dm_dev.
 */
static int action_dev(struct multipath *m, struct dm_dev *dev,
		      action_fn action)
{
1055
	int r = -EINVAL;
L
Linus Torvalds 已提交
1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072
	struct pgpath *pgpath;
	struct priority_group *pg;

	list_for_each_entry(pg, &m->priority_groups, list) {
		list_for_each_entry(pgpath, &pg->pgpaths, list) {
			if (pgpath->path.dev == dev)
				r = action(pgpath);
		}
	}

	return r;
}

/*
 * Temporarily try to avoid having to use the specified PG
 */
static void bypass_pg(struct multipath *m, struct priority_group *pg,
1073
		      bool bypassed)
L
Linus Torvalds 已提交
1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084
{
	unsigned long flags;

	spin_lock_irqsave(&m->lock, flags);

	pg->bypassed = bypassed;
	m->current_pgpath = NULL;
	m->current_pg = NULL;

	spin_unlock_irqrestore(&m->lock, flags);

1085
	schedule_work(&m->trigger_event);
L
Linus Torvalds 已提交
1086 1087 1088 1089 1090 1091 1092 1093 1094 1095
}

/*
 * Switch to using the specified PG from the next I/O that gets mapped
 */
static int switch_pg_num(struct multipath *m, const char *pgstr)
{
	struct priority_group *pg;
	unsigned pgnum;
	unsigned long flags;
1096
	char dummy;
L
Linus Torvalds 已提交
1097

1098
	if (!pgstr || (sscanf(pgstr, "%u%c", &pgnum, &dummy) != 1) || !pgnum ||
L
Linus Torvalds 已提交
1099 1100 1101 1102 1103 1104 1105
	    (pgnum > m->nr_priority_groups)) {
		DMWARN("invalid PG number supplied to switch_pg_num");
		return -EINVAL;
	}

	spin_lock_irqsave(&m->lock, flags);
	list_for_each_entry(pg, &m->priority_groups, list) {
1106
		pg->bypassed = false;
L
Linus Torvalds 已提交
1107 1108 1109 1110 1111 1112 1113 1114 1115
		if (--pgnum)
			continue;

		m->current_pgpath = NULL;
		m->current_pg = NULL;
		m->next_pg = pg;
	}
	spin_unlock_irqrestore(&m->lock, flags);

1116
	schedule_work(&m->trigger_event);
L
Linus Torvalds 已提交
1117 1118 1119 1120 1121 1122 1123
	return 0;
}

/*
 * Set/clear bypassed status of a PG.
 * PGs are numbered upwards from 1 in the order they were declared.
 */
1124
static int bypass_pg_num(struct multipath *m, const char *pgstr, bool bypassed)
L
Linus Torvalds 已提交
1125 1126 1127
{
	struct priority_group *pg;
	unsigned pgnum;
1128
	char dummy;
L
Linus Torvalds 已提交
1129

1130
	if (!pgstr || (sscanf(pgstr, "%u%c", &pgnum, &dummy) != 1) || !pgnum ||
L
Linus Torvalds 已提交
1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144
	    (pgnum > m->nr_priority_groups)) {
		DMWARN("invalid PG number supplied to bypass_pg");
		return -EINVAL;
	}

	list_for_each_entry(pg, &m->priority_groups, list) {
		if (!--pgnum)
			break;
	}

	bypass_pg(m, pg, bypassed);
	return 0;
}

D
Dave Wysochanski 已提交
1145 1146 1147
/*
 * Should we retry pg_init immediately?
 */
1148
static bool pg_init_limit_reached(struct multipath *m, struct pgpath *pgpath)
D
Dave Wysochanski 已提交
1149 1150
{
	unsigned long flags;
1151
	bool limit_reached = false;
D
Dave Wysochanski 已提交
1152 1153 1154

	spin_lock_irqsave(&m->lock, flags);

1155
	if (m->pg_init_count <= m->pg_init_retries && !m->pg_init_disabled)
1156
		m->pg_init_required = true;
D
Dave Wysochanski 已提交
1157
	else
1158
		limit_reached = true;
D
Dave Wysochanski 已提交
1159 1160 1161 1162 1163 1164

	spin_unlock_irqrestore(&m->lock, flags);

	return limit_reached;
}

1165
static void pg_init_done(void *data, int errors)
1166
{
1167
	struct pgpath *pgpath = data;
1168 1169 1170
	struct priority_group *pg = pgpath->pg;
	struct multipath *m = pg->m;
	unsigned long flags;
1171
	bool delay_retry = false;
1172 1173 1174 1175 1176 1177 1178 1179 1180 1181

	/* device or driver problems */
	switch (errors) {
	case SCSI_DH_OK:
		break;
	case SCSI_DH_NOSYS:
		if (!m->hw_handler_name) {
			errors = 0;
			break;
		}
1182 1183
		DMERR("Could not failover the device: Handler scsi_dh_%s "
		      "Error %d.", m->hw_handler_name, errors);
1184 1185 1186 1187 1188 1189 1190 1191 1192 1193
		/*
		 * Fail path for now, so we do not ping pong
		 */
		fail_path(pgpath);
		break;
	case SCSI_DH_DEV_TEMP_BUSY:
		/*
		 * Probably doing something like FW upgrade on the
		 * controller so try the other pg.
		 */
1194
		bypass_pg(m, pg, true);
1195 1196
		break;
	case SCSI_DH_RETRY:
1197 1198
		/* Wait before retrying. */
		delay_retry = 1;
1199 1200 1201 1202 1203 1204
	case SCSI_DH_IMM_RETRY:
	case SCSI_DH_RES_TEMP_UNAVAIL:
		if (pg_init_limit_reached(m, pgpath))
			fail_path(pgpath);
		errors = 0;
		break;
1205
	case SCSI_DH_DEV_OFFLINED:
1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216
	default:
		/*
		 * We probably do not want to fail the path for a device
		 * error, but this is what the old dm did. In future
		 * patches we can do more advanced handling.
		 */
		fail_path(pgpath);
	}

	spin_lock_irqsave(&m->lock, flags);
	if (errors) {
1217 1218 1219 1220 1221
		if (pgpath == m->current_pgpath) {
			DMERR("Could not failover device. Error %d.", errors);
			m->current_pgpath = NULL;
			m->current_pg = NULL;
		}
1222
	} else if (!m->pg_init_required)
1223
		pg->bypassed = false;
1224

1225 1226 1227 1228
	if (--m->pg_init_in_progress)
		/* Activations of other paths are still on going */
		goto out;

1229 1230 1231 1232 1233
	if (m->pg_init_required) {
		m->pg_init_delay_retry = delay_retry;
		if (__pg_init_all_paths(m))
			goto out;
	}
1234
	m->queue_io = false;
1235

1236 1237 1238 1239 1240
	/*
	 * Wake up any thread waiting to suspend.
	 */
	wake_up(&m->pg_init_wait);

1241
out:
1242 1243 1244
	spin_unlock_irqrestore(&m->lock, flags);
}

1245 1246
static void activate_path(struct work_struct *work)
{
1247
	struct pgpath *pgpath =
1248
		container_of(work, struct pgpath, activate_path.work);
1249

1250 1251 1252 1253 1254
	if (pgpath->is_active)
		scsi_dh_activate(bdev_get_queue(pgpath->path.dev->bdev),
				 pg_init_done, pgpath);
	else
		pg_init_done(pgpath, SCSI_DH_DEV_OFFLINED);
1255 1256
}

1257 1258 1259 1260 1261 1262 1263
static int noretry_error(int error)
{
	switch (error) {
	case -EOPNOTSUPP:
	case -EREMOTEIO:
	case -EILSEQ:
	case -ENODATA:
1264
	case -ENOSPC:
1265 1266 1267 1268 1269 1270 1271
		return 1;
	}

	/* Anything else could be a path failure, so should be retried */
	return 0;
}

L
Linus Torvalds 已提交
1272 1273 1274
/*
 * end_io handling
 */
1275
static int do_end_io(struct multipath *m, struct request *clone,
A
Alasdair G Kergon 已提交
1276
		     int error, struct dm_mpath_io *mpio)
L
Linus Torvalds 已提交
1277
{
1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289
	/*
	 * We don't queue any clone request inside the multipath target
	 * during end I/O handling, since those clone requests don't have
	 * bio clones.  If we queue them inside the multipath target,
	 * we need to make bio clones, that requires memory allocation.
	 * (See drivers/md/dm.c:end_clone_bio() about why the clone requests
	 *  don't have bio clones.)
	 * Instead of queueing the clone request here, we queue the original
	 * request into dm core, which will remake a clone request and
	 * clone bios for it and resubmit it later.
	 */
	int r = DM_ENDIO_REQUEUE;
1290
	unsigned long flags;
L
Linus Torvalds 已提交
1291

1292
	if (!error && !clone->errors)
L
Linus Torvalds 已提交
1293 1294
		return 0;	/* I/O complete */

1295
	if (noretry_error(error))
M
Mike Snitzer 已提交
1296 1297
		return error;

1298 1299
	if (mpio->pgpath)
		fail_path(mpio->pgpath);
L
Linus Torvalds 已提交
1300

1301
	spin_lock_irqsave(&m->lock, flags);
1302 1303 1304 1305 1306 1307 1308 1309 1310
	if (!m->nr_valid_paths) {
		if (!m->queue_if_no_path) {
			if (!__must_push_back(m))
				r = -EIO;
		} else {
			if (error == -EBADE)
				r = error;
		}
	}
1311
	spin_unlock_irqrestore(&m->lock, flags);
L
Linus Torvalds 已提交
1312

1313
	return r;
L
Linus Torvalds 已提交
1314 1315
}

1316
static int multipath_end_io(struct dm_target *ti, struct request *clone,
L
Linus Torvalds 已提交
1317 1318
			    int error, union map_info *map_context)
{
A
Alasdair G Kergon 已提交
1319
	struct multipath *m = ti->private;
1320
	struct dm_mpath_io *mpio = get_mpio(map_context);
1321
	struct pgpath *pgpath;
L
Linus Torvalds 已提交
1322 1323 1324
	struct path_selector *ps;
	int r;

1325 1326
	BUG_ON(!mpio);

1327
	r = do_end_io(m, clone, error, mpio);
1328
	pgpath = mpio->pgpath;
L
Linus Torvalds 已提交
1329 1330 1331
	if (pgpath) {
		ps = &pgpath->pg->ps;
		if (ps->type->end_io)
1332
			ps->type->end_io(ps, &pgpath->path, mpio->nr_bytes);
L
Linus Torvalds 已提交
1333
	}
1334
	clear_request_fn_mpio(m, map_context);
L
Linus Torvalds 已提交
1335 1336 1337 1338 1339 1340

	return r;
}

/*
 * Suspend can't complete until all the I/O is processed so if
1341 1342 1343
 * the last path fails we must error any remaining I/O.
 * Note that if the freeze_bdev fails while suspending, the
 * queue_if_no_path state is lost - userspace should reset it.
L
Linus Torvalds 已提交
1344 1345 1346
 */
static void multipath_presuspend(struct dm_target *ti)
{
1347
	struct multipath *m = ti->private;
L
Linus Torvalds 已提交
1348

1349
	queue_if_no_path(m, false, true);
L
Linus Torvalds 已提交
1350 1351
}

1352 1353
static void multipath_postsuspend(struct dm_target *ti)
{
1354 1355 1356
	struct multipath *m = ti->private;

	mutex_lock(&m->work_mutex);
1357
	flush_multipath_work(m);
1358
	mutex_unlock(&m->work_mutex);
1359 1360
}

1361 1362 1363
/*
 * Restore the queue_if_no_path setting.
 */
L
Linus Torvalds 已提交
1364 1365
static void multipath_resume(struct dm_target *ti)
{
1366
	struct multipath *m = ti->private;
L
Linus Torvalds 已提交
1367 1368 1369
	unsigned long flags;

	spin_lock_irqsave(&m->lock, flags);
1370
	m->queue_if_no_path = m->saved_queue_if_no_path;
L
Linus Torvalds 已提交
1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389
	spin_unlock_irqrestore(&m->lock, flags);
}

/*
 * Info output has the following format:
 * num_multipath_feature_args [multipath_feature_args]*
 * num_handler_status_args [handler_status_args]*
 * num_groups init_group_number
 *            [A|D|E num_ps_status_args [ps_status_args]*
 *             num_paths num_selector_args
 *             [path_dev A|F fail_count [selector_args]* ]+ ]+
 *
 * Table output has the following format (identical to the constructor string):
 * num_feature_args [features_args]*
 * num_handler_args hw_handler [hw_handler_args]*
 * num_groups init_group_number
 *     [priority selector-name num_ps_args [ps_args]*
 *      num_paths num_selector_args [path_dev [selector_args]* ]+ ]+
 */
1390 1391
static void multipath_status(struct dm_target *ti, status_type_t type,
			     unsigned status_flags, char *result, unsigned maxlen)
L
Linus Torvalds 已提交
1392 1393 1394
{
	int sz = 0;
	unsigned long flags;
1395
	struct multipath *m = ti->private;
L
Linus Torvalds 已提交
1396 1397 1398 1399 1400 1401 1402 1403 1404
	struct priority_group *pg;
	struct pgpath *p;
	unsigned pg_num;
	char state;

	spin_lock_irqsave(&m->lock, flags);

	/* Features */
	if (type == STATUSTYPE_INFO)
1405
		DMEMIT("2 %u %u ", m->queue_io, m->pg_init_count);
D
Dave Wysochanski 已提交
1406 1407
	else {
		DMEMIT("%u ", m->queue_if_no_path +
1408
			      (m->pg_init_retries > 0) * 2 +
1409 1410
			      (m->pg_init_delay_msecs != DM_PG_INIT_DELAY_DEFAULT) * 2 +
			      m->retain_attached_hw_handler);
D
Dave Wysochanski 已提交
1411 1412 1413 1414
		if (m->queue_if_no_path)
			DMEMIT("queue_if_no_path ");
		if (m->pg_init_retries)
			DMEMIT("pg_init_retries %u ", m->pg_init_retries);
1415 1416
		if (m->pg_init_delay_msecs != DM_PG_INIT_DELAY_DEFAULT)
			DMEMIT("pg_init_delay_msecs %u ", m->pg_init_delay_msecs);
1417 1418
		if (m->retain_attached_hw_handler)
			DMEMIT("retain_attached_hw_handler ");
D
Dave Wysochanski 已提交
1419
	}
L
Linus Torvalds 已提交
1420

1421
	if (!m->hw_handler_name || type == STATUSTYPE_INFO)
L
Linus Torvalds 已提交
1422 1423
		DMEMIT("0 ");
	else
1424
		DMEMIT("1 %s ", m->hw_handler_name);
L
Linus Torvalds 已提交
1425 1426 1427 1428 1429 1430 1431 1432

	DMEMIT("%u ", m->nr_priority_groups);

	if (m->next_pg)
		pg_num = m->next_pg->pg_num;
	else if (m->current_pg)
		pg_num = m->current_pg->pg_num;
	else
1433
		pg_num = (m->nr_priority_groups ? 1 : 0);
L
Linus Torvalds 已提交
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

	DMEMIT("%u ", pg_num);

	switch (type) {
	case STATUSTYPE_INFO:
		list_for_each_entry(pg, &m->priority_groups, list) {
			if (pg->bypassed)
				state = 'D';	/* Disabled */
			else if (pg == m->current_pg)
				state = 'A';	/* Currently Active */
			else
				state = 'E';	/* Enabled */

			DMEMIT("%c ", state);

			if (pg->ps.type->status)
				sz += pg->ps.type->status(&pg->ps, NULL, type,
							  result + sz,
							  maxlen - sz);
			else
				DMEMIT("0 ");

			DMEMIT("%u %u ", pg->nr_pgpaths,
			       pg->ps.type->info_args);

			list_for_each_entry(p, &pg->pgpaths, list) {
				DMEMIT("%s %s %u ", p->path.dev->name,
1461
				       p->is_active ? "A" : "F",
L
Linus Torvalds 已提交
1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500
				       p->fail_count);
				if (pg->ps.type->status)
					sz += pg->ps.type->status(&pg->ps,
					      &p->path, type, result + sz,
					      maxlen - sz);
			}
		}
		break;

	case STATUSTYPE_TABLE:
		list_for_each_entry(pg, &m->priority_groups, list) {
			DMEMIT("%s ", pg->ps.type->name);

			if (pg->ps.type->status)
				sz += pg->ps.type->status(&pg->ps, NULL, type,
							  result + sz,
							  maxlen - sz);
			else
				DMEMIT("0 ");

			DMEMIT("%u %u ", pg->nr_pgpaths,
			       pg->ps.type->table_args);

			list_for_each_entry(p, &pg->pgpaths, list) {
				DMEMIT("%s ", p->path.dev->name);
				if (pg->ps.type->status)
					sz += pg->ps.type->status(&pg->ps,
					      &p->path, type, result + sz,
					      maxlen - sz);
			}
		}
		break;
	}

	spin_unlock_irqrestore(&m->lock, flags);
}

static int multipath_message(struct dm_target *ti, unsigned argc, char **argv)
{
1501
	int r = -EINVAL;
L
Linus Torvalds 已提交
1502
	struct dm_dev *dev;
1503
	struct multipath *m = ti->private;
L
Linus Torvalds 已提交
1504 1505
	action_fn action;

1506 1507
	mutex_lock(&m->work_mutex);

1508 1509 1510 1511 1512
	if (dm_suspended(ti)) {
		r = -EBUSY;
		goto out;
	}

L
Linus Torvalds 已提交
1513
	if (argc == 1) {
1514
		if (!strcasecmp(argv[0], "queue_if_no_path")) {
1515
			r = queue_if_no_path(m, true, false);
1516
			goto out;
1517
		} else if (!strcasecmp(argv[0], "fail_if_no_path")) {
1518
			r = queue_if_no_path(m, false, false);
1519 1520
			goto out;
		}
L
Linus Torvalds 已提交
1521 1522
	}

1523
	if (argc != 2) {
1524
		DMWARN("Invalid multipath message arguments. Expected 2 arguments, got %d.", argc);
1525 1526
		goto out;
	}
L
Linus Torvalds 已提交
1527

1528
	if (!strcasecmp(argv[0], "disable_group")) {
1529
		r = bypass_pg_num(m, argv[1], true);
1530
		goto out;
1531
	} else if (!strcasecmp(argv[0], "enable_group")) {
1532
		r = bypass_pg_num(m, argv[1], false);
1533
		goto out;
1534
	} else if (!strcasecmp(argv[0], "switch_group")) {
1535 1536
		r = switch_pg_num(m, argv[1]);
		goto out;
1537
	} else if (!strcasecmp(argv[0], "reinstate_path"))
L
Linus Torvalds 已提交
1538
		action = reinstate_path;
1539
	else if (!strcasecmp(argv[0], "fail_path"))
L
Linus Torvalds 已提交
1540
		action = fail_path;
1541
	else {
1542
		DMWARN("Unrecognised multipath message received: %s", argv[0]);
1543 1544
		goto out;
	}
L
Linus Torvalds 已提交
1545

1546
	r = dm_get_device(ti, argv[1], dm_table_get_mode(ti->table), &dev);
L
Linus Torvalds 已提交
1547
	if (r) {
1548
		DMWARN("message: error getting device %s",
L
Linus Torvalds 已提交
1549
		       argv[1]);
1550
		goto out;
L
Linus Torvalds 已提交
1551 1552 1553 1554 1555 1556
	}

	r = action_dev(m, dev, action);

	dm_put_device(ti, dev);

1557 1558
out:
	mutex_unlock(&m->work_mutex);
L
Linus Torvalds 已提交
1559 1560 1561
	return r;
}

C
Christoph Hellwig 已提交
1562 1563
static int multipath_prepare_ioctl(struct dm_target *ti,
		struct block_device **bdev, fmode_t *mode)
M
Milan Broz 已提交
1564
{
1565
	struct multipath *m = ti->private;
M
Milan Broz 已提交
1566
	unsigned long flags;
1567 1568
	int r;

M
Milan Broz 已提交
1569 1570 1571
	spin_lock_irqsave(&m->lock, flags);

	if (!m->current_pgpath)
1572
		__choose_pgpath(m, 0);
M
Milan Broz 已提交
1573

1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588
	if (m->current_pgpath) {
		if (!m->queue_io) {
			*bdev = m->current_pgpath->path.dev->bdev;
			*mode = m->current_pgpath->path.dev->mode;
			r = 0;
		} else {
			/* pg_init has not started or completed */
			r = -ENOTCONN;
		}
	} else {
		/* No path is available */
		if (m->queue_if_no_path)
			r = -ENOTCONN;
		else
			r = -EIO;
1589
	}
M
Milan Broz 已提交
1590 1591 1592

	spin_unlock_irqrestore(&m->lock, flags);

1593
	if (r == -ENOTCONN) {
1594 1595 1596 1597 1598 1599 1600
		spin_lock_irqsave(&m->lock, flags);
		if (!m->current_pg) {
			/* Path status changed, redo selection */
			__choose_pgpath(m, 0);
		}
		if (m->pg_init_required)
			__pg_init_all_paths(m);
1601
		spin_unlock_irqrestore(&m->lock, flags);
1602
		dm_table_run_md_queue_async(m->ti->table);
1603
	}
1604

C
Christoph Hellwig 已提交
1605 1606 1607 1608 1609 1610
	/*
	 * Only pass ioctls through if the device sizes match exactly.
	 */
	if (!r && ti->len != i_size_read((*bdev)->bd_inode) >> SECTOR_SHIFT)
		return 1;
	return r;
M
Milan Broz 已提交
1611 1612
}

1613 1614 1615 1616 1617 1618 1619 1620 1621 1622
static int multipath_iterate_devices(struct dm_target *ti,
				     iterate_devices_callout_fn fn, void *data)
{
	struct multipath *m = ti->private;
	struct priority_group *pg;
	struct pgpath *p;
	int ret = 0;

	list_for_each_entry(pg, &m->priority_groups, list) {
		list_for_each_entry(p, &pg->pgpaths, list) {
1623
			ret = fn(ti, p->path.dev, ti->begin, ti->len, data);
1624 1625 1626 1627 1628 1629 1630 1631 1632
			if (ret)
				goto out;
		}
	}

out:
	return ret;
}

1633
static int pgpath_busy(struct pgpath *pgpath)
1634 1635 1636
{
	struct request_queue *q = bdev_get_queue(pgpath->path.dev->bdev);

1637
	return blk_lld_busy(q);
1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649
}

/*
 * We return "busy", only when we can map I/Os but underlying devices
 * are busy (so even if we map I/Os now, the I/Os will wait on
 * the underlying queue).
 * In other words, if we want to kill I/Os or queue them inside us
 * due to map unavailability, we don't return "busy".  Otherwise,
 * dm core won't give us the I/Os and we can't do what we want.
 */
static int multipath_busy(struct dm_target *ti)
{
1650
	bool busy = false, has_active = false;
1651 1652 1653 1654 1655 1656 1657
	struct multipath *m = ti->private;
	struct priority_group *pg;
	struct pgpath *pgpath;
	unsigned long flags;

	spin_lock_irqsave(&m->lock, flags);

1658 1659 1660
	/* pg_init in progress or no paths available */
	if (m->pg_init_in_progress ||
	    (!m->nr_valid_paths && m->queue_if_no_path)) {
1661
		busy = true;
1662 1663
		goto out;
	}
1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682
	/* Guess which priority_group will be used at next mapping time */
	if (unlikely(!m->current_pgpath && m->next_pg))
		pg = m->next_pg;
	else if (likely(m->current_pg))
		pg = m->current_pg;
	else
		/*
		 * We don't know which pg will be used at next mapping time.
		 * We don't call __choose_pgpath() here to avoid to trigger
		 * pg_init just by busy checking.
		 * So we don't know whether underlying devices we will be using
		 * at next mapping time are busy or not. Just try mapping.
		 */
		goto out;

	/*
	 * If there is one non-busy active path at least, the path selector
	 * will be able to select it. So we consider such a pg as not busy.
	 */
1683
	busy = true;
1684 1685
	list_for_each_entry(pgpath, &pg->pgpaths, list)
		if (pgpath->is_active) {
1686
			has_active = true;
1687
			if (!pgpath_busy(pgpath)) {
1688
				busy = false;
1689 1690 1691 1692 1693 1694 1695 1696 1697 1698
				break;
			}
		}

	if (!has_active)
		/*
		 * No active path in this pg, so this pg won't be used and
		 * the current_pg will be changed at next mapping time.
		 * We need to try mapping to determine it.
		 */
1699
		busy = false;
1700 1701 1702 1703 1704 1705 1706

out:
	spin_unlock_irqrestore(&m->lock, flags);

	return busy;
}

L
Linus Torvalds 已提交
1707 1708 1709 1710 1711
/*-----------------------------------------------------------------
 * Module setup
 *---------------------------------------------------------------*/
static struct target_type multipath_target = {
	.name = "multipath",
M
Mike Snitzer 已提交
1712 1713
	.version = {1, 11, 0},
	.features = DM_TARGET_SINGLETON | DM_TARGET_IMMUTABLE,
L
Linus Torvalds 已提交
1714 1715 1716
	.module = THIS_MODULE,
	.ctr = multipath_ctr,
	.dtr = multipath_dtr,
1717
	.map_rq = multipath_map,
1718 1719
	.clone_and_map_rq = multipath_clone_and_map,
	.release_clone_rq = multipath_release_clone,
1720
	.rq_end_io = multipath_end_io,
L
Linus Torvalds 已提交
1721
	.presuspend = multipath_presuspend,
1722
	.postsuspend = multipath_postsuspend,
L
Linus Torvalds 已提交
1723 1724 1725
	.resume = multipath_resume,
	.status = multipath_status,
	.message = multipath_message,
C
Christoph Hellwig 已提交
1726
	.prepare_ioctl = multipath_prepare_ioctl,
1727
	.iterate_devices = multipath_iterate_devices,
1728
	.busy = multipath_busy,
L
Linus Torvalds 已提交
1729 1730 1731 1732 1733 1734 1735
};

static int __init dm_multipath_init(void)
{
	int r;

	/* allocate a slab for the dm_ios */
A
Alasdair G Kergon 已提交
1736
	_mpio_cache = KMEM_CACHE(dm_mpath_io, 0);
L
Linus Torvalds 已提交
1737 1738 1739 1740 1741
	if (!_mpio_cache)
		return -ENOMEM;

	r = dm_register_target(&multipath_target);
	if (r < 0) {
1742
		DMERR("register failed %d", r);
1743 1744
		r = -EINVAL;
		goto bad_register_target;
L
Linus Torvalds 已提交
1745 1746
	}

1747
	kmultipathd = alloc_workqueue("kmpathd", WQ_MEM_RECLAIM, 0);
1748
	if (!kmultipathd) {
1749
		DMERR("failed to create workqueue kmpathd");
1750 1751
		r = -ENOMEM;
		goto bad_alloc_kmultipathd;
1752 1753
	}

1754 1755 1756 1757 1758 1759
	/*
	 * A separate workqueue is used to handle the device handlers
	 * to avoid overloading existing workqueue. Overloading the
	 * old workqueue would also create a bottleneck in the
	 * path of the storage hardware device activation.
	 */
1760 1761
	kmpath_handlerd = alloc_ordered_workqueue("kmpath_handlerd",
						  WQ_MEM_RECLAIM);
1762 1763
	if (!kmpath_handlerd) {
		DMERR("failed to create workqueue kmpath_handlerd");
1764 1765
		r = -ENOMEM;
		goto bad_alloc_kmpath_handlerd;
1766 1767
	}

1768
	DMINFO("version %u.%u.%u loaded",
L
Linus Torvalds 已提交
1769 1770 1771
	       multipath_target.version[0], multipath_target.version[1],
	       multipath_target.version[2]);

1772 1773 1774 1775 1776 1777 1778 1779 1780
	return 0;

bad_alloc_kmpath_handlerd:
	destroy_workqueue(kmultipathd);
bad_alloc_kmultipathd:
	dm_unregister_target(&multipath_target);
bad_register_target:
	kmem_cache_destroy(_mpio_cache);

L
Linus Torvalds 已提交
1781 1782 1783 1784 1785
	return r;
}

static void __exit dm_multipath_exit(void)
{
1786
	destroy_workqueue(kmpath_handlerd);
1787 1788
	destroy_workqueue(kmultipathd);

1789
	dm_unregister_target(&multipath_target);
L
Linus Torvalds 已提交
1790 1791 1792 1793 1794 1795 1796 1797 1798
	kmem_cache_destroy(_mpio_cache);
}

module_init(dm_multipath_init);
module_exit(dm_multipath_exit);

MODULE_DESCRIPTION(DM_NAME " multipath target");
MODULE_AUTHOR("Sistina Software <dm-devel@redhat.com>");
MODULE_LICENSE("GPL");