xref: /openbmc/linux/drivers/md/dm-mpath.c (revision be7d31cca8865c63087ce502a8b3dca4600c2a13)
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>
2678ce23b5SMike Snitzer #include <linux/blk-mq.h>
271da177e4SLinus Torvalds 
2872d94861SAlasdair G Kergon #define DM_MSG_PREFIX "multipath"
294e2d19e4SChandra Seetharaman #define DM_PG_INIT_DELAY_MSECS 2000
304e2d19e4SChandra Seetharaman #define DM_PG_INIT_DELAY_DEFAULT ((unsigned) -1)
311da177e4SLinus Torvalds 
321da177e4SLinus Torvalds /* Path properties */
331da177e4SLinus Torvalds struct pgpath {
341da177e4SLinus Torvalds 	struct list_head list;
351da177e4SLinus Torvalds 
361da177e4SLinus Torvalds 	struct priority_group *pg;	/* Owning PG */
371da177e4SLinus Torvalds 	unsigned fail_count;		/* Cumulative failure count */
381da177e4SLinus Torvalds 
39c922d5f7SJosef "Jeff" Sipek 	struct dm_path path;
404e2d19e4SChandra Seetharaman 	struct delayed_work activate_path;
41*be7d31ccSMike Snitzer 
42*be7d31ccSMike Snitzer 	bool is_active:1;		/* Path status */
431da177e4SLinus Torvalds };
441da177e4SLinus Torvalds 
451da177e4SLinus Torvalds #define path_to_pgpath(__pgp) container_of((__pgp), struct pgpath, path)
461da177e4SLinus Torvalds 
471da177e4SLinus Torvalds /*
481da177e4SLinus Torvalds  * Paths are grouped into Priority Groups and numbered from 1 upwards.
491da177e4SLinus Torvalds  * Each has a path selector which controls which path gets used.
501da177e4SLinus Torvalds  */
511da177e4SLinus Torvalds struct priority_group {
521da177e4SLinus Torvalds 	struct list_head list;
531da177e4SLinus Torvalds 
541da177e4SLinus Torvalds 	struct multipath *m;		/* Owning multipath instance */
551da177e4SLinus Torvalds 	struct path_selector ps;
561da177e4SLinus Torvalds 
571da177e4SLinus Torvalds 	unsigned pg_num;		/* Reference number */
581da177e4SLinus Torvalds 	unsigned nr_pgpaths;		/* Number of paths in PG */
591da177e4SLinus Torvalds 	struct list_head pgpaths;
60*be7d31ccSMike Snitzer 
61*be7d31ccSMike Snitzer 	bool bypassed:1;		/* Temporarily bypass this PG? */
621da177e4SLinus Torvalds };
631da177e4SLinus Torvalds 
641da177e4SLinus Torvalds /* Multipath context */
651da177e4SLinus Torvalds struct multipath {
661da177e4SLinus Torvalds 	struct list_head list;
671da177e4SLinus Torvalds 	struct dm_target *ti;
681da177e4SLinus Torvalds 
69cfae5c9bSChandra Seetharaman 	const char *hw_handler_name;
702bfd2e13SChandra Seetharaman 	char *hw_handler_params;
714e2d19e4SChandra Seetharaman 
721fbdd2b3SMike Snitzer 	spinlock_t lock;
731fbdd2b3SMike Snitzer 
741da177e4SLinus Torvalds 	unsigned nr_priority_groups;
751da177e4SLinus Torvalds 	struct list_head priority_groups;
764e2d19e4SChandra Seetharaman 
774e2d19e4SChandra Seetharaman 	wait_queue_head_t pg_init_wait;	/* Wait for pg_init completion */
784e2d19e4SChandra Seetharaman 
79c3cd4f6bSAlasdair G Kergon 	unsigned pg_init_in_progress;	/* Only one pg_init allowed at once */
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 
86*be7d31ccSMike Snitzer 	bool queue_io:1;		/* Must we queue all I/O? */
87*be7d31ccSMike Snitzer 	bool queue_if_no_path:1;	/* Queue I/O if last path fails? */
88*be7d31ccSMike Snitzer 	bool saved_queue_if_no_path:1;	/* Saved state during suspension */
89*be7d31ccSMike Snitzer 	bool retain_attached_hw_handler:1; /* If there's already a hw_handler present, don't change it. */
90*be7d31ccSMike Snitzer 	bool pg_init_disabled:1;	/* pg_init is not currently allowed */
91*be7d31ccSMike Snitzer 	bool pg_init_required:1;	/* pg_init needs calling? */
92*be7d31ccSMike Snitzer 	bool pg_init_delay_retry:1;	/* Delay pg_init retry? */
931fbdd2b3SMike Snitzer 
94c9e45581SDave Wysochanski 	unsigned pg_init_retries;	/* Number of times to retry pg_init */
95c9e45581SDave Wysochanski 	unsigned pg_init_count;		/* Number of times pg_init called */
964e2d19e4SChandra Seetharaman 	unsigned pg_init_delay_msecs;	/* Number of msecs before pg_init retry */
971da177e4SLinus Torvalds 
981da177e4SLinus Torvalds 	struct work_struct trigger_event;
991da177e4SLinus Torvalds 
1001da177e4SLinus Torvalds 	/*
101028867acSAlasdair G Kergon 	 * We must use a mempool of dm_mpath_io structs so that we
1021da177e4SLinus Torvalds 	 * can resubmit bios on error.
1031da177e4SLinus Torvalds 	 */
1041da177e4SLinus Torvalds 	mempool_t *mpio_pool;
1056380f26fSMike Anderson 
1066380f26fSMike Anderson 	struct mutex work_mutex;
1071da177e4SLinus Torvalds };
1081da177e4SLinus Torvalds 
1091da177e4SLinus Torvalds /*
1101da177e4SLinus Torvalds  * Context information attached to each bio we process.
1111da177e4SLinus Torvalds  */
112028867acSAlasdair G Kergon struct dm_mpath_io {
1131da177e4SLinus Torvalds 	struct pgpath *pgpath;
11402ab823fSKiyoshi Ueda 	size_t nr_bytes;
1151da177e4SLinus Torvalds };
1161da177e4SLinus Torvalds 
1171da177e4SLinus Torvalds typedef int (*action_fn) (struct pgpath *pgpath);
1181da177e4SLinus Torvalds 
119e18b890bSChristoph Lameter static struct kmem_cache *_mpio_cache;
1201da177e4SLinus Torvalds 
121bab7cfc7SChandra Seetharaman static struct workqueue_struct *kmultipathd, *kmpath_handlerd;
122c4028958SDavid Howells static void trigger_event(struct work_struct *work);
123bab7cfc7SChandra Seetharaman static void activate_path(struct work_struct *work);
124e8099177SHannes Reinecke static int __pgpath_busy(struct pgpath *pgpath);
1251da177e4SLinus Torvalds 
1261da177e4SLinus Torvalds 
1271da177e4SLinus Torvalds /*-----------------------------------------------
1281da177e4SLinus Torvalds  * Allocation routines
1291da177e4SLinus Torvalds  *-----------------------------------------------*/
1301da177e4SLinus Torvalds 
1311da177e4SLinus Torvalds static struct pgpath *alloc_pgpath(void)
1321da177e4SLinus Torvalds {
133e69fae56SMicha³ Miros³aw 	struct pgpath *pgpath = kzalloc(sizeof(*pgpath), GFP_KERNEL);
1341da177e4SLinus Torvalds 
135224cb3e9SMike Anderson 	if (pgpath) {
136*be7d31ccSMike Snitzer 		pgpath->is_active = true;
1374e2d19e4SChandra Seetharaman 		INIT_DELAYED_WORK(&pgpath->activate_path, activate_path);
138224cb3e9SMike Anderson 	}
1391da177e4SLinus Torvalds 
1401da177e4SLinus Torvalds 	return pgpath;
1411da177e4SLinus Torvalds }
1421da177e4SLinus Torvalds 
143028867acSAlasdair G Kergon static void free_pgpath(struct pgpath *pgpath)
1441da177e4SLinus Torvalds {
1451da177e4SLinus Torvalds 	kfree(pgpath);
1461da177e4SLinus Torvalds }
1471da177e4SLinus Torvalds 
1481da177e4SLinus Torvalds static struct priority_group *alloc_priority_group(void)
1491da177e4SLinus Torvalds {
1501da177e4SLinus Torvalds 	struct priority_group *pg;
1511da177e4SLinus Torvalds 
152e69fae56SMicha³ Miros³aw 	pg = kzalloc(sizeof(*pg), GFP_KERNEL);
1531da177e4SLinus Torvalds 
154e69fae56SMicha³ Miros³aw 	if (pg)
1551da177e4SLinus Torvalds 		INIT_LIST_HEAD(&pg->pgpaths);
1561da177e4SLinus Torvalds 
1571da177e4SLinus Torvalds 	return pg;
1581da177e4SLinus Torvalds }
1591da177e4SLinus Torvalds 
1601da177e4SLinus Torvalds static void free_pgpaths(struct list_head *pgpaths, struct dm_target *ti)
1611da177e4SLinus Torvalds {
1621da177e4SLinus Torvalds 	struct pgpath *pgpath, *tmp;
1631da177e4SLinus Torvalds 
1641da177e4SLinus Torvalds 	list_for_each_entry_safe(pgpath, tmp, pgpaths, list) {
1651da177e4SLinus Torvalds 		list_del(&pgpath->list);
1661da177e4SLinus Torvalds 		dm_put_device(ti, pgpath->path.dev);
1671da177e4SLinus Torvalds 		free_pgpath(pgpath);
1681da177e4SLinus Torvalds 	}
1691da177e4SLinus Torvalds }
1701da177e4SLinus Torvalds 
1711da177e4SLinus Torvalds static void free_priority_group(struct priority_group *pg,
1721da177e4SLinus Torvalds 				struct dm_target *ti)
1731da177e4SLinus Torvalds {
1741da177e4SLinus Torvalds 	struct path_selector *ps = &pg->ps;
1751da177e4SLinus Torvalds 
1761da177e4SLinus Torvalds 	if (ps->type) {
1771da177e4SLinus Torvalds 		ps->type->destroy(ps);
1781da177e4SLinus Torvalds 		dm_put_path_selector(ps->type);
1791da177e4SLinus Torvalds 	}
1801da177e4SLinus Torvalds 
1811da177e4SLinus Torvalds 	free_pgpaths(&pg->pgpaths, ti);
1821da177e4SLinus Torvalds 	kfree(pg);
1831da177e4SLinus Torvalds }
1841da177e4SLinus Torvalds 
1858637a6bfSMike Snitzer static struct multipath *alloc_multipath(struct dm_target *ti, bool use_blk_mq)
1861da177e4SLinus Torvalds {
1871da177e4SLinus Torvalds 	struct multipath *m;
1881da177e4SLinus Torvalds 
189e69fae56SMicha³ Miros³aw 	m = kzalloc(sizeof(*m), GFP_KERNEL);
1901da177e4SLinus Torvalds 	if (m) {
1911da177e4SLinus Torvalds 		INIT_LIST_HEAD(&m->priority_groups);
1921da177e4SLinus Torvalds 		spin_lock_init(&m->lock);
193*be7d31ccSMike Snitzer 		m->queue_io = true;
1944e2d19e4SChandra Seetharaman 		m->pg_init_delay_msecs = DM_PG_INIT_DELAY_DEFAULT;
195c4028958SDavid Howells 		INIT_WORK(&m->trigger_event, trigger_event);
1962bded7bdSKiyoshi Ueda 		init_waitqueue_head(&m->pg_init_wait);
1976380f26fSMike Anderson 		mutex_init(&m->work_mutex);
1988637a6bfSMike Snitzer 
1998637a6bfSMike Snitzer 		m->mpio_pool = NULL;
2008637a6bfSMike Snitzer 		if (!use_blk_mq) {
2018637a6bfSMike Snitzer 			unsigned min_ios = dm_get_reserved_rq_based_ios();
2028637a6bfSMike Snitzer 
203f4790826SMike Snitzer 			m->mpio_pool = mempool_create_slab_pool(min_ios, _mpio_cache);
2041da177e4SLinus Torvalds 			if (!m->mpio_pool) {
2051da177e4SLinus Torvalds 				kfree(m);
2061da177e4SLinus Torvalds 				return NULL;
2071da177e4SLinus Torvalds 			}
2088637a6bfSMike Snitzer 		}
2098637a6bfSMike Snitzer 
21028f16c20SMicha³ Miros³aw 		m->ti = ti;
21128f16c20SMicha³ Miros³aw 		ti->private = m;
2121da177e4SLinus Torvalds 	}
2131da177e4SLinus Torvalds 
2141da177e4SLinus Torvalds 	return m;
2151da177e4SLinus Torvalds }
2161da177e4SLinus Torvalds 
2171da177e4SLinus Torvalds static void free_multipath(struct multipath *m)
2181da177e4SLinus Torvalds {
2191da177e4SLinus Torvalds 	struct priority_group *pg, *tmp;
2201da177e4SLinus Torvalds 
2211da177e4SLinus Torvalds 	list_for_each_entry_safe(pg, tmp, &m->priority_groups, list) {
2221da177e4SLinus Torvalds 		list_del(&pg->list);
2231da177e4SLinus Torvalds 		free_priority_group(pg, m->ti);
2241da177e4SLinus Torvalds 	}
2251da177e4SLinus Torvalds 
226cfae5c9bSChandra Seetharaman 	kfree(m->hw_handler_name);
2272bfd2e13SChandra Seetharaman 	kfree(m->hw_handler_params);
2281da177e4SLinus Torvalds 	mempool_destroy(m->mpio_pool);
2291da177e4SLinus Torvalds 	kfree(m);
2301da177e4SLinus Torvalds }
2311da177e4SLinus Torvalds 
2322eff1924SMike Snitzer static struct dm_mpath_io *get_mpio(union map_info *info)
2332eff1924SMike Snitzer {
2342eff1924SMike Snitzer 	return info->ptr;
2352eff1924SMike Snitzer }
2362eff1924SMike Snitzer 
2372eff1924SMike Snitzer static struct dm_mpath_io *set_mpio(struct multipath *m, union map_info *info)
238466891f9SJun'ichi Nomura {
239466891f9SJun'ichi Nomura 	struct dm_mpath_io *mpio;
240466891f9SJun'ichi Nomura 
2418637a6bfSMike Snitzer 	if (!m->mpio_pool) {
2428637a6bfSMike Snitzer 		/* Use blk-mq pdu memory requested via per_io_data_size */
2432eff1924SMike Snitzer 		mpio = get_mpio(info);
2448637a6bfSMike Snitzer 		memset(mpio, 0, sizeof(*mpio));
2458637a6bfSMike Snitzer 		return mpio;
2468637a6bfSMike Snitzer 	}
2478637a6bfSMike Snitzer 
248466891f9SJun'ichi Nomura 	mpio = mempool_alloc(m->mpio_pool, GFP_ATOMIC);
249466891f9SJun'ichi Nomura 	if (!mpio)
2502eff1924SMike Snitzer 		return NULL;
251466891f9SJun'ichi Nomura 
252466891f9SJun'ichi Nomura 	memset(mpio, 0, sizeof(*mpio));
253466891f9SJun'ichi Nomura 	info->ptr = mpio;
254466891f9SJun'ichi Nomura 
2552eff1924SMike Snitzer 	return mpio;
256466891f9SJun'ichi Nomura }
257466891f9SJun'ichi Nomura 
2582eff1924SMike Snitzer static void clear_request_fn_mpio(struct multipath *m, union map_info *info)
259466891f9SJun'ichi Nomura {
2602eff1924SMike Snitzer 	/* Only needed for non blk-mq (.request_fn) multipath */
2618637a6bfSMike Snitzer 	if (m->mpio_pool) {
262466891f9SJun'ichi Nomura 		struct dm_mpath_io *mpio = info->ptr;
263466891f9SJun'ichi Nomura 
264466891f9SJun'ichi Nomura 		info->ptr = NULL;
265466891f9SJun'ichi Nomura 		mempool_free(mpio, m->mpio_pool);
266466891f9SJun'ichi Nomura 	}
2678637a6bfSMike Snitzer }
2681da177e4SLinus Torvalds 
2691da177e4SLinus Torvalds /*-----------------------------------------------
2701da177e4SLinus Torvalds  * Path selection
2711da177e4SLinus Torvalds  *-----------------------------------------------*/
2721da177e4SLinus Torvalds 
2733e9f1be1SHannes Reinecke static int __pg_init_all_paths(struct multipath *m)
274fb612642SKiyoshi Ueda {
275fb612642SKiyoshi Ueda 	struct pgpath *pgpath;
2764e2d19e4SChandra Seetharaman 	unsigned long pg_init_delay = 0;
277fb612642SKiyoshi Ueda 
27817f4ff45SHannes Reinecke 	if (m->pg_init_in_progress || m->pg_init_disabled)
2793e9f1be1SHannes Reinecke 		return 0;
28017f4ff45SHannes Reinecke 
281fb612642SKiyoshi Ueda 	m->pg_init_count++;
282*be7d31ccSMike Snitzer 	m->pg_init_required = false;
2833e9f1be1SHannes Reinecke 
2843e9f1be1SHannes Reinecke 	/* Check here to reset pg_init_required */
2853e9f1be1SHannes Reinecke 	if (!m->current_pg)
2863e9f1be1SHannes Reinecke 		return 0;
2873e9f1be1SHannes Reinecke 
2884e2d19e4SChandra Seetharaman 	if (m->pg_init_delay_retry)
2894e2d19e4SChandra Seetharaman 		pg_init_delay = msecs_to_jiffies(m->pg_init_delay_msecs != DM_PG_INIT_DELAY_DEFAULT ?
2904e2d19e4SChandra Seetharaman 						 m->pg_init_delay_msecs : DM_PG_INIT_DELAY_MSECS);
291fb612642SKiyoshi Ueda 	list_for_each_entry(pgpath, &m->current_pg->pgpaths, list) {
292fb612642SKiyoshi Ueda 		/* Skip failed paths */
293fb612642SKiyoshi Ueda 		if (!pgpath->is_active)
294fb612642SKiyoshi Ueda 			continue;
2954e2d19e4SChandra Seetharaman 		if (queue_delayed_work(kmpath_handlerd, &pgpath->activate_path,
2964e2d19e4SChandra Seetharaman 				       pg_init_delay))
297fb612642SKiyoshi Ueda 			m->pg_init_in_progress++;
298fb612642SKiyoshi Ueda 	}
2993e9f1be1SHannes Reinecke 	return m->pg_init_in_progress;
300fb612642SKiyoshi Ueda }
301fb612642SKiyoshi Ueda 
3021da177e4SLinus Torvalds static void __switch_pg(struct multipath *m, struct pgpath *pgpath)
3031da177e4SLinus Torvalds {
3041da177e4SLinus Torvalds 	m->current_pg = pgpath->pg;
3051da177e4SLinus Torvalds 
3061da177e4SLinus Torvalds 	/* Must we initialise the PG first, and queue I/O till it's ready? */
307cfae5c9bSChandra Seetharaman 	if (m->hw_handler_name) {
308*be7d31ccSMike Snitzer 		m->pg_init_required = true;
309*be7d31ccSMike Snitzer 		m->queue_io = true;
3101da177e4SLinus Torvalds 	} else {
311*be7d31ccSMike Snitzer 		m->pg_init_required = false;
312*be7d31ccSMike Snitzer 		m->queue_io = false;
3131da177e4SLinus Torvalds 	}
314c9e45581SDave Wysochanski 
315c9e45581SDave Wysochanski 	m->pg_init_count = 0;
3161da177e4SLinus Torvalds }
3171da177e4SLinus Torvalds 
31802ab823fSKiyoshi Ueda static int __choose_path_in_pg(struct multipath *m, struct priority_group *pg,
31902ab823fSKiyoshi Ueda 			       size_t nr_bytes)
3201da177e4SLinus Torvalds {
321c922d5f7SJosef "Jeff" Sipek 	struct dm_path *path;
3221da177e4SLinus Torvalds 
32390a4323cSMike Snitzer 	path = pg->ps.type->select_path(&pg->ps, nr_bytes);
3241da177e4SLinus Torvalds 	if (!path)
3251da177e4SLinus Torvalds 		return -ENXIO;
3261da177e4SLinus Torvalds 
3271da177e4SLinus Torvalds 	m->current_pgpath = path_to_pgpath(path);
3281da177e4SLinus Torvalds 
3291da177e4SLinus Torvalds 	if (m->current_pg != pg)
3301da177e4SLinus Torvalds 		__switch_pg(m, m->current_pgpath);
3311da177e4SLinus Torvalds 
3321da177e4SLinus Torvalds 	return 0;
3331da177e4SLinus Torvalds }
3341da177e4SLinus Torvalds 
33502ab823fSKiyoshi Ueda static void __choose_pgpath(struct multipath *m, size_t nr_bytes)
3361da177e4SLinus Torvalds {
3371da177e4SLinus Torvalds 	struct priority_group *pg;
338*be7d31ccSMike Snitzer 	bool bypassed = true;
3391da177e4SLinus Torvalds 
3401f271972SBenjamin Marzinski 	if (!m->nr_valid_paths) {
341*be7d31ccSMike Snitzer 		m->queue_io = false;
3421da177e4SLinus Torvalds 		goto failed;
3431f271972SBenjamin Marzinski 	}
3441da177e4SLinus Torvalds 
3451da177e4SLinus Torvalds 	/* Were we instructed to switch PG? */
3461da177e4SLinus Torvalds 	if (m->next_pg) {
3471da177e4SLinus Torvalds 		pg = m->next_pg;
3481da177e4SLinus Torvalds 		m->next_pg = NULL;
34902ab823fSKiyoshi Ueda 		if (!__choose_path_in_pg(m, pg, nr_bytes))
3501da177e4SLinus Torvalds 			return;
3511da177e4SLinus Torvalds 	}
3521da177e4SLinus Torvalds 
3531da177e4SLinus Torvalds 	/* Don't change PG until it has no remaining paths */
35402ab823fSKiyoshi Ueda 	if (m->current_pg && !__choose_path_in_pg(m, m->current_pg, nr_bytes))
3551da177e4SLinus Torvalds 		return;
3561da177e4SLinus Torvalds 
3571da177e4SLinus Torvalds 	/*
3581da177e4SLinus Torvalds 	 * Loop through priority groups until we find a valid path.
3591da177e4SLinus Torvalds 	 * First time we skip PGs marked 'bypassed'.
360f220fd4eSMike Christie 	 * Second time we only try the ones we skipped, but set
361f220fd4eSMike Christie 	 * pg_init_delay_retry so we do not hammer controllers.
3621da177e4SLinus Torvalds 	 */
3631da177e4SLinus Torvalds 	do {
3641da177e4SLinus Torvalds 		list_for_each_entry(pg, &m->priority_groups, list) {
3651da177e4SLinus Torvalds 			if (pg->bypassed == bypassed)
3661da177e4SLinus Torvalds 				continue;
367f220fd4eSMike Christie 			if (!__choose_path_in_pg(m, pg, nr_bytes)) {
368f220fd4eSMike Christie 				if (!bypassed)
369*be7d31ccSMike Snitzer 					m->pg_init_delay_retry = true;
3701da177e4SLinus Torvalds 				return;
3711da177e4SLinus Torvalds 			}
372f220fd4eSMike Christie 		}
3731da177e4SLinus Torvalds 	} while (bypassed--);
3741da177e4SLinus Torvalds 
3751da177e4SLinus Torvalds failed:
3761da177e4SLinus Torvalds 	m->current_pgpath = NULL;
3771da177e4SLinus Torvalds 	m->current_pg = NULL;
3781da177e4SLinus Torvalds }
3791da177e4SLinus Torvalds 
38045e15720SKiyoshi Ueda /*
38145e15720SKiyoshi Ueda  * Check whether bios must be queued in the device-mapper core rather
38245e15720SKiyoshi Ueda  * than here in the target.
38345e15720SKiyoshi Ueda  *
38445e15720SKiyoshi Ueda  * m->lock must be held on entry.
38545e15720SKiyoshi Ueda  *
38645e15720SKiyoshi Ueda  * If m->queue_if_no_path and m->saved_queue_if_no_path hold the
38745e15720SKiyoshi Ueda  * same value then we are not between multipath_presuspend()
38845e15720SKiyoshi Ueda  * and multipath_resume() calls and we have no need to check
38945e15720SKiyoshi Ueda  * for the DMF_NOFLUSH_SUSPENDING flag.
39045e15720SKiyoshi Ueda  */
39145e15720SKiyoshi Ueda static int __must_push_back(struct multipath *m)
39245e15720SKiyoshi Ueda {
393e8099177SHannes Reinecke 	return (m->queue_if_no_path ||
394e8099177SHannes Reinecke 		(m->queue_if_no_path != m->saved_queue_if_no_path &&
395e8099177SHannes Reinecke 		 dm_noflush_suspending(m->ti)));
39645e15720SKiyoshi Ueda }
39745e15720SKiyoshi Ueda 
39836fcffccSHannes Reinecke /*
39936fcffccSHannes Reinecke  * Map cloned requests
40036fcffccSHannes Reinecke  */
401e5863d9aSMike Snitzer static int __multipath_map(struct dm_target *ti, struct request *clone,
402e5863d9aSMike Snitzer 			   union map_info *map_context,
403e5863d9aSMike Snitzer 			   struct request *rq, struct request **__clone)
4041da177e4SLinus Torvalds {
4057943bd6dSMike Snitzer 	struct multipath *m = ti->private;
406e3bde04fSHannes Reinecke 	int r = DM_MAPIO_REQUEUE;
407e5863d9aSMike Snitzer 	size_t nr_bytes = clone ? blk_rq_bytes(clone) : blk_rq_bytes(rq);
4081da177e4SLinus Torvalds 	struct pgpath *pgpath;
409f40c67f0SKiyoshi Ueda 	struct block_device *bdev;
410e3bde04fSHannes Reinecke 	struct dm_mpath_io *mpio;
4111da177e4SLinus Torvalds 
4122eb6e1e3SKeith Busch 	spin_lock_irq(&m->lock);
4131da177e4SLinus Torvalds 
4141da177e4SLinus Torvalds 	/* Do we need to select a new pgpath? */
41521136f89SMike Snitzer 	if (!m->current_pgpath || !m->queue_io)
41602ab823fSKiyoshi Ueda 		__choose_pgpath(m, nr_bytes);
4171da177e4SLinus Torvalds 
4181da177e4SLinus Torvalds 	pgpath = m->current_pgpath;
4191da177e4SLinus Torvalds 
4209bf59a61SMike Snitzer 	if (!pgpath) {
4219bf59a61SMike Snitzer 		if (!__must_push_back(m))
4229bf59a61SMike Snitzer 			r = -EIO;	/* Failed */
4239bf59a61SMike Snitzer 		goto out_unlock;
4246afbc01dSMike Snitzer 	} else if (m->queue_io || m->pg_init_required) {
4259bf59a61SMike Snitzer 		__pg_init_all_paths(m);
4269bf59a61SMike Snitzer 		goto out_unlock;
4279bf59a61SMike Snitzer 	}
4286afbc01dSMike Snitzer 
4292eff1924SMike Snitzer 	mpio = set_mpio(m, map_context);
4302eff1924SMike Snitzer 	if (!mpio)
431e3bde04fSHannes Reinecke 		/* ENOMEM, requeue */
432e3bde04fSHannes Reinecke 		goto out_unlock;
433e3bde04fSHannes Reinecke 
434e8099177SHannes Reinecke 	mpio->pgpath = pgpath;
435e8099177SHannes Reinecke 	mpio->nr_bytes = nr_bytes;
4362eb6e1e3SKeith Busch 
4372eb6e1e3SKeith Busch 	bdev = pgpath->path.dev->bdev;
4382eb6e1e3SKeith Busch 
439e5863d9aSMike Snitzer 	spin_unlock_irq(&m->lock);
440e5863d9aSMike Snitzer 
441e5863d9aSMike Snitzer 	if (clone) {
442c5248f79SMike Snitzer 		/*
443c5248f79SMike Snitzer 		 * Old request-based interface: allocated clone is passed in.
444c5248f79SMike Snitzer 		 * Used by: .request_fn stacked on .request_fn path(s).
445c5248f79SMike Snitzer 		 */
4462eb6e1e3SKeith Busch 		clone->q = bdev_get_queue(bdev);
4472eb6e1e3SKeith Busch 		clone->rq_disk = bdev->bd_disk;
4482eb6e1e3SKeith Busch 		clone->cmd_flags |= REQ_FAILFAST_TRANSPORT;
449e5863d9aSMike Snitzer 	} else {
450eca7ee6dSMike Snitzer 		/*
451eca7ee6dSMike Snitzer 		 * blk-mq request-based interface; used by both:
452eca7ee6dSMike Snitzer 		 * .request_fn stacked on blk-mq path(s) and
453eca7ee6dSMike Snitzer 		 * blk-mq stacked on blk-mq path(s).
454eca7ee6dSMike Snitzer 		 */
45578ce23b5SMike Snitzer 		*__clone = blk_mq_alloc_request(bdev_get_queue(bdev),
45678ce23b5SMike Snitzer 						rq_data_dir(rq), BLK_MQ_REQ_NOWAIT);
4574c6dd53dSMike Snitzer 		if (IS_ERR(*__clone)) {
458e5863d9aSMike Snitzer 			/* ENOMEM, requeue */
4592eff1924SMike Snitzer 			clear_request_fn_mpio(m, map_context);
460e5863d9aSMike Snitzer 			return r;
4614c6dd53dSMike Snitzer 		}
462e5863d9aSMike Snitzer 		(*__clone)->bio = (*__clone)->biotail = NULL;
463e5863d9aSMike Snitzer 		(*__clone)->rq_disk = bdev->bd_disk;
464e5863d9aSMike Snitzer 		(*__clone)->cmd_flags |= REQ_FAILFAST_TRANSPORT;
465e5863d9aSMike Snitzer 	}
4662eb6e1e3SKeith Busch 
467e8099177SHannes Reinecke 	if (pgpath->pg->ps.type->start_io)
468e8099177SHannes Reinecke 		pgpath->pg->ps.type->start_io(&pgpath->pg->ps,
469e8099177SHannes Reinecke 					      &pgpath->path,
470e8099177SHannes Reinecke 					      nr_bytes);
4712eb6e1e3SKeith Busch 	return DM_MAPIO_REMAPPED;
4721da177e4SLinus Torvalds 
473e3bde04fSHannes Reinecke out_unlock:
4742eb6e1e3SKeith Busch 	spin_unlock_irq(&m->lock);
4751da177e4SLinus Torvalds 
4761da177e4SLinus Torvalds 	return r;
4771da177e4SLinus Torvalds }
4781da177e4SLinus Torvalds 
479e5863d9aSMike Snitzer static int multipath_map(struct dm_target *ti, struct request *clone,
480e5863d9aSMike Snitzer 			 union map_info *map_context)
481e5863d9aSMike Snitzer {
482e5863d9aSMike Snitzer 	return __multipath_map(ti, clone, map_context, NULL, NULL);
483e5863d9aSMike Snitzer }
484e5863d9aSMike Snitzer 
485e5863d9aSMike Snitzer static int multipath_clone_and_map(struct dm_target *ti, struct request *rq,
486e5863d9aSMike Snitzer 				   union map_info *map_context,
487e5863d9aSMike Snitzer 				   struct request **clone)
488e5863d9aSMike Snitzer {
489e5863d9aSMike Snitzer 	return __multipath_map(ti, NULL, map_context, rq, clone);
490e5863d9aSMike Snitzer }
491e5863d9aSMike Snitzer 
492e5863d9aSMike Snitzer static void multipath_release_clone(struct request *clone)
493e5863d9aSMike Snitzer {
49478ce23b5SMike Snitzer 	blk_mq_free_request(clone);
495e5863d9aSMike Snitzer }
496e5863d9aSMike Snitzer 
4971da177e4SLinus Torvalds /*
4981da177e4SLinus Torvalds  * If we run out of usable paths, should we queue I/O or error it?
4991da177e4SLinus Torvalds  */
500*be7d31ccSMike Snitzer static int queue_if_no_path(struct multipath *m, bool queue_if_no_path,
501*be7d31ccSMike Snitzer 			    bool save_old_value)
5021da177e4SLinus Torvalds {
5031da177e4SLinus Torvalds 	unsigned long flags;
5041da177e4SLinus Torvalds 
5051da177e4SLinus Torvalds 	spin_lock_irqsave(&m->lock, flags);
5061da177e4SLinus Torvalds 
507485ef69eSAlasdair G Kergon 	if (save_old_value)
508436d4108SAlasdair G Kergon 		m->saved_queue_if_no_path = m->queue_if_no_path;
509485ef69eSAlasdair G Kergon 	else
510485ef69eSAlasdair G Kergon 		m->saved_queue_if_no_path = queue_if_no_path;
5111da177e4SLinus Torvalds 	m->queue_if_no_path = queue_if_no_path;
5121da177e4SLinus Torvalds 	spin_unlock_irqrestore(&m->lock, flags);
5131da177e4SLinus Torvalds 
51463d832c3SHannes Reinecke 	if (!queue_if_no_path)
51563d832c3SHannes Reinecke 		dm_table_run_md_queue_async(m->ti->table);
51663d832c3SHannes Reinecke 
5171da177e4SLinus Torvalds 	return 0;
5181da177e4SLinus Torvalds }
5191da177e4SLinus Torvalds 
5201da177e4SLinus Torvalds /*
5211da177e4SLinus Torvalds  * An event is triggered whenever a path is taken out of use.
5221da177e4SLinus Torvalds  * Includes path failure and PG bypass.
5231da177e4SLinus Torvalds  */
524c4028958SDavid Howells static void trigger_event(struct work_struct *work)
5251da177e4SLinus Torvalds {
526c4028958SDavid Howells 	struct multipath *m =
527c4028958SDavid Howells 		container_of(work, struct multipath, trigger_event);
5281da177e4SLinus Torvalds 
5291da177e4SLinus Torvalds 	dm_table_event(m->ti->table);
5301da177e4SLinus Torvalds }
5311da177e4SLinus Torvalds 
5321da177e4SLinus Torvalds /*-----------------------------------------------------------------
5331da177e4SLinus Torvalds  * Constructor/argument parsing:
5341da177e4SLinus Torvalds  * <#multipath feature args> [<arg>]*
5351da177e4SLinus Torvalds  * <#hw_handler args> [hw_handler [<arg>]*]
5361da177e4SLinus Torvalds  * <#priority groups>
5371da177e4SLinus Torvalds  * <initial priority group>
5381da177e4SLinus Torvalds  *     [<selector> <#selector args> [<arg>]*
5391da177e4SLinus Torvalds  *      <#paths> <#per-path selector args>
5401da177e4SLinus Torvalds  *         [<path> [<arg>]* ]+ ]+
5411da177e4SLinus Torvalds  *---------------------------------------------------------------*/
542498f0103SMike Snitzer static int parse_path_selector(struct dm_arg_set *as, struct priority_group *pg,
5431da177e4SLinus Torvalds 			       struct dm_target *ti)
5441da177e4SLinus Torvalds {
5451da177e4SLinus Torvalds 	int r;
5461da177e4SLinus Torvalds 	struct path_selector_type *pst;
5471da177e4SLinus Torvalds 	unsigned ps_argc;
5481da177e4SLinus Torvalds 
549498f0103SMike Snitzer 	static struct dm_arg _args[] = {
55072d94861SAlasdair G Kergon 		{0, 1024, "invalid number of path selector args"},
5511da177e4SLinus Torvalds 	};
5521da177e4SLinus Torvalds 
553498f0103SMike Snitzer 	pst = dm_get_path_selector(dm_shift_arg(as));
5541da177e4SLinus Torvalds 	if (!pst) {
55572d94861SAlasdair G Kergon 		ti->error = "unknown path selector type";
5561da177e4SLinus Torvalds 		return -EINVAL;
5571da177e4SLinus Torvalds 	}
5581da177e4SLinus Torvalds 
559498f0103SMike Snitzer 	r = dm_read_arg_group(_args, as, &ps_argc, &ti->error);
560371b2e34SMikulas Patocka 	if (r) {
561371b2e34SMikulas Patocka 		dm_put_path_selector(pst);
5621da177e4SLinus Torvalds 		return -EINVAL;
563371b2e34SMikulas Patocka 	}
5641da177e4SLinus Torvalds 
5651da177e4SLinus Torvalds 	r = pst->create(&pg->ps, ps_argc, as->argv);
5661da177e4SLinus Torvalds 	if (r) {
5671da177e4SLinus Torvalds 		dm_put_path_selector(pst);
56872d94861SAlasdair G Kergon 		ti->error = "path selector constructor failed";
5691da177e4SLinus Torvalds 		return r;
5701da177e4SLinus Torvalds 	}
5711da177e4SLinus Torvalds 
5721da177e4SLinus Torvalds 	pg->ps.type = pst;
573498f0103SMike Snitzer 	dm_consume_args(as, ps_argc);
5741da177e4SLinus Torvalds 
5751da177e4SLinus Torvalds 	return 0;
5761da177e4SLinus Torvalds }
5771da177e4SLinus Torvalds 
578498f0103SMike Snitzer static struct pgpath *parse_path(struct dm_arg_set *as, struct path_selector *ps,
5791da177e4SLinus Torvalds 			       struct dm_target *ti)
5801da177e4SLinus Torvalds {
5811da177e4SLinus Torvalds 	int r;
5821da177e4SLinus Torvalds 	struct pgpath *p;
583ae11b1b3SHannes Reinecke 	struct multipath *m = ti->private;
584a58a935dSMike Snitzer 	struct request_queue *q = NULL;
585a58a935dSMike Snitzer 	const char *attached_handler_name;
5861da177e4SLinus Torvalds 
5871da177e4SLinus Torvalds 	/* we need at least a path arg */
5881da177e4SLinus Torvalds 	if (as->argc < 1) {
58972d94861SAlasdair G Kergon 		ti->error = "no device given";
59001460f35SBenjamin Marzinski 		return ERR_PTR(-EINVAL);
5911da177e4SLinus Torvalds 	}
5921da177e4SLinus Torvalds 
5931da177e4SLinus Torvalds 	p = alloc_pgpath();
5941da177e4SLinus Torvalds 	if (!p)
59501460f35SBenjamin Marzinski 		return ERR_PTR(-ENOMEM);
5961da177e4SLinus Torvalds 
597498f0103SMike Snitzer 	r = dm_get_device(ti, dm_shift_arg(as), dm_table_get_mode(ti->table),
5988215d6ecSNikanth Karthikesan 			  &p->path.dev);
5991da177e4SLinus Torvalds 	if (r) {
60072d94861SAlasdair G Kergon 		ti->error = "error getting device";
6011da177e4SLinus Torvalds 		goto bad;
6021da177e4SLinus Torvalds 	}
6031da177e4SLinus Torvalds 
604a58a935dSMike Snitzer 	if (m->retain_attached_hw_handler || m->hw_handler_name)
605a58a935dSMike Snitzer 		q = bdev_get_queue(p->path.dev->bdev);
606a0cf7ea9SHannes Reinecke 
607a58a935dSMike Snitzer 	if (m->retain_attached_hw_handler) {
6081bab0de0SChristoph Hellwig retain:
609a58a935dSMike Snitzer 		attached_handler_name = scsi_dh_attached_handler_name(q, GFP_KERNEL);
610a58a935dSMike Snitzer 		if (attached_handler_name) {
611a58a935dSMike Snitzer 			/*
612a58a935dSMike Snitzer 			 * Reset hw_handler_name to match the attached handler
613a58a935dSMike Snitzer 			 * and clear any hw_handler_params associated with the
614a58a935dSMike Snitzer 			 * ignored handler.
615a58a935dSMike Snitzer 			 *
616a58a935dSMike Snitzer 			 * NB. This modifies the table line to show the actual
617a58a935dSMike Snitzer 			 * handler instead of the original table passed in.
618a58a935dSMike Snitzer 			 */
619a58a935dSMike Snitzer 			kfree(m->hw_handler_name);
620a58a935dSMike Snitzer 			m->hw_handler_name = attached_handler_name;
621a58a935dSMike Snitzer 
622a58a935dSMike Snitzer 			kfree(m->hw_handler_params);
623a58a935dSMike Snitzer 			m->hw_handler_params = NULL;
624a58a935dSMike Snitzer 		}
625a58a935dSMike Snitzer 	}
626a58a935dSMike Snitzer 
627a58a935dSMike Snitzer 	if (m->hw_handler_name) {
628a0cf7ea9SHannes Reinecke 		r = scsi_dh_attach(q, m->hw_handler_name);
629a0cf7ea9SHannes Reinecke 		if (r == -EBUSY) {
6301bab0de0SChristoph Hellwig 			char b[BDEVNAME_SIZE];
631a0cf7ea9SHannes Reinecke 
6321bab0de0SChristoph Hellwig 			printk(KERN_INFO "dm-mpath: retaining handler on device %s\n",
6331bab0de0SChristoph Hellwig 				bdevname(p->path.dev->bdev, b));
6341bab0de0SChristoph Hellwig 			goto retain;
6351bab0de0SChristoph Hellwig 		}
636ae11b1b3SHannes Reinecke 		if (r < 0) {
637a0cf7ea9SHannes Reinecke 			ti->error = "error attaching hardware handler";
638ae11b1b3SHannes Reinecke 			dm_put_device(ti, p->path.dev);
639ae11b1b3SHannes Reinecke 			goto bad;
640ae11b1b3SHannes Reinecke 		}
6412bfd2e13SChandra Seetharaman 
6422bfd2e13SChandra Seetharaman 		if (m->hw_handler_params) {
6432bfd2e13SChandra Seetharaman 			r = scsi_dh_set_params(q, m->hw_handler_params);
6442bfd2e13SChandra Seetharaman 			if (r < 0) {
6452bfd2e13SChandra Seetharaman 				ti->error = "unable to set hardware "
6462bfd2e13SChandra Seetharaman 							"handler parameters";
6472bfd2e13SChandra Seetharaman 				dm_put_device(ti, p->path.dev);
6482bfd2e13SChandra Seetharaman 				goto bad;
6492bfd2e13SChandra Seetharaman 			}
6502bfd2e13SChandra Seetharaman 		}
651ae11b1b3SHannes Reinecke 	}
652ae11b1b3SHannes Reinecke 
6531da177e4SLinus Torvalds 	r = ps->type->add_path(ps, &p->path, as->argc, as->argv, &ti->error);
6541da177e4SLinus Torvalds 	if (r) {
6551da177e4SLinus Torvalds 		dm_put_device(ti, p->path.dev);
6561da177e4SLinus Torvalds 		goto bad;
6571da177e4SLinus Torvalds 	}
6581da177e4SLinus Torvalds 
6591da177e4SLinus Torvalds 	return p;
6601da177e4SLinus Torvalds 
6611da177e4SLinus Torvalds  bad:
6621da177e4SLinus Torvalds 	free_pgpath(p);
66301460f35SBenjamin Marzinski 	return ERR_PTR(r);
6641da177e4SLinus Torvalds }
6651da177e4SLinus Torvalds 
666498f0103SMike Snitzer static struct priority_group *parse_priority_group(struct dm_arg_set *as,
66728f16c20SMicha³ Miros³aw 						   struct multipath *m)
6681da177e4SLinus Torvalds {
669498f0103SMike Snitzer 	static struct dm_arg _args[] = {
67072d94861SAlasdair G Kergon 		{1, 1024, "invalid number of paths"},
67172d94861SAlasdair G Kergon 		{0, 1024, "invalid number of selector args"}
6721da177e4SLinus Torvalds 	};
6731da177e4SLinus Torvalds 
6741da177e4SLinus Torvalds 	int r;
675498f0103SMike Snitzer 	unsigned i, nr_selector_args, nr_args;
6761da177e4SLinus Torvalds 	struct priority_group *pg;
67728f16c20SMicha³ Miros³aw 	struct dm_target *ti = m->ti;
6781da177e4SLinus Torvalds 
6791da177e4SLinus Torvalds 	if (as->argc < 2) {
6801da177e4SLinus Torvalds 		as->argc = 0;
68101460f35SBenjamin Marzinski 		ti->error = "not enough priority group arguments";
68201460f35SBenjamin Marzinski 		return ERR_PTR(-EINVAL);
6831da177e4SLinus Torvalds 	}
6841da177e4SLinus Torvalds 
6851da177e4SLinus Torvalds 	pg = alloc_priority_group();
6861da177e4SLinus Torvalds 	if (!pg) {
68772d94861SAlasdair G Kergon 		ti->error = "couldn't allocate priority group";
68801460f35SBenjamin Marzinski 		return ERR_PTR(-ENOMEM);
6891da177e4SLinus Torvalds 	}
6901da177e4SLinus Torvalds 	pg->m = m;
6911da177e4SLinus Torvalds 
6921da177e4SLinus Torvalds 	r = parse_path_selector(as, pg, ti);
6931da177e4SLinus Torvalds 	if (r)
6941da177e4SLinus Torvalds 		goto bad;
6951da177e4SLinus Torvalds 
6961da177e4SLinus Torvalds 	/*
6971da177e4SLinus Torvalds 	 * read the paths
6981da177e4SLinus Torvalds 	 */
699498f0103SMike Snitzer 	r = dm_read_arg(_args, as, &pg->nr_pgpaths, &ti->error);
7001da177e4SLinus Torvalds 	if (r)
7011da177e4SLinus Torvalds 		goto bad;
7021da177e4SLinus Torvalds 
703498f0103SMike Snitzer 	r = dm_read_arg(_args + 1, as, &nr_selector_args, &ti->error);
7041da177e4SLinus Torvalds 	if (r)
7051da177e4SLinus Torvalds 		goto bad;
7061da177e4SLinus Torvalds 
707498f0103SMike Snitzer 	nr_args = 1 + nr_selector_args;
7081da177e4SLinus Torvalds 	for (i = 0; i < pg->nr_pgpaths; i++) {
7091da177e4SLinus Torvalds 		struct pgpath *pgpath;
710498f0103SMike Snitzer 		struct dm_arg_set path_args;
7111da177e4SLinus Torvalds 
712498f0103SMike Snitzer 		if (as->argc < nr_args) {
713148acff6SMikulas Patocka 			ti->error = "not enough path parameters";
7146bbf79a1SAlasdair G Kergon 			r = -EINVAL;
7151da177e4SLinus Torvalds 			goto bad;
716148acff6SMikulas Patocka 		}
7171da177e4SLinus Torvalds 
718498f0103SMike Snitzer 		path_args.argc = nr_args;
7191da177e4SLinus Torvalds 		path_args.argv = as->argv;
7201da177e4SLinus Torvalds 
7211da177e4SLinus Torvalds 		pgpath = parse_path(&path_args, &pg->ps, ti);
72201460f35SBenjamin Marzinski 		if (IS_ERR(pgpath)) {
72301460f35SBenjamin Marzinski 			r = PTR_ERR(pgpath);
7241da177e4SLinus Torvalds 			goto bad;
72501460f35SBenjamin Marzinski 		}
7261da177e4SLinus Torvalds 
7271da177e4SLinus Torvalds 		pgpath->pg = pg;
7281da177e4SLinus Torvalds 		list_add_tail(&pgpath->list, &pg->pgpaths);
729498f0103SMike Snitzer 		dm_consume_args(as, nr_args);
7301da177e4SLinus Torvalds 	}
7311da177e4SLinus Torvalds 
7321da177e4SLinus Torvalds 	return pg;
7331da177e4SLinus Torvalds 
7341da177e4SLinus Torvalds  bad:
7351da177e4SLinus Torvalds 	free_priority_group(pg, ti);
73601460f35SBenjamin Marzinski 	return ERR_PTR(r);
7371da177e4SLinus Torvalds }
7381da177e4SLinus Torvalds 
739498f0103SMike Snitzer static int parse_hw_handler(struct dm_arg_set *as, struct multipath *m)
7401da177e4SLinus Torvalds {
7411da177e4SLinus Torvalds 	unsigned hw_argc;
7422bfd2e13SChandra Seetharaman 	int ret;
74328f16c20SMicha³ Miros³aw 	struct dm_target *ti = m->ti;
7441da177e4SLinus Torvalds 
745498f0103SMike Snitzer 	static struct dm_arg _args[] = {
74672d94861SAlasdair G Kergon 		{0, 1024, "invalid number of hardware handler args"},
7471da177e4SLinus Torvalds 	};
7481da177e4SLinus Torvalds 
749498f0103SMike Snitzer 	if (dm_read_arg_group(_args, as, &hw_argc, &ti->error))
7501da177e4SLinus Torvalds 		return -EINVAL;
7511da177e4SLinus Torvalds 
7521da177e4SLinus Torvalds 	if (!hw_argc)
7531da177e4SLinus Torvalds 		return 0;
7541da177e4SLinus Torvalds 
755498f0103SMike Snitzer 	m->hw_handler_name = kstrdup(dm_shift_arg(as), GFP_KERNEL);
75614e98c5cSChandra Seetharaman 
7572bfd2e13SChandra Seetharaman 	if (hw_argc > 1) {
7582bfd2e13SChandra Seetharaman 		char *p;
7592bfd2e13SChandra Seetharaman 		int i, j, len = 4;
7602bfd2e13SChandra Seetharaman 
7612bfd2e13SChandra Seetharaman 		for (i = 0; i <= hw_argc - 2; i++)
7622bfd2e13SChandra Seetharaman 			len += strlen(as->argv[i]) + 1;
7632bfd2e13SChandra Seetharaman 		p = m->hw_handler_params = kzalloc(len, GFP_KERNEL);
7642bfd2e13SChandra Seetharaman 		if (!p) {
7652bfd2e13SChandra Seetharaman 			ti->error = "memory allocation failed";
7662bfd2e13SChandra Seetharaman 			ret = -ENOMEM;
7672bfd2e13SChandra Seetharaman 			goto fail;
7682bfd2e13SChandra Seetharaman 		}
7692bfd2e13SChandra Seetharaman 		j = sprintf(p, "%d", hw_argc - 1);
7702bfd2e13SChandra Seetharaman 		for (i = 0, p+=j+1; i <= hw_argc - 2; i++, p+=j+1)
7712bfd2e13SChandra Seetharaman 			j = sprintf(p, "%s", as->argv[i]);
7722bfd2e13SChandra Seetharaman 	}
773498f0103SMike Snitzer 	dm_consume_args(as, hw_argc - 1);
7741da177e4SLinus Torvalds 
7751da177e4SLinus Torvalds 	return 0;
7762bfd2e13SChandra Seetharaman fail:
7772bfd2e13SChandra Seetharaman 	kfree(m->hw_handler_name);
7782bfd2e13SChandra Seetharaman 	m->hw_handler_name = NULL;
7792bfd2e13SChandra Seetharaman 	return ret;
7801da177e4SLinus Torvalds }
7811da177e4SLinus Torvalds 
782498f0103SMike Snitzer static int parse_features(struct dm_arg_set *as, struct multipath *m)
7831da177e4SLinus Torvalds {
7841da177e4SLinus Torvalds 	int r;
7851da177e4SLinus Torvalds 	unsigned argc;
78628f16c20SMicha³ Miros³aw 	struct dm_target *ti = m->ti;
787498f0103SMike Snitzer 	const char *arg_name;
7881da177e4SLinus Torvalds 
789498f0103SMike Snitzer 	static struct dm_arg _args[] = {
790a58a935dSMike Snitzer 		{0, 6, "invalid number of feature args"},
791c9e45581SDave Wysochanski 		{1, 50, "pg_init_retries must be between 1 and 50"},
7924e2d19e4SChandra Seetharaman 		{0, 60000, "pg_init_delay_msecs must be between 0 and 60000"},
7931da177e4SLinus Torvalds 	};
7941da177e4SLinus Torvalds 
795498f0103SMike Snitzer 	r = dm_read_arg_group(_args, as, &argc, &ti->error);
7961da177e4SLinus Torvalds 	if (r)
7971da177e4SLinus Torvalds 		return -EINVAL;
7981da177e4SLinus Torvalds 
7991da177e4SLinus Torvalds 	if (!argc)
8001da177e4SLinus Torvalds 		return 0;
8011da177e4SLinus Torvalds 
802c9e45581SDave Wysochanski 	do {
803498f0103SMike Snitzer 		arg_name = dm_shift_arg(as);
804c9e45581SDave Wysochanski 		argc--;
805c9e45581SDave Wysochanski 
806498f0103SMike Snitzer 		if (!strcasecmp(arg_name, "queue_if_no_path")) {
807*be7d31ccSMike Snitzer 			r = queue_if_no_path(m, true, false);
808c9e45581SDave Wysochanski 			continue;
8091da177e4SLinus Torvalds 		}
810c9e45581SDave Wysochanski 
811a58a935dSMike Snitzer 		if (!strcasecmp(arg_name, "retain_attached_hw_handler")) {
812*be7d31ccSMike Snitzer 			m->retain_attached_hw_handler = true;
813a58a935dSMike Snitzer 			continue;
814a58a935dSMike Snitzer 		}
815a58a935dSMike Snitzer 
816498f0103SMike Snitzer 		if (!strcasecmp(arg_name, "pg_init_retries") &&
817c9e45581SDave Wysochanski 		    (argc >= 1)) {
818498f0103SMike Snitzer 			r = dm_read_arg(_args + 1, as, &m->pg_init_retries, &ti->error);
819c9e45581SDave Wysochanski 			argc--;
820c9e45581SDave Wysochanski 			continue;
821c9e45581SDave Wysochanski 		}
822c9e45581SDave Wysochanski 
823498f0103SMike Snitzer 		if (!strcasecmp(arg_name, "pg_init_delay_msecs") &&
8244e2d19e4SChandra Seetharaman 		    (argc >= 1)) {
825498f0103SMike Snitzer 			r = dm_read_arg(_args + 2, as, &m->pg_init_delay_msecs, &ti->error);
8264e2d19e4SChandra Seetharaman 			argc--;
8274e2d19e4SChandra Seetharaman 			continue;
8284e2d19e4SChandra Seetharaman 		}
8294e2d19e4SChandra Seetharaman 
830c9e45581SDave Wysochanski 		ti->error = "Unrecognised multipath feature request";
831c9e45581SDave Wysochanski 		r = -EINVAL;
832c9e45581SDave Wysochanski 	} while (argc && !r);
833c9e45581SDave Wysochanski 
834c9e45581SDave Wysochanski 	return r;
8351da177e4SLinus Torvalds }
8361da177e4SLinus Torvalds 
8371da177e4SLinus Torvalds static int multipath_ctr(struct dm_target *ti, unsigned int argc,
8381da177e4SLinus Torvalds 			 char **argv)
8391da177e4SLinus Torvalds {
840498f0103SMike Snitzer 	/* target arguments */
841498f0103SMike Snitzer 	static struct dm_arg _args[] = {
842a490a07aSMike Snitzer 		{0, 1024, "invalid number of priority groups"},
843a490a07aSMike Snitzer 		{0, 1024, "invalid initial priority group number"},
8441da177e4SLinus Torvalds 	};
8451da177e4SLinus Torvalds 
8461da177e4SLinus Torvalds 	int r;
8471da177e4SLinus Torvalds 	struct multipath *m;
848498f0103SMike Snitzer 	struct dm_arg_set as;
8491da177e4SLinus Torvalds 	unsigned pg_count = 0;
8501da177e4SLinus Torvalds 	unsigned next_pg_num;
8518637a6bfSMike Snitzer 	bool use_blk_mq = dm_use_blk_mq(dm_table_get_md(ti->table));
8521da177e4SLinus Torvalds 
8531da177e4SLinus Torvalds 	as.argc = argc;
8541da177e4SLinus Torvalds 	as.argv = argv;
8551da177e4SLinus Torvalds 
8568637a6bfSMike Snitzer 	m = alloc_multipath(ti, use_blk_mq);
8571da177e4SLinus Torvalds 	if (!m) {
85872d94861SAlasdair G Kergon 		ti->error = "can't allocate multipath";
8591da177e4SLinus Torvalds 		return -EINVAL;
8601da177e4SLinus Torvalds 	}
8611da177e4SLinus Torvalds 
86228f16c20SMicha³ Miros³aw 	r = parse_features(&as, m);
8631da177e4SLinus Torvalds 	if (r)
8641da177e4SLinus Torvalds 		goto bad;
8651da177e4SLinus Torvalds 
86628f16c20SMicha³ Miros³aw 	r = parse_hw_handler(&as, m);
8671da177e4SLinus Torvalds 	if (r)
8681da177e4SLinus Torvalds 		goto bad;
8691da177e4SLinus Torvalds 
870498f0103SMike Snitzer 	r = dm_read_arg(_args, &as, &m->nr_priority_groups, &ti->error);
8711da177e4SLinus Torvalds 	if (r)
8721da177e4SLinus Torvalds 		goto bad;
8731da177e4SLinus Torvalds 
874498f0103SMike Snitzer 	r = dm_read_arg(_args + 1, &as, &next_pg_num, &ti->error);
8751da177e4SLinus Torvalds 	if (r)
8761da177e4SLinus Torvalds 		goto bad;
8771da177e4SLinus Torvalds 
878a490a07aSMike Snitzer 	if ((!m->nr_priority_groups && next_pg_num) ||
879a490a07aSMike Snitzer 	    (m->nr_priority_groups && !next_pg_num)) {
880a490a07aSMike Snitzer 		ti->error = "invalid initial priority group";
881a490a07aSMike Snitzer 		r = -EINVAL;
882a490a07aSMike Snitzer 		goto bad;
883a490a07aSMike Snitzer 	}
884a490a07aSMike Snitzer 
8851da177e4SLinus Torvalds 	/* parse the priority groups */
8861da177e4SLinus Torvalds 	while (as.argc) {
8871da177e4SLinus Torvalds 		struct priority_group *pg;
8881da177e4SLinus Torvalds 
88928f16c20SMicha³ Miros³aw 		pg = parse_priority_group(&as, m);
89001460f35SBenjamin Marzinski 		if (IS_ERR(pg)) {
89101460f35SBenjamin Marzinski 			r = PTR_ERR(pg);
8921da177e4SLinus Torvalds 			goto bad;
8931da177e4SLinus Torvalds 		}
8941da177e4SLinus Torvalds 
8951da177e4SLinus Torvalds 		m->nr_valid_paths += pg->nr_pgpaths;
8961da177e4SLinus Torvalds 		list_add_tail(&pg->list, &m->priority_groups);
8971da177e4SLinus Torvalds 		pg_count++;
8981da177e4SLinus Torvalds 		pg->pg_num = pg_count;
8991da177e4SLinus Torvalds 		if (!--next_pg_num)
9001da177e4SLinus Torvalds 			m->next_pg = pg;
9011da177e4SLinus Torvalds 	}
9021da177e4SLinus Torvalds 
9031da177e4SLinus Torvalds 	if (pg_count != m->nr_priority_groups) {
90472d94861SAlasdair G Kergon 		ti->error = "priority group count mismatch";
9051da177e4SLinus Torvalds 		r = -EINVAL;
9061da177e4SLinus Torvalds 		goto bad;
9071da177e4SLinus Torvalds 	}
9081da177e4SLinus Torvalds 
90955a62eefSAlasdair G Kergon 	ti->num_flush_bios = 1;
91055a62eefSAlasdair G Kergon 	ti->num_discard_bios = 1;
911042bcef8SMike Snitzer 	ti->num_write_same_bios = 1;
9128637a6bfSMike Snitzer 	if (use_blk_mq)
9138637a6bfSMike Snitzer 		ti->per_io_data_size = sizeof(struct dm_mpath_io);
9148627921fSMikulas Patocka 
9151da177e4SLinus Torvalds 	return 0;
9161da177e4SLinus Torvalds 
9171da177e4SLinus Torvalds  bad:
9181da177e4SLinus Torvalds 	free_multipath(m);
9191da177e4SLinus Torvalds 	return r;
9201da177e4SLinus Torvalds }
9211da177e4SLinus Torvalds 
9222bded7bdSKiyoshi Ueda static void multipath_wait_for_pg_init_completion(struct multipath *m)
9232bded7bdSKiyoshi Ueda {
9242bded7bdSKiyoshi Ueda 	DECLARE_WAITQUEUE(wait, current);
9252bded7bdSKiyoshi Ueda 	unsigned long flags;
9262bded7bdSKiyoshi Ueda 
9272bded7bdSKiyoshi Ueda 	add_wait_queue(&m->pg_init_wait, &wait);
9282bded7bdSKiyoshi Ueda 
9292bded7bdSKiyoshi Ueda 	while (1) {
9302bded7bdSKiyoshi Ueda 		set_current_state(TASK_UNINTERRUPTIBLE);
9312bded7bdSKiyoshi Ueda 
9322bded7bdSKiyoshi Ueda 		spin_lock_irqsave(&m->lock, flags);
9332bded7bdSKiyoshi Ueda 		if (!m->pg_init_in_progress) {
9342bded7bdSKiyoshi Ueda 			spin_unlock_irqrestore(&m->lock, flags);
9352bded7bdSKiyoshi Ueda 			break;
9362bded7bdSKiyoshi Ueda 		}
9372bded7bdSKiyoshi Ueda 		spin_unlock_irqrestore(&m->lock, flags);
9382bded7bdSKiyoshi Ueda 
9392bded7bdSKiyoshi Ueda 		io_schedule();
9402bded7bdSKiyoshi Ueda 	}
9412bded7bdSKiyoshi Ueda 	set_current_state(TASK_RUNNING);
9422bded7bdSKiyoshi Ueda 
9432bded7bdSKiyoshi Ueda 	remove_wait_queue(&m->pg_init_wait, &wait);
9442bded7bdSKiyoshi Ueda }
9452bded7bdSKiyoshi Ueda 
9462bded7bdSKiyoshi Ueda static void flush_multipath_work(struct multipath *m)
9471da177e4SLinus Torvalds {
948954a73d5SShiva Krishna Merla 	unsigned long flags;
949954a73d5SShiva Krishna Merla 
950954a73d5SShiva Krishna Merla 	spin_lock_irqsave(&m->lock, flags);
951*be7d31ccSMike Snitzer 	m->pg_init_disabled = true;
952954a73d5SShiva Krishna Merla 	spin_unlock_irqrestore(&m->lock, flags);
953954a73d5SShiva Krishna Merla 
954bab7cfc7SChandra Seetharaman 	flush_workqueue(kmpath_handlerd);
9552bded7bdSKiyoshi Ueda 	multipath_wait_for_pg_init_completion(m);
956a044d016SAlasdair G Kergon 	flush_workqueue(kmultipathd);
95743829731STejun Heo 	flush_work(&m->trigger_event);
958954a73d5SShiva Krishna Merla 
959954a73d5SShiva Krishna Merla 	spin_lock_irqsave(&m->lock, flags);
960*be7d31ccSMike Snitzer 	m->pg_init_disabled = false;
961954a73d5SShiva Krishna Merla 	spin_unlock_irqrestore(&m->lock, flags);
9626df400abSKiyoshi Ueda }
9636df400abSKiyoshi Ueda 
9646df400abSKiyoshi Ueda static void multipath_dtr(struct dm_target *ti)
9656df400abSKiyoshi Ueda {
9666df400abSKiyoshi Ueda 	struct multipath *m = ti->private;
9676df400abSKiyoshi Ueda 
9682bded7bdSKiyoshi Ueda 	flush_multipath_work(m);
9691da177e4SLinus Torvalds 	free_multipath(m);
9701da177e4SLinus Torvalds }
9711da177e4SLinus Torvalds 
9721da177e4SLinus Torvalds /*
9731da177e4SLinus Torvalds  * Take a path out of use.
9741da177e4SLinus Torvalds  */
9751da177e4SLinus Torvalds static int fail_path(struct pgpath *pgpath)
9761da177e4SLinus Torvalds {
9771da177e4SLinus Torvalds 	unsigned long flags;
9781da177e4SLinus Torvalds 	struct multipath *m = pgpath->pg->m;
9791da177e4SLinus Torvalds 
9801da177e4SLinus Torvalds 	spin_lock_irqsave(&m->lock, flags);
9811da177e4SLinus Torvalds 
9826680073dSKiyoshi Ueda 	if (!pgpath->is_active)
9831da177e4SLinus Torvalds 		goto out;
9841da177e4SLinus Torvalds 
98572d94861SAlasdair G Kergon 	DMWARN("Failing path %s.", pgpath->path.dev->name);
9861da177e4SLinus Torvalds 
9871da177e4SLinus Torvalds 	pgpath->pg->ps.type->fail_path(&pgpath->pg->ps, &pgpath->path);
988*be7d31ccSMike Snitzer 	pgpath->is_active = false;
9891da177e4SLinus Torvalds 	pgpath->fail_count++;
9901da177e4SLinus Torvalds 
9911da177e4SLinus Torvalds 	m->nr_valid_paths--;
9921da177e4SLinus Torvalds 
9931da177e4SLinus Torvalds 	if (pgpath == m->current_pgpath)
9941da177e4SLinus Torvalds 		m->current_pgpath = NULL;
9951da177e4SLinus Torvalds 
996b15546f9SMike Anderson 	dm_path_uevent(DM_UEVENT_PATH_FAILED, m->ti,
997b15546f9SMike Anderson 		      pgpath->path.dev->name, m->nr_valid_paths);
998b15546f9SMike Anderson 
999fe9cf30eSAlasdair G Kergon 	schedule_work(&m->trigger_event);
10001da177e4SLinus Torvalds 
10011da177e4SLinus Torvalds out:
10021da177e4SLinus Torvalds 	spin_unlock_irqrestore(&m->lock, flags);
10031da177e4SLinus Torvalds 
10041da177e4SLinus Torvalds 	return 0;
10051da177e4SLinus Torvalds }
10061da177e4SLinus Torvalds 
10071da177e4SLinus Torvalds /*
10081da177e4SLinus Torvalds  * Reinstate a previously-failed path
10091da177e4SLinus Torvalds  */
10101da177e4SLinus Torvalds static int reinstate_path(struct pgpath *pgpath)
10111da177e4SLinus Torvalds {
101263d832c3SHannes Reinecke 	int r = 0, run_queue = 0;
10131da177e4SLinus Torvalds 	unsigned long flags;
10141da177e4SLinus Torvalds 	struct multipath *m = pgpath->pg->m;
10151da177e4SLinus Torvalds 
10161da177e4SLinus Torvalds 	spin_lock_irqsave(&m->lock, flags);
10171da177e4SLinus Torvalds 
10186680073dSKiyoshi Ueda 	if (pgpath->is_active)
10191da177e4SLinus Torvalds 		goto out;
10201da177e4SLinus Torvalds 
1021def052d2SAlasdair G Kergon 	if (!pgpath->pg->ps.type->reinstate_path) {
10221da177e4SLinus Torvalds 		DMWARN("Reinstate path not supported by path selector %s",
10231da177e4SLinus Torvalds 		       pgpath->pg->ps.type->name);
10241da177e4SLinus Torvalds 		r = -EINVAL;
10251da177e4SLinus Torvalds 		goto out;
10261da177e4SLinus Torvalds 	}
10271da177e4SLinus Torvalds 
10281da177e4SLinus Torvalds 	r = pgpath->pg->ps.type->reinstate_path(&pgpath->pg->ps, &pgpath->path);
10291da177e4SLinus Torvalds 	if (r)
10301da177e4SLinus Torvalds 		goto out;
10311da177e4SLinus Torvalds 
1032*be7d31ccSMike Snitzer 	pgpath->is_active = true;
10331da177e4SLinus Torvalds 
1034e8099177SHannes Reinecke 	if (!m->nr_valid_paths++) {
10351da177e4SLinus Torvalds 		m->current_pgpath = NULL;
103663d832c3SHannes Reinecke 		run_queue = 1;
1037e54f77ddSChandra Seetharaman 	} else if (m->hw_handler_name && (m->current_pg == pgpath->pg)) {
10384e2d19e4SChandra Seetharaman 		if (queue_work(kmpath_handlerd, &pgpath->activate_path.work))
1039e54f77ddSChandra Seetharaman 			m->pg_init_in_progress++;
1040e54f77ddSChandra Seetharaman 	}
10411da177e4SLinus Torvalds 
1042b15546f9SMike Anderson 	dm_path_uevent(DM_UEVENT_PATH_REINSTATED, m->ti,
1043b15546f9SMike Anderson 		      pgpath->path.dev->name, m->nr_valid_paths);
1044b15546f9SMike Anderson 
1045fe9cf30eSAlasdair G Kergon 	schedule_work(&m->trigger_event);
10461da177e4SLinus Torvalds 
10471da177e4SLinus Torvalds out:
10481da177e4SLinus Torvalds 	spin_unlock_irqrestore(&m->lock, flags);
104963d832c3SHannes Reinecke 	if (run_queue)
105063d832c3SHannes Reinecke 		dm_table_run_md_queue_async(m->ti->table);
10511da177e4SLinus Torvalds 
10521da177e4SLinus Torvalds 	return r;
10531da177e4SLinus Torvalds }
10541da177e4SLinus Torvalds 
10551da177e4SLinus Torvalds /*
10561da177e4SLinus Torvalds  * Fail or reinstate all paths that match the provided struct dm_dev.
10571da177e4SLinus Torvalds  */
10581da177e4SLinus Torvalds static int action_dev(struct multipath *m, struct dm_dev *dev,
10591da177e4SLinus Torvalds 		      action_fn action)
10601da177e4SLinus Torvalds {
106119040c0bSMike Snitzer 	int r = -EINVAL;
10621da177e4SLinus Torvalds 	struct pgpath *pgpath;
10631da177e4SLinus Torvalds 	struct priority_group *pg;
10641da177e4SLinus Torvalds 
10651da177e4SLinus Torvalds 	list_for_each_entry(pg, &m->priority_groups, list) {
10661da177e4SLinus Torvalds 		list_for_each_entry(pgpath, &pg->pgpaths, list) {
10671da177e4SLinus Torvalds 			if (pgpath->path.dev == dev)
10681da177e4SLinus Torvalds 				r = action(pgpath);
10691da177e4SLinus Torvalds 		}
10701da177e4SLinus Torvalds 	}
10711da177e4SLinus Torvalds 
10721da177e4SLinus Torvalds 	return r;
10731da177e4SLinus Torvalds }
10741da177e4SLinus Torvalds 
10751da177e4SLinus Torvalds /*
10761da177e4SLinus Torvalds  * Temporarily try to avoid having to use the specified PG
10771da177e4SLinus Torvalds  */
10781da177e4SLinus Torvalds static void bypass_pg(struct multipath *m, struct priority_group *pg,
1079*be7d31ccSMike Snitzer 		      bool bypassed)
10801da177e4SLinus Torvalds {
10811da177e4SLinus Torvalds 	unsigned long flags;
10821da177e4SLinus Torvalds 
10831da177e4SLinus Torvalds 	spin_lock_irqsave(&m->lock, flags);
10841da177e4SLinus Torvalds 
10851da177e4SLinus Torvalds 	pg->bypassed = bypassed;
10861da177e4SLinus Torvalds 	m->current_pgpath = NULL;
10871da177e4SLinus Torvalds 	m->current_pg = NULL;
10881da177e4SLinus Torvalds 
10891da177e4SLinus Torvalds 	spin_unlock_irqrestore(&m->lock, flags);
10901da177e4SLinus Torvalds 
1091fe9cf30eSAlasdair G Kergon 	schedule_work(&m->trigger_event);
10921da177e4SLinus Torvalds }
10931da177e4SLinus Torvalds 
10941da177e4SLinus Torvalds /*
10951da177e4SLinus Torvalds  * Switch to using the specified PG from the next I/O that gets mapped
10961da177e4SLinus Torvalds  */
10971da177e4SLinus Torvalds static int switch_pg_num(struct multipath *m, const char *pgstr)
10981da177e4SLinus Torvalds {
10991da177e4SLinus Torvalds 	struct priority_group *pg;
11001da177e4SLinus Torvalds 	unsigned pgnum;
11011da177e4SLinus Torvalds 	unsigned long flags;
110231998ef1SMikulas Patocka 	char dummy;
11031da177e4SLinus Torvalds 
110431998ef1SMikulas Patocka 	if (!pgstr || (sscanf(pgstr, "%u%c", &pgnum, &dummy) != 1) || !pgnum ||
11051da177e4SLinus Torvalds 	    (pgnum > m->nr_priority_groups)) {
11061da177e4SLinus Torvalds 		DMWARN("invalid PG number supplied to switch_pg_num");
11071da177e4SLinus Torvalds 		return -EINVAL;
11081da177e4SLinus Torvalds 	}
11091da177e4SLinus Torvalds 
11101da177e4SLinus Torvalds 	spin_lock_irqsave(&m->lock, flags);
11111da177e4SLinus Torvalds 	list_for_each_entry(pg, &m->priority_groups, list) {
1112*be7d31ccSMike Snitzer 		pg->bypassed = false;
11131da177e4SLinus Torvalds 		if (--pgnum)
11141da177e4SLinus Torvalds 			continue;
11151da177e4SLinus Torvalds 
11161da177e4SLinus Torvalds 		m->current_pgpath = NULL;
11171da177e4SLinus Torvalds 		m->current_pg = NULL;
11181da177e4SLinus Torvalds 		m->next_pg = pg;
11191da177e4SLinus Torvalds 	}
11201da177e4SLinus Torvalds 	spin_unlock_irqrestore(&m->lock, flags);
11211da177e4SLinus Torvalds 
1122fe9cf30eSAlasdair G Kergon 	schedule_work(&m->trigger_event);
11231da177e4SLinus Torvalds 	return 0;
11241da177e4SLinus Torvalds }
11251da177e4SLinus Torvalds 
11261da177e4SLinus Torvalds /*
11271da177e4SLinus Torvalds  * Set/clear bypassed status of a PG.
11281da177e4SLinus Torvalds  * PGs are numbered upwards from 1 in the order they were declared.
11291da177e4SLinus Torvalds  */
1130*be7d31ccSMike Snitzer static int bypass_pg_num(struct multipath *m, const char *pgstr, bool bypassed)
11311da177e4SLinus Torvalds {
11321da177e4SLinus Torvalds 	struct priority_group *pg;
11331da177e4SLinus Torvalds 	unsigned pgnum;
113431998ef1SMikulas Patocka 	char dummy;
11351da177e4SLinus Torvalds 
113631998ef1SMikulas Patocka 	if (!pgstr || (sscanf(pgstr, "%u%c", &pgnum, &dummy) != 1) || !pgnum ||
11371da177e4SLinus Torvalds 	    (pgnum > m->nr_priority_groups)) {
11381da177e4SLinus Torvalds 		DMWARN("invalid PG number supplied to bypass_pg");
11391da177e4SLinus Torvalds 		return -EINVAL;
11401da177e4SLinus Torvalds 	}
11411da177e4SLinus Torvalds 
11421da177e4SLinus Torvalds 	list_for_each_entry(pg, &m->priority_groups, list) {
11431da177e4SLinus Torvalds 		if (!--pgnum)
11441da177e4SLinus Torvalds 			break;
11451da177e4SLinus Torvalds 	}
11461da177e4SLinus Torvalds 
11471da177e4SLinus Torvalds 	bypass_pg(m, pg, bypassed);
11481da177e4SLinus Torvalds 	return 0;
11491da177e4SLinus Torvalds }
11501da177e4SLinus Torvalds 
11511da177e4SLinus Torvalds /*
1152c9e45581SDave Wysochanski  * Should we retry pg_init immediately?
1153c9e45581SDave Wysochanski  */
1154*be7d31ccSMike Snitzer static bool pg_init_limit_reached(struct multipath *m, struct pgpath *pgpath)
1155c9e45581SDave Wysochanski {
1156c9e45581SDave Wysochanski 	unsigned long flags;
1157*be7d31ccSMike Snitzer 	bool limit_reached = false;
1158c9e45581SDave Wysochanski 
1159c9e45581SDave Wysochanski 	spin_lock_irqsave(&m->lock, flags);
1160c9e45581SDave Wysochanski 
1161954a73d5SShiva Krishna Merla 	if (m->pg_init_count <= m->pg_init_retries && !m->pg_init_disabled)
1162*be7d31ccSMike Snitzer 		m->pg_init_required = true;
1163c9e45581SDave Wysochanski 	else
1164*be7d31ccSMike Snitzer 		limit_reached = true;
1165c9e45581SDave Wysochanski 
1166c9e45581SDave Wysochanski 	spin_unlock_irqrestore(&m->lock, flags);
1167c9e45581SDave Wysochanski 
1168c9e45581SDave Wysochanski 	return limit_reached;
1169c9e45581SDave Wysochanski }
1170c9e45581SDave Wysochanski 
11713ae31f6aSChandra Seetharaman static void pg_init_done(void *data, int errors)
1172cfae5c9bSChandra Seetharaman {
117383c0d5d5SMoger, Babu 	struct pgpath *pgpath = data;
1174cfae5c9bSChandra Seetharaman 	struct priority_group *pg = pgpath->pg;
1175cfae5c9bSChandra Seetharaman 	struct multipath *m = pg->m;
1176cfae5c9bSChandra Seetharaman 	unsigned long flags;
1177*be7d31ccSMike Snitzer 	bool delay_retry = false;
1178cfae5c9bSChandra Seetharaman 
1179cfae5c9bSChandra Seetharaman 	/* device or driver problems */
1180cfae5c9bSChandra Seetharaman 	switch (errors) {
1181cfae5c9bSChandra Seetharaman 	case SCSI_DH_OK:
1182cfae5c9bSChandra Seetharaman 		break;
1183cfae5c9bSChandra Seetharaman 	case SCSI_DH_NOSYS:
1184cfae5c9bSChandra Seetharaman 		if (!m->hw_handler_name) {
1185cfae5c9bSChandra Seetharaman 			errors = 0;
1186cfae5c9bSChandra Seetharaman 			break;
1187cfae5c9bSChandra Seetharaman 		}
1188f7b934c8SMoger, Babu 		DMERR("Could not failover the device: Handler scsi_dh_%s "
1189f7b934c8SMoger, Babu 		      "Error %d.", m->hw_handler_name, errors);
1190cfae5c9bSChandra Seetharaman 		/*
1191cfae5c9bSChandra Seetharaman 		 * Fail path for now, so we do not ping pong
1192cfae5c9bSChandra Seetharaman 		 */
1193cfae5c9bSChandra Seetharaman 		fail_path(pgpath);
1194cfae5c9bSChandra Seetharaman 		break;
1195cfae5c9bSChandra Seetharaman 	case SCSI_DH_DEV_TEMP_BUSY:
1196cfae5c9bSChandra Seetharaman 		/*
1197cfae5c9bSChandra Seetharaman 		 * Probably doing something like FW upgrade on the
1198cfae5c9bSChandra Seetharaman 		 * controller so try the other pg.
1199cfae5c9bSChandra Seetharaman 		 */
1200*be7d31ccSMike Snitzer 		bypass_pg(m, pg, true);
1201cfae5c9bSChandra Seetharaman 		break;
1202cfae5c9bSChandra Seetharaman 	case SCSI_DH_RETRY:
12034e2d19e4SChandra Seetharaman 		/* Wait before retrying. */
12044e2d19e4SChandra Seetharaman 		delay_retry = 1;
1205cfae5c9bSChandra Seetharaman 	case SCSI_DH_IMM_RETRY:
1206cfae5c9bSChandra Seetharaman 	case SCSI_DH_RES_TEMP_UNAVAIL:
1207cfae5c9bSChandra Seetharaman 		if (pg_init_limit_reached(m, pgpath))
1208cfae5c9bSChandra Seetharaman 			fail_path(pgpath);
1209cfae5c9bSChandra Seetharaman 		errors = 0;
1210cfae5c9bSChandra Seetharaman 		break;
1211cfae5c9bSChandra Seetharaman 	default:
1212cfae5c9bSChandra Seetharaman 		/*
1213cfae5c9bSChandra Seetharaman 		 * We probably do not want to fail the path for a device
1214cfae5c9bSChandra Seetharaman 		 * error, but this is what the old dm did. In future
1215cfae5c9bSChandra Seetharaman 		 * patches we can do more advanced handling.
1216cfae5c9bSChandra Seetharaman 		 */
1217cfae5c9bSChandra Seetharaman 		fail_path(pgpath);
1218cfae5c9bSChandra Seetharaman 	}
1219cfae5c9bSChandra Seetharaman 
1220cfae5c9bSChandra Seetharaman 	spin_lock_irqsave(&m->lock, flags);
1221cfae5c9bSChandra Seetharaman 	if (errors) {
1222e54f77ddSChandra Seetharaman 		if (pgpath == m->current_pgpath) {
1223cfae5c9bSChandra Seetharaman 			DMERR("Could not failover device. Error %d.", errors);
1224cfae5c9bSChandra Seetharaman 			m->current_pgpath = NULL;
1225cfae5c9bSChandra Seetharaman 			m->current_pg = NULL;
1226e54f77ddSChandra Seetharaman 		}
1227d0259bf0SKiyoshi Ueda 	} else if (!m->pg_init_required)
1228*be7d31ccSMike Snitzer 		pg->bypassed = false;
1229cfae5c9bSChandra Seetharaman 
1230d0259bf0SKiyoshi Ueda 	if (--m->pg_init_in_progress)
1231d0259bf0SKiyoshi Ueda 		/* Activations of other paths are still on going */
1232d0259bf0SKiyoshi Ueda 		goto out;
1233d0259bf0SKiyoshi Ueda 
12343e9f1be1SHannes Reinecke 	if (m->pg_init_required) {
12354e2d19e4SChandra Seetharaman 		m->pg_init_delay_retry = delay_retry;
12363e9f1be1SHannes Reinecke 		if (__pg_init_all_paths(m))
12373e9f1be1SHannes Reinecke 			goto out;
12383e9f1be1SHannes Reinecke 	}
1239*be7d31ccSMike Snitzer 	m->queue_io = false;
1240d0259bf0SKiyoshi Ueda 
12412bded7bdSKiyoshi Ueda 	/*
12422bded7bdSKiyoshi Ueda 	 * Wake up any thread waiting to suspend.
12432bded7bdSKiyoshi Ueda 	 */
12442bded7bdSKiyoshi Ueda 	wake_up(&m->pg_init_wait);
12452bded7bdSKiyoshi Ueda 
1246d0259bf0SKiyoshi Ueda out:
1247cfae5c9bSChandra Seetharaman 	spin_unlock_irqrestore(&m->lock, flags);
1248cfae5c9bSChandra Seetharaman }
1249cfae5c9bSChandra Seetharaman 
1250bab7cfc7SChandra Seetharaman static void activate_path(struct work_struct *work)
1251bab7cfc7SChandra Seetharaman {
1252e54f77ddSChandra Seetharaman 	struct pgpath *pgpath =
12534e2d19e4SChandra Seetharaman 		container_of(work, struct pgpath, activate_path.work);
1254bab7cfc7SChandra Seetharaman 
12553a017509SHannes Reinecke 	if (pgpath->is_active)
12563ae31f6aSChandra Seetharaman 		scsi_dh_activate(bdev_get_queue(pgpath->path.dev->bdev),
125783c0d5d5SMoger, Babu 				 pg_init_done, pgpath);
12583a017509SHannes Reinecke 	else
12593a017509SHannes Reinecke 		pg_init_done(pgpath, SCSI_DH_DEV_OFFLINED);
1260bab7cfc7SChandra Seetharaman }
1261bab7cfc7SChandra Seetharaman 
12627e782af5SHannes Reinecke static int noretry_error(int error)
12637e782af5SHannes Reinecke {
12647e782af5SHannes Reinecke 	switch (error) {
12657e782af5SHannes Reinecke 	case -EOPNOTSUPP:
12667e782af5SHannes Reinecke 	case -EREMOTEIO:
12677e782af5SHannes Reinecke 	case -EILSEQ:
12687e782af5SHannes Reinecke 	case -ENODATA:
1269cc9d3c38SJun'ichi Nomura 	case -ENOSPC:
12707e782af5SHannes Reinecke 		return 1;
12717e782af5SHannes Reinecke 	}
12727e782af5SHannes Reinecke 
12737e782af5SHannes Reinecke 	/* Anything else could be a path failure, so should be retried */
12747e782af5SHannes Reinecke 	return 0;
12757e782af5SHannes Reinecke }
12767e782af5SHannes Reinecke 
12771da177e4SLinus Torvalds /*
12781da177e4SLinus Torvalds  * end_io handling
12791da177e4SLinus Torvalds  */
1280f40c67f0SKiyoshi Ueda static int do_end_io(struct multipath *m, struct request *clone,
1281028867acSAlasdair G Kergon 		     int error, struct dm_mpath_io *mpio)
12821da177e4SLinus Torvalds {
1283f40c67f0SKiyoshi Ueda 	/*
1284f40c67f0SKiyoshi Ueda 	 * We don't queue any clone request inside the multipath target
1285f40c67f0SKiyoshi Ueda 	 * during end I/O handling, since those clone requests don't have
1286f40c67f0SKiyoshi Ueda 	 * bio clones.  If we queue them inside the multipath target,
1287f40c67f0SKiyoshi Ueda 	 * we need to make bio clones, that requires memory allocation.
1288f40c67f0SKiyoshi Ueda 	 * (See drivers/md/dm.c:end_clone_bio() about why the clone requests
1289f40c67f0SKiyoshi Ueda 	 *  don't have bio clones.)
1290f40c67f0SKiyoshi Ueda 	 * Instead of queueing the clone request here, we queue the original
1291f40c67f0SKiyoshi Ueda 	 * request into dm core, which will remake a clone request and
1292f40c67f0SKiyoshi Ueda 	 * clone bios for it and resubmit it later.
1293f40c67f0SKiyoshi Ueda 	 */
1294f40c67f0SKiyoshi Ueda 	int r = DM_ENDIO_REQUEUE;
1295640eb3b0SStefan Bader 	unsigned long flags;
12961da177e4SLinus Torvalds 
1297f40c67f0SKiyoshi Ueda 	if (!error && !clone->errors)
12981da177e4SLinus Torvalds 		return 0;	/* I/O complete */
12991da177e4SLinus Torvalds 
13007eee4ae2SMike Snitzer 	if (noretry_error(error))
1301959eb4e5SMike Snitzer 		return error;
1302959eb4e5SMike Snitzer 
1303cfae5c9bSChandra Seetharaman 	if (mpio->pgpath)
13041da177e4SLinus Torvalds 		fail_path(mpio->pgpath);
13051da177e4SLinus Torvalds 
1306640eb3b0SStefan Bader 	spin_lock_irqsave(&m->lock, flags);
1307751b2a7dSHannes Reinecke 	if (!m->nr_valid_paths) {
1308751b2a7dSHannes Reinecke 		if (!m->queue_if_no_path) {
1309751b2a7dSHannes Reinecke 			if (!__must_push_back(m))
1310f40c67f0SKiyoshi Ueda 				r = -EIO;
1311751b2a7dSHannes Reinecke 		} else {
1312751b2a7dSHannes Reinecke 			if (error == -EBADE)
1313751b2a7dSHannes Reinecke 				r = error;
1314751b2a7dSHannes Reinecke 		}
1315751b2a7dSHannes Reinecke 	}
1316640eb3b0SStefan Bader 	spin_unlock_irqrestore(&m->lock, flags);
13171da177e4SLinus Torvalds 
1318f40c67f0SKiyoshi Ueda 	return r;
13191da177e4SLinus Torvalds }
13201da177e4SLinus Torvalds 
1321f40c67f0SKiyoshi Ueda static int multipath_end_io(struct dm_target *ti, struct request *clone,
13221da177e4SLinus Torvalds 			    int error, union map_info *map_context)
13231da177e4SLinus Torvalds {
1324028867acSAlasdair G Kergon 	struct multipath *m = ti->private;
13252eff1924SMike Snitzer 	struct dm_mpath_io *mpio = get_mpio(map_context);
1326a71a261fSWei Yongjun 	struct pgpath *pgpath;
13271da177e4SLinus Torvalds 	struct path_selector *ps;
13281da177e4SLinus Torvalds 	int r;
13291da177e4SLinus Torvalds 
1330466891f9SJun'ichi Nomura 	BUG_ON(!mpio);
1331466891f9SJun'ichi Nomura 
1332f40c67f0SKiyoshi Ueda 	r = do_end_io(m, clone, error, mpio);
1333a71a261fSWei Yongjun 	pgpath = mpio->pgpath;
13341da177e4SLinus Torvalds 	if (pgpath) {
13351da177e4SLinus Torvalds 		ps = &pgpath->pg->ps;
13361da177e4SLinus Torvalds 		if (ps->type->end_io)
133702ab823fSKiyoshi Ueda 			ps->type->end_io(ps, &pgpath->path, mpio->nr_bytes);
13381da177e4SLinus Torvalds 	}
13392eff1924SMike Snitzer 	clear_request_fn_mpio(m, map_context);
13401da177e4SLinus Torvalds 
13411da177e4SLinus Torvalds 	return r;
13421da177e4SLinus Torvalds }
13431da177e4SLinus Torvalds 
13441da177e4SLinus Torvalds /*
13451da177e4SLinus Torvalds  * Suspend can't complete until all the I/O is processed so if
1346436d4108SAlasdair G Kergon  * the last path fails we must error any remaining I/O.
1347436d4108SAlasdair G Kergon  * Note that if the freeze_bdev fails while suspending, the
1348436d4108SAlasdair G Kergon  * queue_if_no_path state is lost - userspace should reset it.
13491da177e4SLinus Torvalds  */
13501da177e4SLinus Torvalds static void multipath_presuspend(struct dm_target *ti)
13511da177e4SLinus Torvalds {
13527943bd6dSMike Snitzer 	struct multipath *m = ti->private;
13531da177e4SLinus Torvalds 
1354*be7d31ccSMike Snitzer 	queue_if_no_path(m, false, true);
13551da177e4SLinus Torvalds }
13561da177e4SLinus Torvalds 
13576df400abSKiyoshi Ueda static void multipath_postsuspend(struct dm_target *ti)
13586df400abSKiyoshi Ueda {
13596380f26fSMike Anderson 	struct multipath *m = ti->private;
13606380f26fSMike Anderson 
13616380f26fSMike Anderson 	mutex_lock(&m->work_mutex);
13622bded7bdSKiyoshi Ueda 	flush_multipath_work(m);
13636380f26fSMike Anderson 	mutex_unlock(&m->work_mutex);
13646df400abSKiyoshi Ueda }
13656df400abSKiyoshi Ueda 
1366436d4108SAlasdair G Kergon /*
1367436d4108SAlasdair G Kergon  * Restore the queue_if_no_path setting.
1368436d4108SAlasdair G Kergon  */
13691da177e4SLinus Torvalds static void multipath_resume(struct dm_target *ti)
13701da177e4SLinus Torvalds {
13717943bd6dSMike Snitzer 	struct multipath *m = ti->private;
13721da177e4SLinus Torvalds 	unsigned long flags;
13731da177e4SLinus Torvalds 
13741da177e4SLinus Torvalds 	spin_lock_irqsave(&m->lock, flags);
1375436d4108SAlasdair G Kergon 	m->queue_if_no_path = m->saved_queue_if_no_path;
13761da177e4SLinus Torvalds 	spin_unlock_irqrestore(&m->lock, flags);
13771da177e4SLinus Torvalds }
13781da177e4SLinus Torvalds 
13791da177e4SLinus Torvalds /*
13801da177e4SLinus Torvalds  * Info output has the following format:
13811da177e4SLinus Torvalds  * num_multipath_feature_args [multipath_feature_args]*
13821da177e4SLinus Torvalds  * num_handler_status_args [handler_status_args]*
13831da177e4SLinus Torvalds  * num_groups init_group_number
13841da177e4SLinus Torvalds  *            [A|D|E num_ps_status_args [ps_status_args]*
13851da177e4SLinus Torvalds  *             num_paths num_selector_args
13861da177e4SLinus Torvalds  *             [path_dev A|F fail_count [selector_args]* ]+ ]+
13871da177e4SLinus Torvalds  *
13881da177e4SLinus Torvalds  * Table output has the following format (identical to the constructor string):
13891da177e4SLinus Torvalds  * num_feature_args [features_args]*
13901da177e4SLinus Torvalds  * num_handler_args hw_handler [hw_handler_args]*
13911da177e4SLinus Torvalds  * num_groups init_group_number
13921da177e4SLinus Torvalds  *     [priority selector-name num_ps_args [ps_args]*
13931da177e4SLinus Torvalds  *      num_paths num_selector_args [path_dev [selector_args]* ]+ ]+
13941da177e4SLinus Torvalds  */
1395fd7c092eSMikulas Patocka static void multipath_status(struct dm_target *ti, status_type_t type,
13961f4e0ff0SAlasdair G Kergon 			     unsigned status_flags, char *result, unsigned maxlen)
13971da177e4SLinus Torvalds {
13981da177e4SLinus Torvalds 	int sz = 0;
13991da177e4SLinus Torvalds 	unsigned long flags;
14007943bd6dSMike Snitzer 	struct multipath *m = ti->private;
14011da177e4SLinus Torvalds 	struct priority_group *pg;
14021da177e4SLinus Torvalds 	struct pgpath *p;
14031da177e4SLinus Torvalds 	unsigned pg_num;
14041da177e4SLinus Torvalds 	char state;
14051da177e4SLinus Torvalds 
14061da177e4SLinus Torvalds 	spin_lock_irqsave(&m->lock, flags);
14071da177e4SLinus Torvalds 
14081da177e4SLinus Torvalds 	/* Features */
14091da177e4SLinus Torvalds 	if (type == STATUSTYPE_INFO)
1410e8099177SHannes Reinecke 		DMEMIT("2 %u %u ", m->queue_io, m->pg_init_count);
1411c9e45581SDave Wysochanski 	else {
1412c9e45581SDave Wysochanski 		DMEMIT("%u ", m->queue_if_no_path +
14134e2d19e4SChandra Seetharaman 			      (m->pg_init_retries > 0) * 2 +
1414a58a935dSMike Snitzer 			      (m->pg_init_delay_msecs != DM_PG_INIT_DELAY_DEFAULT) * 2 +
1415a58a935dSMike Snitzer 			      m->retain_attached_hw_handler);
1416c9e45581SDave Wysochanski 		if (m->queue_if_no_path)
1417c9e45581SDave Wysochanski 			DMEMIT("queue_if_no_path ");
1418c9e45581SDave Wysochanski 		if (m->pg_init_retries)
1419c9e45581SDave Wysochanski 			DMEMIT("pg_init_retries %u ", m->pg_init_retries);
14204e2d19e4SChandra Seetharaman 		if (m->pg_init_delay_msecs != DM_PG_INIT_DELAY_DEFAULT)
14214e2d19e4SChandra Seetharaman 			DMEMIT("pg_init_delay_msecs %u ", m->pg_init_delay_msecs);
1422a58a935dSMike Snitzer 		if (m->retain_attached_hw_handler)
1423a58a935dSMike Snitzer 			DMEMIT("retain_attached_hw_handler ");
1424c9e45581SDave Wysochanski 	}
14251da177e4SLinus Torvalds 
1426cfae5c9bSChandra Seetharaman 	if (!m->hw_handler_name || type == STATUSTYPE_INFO)
14271da177e4SLinus Torvalds 		DMEMIT("0 ");
14281da177e4SLinus Torvalds 	else
1429cfae5c9bSChandra Seetharaman 		DMEMIT("1 %s ", m->hw_handler_name);
14301da177e4SLinus Torvalds 
14311da177e4SLinus Torvalds 	DMEMIT("%u ", m->nr_priority_groups);
14321da177e4SLinus Torvalds 
14331da177e4SLinus Torvalds 	if (m->next_pg)
14341da177e4SLinus Torvalds 		pg_num = m->next_pg->pg_num;
14351da177e4SLinus Torvalds 	else if (m->current_pg)
14361da177e4SLinus Torvalds 		pg_num = m->current_pg->pg_num;
14371da177e4SLinus Torvalds 	else
1438a490a07aSMike Snitzer 		pg_num = (m->nr_priority_groups ? 1 : 0);
14391da177e4SLinus Torvalds 
14401da177e4SLinus Torvalds 	DMEMIT("%u ", pg_num);
14411da177e4SLinus Torvalds 
14421da177e4SLinus Torvalds 	switch (type) {
14431da177e4SLinus Torvalds 	case STATUSTYPE_INFO:
14441da177e4SLinus Torvalds 		list_for_each_entry(pg, &m->priority_groups, list) {
14451da177e4SLinus Torvalds 			if (pg->bypassed)
14461da177e4SLinus Torvalds 				state = 'D';	/* Disabled */
14471da177e4SLinus Torvalds 			else if (pg == m->current_pg)
14481da177e4SLinus Torvalds 				state = 'A';	/* Currently Active */
14491da177e4SLinus Torvalds 			else
14501da177e4SLinus Torvalds 				state = 'E';	/* Enabled */
14511da177e4SLinus Torvalds 
14521da177e4SLinus Torvalds 			DMEMIT("%c ", state);
14531da177e4SLinus Torvalds 
14541da177e4SLinus Torvalds 			if (pg->ps.type->status)
14551da177e4SLinus Torvalds 				sz += pg->ps.type->status(&pg->ps, NULL, type,
14561da177e4SLinus Torvalds 							  result + sz,
14571da177e4SLinus Torvalds 							  maxlen - sz);
14581da177e4SLinus Torvalds 			else
14591da177e4SLinus Torvalds 				DMEMIT("0 ");
14601da177e4SLinus Torvalds 
14611da177e4SLinus Torvalds 			DMEMIT("%u %u ", pg->nr_pgpaths,
14621da177e4SLinus Torvalds 			       pg->ps.type->info_args);
14631da177e4SLinus Torvalds 
14641da177e4SLinus Torvalds 			list_for_each_entry(p, &pg->pgpaths, list) {
14651da177e4SLinus Torvalds 				DMEMIT("%s %s %u ", p->path.dev->name,
14666680073dSKiyoshi Ueda 				       p->is_active ? "A" : "F",
14671da177e4SLinus Torvalds 				       p->fail_count);
14681da177e4SLinus Torvalds 				if (pg->ps.type->status)
14691da177e4SLinus Torvalds 					sz += pg->ps.type->status(&pg->ps,
14701da177e4SLinus Torvalds 					      &p->path, type, result + sz,
14711da177e4SLinus Torvalds 					      maxlen - sz);
14721da177e4SLinus Torvalds 			}
14731da177e4SLinus Torvalds 		}
14741da177e4SLinus Torvalds 		break;
14751da177e4SLinus Torvalds 
14761da177e4SLinus Torvalds 	case STATUSTYPE_TABLE:
14771da177e4SLinus Torvalds 		list_for_each_entry(pg, &m->priority_groups, list) {
14781da177e4SLinus Torvalds 			DMEMIT("%s ", pg->ps.type->name);
14791da177e4SLinus Torvalds 
14801da177e4SLinus Torvalds 			if (pg->ps.type->status)
14811da177e4SLinus Torvalds 				sz += pg->ps.type->status(&pg->ps, NULL, type,
14821da177e4SLinus Torvalds 							  result + sz,
14831da177e4SLinus Torvalds 							  maxlen - sz);
14841da177e4SLinus Torvalds 			else
14851da177e4SLinus Torvalds 				DMEMIT("0 ");
14861da177e4SLinus Torvalds 
14871da177e4SLinus Torvalds 			DMEMIT("%u %u ", pg->nr_pgpaths,
14881da177e4SLinus Torvalds 			       pg->ps.type->table_args);
14891da177e4SLinus Torvalds 
14901da177e4SLinus Torvalds 			list_for_each_entry(p, &pg->pgpaths, list) {
14911da177e4SLinus Torvalds 				DMEMIT("%s ", p->path.dev->name);
14921da177e4SLinus Torvalds 				if (pg->ps.type->status)
14931da177e4SLinus Torvalds 					sz += pg->ps.type->status(&pg->ps,
14941da177e4SLinus Torvalds 					      &p->path, type, result + sz,
14951da177e4SLinus Torvalds 					      maxlen - sz);
14961da177e4SLinus Torvalds 			}
14971da177e4SLinus Torvalds 		}
14981da177e4SLinus Torvalds 		break;
14991da177e4SLinus Torvalds 	}
15001da177e4SLinus Torvalds 
15011da177e4SLinus Torvalds 	spin_unlock_irqrestore(&m->lock, flags);
15021da177e4SLinus Torvalds }
15031da177e4SLinus Torvalds 
15041da177e4SLinus Torvalds static int multipath_message(struct dm_target *ti, unsigned argc, char **argv)
15051da177e4SLinus Torvalds {
15066380f26fSMike Anderson 	int r = -EINVAL;
15071da177e4SLinus Torvalds 	struct dm_dev *dev;
15087943bd6dSMike Snitzer 	struct multipath *m = ti->private;
15091da177e4SLinus Torvalds 	action_fn action;
15101da177e4SLinus Torvalds 
15116380f26fSMike Anderson 	mutex_lock(&m->work_mutex);
15126380f26fSMike Anderson 
1513c2f3d24bSKiyoshi Ueda 	if (dm_suspended(ti)) {
1514c2f3d24bSKiyoshi Ueda 		r = -EBUSY;
1515c2f3d24bSKiyoshi Ueda 		goto out;
1516c2f3d24bSKiyoshi Ueda 	}
1517c2f3d24bSKiyoshi Ueda 
15181da177e4SLinus Torvalds 	if (argc == 1) {
1519498f0103SMike Snitzer 		if (!strcasecmp(argv[0], "queue_if_no_path")) {
1520*be7d31ccSMike Snitzer 			r = queue_if_no_path(m, true, false);
15216380f26fSMike Anderson 			goto out;
1522498f0103SMike Snitzer 		} else if (!strcasecmp(argv[0], "fail_if_no_path")) {
1523*be7d31ccSMike Snitzer 			r = queue_if_no_path(m, false, false);
15246380f26fSMike Anderson 			goto out;
15256380f26fSMike Anderson 		}
15261da177e4SLinus Torvalds 	}
15271da177e4SLinus Torvalds 
15286380f26fSMike Anderson 	if (argc != 2) {
1529a356e426SJose Castillo 		DMWARN("Invalid multipath message arguments. Expected 2 arguments, got %d.", argc);
15306380f26fSMike Anderson 		goto out;
15316380f26fSMike Anderson 	}
15321da177e4SLinus Torvalds 
1533498f0103SMike Snitzer 	if (!strcasecmp(argv[0], "disable_group")) {
1534*be7d31ccSMike Snitzer 		r = bypass_pg_num(m, argv[1], true);
15356380f26fSMike Anderson 		goto out;
1536498f0103SMike Snitzer 	} else if (!strcasecmp(argv[0], "enable_group")) {
1537*be7d31ccSMike Snitzer 		r = bypass_pg_num(m, argv[1], false);
15386380f26fSMike Anderson 		goto out;
1539498f0103SMike Snitzer 	} else if (!strcasecmp(argv[0], "switch_group")) {
15406380f26fSMike Anderson 		r = switch_pg_num(m, argv[1]);
15416380f26fSMike Anderson 		goto out;
1542498f0103SMike Snitzer 	} else if (!strcasecmp(argv[0], "reinstate_path"))
15431da177e4SLinus Torvalds 		action = reinstate_path;
1544498f0103SMike Snitzer 	else if (!strcasecmp(argv[0], "fail_path"))
15451da177e4SLinus Torvalds 		action = fail_path;
15466380f26fSMike Anderson 	else {
1547a356e426SJose Castillo 		DMWARN("Unrecognised multipath message received: %s", argv[0]);
15486380f26fSMike Anderson 		goto out;
15496380f26fSMike Anderson 	}
15501da177e4SLinus Torvalds 
15518215d6ecSNikanth Karthikesan 	r = dm_get_device(ti, argv[1], dm_table_get_mode(ti->table), &dev);
15521da177e4SLinus Torvalds 	if (r) {
155372d94861SAlasdair G Kergon 		DMWARN("message: error getting device %s",
15541da177e4SLinus Torvalds 		       argv[1]);
15556380f26fSMike Anderson 		goto out;
15561da177e4SLinus Torvalds 	}
15571da177e4SLinus Torvalds 
15581da177e4SLinus Torvalds 	r = action_dev(m, dev, action);
15591da177e4SLinus Torvalds 
15601da177e4SLinus Torvalds 	dm_put_device(ti, dev);
15611da177e4SLinus Torvalds 
15626380f26fSMike Anderson out:
15636380f26fSMike Anderson 	mutex_unlock(&m->work_mutex);
15641da177e4SLinus Torvalds 	return r;
15651da177e4SLinus Torvalds }
15661da177e4SLinus Torvalds 
1567e56f81e0SChristoph Hellwig static int multipath_prepare_ioctl(struct dm_target *ti,
1568e56f81e0SChristoph Hellwig 		struct block_device **bdev, fmode_t *mode)
15699af4aa30SMilan Broz {
157035991652SMikulas Patocka 	struct multipath *m = ti->private;
15719af4aa30SMilan Broz 	unsigned long flags;
157235991652SMikulas Patocka 	int r;
157335991652SMikulas Patocka 
15749af4aa30SMilan Broz 	spin_lock_irqsave(&m->lock, flags);
15759af4aa30SMilan Broz 
15769af4aa30SMilan Broz 	if (!m->current_pgpath)
157702ab823fSKiyoshi Ueda 		__choose_pgpath(m, 0);
15789af4aa30SMilan Broz 
157943e43c9eSJunichi Nomura 	if (m->current_pgpath) {
158043e43c9eSJunichi Nomura 		if (!m->queue_io) {
158143e43c9eSJunichi Nomura 			*bdev = m->current_pgpath->path.dev->bdev;
158243e43c9eSJunichi Nomura 			*mode = m->current_pgpath->path.dev->mode;
158343e43c9eSJunichi Nomura 			r = 0;
158443e43c9eSJunichi Nomura 		} else {
158543e43c9eSJunichi Nomura 			/* pg_init has not started or completed */
15866c182cd8SHannes Reinecke 			r = -ENOTCONN;
158743e43c9eSJunichi Nomura 		}
158843e43c9eSJunichi Nomura 	} else {
158943e43c9eSJunichi Nomura 		/* No path is available */
159043e43c9eSJunichi Nomura 		if (m->queue_if_no_path)
159143e43c9eSJunichi Nomura 			r = -ENOTCONN;
159243e43c9eSJunichi Nomura 		else
15939af4aa30SMilan Broz 			r = -EIO;
159443e43c9eSJunichi Nomura 	}
15959af4aa30SMilan Broz 
15969af4aa30SMilan Broz 	spin_unlock_irqrestore(&m->lock, flags);
15979af4aa30SMilan Broz 
15985bbbfdf6SJunichi Nomura 	if (r == -ENOTCONN) {
15993e9f1be1SHannes Reinecke 		spin_lock_irqsave(&m->lock, flags);
16003e9f1be1SHannes Reinecke 		if (!m->current_pg) {
16013e9f1be1SHannes Reinecke 			/* Path status changed, redo selection */
16023e9f1be1SHannes Reinecke 			__choose_pgpath(m, 0);
16033e9f1be1SHannes Reinecke 		}
16043e9f1be1SHannes Reinecke 		if (m->pg_init_required)
16053e9f1be1SHannes Reinecke 			__pg_init_all_paths(m);
16064cdd2ad7SMike Snitzer 		spin_unlock_irqrestore(&m->lock, flags);
160763d832c3SHannes Reinecke 		dm_table_run_md_queue_async(m->ti->table);
16083e9f1be1SHannes Reinecke 	}
160935991652SMikulas Patocka 
1610e56f81e0SChristoph Hellwig 	/*
1611e56f81e0SChristoph Hellwig 	 * Only pass ioctls through if the device sizes match exactly.
1612e56f81e0SChristoph Hellwig 	 */
1613e56f81e0SChristoph Hellwig 	if (!r && ti->len != i_size_read((*bdev)->bd_inode) >> SECTOR_SHIFT)
1614e56f81e0SChristoph Hellwig 		return 1;
1615e56f81e0SChristoph Hellwig 	return r;
16169af4aa30SMilan Broz }
16179af4aa30SMilan Broz 
1618af4874e0SMike Snitzer static int multipath_iterate_devices(struct dm_target *ti,
1619af4874e0SMike Snitzer 				     iterate_devices_callout_fn fn, void *data)
1620af4874e0SMike Snitzer {
1621af4874e0SMike Snitzer 	struct multipath *m = ti->private;
1622af4874e0SMike Snitzer 	struct priority_group *pg;
1623af4874e0SMike Snitzer 	struct pgpath *p;
1624af4874e0SMike Snitzer 	int ret = 0;
1625af4874e0SMike Snitzer 
1626af4874e0SMike Snitzer 	list_for_each_entry(pg, &m->priority_groups, list) {
1627af4874e0SMike Snitzer 		list_for_each_entry(p, &pg->pgpaths, list) {
16285dea271bSMike Snitzer 			ret = fn(ti, p->path.dev, ti->begin, ti->len, data);
1629af4874e0SMike Snitzer 			if (ret)
1630af4874e0SMike Snitzer 				goto out;
1631af4874e0SMike Snitzer 		}
1632af4874e0SMike Snitzer 	}
1633af4874e0SMike Snitzer 
1634af4874e0SMike Snitzer out:
1635af4874e0SMike Snitzer 	return ret;
1636af4874e0SMike Snitzer }
1637af4874e0SMike Snitzer 
1638f40c67f0SKiyoshi Ueda static int __pgpath_busy(struct pgpath *pgpath)
1639f40c67f0SKiyoshi Ueda {
1640f40c67f0SKiyoshi Ueda 	struct request_queue *q = bdev_get_queue(pgpath->path.dev->bdev);
1641f40c67f0SKiyoshi Ueda 
164252b09914SMike Snitzer 	return blk_lld_busy(q);
1643f40c67f0SKiyoshi Ueda }
1644f40c67f0SKiyoshi Ueda 
1645f40c67f0SKiyoshi Ueda /*
1646f40c67f0SKiyoshi Ueda  * We return "busy", only when we can map I/Os but underlying devices
1647f40c67f0SKiyoshi Ueda  * are busy (so even if we map I/Os now, the I/Os will wait on
1648f40c67f0SKiyoshi Ueda  * the underlying queue).
1649f40c67f0SKiyoshi Ueda  * In other words, if we want to kill I/Os or queue them inside us
1650f40c67f0SKiyoshi Ueda  * due to map unavailability, we don't return "busy".  Otherwise,
1651f40c67f0SKiyoshi Ueda  * dm core won't give us the I/Os and we can't do what we want.
1652f40c67f0SKiyoshi Ueda  */
1653f40c67f0SKiyoshi Ueda static int multipath_busy(struct dm_target *ti)
1654f40c67f0SKiyoshi Ueda {
1655*be7d31ccSMike Snitzer 	bool busy = false, has_active = false;
1656f40c67f0SKiyoshi Ueda 	struct multipath *m = ti->private;
1657f40c67f0SKiyoshi Ueda 	struct priority_group *pg;
1658f40c67f0SKiyoshi Ueda 	struct pgpath *pgpath;
1659f40c67f0SKiyoshi Ueda 	unsigned long flags;
1660f40c67f0SKiyoshi Ueda 
1661f40c67f0SKiyoshi Ueda 	spin_lock_irqsave(&m->lock, flags);
1662f40c67f0SKiyoshi Ueda 
16637a7a3b45SJun'ichi Nomura 	/* pg_init in progress or no paths available */
16647a7a3b45SJun'ichi Nomura 	if (m->pg_init_in_progress ||
16657a7a3b45SJun'ichi Nomura 	    (!m->nr_valid_paths && m->queue_if_no_path)) {
1666*be7d31ccSMike Snitzer 		busy = true;
1667b63349a7SHannes Reinecke 		goto out;
1668b63349a7SHannes Reinecke 	}
1669f40c67f0SKiyoshi Ueda 	/* Guess which priority_group will be used at next mapping time */
1670f40c67f0SKiyoshi Ueda 	if (unlikely(!m->current_pgpath && m->next_pg))
1671f40c67f0SKiyoshi Ueda 		pg = m->next_pg;
1672f40c67f0SKiyoshi Ueda 	else if (likely(m->current_pg))
1673f40c67f0SKiyoshi Ueda 		pg = m->current_pg;
1674f40c67f0SKiyoshi Ueda 	else
1675f40c67f0SKiyoshi Ueda 		/*
1676f40c67f0SKiyoshi Ueda 		 * We don't know which pg will be used at next mapping time.
1677f40c67f0SKiyoshi Ueda 		 * We don't call __choose_pgpath() here to avoid to trigger
1678f40c67f0SKiyoshi Ueda 		 * pg_init just by busy checking.
1679f40c67f0SKiyoshi Ueda 		 * So we don't know whether underlying devices we will be using
1680f40c67f0SKiyoshi Ueda 		 * at next mapping time are busy or not. Just try mapping.
1681f40c67f0SKiyoshi Ueda 		 */
1682f40c67f0SKiyoshi Ueda 		goto out;
1683f40c67f0SKiyoshi Ueda 
1684f40c67f0SKiyoshi Ueda 	/*
1685f40c67f0SKiyoshi Ueda 	 * If there is one non-busy active path at least, the path selector
1686f40c67f0SKiyoshi Ueda 	 * will be able to select it. So we consider such a pg as not busy.
1687f40c67f0SKiyoshi Ueda 	 */
1688*be7d31ccSMike Snitzer 	busy = true;
1689f40c67f0SKiyoshi Ueda 	list_for_each_entry(pgpath, &pg->pgpaths, list)
1690f40c67f0SKiyoshi Ueda 		if (pgpath->is_active) {
1691*be7d31ccSMike Snitzer 			has_active = true;
1692f40c67f0SKiyoshi Ueda 
1693f40c67f0SKiyoshi Ueda 			if (!__pgpath_busy(pgpath)) {
1694*be7d31ccSMike Snitzer 				busy = false;
1695f40c67f0SKiyoshi Ueda 				break;
1696f40c67f0SKiyoshi Ueda 			}
1697f40c67f0SKiyoshi Ueda 		}
1698f40c67f0SKiyoshi Ueda 
1699f40c67f0SKiyoshi Ueda 	if (!has_active)
1700f40c67f0SKiyoshi Ueda 		/*
1701f40c67f0SKiyoshi Ueda 		 * No active path in this pg, so this pg won't be used and
1702f40c67f0SKiyoshi Ueda 		 * the current_pg will be changed at next mapping time.
1703f40c67f0SKiyoshi Ueda 		 * We need to try mapping to determine it.
1704f40c67f0SKiyoshi Ueda 		 */
1705*be7d31ccSMike Snitzer 		busy = false;
1706f40c67f0SKiyoshi Ueda 
1707f40c67f0SKiyoshi Ueda out:
1708f40c67f0SKiyoshi Ueda 	spin_unlock_irqrestore(&m->lock, flags);
1709f40c67f0SKiyoshi Ueda 
1710f40c67f0SKiyoshi Ueda 	return busy;
1711f40c67f0SKiyoshi Ueda }
1712f40c67f0SKiyoshi Ueda 
17131da177e4SLinus Torvalds /*-----------------------------------------------------------------
17141da177e4SLinus Torvalds  * Module setup
17151da177e4SLinus Torvalds  *---------------------------------------------------------------*/
17161da177e4SLinus Torvalds static struct target_type multipath_target = {
17171da177e4SLinus Torvalds 	.name = "multipath",
171816f12266SMike Snitzer 	.version = {1, 11, 0},
171916f12266SMike Snitzer 	.features = DM_TARGET_SINGLETON | DM_TARGET_IMMUTABLE,
17201da177e4SLinus Torvalds 	.module = THIS_MODULE,
17211da177e4SLinus Torvalds 	.ctr = multipath_ctr,
17221da177e4SLinus Torvalds 	.dtr = multipath_dtr,
1723f40c67f0SKiyoshi Ueda 	.map_rq = multipath_map,
1724e5863d9aSMike Snitzer 	.clone_and_map_rq = multipath_clone_and_map,
1725e5863d9aSMike Snitzer 	.release_clone_rq = multipath_release_clone,
1726f40c67f0SKiyoshi Ueda 	.rq_end_io = multipath_end_io,
17271da177e4SLinus Torvalds 	.presuspend = multipath_presuspend,
17286df400abSKiyoshi Ueda 	.postsuspend = multipath_postsuspend,
17291da177e4SLinus Torvalds 	.resume = multipath_resume,
17301da177e4SLinus Torvalds 	.status = multipath_status,
17311da177e4SLinus Torvalds 	.message = multipath_message,
1732e56f81e0SChristoph Hellwig 	.prepare_ioctl = multipath_prepare_ioctl,
1733af4874e0SMike Snitzer 	.iterate_devices = multipath_iterate_devices,
1734f40c67f0SKiyoshi Ueda 	.busy = multipath_busy,
17351da177e4SLinus Torvalds };
17361da177e4SLinus Torvalds 
17371da177e4SLinus Torvalds static int __init dm_multipath_init(void)
17381da177e4SLinus Torvalds {
17391da177e4SLinus Torvalds 	int r;
17401da177e4SLinus Torvalds 
17411da177e4SLinus Torvalds 	/* allocate a slab for the dm_ios */
1742028867acSAlasdair G Kergon 	_mpio_cache = KMEM_CACHE(dm_mpath_io, 0);
17431da177e4SLinus Torvalds 	if (!_mpio_cache)
17441da177e4SLinus Torvalds 		return -ENOMEM;
17451da177e4SLinus Torvalds 
17461da177e4SLinus Torvalds 	r = dm_register_target(&multipath_target);
17471da177e4SLinus Torvalds 	if (r < 0) {
17480cd33124SAlasdair G Kergon 		DMERR("register failed %d", r);
1749ff658e9cSJohannes Thumshirn 		r = -EINVAL;
1750ff658e9cSJohannes Thumshirn 		goto bad_register_target;
17511da177e4SLinus Torvalds 	}
17521da177e4SLinus Torvalds 
17534d4d66abSTejun Heo 	kmultipathd = alloc_workqueue("kmpathd", WQ_MEM_RECLAIM, 0);
1754c557308eSAlasdair G Kergon 	if (!kmultipathd) {
17550cd33124SAlasdair G Kergon 		DMERR("failed to create workqueue kmpathd");
1756ff658e9cSJohannes Thumshirn 		r = -ENOMEM;
1757ff658e9cSJohannes Thumshirn 		goto bad_alloc_kmultipathd;
1758c557308eSAlasdair G Kergon 	}
1759c557308eSAlasdair G Kergon 
1760bab7cfc7SChandra Seetharaman 	/*
1761bab7cfc7SChandra Seetharaman 	 * A separate workqueue is used to handle the device handlers
1762bab7cfc7SChandra Seetharaman 	 * to avoid overloading existing workqueue. Overloading the
1763bab7cfc7SChandra Seetharaman 	 * old workqueue would also create a bottleneck in the
1764bab7cfc7SChandra Seetharaman 	 * path of the storage hardware device activation.
1765bab7cfc7SChandra Seetharaman 	 */
17664d4d66abSTejun Heo 	kmpath_handlerd = alloc_ordered_workqueue("kmpath_handlerd",
17674d4d66abSTejun Heo 						  WQ_MEM_RECLAIM);
1768bab7cfc7SChandra Seetharaman 	if (!kmpath_handlerd) {
1769bab7cfc7SChandra Seetharaman 		DMERR("failed to create workqueue kmpath_handlerd");
1770ff658e9cSJohannes Thumshirn 		r = -ENOMEM;
1771ff658e9cSJohannes Thumshirn 		goto bad_alloc_kmpath_handlerd;
1772bab7cfc7SChandra Seetharaman 	}
1773bab7cfc7SChandra Seetharaman 
177472d94861SAlasdair G Kergon 	DMINFO("version %u.%u.%u loaded",
17751da177e4SLinus Torvalds 	       multipath_target.version[0], multipath_target.version[1],
17761da177e4SLinus Torvalds 	       multipath_target.version[2]);
17771da177e4SLinus Torvalds 
1778ff658e9cSJohannes Thumshirn 	return 0;
1779ff658e9cSJohannes Thumshirn 
1780ff658e9cSJohannes Thumshirn bad_alloc_kmpath_handlerd:
1781ff658e9cSJohannes Thumshirn 	destroy_workqueue(kmultipathd);
1782ff658e9cSJohannes Thumshirn bad_alloc_kmultipathd:
1783ff658e9cSJohannes Thumshirn 	dm_unregister_target(&multipath_target);
1784ff658e9cSJohannes Thumshirn bad_register_target:
1785ff658e9cSJohannes Thumshirn 	kmem_cache_destroy(_mpio_cache);
1786ff658e9cSJohannes Thumshirn 
17871da177e4SLinus Torvalds 	return r;
17881da177e4SLinus Torvalds }
17891da177e4SLinus Torvalds 
17901da177e4SLinus Torvalds static void __exit dm_multipath_exit(void)
17911da177e4SLinus Torvalds {
1792bab7cfc7SChandra Seetharaman 	destroy_workqueue(kmpath_handlerd);
1793c557308eSAlasdair G Kergon 	destroy_workqueue(kmultipathd);
1794c557308eSAlasdair G Kergon 
179510d3bd09SMikulas Patocka 	dm_unregister_target(&multipath_target);
17961da177e4SLinus Torvalds 	kmem_cache_destroy(_mpio_cache);
17971da177e4SLinus Torvalds }
17981da177e4SLinus Torvalds 
17991da177e4SLinus Torvalds module_init(dm_multipath_init);
18001da177e4SLinus Torvalds module_exit(dm_multipath_exit);
18011da177e4SLinus Torvalds 
18021da177e4SLinus Torvalds MODULE_DESCRIPTION(DM_NAME " multipath target");
18031da177e4SLinus Torvalds MODULE_AUTHOR("Sistina Software <dm-devel@redhat.com>");
18041da177e4SLinus Torvalds MODULE_LICENSE("GPL");
1805