xref: /openbmc/linux/drivers/md/dm-mpath.c (revision 022333427a8aa4ccb318a9db90cea4e69ca1826b)
11da177e4SLinus Torvalds /*
21da177e4SLinus Torvalds  * Copyright (C) 2003 Sistina Software Limited.
31da177e4SLinus Torvalds  * Copyright (C) 2004-2005 Red Hat, Inc. All rights reserved.
41da177e4SLinus Torvalds  *
51da177e4SLinus Torvalds  * This file is released under the GPL.
61da177e4SLinus Torvalds  */
71da177e4SLinus Torvalds 
8586e80e6SMikulas Patocka #include <linux/device-mapper.h>
9586e80e6SMikulas Patocka 
10f4790826SMike Snitzer #include "dm.h"
111da177e4SLinus Torvalds #include "dm-path-selector.h"
12b15546f9SMike Anderson #include "dm-uevent.h"
131da177e4SLinus Torvalds 
14e5863d9aSMike Snitzer #include <linux/blkdev.h>
151da177e4SLinus Torvalds #include <linux/ctype.h>
161da177e4SLinus Torvalds #include <linux/init.h>
171da177e4SLinus Torvalds #include <linux/mempool.h>
181da177e4SLinus Torvalds #include <linux/module.h>
191da177e4SLinus Torvalds #include <linux/pagemap.h>
201da177e4SLinus Torvalds #include <linux/slab.h>
211da177e4SLinus Torvalds #include <linux/time.h>
221da177e4SLinus Torvalds #include <linux/workqueue.h>
2335991652SMikulas Patocka #include <linux/delay.h>
24cfae5c9bSChandra Seetharaman #include <scsi/scsi_dh.h>
2560063497SArun Sharma #include <linux/atomic.h>
261da177e4SLinus Torvalds 
2772d94861SAlasdair G Kergon #define DM_MSG_PREFIX "multipath"
284e2d19e4SChandra Seetharaman #define DM_PG_INIT_DELAY_MSECS 2000
294e2d19e4SChandra Seetharaman #define DM_PG_INIT_DELAY_DEFAULT ((unsigned) -1)
301da177e4SLinus Torvalds 
311da177e4SLinus Torvalds /* Path properties */
321da177e4SLinus Torvalds struct pgpath {
331da177e4SLinus Torvalds 	struct list_head list;
341da177e4SLinus Torvalds 
351da177e4SLinus Torvalds 	struct priority_group *pg;	/* Owning PG */
366680073dSKiyoshi Ueda 	unsigned is_active;		/* Path status */
371da177e4SLinus Torvalds 	unsigned fail_count;		/* Cumulative failure count */
381da177e4SLinus Torvalds 
39c922d5f7SJosef "Jeff" Sipek 	struct dm_path path;
404e2d19e4SChandra Seetharaman 	struct delayed_work activate_path;
411da177e4SLinus Torvalds };
421da177e4SLinus Torvalds 
431da177e4SLinus Torvalds #define path_to_pgpath(__pgp) container_of((__pgp), struct pgpath, path)
441da177e4SLinus Torvalds 
451da177e4SLinus Torvalds /*
461da177e4SLinus Torvalds  * Paths are grouped into Priority Groups and numbered from 1 upwards.
471da177e4SLinus Torvalds  * Each has a path selector which controls which path gets used.
481da177e4SLinus Torvalds  */
491da177e4SLinus Torvalds struct priority_group {
501da177e4SLinus Torvalds 	struct list_head list;
511da177e4SLinus Torvalds 
521da177e4SLinus Torvalds 	struct multipath *m;		/* Owning multipath instance */
531da177e4SLinus Torvalds 	struct path_selector ps;
541da177e4SLinus Torvalds 
551da177e4SLinus Torvalds 	unsigned pg_num;		/* Reference number */
561da177e4SLinus Torvalds 	unsigned bypassed;		/* Temporarily bypass this PG? */
571da177e4SLinus Torvalds 
581da177e4SLinus Torvalds 	unsigned nr_pgpaths;		/* Number of paths in PG */
591da177e4SLinus Torvalds 	struct list_head pgpaths;
601da177e4SLinus Torvalds };
611da177e4SLinus Torvalds 
621da177e4SLinus Torvalds /* Multipath context */
631da177e4SLinus Torvalds struct multipath {
641da177e4SLinus Torvalds 	struct list_head list;
651da177e4SLinus Torvalds 	struct dm_target *ti;
661da177e4SLinus Torvalds 
67cfae5c9bSChandra Seetharaman 	const char *hw_handler_name;
682bfd2e13SChandra Seetharaman 	char *hw_handler_params;
694e2d19e4SChandra Seetharaman 
701fbdd2b3SMike Snitzer 	spinlock_t lock;
711fbdd2b3SMike Snitzer 
721da177e4SLinus Torvalds 	unsigned nr_priority_groups;
731da177e4SLinus Torvalds 	struct list_head priority_groups;
744e2d19e4SChandra Seetharaman 
754e2d19e4SChandra Seetharaman 	wait_queue_head_t pg_init_wait;	/* Wait for pg_init completion */
764e2d19e4SChandra Seetharaman 
771da177e4SLinus Torvalds 	unsigned pg_init_required;	/* pg_init needs calling? */
78c3cd4f6bSAlasdair G Kergon 	unsigned pg_init_in_progress;	/* Only one pg_init allowed at once */
794e2d19e4SChandra Seetharaman 	unsigned pg_init_delay_retry;	/* Delay pg_init retry? */
801da177e4SLinus Torvalds 
811da177e4SLinus Torvalds 	unsigned nr_valid_paths;	/* Total number of usable paths */
821da177e4SLinus Torvalds 	struct pgpath *current_pgpath;
831da177e4SLinus Torvalds 	struct priority_group *current_pg;
841da177e4SLinus Torvalds 	struct priority_group *next_pg;	/* Switch to this PG if set */
851da177e4SLinus Torvalds 	unsigned repeat_count;		/* I/Os left before calling PS again */
861da177e4SLinus Torvalds 
871fbdd2b3SMike Snitzer 	unsigned queue_io:1;		/* Must we queue all I/O? */
881fbdd2b3SMike Snitzer 	unsigned queue_if_no_path:1;	/* Queue I/O if last path fails? */
891fbdd2b3SMike Snitzer 	unsigned saved_queue_if_no_path:1; /* Saved state during suspension */
90a58a935dSMike Snitzer 	unsigned retain_attached_hw_handler:1; /* If there's already a hw_handler present, don't change it. */
91954a73d5SShiva Krishna Merla 	unsigned pg_init_disabled:1;	/* pg_init is not currently allowed */
921fbdd2b3SMike Snitzer 
93c9e45581SDave Wysochanski 	unsigned pg_init_retries;	/* Number of times to retry pg_init */
94c9e45581SDave Wysochanski 	unsigned pg_init_count;		/* Number of times pg_init called */
954e2d19e4SChandra Seetharaman 	unsigned pg_init_delay_msecs;	/* Number of msecs before pg_init retry */
961da177e4SLinus Torvalds 
971da177e4SLinus Torvalds 	struct work_struct trigger_event;
981da177e4SLinus Torvalds 
991da177e4SLinus Torvalds 	/*
100028867acSAlasdair G Kergon 	 * We must use a mempool of dm_mpath_io structs so that we
1011da177e4SLinus Torvalds 	 * can resubmit bios on error.
1021da177e4SLinus Torvalds 	 */
1031da177e4SLinus Torvalds 	mempool_t *mpio_pool;
1046380f26fSMike Anderson 
1056380f26fSMike Anderson 	struct mutex work_mutex;
1061da177e4SLinus Torvalds };
1071da177e4SLinus Torvalds 
1081da177e4SLinus Torvalds /*
1091da177e4SLinus Torvalds  * Context information attached to each bio we process.
1101da177e4SLinus Torvalds  */
111028867acSAlasdair G Kergon struct dm_mpath_io {
1121da177e4SLinus Torvalds 	struct pgpath *pgpath;
11302ab823fSKiyoshi Ueda 	size_t nr_bytes;
1141da177e4SLinus Torvalds };
1151da177e4SLinus Torvalds 
1161da177e4SLinus Torvalds typedef int (*action_fn) (struct pgpath *pgpath);
1171da177e4SLinus Torvalds 
118e18b890bSChristoph Lameter static struct kmem_cache *_mpio_cache;
1191da177e4SLinus Torvalds 
120bab7cfc7SChandra Seetharaman static struct workqueue_struct *kmultipathd, *kmpath_handlerd;
121c4028958SDavid Howells static void trigger_event(struct work_struct *work);
122bab7cfc7SChandra Seetharaman static void activate_path(struct work_struct *work);
123e8099177SHannes Reinecke static int __pgpath_busy(struct pgpath *pgpath);
1241da177e4SLinus Torvalds 
1251da177e4SLinus Torvalds 
1261da177e4SLinus Torvalds /*-----------------------------------------------
1271da177e4SLinus Torvalds  * Allocation routines
1281da177e4SLinus Torvalds  *-----------------------------------------------*/
1291da177e4SLinus Torvalds 
1301da177e4SLinus Torvalds static struct pgpath *alloc_pgpath(void)
1311da177e4SLinus Torvalds {
132e69fae56SMicha³ Miros³aw 	struct pgpath *pgpath = kzalloc(sizeof(*pgpath), GFP_KERNEL);
1331da177e4SLinus Torvalds 
134224cb3e9SMike Anderson 	if (pgpath) {
1356680073dSKiyoshi Ueda 		pgpath->is_active = 1;
1364e2d19e4SChandra Seetharaman 		INIT_DELAYED_WORK(&pgpath->activate_path, activate_path);
137224cb3e9SMike Anderson 	}
1381da177e4SLinus Torvalds 
1391da177e4SLinus Torvalds 	return pgpath;
1401da177e4SLinus Torvalds }
1411da177e4SLinus Torvalds 
142028867acSAlasdair G Kergon static void free_pgpath(struct pgpath *pgpath)
1431da177e4SLinus Torvalds {
1441da177e4SLinus Torvalds 	kfree(pgpath);
1451da177e4SLinus Torvalds }
1461da177e4SLinus Torvalds 
1471da177e4SLinus Torvalds static struct priority_group *alloc_priority_group(void)
1481da177e4SLinus Torvalds {
1491da177e4SLinus Torvalds 	struct priority_group *pg;
1501da177e4SLinus Torvalds 
151e69fae56SMicha³ Miros³aw 	pg = kzalloc(sizeof(*pg), GFP_KERNEL);
1521da177e4SLinus Torvalds 
153e69fae56SMicha³ Miros³aw 	if (pg)
1541da177e4SLinus Torvalds 		INIT_LIST_HEAD(&pg->pgpaths);
1551da177e4SLinus Torvalds 
1561da177e4SLinus Torvalds 	return pg;
1571da177e4SLinus Torvalds }
1581da177e4SLinus Torvalds 
1591da177e4SLinus Torvalds static void free_pgpaths(struct list_head *pgpaths, struct dm_target *ti)
1601da177e4SLinus Torvalds {
1611da177e4SLinus Torvalds 	struct pgpath *pgpath, *tmp;
162ae11b1b3SHannes Reinecke 	struct multipath *m = ti->private;
1631da177e4SLinus Torvalds 
1641da177e4SLinus Torvalds 	list_for_each_entry_safe(pgpath, tmp, pgpaths, list) {
1651da177e4SLinus Torvalds 		list_del(&pgpath->list);
166ae11b1b3SHannes Reinecke 		if (m->hw_handler_name)
167ae11b1b3SHannes Reinecke 			scsi_dh_detach(bdev_get_queue(pgpath->path.dev->bdev));
1681da177e4SLinus Torvalds 		dm_put_device(ti, pgpath->path.dev);
1691da177e4SLinus Torvalds 		free_pgpath(pgpath);
1701da177e4SLinus Torvalds 	}
1711da177e4SLinus Torvalds }
1721da177e4SLinus Torvalds 
1731da177e4SLinus Torvalds static void free_priority_group(struct priority_group *pg,
1741da177e4SLinus Torvalds 				struct dm_target *ti)
1751da177e4SLinus Torvalds {
1761da177e4SLinus Torvalds 	struct path_selector *ps = &pg->ps;
1771da177e4SLinus Torvalds 
1781da177e4SLinus Torvalds 	if (ps->type) {
1791da177e4SLinus Torvalds 		ps->type->destroy(ps);
1801da177e4SLinus Torvalds 		dm_put_path_selector(ps->type);
1811da177e4SLinus Torvalds 	}
1821da177e4SLinus Torvalds 
1831da177e4SLinus Torvalds 	free_pgpaths(&pg->pgpaths, ti);
1841da177e4SLinus Torvalds 	kfree(pg);
1851da177e4SLinus Torvalds }
1861da177e4SLinus Torvalds 
18728f16c20SMicha³ Miros³aw static struct multipath *alloc_multipath(struct dm_target *ti)
1881da177e4SLinus Torvalds {
1891da177e4SLinus Torvalds 	struct multipath *m;
190f4790826SMike Snitzer 	unsigned min_ios = dm_get_reserved_rq_based_ios();
1911da177e4SLinus Torvalds 
192e69fae56SMicha³ Miros³aw 	m = kzalloc(sizeof(*m), GFP_KERNEL);
1931da177e4SLinus Torvalds 	if (m) {
1941da177e4SLinus Torvalds 		INIT_LIST_HEAD(&m->priority_groups);
1951da177e4SLinus Torvalds 		spin_lock_init(&m->lock);
1961da177e4SLinus Torvalds 		m->queue_io = 1;
1974e2d19e4SChandra Seetharaman 		m->pg_init_delay_msecs = DM_PG_INIT_DELAY_DEFAULT;
198c4028958SDavid Howells 		INIT_WORK(&m->trigger_event, trigger_event);
1992bded7bdSKiyoshi Ueda 		init_waitqueue_head(&m->pg_init_wait);
2006380f26fSMike Anderson 		mutex_init(&m->work_mutex);
201f4790826SMike Snitzer 		m->mpio_pool = mempool_create_slab_pool(min_ios, _mpio_cache);
2021da177e4SLinus Torvalds 		if (!m->mpio_pool) {
2031da177e4SLinus Torvalds 			kfree(m);
2041da177e4SLinus Torvalds 			return NULL;
2051da177e4SLinus Torvalds 		}
20628f16c20SMicha³ Miros³aw 		m->ti = ti;
20728f16c20SMicha³ Miros³aw 		ti->private = m;
2081da177e4SLinus Torvalds 	}
2091da177e4SLinus Torvalds 
2101da177e4SLinus Torvalds 	return m;
2111da177e4SLinus Torvalds }
2121da177e4SLinus Torvalds 
2131da177e4SLinus Torvalds static void free_multipath(struct multipath *m)
2141da177e4SLinus Torvalds {
2151da177e4SLinus Torvalds 	struct priority_group *pg, *tmp;
2161da177e4SLinus Torvalds 
2171da177e4SLinus Torvalds 	list_for_each_entry_safe(pg, tmp, &m->priority_groups, list) {
2181da177e4SLinus Torvalds 		list_del(&pg->list);
2191da177e4SLinus Torvalds 		free_priority_group(pg, m->ti);
2201da177e4SLinus Torvalds 	}
2211da177e4SLinus Torvalds 
222cfae5c9bSChandra Seetharaman 	kfree(m->hw_handler_name);
2232bfd2e13SChandra Seetharaman 	kfree(m->hw_handler_params);
2241da177e4SLinus Torvalds 	mempool_destroy(m->mpio_pool);
2251da177e4SLinus Torvalds 	kfree(m);
2261da177e4SLinus Torvalds }
2271da177e4SLinus Torvalds 
228466891f9SJun'ichi Nomura static int set_mapinfo(struct multipath *m, union map_info *info)
229466891f9SJun'ichi Nomura {
230466891f9SJun'ichi Nomura 	struct dm_mpath_io *mpio;
231466891f9SJun'ichi Nomura 
232466891f9SJun'ichi Nomura 	mpio = mempool_alloc(m->mpio_pool, GFP_ATOMIC);
233466891f9SJun'ichi Nomura 	if (!mpio)
234466891f9SJun'ichi Nomura 		return -ENOMEM;
235466891f9SJun'ichi Nomura 
236466891f9SJun'ichi Nomura 	memset(mpio, 0, sizeof(*mpio));
237466891f9SJun'ichi Nomura 	info->ptr = mpio;
238466891f9SJun'ichi Nomura 
239466891f9SJun'ichi Nomura 	return 0;
240466891f9SJun'ichi Nomura }
241466891f9SJun'ichi Nomura 
242466891f9SJun'ichi Nomura static void clear_mapinfo(struct multipath *m, union map_info *info)
243466891f9SJun'ichi Nomura {
244466891f9SJun'ichi Nomura 	struct dm_mpath_io *mpio = info->ptr;
245466891f9SJun'ichi Nomura 
246466891f9SJun'ichi Nomura 	info->ptr = NULL;
247466891f9SJun'ichi Nomura 	mempool_free(mpio, m->mpio_pool);
248466891f9SJun'ichi Nomura }
2491da177e4SLinus Torvalds 
2501da177e4SLinus Torvalds /*-----------------------------------------------
2511da177e4SLinus Torvalds  * Path selection
2521da177e4SLinus Torvalds  *-----------------------------------------------*/
2531da177e4SLinus Torvalds 
2543e9f1be1SHannes Reinecke static int __pg_init_all_paths(struct multipath *m)
255fb612642SKiyoshi Ueda {
256fb612642SKiyoshi Ueda 	struct pgpath *pgpath;
2574e2d19e4SChandra Seetharaman 	unsigned long pg_init_delay = 0;
258fb612642SKiyoshi Ueda 
25917f4ff45SHannes Reinecke 	if (m->pg_init_in_progress || m->pg_init_disabled)
2603e9f1be1SHannes Reinecke 		return 0;
26117f4ff45SHannes Reinecke 
262fb612642SKiyoshi Ueda 	m->pg_init_count++;
263fb612642SKiyoshi Ueda 	m->pg_init_required = 0;
2643e9f1be1SHannes Reinecke 
2653e9f1be1SHannes Reinecke 	/* Check here to reset pg_init_required */
2663e9f1be1SHannes Reinecke 	if (!m->current_pg)
2673e9f1be1SHannes Reinecke 		return 0;
2683e9f1be1SHannes Reinecke 
2694e2d19e4SChandra Seetharaman 	if (m->pg_init_delay_retry)
2704e2d19e4SChandra Seetharaman 		pg_init_delay = msecs_to_jiffies(m->pg_init_delay_msecs != DM_PG_INIT_DELAY_DEFAULT ?
2714e2d19e4SChandra Seetharaman 						 m->pg_init_delay_msecs : DM_PG_INIT_DELAY_MSECS);
272fb612642SKiyoshi Ueda 	list_for_each_entry(pgpath, &m->current_pg->pgpaths, list) {
273fb612642SKiyoshi Ueda 		/* Skip failed paths */
274fb612642SKiyoshi Ueda 		if (!pgpath->is_active)
275fb612642SKiyoshi Ueda 			continue;
2764e2d19e4SChandra Seetharaman 		if (queue_delayed_work(kmpath_handlerd, &pgpath->activate_path,
2774e2d19e4SChandra Seetharaman 				       pg_init_delay))
278fb612642SKiyoshi Ueda 			m->pg_init_in_progress++;
279fb612642SKiyoshi Ueda 	}
2803e9f1be1SHannes Reinecke 	return m->pg_init_in_progress;
281fb612642SKiyoshi Ueda }
282fb612642SKiyoshi Ueda 
2831da177e4SLinus Torvalds static void __switch_pg(struct multipath *m, struct pgpath *pgpath)
2841da177e4SLinus Torvalds {
2851da177e4SLinus Torvalds 	m->current_pg = pgpath->pg;
2861da177e4SLinus Torvalds 
2871da177e4SLinus Torvalds 	/* Must we initialise the PG first, and queue I/O till it's ready? */
288cfae5c9bSChandra Seetharaman 	if (m->hw_handler_name) {
2891da177e4SLinus Torvalds 		m->pg_init_required = 1;
2901da177e4SLinus Torvalds 		m->queue_io = 1;
2911da177e4SLinus Torvalds 	} else {
2921da177e4SLinus Torvalds 		m->pg_init_required = 0;
2931da177e4SLinus Torvalds 		m->queue_io = 0;
2941da177e4SLinus Torvalds 	}
295c9e45581SDave Wysochanski 
296c9e45581SDave Wysochanski 	m->pg_init_count = 0;
2971da177e4SLinus Torvalds }
2981da177e4SLinus Torvalds 
29902ab823fSKiyoshi Ueda static int __choose_path_in_pg(struct multipath *m, struct priority_group *pg,
30002ab823fSKiyoshi Ueda 			       size_t nr_bytes)
3011da177e4SLinus Torvalds {
302c922d5f7SJosef "Jeff" Sipek 	struct dm_path *path;
3031da177e4SLinus Torvalds 
30402ab823fSKiyoshi Ueda 	path = pg->ps.type->select_path(&pg->ps, &m->repeat_count, nr_bytes);
3051da177e4SLinus Torvalds 	if (!path)
3061da177e4SLinus Torvalds 		return -ENXIO;
3071da177e4SLinus Torvalds 
3081da177e4SLinus Torvalds 	m->current_pgpath = path_to_pgpath(path);
3091da177e4SLinus Torvalds 
3101da177e4SLinus Torvalds 	if (m->current_pg != pg)
3111da177e4SLinus Torvalds 		__switch_pg(m, m->current_pgpath);
3121da177e4SLinus Torvalds 
3131da177e4SLinus Torvalds 	return 0;
3141da177e4SLinus Torvalds }
3151da177e4SLinus Torvalds 
31602ab823fSKiyoshi Ueda static void __choose_pgpath(struct multipath *m, size_t nr_bytes)
3171da177e4SLinus Torvalds {
3181da177e4SLinus Torvalds 	struct priority_group *pg;
3191da177e4SLinus Torvalds 	unsigned bypassed = 1;
3201da177e4SLinus Torvalds 
3211f271972SBenjamin Marzinski 	if (!m->nr_valid_paths) {
3221f271972SBenjamin Marzinski 		m->queue_io = 0;
3231da177e4SLinus Torvalds 		goto failed;
3241f271972SBenjamin Marzinski 	}
3251da177e4SLinus Torvalds 
3261da177e4SLinus Torvalds 	/* Were we instructed to switch PG? */
3271da177e4SLinus Torvalds 	if (m->next_pg) {
3281da177e4SLinus Torvalds 		pg = m->next_pg;
3291da177e4SLinus Torvalds 		m->next_pg = NULL;
33002ab823fSKiyoshi Ueda 		if (!__choose_path_in_pg(m, pg, nr_bytes))
3311da177e4SLinus Torvalds 			return;
3321da177e4SLinus Torvalds 	}
3331da177e4SLinus Torvalds 
3341da177e4SLinus Torvalds 	/* Don't change PG until it has no remaining paths */
33502ab823fSKiyoshi Ueda 	if (m->current_pg && !__choose_path_in_pg(m, m->current_pg, nr_bytes))
3361da177e4SLinus Torvalds 		return;
3371da177e4SLinus Torvalds 
3381da177e4SLinus Torvalds 	/*
3391da177e4SLinus Torvalds 	 * Loop through priority groups until we find a valid path.
3401da177e4SLinus Torvalds 	 * First time we skip PGs marked 'bypassed'.
341f220fd4eSMike Christie 	 * Second time we only try the ones we skipped, but set
342f220fd4eSMike Christie 	 * pg_init_delay_retry so we do not hammer controllers.
3431da177e4SLinus Torvalds 	 */
3441da177e4SLinus Torvalds 	do {
3451da177e4SLinus Torvalds 		list_for_each_entry(pg, &m->priority_groups, list) {
3461da177e4SLinus Torvalds 			if (pg->bypassed == bypassed)
3471da177e4SLinus Torvalds 				continue;
348f220fd4eSMike Christie 			if (!__choose_path_in_pg(m, pg, nr_bytes)) {
349f220fd4eSMike Christie 				if (!bypassed)
350f220fd4eSMike Christie 					m->pg_init_delay_retry = 1;
3511da177e4SLinus Torvalds 				return;
3521da177e4SLinus Torvalds 			}
353f220fd4eSMike Christie 		}
3541da177e4SLinus Torvalds 	} while (bypassed--);
3551da177e4SLinus Torvalds 
3561da177e4SLinus Torvalds failed:
3571da177e4SLinus Torvalds 	m->current_pgpath = NULL;
3581da177e4SLinus Torvalds 	m->current_pg = NULL;
3591da177e4SLinus Torvalds }
3601da177e4SLinus Torvalds 
36145e15720SKiyoshi Ueda /*
36245e15720SKiyoshi Ueda  * Check whether bios must be queued in the device-mapper core rather
36345e15720SKiyoshi Ueda  * than here in the target.
36445e15720SKiyoshi Ueda  *
36545e15720SKiyoshi Ueda  * m->lock must be held on entry.
36645e15720SKiyoshi Ueda  *
36745e15720SKiyoshi Ueda  * If m->queue_if_no_path and m->saved_queue_if_no_path hold the
36845e15720SKiyoshi Ueda  * same value then we are not between multipath_presuspend()
36945e15720SKiyoshi Ueda  * and multipath_resume() calls and we have no need to check
37045e15720SKiyoshi Ueda  * for the DMF_NOFLUSH_SUSPENDING flag.
37145e15720SKiyoshi Ueda  */
37245e15720SKiyoshi Ueda static int __must_push_back(struct multipath *m)
37345e15720SKiyoshi Ueda {
374e8099177SHannes Reinecke 	return (m->queue_if_no_path ||
375e8099177SHannes Reinecke 		(m->queue_if_no_path != m->saved_queue_if_no_path &&
376e8099177SHannes Reinecke 		 dm_noflush_suspending(m->ti)));
37745e15720SKiyoshi Ueda }
37845e15720SKiyoshi Ueda 
37936fcffccSHannes Reinecke /*
38036fcffccSHannes Reinecke  * Map cloned requests
38136fcffccSHannes Reinecke  */
382e5863d9aSMike Snitzer static int __multipath_map(struct dm_target *ti, struct request *clone,
383e5863d9aSMike Snitzer 			   union map_info *map_context,
384e5863d9aSMike Snitzer 			   struct request *rq, struct request **__clone)
3851da177e4SLinus Torvalds {
38636fcffccSHannes Reinecke 	struct multipath *m = (struct multipath *) ti->private;
387e3bde04fSHannes Reinecke 	int r = DM_MAPIO_REQUEUE;
388e5863d9aSMike Snitzer 	size_t nr_bytes = clone ? blk_rq_bytes(clone) : blk_rq_bytes(rq);
3891da177e4SLinus Torvalds 	struct pgpath *pgpath;
390f40c67f0SKiyoshi Ueda 	struct block_device *bdev;
391e3bde04fSHannes Reinecke 	struct dm_mpath_io *mpio;
3921da177e4SLinus Torvalds 
3932eb6e1e3SKeith Busch 	spin_lock_irq(&m->lock);
3941da177e4SLinus Torvalds 
3951da177e4SLinus Torvalds 	/* Do we need to select a new pgpath? */
3961da177e4SLinus Torvalds 	if (!m->current_pgpath ||
3971da177e4SLinus Torvalds 	    (!m->queue_io && (m->repeat_count && --m->repeat_count == 0)))
39802ab823fSKiyoshi Ueda 		__choose_pgpath(m, nr_bytes);
3991da177e4SLinus Torvalds 
4001da177e4SLinus Torvalds 	pgpath = m->current_pgpath;
4011da177e4SLinus Torvalds 
4029bf59a61SMike Snitzer 	if (!pgpath) {
4039bf59a61SMike Snitzer 		if (!__must_push_back(m))
4049bf59a61SMike Snitzer 			r = -EIO;	/* Failed */
4059bf59a61SMike Snitzer 		goto out_unlock;
4066afbc01dSMike Snitzer 	} else if (m->queue_io || m->pg_init_required) {
4079bf59a61SMike Snitzer 		__pg_init_all_paths(m);
4089bf59a61SMike Snitzer 		goto out_unlock;
4099bf59a61SMike Snitzer 	}
4106afbc01dSMike Snitzer 
411e3bde04fSHannes Reinecke 	if (set_mapinfo(m, map_context) < 0)
412e3bde04fSHannes Reinecke 		/* ENOMEM, requeue */
413e3bde04fSHannes Reinecke 		goto out_unlock;
414e3bde04fSHannes Reinecke 
415e3bde04fSHannes Reinecke 	mpio = map_context->ptr;
416e8099177SHannes Reinecke 	mpio->pgpath = pgpath;
417e8099177SHannes Reinecke 	mpio->nr_bytes = nr_bytes;
4182eb6e1e3SKeith Busch 
4192eb6e1e3SKeith Busch 	bdev = pgpath->path.dev->bdev;
4202eb6e1e3SKeith Busch 
421e5863d9aSMike Snitzer 	spin_unlock_irq(&m->lock);
422e5863d9aSMike Snitzer 
423e5863d9aSMike Snitzer 	if (clone) {
424e5863d9aSMike Snitzer 		/* Old request-based interface: allocated clone is passed in */
4252eb6e1e3SKeith Busch 		clone->q = bdev_get_queue(bdev);
4262eb6e1e3SKeith Busch 		clone->rq_disk = bdev->bd_disk;
4272eb6e1e3SKeith Busch 		clone->cmd_flags |= REQ_FAILFAST_TRANSPORT;
428e5863d9aSMike Snitzer 	} else {
429e5863d9aSMike Snitzer 		/* blk-mq request-based interface */
430e5863d9aSMike Snitzer 		*__clone = blk_get_request(bdev_get_queue(bdev),
431*02233342SMike Snitzer 					   rq_data_dir(rq), GFP_ATOMIC);
432e5863d9aSMike Snitzer 		if (IS_ERR(*__clone))
433e5863d9aSMike Snitzer 			/* ENOMEM, requeue */
434e5863d9aSMike Snitzer 			return r;
435e5863d9aSMike Snitzer 		(*__clone)->bio = (*__clone)->biotail = NULL;
436e5863d9aSMike Snitzer 		(*__clone)->rq_disk = bdev->bd_disk;
437e5863d9aSMike Snitzer 		(*__clone)->cmd_flags |= REQ_FAILFAST_TRANSPORT;
438e5863d9aSMike Snitzer 	}
4392eb6e1e3SKeith Busch 
440e8099177SHannes Reinecke 	if (pgpath->pg->ps.type->start_io)
441e8099177SHannes Reinecke 		pgpath->pg->ps.type->start_io(&pgpath->pg->ps,
442e8099177SHannes Reinecke 					      &pgpath->path,
443e8099177SHannes Reinecke 					      nr_bytes);
4442eb6e1e3SKeith Busch 	return DM_MAPIO_REMAPPED;
4451da177e4SLinus Torvalds 
446e3bde04fSHannes Reinecke out_unlock:
4472eb6e1e3SKeith Busch 	spin_unlock_irq(&m->lock);
4481da177e4SLinus Torvalds 
4491da177e4SLinus Torvalds 	return r;
4501da177e4SLinus Torvalds }
4511da177e4SLinus Torvalds 
452e5863d9aSMike Snitzer static int multipath_map(struct dm_target *ti, struct request *clone,
453e5863d9aSMike Snitzer 			 union map_info *map_context)
454e5863d9aSMike Snitzer {
455e5863d9aSMike Snitzer 	return __multipath_map(ti, clone, map_context, NULL, NULL);
456e5863d9aSMike Snitzer }
457e5863d9aSMike Snitzer 
458e5863d9aSMike Snitzer static int multipath_clone_and_map(struct dm_target *ti, struct request *rq,
459e5863d9aSMike Snitzer 				   union map_info *map_context,
460e5863d9aSMike Snitzer 				   struct request **clone)
461e5863d9aSMike Snitzer {
462e5863d9aSMike Snitzer 	return __multipath_map(ti, NULL, map_context, rq, clone);
463e5863d9aSMike Snitzer }
464e5863d9aSMike Snitzer 
465e5863d9aSMike Snitzer static void multipath_release_clone(struct request *clone)
466e5863d9aSMike Snitzer {
467e5863d9aSMike Snitzer 	blk_put_request(clone);
468e5863d9aSMike Snitzer }
469e5863d9aSMike Snitzer 
4701da177e4SLinus Torvalds /*
4711da177e4SLinus Torvalds  * If we run out of usable paths, should we queue I/O or error it?
4721da177e4SLinus Torvalds  */
473485ef69eSAlasdair G Kergon static int queue_if_no_path(struct multipath *m, unsigned queue_if_no_path,
474485ef69eSAlasdair G Kergon 			    unsigned save_old_value)
4751da177e4SLinus Torvalds {
4761da177e4SLinus Torvalds 	unsigned long flags;
4771da177e4SLinus Torvalds 
4781da177e4SLinus Torvalds 	spin_lock_irqsave(&m->lock, flags);
4791da177e4SLinus Torvalds 
480485ef69eSAlasdair G Kergon 	if (save_old_value)
481436d4108SAlasdair G Kergon 		m->saved_queue_if_no_path = m->queue_if_no_path;
482485ef69eSAlasdair G Kergon 	else
483485ef69eSAlasdair G Kergon 		m->saved_queue_if_no_path = queue_if_no_path;
4841da177e4SLinus Torvalds 	m->queue_if_no_path = queue_if_no_path;
4851da177e4SLinus Torvalds 	spin_unlock_irqrestore(&m->lock, flags);
4861da177e4SLinus Torvalds 
48763d832c3SHannes Reinecke 	if (!queue_if_no_path)
48863d832c3SHannes Reinecke 		dm_table_run_md_queue_async(m->ti->table);
48963d832c3SHannes Reinecke 
4901da177e4SLinus Torvalds 	return 0;
4911da177e4SLinus Torvalds }
4921da177e4SLinus Torvalds 
4931da177e4SLinus Torvalds /*
4941da177e4SLinus Torvalds  * An event is triggered whenever a path is taken out of use.
4951da177e4SLinus Torvalds  * Includes path failure and PG bypass.
4961da177e4SLinus Torvalds  */
497c4028958SDavid Howells static void trigger_event(struct work_struct *work)
4981da177e4SLinus Torvalds {
499c4028958SDavid Howells 	struct multipath *m =
500c4028958SDavid Howells 		container_of(work, struct multipath, trigger_event);
5011da177e4SLinus Torvalds 
5021da177e4SLinus Torvalds 	dm_table_event(m->ti->table);
5031da177e4SLinus Torvalds }
5041da177e4SLinus Torvalds 
5051da177e4SLinus Torvalds /*-----------------------------------------------------------------
5061da177e4SLinus Torvalds  * Constructor/argument parsing:
5071da177e4SLinus Torvalds  * <#multipath feature args> [<arg>]*
5081da177e4SLinus Torvalds  * <#hw_handler args> [hw_handler [<arg>]*]
5091da177e4SLinus Torvalds  * <#priority groups>
5101da177e4SLinus Torvalds  * <initial priority group>
5111da177e4SLinus Torvalds  *     [<selector> <#selector args> [<arg>]*
5121da177e4SLinus Torvalds  *      <#paths> <#per-path selector args>
5131da177e4SLinus Torvalds  *         [<path> [<arg>]* ]+ ]+
5141da177e4SLinus Torvalds  *---------------------------------------------------------------*/
515498f0103SMike Snitzer static int parse_path_selector(struct dm_arg_set *as, struct priority_group *pg,
5161da177e4SLinus Torvalds 			       struct dm_target *ti)
5171da177e4SLinus Torvalds {
5181da177e4SLinus Torvalds 	int r;
5191da177e4SLinus Torvalds 	struct path_selector_type *pst;
5201da177e4SLinus Torvalds 	unsigned ps_argc;
5211da177e4SLinus Torvalds 
522498f0103SMike Snitzer 	static struct dm_arg _args[] = {
52372d94861SAlasdair G Kergon 		{0, 1024, "invalid number of path selector args"},
5241da177e4SLinus Torvalds 	};
5251da177e4SLinus Torvalds 
526498f0103SMike Snitzer 	pst = dm_get_path_selector(dm_shift_arg(as));
5271da177e4SLinus Torvalds 	if (!pst) {
52872d94861SAlasdair G Kergon 		ti->error = "unknown path selector type";
5291da177e4SLinus Torvalds 		return -EINVAL;
5301da177e4SLinus Torvalds 	}
5311da177e4SLinus Torvalds 
532498f0103SMike Snitzer 	r = dm_read_arg_group(_args, as, &ps_argc, &ti->error);
533371b2e34SMikulas Patocka 	if (r) {
534371b2e34SMikulas Patocka 		dm_put_path_selector(pst);
5351da177e4SLinus Torvalds 		return -EINVAL;
536371b2e34SMikulas Patocka 	}
5371da177e4SLinus Torvalds 
5381da177e4SLinus Torvalds 	r = pst->create(&pg->ps, ps_argc, as->argv);
5391da177e4SLinus Torvalds 	if (r) {
5401da177e4SLinus Torvalds 		dm_put_path_selector(pst);
54172d94861SAlasdair G Kergon 		ti->error = "path selector constructor failed";
5421da177e4SLinus Torvalds 		return r;
5431da177e4SLinus Torvalds 	}
5441da177e4SLinus Torvalds 
5451da177e4SLinus Torvalds 	pg->ps.type = pst;
546498f0103SMike Snitzer 	dm_consume_args(as, ps_argc);
5471da177e4SLinus Torvalds 
5481da177e4SLinus Torvalds 	return 0;
5491da177e4SLinus Torvalds }
5501da177e4SLinus Torvalds 
551498f0103SMike Snitzer static struct pgpath *parse_path(struct dm_arg_set *as, struct path_selector *ps,
5521da177e4SLinus Torvalds 			       struct dm_target *ti)
5531da177e4SLinus Torvalds {
5541da177e4SLinus Torvalds 	int r;
5551da177e4SLinus Torvalds 	struct pgpath *p;
556ae11b1b3SHannes Reinecke 	struct multipath *m = ti->private;
557a58a935dSMike Snitzer 	struct request_queue *q = NULL;
558a58a935dSMike Snitzer 	const char *attached_handler_name;
5591da177e4SLinus Torvalds 
5601da177e4SLinus Torvalds 	/* we need at least a path arg */
5611da177e4SLinus Torvalds 	if (as->argc < 1) {
56272d94861SAlasdair G Kergon 		ti->error = "no device given";
56301460f35SBenjamin Marzinski 		return ERR_PTR(-EINVAL);
5641da177e4SLinus Torvalds 	}
5651da177e4SLinus Torvalds 
5661da177e4SLinus Torvalds 	p = alloc_pgpath();
5671da177e4SLinus Torvalds 	if (!p)
56801460f35SBenjamin Marzinski 		return ERR_PTR(-ENOMEM);
5691da177e4SLinus Torvalds 
570498f0103SMike Snitzer 	r = dm_get_device(ti, dm_shift_arg(as), dm_table_get_mode(ti->table),
5718215d6ecSNikanth Karthikesan 			  &p->path.dev);
5721da177e4SLinus Torvalds 	if (r) {
57372d94861SAlasdair G Kergon 		ti->error = "error getting device";
5741da177e4SLinus Torvalds 		goto bad;
5751da177e4SLinus Torvalds 	}
5761da177e4SLinus Torvalds 
577a58a935dSMike Snitzer 	if (m->retain_attached_hw_handler || m->hw_handler_name)
578a58a935dSMike Snitzer 		q = bdev_get_queue(p->path.dev->bdev);
579a0cf7ea9SHannes Reinecke 
580a58a935dSMike Snitzer 	if (m->retain_attached_hw_handler) {
581a58a935dSMike Snitzer 		attached_handler_name = scsi_dh_attached_handler_name(q, GFP_KERNEL);
582a58a935dSMike Snitzer 		if (attached_handler_name) {
583a58a935dSMike Snitzer 			/*
584a58a935dSMike Snitzer 			 * Reset hw_handler_name to match the attached handler
585a58a935dSMike Snitzer 			 * and clear any hw_handler_params associated with the
586a58a935dSMike Snitzer 			 * ignored handler.
587a58a935dSMike Snitzer 			 *
588a58a935dSMike Snitzer 			 * NB. This modifies the table line to show the actual
589a58a935dSMike Snitzer 			 * handler instead of the original table passed in.
590a58a935dSMike Snitzer 			 */
591a58a935dSMike Snitzer 			kfree(m->hw_handler_name);
592a58a935dSMike Snitzer 			m->hw_handler_name = attached_handler_name;
593a58a935dSMike Snitzer 
594a58a935dSMike Snitzer 			kfree(m->hw_handler_params);
595a58a935dSMike Snitzer 			m->hw_handler_params = NULL;
596a58a935dSMike Snitzer 		}
597a58a935dSMike Snitzer 	}
598a58a935dSMike Snitzer 
599a58a935dSMike Snitzer 	if (m->hw_handler_name) {
600a58a935dSMike Snitzer 		/*
601a58a935dSMike Snitzer 		 * Increments scsi_dh reference, even when using an
602a58a935dSMike Snitzer 		 * already-attached handler.
603a58a935dSMike Snitzer 		 */
604a0cf7ea9SHannes Reinecke 		r = scsi_dh_attach(q, m->hw_handler_name);
605a0cf7ea9SHannes Reinecke 		if (r == -EBUSY) {
606a0cf7ea9SHannes Reinecke 			/*
607a58a935dSMike Snitzer 			 * Already attached to different hw_handler:
608a0cf7ea9SHannes Reinecke 			 * try to reattach with correct one.
609a0cf7ea9SHannes Reinecke 			 */
610a0cf7ea9SHannes Reinecke 			scsi_dh_detach(q);
611a0cf7ea9SHannes Reinecke 			r = scsi_dh_attach(q, m->hw_handler_name);
612a0cf7ea9SHannes Reinecke 		}
613a0cf7ea9SHannes Reinecke 
614ae11b1b3SHannes Reinecke 		if (r < 0) {
615a0cf7ea9SHannes Reinecke 			ti->error = "error attaching hardware handler";
616ae11b1b3SHannes Reinecke 			dm_put_device(ti, p->path.dev);
617ae11b1b3SHannes Reinecke 			goto bad;
618ae11b1b3SHannes Reinecke 		}
6192bfd2e13SChandra Seetharaman 
6202bfd2e13SChandra Seetharaman 		if (m->hw_handler_params) {
6212bfd2e13SChandra Seetharaman 			r = scsi_dh_set_params(q, m->hw_handler_params);
6222bfd2e13SChandra Seetharaman 			if (r < 0) {
6232bfd2e13SChandra Seetharaman 				ti->error = "unable to set hardware "
6242bfd2e13SChandra Seetharaman 							"handler parameters";
6252bfd2e13SChandra Seetharaman 				scsi_dh_detach(q);
6262bfd2e13SChandra Seetharaman 				dm_put_device(ti, p->path.dev);
6272bfd2e13SChandra Seetharaman 				goto bad;
6282bfd2e13SChandra Seetharaman 			}
6292bfd2e13SChandra Seetharaman 		}
630ae11b1b3SHannes Reinecke 	}
631ae11b1b3SHannes Reinecke 
6321da177e4SLinus Torvalds 	r = ps->type->add_path(ps, &p->path, as->argc, as->argv, &ti->error);
6331da177e4SLinus Torvalds 	if (r) {
6341da177e4SLinus Torvalds 		dm_put_device(ti, p->path.dev);
6351da177e4SLinus Torvalds 		goto bad;
6361da177e4SLinus Torvalds 	}
6371da177e4SLinus Torvalds 
6381da177e4SLinus Torvalds 	return p;
6391da177e4SLinus Torvalds 
6401da177e4SLinus Torvalds  bad:
6411da177e4SLinus Torvalds 	free_pgpath(p);
64201460f35SBenjamin Marzinski 	return ERR_PTR(r);
6431da177e4SLinus Torvalds }
6441da177e4SLinus Torvalds 
645498f0103SMike Snitzer static struct priority_group *parse_priority_group(struct dm_arg_set *as,
64628f16c20SMicha³ Miros³aw 						   struct multipath *m)
6471da177e4SLinus Torvalds {
648498f0103SMike Snitzer 	static struct dm_arg _args[] = {
64972d94861SAlasdair G Kergon 		{1, 1024, "invalid number of paths"},
65072d94861SAlasdair G Kergon 		{0, 1024, "invalid number of selector args"}
6511da177e4SLinus Torvalds 	};
6521da177e4SLinus Torvalds 
6531da177e4SLinus Torvalds 	int r;
654498f0103SMike Snitzer 	unsigned i, nr_selector_args, nr_args;
6551da177e4SLinus Torvalds 	struct priority_group *pg;
65628f16c20SMicha³ Miros³aw 	struct dm_target *ti = m->ti;
6571da177e4SLinus Torvalds 
6581da177e4SLinus Torvalds 	if (as->argc < 2) {
6591da177e4SLinus Torvalds 		as->argc = 0;
66001460f35SBenjamin Marzinski 		ti->error = "not enough priority group arguments";
66101460f35SBenjamin Marzinski 		return ERR_PTR(-EINVAL);
6621da177e4SLinus Torvalds 	}
6631da177e4SLinus Torvalds 
6641da177e4SLinus Torvalds 	pg = alloc_priority_group();
6651da177e4SLinus Torvalds 	if (!pg) {
66672d94861SAlasdair G Kergon 		ti->error = "couldn't allocate priority group";
66701460f35SBenjamin Marzinski 		return ERR_PTR(-ENOMEM);
6681da177e4SLinus Torvalds 	}
6691da177e4SLinus Torvalds 	pg->m = m;
6701da177e4SLinus Torvalds 
6711da177e4SLinus Torvalds 	r = parse_path_selector(as, pg, ti);
6721da177e4SLinus Torvalds 	if (r)
6731da177e4SLinus Torvalds 		goto bad;
6741da177e4SLinus Torvalds 
6751da177e4SLinus Torvalds 	/*
6761da177e4SLinus Torvalds 	 * read the paths
6771da177e4SLinus Torvalds 	 */
678498f0103SMike Snitzer 	r = dm_read_arg(_args, as, &pg->nr_pgpaths, &ti->error);
6791da177e4SLinus Torvalds 	if (r)
6801da177e4SLinus Torvalds 		goto bad;
6811da177e4SLinus Torvalds 
682498f0103SMike Snitzer 	r = dm_read_arg(_args + 1, as, &nr_selector_args, &ti->error);
6831da177e4SLinus Torvalds 	if (r)
6841da177e4SLinus Torvalds 		goto bad;
6851da177e4SLinus Torvalds 
686498f0103SMike Snitzer 	nr_args = 1 + nr_selector_args;
6871da177e4SLinus Torvalds 	for (i = 0; i < pg->nr_pgpaths; i++) {
6881da177e4SLinus Torvalds 		struct pgpath *pgpath;
689498f0103SMike Snitzer 		struct dm_arg_set path_args;
6901da177e4SLinus Torvalds 
691498f0103SMike Snitzer 		if (as->argc < nr_args) {
692148acff6SMikulas Patocka 			ti->error = "not enough path parameters";
6936bbf79a1SAlasdair G Kergon 			r = -EINVAL;
6941da177e4SLinus Torvalds 			goto bad;
695148acff6SMikulas Patocka 		}
6961da177e4SLinus Torvalds 
697498f0103SMike Snitzer 		path_args.argc = nr_args;
6981da177e4SLinus Torvalds 		path_args.argv = as->argv;
6991da177e4SLinus Torvalds 
7001da177e4SLinus Torvalds 		pgpath = parse_path(&path_args, &pg->ps, ti);
70101460f35SBenjamin Marzinski 		if (IS_ERR(pgpath)) {
70201460f35SBenjamin Marzinski 			r = PTR_ERR(pgpath);
7031da177e4SLinus Torvalds 			goto bad;
70401460f35SBenjamin Marzinski 		}
7051da177e4SLinus Torvalds 
7061da177e4SLinus Torvalds 		pgpath->pg = pg;
7071da177e4SLinus Torvalds 		list_add_tail(&pgpath->list, &pg->pgpaths);
708498f0103SMike Snitzer 		dm_consume_args(as, nr_args);
7091da177e4SLinus Torvalds 	}
7101da177e4SLinus Torvalds 
7111da177e4SLinus Torvalds 	return pg;
7121da177e4SLinus Torvalds 
7131da177e4SLinus Torvalds  bad:
7141da177e4SLinus Torvalds 	free_priority_group(pg, ti);
71501460f35SBenjamin Marzinski 	return ERR_PTR(r);
7161da177e4SLinus Torvalds }
7171da177e4SLinus Torvalds 
718498f0103SMike Snitzer static int parse_hw_handler(struct dm_arg_set *as, struct multipath *m)
7191da177e4SLinus Torvalds {
7201da177e4SLinus Torvalds 	unsigned hw_argc;
7212bfd2e13SChandra Seetharaman 	int ret;
72228f16c20SMicha³ Miros³aw 	struct dm_target *ti = m->ti;
7231da177e4SLinus Torvalds 
724498f0103SMike Snitzer 	static struct dm_arg _args[] = {
72572d94861SAlasdair G Kergon 		{0, 1024, "invalid number of hardware handler args"},
7261da177e4SLinus Torvalds 	};
7271da177e4SLinus Torvalds 
728498f0103SMike Snitzer 	if (dm_read_arg_group(_args, as, &hw_argc, &ti->error))
7291da177e4SLinus Torvalds 		return -EINVAL;
7301da177e4SLinus Torvalds 
7311da177e4SLinus Torvalds 	if (!hw_argc)
7321da177e4SLinus Torvalds 		return 0;
7331da177e4SLinus Torvalds 
734498f0103SMike Snitzer 	m->hw_handler_name = kstrdup(dm_shift_arg(as), GFP_KERNEL);
735510193a2SMike Snitzer 	if (!try_then_request_module(scsi_dh_handler_exist(m->hw_handler_name),
736510193a2SMike Snitzer 				     "scsi_dh_%s", m->hw_handler_name)) {
73772d94861SAlasdair G Kergon 		ti->error = "unknown hardware handler type";
7382bfd2e13SChandra Seetharaman 		ret = -EINVAL;
7392bfd2e13SChandra Seetharaman 		goto fail;
7401da177e4SLinus Torvalds 	}
74114e98c5cSChandra Seetharaman 
7422bfd2e13SChandra Seetharaman 	if (hw_argc > 1) {
7432bfd2e13SChandra Seetharaman 		char *p;
7442bfd2e13SChandra Seetharaman 		int i, j, len = 4;
7452bfd2e13SChandra Seetharaman 
7462bfd2e13SChandra Seetharaman 		for (i = 0; i <= hw_argc - 2; i++)
7472bfd2e13SChandra Seetharaman 			len += strlen(as->argv[i]) + 1;
7482bfd2e13SChandra Seetharaman 		p = m->hw_handler_params = kzalloc(len, GFP_KERNEL);
7492bfd2e13SChandra Seetharaman 		if (!p) {
7502bfd2e13SChandra Seetharaman 			ti->error = "memory allocation failed";
7512bfd2e13SChandra Seetharaman 			ret = -ENOMEM;
7522bfd2e13SChandra Seetharaman 			goto fail;
7532bfd2e13SChandra Seetharaman 		}
7542bfd2e13SChandra Seetharaman 		j = sprintf(p, "%d", hw_argc - 1);
7552bfd2e13SChandra Seetharaman 		for (i = 0, p+=j+1; i <= hw_argc - 2; i++, p+=j+1)
7562bfd2e13SChandra Seetharaman 			j = sprintf(p, "%s", as->argv[i]);
7572bfd2e13SChandra Seetharaman 	}
758498f0103SMike Snitzer 	dm_consume_args(as, hw_argc - 1);
7591da177e4SLinus Torvalds 
7601da177e4SLinus Torvalds 	return 0;
7612bfd2e13SChandra Seetharaman fail:
7622bfd2e13SChandra Seetharaman 	kfree(m->hw_handler_name);
7632bfd2e13SChandra Seetharaman 	m->hw_handler_name = NULL;
7642bfd2e13SChandra Seetharaman 	return ret;
7651da177e4SLinus Torvalds }
7661da177e4SLinus Torvalds 
767498f0103SMike Snitzer static int parse_features(struct dm_arg_set *as, struct multipath *m)
7681da177e4SLinus Torvalds {
7691da177e4SLinus Torvalds 	int r;
7701da177e4SLinus Torvalds 	unsigned argc;
77128f16c20SMicha³ Miros³aw 	struct dm_target *ti = m->ti;
772498f0103SMike Snitzer 	const char *arg_name;
7731da177e4SLinus Torvalds 
774498f0103SMike Snitzer 	static struct dm_arg _args[] = {
775a58a935dSMike Snitzer 		{0, 6, "invalid number of feature args"},
776c9e45581SDave Wysochanski 		{1, 50, "pg_init_retries must be between 1 and 50"},
7774e2d19e4SChandra Seetharaman 		{0, 60000, "pg_init_delay_msecs must be between 0 and 60000"},
7781da177e4SLinus Torvalds 	};
7791da177e4SLinus Torvalds 
780498f0103SMike Snitzer 	r = dm_read_arg_group(_args, as, &argc, &ti->error);
7811da177e4SLinus Torvalds 	if (r)
7821da177e4SLinus Torvalds 		return -EINVAL;
7831da177e4SLinus Torvalds 
7841da177e4SLinus Torvalds 	if (!argc)
7851da177e4SLinus Torvalds 		return 0;
7861da177e4SLinus Torvalds 
787c9e45581SDave Wysochanski 	do {
788498f0103SMike Snitzer 		arg_name = dm_shift_arg(as);
789c9e45581SDave Wysochanski 		argc--;
790c9e45581SDave Wysochanski 
791498f0103SMike Snitzer 		if (!strcasecmp(arg_name, "queue_if_no_path")) {
792c9e45581SDave Wysochanski 			r = queue_if_no_path(m, 1, 0);
793c9e45581SDave Wysochanski 			continue;
7941da177e4SLinus Torvalds 		}
795c9e45581SDave Wysochanski 
796a58a935dSMike Snitzer 		if (!strcasecmp(arg_name, "retain_attached_hw_handler")) {
797a58a935dSMike Snitzer 			m->retain_attached_hw_handler = 1;
798a58a935dSMike Snitzer 			continue;
799a58a935dSMike Snitzer 		}
800a58a935dSMike Snitzer 
801498f0103SMike Snitzer 		if (!strcasecmp(arg_name, "pg_init_retries") &&
802c9e45581SDave Wysochanski 		    (argc >= 1)) {
803498f0103SMike Snitzer 			r = dm_read_arg(_args + 1, as, &m->pg_init_retries, &ti->error);
804c9e45581SDave Wysochanski 			argc--;
805c9e45581SDave Wysochanski 			continue;
806c9e45581SDave Wysochanski 		}
807c9e45581SDave Wysochanski 
808498f0103SMike Snitzer 		if (!strcasecmp(arg_name, "pg_init_delay_msecs") &&
8094e2d19e4SChandra Seetharaman 		    (argc >= 1)) {
810498f0103SMike Snitzer 			r = dm_read_arg(_args + 2, as, &m->pg_init_delay_msecs, &ti->error);
8114e2d19e4SChandra Seetharaman 			argc--;
8124e2d19e4SChandra Seetharaman 			continue;
8134e2d19e4SChandra Seetharaman 		}
8144e2d19e4SChandra Seetharaman 
815c9e45581SDave Wysochanski 		ti->error = "Unrecognised multipath feature request";
816c9e45581SDave Wysochanski 		r = -EINVAL;
817c9e45581SDave Wysochanski 	} while (argc && !r);
818c9e45581SDave Wysochanski 
819c9e45581SDave Wysochanski 	return r;
8201da177e4SLinus Torvalds }
8211da177e4SLinus Torvalds 
8221da177e4SLinus Torvalds static int multipath_ctr(struct dm_target *ti, unsigned int argc,
8231da177e4SLinus Torvalds 			 char **argv)
8241da177e4SLinus Torvalds {
825498f0103SMike Snitzer 	/* target arguments */
826498f0103SMike Snitzer 	static struct dm_arg _args[] = {
827a490a07aSMike Snitzer 		{0, 1024, "invalid number of priority groups"},
828a490a07aSMike Snitzer 		{0, 1024, "invalid initial priority group number"},
8291da177e4SLinus Torvalds 	};
8301da177e4SLinus Torvalds 
8311da177e4SLinus Torvalds 	int r;
8321da177e4SLinus Torvalds 	struct multipath *m;
833498f0103SMike Snitzer 	struct dm_arg_set as;
8341da177e4SLinus Torvalds 	unsigned pg_count = 0;
8351da177e4SLinus Torvalds 	unsigned next_pg_num;
8361da177e4SLinus Torvalds 
8371da177e4SLinus Torvalds 	as.argc = argc;
8381da177e4SLinus Torvalds 	as.argv = argv;
8391da177e4SLinus Torvalds 
84028f16c20SMicha³ Miros³aw 	m = alloc_multipath(ti);
8411da177e4SLinus Torvalds 	if (!m) {
84272d94861SAlasdair G Kergon 		ti->error = "can't allocate multipath";
8431da177e4SLinus Torvalds 		return -EINVAL;
8441da177e4SLinus Torvalds 	}
8451da177e4SLinus Torvalds 
84628f16c20SMicha³ Miros³aw 	r = parse_features(&as, m);
8471da177e4SLinus Torvalds 	if (r)
8481da177e4SLinus Torvalds 		goto bad;
8491da177e4SLinus Torvalds 
85028f16c20SMicha³ Miros³aw 	r = parse_hw_handler(&as, m);
8511da177e4SLinus Torvalds 	if (r)
8521da177e4SLinus Torvalds 		goto bad;
8531da177e4SLinus Torvalds 
854498f0103SMike Snitzer 	r = dm_read_arg(_args, &as, &m->nr_priority_groups, &ti->error);
8551da177e4SLinus Torvalds 	if (r)
8561da177e4SLinus Torvalds 		goto bad;
8571da177e4SLinus Torvalds 
858498f0103SMike Snitzer 	r = dm_read_arg(_args + 1, &as, &next_pg_num, &ti->error);
8591da177e4SLinus Torvalds 	if (r)
8601da177e4SLinus Torvalds 		goto bad;
8611da177e4SLinus Torvalds 
862a490a07aSMike Snitzer 	if ((!m->nr_priority_groups && next_pg_num) ||
863a490a07aSMike Snitzer 	    (m->nr_priority_groups && !next_pg_num)) {
864a490a07aSMike Snitzer 		ti->error = "invalid initial priority group";
865a490a07aSMike Snitzer 		r = -EINVAL;
866a490a07aSMike Snitzer 		goto bad;
867a490a07aSMike Snitzer 	}
868a490a07aSMike Snitzer 
8691da177e4SLinus Torvalds 	/* parse the priority groups */
8701da177e4SLinus Torvalds 	while (as.argc) {
8711da177e4SLinus Torvalds 		struct priority_group *pg;
8721da177e4SLinus Torvalds 
87328f16c20SMicha³ Miros³aw 		pg = parse_priority_group(&as, m);
87401460f35SBenjamin Marzinski 		if (IS_ERR(pg)) {
87501460f35SBenjamin Marzinski 			r = PTR_ERR(pg);
8761da177e4SLinus Torvalds 			goto bad;
8771da177e4SLinus Torvalds 		}
8781da177e4SLinus Torvalds 
8791da177e4SLinus Torvalds 		m->nr_valid_paths += pg->nr_pgpaths;
8801da177e4SLinus Torvalds 		list_add_tail(&pg->list, &m->priority_groups);
8811da177e4SLinus Torvalds 		pg_count++;
8821da177e4SLinus Torvalds 		pg->pg_num = pg_count;
8831da177e4SLinus Torvalds 		if (!--next_pg_num)
8841da177e4SLinus Torvalds 			m->next_pg = pg;
8851da177e4SLinus Torvalds 	}
8861da177e4SLinus Torvalds 
8871da177e4SLinus Torvalds 	if (pg_count != m->nr_priority_groups) {
88872d94861SAlasdair G Kergon 		ti->error = "priority group count mismatch";
8891da177e4SLinus Torvalds 		r = -EINVAL;
8901da177e4SLinus Torvalds 		goto bad;
8911da177e4SLinus Torvalds 	}
8921da177e4SLinus Torvalds 
89355a62eefSAlasdair G Kergon 	ti->num_flush_bios = 1;
89455a62eefSAlasdair G Kergon 	ti->num_discard_bios = 1;
895042bcef8SMike Snitzer 	ti->num_write_same_bios = 1;
8968627921fSMikulas Patocka 
8971da177e4SLinus Torvalds 	return 0;
8981da177e4SLinus Torvalds 
8991da177e4SLinus Torvalds  bad:
9001da177e4SLinus Torvalds 	free_multipath(m);
9011da177e4SLinus Torvalds 	return r;
9021da177e4SLinus Torvalds }
9031da177e4SLinus Torvalds 
9042bded7bdSKiyoshi Ueda static void multipath_wait_for_pg_init_completion(struct multipath *m)
9052bded7bdSKiyoshi Ueda {
9062bded7bdSKiyoshi Ueda 	DECLARE_WAITQUEUE(wait, current);
9072bded7bdSKiyoshi Ueda 	unsigned long flags;
9082bded7bdSKiyoshi Ueda 
9092bded7bdSKiyoshi Ueda 	add_wait_queue(&m->pg_init_wait, &wait);
9102bded7bdSKiyoshi Ueda 
9112bded7bdSKiyoshi Ueda 	while (1) {
9122bded7bdSKiyoshi Ueda 		set_current_state(TASK_UNINTERRUPTIBLE);
9132bded7bdSKiyoshi Ueda 
9142bded7bdSKiyoshi Ueda 		spin_lock_irqsave(&m->lock, flags);
9152bded7bdSKiyoshi Ueda 		if (!m->pg_init_in_progress) {
9162bded7bdSKiyoshi Ueda 			spin_unlock_irqrestore(&m->lock, flags);
9172bded7bdSKiyoshi Ueda 			break;
9182bded7bdSKiyoshi Ueda 		}
9192bded7bdSKiyoshi Ueda 		spin_unlock_irqrestore(&m->lock, flags);
9202bded7bdSKiyoshi Ueda 
9212bded7bdSKiyoshi Ueda 		io_schedule();
9222bded7bdSKiyoshi Ueda 	}
9232bded7bdSKiyoshi Ueda 	set_current_state(TASK_RUNNING);
9242bded7bdSKiyoshi Ueda 
9252bded7bdSKiyoshi Ueda 	remove_wait_queue(&m->pg_init_wait, &wait);
9262bded7bdSKiyoshi Ueda }
9272bded7bdSKiyoshi Ueda 
9282bded7bdSKiyoshi Ueda static void flush_multipath_work(struct multipath *m)
9291da177e4SLinus Torvalds {
930954a73d5SShiva Krishna Merla 	unsigned long flags;
931954a73d5SShiva Krishna Merla 
932954a73d5SShiva Krishna Merla 	spin_lock_irqsave(&m->lock, flags);
933954a73d5SShiva Krishna Merla 	m->pg_init_disabled = 1;
934954a73d5SShiva Krishna Merla 	spin_unlock_irqrestore(&m->lock, flags);
935954a73d5SShiva Krishna Merla 
936bab7cfc7SChandra Seetharaman 	flush_workqueue(kmpath_handlerd);
9372bded7bdSKiyoshi Ueda 	multipath_wait_for_pg_init_completion(m);
938a044d016SAlasdair G Kergon 	flush_workqueue(kmultipathd);
93943829731STejun Heo 	flush_work(&m->trigger_event);
940954a73d5SShiva Krishna Merla 
941954a73d5SShiva Krishna Merla 	spin_lock_irqsave(&m->lock, flags);
942954a73d5SShiva Krishna Merla 	m->pg_init_disabled = 0;
943954a73d5SShiva Krishna Merla 	spin_unlock_irqrestore(&m->lock, flags);
9446df400abSKiyoshi Ueda }
9456df400abSKiyoshi Ueda 
9466df400abSKiyoshi Ueda static void multipath_dtr(struct dm_target *ti)
9476df400abSKiyoshi Ueda {
9486df400abSKiyoshi Ueda 	struct multipath *m = ti->private;
9496df400abSKiyoshi Ueda 
9502bded7bdSKiyoshi Ueda 	flush_multipath_work(m);
9511da177e4SLinus Torvalds 	free_multipath(m);
9521da177e4SLinus Torvalds }
9531da177e4SLinus Torvalds 
9541da177e4SLinus Torvalds /*
9551da177e4SLinus Torvalds  * Take a path out of use.
9561da177e4SLinus Torvalds  */
9571da177e4SLinus Torvalds static int fail_path(struct pgpath *pgpath)
9581da177e4SLinus Torvalds {
9591da177e4SLinus Torvalds 	unsigned long flags;
9601da177e4SLinus Torvalds 	struct multipath *m = pgpath->pg->m;
9611da177e4SLinus Torvalds 
9621da177e4SLinus Torvalds 	spin_lock_irqsave(&m->lock, flags);
9631da177e4SLinus Torvalds 
9646680073dSKiyoshi Ueda 	if (!pgpath->is_active)
9651da177e4SLinus Torvalds 		goto out;
9661da177e4SLinus Torvalds 
96772d94861SAlasdair G Kergon 	DMWARN("Failing path %s.", pgpath->path.dev->name);
9681da177e4SLinus Torvalds 
9691da177e4SLinus Torvalds 	pgpath->pg->ps.type->fail_path(&pgpath->pg->ps, &pgpath->path);
9706680073dSKiyoshi Ueda 	pgpath->is_active = 0;
9711da177e4SLinus Torvalds 	pgpath->fail_count++;
9721da177e4SLinus Torvalds 
9731da177e4SLinus Torvalds 	m->nr_valid_paths--;
9741da177e4SLinus Torvalds 
9751da177e4SLinus Torvalds 	if (pgpath == m->current_pgpath)
9761da177e4SLinus Torvalds 		m->current_pgpath = NULL;
9771da177e4SLinus Torvalds 
978b15546f9SMike Anderson 	dm_path_uevent(DM_UEVENT_PATH_FAILED, m->ti,
979b15546f9SMike Anderson 		      pgpath->path.dev->name, m->nr_valid_paths);
980b15546f9SMike Anderson 
981fe9cf30eSAlasdair G Kergon 	schedule_work(&m->trigger_event);
9821da177e4SLinus Torvalds 
9831da177e4SLinus Torvalds out:
9841da177e4SLinus Torvalds 	spin_unlock_irqrestore(&m->lock, flags);
9851da177e4SLinus Torvalds 
9861da177e4SLinus Torvalds 	return 0;
9871da177e4SLinus Torvalds }
9881da177e4SLinus Torvalds 
9891da177e4SLinus Torvalds /*
9901da177e4SLinus Torvalds  * Reinstate a previously-failed path
9911da177e4SLinus Torvalds  */
9921da177e4SLinus Torvalds static int reinstate_path(struct pgpath *pgpath)
9931da177e4SLinus Torvalds {
99463d832c3SHannes Reinecke 	int r = 0, run_queue = 0;
9951da177e4SLinus Torvalds 	unsigned long flags;
9961da177e4SLinus Torvalds 	struct multipath *m = pgpath->pg->m;
9971da177e4SLinus Torvalds 
9981da177e4SLinus Torvalds 	spin_lock_irqsave(&m->lock, flags);
9991da177e4SLinus Torvalds 
10006680073dSKiyoshi Ueda 	if (pgpath->is_active)
10011da177e4SLinus Torvalds 		goto out;
10021da177e4SLinus Torvalds 
1003def052d2SAlasdair G Kergon 	if (!pgpath->pg->ps.type->reinstate_path) {
10041da177e4SLinus Torvalds 		DMWARN("Reinstate path not supported by path selector %s",
10051da177e4SLinus Torvalds 		       pgpath->pg->ps.type->name);
10061da177e4SLinus Torvalds 		r = -EINVAL;
10071da177e4SLinus Torvalds 		goto out;
10081da177e4SLinus Torvalds 	}
10091da177e4SLinus Torvalds 
10101da177e4SLinus Torvalds 	r = pgpath->pg->ps.type->reinstate_path(&pgpath->pg->ps, &pgpath->path);
10111da177e4SLinus Torvalds 	if (r)
10121da177e4SLinus Torvalds 		goto out;
10131da177e4SLinus Torvalds 
10146680073dSKiyoshi Ueda 	pgpath->is_active = 1;
10151da177e4SLinus Torvalds 
1016e8099177SHannes Reinecke 	if (!m->nr_valid_paths++) {
10171da177e4SLinus Torvalds 		m->current_pgpath = NULL;
101863d832c3SHannes Reinecke 		run_queue = 1;
1019e54f77ddSChandra Seetharaman 	} else if (m->hw_handler_name && (m->current_pg == pgpath->pg)) {
10204e2d19e4SChandra Seetharaman 		if (queue_work(kmpath_handlerd, &pgpath->activate_path.work))
1021e54f77ddSChandra Seetharaman 			m->pg_init_in_progress++;
1022e54f77ddSChandra Seetharaman 	}
10231da177e4SLinus Torvalds 
1024b15546f9SMike Anderson 	dm_path_uevent(DM_UEVENT_PATH_REINSTATED, m->ti,
1025b15546f9SMike Anderson 		      pgpath->path.dev->name, m->nr_valid_paths);
1026b15546f9SMike Anderson 
1027fe9cf30eSAlasdair G Kergon 	schedule_work(&m->trigger_event);
10281da177e4SLinus Torvalds 
10291da177e4SLinus Torvalds out:
10301da177e4SLinus Torvalds 	spin_unlock_irqrestore(&m->lock, flags);
103163d832c3SHannes Reinecke 	if (run_queue)
103263d832c3SHannes Reinecke 		dm_table_run_md_queue_async(m->ti->table);
10331da177e4SLinus Torvalds 
10341da177e4SLinus Torvalds 	return r;
10351da177e4SLinus Torvalds }
10361da177e4SLinus Torvalds 
10371da177e4SLinus Torvalds /*
10381da177e4SLinus Torvalds  * Fail or reinstate all paths that match the provided struct dm_dev.
10391da177e4SLinus Torvalds  */
10401da177e4SLinus Torvalds static int action_dev(struct multipath *m, struct dm_dev *dev,
10411da177e4SLinus Torvalds 		      action_fn action)
10421da177e4SLinus Torvalds {
104319040c0bSMike Snitzer 	int r = -EINVAL;
10441da177e4SLinus Torvalds 	struct pgpath *pgpath;
10451da177e4SLinus Torvalds 	struct priority_group *pg;
10461da177e4SLinus Torvalds 
10471da177e4SLinus Torvalds 	list_for_each_entry(pg, &m->priority_groups, list) {
10481da177e4SLinus Torvalds 		list_for_each_entry(pgpath, &pg->pgpaths, list) {
10491da177e4SLinus Torvalds 			if (pgpath->path.dev == dev)
10501da177e4SLinus Torvalds 				r = action(pgpath);
10511da177e4SLinus Torvalds 		}
10521da177e4SLinus Torvalds 	}
10531da177e4SLinus Torvalds 
10541da177e4SLinus Torvalds 	return r;
10551da177e4SLinus Torvalds }
10561da177e4SLinus Torvalds 
10571da177e4SLinus Torvalds /*
10581da177e4SLinus Torvalds  * Temporarily try to avoid having to use the specified PG
10591da177e4SLinus Torvalds  */
10601da177e4SLinus Torvalds static void bypass_pg(struct multipath *m, struct priority_group *pg,
10611da177e4SLinus Torvalds 		      int bypassed)
10621da177e4SLinus Torvalds {
10631da177e4SLinus Torvalds 	unsigned long flags;
10641da177e4SLinus Torvalds 
10651da177e4SLinus Torvalds 	spin_lock_irqsave(&m->lock, flags);
10661da177e4SLinus Torvalds 
10671da177e4SLinus Torvalds 	pg->bypassed = bypassed;
10681da177e4SLinus Torvalds 	m->current_pgpath = NULL;
10691da177e4SLinus Torvalds 	m->current_pg = NULL;
10701da177e4SLinus Torvalds 
10711da177e4SLinus Torvalds 	spin_unlock_irqrestore(&m->lock, flags);
10721da177e4SLinus Torvalds 
1073fe9cf30eSAlasdair G Kergon 	schedule_work(&m->trigger_event);
10741da177e4SLinus Torvalds }
10751da177e4SLinus Torvalds 
10761da177e4SLinus Torvalds /*
10771da177e4SLinus Torvalds  * Switch to using the specified PG from the next I/O that gets mapped
10781da177e4SLinus Torvalds  */
10791da177e4SLinus Torvalds static int switch_pg_num(struct multipath *m, const char *pgstr)
10801da177e4SLinus Torvalds {
10811da177e4SLinus Torvalds 	struct priority_group *pg;
10821da177e4SLinus Torvalds 	unsigned pgnum;
10831da177e4SLinus Torvalds 	unsigned long flags;
108431998ef1SMikulas Patocka 	char dummy;
10851da177e4SLinus Torvalds 
108631998ef1SMikulas Patocka 	if (!pgstr || (sscanf(pgstr, "%u%c", &pgnum, &dummy) != 1) || !pgnum ||
10871da177e4SLinus Torvalds 	    (pgnum > m->nr_priority_groups)) {
10881da177e4SLinus Torvalds 		DMWARN("invalid PG number supplied to switch_pg_num");
10891da177e4SLinus Torvalds 		return -EINVAL;
10901da177e4SLinus Torvalds 	}
10911da177e4SLinus Torvalds 
10921da177e4SLinus Torvalds 	spin_lock_irqsave(&m->lock, flags);
10931da177e4SLinus Torvalds 	list_for_each_entry(pg, &m->priority_groups, list) {
10941da177e4SLinus Torvalds 		pg->bypassed = 0;
10951da177e4SLinus Torvalds 		if (--pgnum)
10961da177e4SLinus Torvalds 			continue;
10971da177e4SLinus Torvalds 
10981da177e4SLinus Torvalds 		m->current_pgpath = NULL;
10991da177e4SLinus Torvalds 		m->current_pg = NULL;
11001da177e4SLinus Torvalds 		m->next_pg = pg;
11011da177e4SLinus Torvalds 	}
11021da177e4SLinus Torvalds 	spin_unlock_irqrestore(&m->lock, flags);
11031da177e4SLinus Torvalds 
1104fe9cf30eSAlasdair G Kergon 	schedule_work(&m->trigger_event);
11051da177e4SLinus Torvalds 	return 0;
11061da177e4SLinus Torvalds }
11071da177e4SLinus Torvalds 
11081da177e4SLinus Torvalds /*
11091da177e4SLinus Torvalds  * Set/clear bypassed status of a PG.
11101da177e4SLinus Torvalds  * PGs are numbered upwards from 1 in the order they were declared.
11111da177e4SLinus Torvalds  */
11121da177e4SLinus Torvalds static int bypass_pg_num(struct multipath *m, const char *pgstr, int bypassed)
11131da177e4SLinus Torvalds {
11141da177e4SLinus Torvalds 	struct priority_group *pg;
11151da177e4SLinus Torvalds 	unsigned pgnum;
111631998ef1SMikulas Patocka 	char dummy;
11171da177e4SLinus Torvalds 
111831998ef1SMikulas Patocka 	if (!pgstr || (sscanf(pgstr, "%u%c", &pgnum, &dummy) != 1) || !pgnum ||
11191da177e4SLinus Torvalds 	    (pgnum > m->nr_priority_groups)) {
11201da177e4SLinus Torvalds 		DMWARN("invalid PG number supplied to bypass_pg");
11211da177e4SLinus Torvalds 		return -EINVAL;
11221da177e4SLinus Torvalds 	}
11231da177e4SLinus Torvalds 
11241da177e4SLinus Torvalds 	list_for_each_entry(pg, &m->priority_groups, list) {
11251da177e4SLinus Torvalds 		if (!--pgnum)
11261da177e4SLinus Torvalds 			break;
11271da177e4SLinus Torvalds 	}
11281da177e4SLinus Torvalds 
11291da177e4SLinus Torvalds 	bypass_pg(m, pg, bypassed);
11301da177e4SLinus Torvalds 	return 0;
11311da177e4SLinus Torvalds }
11321da177e4SLinus Torvalds 
11331da177e4SLinus Torvalds /*
1134c9e45581SDave Wysochanski  * Should we retry pg_init immediately?
1135c9e45581SDave Wysochanski  */
1136c9e45581SDave Wysochanski static int pg_init_limit_reached(struct multipath *m, struct pgpath *pgpath)
1137c9e45581SDave Wysochanski {
1138c9e45581SDave Wysochanski 	unsigned long flags;
1139c9e45581SDave Wysochanski 	int limit_reached = 0;
1140c9e45581SDave Wysochanski 
1141c9e45581SDave Wysochanski 	spin_lock_irqsave(&m->lock, flags);
1142c9e45581SDave Wysochanski 
1143954a73d5SShiva Krishna Merla 	if (m->pg_init_count <= m->pg_init_retries && !m->pg_init_disabled)
1144c9e45581SDave Wysochanski 		m->pg_init_required = 1;
1145c9e45581SDave Wysochanski 	else
1146c9e45581SDave Wysochanski 		limit_reached = 1;
1147c9e45581SDave Wysochanski 
1148c9e45581SDave Wysochanski 	spin_unlock_irqrestore(&m->lock, flags);
1149c9e45581SDave Wysochanski 
1150c9e45581SDave Wysochanski 	return limit_reached;
1151c9e45581SDave Wysochanski }
1152c9e45581SDave Wysochanski 
11533ae31f6aSChandra Seetharaman static void pg_init_done(void *data, int errors)
1154cfae5c9bSChandra Seetharaman {
115583c0d5d5SMoger, Babu 	struct pgpath *pgpath = data;
1156cfae5c9bSChandra Seetharaman 	struct priority_group *pg = pgpath->pg;
1157cfae5c9bSChandra Seetharaman 	struct multipath *m = pg->m;
1158cfae5c9bSChandra Seetharaman 	unsigned long flags;
11594e2d19e4SChandra Seetharaman 	unsigned delay_retry = 0;
1160cfae5c9bSChandra Seetharaman 
1161cfae5c9bSChandra Seetharaman 	/* device or driver problems */
1162cfae5c9bSChandra Seetharaman 	switch (errors) {
1163cfae5c9bSChandra Seetharaman 	case SCSI_DH_OK:
1164cfae5c9bSChandra Seetharaman 		break;
1165cfae5c9bSChandra Seetharaman 	case SCSI_DH_NOSYS:
1166cfae5c9bSChandra Seetharaman 		if (!m->hw_handler_name) {
1167cfae5c9bSChandra Seetharaman 			errors = 0;
1168cfae5c9bSChandra Seetharaman 			break;
1169cfae5c9bSChandra Seetharaman 		}
1170f7b934c8SMoger, Babu 		DMERR("Could not failover the device: Handler scsi_dh_%s "
1171f7b934c8SMoger, Babu 		      "Error %d.", m->hw_handler_name, errors);
1172cfae5c9bSChandra Seetharaman 		/*
1173cfae5c9bSChandra Seetharaman 		 * Fail path for now, so we do not ping pong
1174cfae5c9bSChandra Seetharaman 		 */
1175cfae5c9bSChandra Seetharaman 		fail_path(pgpath);
1176cfae5c9bSChandra Seetharaman 		break;
1177cfae5c9bSChandra Seetharaman 	case SCSI_DH_DEV_TEMP_BUSY:
1178cfae5c9bSChandra Seetharaman 		/*
1179cfae5c9bSChandra Seetharaman 		 * Probably doing something like FW upgrade on the
1180cfae5c9bSChandra Seetharaman 		 * controller so try the other pg.
1181cfae5c9bSChandra Seetharaman 		 */
1182cfae5c9bSChandra Seetharaman 		bypass_pg(m, pg, 1);
1183cfae5c9bSChandra Seetharaman 		break;
1184cfae5c9bSChandra Seetharaman 	case SCSI_DH_RETRY:
11854e2d19e4SChandra Seetharaman 		/* Wait before retrying. */
11864e2d19e4SChandra Seetharaman 		delay_retry = 1;
1187cfae5c9bSChandra Seetharaman 	case SCSI_DH_IMM_RETRY:
1188cfae5c9bSChandra Seetharaman 	case SCSI_DH_RES_TEMP_UNAVAIL:
1189cfae5c9bSChandra Seetharaman 		if (pg_init_limit_reached(m, pgpath))
1190cfae5c9bSChandra Seetharaman 			fail_path(pgpath);
1191cfae5c9bSChandra Seetharaman 		errors = 0;
1192cfae5c9bSChandra Seetharaman 		break;
1193cfae5c9bSChandra Seetharaman 	default:
1194cfae5c9bSChandra Seetharaman 		/*
1195cfae5c9bSChandra Seetharaman 		 * We probably do not want to fail the path for a device
1196cfae5c9bSChandra Seetharaman 		 * error, but this is what the old dm did. In future
1197cfae5c9bSChandra Seetharaman 		 * patches we can do more advanced handling.
1198cfae5c9bSChandra Seetharaman 		 */
1199cfae5c9bSChandra Seetharaman 		fail_path(pgpath);
1200cfae5c9bSChandra Seetharaman 	}
1201cfae5c9bSChandra Seetharaman 
1202cfae5c9bSChandra Seetharaman 	spin_lock_irqsave(&m->lock, flags);
1203cfae5c9bSChandra Seetharaman 	if (errors) {
1204e54f77ddSChandra Seetharaman 		if (pgpath == m->current_pgpath) {
1205cfae5c9bSChandra Seetharaman 			DMERR("Could not failover device. Error %d.", errors);
1206cfae5c9bSChandra Seetharaman 			m->current_pgpath = NULL;
1207cfae5c9bSChandra Seetharaman 			m->current_pg = NULL;
1208e54f77ddSChandra Seetharaman 		}
1209d0259bf0SKiyoshi Ueda 	} else if (!m->pg_init_required)
1210cfae5c9bSChandra Seetharaman 		pg->bypassed = 0;
1211cfae5c9bSChandra Seetharaman 
1212d0259bf0SKiyoshi Ueda 	if (--m->pg_init_in_progress)
1213d0259bf0SKiyoshi Ueda 		/* Activations of other paths are still on going */
1214d0259bf0SKiyoshi Ueda 		goto out;
1215d0259bf0SKiyoshi Ueda 
12163e9f1be1SHannes Reinecke 	if (m->pg_init_required) {
12174e2d19e4SChandra Seetharaman 		m->pg_init_delay_retry = delay_retry;
12183e9f1be1SHannes Reinecke 		if (__pg_init_all_paths(m))
12193e9f1be1SHannes Reinecke 			goto out;
12203e9f1be1SHannes Reinecke 	}
12213e9f1be1SHannes Reinecke 	m->queue_io = 0;
1222d0259bf0SKiyoshi Ueda 
12232bded7bdSKiyoshi Ueda 	/*
12242bded7bdSKiyoshi Ueda 	 * Wake up any thread waiting to suspend.
12252bded7bdSKiyoshi Ueda 	 */
12262bded7bdSKiyoshi Ueda 	wake_up(&m->pg_init_wait);
12272bded7bdSKiyoshi Ueda 
1228d0259bf0SKiyoshi Ueda out:
1229cfae5c9bSChandra Seetharaman 	spin_unlock_irqrestore(&m->lock, flags);
1230cfae5c9bSChandra Seetharaman }
1231cfae5c9bSChandra Seetharaman 
1232bab7cfc7SChandra Seetharaman static void activate_path(struct work_struct *work)
1233bab7cfc7SChandra Seetharaman {
1234e54f77ddSChandra Seetharaman 	struct pgpath *pgpath =
12354e2d19e4SChandra Seetharaman 		container_of(work, struct pgpath, activate_path.work);
1236bab7cfc7SChandra Seetharaman 
12373a017509SHannes Reinecke 	if (pgpath->is_active)
12383ae31f6aSChandra Seetharaman 		scsi_dh_activate(bdev_get_queue(pgpath->path.dev->bdev),
123983c0d5d5SMoger, Babu 				 pg_init_done, pgpath);
12403a017509SHannes Reinecke 	else
12413a017509SHannes Reinecke 		pg_init_done(pgpath, SCSI_DH_DEV_OFFLINED);
1242bab7cfc7SChandra Seetharaman }
1243bab7cfc7SChandra Seetharaman 
12447e782af5SHannes Reinecke static int noretry_error(int error)
12457e782af5SHannes Reinecke {
12467e782af5SHannes Reinecke 	switch (error) {
12477e782af5SHannes Reinecke 	case -EOPNOTSUPP:
12487e782af5SHannes Reinecke 	case -EREMOTEIO:
12497e782af5SHannes Reinecke 	case -EILSEQ:
12507e782af5SHannes Reinecke 	case -ENODATA:
1251cc9d3c38SJun'ichi Nomura 	case -ENOSPC:
12527e782af5SHannes Reinecke 		return 1;
12537e782af5SHannes Reinecke 	}
12547e782af5SHannes Reinecke 
12557e782af5SHannes Reinecke 	/* Anything else could be a path failure, so should be retried */
12567e782af5SHannes Reinecke 	return 0;
12577e782af5SHannes Reinecke }
12587e782af5SHannes Reinecke 
12591da177e4SLinus Torvalds /*
12601da177e4SLinus Torvalds  * end_io handling
12611da177e4SLinus Torvalds  */
1262f40c67f0SKiyoshi Ueda static int do_end_io(struct multipath *m, struct request *clone,
1263028867acSAlasdair G Kergon 		     int error, struct dm_mpath_io *mpio)
12641da177e4SLinus Torvalds {
1265f40c67f0SKiyoshi Ueda 	/*
1266f40c67f0SKiyoshi Ueda 	 * We don't queue any clone request inside the multipath target
1267f40c67f0SKiyoshi Ueda 	 * during end I/O handling, since those clone requests don't have
1268f40c67f0SKiyoshi Ueda 	 * bio clones.  If we queue them inside the multipath target,
1269f40c67f0SKiyoshi Ueda 	 * we need to make bio clones, that requires memory allocation.
1270f40c67f0SKiyoshi Ueda 	 * (See drivers/md/dm.c:end_clone_bio() about why the clone requests
1271f40c67f0SKiyoshi Ueda 	 *  don't have bio clones.)
1272f40c67f0SKiyoshi Ueda 	 * Instead of queueing the clone request here, we queue the original
1273f40c67f0SKiyoshi Ueda 	 * request into dm core, which will remake a clone request and
1274f40c67f0SKiyoshi Ueda 	 * clone bios for it and resubmit it later.
1275f40c67f0SKiyoshi Ueda 	 */
1276f40c67f0SKiyoshi Ueda 	int r = DM_ENDIO_REQUEUE;
1277640eb3b0SStefan Bader 	unsigned long flags;
12781da177e4SLinus Torvalds 
1279f40c67f0SKiyoshi Ueda 	if (!error && !clone->errors)
12801da177e4SLinus Torvalds 		return 0;	/* I/O complete */
12811da177e4SLinus Torvalds 
12827eee4ae2SMike Snitzer 	if (noretry_error(error))
1283959eb4e5SMike Snitzer 		return error;
1284959eb4e5SMike Snitzer 
1285cfae5c9bSChandra Seetharaman 	if (mpio->pgpath)
12861da177e4SLinus Torvalds 		fail_path(mpio->pgpath);
12871da177e4SLinus Torvalds 
1288640eb3b0SStefan Bader 	spin_lock_irqsave(&m->lock, flags);
1289751b2a7dSHannes Reinecke 	if (!m->nr_valid_paths) {
1290751b2a7dSHannes Reinecke 		if (!m->queue_if_no_path) {
1291751b2a7dSHannes Reinecke 			if (!__must_push_back(m))
1292f40c67f0SKiyoshi Ueda 				r = -EIO;
1293751b2a7dSHannes Reinecke 		} else {
1294751b2a7dSHannes Reinecke 			if (error == -EBADE)
1295751b2a7dSHannes Reinecke 				r = error;
1296751b2a7dSHannes Reinecke 		}
1297751b2a7dSHannes Reinecke 	}
1298640eb3b0SStefan Bader 	spin_unlock_irqrestore(&m->lock, flags);
12991da177e4SLinus Torvalds 
1300f40c67f0SKiyoshi Ueda 	return r;
13011da177e4SLinus Torvalds }
13021da177e4SLinus Torvalds 
1303f40c67f0SKiyoshi Ueda static int multipath_end_io(struct dm_target *ti, struct request *clone,
13041da177e4SLinus Torvalds 			    int error, union map_info *map_context)
13051da177e4SLinus Torvalds {
1306028867acSAlasdair G Kergon 	struct multipath *m = ti->private;
1307028867acSAlasdair G Kergon 	struct dm_mpath_io *mpio = map_context->ptr;
1308a71a261fSWei Yongjun 	struct pgpath *pgpath;
13091da177e4SLinus Torvalds 	struct path_selector *ps;
13101da177e4SLinus Torvalds 	int r;
13111da177e4SLinus Torvalds 
1312466891f9SJun'ichi Nomura 	BUG_ON(!mpio);
1313466891f9SJun'ichi Nomura 
1314f40c67f0SKiyoshi Ueda 	r  = do_end_io(m, clone, error, mpio);
1315a71a261fSWei Yongjun 	pgpath = mpio->pgpath;
13161da177e4SLinus Torvalds 	if (pgpath) {
13171da177e4SLinus Torvalds 		ps = &pgpath->pg->ps;
13181da177e4SLinus Torvalds 		if (ps->type->end_io)
131902ab823fSKiyoshi Ueda 			ps->type->end_io(ps, &pgpath->path, mpio->nr_bytes);
13201da177e4SLinus Torvalds 	}
1321466891f9SJun'ichi Nomura 	clear_mapinfo(m, map_context);
13221da177e4SLinus Torvalds 
13231da177e4SLinus Torvalds 	return r;
13241da177e4SLinus Torvalds }
13251da177e4SLinus Torvalds 
13261da177e4SLinus Torvalds /*
13271da177e4SLinus Torvalds  * Suspend can't complete until all the I/O is processed so if
1328436d4108SAlasdair G Kergon  * the last path fails we must error any remaining I/O.
1329436d4108SAlasdair G Kergon  * Note that if the freeze_bdev fails while suspending, the
1330436d4108SAlasdair G Kergon  * queue_if_no_path state is lost - userspace should reset it.
13311da177e4SLinus Torvalds  */
13321da177e4SLinus Torvalds static void multipath_presuspend(struct dm_target *ti)
13331da177e4SLinus Torvalds {
13341da177e4SLinus Torvalds 	struct multipath *m = (struct multipath *) ti->private;
13351da177e4SLinus Torvalds 
1336485ef69eSAlasdair G Kergon 	queue_if_no_path(m, 0, 1);
13371da177e4SLinus Torvalds }
13381da177e4SLinus Torvalds 
13396df400abSKiyoshi Ueda static void multipath_postsuspend(struct dm_target *ti)
13406df400abSKiyoshi Ueda {
13416380f26fSMike Anderson 	struct multipath *m = ti->private;
13426380f26fSMike Anderson 
13436380f26fSMike Anderson 	mutex_lock(&m->work_mutex);
13442bded7bdSKiyoshi Ueda 	flush_multipath_work(m);
13456380f26fSMike Anderson 	mutex_unlock(&m->work_mutex);
13466df400abSKiyoshi Ueda }
13476df400abSKiyoshi Ueda 
1348436d4108SAlasdair G Kergon /*
1349436d4108SAlasdair G Kergon  * Restore the queue_if_no_path setting.
1350436d4108SAlasdair G Kergon  */
13511da177e4SLinus Torvalds static void multipath_resume(struct dm_target *ti)
13521da177e4SLinus Torvalds {
13531da177e4SLinus Torvalds 	struct multipath *m = (struct multipath *) ti->private;
13541da177e4SLinus Torvalds 	unsigned long flags;
13551da177e4SLinus Torvalds 
13561da177e4SLinus Torvalds 	spin_lock_irqsave(&m->lock, flags);
1357436d4108SAlasdair G Kergon 	m->queue_if_no_path = m->saved_queue_if_no_path;
13581da177e4SLinus Torvalds 	spin_unlock_irqrestore(&m->lock, flags);
13591da177e4SLinus Torvalds }
13601da177e4SLinus Torvalds 
13611da177e4SLinus Torvalds /*
13621da177e4SLinus Torvalds  * Info output has the following format:
13631da177e4SLinus Torvalds  * num_multipath_feature_args [multipath_feature_args]*
13641da177e4SLinus Torvalds  * num_handler_status_args [handler_status_args]*
13651da177e4SLinus Torvalds  * num_groups init_group_number
13661da177e4SLinus Torvalds  *            [A|D|E num_ps_status_args [ps_status_args]*
13671da177e4SLinus Torvalds  *             num_paths num_selector_args
13681da177e4SLinus Torvalds  *             [path_dev A|F fail_count [selector_args]* ]+ ]+
13691da177e4SLinus Torvalds  *
13701da177e4SLinus Torvalds  * Table output has the following format (identical to the constructor string):
13711da177e4SLinus Torvalds  * num_feature_args [features_args]*
13721da177e4SLinus Torvalds  * num_handler_args hw_handler [hw_handler_args]*
13731da177e4SLinus Torvalds  * num_groups init_group_number
13741da177e4SLinus Torvalds  *     [priority selector-name num_ps_args [ps_args]*
13751da177e4SLinus Torvalds  *      num_paths num_selector_args [path_dev [selector_args]* ]+ ]+
13761da177e4SLinus Torvalds  */
1377fd7c092eSMikulas Patocka static void multipath_status(struct dm_target *ti, status_type_t type,
13781f4e0ff0SAlasdair G Kergon 			     unsigned status_flags, char *result, unsigned maxlen)
13791da177e4SLinus Torvalds {
13801da177e4SLinus Torvalds 	int sz = 0;
13811da177e4SLinus Torvalds 	unsigned long flags;
13821da177e4SLinus Torvalds 	struct multipath *m = (struct multipath *) ti->private;
13831da177e4SLinus Torvalds 	struct priority_group *pg;
13841da177e4SLinus Torvalds 	struct pgpath *p;
13851da177e4SLinus Torvalds 	unsigned pg_num;
13861da177e4SLinus Torvalds 	char state;
13871da177e4SLinus Torvalds 
13881da177e4SLinus Torvalds 	spin_lock_irqsave(&m->lock, flags);
13891da177e4SLinus Torvalds 
13901da177e4SLinus Torvalds 	/* Features */
13911da177e4SLinus Torvalds 	if (type == STATUSTYPE_INFO)
1392e8099177SHannes Reinecke 		DMEMIT("2 %u %u ", m->queue_io, m->pg_init_count);
1393c9e45581SDave Wysochanski 	else {
1394c9e45581SDave Wysochanski 		DMEMIT("%u ", m->queue_if_no_path +
13954e2d19e4SChandra Seetharaman 			      (m->pg_init_retries > 0) * 2 +
1396a58a935dSMike Snitzer 			      (m->pg_init_delay_msecs != DM_PG_INIT_DELAY_DEFAULT) * 2 +
1397a58a935dSMike Snitzer 			      m->retain_attached_hw_handler);
1398c9e45581SDave Wysochanski 		if (m->queue_if_no_path)
1399c9e45581SDave Wysochanski 			DMEMIT("queue_if_no_path ");
1400c9e45581SDave Wysochanski 		if (m->pg_init_retries)
1401c9e45581SDave Wysochanski 			DMEMIT("pg_init_retries %u ", m->pg_init_retries);
14024e2d19e4SChandra Seetharaman 		if (m->pg_init_delay_msecs != DM_PG_INIT_DELAY_DEFAULT)
14034e2d19e4SChandra Seetharaman 			DMEMIT("pg_init_delay_msecs %u ", m->pg_init_delay_msecs);
1404a58a935dSMike Snitzer 		if (m->retain_attached_hw_handler)
1405a58a935dSMike Snitzer 			DMEMIT("retain_attached_hw_handler ");
1406c9e45581SDave Wysochanski 	}
14071da177e4SLinus Torvalds 
1408cfae5c9bSChandra Seetharaman 	if (!m->hw_handler_name || type == STATUSTYPE_INFO)
14091da177e4SLinus Torvalds 		DMEMIT("0 ");
14101da177e4SLinus Torvalds 	else
1411cfae5c9bSChandra Seetharaman 		DMEMIT("1 %s ", m->hw_handler_name);
14121da177e4SLinus Torvalds 
14131da177e4SLinus Torvalds 	DMEMIT("%u ", m->nr_priority_groups);
14141da177e4SLinus Torvalds 
14151da177e4SLinus Torvalds 	if (m->next_pg)
14161da177e4SLinus Torvalds 		pg_num = m->next_pg->pg_num;
14171da177e4SLinus Torvalds 	else if (m->current_pg)
14181da177e4SLinus Torvalds 		pg_num = m->current_pg->pg_num;
14191da177e4SLinus Torvalds 	else
1420a490a07aSMike Snitzer 		pg_num = (m->nr_priority_groups ? 1 : 0);
14211da177e4SLinus Torvalds 
14221da177e4SLinus Torvalds 	DMEMIT("%u ", pg_num);
14231da177e4SLinus Torvalds 
14241da177e4SLinus Torvalds 	switch (type) {
14251da177e4SLinus Torvalds 	case STATUSTYPE_INFO:
14261da177e4SLinus Torvalds 		list_for_each_entry(pg, &m->priority_groups, list) {
14271da177e4SLinus Torvalds 			if (pg->bypassed)
14281da177e4SLinus Torvalds 				state = 'D';	/* Disabled */
14291da177e4SLinus Torvalds 			else if (pg == m->current_pg)
14301da177e4SLinus Torvalds 				state = 'A';	/* Currently Active */
14311da177e4SLinus Torvalds 			else
14321da177e4SLinus Torvalds 				state = 'E';	/* Enabled */
14331da177e4SLinus Torvalds 
14341da177e4SLinus Torvalds 			DMEMIT("%c ", state);
14351da177e4SLinus Torvalds 
14361da177e4SLinus Torvalds 			if (pg->ps.type->status)
14371da177e4SLinus Torvalds 				sz += pg->ps.type->status(&pg->ps, NULL, type,
14381da177e4SLinus Torvalds 							  result + sz,
14391da177e4SLinus Torvalds 							  maxlen - sz);
14401da177e4SLinus Torvalds 			else
14411da177e4SLinus Torvalds 				DMEMIT("0 ");
14421da177e4SLinus Torvalds 
14431da177e4SLinus Torvalds 			DMEMIT("%u %u ", pg->nr_pgpaths,
14441da177e4SLinus Torvalds 			       pg->ps.type->info_args);
14451da177e4SLinus Torvalds 
14461da177e4SLinus Torvalds 			list_for_each_entry(p, &pg->pgpaths, list) {
14471da177e4SLinus Torvalds 				DMEMIT("%s %s %u ", p->path.dev->name,
14486680073dSKiyoshi Ueda 				       p->is_active ? "A" : "F",
14491da177e4SLinus Torvalds 				       p->fail_count);
14501da177e4SLinus Torvalds 				if (pg->ps.type->status)
14511da177e4SLinus Torvalds 					sz += pg->ps.type->status(&pg->ps,
14521da177e4SLinus Torvalds 					      &p->path, type, result + sz,
14531da177e4SLinus Torvalds 					      maxlen - sz);
14541da177e4SLinus Torvalds 			}
14551da177e4SLinus Torvalds 		}
14561da177e4SLinus Torvalds 		break;
14571da177e4SLinus Torvalds 
14581da177e4SLinus Torvalds 	case STATUSTYPE_TABLE:
14591da177e4SLinus Torvalds 		list_for_each_entry(pg, &m->priority_groups, list) {
14601da177e4SLinus Torvalds 			DMEMIT("%s ", pg->ps.type->name);
14611da177e4SLinus Torvalds 
14621da177e4SLinus Torvalds 			if (pg->ps.type->status)
14631da177e4SLinus Torvalds 				sz += pg->ps.type->status(&pg->ps, NULL, type,
14641da177e4SLinus Torvalds 							  result + sz,
14651da177e4SLinus Torvalds 							  maxlen - sz);
14661da177e4SLinus Torvalds 			else
14671da177e4SLinus Torvalds 				DMEMIT("0 ");
14681da177e4SLinus Torvalds 
14691da177e4SLinus Torvalds 			DMEMIT("%u %u ", pg->nr_pgpaths,
14701da177e4SLinus Torvalds 			       pg->ps.type->table_args);
14711da177e4SLinus Torvalds 
14721da177e4SLinus Torvalds 			list_for_each_entry(p, &pg->pgpaths, list) {
14731da177e4SLinus Torvalds 				DMEMIT("%s ", p->path.dev->name);
14741da177e4SLinus Torvalds 				if (pg->ps.type->status)
14751da177e4SLinus Torvalds 					sz += pg->ps.type->status(&pg->ps,
14761da177e4SLinus Torvalds 					      &p->path, type, result + sz,
14771da177e4SLinus Torvalds 					      maxlen - sz);
14781da177e4SLinus Torvalds 			}
14791da177e4SLinus Torvalds 		}
14801da177e4SLinus Torvalds 		break;
14811da177e4SLinus Torvalds 	}
14821da177e4SLinus Torvalds 
14831da177e4SLinus Torvalds 	spin_unlock_irqrestore(&m->lock, flags);
14841da177e4SLinus Torvalds }
14851da177e4SLinus Torvalds 
14861da177e4SLinus Torvalds static int multipath_message(struct dm_target *ti, unsigned argc, char **argv)
14871da177e4SLinus Torvalds {
14886380f26fSMike Anderson 	int r = -EINVAL;
14891da177e4SLinus Torvalds 	struct dm_dev *dev;
14901da177e4SLinus Torvalds 	struct multipath *m = (struct multipath *) ti->private;
14911da177e4SLinus Torvalds 	action_fn action;
14921da177e4SLinus Torvalds 
14936380f26fSMike Anderson 	mutex_lock(&m->work_mutex);
14946380f26fSMike Anderson 
1495c2f3d24bSKiyoshi Ueda 	if (dm_suspended(ti)) {
1496c2f3d24bSKiyoshi Ueda 		r = -EBUSY;
1497c2f3d24bSKiyoshi Ueda 		goto out;
1498c2f3d24bSKiyoshi Ueda 	}
1499c2f3d24bSKiyoshi Ueda 
15001da177e4SLinus Torvalds 	if (argc == 1) {
1501498f0103SMike Snitzer 		if (!strcasecmp(argv[0], "queue_if_no_path")) {
15026380f26fSMike Anderson 			r = queue_if_no_path(m, 1, 0);
15036380f26fSMike Anderson 			goto out;
1504498f0103SMike Snitzer 		} else if (!strcasecmp(argv[0], "fail_if_no_path")) {
15056380f26fSMike Anderson 			r = queue_if_no_path(m, 0, 0);
15066380f26fSMike Anderson 			goto out;
15076380f26fSMike Anderson 		}
15081da177e4SLinus Torvalds 	}
15091da177e4SLinus Torvalds 
15106380f26fSMike Anderson 	if (argc != 2) {
1511a356e426SJose Castillo 		DMWARN("Invalid multipath message arguments. Expected 2 arguments, got %d.", argc);
15126380f26fSMike Anderson 		goto out;
15136380f26fSMike Anderson 	}
15141da177e4SLinus Torvalds 
1515498f0103SMike Snitzer 	if (!strcasecmp(argv[0], "disable_group")) {
15166380f26fSMike Anderson 		r = bypass_pg_num(m, argv[1], 1);
15176380f26fSMike Anderson 		goto out;
1518498f0103SMike Snitzer 	} else if (!strcasecmp(argv[0], "enable_group")) {
15196380f26fSMike Anderson 		r = bypass_pg_num(m, argv[1], 0);
15206380f26fSMike Anderson 		goto out;
1521498f0103SMike Snitzer 	} else if (!strcasecmp(argv[0], "switch_group")) {
15226380f26fSMike Anderson 		r = switch_pg_num(m, argv[1]);
15236380f26fSMike Anderson 		goto out;
1524498f0103SMike Snitzer 	} else if (!strcasecmp(argv[0], "reinstate_path"))
15251da177e4SLinus Torvalds 		action = reinstate_path;
1526498f0103SMike Snitzer 	else if (!strcasecmp(argv[0], "fail_path"))
15271da177e4SLinus Torvalds 		action = fail_path;
15286380f26fSMike Anderson 	else {
1529a356e426SJose Castillo 		DMWARN("Unrecognised multipath message received: %s", argv[0]);
15306380f26fSMike Anderson 		goto out;
15316380f26fSMike Anderson 	}
15321da177e4SLinus Torvalds 
15338215d6ecSNikanth Karthikesan 	r = dm_get_device(ti, argv[1], dm_table_get_mode(ti->table), &dev);
15341da177e4SLinus Torvalds 	if (r) {
153572d94861SAlasdair G Kergon 		DMWARN("message: error getting device %s",
15361da177e4SLinus Torvalds 		       argv[1]);
15376380f26fSMike Anderson 		goto out;
15381da177e4SLinus Torvalds 	}
15391da177e4SLinus Torvalds 
15401da177e4SLinus Torvalds 	r = action_dev(m, dev, action);
15411da177e4SLinus Torvalds 
15421da177e4SLinus Torvalds 	dm_put_device(ti, dev);
15431da177e4SLinus Torvalds 
15446380f26fSMike Anderson out:
15456380f26fSMike Anderson 	mutex_unlock(&m->work_mutex);
15461da177e4SLinus Torvalds 	return r;
15471da177e4SLinus Torvalds }
15481da177e4SLinus Torvalds 
1549647b3d00SAl Viro static int multipath_ioctl(struct dm_target *ti, unsigned int cmd,
15509af4aa30SMilan Broz 			   unsigned long arg)
15519af4aa30SMilan Broz {
155235991652SMikulas Patocka 	struct multipath *m = ti->private;
15537ba10aa6SMike Snitzer 	struct pgpath *pgpath;
155435991652SMikulas Patocka 	struct block_device *bdev;
155535991652SMikulas Patocka 	fmode_t mode;
15569af4aa30SMilan Broz 	unsigned long flags;
155735991652SMikulas Patocka 	int r;
155835991652SMikulas Patocka 
155935991652SMikulas Patocka 	bdev = NULL;
156035991652SMikulas Patocka 	mode = 0;
156135991652SMikulas Patocka 	r = 0;
15629af4aa30SMilan Broz 
15639af4aa30SMilan Broz 	spin_lock_irqsave(&m->lock, flags);
15649af4aa30SMilan Broz 
15659af4aa30SMilan Broz 	if (!m->current_pgpath)
156602ab823fSKiyoshi Ueda 		__choose_pgpath(m, 0);
15679af4aa30SMilan Broz 
15687ba10aa6SMike Snitzer 	pgpath = m->current_pgpath;
15697ba10aa6SMike Snitzer 
15707ba10aa6SMike Snitzer 	if (pgpath) {
15717ba10aa6SMike Snitzer 		bdev = pgpath->path.dev->bdev;
15727ba10aa6SMike Snitzer 		mode = pgpath->path.dev->mode;
1573e90dae1fSMilan Broz 	}
15749af4aa30SMilan Broz 
15757ba10aa6SMike Snitzer 	if ((pgpath && m->queue_io) || (!pgpath && m->queue_if_no_path))
15766c182cd8SHannes Reinecke 		r = -ENOTCONN;
15779af4aa30SMilan Broz 	else if (!bdev)
15789af4aa30SMilan Broz 		r = -EIO;
15799af4aa30SMilan Broz 
15809af4aa30SMilan Broz 	spin_unlock_irqrestore(&m->lock, flags);
15819af4aa30SMilan Broz 
1582ec8013beSPaolo Bonzini 	/*
1583ec8013beSPaolo Bonzini 	 * Only pass ioctls through if the device sizes match exactly.
1584ec8013beSPaolo Bonzini 	 */
1585a1989b33SHannes Reinecke 	if (!bdev || ti->len != i_size_read(bdev->bd_inode) >> SECTOR_SHIFT) {
1586a1989b33SHannes Reinecke 		int err = scsi_verify_blk_ioctl(NULL, cmd);
1587a1989b33SHannes Reinecke 		if (err)
1588a1989b33SHannes Reinecke 			r = err;
1589a1989b33SHannes Reinecke 	}
1590ec8013beSPaolo Bonzini 
15913e9f1be1SHannes Reinecke 	if (r == -ENOTCONN && !fatal_signal_pending(current)) {
15923e9f1be1SHannes Reinecke 		spin_lock_irqsave(&m->lock, flags);
15933e9f1be1SHannes Reinecke 		if (!m->current_pg) {
15943e9f1be1SHannes Reinecke 			/* Path status changed, redo selection */
15953e9f1be1SHannes Reinecke 			__choose_pgpath(m, 0);
15963e9f1be1SHannes Reinecke 		}
15973e9f1be1SHannes Reinecke 		if (m->pg_init_required)
15983e9f1be1SHannes Reinecke 			__pg_init_all_paths(m);
15994cdd2ad7SMike Snitzer 		spin_unlock_irqrestore(&m->lock, flags);
160063d832c3SHannes Reinecke 		dm_table_run_md_queue_async(m->ti->table);
16013e9f1be1SHannes Reinecke 	}
160235991652SMikulas Patocka 
1603633a08b8SAl Viro 	return r ? : __blkdev_driver_ioctl(bdev, mode, cmd, arg);
16049af4aa30SMilan Broz }
16059af4aa30SMilan Broz 
1606af4874e0SMike Snitzer static int multipath_iterate_devices(struct dm_target *ti,
1607af4874e0SMike Snitzer 				     iterate_devices_callout_fn fn, void *data)
1608af4874e0SMike Snitzer {
1609af4874e0SMike Snitzer 	struct multipath *m = ti->private;
1610af4874e0SMike Snitzer 	struct priority_group *pg;
1611af4874e0SMike Snitzer 	struct pgpath *p;
1612af4874e0SMike Snitzer 	int ret = 0;
1613af4874e0SMike Snitzer 
1614af4874e0SMike Snitzer 	list_for_each_entry(pg, &m->priority_groups, list) {
1615af4874e0SMike Snitzer 		list_for_each_entry(p, &pg->pgpaths, list) {
16165dea271bSMike Snitzer 			ret = fn(ti, p->path.dev, ti->begin, ti->len, data);
1617af4874e0SMike Snitzer 			if (ret)
1618af4874e0SMike Snitzer 				goto out;
1619af4874e0SMike Snitzer 		}
1620af4874e0SMike Snitzer 	}
1621af4874e0SMike Snitzer 
1622af4874e0SMike Snitzer out:
1623af4874e0SMike Snitzer 	return ret;
1624af4874e0SMike Snitzer }
1625af4874e0SMike Snitzer 
1626f40c67f0SKiyoshi Ueda static int __pgpath_busy(struct pgpath *pgpath)
1627f40c67f0SKiyoshi Ueda {
1628f40c67f0SKiyoshi Ueda 	struct request_queue *q = bdev_get_queue(pgpath->path.dev->bdev);
1629f40c67f0SKiyoshi Ueda 
163052b09914SMike Snitzer 	return blk_lld_busy(q);
1631f40c67f0SKiyoshi Ueda }
1632f40c67f0SKiyoshi Ueda 
1633f40c67f0SKiyoshi Ueda /*
1634f40c67f0SKiyoshi Ueda  * We return "busy", only when we can map I/Os but underlying devices
1635f40c67f0SKiyoshi Ueda  * are busy (so even if we map I/Os now, the I/Os will wait on
1636f40c67f0SKiyoshi Ueda  * the underlying queue).
1637f40c67f0SKiyoshi Ueda  * In other words, if we want to kill I/Os or queue them inside us
1638f40c67f0SKiyoshi Ueda  * due to map unavailability, we don't return "busy".  Otherwise,
1639f40c67f0SKiyoshi Ueda  * dm core won't give us the I/Os and we can't do what we want.
1640f40c67f0SKiyoshi Ueda  */
1641f40c67f0SKiyoshi Ueda static int multipath_busy(struct dm_target *ti)
1642f40c67f0SKiyoshi Ueda {
1643f40c67f0SKiyoshi Ueda 	int busy = 0, has_active = 0;
1644f40c67f0SKiyoshi Ueda 	struct multipath *m = ti->private;
1645f40c67f0SKiyoshi Ueda 	struct priority_group *pg;
1646f40c67f0SKiyoshi Ueda 	struct pgpath *pgpath;
1647f40c67f0SKiyoshi Ueda 	unsigned long flags;
1648f40c67f0SKiyoshi Ueda 
1649f40c67f0SKiyoshi Ueda 	spin_lock_irqsave(&m->lock, flags);
1650f40c67f0SKiyoshi Ueda 
16517a7a3b45SJun'ichi Nomura 	/* pg_init in progress or no paths available */
16527a7a3b45SJun'ichi Nomura 	if (m->pg_init_in_progress ||
16537a7a3b45SJun'ichi Nomura 	    (!m->nr_valid_paths && m->queue_if_no_path)) {
1654b63349a7SHannes Reinecke 		busy = 1;
1655b63349a7SHannes Reinecke 		goto out;
1656b63349a7SHannes Reinecke 	}
1657f40c67f0SKiyoshi Ueda 	/* Guess which priority_group will be used at next mapping time */
1658f40c67f0SKiyoshi Ueda 	if (unlikely(!m->current_pgpath && m->next_pg))
1659f40c67f0SKiyoshi Ueda 		pg = m->next_pg;
1660f40c67f0SKiyoshi Ueda 	else if (likely(m->current_pg))
1661f40c67f0SKiyoshi Ueda 		pg = m->current_pg;
1662f40c67f0SKiyoshi Ueda 	else
1663f40c67f0SKiyoshi Ueda 		/*
1664f40c67f0SKiyoshi Ueda 		 * We don't know which pg will be used at next mapping time.
1665f40c67f0SKiyoshi Ueda 		 * We don't call __choose_pgpath() here to avoid to trigger
1666f40c67f0SKiyoshi Ueda 		 * pg_init just by busy checking.
1667f40c67f0SKiyoshi Ueda 		 * So we don't know whether underlying devices we will be using
1668f40c67f0SKiyoshi Ueda 		 * at next mapping time are busy or not. Just try mapping.
1669f40c67f0SKiyoshi Ueda 		 */
1670f40c67f0SKiyoshi Ueda 		goto out;
1671f40c67f0SKiyoshi Ueda 
1672f40c67f0SKiyoshi Ueda 	/*
1673f40c67f0SKiyoshi Ueda 	 * If there is one non-busy active path at least, the path selector
1674f40c67f0SKiyoshi Ueda 	 * will be able to select it. So we consider such a pg as not busy.
1675f40c67f0SKiyoshi Ueda 	 */
1676f40c67f0SKiyoshi Ueda 	busy = 1;
1677f40c67f0SKiyoshi Ueda 	list_for_each_entry(pgpath, &pg->pgpaths, list)
1678f40c67f0SKiyoshi Ueda 		if (pgpath->is_active) {
1679f40c67f0SKiyoshi Ueda 			has_active = 1;
1680f40c67f0SKiyoshi Ueda 
1681f40c67f0SKiyoshi Ueda 			if (!__pgpath_busy(pgpath)) {
1682f40c67f0SKiyoshi Ueda 				busy = 0;
1683f40c67f0SKiyoshi Ueda 				break;
1684f40c67f0SKiyoshi Ueda 			}
1685f40c67f0SKiyoshi Ueda 		}
1686f40c67f0SKiyoshi Ueda 
1687f40c67f0SKiyoshi Ueda 	if (!has_active)
1688f40c67f0SKiyoshi Ueda 		/*
1689f40c67f0SKiyoshi Ueda 		 * No active path in this pg, so this pg won't be used and
1690f40c67f0SKiyoshi Ueda 		 * the current_pg will be changed at next mapping time.
1691f40c67f0SKiyoshi Ueda 		 * We need to try mapping to determine it.
1692f40c67f0SKiyoshi Ueda 		 */
1693f40c67f0SKiyoshi Ueda 		busy = 0;
1694f40c67f0SKiyoshi Ueda 
1695f40c67f0SKiyoshi Ueda out:
1696f40c67f0SKiyoshi Ueda 	spin_unlock_irqrestore(&m->lock, flags);
1697f40c67f0SKiyoshi Ueda 
1698f40c67f0SKiyoshi Ueda 	return busy;
1699f40c67f0SKiyoshi Ueda }
1700f40c67f0SKiyoshi Ueda 
17011da177e4SLinus Torvalds /*-----------------------------------------------------------------
17021da177e4SLinus Torvalds  * Module setup
17031da177e4SLinus Torvalds  *---------------------------------------------------------------*/
17041da177e4SLinus Torvalds static struct target_type multipath_target = {
17051da177e4SLinus Torvalds 	.name = "multipath",
1706bfebd1cdSMike Snitzer 	.version = {1, 9, 0},
17071da177e4SLinus Torvalds 	.module = THIS_MODULE,
17081da177e4SLinus Torvalds 	.ctr = multipath_ctr,
17091da177e4SLinus Torvalds 	.dtr = multipath_dtr,
1710f40c67f0SKiyoshi Ueda 	.map_rq = multipath_map,
1711e5863d9aSMike Snitzer 	.clone_and_map_rq = multipath_clone_and_map,
1712e5863d9aSMike Snitzer 	.release_clone_rq = multipath_release_clone,
1713f40c67f0SKiyoshi Ueda 	.rq_end_io = multipath_end_io,
17141da177e4SLinus Torvalds 	.presuspend = multipath_presuspend,
17156df400abSKiyoshi Ueda 	.postsuspend = multipath_postsuspend,
17161da177e4SLinus Torvalds 	.resume = multipath_resume,
17171da177e4SLinus Torvalds 	.status = multipath_status,
17181da177e4SLinus Torvalds 	.message = multipath_message,
17199af4aa30SMilan Broz 	.ioctl  = multipath_ioctl,
1720af4874e0SMike Snitzer 	.iterate_devices = multipath_iterate_devices,
1721f40c67f0SKiyoshi Ueda 	.busy = multipath_busy,
17221da177e4SLinus Torvalds };
17231da177e4SLinus Torvalds 
17241da177e4SLinus Torvalds static int __init dm_multipath_init(void)
17251da177e4SLinus Torvalds {
17261da177e4SLinus Torvalds 	int r;
17271da177e4SLinus Torvalds 
17281da177e4SLinus Torvalds 	/* allocate a slab for the dm_ios */
1729028867acSAlasdair G Kergon 	_mpio_cache = KMEM_CACHE(dm_mpath_io, 0);
17301da177e4SLinus Torvalds 	if (!_mpio_cache)
17311da177e4SLinus Torvalds 		return -ENOMEM;
17321da177e4SLinus Torvalds 
17331da177e4SLinus Torvalds 	r = dm_register_target(&multipath_target);
17341da177e4SLinus Torvalds 	if (r < 0) {
17350cd33124SAlasdair G Kergon 		DMERR("register failed %d", r);
1736ff658e9cSJohannes Thumshirn 		r = -EINVAL;
1737ff658e9cSJohannes Thumshirn 		goto bad_register_target;
17381da177e4SLinus Torvalds 	}
17391da177e4SLinus Torvalds 
17404d4d66abSTejun Heo 	kmultipathd = alloc_workqueue("kmpathd", WQ_MEM_RECLAIM, 0);
1741c557308eSAlasdair G Kergon 	if (!kmultipathd) {
17420cd33124SAlasdair G Kergon 		DMERR("failed to create workqueue kmpathd");
1743ff658e9cSJohannes Thumshirn 		r = -ENOMEM;
1744ff658e9cSJohannes Thumshirn 		goto bad_alloc_kmultipathd;
1745c557308eSAlasdair G Kergon 	}
1746c557308eSAlasdair G Kergon 
1747bab7cfc7SChandra Seetharaman 	/*
1748bab7cfc7SChandra Seetharaman 	 * A separate workqueue is used to handle the device handlers
1749bab7cfc7SChandra Seetharaman 	 * to avoid overloading existing workqueue. Overloading the
1750bab7cfc7SChandra Seetharaman 	 * old workqueue would also create a bottleneck in the
1751bab7cfc7SChandra Seetharaman 	 * path of the storage hardware device activation.
1752bab7cfc7SChandra Seetharaman 	 */
17534d4d66abSTejun Heo 	kmpath_handlerd = alloc_ordered_workqueue("kmpath_handlerd",
17544d4d66abSTejun Heo 						  WQ_MEM_RECLAIM);
1755bab7cfc7SChandra Seetharaman 	if (!kmpath_handlerd) {
1756bab7cfc7SChandra Seetharaman 		DMERR("failed to create workqueue kmpath_handlerd");
1757ff658e9cSJohannes Thumshirn 		r = -ENOMEM;
1758ff658e9cSJohannes Thumshirn 		goto bad_alloc_kmpath_handlerd;
1759bab7cfc7SChandra Seetharaman 	}
1760bab7cfc7SChandra Seetharaman 
176172d94861SAlasdair G Kergon 	DMINFO("version %u.%u.%u loaded",
17621da177e4SLinus Torvalds 	       multipath_target.version[0], multipath_target.version[1],
17631da177e4SLinus Torvalds 	       multipath_target.version[2]);
17641da177e4SLinus Torvalds 
1765ff658e9cSJohannes Thumshirn 	return 0;
1766ff658e9cSJohannes Thumshirn 
1767ff658e9cSJohannes Thumshirn bad_alloc_kmpath_handlerd:
1768ff658e9cSJohannes Thumshirn 	destroy_workqueue(kmultipathd);
1769ff658e9cSJohannes Thumshirn bad_alloc_kmultipathd:
1770ff658e9cSJohannes Thumshirn 	dm_unregister_target(&multipath_target);
1771ff658e9cSJohannes Thumshirn bad_register_target:
1772ff658e9cSJohannes Thumshirn 	kmem_cache_destroy(_mpio_cache);
1773ff658e9cSJohannes Thumshirn 
17741da177e4SLinus Torvalds 	return r;
17751da177e4SLinus Torvalds }
17761da177e4SLinus Torvalds 
17771da177e4SLinus Torvalds static void __exit dm_multipath_exit(void)
17781da177e4SLinus Torvalds {
1779bab7cfc7SChandra Seetharaman 	destroy_workqueue(kmpath_handlerd);
1780c557308eSAlasdair G Kergon 	destroy_workqueue(kmultipathd);
1781c557308eSAlasdair G Kergon 
178210d3bd09SMikulas Patocka 	dm_unregister_target(&multipath_target);
17831da177e4SLinus Torvalds 	kmem_cache_destroy(_mpio_cache);
17841da177e4SLinus Torvalds }
17851da177e4SLinus Torvalds 
17861da177e4SLinus Torvalds module_init(dm_multipath_init);
17871da177e4SLinus Torvalds module_exit(dm_multipath_exit);
17881da177e4SLinus Torvalds 
17891da177e4SLinus Torvalds MODULE_DESCRIPTION(DM_NAME " multipath target");
17901da177e4SLinus Torvalds MODULE_AUTHOR("Sistina Software <dm-devel@redhat.com>");
17911da177e4SLinus Torvalds MODULE_LICENSE("GPL");
1792