blob: 2c2c33f249986c86e29c9633539e3636078579df [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * Copyright (C) 2003 Sistina Software Limited.
3 * Copyright (C) 2004-2005 Red Hat, Inc. All rights reserved.
4 *
5 * This file is released under the GPL.
6 */
7
Mikulas Patocka586e80e2008-10-21 17:44:59 +01008#include <linux/device-mapper.h>
9
Mike Snitzerf4790822013-09-12 18:06:12 -040010#include "dm.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070011#include "dm-path-selector.h"
Mike Andersonb15546f2007-10-19 22:48:02 +010012#include "dm-uevent.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070013
14#include <linux/ctype.h>
15#include <linux/init.h>
16#include <linux/mempool.h>
17#include <linux/module.h>
18#include <linux/pagemap.h>
19#include <linux/slab.h>
20#include <linux/time.h>
21#include <linux/workqueue.h>
Mikulas Patocka35991652012-06-03 00:29:58 +010022#include <linux/delay.h>
Chandra Seetharamancfae5c92008-05-01 14:50:11 -070023#include <scsi/scsi_dh.h>
Arun Sharma600634972011-07-26 16:09:06 -070024#include <linux/atomic.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070025
Alasdair G Kergon72d94862006-06-26 00:27:35 -070026#define DM_MSG_PREFIX "multipath"
Chandra Seetharaman4e2d19e2011-01-13 20:00:01 +000027#define DM_PG_INIT_DELAY_MSECS 2000
28#define DM_PG_INIT_DELAY_DEFAULT ((unsigned) -1)
Linus Torvalds1da177e2005-04-16 15:20:36 -070029
30/* Path properties */
31struct pgpath {
32 struct list_head list;
33
34 struct priority_group *pg; /* Owning PG */
Kiyoshi Ueda66800732008-10-10 13:36:58 +010035 unsigned is_active; /* Path status */
Linus Torvalds1da177e2005-04-16 15:20:36 -070036 unsigned fail_count; /* Cumulative failure count */
37
Josef "Jeff" Sipekc922d5f2006-12-08 02:36:33 -080038 struct dm_path path;
Chandra Seetharaman4e2d19e2011-01-13 20:00:01 +000039 struct delayed_work activate_path;
Linus Torvalds1da177e2005-04-16 15:20:36 -070040};
41
42#define path_to_pgpath(__pgp) container_of((__pgp), struct pgpath, path)
43
44/*
45 * Paths are grouped into Priority Groups and numbered from 1 upwards.
46 * Each has a path selector which controls which path gets used.
47 */
48struct priority_group {
49 struct list_head list;
50
51 struct multipath *m; /* Owning multipath instance */
52 struct path_selector ps;
53
54 unsigned pg_num; /* Reference number */
55 unsigned bypassed; /* Temporarily bypass this PG? */
56
57 unsigned nr_pgpaths; /* Number of paths in PG */
58 struct list_head pgpaths;
59};
60
61/* Multipath context */
62struct multipath {
63 struct list_head list;
64 struct dm_target *ti;
65
Chandra Seetharamancfae5c92008-05-01 14:50:11 -070066 const char *hw_handler_name;
Chandra Seetharaman2bfd2e12009-08-03 12:42:45 -070067 char *hw_handler_params;
Chandra Seetharaman4e2d19e2011-01-13 20:00:01 +000068
Mike Snitzer1fbdd2b2012-06-03 00:29:43 +010069 spinlock_t lock;
70
Linus Torvalds1da177e2005-04-16 15:20:36 -070071 unsigned nr_priority_groups;
72 struct list_head priority_groups;
Chandra Seetharaman4e2d19e2011-01-13 20:00:01 +000073
74 wait_queue_head_t pg_init_wait; /* Wait for pg_init completion */
75
Linus Torvalds1da177e2005-04-16 15:20:36 -070076 unsigned pg_init_required; /* pg_init needs calling? */
Alasdair G Kergonc3cd4f62005-07-12 15:53:04 -070077 unsigned pg_init_in_progress; /* Only one pg_init allowed at once */
Chandra Seetharaman4e2d19e2011-01-13 20:00:01 +000078 unsigned pg_init_delay_retry; /* Delay pg_init retry? */
Linus Torvalds1da177e2005-04-16 15:20:36 -070079
80 unsigned nr_valid_paths; /* Total number of usable paths */
81 struct pgpath *current_pgpath;
82 struct priority_group *current_pg;
83 struct priority_group *next_pg; /* Switch to this PG if set */
84 unsigned repeat_count; /* I/Os left before calling PS again */
85
Mike Snitzer1fbdd2b2012-06-03 00:29:43 +010086 unsigned queue_io:1; /* Must we queue all I/O? */
87 unsigned queue_if_no_path:1; /* Queue I/O if last path fails? */
88 unsigned saved_queue_if_no_path:1; /* Saved state during suspension */
Mike Snitzera58a9352012-07-27 15:08:04 +010089 unsigned retain_attached_hw_handler:1; /* If there's already a hw_handler present, don't change it. */
Shiva Krishna Merla954a73d2013-10-30 03:26:38 +000090 unsigned pg_init_disabled:1; /* pg_init is not currently allowed */
Mike Snitzer1fbdd2b2012-06-03 00:29:43 +010091
Dave Wysochanskic9e45582007-10-19 22:47:53 +010092 unsigned pg_init_retries; /* Number of times to retry pg_init */
93 unsigned pg_init_count; /* Number of times pg_init called */
Chandra Seetharaman4e2d19e2011-01-13 20:00:01 +000094 unsigned pg_init_delay_msecs; /* Number of msecs before pg_init retry */
Linus Torvalds1da177e2005-04-16 15:20:36 -070095
Linus Torvalds1da177e2005-04-16 15:20:36 -070096 struct work_struct trigger_event;
97
98 /*
Alasdair G Kergon028867a2007-07-12 17:26:32 +010099 * We must use a mempool of dm_mpath_io structs so that we
Linus Torvalds1da177e2005-04-16 15:20:36 -0700100 * can resubmit bios on error.
101 */
102 mempool_t *mpio_pool;
Mike Anderson6380f262009-12-10 23:52:21 +0000103
104 struct mutex work_mutex;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700105};
106
107/*
108 * Context information attached to each bio we process.
109 */
Alasdair G Kergon028867a2007-07-12 17:26:32 +0100110struct dm_mpath_io {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111 struct pgpath *pgpath;
Kiyoshi Ueda02ab8232009-06-22 10:12:27 +0100112 size_t nr_bytes;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113};
114
115typedef int (*action_fn) (struct pgpath *pgpath);
116
Christoph Lametere18b8902006-12-06 20:33:20 -0800117static struct kmem_cache *_mpio_cache;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700118
Chandra Seetharamanbab7cfc2008-05-01 14:50:22 -0700119static struct workqueue_struct *kmultipathd, *kmpath_handlerd;
David Howellsc4028952006-11-22 14:57:56 +0000120static void trigger_event(struct work_struct *work);
Chandra Seetharamanbab7cfc2008-05-01 14:50:22 -0700121static void activate_path(struct work_struct *work);
Hannes Reineckee8099172014-02-28 15:33:44 +0100122static int __pgpath_busy(struct pgpath *pgpath);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123
124
125/*-----------------------------------------------
126 * Allocation routines
127 *-----------------------------------------------*/
128
129static struct pgpath *alloc_pgpath(void)
130{
Micha³ Miros³awe69fae52006-10-03 01:15:34 -0700131 struct pgpath *pgpath = kzalloc(sizeof(*pgpath), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132
Mike Anderson224cb3e2008-08-29 09:36:09 +0200133 if (pgpath) {
Kiyoshi Ueda66800732008-10-10 13:36:58 +0100134 pgpath->is_active = 1;
Chandra Seetharaman4e2d19e2011-01-13 20:00:01 +0000135 INIT_DELAYED_WORK(&pgpath->activate_path, activate_path);
Mike Anderson224cb3e2008-08-29 09:36:09 +0200136 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700137
138 return pgpath;
139}
140
Alasdair G Kergon028867a2007-07-12 17:26:32 +0100141static void free_pgpath(struct pgpath *pgpath)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142{
143 kfree(pgpath);
144}
145
146static struct priority_group *alloc_priority_group(void)
147{
148 struct priority_group *pg;
149
Micha³ Miros³awe69fae52006-10-03 01:15:34 -0700150 pg = kzalloc(sizeof(*pg), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700151
Micha³ Miros³awe69fae52006-10-03 01:15:34 -0700152 if (pg)
153 INIT_LIST_HEAD(&pg->pgpaths);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154
155 return pg;
156}
157
158static void free_pgpaths(struct list_head *pgpaths, struct dm_target *ti)
159{
160 struct pgpath *pgpath, *tmp;
Hannes Reineckeae11b1b2008-07-17 17:49:02 -0700161 struct multipath *m = ti->private;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162
163 list_for_each_entry_safe(pgpath, tmp, pgpaths, list) {
164 list_del(&pgpath->list);
Hannes Reineckeae11b1b2008-07-17 17:49:02 -0700165 if (m->hw_handler_name)
166 scsi_dh_detach(bdev_get_queue(pgpath->path.dev->bdev));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700167 dm_put_device(ti, pgpath->path.dev);
168 free_pgpath(pgpath);
169 }
170}
171
172static void free_priority_group(struct priority_group *pg,
173 struct dm_target *ti)
174{
175 struct path_selector *ps = &pg->ps;
176
177 if (ps->type) {
178 ps->type->destroy(ps);
179 dm_put_path_selector(ps->type);
180 }
181
182 free_pgpaths(&pg->pgpaths, ti);
183 kfree(pg);
184}
185
Micha³ Miros³aw28f16c22006-10-03 01:15:33 -0700186static struct multipath *alloc_multipath(struct dm_target *ti)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700187{
188 struct multipath *m;
Mike Snitzerf4790822013-09-12 18:06:12 -0400189 unsigned min_ios = dm_get_reserved_rq_based_ios();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700190
Micha³ Miros³awe69fae52006-10-03 01:15:34 -0700191 m = kzalloc(sizeof(*m), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700192 if (m) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700193 INIT_LIST_HEAD(&m->priority_groups);
194 spin_lock_init(&m->lock);
195 m->queue_io = 1;
Chandra Seetharaman4e2d19e2011-01-13 20:00:01 +0000196 m->pg_init_delay_msecs = DM_PG_INIT_DELAY_DEFAULT;
David Howellsc4028952006-11-22 14:57:56 +0000197 INIT_WORK(&m->trigger_event, trigger_event);
Kiyoshi Ueda2bded7b2010-03-06 02:32:13 +0000198 init_waitqueue_head(&m->pg_init_wait);
Mike Anderson6380f262009-12-10 23:52:21 +0000199 mutex_init(&m->work_mutex);
Mike Snitzerf4790822013-09-12 18:06:12 -0400200 m->mpio_pool = mempool_create_slab_pool(min_ios, _mpio_cache);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700201 if (!m->mpio_pool) {
202 kfree(m);
203 return NULL;
204 }
Micha³ Miros³aw28f16c22006-10-03 01:15:33 -0700205 m->ti = ti;
206 ti->private = m;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700207 }
208
209 return m;
210}
211
212static void free_multipath(struct multipath *m)
213{
214 struct priority_group *pg, *tmp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700215
216 list_for_each_entry_safe(pg, tmp, &m->priority_groups, list) {
217 list_del(&pg->list);
218 free_priority_group(pg, m->ti);
219 }
220
Chandra Seetharamancfae5c92008-05-01 14:50:11 -0700221 kfree(m->hw_handler_name);
Chandra Seetharaman2bfd2e12009-08-03 12:42:45 -0700222 kfree(m->hw_handler_params);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700223 mempool_destroy(m->mpio_pool);
224 kfree(m);
225}
226
Jun'ichi Nomura466891f2012-03-28 18:41:25 +0100227static int set_mapinfo(struct multipath *m, union map_info *info)
228{
229 struct dm_mpath_io *mpio;
230
231 mpio = mempool_alloc(m->mpio_pool, GFP_ATOMIC);
232 if (!mpio)
233 return -ENOMEM;
234
235 memset(mpio, 0, sizeof(*mpio));
236 info->ptr = mpio;
237
238 return 0;
239}
240
241static void clear_mapinfo(struct multipath *m, union map_info *info)
242{
243 struct dm_mpath_io *mpio = info->ptr;
244
245 info->ptr = NULL;
246 mempool_free(mpio, m->mpio_pool);
247}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700248
249/*-----------------------------------------------
250 * Path selection
251 *-----------------------------------------------*/
252
Hannes Reinecke3e9f1be2014-02-28 15:33:45 +0100253static int __pg_init_all_paths(struct multipath *m)
Kiyoshi Uedafb612642010-03-06 02:32:18 +0000254{
255 struct pgpath *pgpath;
Chandra Seetharaman4e2d19e2011-01-13 20:00:01 +0000256 unsigned long pg_init_delay = 0;
Kiyoshi Uedafb612642010-03-06 02:32:18 +0000257
Hannes Reinecke17f4ff42014-02-28 15:33:42 +0100258 if (m->pg_init_in_progress || m->pg_init_disabled)
Hannes Reinecke3e9f1be2014-02-28 15:33:45 +0100259 return 0;
Hannes Reinecke17f4ff42014-02-28 15:33:42 +0100260
Kiyoshi Uedafb612642010-03-06 02:32:18 +0000261 m->pg_init_count++;
262 m->pg_init_required = 0;
Hannes Reinecke3e9f1be2014-02-28 15:33:45 +0100263
264 /* Check here to reset pg_init_required */
265 if (!m->current_pg)
266 return 0;
267
Chandra Seetharaman4e2d19e2011-01-13 20:00:01 +0000268 if (m->pg_init_delay_retry)
269 pg_init_delay = msecs_to_jiffies(m->pg_init_delay_msecs != DM_PG_INIT_DELAY_DEFAULT ?
270 m->pg_init_delay_msecs : DM_PG_INIT_DELAY_MSECS);
Kiyoshi Uedafb612642010-03-06 02:32:18 +0000271 list_for_each_entry(pgpath, &m->current_pg->pgpaths, list) {
272 /* Skip failed paths */
273 if (!pgpath->is_active)
274 continue;
Chandra Seetharaman4e2d19e2011-01-13 20:00:01 +0000275 if (queue_delayed_work(kmpath_handlerd, &pgpath->activate_path,
276 pg_init_delay))
Kiyoshi Uedafb612642010-03-06 02:32:18 +0000277 m->pg_init_in_progress++;
278 }
Hannes Reinecke3e9f1be2014-02-28 15:33:45 +0100279 return m->pg_init_in_progress;
Kiyoshi Uedafb612642010-03-06 02:32:18 +0000280}
281
Linus Torvalds1da177e2005-04-16 15:20:36 -0700282static void __switch_pg(struct multipath *m, struct pgpath *pgpath)
283{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700284 m->current_pg = pgpath->pg;
285
286 /* Must we initialise the PG first, and queue I/O till it's ready? */
Chandra Seetharamancfae5c92008-05-01 14:50:11 -0700287 if (m->hw_handler_name) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700288 m->pg_init_required = 1;
289 m->queue_io = 1;
290 } else {
291 m->pg_init_required = 0;
292 m->queue_io = 0;
293 }
Dave Wysochanskic9e45582007-10-19 22:47:53 +0100294
295 m->pg_init_count = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700296}
297
Kiyoshi Ueda02ab8232009-06-22 10:12:27 +0100298static int __choose_path_in_pg(struct multipath *m, struct priority_group *pg,
299 size_t nr_bytes)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700300{
Josef "Jeff" Sipekc922d5f2006-12-08 02:36:33 -0800301 struct dm_path *path;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700302
Kiyoshi Ueda02ab8232009-06-22 10:12:27 +0100303 path = pg->ps.type->select_path(&pg->ps, &m->repeat_count, nr_bytes);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700304 if (!path)
305 return -ENXIO;
306
307 m->current_pgpath = path_to_pgpath(path);
308
309 if (m->current_pg != pg)
310 __switch_pg(m, m->current_pgpath);
311
312 return 0;
313}
314
Kiyoshi Ueda02ab8232009-06-22 10:12:27 +0100315static void __choose_pgpath(struct multipath *m, size_t nr_bytes)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700316{
317 struct priority_group *pg;
318 unsigned bypassed = 1;
319
320 if (!m->nr_valid_paths)
321 goto failed;
322
323 /* Were we instructed to switch PG? */
324 if (m->next_pg) {
325 pg = m->next_pg;
326 m->next_pg = NULL;
Kiyoshi Ueda02ab8232009-06-22 10:12:27 +0100327 if (!__choose_path_in_pg(m, pg, nr_bytes))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700328 return;
329 }
330
331 /* Don't change PG until it has no remaining paths */
Kiyoshi Ueda02ab8232009-06-22 10:12:27 +0100332 if (m->current_pg && !__choose_path_in_pg(m, m->current_pg, nr_bytes))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700333 return;
334
335 /*
336 * Loop through priority groups until we find a valid path.
337 * First time we skip PGs marked 'bypassed'.
Mike Christief220fd42012-06-03 00:29:45 +0100338 * Second time we only try the ones we skipped, but set
339 * pg_init_delay_retry so we do not hammer controllers.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700340 */
341 do {
342 list_for_each_entry(pg, &m->priority_groups, list) {
343 if (pg->bypassed == bypassed)
344 continue;
Mike Christief220fd42012-06-03 00:29:45 +0100345 if (!__choose_path_in_pg(m, pg, nr_bytes)) {
346 if (!bypassed)
347 m->pg_init_delay_retry = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700348 return;
Mike Christief220fd42012-06-03 00:29:45 +0100349 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700350 }
351 } while (bypassed--);
352
353failed:
354 m->current_pgpath = NULL;
355 m->current_pg = NULL;
356}
357
Kiyoshi Ueda45e15722006-12-08 02:41:10 -0800358/*
359 * Check whether bios must be queued in the device-mapper core rather
360 * than here in the target.
361 *
362 * m->lock must be held on entry.
363 *
364 * If m->queue_if_no_path and m->saved_queue_if_no_path hold the
365 * same value then we are not between multipath_presuspend()
366 * and multipath_resume() calls and we have no need to check
367 * for the DMF_NOFLUSH_SUSPENDING flag.
368 */
369static int __must_push_back(struct multipath *m)
370{
Hannes Reineckee8099172014-02-28 15:33:44 +0100371 return (m->queue_if_no_path ||
372 (m->queue_if_no_path != m->saved_queue_if_no_path &&
373 dm_noflush_suspending(m->ti)));
Kiyoshi Ueda45e15722006-12-08 02:41:10 -0800374}
375
Hannes Reineckee8099172014-02-28 15:33:44 +0100376#define pg_ready(m) (!(m)->queue_io && !(m)->pg_init_required)
377
Kiyoshi Uedaf40c67f2009-06-22 10:12:37 +0100378static int map_io(struct multipath *m, struct request *clone,
Hannes Reineckee8099172014-02-28 15:33:44 +0100379 union map_info *map_context)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700380{
Hannes Reineckee3bde042014-02-28 15:33:46 +0100381 int r = DM_MAPIO_REQUEUE;
Kiyoshi Uedaf40c67f2009-06-22 10:12:37 +0100382 size_t nr_bytes = blk_rq_bytes(clone);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700383 unsigned long flags;
384 struct pgpath *pgpath;
Kiyoshi Uedaf40c67f2009-06-22 10:12:37 +0100385 struct block_device *bdev;
Hannes Reineckee3bde042014-02-28 15:33:46 +0100386 struct dm_mpath_io *mpio;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700387
388 spin_lock_irqsave(&m->lock, flags);
389
390 /* Do we need to select a new pgpath? */
391 if (!m->current_pgpath ||
392 (!m->queue_io && (m->repeat_count && --m->repeat_count == 0)))
Kiyoshi Ueda02ab8232009-06-22 10:12:27 +0100393 __choose_pgpath(m, nr_bytes);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700394
395 pgpath = m->current_pgpath;
396
Hannes Reineckee8099172014-02-28 15:33:44 +0100397 if (pgpath) {
398 if (pg_ready(m)) {
Hannes Reineckee3bde042014-02-28 15:33:46 +0100399 if (set_mapinfo(m, map_context) < 0)
400 /* ENOMEM, requeue */
401 goto out_unlock;
402
Hannes Reineckee8099172014-02-28 15:33:44 +0100403 bdev = pgpath->path.dev->bdev;
404 clone->q = bdev_get_queue(bdev);
405 clone->rq_disk = bdev->bd_disk;
Hannes Reineckee3bde042014-02-28 15:33:46 +0100406 clone->cmd_flags |= REQ_FAILFAST_TRANSPORT;
407 mpio = map_context->ptr;
Hannes Reineckee8099172014-02-28 15:33:44 +0100408 mpio->pgpath = pgpath;
409 mpio->nr_bytes = nr_bytes;
410 if (pgpath->pg->ps.type->start_io)
411 pgpath->pg->ps.type->start_io(&pgpath->pg->ps,
412 &pgpath->path,
413 nr_bytes);
Hannes Reineckee3bde042014-02-28 15:33:46 +0100414 r = DM_MAPIO_REMAPPED;
415 goto out_unlock;
Hannes Reineckee8099172014-02-28 15:33:44 +0100416 }
Hannes Reineckee3bde042014-02-28 15:33:46 +0100417 __pg_init_all_paths(m);
418 } else if (!__must_push_back(m))
419 r = -EIO; /* Failed */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700420
Hannes Reineckee3bde042014-02-28 15:33:46 +0100421out_unlock:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700422 spin_unlock_irqrestore(&m->lock, flags);
423
424 return r;
425}
426
427/*
428 * If we run out of usable paths, should we queue I/O or error it?
429 */
Alasdair G Kergon485ef692005-09-27 21:45:45 -0700430static int queue_if_no_path(struct multipath *m, unsigned queue_if_no_path,
431 unsigned save_old_value)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700432{
433 unsigned long flags;
434
435 spin_lock_irqsave(&m->lock, flags);
436
Alasdair G Kergon485ef692005-09-27 21:45:45 -0700437 if (save_old_value)
438 m->saved_queue_if_no_path = m->queue_if_no_path;
439 else
440 m->saved_queue_if_no_path = queue_if_no_path;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700441 m->queue_if_no_path = queue_if_no_path;
Hannes Reineckee8099172014-02-28 15:33:44 +0100442 if (!m->queue_if_no_path)
Hannes Reinecke3e9f1be2014-02-28 15:33:45 +0100443 dm_table_run_md_queue_async(m->ti->table);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700444
445 spin_unlock_irqrestore(&m->lock, flags);
446
447 return 0;
448}
449
Linus Torvalds1da177e2005-04-16 15:20:36 -0700450/*
451 * An event is triggered whenever a path is taken out of use.
452 * Includes path failure and PG bypass.
453 */
David Howellsc4028952006-11-22 14:57:56 +0000454static void trigger_event(struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700455{
David Howellsc4028952006-11-22 14:57:56 +0000456 struct multipath *m =
457 container_of(work, struct multipath, trigger_event);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700458
459 dm_table_event(m->ti->table);
460}
461
462/*-----------------------------------------------------------------
463 * Constructor/argument parsing:
464 * <#multipath feature args> [<arg>]*
465 * <#hw_handler args> [hw_handler [<arg>]*]
466 * <#priority groups>
467 * <initial priority group>
468 * [<selector> <#selector args> [<arg>]*
469 * <#paths> <#per-path selector args>
470 * [<path> [<arg>]* ]+ ]+
471 *---------------------------------------------------------------*/
Mike Snitzer498f0102011-08-02 12:32:04 +0100472static int parse_path_selector(struct dm_arg_set *as, struct priority_group *pg,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700473 struct dm_target *ti)
474{
475 int r;
476 struct path_selector_type *pst;
477 unsigned ps_argc;
478
Mike Snitzer498f0102011-08-02 12:32:04 +0100479 static struct dm_arg _args[] = {
Alasdair G Kergon72d94862006-06-26 00:27:35 -0700480 {0, 1024, "invalid number of path selector args"},
Linus Torvalds1da177e2005-04-16 15:20:36 -0700481 };
482
Mike Snitzer498f0102011-08-02 12:32:04 +0100483 pst = dm_get_path_selector(dm_shift_arg(as));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700484 if (!pst) {
Alasdair G Kergon72d94862006-06-26 00:27:35 -0700485 ti->error = "unknown path selector type";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700486 return -EINVAL;
487 }
488
Mike Snitzer498f0102011-08-02 12:32:04 +0100489 r = dm_read_arg_group(_args, as, &ps_argc, &ti->error);
Mikulas Patocka371b2e32008-07-21 12:00:24 +0100490 if (r) {
491 dm_put_path_selector(pst);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700492 return -EINVAL;
Mikulas Patocka371b2e32008-07-21 12:00:24 +0100493 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700494
495 r = pst->create(&pg->ps, ps_argc, as->argv);
496 if (r) {
497 dm_put_path_selector(pst);
Alasdair G Kergon72d94862006-06-26 00:27:35 -0700498 ti->error = "path selector constructor failed";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700499 return r;
500 }
501
502 pg->ps.type = pst;
Mike Snitzer498f0102011-08-02 12:32:04 +0100503 dm_consume_args(as, ps_argc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700504
505 return 0;
506}
507
Mike Snitzer498f0102011-08-02 12:32:04 +0100508static struct pgpath *parse_path(struct dm_arg_set *as, struct path_selector *ps,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700509 struct dm_target *ti)
510{
511 int r;
512 struct pgpath *p;
Hannes Reineckeae11b1b2008-07-17 17:49:02 -0700513 struct multipath *m = ti->private;
Mike Snitzera58a9352012-07-27 15:08:04 +0100514 struct request_queue *q = NULL;
515 const char *attached_handler_name;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700516
517 /* we need at least a path arg */
518 if (as->argc < 1) {
Alasdair G Kergon72d94862006-06-26 00:27:35 -0700519 ti->error = "no device given";
Benjamin Marzinski01460f32008-10-10 13:36:57 +0100520 return ERR_PTR(-EINVAL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700521 }
522
523 p = alloc_pgpath();
524 if (!p)
Benjamin Marzinski01460f32008-10-10 13:36:57 +0100525 return ERR_PTR(-ENOMEM);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700526
Mike Snitzer498f0102011-08-02 12:32:04 +0100527 r = dm_get_device(ti, dm_shift_arg(as), dm_table_get_mode(ti->table),
Nikanth Karthikesan8215d6e2010-03-06 02:32:27 +0000528 &p->path.dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700529 if (r) {
Alasdair G Kergon72d94862006-06-26 00:27:35 -0700530 ti->error = "error getting device";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700531 goto bad;
532 }
533
Mike Snitzera58a9352012-07-27 15:08:04 +0100534 if (m->retain_attached_hw_handler || m->hw_handler_name)
535 q = bdev_get_queue(p->path.dev->bdev);
Hannes Reineckea0cf7ea2009-06-22 10:12:11 +0100536
Mike Snitzera58a9352012-07-27 15:08:04 +0100537 if (m->retain_attached_hw_handler) {
538 attached_handler_name = scsi_dh_attached_handler_name(q, GFP_KERNEL);
539 if (attached_handler_name) {
540 /*
541 * Reset hw_handler_name to match the attached handler
542 * and clear any hw_handler_params associated with the
543 * ignored handler.
544 *
545 * NB. This modifies the table line to show the actual
546 * handler instead of the original table passed in.
547 */
548 kfree(m->hw_handler_name);
549 m->hw_handler_name = attached_handler_name;
550
551 kfree(m->hw_handler_params);
552 m->hw_handler_params = NULL;
553 }
554 }
555
556 if (m->hw_handler_name) {
557 /*
558 * Increments scsi_dh reference, even when using an
559 * already-attached handler.
560 */
Hannes Reineckea0cf7ea2009-06-22 10:12:11 +0100561 r = scsi_dh_attach(q, m->hw_handler_name);
562 if (r == -EBUSY) {
563 /*
Mike Snitzera58a9352012-07-27 15:08:04 +0100564 * Already attached to different hw_handler:
Hannes Reineckea0cf7ea2009-06-22 10:12:11 +0100565 * try to reattach with correct one.
566 */
567 scsi_dh_detach(q);
568 r = scsi_dh_attach(q, m->hw_handler_name);
569 }
570
Hannes Reineckeae11b1b2008-07-17 17:49:02 -0700571 if (r < 0) {
Hannes Reineckea0cf7ea2009-06-22 10:12:11 +0100572 ti->error = "error attaching hardware handler";
Hannes Reineckeae11b1b2008-07-17 17:49:02 -0700573 dm_put_device(ti, p->path.dev);
574 goto bad;
575 }
Chandra Seetharaman2bfd2e12009-08-03 12:42:45 -0700576
577 if (m->hw_handler_params) {
578 r = scsi_dh_set_params(q, m->hw_handler_params);
579 if (r < 0) {
580 ti->error = "unable to set hardware "
581 "handler parameters";
582 scsi_dh_detach(q);
583 dm_put_device(ti, p->path.dev);
584 goto bad;
585 }
586 }
Hannes Reineckeae11b1b2008-07-17 17:49:02 -0700587 }
588
Linus Torvalds1da177e2005-04-16 15:20:36 -0700589 r = ps->type->add_path(ps, &p->path, as->argc, as->argv, &ti->error);
590 if (r) {
591 dm_put_device(ti, p->path.dev);
592 goto bad;
593 }
594
595 return p;
596
597 bad:
598 free_pgpath(p);
Benjamin Marzinski01460f32008-10-10 13:36:57 +0100599 return ERR_PTR(r);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700600}
601
Mike Snitzer498f0102011-08-02 12:32:04 +0100602static struct priority_group *parse_priority_group(struct dm_arg_set *as,
Micha³ Miros³aw28f16c22006-10-03 01:15:33 -0700603 struct multipath *m)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700604{
Mike Snitzer498f0102011-08-02 12:32:04 +0100605 static struct dm_arg _args[] = {
Alasdair G Kergon72d94862006-06-26 00:27:35 -0700606 {1, 1024, "invalid number of paths"},
607 {0, 1024, "invalid number of selector args"}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700608 };
609
610 int r;
Mike Snitzer498f0102011-08-02 12:32:04 +0100611 unsigned i, nr_selector_args, nr_args;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700612 struct priority_group *pg;
Micha³ Miros³aw28f16c22006-10-03 01:15:33 -0700613 struct dm_target *ti = m->ti;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700614
615 if (as->argc < 2) {
616 as->argc = 0;
Benjamin Marzinski01460f32008-10-10 13:36:57 +0100617 ti->error = "not enough priority group arguments";
618 return ERR_PTR(-EINVAL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700619 }
620
621 pg = alloc_priority_group();
622 if (!pg) {
Alasdair G Kergon72d94862006-06-26 00:27:35 -0700623 ti->error = "couldn't allocate priority group";
Benjamin Marzinski01460f32008-10-10 13:36:57 +0100624 return ERR_PTR(-ENOMEM);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700625 }
626 pg->m = m;
627
628 r = parse_path_selector(as, pg, ti);
629 if (r)
630 goto bad;
631
632 /*
633 * read the paths
634 */
Mike Snitzer498f0102011-08-02 12:32:04 +0100635 r = dm_read_arg(_args, as, &pg->nr_pgpaths, &ti->error);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700636 if (r)
637 goto bad;
638
Mike Snitzer498f0102011-08-02 12:32:04 +0100639 r = dm_read_arg(_args + 1, as, &nr_selector_args, &ti->error);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700640 if (r)
641 goto bad;
642
Mike Snitzer498f0102011-08-02 12:32:04 +0100643 nr_args = 1 + nr_selector_args;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700644 for (i = 0; i < pg->nr_pgpaths; i++) {
645 struct pgpath *pgpath;
Mike Snitzer498f0102011-08-02 12:32:04 +0100646 struct dm_arg_set path_args;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700647
Mike Snitzer498f0102011-08-02 12:32:04 +0100648 if (as->argc < nr_args) {
Mikulas Patocka148acff2008-07-21 12:00:30 +0100649 ti->error = "not enough path parameters";
Alasdair G Kergon6bbf79a2010-08-12 04:13:49 +0100650 r = -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700651 goto bad;
Mikulas Patocka148acff2008-07-21 12:00:30 +0100652 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700653
Mike Snitzer498f0102011-08-02 12:32:04 +0100654 path_args.argc = nr_args;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700655 path_args.argv = as->argv;
656
657 pgpath = parse_path(&path_args, &pg->ps, ti);
Benjamin Marzinski01460f32008-10-10 13:36:57 +0100658 if (IS_ERR(pgpath)) {
659 r = PTR_ERR(pgpath);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700660 goto bad;
Benjamin Marzinski01460f32008-10-10 13:36:57 +0100661 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700662
663 pgpath->pg = pg;
664 list_add_tail(&pgpath->list, &pg->pgpaths);
Mike Snitzer498f0102011-08-02 12:32:04 +0100665 dm_consume_args(as, nr_args);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700666 }
667
668 return pg;
669
670 bad:
671 free_priority_group(pg, ti);
Benjamin Marzinski01460f32008-10-10 13:36:57 +0100672 return ERR_PTR(r);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700673}
674
Mike Snitzer498f0102011-08-02 12:32:04 +0100675static int parse_hw_handler(struct dm_arg_set *as, struct multipath *m)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700676{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700677 unsigned hw_argc;
Chandra Seetharaman2bfd2e12009-08-03 12:42:45 -0700678 int ret;
Micha³ Miros³aw28f16c22006-10-03 01:15:33 -0700679 struct dm_target *ti = m->ti;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700680
Mike Snitzer498f0102011-08-02 12:32:04 +0100681 static struct dm_arg _args[] = {
Alasdair G Kergon72d94862006-06-26 00:27:35 -0700682 {0, 1024, "invalid number of hardware handler args"},
Linus Torvalds1da177e2005-04-16 15:20:36 -0700683 };
684
Mike Snitzer498f0102011-08-02 12:32:04 +0100685 if (dm_read_arg_group(_args, as, &hw_argc, &ti->error))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700686 return -EINVAL;
687
688 if (!hw_argc)
689 return 0;
690
Mike Snitzer498f0102011-08-02 12:32:04 +0100691 m->hw_handler_name = kstrdup(dm_shift_arg(as), GFP_KERNEL);
Mike Snitzer510193a2012-05-12 01:43:21 +0100692 if (!try_then_request_module(scsi_dh_handler_exist(m->hw_handler_name),
693 "scsi_dh_%s", m->hw_handler_name)) {
Alasdair G Kergon72d94862006-06-26 00:27:35 -0700694 ti->error = "unknown hardware handler type";
Chandra Seetharaman2bfd2e12009-08-03 12:42:45 -0700695 ret = -EINVAL;
696 goto fail;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700697 }
Chandra Seetharaman14e98c52008-11-13 23:39:06 +0000698
Chandra Seetharaman2bfd2e12009-08-03 12:42:45 -0700699 if (hw_argc > 1) {
700 char *p;
701 int i, j, len = 4;
702
703 for (i = 0; i <= hw_argc - 2; i++)
704 len += strlen(as->argv[i]) + 1;
705 p = m->hw_handler_params = kzalloc(len, GFP_KERNEL);
706 if (!p) {
707 ti->error = "memory allocation failed";
708 ret = -ENOMEM;
709 goto fail;
710 }
711 j = sprintf(p, "%d", hw_argc - 1);
712 for (i = 0, p+=j+1; i <= hw_argc - 2; i++, p+=j+1)
713 j = sprintf(p, "%s", as->argv[i]);
714 }
Mike Snitzer498f0102011-08-02 12:32:04 +0100715 dm_consume_args(as, hw_argc - 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700716
717 return 0;
Chandra Seetharaman2bfd2e12009-08-03 12:42:45 -0700718fail:
719 kfree(m->hw_handler_name);
720 m->hw_handler_name = NULL;
721 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700722}
723
Mike Snitzer498f0102011-08-02 12:32:04 +0100724static int parse_features(struct dm_arg_set *as, struct multipath *m)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700725{
726 int r;
727 unsigned argc;
Micha³ Miros³aw28f16c22006-10-03 01:15:33 -0700728 struct dm_target *ti = m->ti;
Mike Snitzer498f0102011-08-02 12:32:04 +0100729 const char *arg_name;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700730
Mike Snitzer498f0102011-08-02 12:32:04 +0100731 static struct dm_arg _args[] = {
Mike Snitzera58a9352012-07-27 15:08:04 +0100732 {0, 6, "invalid number of feature args"},
Dave Wysochanskic9e45582007-10-19 22:47:53 +0100733 {1, 50, "pg_init_retries must be between 1 and 50"},
Chandra Seetharaman4e2d19e2011-01-13 20:00:01 +0000734 {0, 60000, "pg_init_delay_msecs must be between 0 and 60000"},
Linus Torvalds1da177e2005-04-16 15:20:36 -0700735 };
736
Mike Snitzer498f0102011-08-02 12:32:04 +0100737 r = dm_read_arg_group(_args, as, &argc, &ti->error);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700738 if (r)
739 return -EINVAL;
740
741 if (!argc)
742 return 0;
743
Dave Wysochanskic9e45582007-10-19 22:47:53 +0100744 do {
Mike Snitzer498f0102011-08-02 12:32:04 +0100745 arg_name = dm_shift_arg(as);
Dave Wysochanskic9e45582007-10-19 22:47:53 +0100746 argc--;
747
Mike Snitzer498f0102011-08-02 12:32:04 +0100748 if (!strcasecmp(arg_name, "queue_if_no_path")) {
Dave Wysochanskic9e45582007-10-19 22:47:53 +0100749 r = queue_if_no_path(m, 1, 0);
750 continue;
751 }
752
Mike Snitzera58a9352012-07-27 15:08:04 +0100753 if (!strcasecmp(arg_name, "retain_attached_hw_handler")) {
754 m->retain_attached_hw_handler = 1;
755 continue;
756 }
757
Mike Snitzer498f0102011-08-02 12:32:04 +0100758 if (!strcasecmp(arg_name, "pg_init_retries") &&
Dave Wysochanskic9e45582007-10-19 22:47:53 +0100759 (argc >= 1)) {
Mike Snitzer498f0102011-08-02 12:32:04 +0100760 r = dm_read_arg(_args + 1, as, &m->pg_init_retries, &ti->error);
Dave Wysochanskic9e45582007-10-19 22:47:53 +0100761 argc--;
762 continue;
763 }
764
Mike Snitzer498f0102011-08-02 12:32:04 +0100765 if (!strcasecmp(arg_name, "pg_init_delay_msecs") &&
Chandra Seetharaman4e2d19e2011-01-13 20:00:01 +0000766 (argc >= 1)) {
Mike Snitzer498f0102011-08-02 12:32:04 +0100767 r = dm_read_arg(_args + 2, as, &m->pg_init_delay_msecs, &ti->error);
Chandra Seetharaman4e2d19e2011-01-13 20:00:01 +0000768 argc--;
769 continue;
770 }
771
Linus Torvalds1da177e2005-04-16 15:20:36 -0700772 ti->error = "Unrecognised multipath feature request";
Dave Wysochanskic9e45582007-10-19 22:47:53 +0100773 r = -EINVAL;
774 } while (argc && !r);
775
776 return r;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700777}
778
779static int multipath_ctr(struct dm_target *ti, unsigned int argc,
780 char **argv)
781{
Mike Snitzer498f0102011-08-02 12:32:04 +0100782 /* target arguments */
783 static struct dm_arg _args[] = {
Mike Snitzera490a072011-03-24 13:54:33 +0000784 {0, 1024, "invalid number of priority groups"},
785 {0, 1024, "invalid initial priority group number"},
Linus Torvalds1da177e2005-04-16 15:20:36 -0700786 };
787
788 int r;
789 struct multipath *m;
Mike Snitzer498f0102011-08-02 12:32:04 +0100790 struct dm_arg_set as;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700791 unsigned pg_count = 0;
792 unsigned next_pg_num;
793
794 as.argc = argc;
795 as.argv = argv;
796
Micha³ Miros³aw28f16c22006-10-03 01:15:33 -0700797 m = alloc_multipath(ti);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700798 if (!m) {
Alasdair G Kergon72d94862006-06-26 00:27:35 -0700799 ti->error = "can't allocate multipath";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700800 return -EINVAL;
801 }
802
Micha³ Miros³aw28f16c22006-10-03 01:15:33 -0700803 r = parse_features(&as, m);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700804 if (r)
805 goto bad;
806
Micha³ Miros³aw28f16c22006-10-03 01:15:33 -0700807 r = parse_hw_handler(&as, m);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700808 if (r)
809 goto bad;
810
Mike Snitzer498f0102011-08-02 12:32:04 +0100811 r = dm_read_arg(_args, &as, &m->nr_priority_groups, &ti->error);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700812 if (r)
813 goto bad;
814
Mike Snitzer498f0102011-08-02 12:32:04 +0100815 r = dm_read_arg(_args + 1, &as, &next_pg_num, &ti->error);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700816 if (r)
817 goto bad;
818
Mike Snitzera490a072011-03-24 13:54:33 +0000819 if ((!m->nr_priority_groups && next_pg_num) ||
820 (m->nr_priority_groups && !next_pg_num)) {
821 ti->error = "invalid initial priority group";
822 r = -EINVAL;
823 goto bad;
824 }
825
Linus Torvalds1da177e2005-04-16 15:20:36 -0700826 /* parse the priority groups */
827 while (as.argc) {
828 struct priority_group *pg;
829
Micha³ Miros³aw28f16c22006-10-03 01:15:33 -0700830 pg = parse_priority_group(&as, m);
Benjamin Marzinski01460f32008-10-10 13:36:57 +0100831 if (IS_ERR(pg)) {
832 r = PTR_ERR(pg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700833 goto bad;
834 }
835
836 m->nr_valid_paths += pg->nr_pgpaths;
837 list_add_tail(&pg->list, &m->priority_groups);
838 pg_count++;
839 pg->pg_num = pg_count;
840 if (!--next_pg_num)
841 m->next_pg = pg;
842 }
843
844 if (pg_count != m->nr_priority_groups) {
Alasdair G Kergon72d94862006-06-26 00:27:35 -0700845 ti->error = "priority group count mismatch";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700846 r = -EINVAL;
847 goto bad;
848 }
849
Alasdair G Kergon55a62ee2013-03-01 22:45:47 +0000850 ti->num_flush_bios = 1;
851 ti->num_discard_bios = 1;
Mike Snitzer042bcef2013-05-10 14:37:16 +0100852 ti->num_write_same_bios = 1;
Mikulas Patocka86279212009-06-22 10:12:24 +0100853
Linus Torvalds1da177e2005-04-16 15:20:36 -0700854 return 0;
855
856 bad:
857 free_multipath(m);
858 return r;
859}
860
Kiyoshi Ueda2bded7b2010-03-06 02:32:13 +0000861static void multipath_wait_for_pg_init_completion(struct multipath *m)
862{
863 DECLARE_WAITQUEUE(wait, current);
864 unsigned long flags;
865
866 add_wait_queue(&m->pg_init_wait, &wait);
867
868 while (1) {
869 set_current_state(TASK_UNINTERRUPTIBLE);
870
871 spin_lock_irqsave(&m->lock, flags);
872 if (!m->pg_init_in_progress) {
873 spin_unlock_irqrestore(&m->lock, flags);
874 break;
875 }
876 spin_unlock_irqrestore(&m->lock, flags);
877
878 io_schedule();
879 }
880 set_current_state(TASK_RUNNING);
881
882 remove_wait_queue(&m->pg_init_wait, &wait);
883}
884
885static void flush_multipath_work(struct multipath *m)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700886{
Shiva Krishna Merla954a73d2013-10-30 03:26:38 +0000887 unsigned long flags;
888
889 spin_lock_irqsave(&m->lock, flags);
890 m->pg_init_disabled = 1;
891 spin_unlock_irqrestore(&m->lock, flags);
892
Chandra Seetharamanbab7cfc2008-05-01 14:50:22 -0700893 flush_workqueue(kmpath_handlerd);
Kiyoshi Ueda2bded7b2010-03-06 02:32:13 +0000894 multipath_wait_for_pg_init_completion(m);
Alasdair G Kergona044d012005-07-12 15:53:02 -0700895 flush_workqueue(kmultipathd);
Tejun Heo43829732012-08-20 14:51:24 -0700896 flush_work(&m->trigger_event);
Shiva Krishna Merla954a73d2013-10-30 03:26:38 +0000897
898 spin_lock_irqsave(&m->lock, flags);
899 m->pg_init_disabled = 0;
900 spin_unlock_irqrestore(&m->lock, flags);
Kiyoshi Ueda6df400a2009-12-10 23:52:19 +0000901}
902
903static void multipath_dtr(struct dm_target *ti)
904{
905 struct multipath *m = ti->private;
906
Kiyoshi Ueda2bded7b2010-03-06 02:32:13 +0000907 flush_multipath_work(m);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700908 free_multipath(m);
909}
910
911/*
Kiyoshi Uedaf40c67f2009-06-22 10:12:37 +0100912 * Map cloned requests
Linus Torvalds1da177e2005-04-16 15:20:36 -0700913 */
Kiyoshi Uedaf40c67f2009-06-22 10:12:37 +0100914static int multipath_map(struct dm_target *ti, struct request *clone,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700915 union map_info *map_context)
916{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700917 struct multipath *m = (struct multipath *) ti->private;
918
Hannes Reineckee3bde042014-02-28 15:33:46 +0100919 return map_io(m, clone, map_context);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700920}
921
922/*
923 * Take a path out of use.
924 */
925static int fail_path(struct pgpath *pgpath)
926{
927 unsigned long flags;
928 struct multipath *m = pgpath->pg->m;
929
930 spin_lock_irqsave(&m->lock, flags);
931
Kiyoshi Ueda66800732008-10-10 13:36:58 +0100932 if (!pgpath->is_active)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700933 goto out;
934
Alasdair G Kergon72d94862006-06-26 00:27:35 -0700935 DMWARN("Failing path %s.", pgpath->path.dev->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700936
937 pgpath->pg->ps.type->fail_path(&pgpath->pg->ps, &pgpath->path);
Kiyoshi Ueda66800732008-10-10 13:36:58 +0100938 pgpath->is_active = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700939 pgpath->fail_count++;
940
941 m->nr_valid_paths--;
942
943 if (pgpath == m->current_pgpath)
944 m->current_pgpath = NULL;
945
Mike Andersonb15546f2007-10-19 22:48:02 +0100946 dm_path_uevent(DM_UEVENT_PATH_FAILED, m->ti,
947 pgpath->path.dev->name, m->nr_valid_paths);
948
Alasdair G Kergonfe9cf302009-01-06 03:05:13 +0000949 schedule_work(&m->trigger_event);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700950
951out:
952 spin_unlock_irqrestore(&m->lock, flags);
953
954 return 0;
955}
956
957/*
958 * Reinstate a previously-failed path
959 */
960static int reinstate_path(struct pgpath *pgpath)
961{
962 int r = 0;
963 unsigned long flags;
964 struct multipath *m = pgpath->pg->m;
965
966 spin_lock_irqsave(&m->lock, flags);
967
Kiyoshi Ueda66800732008-10-10 13:36:58 +0100968 if (pgpath->is_active)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700969 goto out;
970
Alasdair G Kergondef052d2008-07-21 12:00:31 +0100971 if (!pgpath->pg->ps.type->reinstate_path) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700972 DMWARN("Reinstate path not supported by path selector %s",
973 pgpath->pg->ps.type->name);
974 r = -EINVAL;
975 goto out;
976 }
977
978 r = pgpath->pg->ps.type->reinstate_path(&pgpath->pg->ps, &pgpath->path);
979 if (r)
980 goto out;
981
Kiyoshi Ueda66800732008-10-10 13:36:58 +0100982 pgpath->is_active = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700983
Hannes Reineckee8099172014-02-28 15:33:44 +0100984 if (!m->nr_valid_paths++) {
Chandra Seetharamane54f77d2009-06-22 10:12:12 +0100985 m->current_pgpath = NULL;
Hannes Reinecke3e9f1be2014-02-28 15:33:45 +0100986 dm_table_run_md_queue_async(m->ti->table);
Chandra Seetharamane54f77d2009-06-22 10:12:12 +0100987 } else if (m->hw_handler_name && (m->current_pg == pgpath->pg)) {
Chandra Seetharaman4e2d19e2011-01-13 20:00:01 +0000988 if (queue_work(kmpath_handlerd, &pgpath->activate_path.work))
Chandra Seetharamane54f77d2009-06-22 10:12:12 +0100989 m->pg_init_in_progress++;
990 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700991
Mike Andersonb15546f2007-10-19 22:48:02 +0100992 dm_path_uevent(DM_UEVENT_PATH_REINSTATED, m->ti,
993 pgpath->path.dev->name, m->nr_valid_paths);
994
Alasdair G Kergonfe9cf302009-01-06 03:05:13 +0000995 schedule_work(&m->trigger_event);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700996
997out:
998 spin_unlock_irqrestore(&m->lock, flags);
999
1000 return r;
1001}
1002
1003/*
1004 * Fail or reinstate all paths that match the provided struct dm_dev.
1005 */
1006static int action_dev(struct multipath *m, struct dm_dev *dev,
1007 action_fn action)
1008{
Mike Snitzer19040c02011-03-24 13:54:31 +00001009 int r = -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001010 struct pgpath *pgpath;
1011 struct priority_group *pg;
1012
1013 list_for_each_entry(pg, &m->priority_groups, list) {
1014 list_for_each_entry(pgpath, &pg->pgpaths, list) {
1015 if (pgpath->path.dev == dev)
1016 r = action(pgpath);
1017 }
1018 }
1019
1020 return r;
1021}
1022
1023/*
1024 * Temporarily try to avoid having to use the specified PG
1025 */
1026static void bypass_pg(struct multipath *m, struct priority_group *pg,
1027 int bypassed)
1028{
1029 unsigned long flags;
1030
1031 spin_lock_irqsave(&m->lock, flags);
1032
1033 pg->bypassed = bypassed;
1034 m->current_pgpath = NULL;
1035 m->current_pg = NULL;
1036
1037 spin_unlock_irqrestore(&m->lock, flags);
1038
Alasdair G Kergonfe9cf302009-01-06 03:05:13 +00001039 schedule_work(&m->trigger_event);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001040}
1041
1042/*
1043 * Switch to using the specified PG from the next I/O that gets mapped
1044 */
1045static int switch_pg_num(struct multipath *m, const char *pgstr)
1046{
1047 struct priority_group *pg;
1048 unsigned pgnum;
1049 unsigned long flags;
Mikulas Patocka31998ef2012-03-28 18:41:26 +01001050 char dummy;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001051
Mikulas Patocka31998ef2012-03-28 18:41:26 +01001052 if (!pgstr || (sscanf(pgstr, "%u%c", &pgnum, &dummy) != 1) || !pgnum ||
Linus Torvalds1da177e2005-04-16 15:20:36 -07001053 (pgnum > m->nr_priority_groups)) {
1054 DMWARN("invalid PG number supplied to switch_pg_num");
1055 return -EINVAL;
1056 }
1057
1058 spin_lock_irqsave(&m->lock, flags);
1059 list_for_each_entry(pg, &m->priority_groups, list) {
1060 pg->bypassed = 0;
1061 if (--pgnum)
1062 continue;
1063
1064 m->current_pgpath = NULL;
1065 m->current_pg = NULL;
1066 m->next_pg = pg;
1067 }
1068 spin_unlock_irqrestore(&m->lock, flags);
1069
Alasdair G Kergonfe9cf302009-01-06 03:05:13 +00001070 schedule_work(&m->trigger_event);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001071 return 0;
1072}
1073
1074/*
1075 * Set/clear bypassed status of a PG.
1076 * PGs are numbered upwards from 1 in the order they were declared.
1077 */
1078static int bypass_pg_num(struct multipath *m, const char *pgstr, int bypassed)
1079{
1080 struct priority_group *pg;
1081 unsigned pgnum;
Mikulas Patocka31998ef2012-03-28 18:41:26 +01001082 char dummy;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001083
Mikulas Patocka31998ef2012-03-28 18:41:26 +01001084 if (!pgstr || (sscanf(pgstr, "%u%c", &pgnum, &dummy) != 1) || !pgnum ||
Linus Torvalds1da177e2005-04-16 15:20:36 -07001085 (pgnum > m->nr_priority_groups)) {
1086 DMWARN("invalid PG number supplied to bypass_pg");
1087 return -EINVAL;
1088 }
1089
1090 list_for_each_entry(pg, &m->priority_groups, list) {
1091 if (!--pgnum)
1092 break;
1093 }
1094
1095 bypass_pg(m, pg, bypassed);
1096 return 0;
1097}
1098
1099/*
Dave Wysochanskic9e45582007-10-19 22:47:53 +01001100 * Should we retry pg_init immediately?
1101 */
1102static int pg_init_limit_reached(struct multipath *m, struct pgpath *pgpath)
1103{
1104 unsigned long flags;
1105 int limit_reached = 0;
1106
1107 spin_lock_irqsave(&m->lock, flags);
1108
Shiva Krishna Merla954a73d2013-10-30 03:26:38 +00001109 if (m->pg_init_count <= m->pg_init_retries && !m->pg_init_disabled)
Dave Wysochanskic9e45582007-10-19 22:47:53 +01001110 m->pg_init_required = 1;
1111 else
1112 limit_reached = 1;
1113
1114 spin_unlock_irqrestore(&m->lock, flags);
1115
1116 return limit_reached;
1117}
1118
Chandra Seetharaman3ae31f62009-10-21 09:22:46 -07001119static void pg_init_done(void *data, int errors)
Chandra Seetharamancfae5c92008-05-01 14:50:11 -07001120{
Moger, Babu83c0d5d2010-03-06 02:29:45 +00001121 struct pgpath *pgpath = data;
Chandra Seetharamancfae5c92008-05-01 14:50:11 -07001122 struct priority_group *pg = pgpath->pg;
1123 struct multipath *m = pg->m;
1124 unsigned long flags;
Chandra Seetharaman4e2d19e2011-01-13 20:00:01 +00001125 unsigned delay_retry = 0;
Chandra Seetharamancfae5c92008-05-01 14:50:11 -07001126
1127 /* device or driver problems */
1128 switch (errors) {
1129 case SCSI_DH_OK:
1130 break;
1131 case SCSI_DH_NOSYS:
1132 if (!m->hw_handler_name) {
1133 errors = 0;
1134 break;
1135 }
Moger, Babuf7b934c2010-03-06 02:29:49 +00001136 DMERR("Could not failover the device: Handler scsi_dh_%s "
1137 "Error %d.", m->hw_handler_name, errors);
Chandra Seetharamancfae5c92008-05-01 14:50:11 -07001138 /*
1139 * Fail path for now, so we do not ping pong
1140 */
1141 fail_path(pgpath);
1142 break;
1143 case SCSI_DH_DEV_TEMP_BUSY:
1144 /*
1145 * Probably doing something like FW upgrade on the
1146 * controller so try the other pg.
1147 */
1148 bypass_pg(m, pg, 1);
1149 break;
Chandra Seetharamancfae5c92008-05-01 14:50:11 -07001150 case SCSI_DH_RETRY:
Chandra Seetharaman4e2d19e2011-01-13 20:00:01 +00001151 /* Wait before retrying. */
1152 delay_retry = 1;
Chandra Seetharamancfae5c92008-05-01 14:50:11 -07001153 case SCSI_DH_IMM_RETRY:
1154 case SCSI_DH_RES_TEMP_UNAVAIL:
1155 if (pg_init_limit_reached(m, pgpath))
1156 fail_path(pgpath);
1157 errors = 0;
1158 break;
1159 default:
1160 /*
1161 * We probably do not want to fail the path for a device
1162 * error, but this is what the old dm did. In future
1163 * patches we can do more advanced handling.
1164 */
1165 fail_path(pgpath);
1166 }
1167
1168 spin_lock_irqsave(&m->lock, flags);
1169 if (errors) {
Chandra Seetharamane54f77d2009-06-22 10:12:12 +01001170 if (pgpath == m->current_pgpath) {
1171 DMERR("Could not failover device. Error %d.", errors);
1172 m->current_pgpath = NULL;
1173 m->current_pg = NULL;
1174 }
Kiyoshi Uedad0259bf2010-03-06 02:30:02 +00001175 } else if (!m->pg_init_required)
Chandra Seetharamancfae5c92008-05-01 14:50:11 -07001176 pg->bypassed = 0;
Chandra Seetharamancfae5c92008-05-01 14:50:11 -07001177
Kiyoshi Uedad0259bf2010-03-06 02:30:02 +00001178 if (--m->pg_init_in_progress)
1179 /* Activations of other paths are still on going */
1180 goto out;
1181
Hannes Reinecke3e9f1be2014-02-28 15:33:45 +01001182 if (m->pg_init_required) {
1183 m->pg_init_delay_retry = delay_retry;
1184 if (__pg_init_all_paths(m))
1185 goto out;
1186 }
1187 m->queue_io = 0;
Kiyoshi Uedad0259bf2010-03-06 02:30:02 +00001188
Kiyoshi Ueda2bded7b2010-03-06 02:32:13 +00001189 /*
1190 * Wake up any thread waiting to suspend.
1191 */
1192 wake_up(&m->pg_init_wait);
1193
Kiyoshi Uedad0259bf2010-03-06 02:30:02 +00001194out:
Chandra Seetharamancfae5c92008-05-01 14:50:11 -07001195 spin_unlock_irqrestore(&m->lock, flags);
1196}
1197
Chandra Seetharamanbab7cfc2008-05-01 14:50:22 -07001198static void activate_path(struct work_struct *work)
1199{
Chandra Seetharamane54f77d2009-06-22 10:12:12 +01001200 struct pgpath *pgpath =
Chandra Seetharaman4e2d19e2011-01-13 20:00:01 +00001201 container_of(work, struct pgpath, activate_path.work);
Chandra Seetharamanbab7cfc2008-05-01 14:50:22 -07001202
Chandra Seetharaman3ae31f62009-10-21 09:22:46 -07001203 scsi_dh_activate(bdev_get_queue(pgpath->path.dev->bdev),
Moger, Babu83c0d5d2010-03-06 02:29:45 +00001204 pg_init_done, pgpath);
Chandra Seetharamanbab7cfc2008-05-01 14:50:22 -07001205}
1206
Hannes Reinecke7e782af2013-07-01 15:16:26 +02001207static int noretry_error(int error)
1208{
1209 switch (error) {
1210 case -EOPNOTSUPP:
1211 case -EREMOTEIO:
1212 case -EILSEQ:
1213 case -ENODATA:
Jun'ichi Nomuracc9d3c32013-09-13 14:54:30 +09001214 case -ENOSPC:
Hannes Reinecke7e782af2013-07-01 15:16:26 +02001215 return 1;
1216 }
1217
1218 /* Anything else could be a path failure, so should be retried */
1219 return 0;
1220}
1221
Linus Torvalds1da177e2005-04-16 15:20:36 -07001222/*
1223 * end_io handling
1224 */
Kiyoshi Uedaf40c67f2009-06-22 10:12:37 +01001225static int do_end_io(struct multipath *m, struct request *clone,
Alasdair G Kergon028867a2007-07-12 17:26:32 +01001226 int error, struct dm_mpath_io *mpio)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001227{
Kiyoshi Uedaf40c67f2009-06-22 10:12:37 +01001228 /*
1229 * We don't queue any clone request inside the multipath target
1230 * during end I/O handling, since those clone requests don't have
1231 * bio clones. If we queue them inside the multipath target,
1232 * we need to make bio clones, that requires memory allocation.
1233 * (See drivers/md/dm.c:end_clone_bio() about why the clone requests
1234 * don't have bio clones.)
1235 * Instead of queueing the clone request here, we queue the original
1236 * request into dm core, which will remake a clone request and
1237 * clone bios for it and resubmit it later.
1238 */
1239 int r = DM_ENDIO_REQUEUE;
Stefan Bader640eb3b2005-11-21 21:32:35 -08001240 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001241
Kiyoshi Uedaf40c67f2009-06-22 10:12:37 +01001242 if (!error && !clone->errors)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001243 return 0; /* I/O complete */
1244
Mike Snitzerf84cb8a2013-09-19 12:13:58 -04001245 if (noretry_error(error)) {
1246 if ((clone->cmd_flags & REQ_WRITE_SAME) &&
1247 !clone->q->limits.max_write_same_sectors) {
1248 struct queue_limits *limits;
1249
1250 /* device doesn't really support WRITE SAME, disable it */
1251 limits = dm_get_queue_limits(dm_table_get_md(m->ti->table));
1252 limits->max_write_same_sectors = 0;
1253 }
Mike Snitzer959eb4e2010-08-12 04:14:32 +01001254 return error;
Mike Snitzerf84cb8a2013-09-19 12:13:58 -04001255 }
Mike Snitzer959eb4e2010-08-12 04:14:32 +01001256
Chandra Seetharamancfae5c92008-05-01 14:50:11 -07001257 if (mpio->pgpath)
1258 fail_path(mpio->pgpath);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001259
Stefan Bader640eb3b2005-11-21 21:32:35 -08001260 spin_lock_irqsave(&m->lock, flags);
Hannes Reinecke751b2a72011-01-18 10:13:12 +01001261 if (!m->nr_valid_paths) {
1262 if (!m->queue_if_no_path) {
1263 if (!__must_push_back(m))
1264 r = -EIO;
1265 } else {
1266 if (error == -EBADE)
1267 r = error;
1268 }
1269 }
Stefan Bader640eb3b2005-11-21 21:32:35 -08001270 spin_unlock_irqrestore(&m->lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001271
Kiyoshi Uedaf40c67f2009-06-22 10:12:37 +01001272 return r;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001273}
1274
Kiyoshi Uedaf40c67f2009-06-22 10:12:37 +01001275static int multipath_end_io(struct dm_target *ti, struct request *clone,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001276 int error, union map_info *map_context)
1277{
Alasdair G Kergon028867a2007-07-12 17:26:32 +01001278 struct multipath *m = ti->private;
1279 struct dm_mpath_io *mpio = map_context->ptr;
Wei Yongjuna71a2612012-10-12 16:59:42 +01001280 struct pgpath *pgpath;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001281 struct path_selector *ps;
1282 int r;
1283
Jun'ichi Nomura466891f2012-03-28 18:41:25 +01001284 BUG_ON(!mpio);
1285
Kiyoshi Uedaf40c67f2009-06-22 10:12:37 +01001286 r = do_end_io(m, clone, error, mpio);
Wei Yongjuna71a2612012-10-12 16:59:42 +01001287 pgpath = mpio->pgpath;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001288 if (pgpath) {
1289 ps = &pgpath->pg->ps;
1290 if (ps->type->end_io)
Kiyoshi Ueda02ab8232009-06-22 10:12:27 +01001291 ps->type->end_io(ps, &pgpath->path, mpio->nr_bytes);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001292 }
Jun'ichi Nomura466891f2012-03-28 18:41:25 +01001293 clear_mapinfo(m, map_context);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001294
1295 return r;
1296}
1297
1298/*
1299 * Suspend can't complete until all the I/O is processed so if
Alasdair G Kergon436d4102005-07-12 15:53:03 -07001300 * the last path fails we must error any remaining I/O.
1301 * Note that if the freeze_bdev fails while suspending, the
1302 * queue_if_no_path state is lost - userspace should reset it.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001303 */
1304static void multipath_presuspend(struct dm_target *ti)
1305{
1306 struct multipath *m = (struct multipath *) ti->private;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001307
Alasdair G Kergon485ef692005-09-27 21:45:45 -07001308 queue_if_no_path(m, 0, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001309}
1310
Kiyoshi Ueda6df400a2009-12-10 23:52:19 +00001311static void multipath_postsuspend(struct dm_target *ti)
1312{
Mike Anderson6380f262009-12-10 23:52:21 +00001313 struct multipath *m = ti->private;
1314
1315 mutex_lock(&m->work_mutex);
Kiyoshi Ueda2bded7b2010-03-06 02:32:13 +00001316 flush_multipath_work(m);
Mike Anderson6380f262009-12-10 23:52:21 +00001317 mutex_unlock(&m->work_mutex);
Kiyoshi Ueda6df400a2009-12-10 23:52:19 +00001318}
1319
Alasdair G Kergon436d4102005-07-12 15:53:03 -07001320/*
1321 * Restore the queue_if_no_path setting.
1322 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001323static void multipath_resume(struct dm_target *ti)
1324{
1325 struct multipath *m = (struct multipath *) ti->private;
1326 unsigned long flags;
1327
1328 spin_lock_irqsave(&m->lock, flags);
Alasdair G Kergon436d4102005-07-12 15:53:03 -07001329 m->queue_if_no_path = m->saved_queue_if_no_path;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001330 spin_unlock_irqrestore(&m->lock, flags);
1331}
1332
1333/*
1334 * Info output has the following format:
1335 * num_multipath_feature_args [multipath_feature_args]*
1336 * num_handler_status_args [handler_status_args]*
1337 * num_groups init_group_number
1338 * [A|D|E num_ps_status_args [ps_status_args]*
1339 * num_paths num_selector_args
1340 * [path_dev A|F fail_count [selector_args]* ]+ ]+
1341 *
1342 * Table output has the following format (identical to the constructor string):
1343 * num_feature_args [features_args]*
1344 * num_handler_args hw_handler [hw_handler_args]*
1345 * num_groups init_group_number
1346 * [priority selector-name num_ps_args [ps_args]*
1347 * num_paths num_selector_args [path_dev [selector_args]* ]+ ]+
1348 */
Mikulas Patockafd7c0922013-03-01 22:45:44 +00001349static void multipath_status(struct dm_target *ti, status_type_t type,
1350 unsigned status_flags, char *result, unsigned maxlen)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001351{
1352 int sz = 0;
1353 unsigned long flags;
1354 struct multipath *m = (struct multipath *) ti->private;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001355 struct priority_group *pg;
1356 struct pgpath *p;
1357 unsigned pg_num;
1358 char state;
1359
1360 spin_lock_irqsave(&m->lock, flags);
1361
1362 /* Features */
1363 if (type == STATUSTYPE_INFO)
Hannes Reineckee8099172014-02-28 15:33:44 +01001364 DMEMIT("2 %u %u ", m->queue_io, m->pg_init_count);
Dave Wysochanskic9e45582007-10-19 22:47:53 +01001365 else {
1366 DMEMIT("%u ", m->queue_if_no_path +
Chandra Seetharaman4e2d19e2011-01-13 20:00:01 +00001367 (m->pg_init_retries > 0) * 2 +
Mike Snitzera58a9352012-07-27 15:08:04 +01001368 (m->pg_init_delay_msecs != DM_PG_INIT_DELAY_DEFAULT) * 2 +
1369 m->retain_attached_hw_handler);
Dave Wysochanskic9e45582007-10-19 22:47:53 +01001370 if (m->queue_if_no_path)
1371 DMEMIT("queue_if_no_path ");
1372 if (m->pg_init_retries)
1373 DMEMIT("pg_init_retries %u ", m->pg_init_retries);
Chandra Seetharaman4e2d19e2011-01-13 20:00:01 +00001374 if (m->pg_init_delay_msecs != DM_PG_INIT_DELAY_DEFAULT)
1375 DMEMIT("pg_init_delay_msecs %u ", m->pg_init_delay_msecs);
Mike Snitzera58a9352012-07-27 15:08:04 +01001376 if (m->retain_attached_hw_handler)
1377 DMEMIT("retain_attached_hw_handler ");
Dave Wysochanskic9e45582007-10-19 22:47:53 +01001378 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001379
Chandra Seetharamancfae5c92008-05-01 14:50:11 -07001380 if (!m->hw_handler_name || type == STATUSTYPE_INFO)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001381 DMEMIT("0 ");
1382 else
Chandra Seetharamancfae5c92008-05-01 14:50:11 -07001383 DMEMIT("1 %s ", m->hw_handler_name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001384
1385 DMEMIT("%u ", m->nr_priority_groups);
1386
1387 if (m->next_pg)
1388 pg_num = m->next_pg->pg_num;
1389 else if (m->current_pg)
1390 pg_num = m->current_pg->pg_num;
1391 else
Mike Snitzera490a072011-03-24 13:54:33 +00001392 pg_num = (m->nr_priority_groups ? 1 : 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001393
1394 DMEMIT("%u ", pg_num);
1395
1396 switch (type) {
1397 case STATUSTYPE_INFO:
1398 list_for_each_entry(pg, &m->priority_groups, list) {
1399 if (pg->bypassed)
1400 state = 'D'; /* Disabled */
1401 else if (pg == m->current_pg)
1402 state = 'A'; /* Currently Active */
1403 else
1404 state = 'E'; /* Enabled */
1405
1406 DMEMIT("%c ", state);
1407
1408 if (pg->ps.type->status)
1409 sz += pg->ps.type->status(&pg->ps, NULL, type,
1410 result + sz,
1411 maxlen - sz);
1412 else
1413 DMEMIT("0 ");
1414
1415 DMEMIT("%u %u ", pg->nr_pgpaths,
1416 pg->ps.type->info_args);
1417
1418 list_for_each_entry(p, &pg->pgpaths, list) {
1419 DMEMIT("%s %s %u ", p->path.dev->name,
Kiyoshi Ueda66800732008-10-10 13:36:58 +01001420 p->is_active ? "A" : "F",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001421 p->fail_count);
1422 if (pg->ps.type->status)
1423 sz += pg->ps.type->status(&pg->ps,
1424 &p->path, type, result + sz,
1425 maxlen - sz);
1426 }
1427 }
1428 break;
1429
1430 case STATUSTYPE_TABLE:
1431 list_for_each_entry(pg, &m->priority_groups, list) {
1432 DMEMIT("%s ", pg->ps.type->name);
1433
1434 if (pg->ps.type->status)
1435 sz += pg->ps.type->status(&pg->ps, NULL, type,
1436 result + sz,
1437 maxlen - sz);
1438 else
1439 DMEMIT("0 ");
1440
1441 DMEMIT("%u %u ", pg->nr_pgpaths,
1442 pg->ps.type->table_args);
1443
1444 list_for_each_entry(p, &pg->pgpaths, list) {
1445 DMEMIT("%s ", p->path.dev->name);
1446 if (pg->ps.type->status)
1447 sz += pg->ps.type->status(&pg->ps,
1448 &p->path, type, result + sz,
1449 maxlen - sz);
1450 }
1451 }
1452 break;
1453 }
1454
1455 spin_unlock_irqrestore(&m->lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001456}
1457
1458static int multipath_message(struct dm_target *ti, unsigned argc, char **argv)
1459{
Mike Anderson6380f262009-12-10 23:52:21 +00001460 int r = -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001461 struct dm_dev *dev;
1462 struct multipath *m = (struct multipath *) ti->private;
1463 action_fn action;
1464
Mike Anderson6380f262009-12-10 23:52:21 +00001465 mutex_lock(&m->work_mutex);
1466
Kiyoshi Uedac2f3d242009-12-10 23:52:27 +00001467 if (dm_suspended(ti)) {
1468 r = -EBUSY;
1469 goto out;
1470 }
1471
Linus Torvalds1da177e2005-04-16 15:20:36 -07001472 if (argc == 1) {
Mike Snitzer498f0102011-08-02 12:32:04 +01001473 if (!strcasecmp(argv[0], "queue_if_no_path")) {
Mike Anderson6380f262009-12-10 23:52:21 +00001474 r = queue_if_no_path(m, 1, 0);
1475 goto out;
Mike Snitzer498f0102011-08-02 12:32:04 +01001476 } else if (!strcasecmp(argv[0], "fail_if_no_path")) {
Mike Anderson6380f262009-12-10 23:52:21 +00001477 r = queue_if_no_path(m, 0, 0);
1478 goto out;
1479 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001480 }
1481
Mike Anderson6380f262009-12-10 23:52:21 +00001482 if (argc != 2) {
1483 DMWARN("Unrecognised multipath message received.");
1484 goto out;
1485 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001486
Mike Snitzer498f0102011-08-02 12:32:04 +01001487 if (!strcasecmp(argv[0], "disable_group")) {
Mike Anderson6380f262009-12-10 23:52:21 +00001488 r = bypass_pg_num(m, argv[1], 1);
1489 goto out;
Mike Snitzer498f0102011-08-02 12:32:04 +01001490 } else if (!strcasecmp(argv[0], "enable_group")) {
Mike Anderson6380f262009-12-10 23:52:21 +00001491 r = bypass_pg_num(m, argv[1], 0);
1492 goto out;
Mike Snitzer498f0102011-08-02 12:32:04 +01001493 } else if (!strcasecmp(argv[0], "switch_group")) {
Mike Anderson6380f262009-12-10 23:52:21 +00001494 r = switch_pg_num(m, argv[1]);
1495 goto out;
Mike Snitzer498f0102011-08-02 12:32:04 +01001496 } else if (!strcasecmp(argv[0], "reinstate_path"))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001497 action = reinstate_path;
Mike Snitzer498f0102011-08-02 12:32:04 +01001498 else if (!strcasecmp(argv[0], "fail_path"))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001499 action = fail_path;
Mike Anderson6380f262009-12-10 23:52:21 +00001500 else {
1501 DMWARN("Unrecognised multipath message received.");
1502 goto out;
1503 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001504
Nikanth Karthikesan8215d6e2010-03-06 02:32:27 +00001505 r = dm_get_device(ti, argv[1], dm_table_get_mode(ti->table), &dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001506 if (r) {
Alasdair G Kergon72d94862006-06-26 00:27:35 -07001507 DMWARN("message: error getting device %s",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001508 argv[1]);
Mike Anderson6380f262009-12-10 23:52:21 +00001509 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001510 }
1511
1512 r = action_dev(m, dev, action);
1513
1514 dm_put_device(ti, dev);
1515
Mike Anderson6380f262009-12-10 23:52:21 +00001516out:
1517 mutex_unlock(&m->work_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001518 return r;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001519}
1520
Al Viro647b3d02007-08-28 22:15:59 -04001521static int multipath_ioctl(struct dm_target *ti, unsigned int cmd,
Milan Broz9af4aa32006-10-03 01:15:20 -07001522 unsigned long arg)
1523{
Mikulas Patocka35991652012-06-03 00:29:58 +01001524 struct multipath *m = ti->private;
Mike Snitzer7ba10aa2012-09-26 23:45:41 +01001525 struct pgpath *pgpath;
Mikulas Patocka35991652012-06-03 00:29:58 +01001526 struct block_device *bdev;
1527 fmode_t mode;
Milan Broz9af4aa32006-10-03 01:15:20 -07001528 unsigned long flags;
Mikulas Patocka35991652012-06-03 00:29:58 +01001529 int r;
1530
Mikulas Patocka35991652012-06-03 00:29:58 +01001531 bdev = NULL;
1532 mode = 0;
1533 r = 0;
Milan Broz9af4aa32006-10-03 01:15:20 -07001534
1535 spin_lock_irqsave(&m->lock, flags);
1536
1537 if (!m->current_pgpath)
Kiyoshi Ueda02ab8232009-06-22 10:12:27 +01001538 __choose_pgpath(m, 0);
Milan Broz9af4aa32006-10-03 01:15:20 -07001539
Mike Snitzer7ba10aa2012-09-26 23:45:41 +01001540 pgpath = m->current_pgpath;
1541
1542 if (pgpath) {
1543 bdev = pgpath->path.dev->bdev;
1544 mode = pgpath->path.dev->mode;
Milan Broze90dae12006-10-03 01:15:22 -07001545 }
Milan Broz9af4aa32006-10-03 01:15:20 -07001546
Mike Snitzer7ba10aa2012-09-26 23:45:41 +01001547 if ((pgpath && m->queue_io) || (!pgpath && m->queue_if_no_path))
Hannes Reinecke6c182cd2013-07-10 23:41:15 +01001548 r = -ENOTCONN;
Milan Broz9af4aa32006-10-03 01:15:20 -07001549 else if (!bdev)
1550 r = -EIO;
1551
1552 spin_unlock_irqrestore(&m->lock, flags);
1553
Paolo Bonziniec8013b2012-01-12 16:01:29 +01001554 /*
1555 * Only pass ioctls through if the device sizes match exactly.
1556 */
Hannes Reineckea1989b32014-02-26 10:07:04 +01001557 if (!bdev || ti->len != i_size_read(bdev->bd_inode) >> SECTOR_SHIFT) {
1558 int err = scsi_verify_blk_ioctl(NULL, cmd);
1559 if (err)
1560 r = err;
1561 }
Paolo Bonziniec8013b2012-01-12 16:01:29 +01001562
Hannes Reinecke3e9f1be2014-02-28 15:33:45 +01001563 if (r == -ENOTCONN && !fatal_signal_pending(current)) {
1564 spin_lock_irqsave(&m->lock, flags);
1565 if (!m->current_pg) {
1566 /* Path status changed, redo selection */
1567 __choose_pgpath(m, 0);
1568 }
1569 if (m->pg_init_required)
1570 __pg_init_all_paths(m);
1571 spin_unlock_irqrestore(&m->lock, flags);
1572 dm_table_run_md_queue_async(m->ti->table);
1573 }
Mikulas Patocka35991652012-06-03 00:29:58 +01001574
Al Viro633a08b2007-08-29 20:34:12 -04001575 return r ? : __blkdev_driver_ioctl(bdev, mode, cmd, arg);
Milan Broz9af4aa32006-10-03 01:15:20 -07001576}
1577
Mike Snitzeraf4874e2009-06-22 10:12:33 +01001578static int multipath_iterate_devices(struct dm_target *ti,
1579 iterate_devices_callout_fn fn, void *data)
1580{
1581 struct multipath *m = ti->private;
1582 struct priority_group *pg;
1583 struct pgpath *p;
1584 int ret = 0;
1585
1586 list_for_each_entry(pg, &m->priority_groups, list) {
1587 list_for_each_entry(p, &pg->pgpaths, list) {
Mike Snitzer5dea2712009-07-23 20:30:42 +01001588 ret = fn(ti, p->path.dev, ti->begin, ti->len, data);
Mike Snitzeraf4874e2009-06-22 10:12:33 +01001589 if (ret)
1590 goto out;
1591 }
1592 }
1593
1594out:
1595 return ret;
1596}
1597
Kiyoshi Uedaf40c67f2009-06-22 10:12:37 +01001598static int __pgpath_busy(struct pgpath *pgpath)
1599{
1600 struct request_queue *q = bdev_get_queue(pgpath->path.dev->bdev);
1601
1602 return dm_underlying_device_busy(q);
1603}
1604
1605/*
1606 * We return "busy", only when we can map I/Os but underlying devices
1607 * are busy (so even if we map I/Os now, the I/Os will wait on
1608 * the underlying queue).
1609 * In other words, if we want to kill I/Os or queue them inside us
1610 * due to map unavailability, we don't return "busy". Otherwise,
1611 * dm core won't give us the I/Os and we can't do what we want.
1612 */
1613static int multipath_busy(struct dm_target *ti)
1614{
1615 int busy = 0, has_active = 0;
1616 struct multipath *m = ti->private;
1617 struct priority_group *pg;
1618 struct pgpath *pgpath;
1619 unsigned long flags;
1620
1621 spin_lock_irqsave(&m->lock, flags);
1622
Hannes Reineckeb63349a2013-10-01 11:49:56 +02001623 /* pg_init in progress, requeue until done */
Hannes Reineckee8099172014-02-28 15:33:44 +01001624 if (!pg_ready(m)) {
Hannes Reineckeb63349a2013-10-01 11:49:56 +02001625 busy = 1;
1626 goto out;
1627 }
Kiyoshi Uedaf40c67f2009-06-22 10:12:37 +01001628 /* Guess which priority_group will be used at next mapping time */
1629 if (unlikely(!m->current_pgpath && m->next_pg))
1630 pg = m->next_pg;
1631 else if (likely(m->current_pg))
1632 pg = m->current_pg;
1633 else
1634 /*
1635 * We don't know which pg will be used at next mapping time.
1636 * We don't call __choose_pgpath() here to avoid to trigger
1637 * pg_init just by busy checking.
1638 * So we don't know whether underlying devices we will be using
1639 * at next mapping time are busy or not. Just try mapping.
1640 */
1641 goto out;
1642
1643 /*
1644 * If there is one non-busy active path at least, the path selector
1645 * will be able to select it. So we consider such a pg as not busy.
1646 */
1647 busy = 1;
1648 list_for_each_entry(pgpath, &pg->pgpaths, list)
1649 if (pgpath->is_active) {
1650 has_active = 1;
1651
1652 if (!__pgpath_busy(pgpath)) {
1653 busy = 0;
1654 break;
1655 }
1656 }
1657
1658 if (!has_active)
1659 /*
1660 * No active path in this pg, so this pg won't be used and
1661 * the current_pg will be changed at next mapping time.
1662 * We need to try mapping to determine it.
1663 */
1664 busy = 0;
1665
1666out:
1667 spin_unlock_irqrestore(&m->lock, flags);
1668
1669 return busy;
1670}
1671
Linus Torvalds1da177e2005-04-16 15:20:36 -07001672/*-----------------------------------------------------------------
1673 * Module setup
1674 *---------------------------------------------------------------*/
1675static struct target_type multipath_target = {
1676 .name = "multipath",
Hannes Reineckee8099172014-02-28 15:33:44 +01001677 .version = {1, 7, 0},
Linus Torvalds1da177e2005-04-16 15:20:36 -07001678 .module = THIS_MODULE,
1679 .ctr = multipath_ctr,
1680 .dtr = multipath_dtr,
Kiyoshi Uedaf40c67f2009-06-22 10:12:37 +01001681 .map_rq = multipath_map,
1682 .rq_end_io = multipath_end_io,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001683 .presuspend = multipath_presuspend,
Kiyoshi Ueda6df400a2009-12-10 23:52:19 +00001684 .postsuspend = multipath_postsuspend,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001685 .resume = multipath_resume,
1686 .status = multipath_status,
1687 .message = multipath_message,
Milan Broz9af4aa32006-10-03 01:15:20 -07001688 .ioctl = multipath_ioctl,
Mike Snitzeraf4874e2009-06-22 10:12:33 +01001689 .iterate_devices = multipath_iterate_devices,
Kiyoshi Uedaf40c67f2009-06-22 10:12:37 +01001690 .busy = multipath_busy,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001691};
1692
1693static int __init dm_multipath_init(void)
1694{
1695 int r;
1696
1697 /* allocate a slab for the dm_ios */
Alasdair G Kergon028867a2007-07-12 17:26:32 +01001698 _mpio_cache = KMEM_CACHE(dm_mpath_io, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001699 if (!_mpio_cache)
1700 return -ENOMEM;
1701
1702 r = dm_register_target(&multipath_target);
1703 if (r < 0) {
Alasdair G Kergon0cd33122007-07-12 17:27:01 +01001704 DMERR("register failed %d", r);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001705 kmem_cache_destroy(_mpio_cache);
1706 return -EINVAL;
1707 }
1708
Tejun Heo4d4d66a2011-01-13 19:59:57 +00001709 kmultipathd = alloc_workqueue("kmpathd", WQ_MEM_RECLAIM, 0);
Alasdair G Kergonc5573082005-05-05 16:16:07 -07001710 if (!kmultipathd) {
Alasdair G Kergon0cd33122007-07-12 17:27:01 +01001711 DMERR("failed to create workqueue kmpathd");
Alasdair G Kergonc5573082005-05-05 16:16:07 -07001712 dm_unregister_target(&multipath_target);
1713 kmem_cache_destroy(_mpio_cache);
1714 return -ENOMEM;
1715 }
1716
Chandra Seetharamanbab7cfc2008-05-01 14:50:22 -07001717 /*
1718 * A separate workqueue is used to handle the device handlers
1719 * to avoid overloading existing workqueue. Overloading the
1720 * old workqueue would also create a bottleneck in the
1721 * path of the storage hardware device activation.
1722 */
Tejun Heo4d4d66a2011-01-13 19:59:57 +00001723 kmpath_handlerd = alloc_ordered_workqueue("kmpath_handlerd",
1724 WQ_MEM_RECLAIM);
Chandra Seetharamanbab7cfc2008-05-01 14:50:22 -07001725 if (!kmpath_handlerd) {
1726 DMERR("failed to create workqueue kmpath_handlerd");
1727 destroy_workqueue(kmultipathd);
1728 dm_unregister_target(&multipath_target);
1729 kmem_cache_destroy(_mpio_cache);
1730 return -ENOMEM;
1731 }
1732
Alasdair G Kergon72d94862006-06-26 00:27:35 -07001733 DMINFO("version %u.%u.%u loaded",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001734 multipath_target.version[0], multipath_target.version[1],
1735 multipath_target.version[2]);
1736
1737 return r;
1738}
1739
1740static void __exit dm_multipath_exit(void)
1741{
Chandra Seetharamanbab7cfc2008-05-01 14:50:22 -07001742 destroy_workqueue(kmpath_handlerd);
Alasdair G Kergonc5573082005-05-05 16:16:07 -07001743 destroy_workqueue(kmultipathd);
1744
Mikulas Patocka10d3bd02009-01-06 03:04:58 +00001745 dm_unregister_target(&multipath_target);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001746 kmem_cache_destroy(_mpio_cache);
1747}
1748
Linus Torvalds1da177e2005-04-16 15:20:36 -07001749module_init(dm_multipath_init);
1750module_exit(dm_multipath_exit);
1751
1752MODULE_DESCRIPTION(DM_NAME " multipath target");
1753MODULE_AUTHOR("Sistina Software <dm-devel@redhat.com>");
1754MODULE_LICENSE("GPL");