Skip to content
Snippets Groups Projects
dm-mpath.c 39.9 KiB
Newer Older
Linus Torvalds's avatar
Linus Torvalds committed
/*
 * Copyright (C) 2003 Sistina Software Limited.
 * Copyright (C) 2004-2005 Red Hat, Inc. All rights reserved.
 *
 * This file is released under the GPL.
 */

#include <linux/device-mapper.h>

Linus Torvalds's avatar
Linus Torvalds committed
#include "dm-path-selector.h"
Mike Anderson's avatar
Mike Anderson committed
#include "dm-uevent.h"
Linus Torvalds's avatar
Linus Torvalds committed

#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>
#include <linux/delay.h>
#include <linux/atomic.h>
Linus Torvalds's avatar
Linus Torvalds committed

#define DM_MSG_PREFIX "multipath"
#define DM_PG_INIT_DELAY_MSECS 2000
#define DM_PG_INIT_DELAY_DEFAULT ((unsigned) -1)
Linus Torvalds's avatar
Linus Torvalds committed

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

	struct priority_group *pg;	/* Owning PG */
	unsigned is_active;		/* Path status */
Linus Torvalds's avatar
Linus Torvalds committed
	unsigned fail_count;		/* Cumulative failure count */

	struct dm_path path;
	struct delayed_work activate_path;
Linus Torvalds's avatar
Linus Torvalds committed
};

#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 bypassed;		/* Temporarily bypass this PG? */

	unsigned nr_pgpaths;		/* Number of paths in PG */
	struct list_head pgpaths;
};

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

	const char *hw_handler_name;
	spinlock_t lock;

Linus Torvalds's avatar
Linus Torvalds committed
	unsigned nr_priority_groups;
	struct list_head priority_groups;

	wait_queue_head_t pg_init_wait;	/* Wait for pg_init completion */

Linus Torvalds's avatar
Linus Torvalds committed
	unsigned pg_init_required;	/* pg_init needs calling? */
	unsigned pg_init_in_progress;	/* Only one pg_init allowed at once */
	unsigned pg_init_delay_retry;	/* Delay pg_init retry? */
Linus Torvalds's avatar
Linus Torvalds committed

	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 */
	unsigned repeat_count;		/* I/Os left before calling PS again */

	unsigned queue_io:1;		/* Must we queue all I/O? */
	unsigned queue_if_no_path:1;	/* Queue I/O if last path fails? */
	unsigned saved_queue_if_no_path:1; /* Saved state during suspension */
	unsigned retain_attached_hw_handler:1; /* If there's already a hw_handler present, don't change it. */
	unsigned pg_init_disabled:1;	/* pg_init is not currently allowed */
	unsigned pg_init_retries;	/* Number of times to retry pg_init */
	unsigned pg_init_count;		/* Number of times pg_init called */
	unsigned pg_init_delay_msecs;	/* Number of msecs before pg_init retry */
Linus Torvalds's avatar
Linus Torvalds committed

	struct work_struct trigger_event;

	/*
	 * We must use a mempool of dm_mpath_io structs so that we
Linus Torvalds's avatar
Linus Torvalds committed
	 * can resubmit bios on error.
	 */
	mempool_t *mpio_pool;
Linus Torvalds's avatar
Linus Torvalds committed
};

/*
 * Context information attached to each bio we process.
 */
struct dm_mpath_io {
Linus Torvalds's avatar
Linus Torvalds committed
	struct pgpath *pgpath;
Linus Torvalds's avatar
Linus Torvalds committed
};

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

static struct kmem_cache *_mpio_cache;
Linus Torvalds's avatar
Linus Torvalds committed

static struct workqueue_struct *kmultipathd, *kmpath_handlerd;
static void trigger_event(struct work_struct *work);
static void activate_path(struct work_struct *work);
static int __pgpath_busy(struct pgpath *pgpath);
Linus Torvalds's avatar
Linus Torvalds committed


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

static struct pgpath *alloc_pgpath(void)
{
	struct pgpath *pgpath = kzalloc(sizeof(*pgpath), GFP_KERNEL);
Linus Torvalds's avatar
Linus Torvalds committed

	if (pgpath) {
		pgpath->is_active = 1;
		INIT_DELAYED_WORK(&pgpath->activate_path, activate_path);
Linus Torvalds's avatar
Linus Torvalds committed

	return pgpath;
}

static void free_pgpath(struct pgpath *pgpath)
Linus Torvalds's avatar
Linus Torvalds committed
{
	kfree(pgpath);
}

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

	pg = kzalloc(sizeof(*pg), GFP_KERNEL);
Linus Torvalds's avatar
Linus Torvalds committed

	if (pg)
		INIT_LIST_HEAD(&pg->pgpaths);
Linus Torvalds's avatar
Linus Torvalds committed

	return pg;
}

static void free_pgpaths(struct list_head *pgpaths, struct dm_target *ti)
{
	struct pgpath *pgpath, *tmp;
	struct multipath *m = ti->private;
Linus Torvalds's avatar
Linus Torvalds committed

	list_for_each_entry_safe(pgpath, tmp, pgpaths, list) {
		list_del(&pgpath->list);
		if (m->hw_handler_name)
			scsi_dh_detach(bdev_get_queue(pgpath->path.dev->bdev));
Linus Torvalds's avatar
Linus Torvalds committed
		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);
}

static struct multipath *alloc_multipath(struct dm_target *ti)
Linus Torvalds's avatar
Linus Torvalds committed
{
	struct multipath *m;
	unsigned min_ios = dm_get_reserved_rq_based_ios();
Linus Torvalds's avatar
Linus Torvalds committed

	m = kzalloc(sizeof(*m), GFP_KERNEL);
Linus Torvalds's avatar
Linus Torvalds committed
	if (m) {
		INIT_LIST_HEAD(&m->priority_groups);
		spin_lock_init(&m->lock);
		m->queue_io = 1;
		m->pg_init_delay_msecs = DM_PG_INIT_DELAY_DEFAULT;
		INIT_WORK(&m->trigger_event, trigger_event);
		init_waitqueue_head(&m->pg_init_wait);
		mutex_init(&m->work_mutex);
		m->mpio_pool = mempool_create_slab_pool(min_ios, _mpio_cache);
Linus Torvalds's avatar
Linus Torvalds committed
		if (!m->mpio_pool) {
			kfree(m);
			return NULL;
		}
		m->ti = ti;
		ti->private = m;
Linus Torvalds's avatar
Linus Torvalds committed
	}

	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);
	}

	kfree(m->hw_handler_params);
Linus Torvalds's avatar
Linus Torvalds committed
	mempool_destroy(m->mpio_pool);
	kfree(m);
}

static int set_mapinfo(struct multipath *m, union map_info *info)
{
	struct dm_mpath_io *mpio;

	mpio = mempool_alloc(m->mpio_pool, GFP_ATOMIC);
	if (!mpio)
		return -ENOMEM;

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

	return 0;
}

static void clear_mapinfo(struct multipath *m, union map_info *info)
{
	struct dm_mpath_io *mpio = info->ptr;

	info->ptr = NULL;
	mempool_free(mpio, m->mpio_pool);
}
Linus Torvalds's avatar
Linus Torvalds committed

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

static int __pg_init_all_paths(struct multipath *m)
Kiyoshi Ueda's avatar
Kiyoshi Ueda committed
{
	struct pgpath *pgpath;
	unsigned long pg_init_delay = 0;
	if (m->pg_init_in_progress || m->pg_init_disabled)
Kiyoshi Ueda's avatar
Kiyoshi Ueda committed
	m->pg_init_count++;
	m->pg_init_required = 0;

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

	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);
Kiyoshi Ueda's avatar
Kiyoshi Ueda committed
	list_for_each_entry(pgpath, &m->current_pg->pgpaths, list) {
		/* Skip failed paths */
		if (!pgpath->is_active)
			continue;
		if (queue_delayed_work(kmpath_handlerd, &pgpath->activate_path,
				       pg_init_delay))
Kiyoshi Ueda's avatar
Kiyoshi Ueda committed
			m->pg_init_in_progress++;
	}
	return m->pg_init_in_progress;
Linus Torvalds's avatar
Linus Torvalds committed
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? */
Linus Torvalds's avatar
Linus Torvalds committed
		m->pg_init_required = 1;
		m->queue_io = 1;
	} else {
		m->pg_init_required = 0;
		m->queue_io = 0;
	}

	m->pg_init_count = 0;
static int __choose_path_in_pg(struct multipath *m, struct priority_group *pg,
			       size_t nr_bytes)
Linus Torvalds's avatar
Linus Torvalds committed
{
	struct dm_path *path;
Linus Torvalds's avatar
Linus Torvalds committed

	path = pg->ps.type->select_path(&pg->ps, &m->repeat_count, nr_bytes);
Linus Torvalds's avatar
Linus Torvalds committed
	if (!path)
		return -ENXIO;

	m->current_pgpath = path_to_pgpath(path);

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

	return 0;
}

static void __choose_pgpath(struct multipath *m, size_t nr_bytes)
Linus Torvalds's avatar
Linus Torvalds committed
{
	struct priority_group *pg;
	unsigned bypassed = 1;

	if (!m->nr_valid_paths)
		goto failed;

	/* Were we instructed to switch PG? */
	if (m->next_pg) {
		pg = m->next_pg;
		m->next_pg = NULL;
		if (!__choose_path_in_pg(m, pg, nr_bytes))
Linus Torvalds's avatar
Linus Torvalds committed
			return;
	}

	/* Don't change PG until it has no remaining paths */
	if (m->current_pg && !__choose_path_in_pg(m, m->current_pg, nr_bytes))
Linus Torvalds's avatar
Linus Torvalds committed
		return;

	/*
	 * Loop through priority groups until we find a valid path.
	 * First time we skip PGs marked 'bypassed'.
	 * Second time we only try the ones we skipped, but set
	 * pg_init_delay_retry so we do not hammer controllers.
Linus Torvalds's avatar
Linus Torvalds committed
	 */
	do {
		list_for_each_entry(pg, &m->priority_groups, list) {
			if (pg->bypassed == bypassed)
				continue;
			if (!__choose_path_in_pg(m, pg, nr_bytes)) {
				if (!bypassed)
					m->pg_init_delay_retry = 1;
Linus Torvalds's avatar
Linus Torvalds committed
				return;
Linus Torvalds's avatar
Linus Torvalds committed
		}
	} while (bypassed--);

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

/*
 * 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)
{
	return (m->queue_if_no_path ||
		(m->queue_if_no_path != m->saved_queue_if_no_path &&
		 dm_noflush_suspending(m->ti)));
#define pg_ready(m) (!(m)->queue_io && !(m)->pg_init_required)

/*
 * Map cloned requests
 */
static int multipath_map(struct dm_target *ti, struct request *clone,
			 union map_info *map_context)
Linus Torvalds's avatar
Linus Torvalds committed
{
	struct multipath *m = (struct multipath *) ti->private;
	int r = DM_MAPIO_REQUEUE;
	size_t nr_bytes = blk_rq_bytes(clone);
Linus Torvalds's avatar
Linus Torvalds committed
	unsigned long flags;
	struct pgpath *pgpath;
	struct block_device *bdev;
	struct dm_mpath_io *mpio;
Linus Torvalds's avatar
Linus Torvalds committed

	spin_lock_irqsave(&m->lock, flags);

	/* Do we need to select a new pgpath? */
	if (!m->current_pgpath ||
	    (!m->queue_io && (m->repeat_count && --m->repeat_count == 0)))
		__choose_pgpath(m, nr_bytes);
Linus Torvalds's avatar
Linus Torvalds committed

	pgpath = m->current_pgpath;

	if (!pgpath) {
		if (!__must_push_back(m))
			r = -EIO;	/* Failed */
		goto out_unlock;
	}
	if (!pg_ready(m)) {
		__pg_init_all_paths(m);
		goto out_unlock;
	}
	if (set_mapinfo(m, map_context) < 0)
		/* ENOMEM, requeue */
		goto out_unlock;

	bdev = pgpath->path.dev->bdev;
	clone->q = bdev_get_queue(bdev);
	clone->rq_disk = bdev->bd_disk;
	clone->cmd_flags |= REQ_FAILFAST_TRANSPORT;
	mpio = map_context->ptr;
	mpio->pgpath = pgpath;
	mpio->nr_bytes = nr_bytes;
	if (pgpath->pg->ps.type->start_io)
		pgpath->pg->ps.type->start_io(&pgpath->pg->ps,
					      &pgpath->path,
					      nr_bytes);
	r = DM_MAPIO_REMAPPED;
Linus Torvalds's avatar
Linus Torvalds committed

Linus Torvalds's avatar
Linus Torvalds committed
	spin_unlock_irqrestore(&m->lock, flags);

	return r;
}

/*
 * If we run out of usable paths, should we queue I/O or error it?
 */
static int queue_if_no_path(struct multipath *m, unsigned queue_if_no_path,
			    unsigned save_old_value)
Linus Torvalds's avatar
Linus Torvalds committed
{
	unsigned long flags;

	spin_lock_irqsave(&m->lock, flags);

	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;
Linus Torvalds's avatar
Linus Torvalds committed
	m->queue_if_no_path = queue_if_no_path;
	spin_unlock_irqrestore(&m->lock, flags);

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

Linus Torvalds's avatar
Linus Torvalds committed
	return 0;
}

/*
 * An event is triggered whenever a path is taken out of use.
 * Includes path failure and PG bypass.
 */
static void trigger_event(struct work_struct *work)
Linus Torvalds's avatar
Linus Torvalds committed
{
	struct multipath *m =
		container_of(work, struct multipath, trigger_event);
Linus Torvalds's avatar
Linus Torvalds committed

	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>]* ]+ ]+
 *---------------------------------------------------------------*/
static int parse_path_selector(struct dm_arg_set *as, struct priority_group *pg,
Linus Torvalds's avatar
Linus Torvalds committed
			       struct dm_target *ti)
{
	int r;
	struct path_selector_type *pst;
	unsigned ps_argc;

	static struct dm_arg _args[] = {
		{0, 1024, "invalid number of path selector args"},
Linus Torvalds's avatar
Linus Torvalds committed
	};

	pst = dm_get_path_selector(dm_shift_arg(as));
Linus Torvalds's avatar
Linus Torvalds committed
	if (!pst) {
		ti->error = "unknown path selector type";
Linus Torvalds's avatar
Linus Torvalds committed
		return -EINVAL;
	}

	r = dm_read_arg_group(_args, as, &ps_argc, &ti->error);
	if (r) {
		dm_put_path_selector(pst);
Linus Torvalds's avatar
Linus Torvalds committed
		return -EINVAL;
Linus Torvalds's avatar
Linus Torvalds committed

	r = pst->create(&pg->ps, ps_argc, as->argv);
	if (r) {
		dm_put_path_selector(pst);
		ti->error = "path selector constructor failed";
Linus Torvalds's avatar
Linus Torvalds committed
		return r;
	}

	pg->ps.type = pst;
	dm_consume_args(as, ps_argc);
Linus Torvalds's avatar
Linus Torvalds committed

	return 0;
}

static struct pgpath *parse_path(struct dm_arg_set *as, struct path_selector *ps,
Linus Torvalds's avatar
Linus Torvalds committed
			       struct dm_target *ti)
{
	int r;
	struct pgpath *p;
	struct multipath *m = ti->private;
	struct request_queue *q = NULL;
	const char *attached_handler_name;
Linus Torvalds's avatar
Linus Torvalds committed

	/* we need at least a path arg */
	if (as->argc < 1) {
		ti->error = "no device given";
		return ERR_PTR(-EINVAL);
Linus Torvalds's avatar
Linus Torvalds committed
	}

	p = alloc_pgpath();
	if (!p)
		return ERR_PTR(-ENOMEM);
Linus Torvalds's avatar
Linus Torvalds committed

	r = dm_get_device(ti, dm_shift_arg(as), dm_table_get_mode(ti->table),
Linus Torvalds's avatar
Linus Torvalds committed
	if (r) {
		ti->error = "error getting device";
Linus Torvalds's avatar
Linus Torvalds committed
		goto bad;
	}

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

	if (m->retain_attached_hw_handler) {
		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;
		}
	}
	if (m->hw_handler_name) {
		/*
		 * Increments scsi_dh reference, even when using an
		 * already-attached handler.
		 */
		r = scsi_dh_attach(q, m->hw_handler_name);
		if (r == -EBUSY) {
			/*
			 * Already attached to different hw_handler:
			 * try to reattach with correct one.
			 */
			scsi_dh_detach(q);
			r = scsi_dh_attach(q, m->hw_handler_name);
		}

			ti->error = "error attaching hardware handler";
			dm_put_device(ti, p->path.dev);
			goto bad;
		}

		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";
				scsi_dh_detach(q);
				dm_put_device(ti, p->path.dev);
				goto bad;
			}
		}
Linus Torvalds's avatar
Linus Torvalds committed
	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);
	return ERR_PTR(r);
static struct priority_group *parse_priority_group(struct dm_arg_set *as,
						   struct multipath *m)
Linus Torvalds's avatar
Linus Torvalds committed
{
	static struct dm_arg _args[] = {
		{1, 1024, "invalid number of paths"},
		{0, 1024, "invalid number of selector args"}
Linus Torvalds's avatar
Linus Torvalds committed
	};

	int r;
	unsigned i, nr_selector_args, nr_args;
Linus Torvalds's avatar
Linus Torvalds committed
	struct priority_group *pg;
	struct dm_target *ti = m->ti;
Linus Torvalds's avatar
Linus Torvalds committed

	if (as->argc < 2) {
		as->argc = 0;
		ti->error = "not enough priority group arguments";
		return ERR_PTR(-EINVAL);
Linus Torvalds's avatar
Linus Torvalds committed
	}

	pg = alloc_priority_group();
	if (!pg) {
		ti->error = "couldn't allocate priority group";
		return ERR_PTR(-ENOMEM);
Linus Torvalds's avatar
Linus Torvalds committed
	}
	pg->m = m;

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

	/*
	 * read the paths
	 */
	r = dm_read_arg(_args, as, &pg->nr_pgpaths, &ti->error);
Linus Torvalds's avatar
Linus Torvalds committed
	if (r)
		goto bad;

	r = dm_read_arg(_args + 1, as, &nr_selector_args, &ti->error);
Linus Torvalds's avatar
Linus Torvalds committed
	if (r)
		goto bad;

	nr_args = 1 + nr_selector_args;
Linus Torvalds's avatar
Linus Torvalds committed
	for (i = 0; i < pg->nr_pgpaths; i++) {
		struct pgpath *pgpath;
		struct dm_arg_set path_args;
Linus Torvalds's avatar
Linus Torvalds committed

		if (as->argc < nr_args) {
			ti->error = "not enough path parameters";
Linus Torvalds's avatar
Linus Torvalds committed
			goto bad;
Linus Torvalds's avatar
Linus Torvalds committed

		path_args.argc = nr_args;
Linus Torvalds's avatar
Linus Torvalds committed
		path_args.argv = as->argv;

		pgpath = parse_path(&path_args, &pg->ps, ti);
		if (IS_ERR(pgpath)) {
			r = PTR_ERR(pgpath);
Linus Torvalds's avatar
Linus Torvalds committed
			goto bad;
Linus Torvalds's avatar
Linus Torvalds committed

		pgpath->pg = pg;
		list_add_tail(&pgpath->list, &pg->pgpaths);
		dm_consume_args(as, nr_args);
Linus Torvalds's avatar
Linus Torvalds committed
	}

	return pg;

 bad:
	free_priority_group(pg, ti);
	return ERR_PTR(r);
static int parse_hw_handler(struct dm_arg_set *as, struct multipath *m)
Linus Torvalds's avatar
Linus Torvalds committed
{
	unsigned hw_argc;
	struct dm_target *ti = m->ti;
Linus Torvalds's avatar
Linus Torvalds committed

	static struct dm_arg _args[] = {
		{0, 1024, "invalid number of hardware handler args"},
Linus Torvalds's avatar
Linus Torvalds committed
	};

	if (dm_read_arg_group(_args, as, &hw_argc, &ti->error))
Linus Torvalds's avatar
Linus Torvalds committed
		return -EINVAL;

	if (!hw_argc)
		return 0;

	m->hw_handler_name = kstrdup(dm_shift_arg(as), GFP_KERNEL);
	if (!try_then_request_module(scsi_dh_handler_exist(m->hw_handler_name),
				     "scsi_dh_%s", m->hw_handler_name)) {
		ti->error = "unknown hardware handler type";
Linus Torvalds's avatar
Linus Torvalds committed
	}
	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]);
	}
	dm_consume_args(as, hw_argc - 1);
Linus Torvalds's avatar
Linus Torvalds committed

	return 0;
fail:
	kfree(m->hw_handler_name);
	m->hw_handler_name = NULL;
	return ret;
static int parse_features(struct dm_arg_set *as, struct multipath *m)
Linus Torvalds's avatar
Linus Torvalds committed
{
	int r;
	unsigned argc;
	struct dm_target *ti = m->ti;
	const char *arg_name;
Linus Torvalds's avatar
Linus Torvalds committed

	static struct dm_arg _args[] = {
		{0, 6, "invalid number of feature args"},
		{1, 50, "pg_init_retries must be between 1 and 50"},
		{0, 60000, "pg_init_delay_msecs must be between 0 and 60000"},
Linus Torvalds's avatar
Linus Torvalds committed
	};

	r = dm_read_arg_group(_args, as, &argc, &ti->error);
Linus Torvalds's avatar
Linus Torvalds committed
	if (r)
		return -EINVAL;

	if (!argc)
		return 0;

		arg_name = dm_shift_arg(as);
		if (!strcasecmp(arg_name, "queue_if_no_path")) {
			r = queue_if_no_path(m, 1, 0);
			continue;
		}

		if (!strcasecmp(arg_name, "retain_attached_hw_handler")) {
			m->retain_attached_hw_handler = 1;
			continue;
		}

		if (!strcasecmp(arg_name, "pg_init_retries") &&
		    (argc >= 1)) {
			r = dm_read_arg(_args + 1, as, &m->pg_init_retries, &ti->error);
		if (!strcasecmp(arg_name, "pg_init_delay_msecs") &&
			r = dm_read_arg(_args + 2, as, &m->pg_init_delay_msecs, &ti->error);
Linus Torvalds's avatar
Linus Torvalds committed
		ti->error = "Unrecognised multipath feature request";
		r = -EINVAL;
	} while (argc && !r);

	return r;
Linus Torvalds's avatar
Linus Torvalds committed
}

static int multipath_ctr(struct dm_target *ti, unsigned int argc,
			 char **argv)
{
	/* target arguments */
	static struct dm_arg _args[] = {
		{0, 1024, "invalid number of priority groups"},
		{0, 1024, "invalid initial priority group number"},
Linus Torvalds's avatar
Linus Torvalds committed
	};

	int r;
	struct multipath *m;
	struct dm_arg_set as;
Linus Torvalds's avatar
Linus Torvalds committed
	unsigned pg_count = 0;
	unsigned next_pg_num;

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

	m = alloc_multipath(ti);
Linus Torvalds's avatar
Linus Torvalds committed
	if (!m) {
		ti->error = "can't allocate multipath";
Linus Torvalds's avatar
Linus Torvalds committed
		return -EINVAL;
	}

	r = parse_features(&as, m);
Linus Torvalds's avatar
Linus Torvalds committed
	if (r)
		goto bad;

	r = parse_hw_handler(&as, m);
Linus Torvalds's avatar
Linus Torvalds committed
	if (r)
		goto bad;

	r = dm_read_arg(_args, &as, &m->nr_priority_groups, &ti->error);
Linus Torvalds's avatar
Linus Torvalds committed
	if (r)
		goto bad;

	r = dm_read_arg(_args + 1, &as, &next_pg_num, &ti->error);
Linus Torvalds's avatar
Linus Torvalds committed
	if (r)
		goto bad;

	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;
	}

Linus Torvalds's avatar
Linus Torvalds committed
	/* parse the priority groups */
	while (as.argc) {
		struct priority_group *pg;

		pg = parse_priority_group(&as, m);
		if (IS_ERR(pg)) {
			r = PTR_ERR(pg);
Linus Torvalds's avatar
Linus Torvalds committed
			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) {
		ti->error = "priority group count mismatch";
Linus Torvalds's avatar
Linus Torvalds committed
		r = -EINVAL;
		goto bad;
	}

	ti->num_flush_bios = 1;
	ti->num_discard_bios = 1;
	ti->num_write_same_bios = 1;
Linus Torvalds's avatar
Linus Torvalds committed
	return 0;

 bad:
	free_multipath(m);
	return r;
}

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)
Linus Torvalds's avatar
Linus Torvalds committed
{
	unsigned long flags;

	spin_lock_irqsave(&m->lock, flags);
	m->pg_init_disabled = 1;
	spin_unlock_irqrestore(&m->lock, flags);

	multipath_wait_for_pg_init_completion(m);
	flush_work(&m->trigger_event);

	spin_lock_irqsave(&m->lock, flags);
	m->pg_init_disabled = 0;
	spin_unlock_irqrestore(&m->lock, flags);
}

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

	flush_multipath_work(m);
Linus Torvalds's avatar
Linus Torvalds committed
	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);

	if (!pgpath->is_active)
Linus Torvalds's avatar
Linus Torvalds committed
		goto out;

	DMWARN("Failing path %s.", pgpath->path.dev->name);
Linus Torvalds's avatar
Linus Torvalds committed

	pgpath->pg->ps.type->fail_path(&pgpath->pg->ps, &pgpath->path);
	pgpath->is_active = 0;
Linus Torvalds's avatar
Linus Torvalds committed
	pgpath->fail_count++;

	m->nr_valid_paths--;

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

Mike Anderson's avatar
Mike Anderson committed
	dm_path_uevent(DM_UEVENT_PATH_FAILED, m->ti,
		      pgpath->path.dev->name, m->nr_valid_paths);

	schedule_work(&m->trigger_event);
Linus Torvalds's avatar
Linus Torvalds committed

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

	return 0;
}

/*
 * Reinstate a previously-failed path
 */
static int reinstate_path(struct pgpath *pgpath)
{
	int r = 0, run_queue = 0;
Linus Torvalds's avatar
Linus Torvalds committed
	unsigned long flags;
	struct multipath *m = pgpath->pg->m;

	spin_lock_irqsave(&m->lock, flags);

	if (pgpath->is_active)
Linus Torvalds's avatar
Linus Torvalds committed
		goto out;

	if (!pgpath->pg->ps.type->reinstate_path) {
Linus Torvalds's avatar
Linus Torvalds committed
		DMWARN("Reinstate path not supported by path selector %s",
		       pgpath->pg->ps.type->name);
		r = -EINVAL;
		goto out;
	}

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

	pgpath->is_active = 1;
Linus Torvalds's avatar
Linus Torvalds committed

	if (!m->nr_valid_paths++) {
		m->current_pgpath = NULL;
		run_queue = 1;
	} else if (m->hw_handler_name && (m->current_pg == pgpath->pg)) {
		if (queue_work(kmpath_handlerd, &pgpath->activate_path.work))
Linus Torvalds's avatar
Linus Torvalds committed

Mike Anderson's avatar
Mike Anderson committed
	dm_path_uevent(DM_UEVENT_PATH_REINSTATED, m->ti,
		      pgpath->path.dev->name, m->nr_valid_paths);

	schedule_work(&m->trigger_event);
Linus Torvalds's avatar
Linus Torvalds committed

out:
	spin_unlock_irqrestore(&m->lock, flags);
	if (run_queue)
		dm_table_run_md_queue_async(m->ti->table);