blob: 1c6a3f8da24d9a8e40716f018f5a6bdacb61eb99 [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{
Kiyoshi Uedad2a7ad22006-12-08 02:41:06 -0800381 int r = DM_MAPIO_REMAPPED;
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;
Jun'ichi Nomura466891f2012-03-28 18:41:25 +0100386 struct dm_mpath_io *mpio = map_context->ptr;
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)) {
399 bdev = pgpath->path.dev->bdev;
400 clone->q = bdev_get_queue(bdev);
401 clone->rq_disk = bdev->bd_disk;
402 mpio->pgpath = pgpath;
403 mpio->nr_bytes = nr_bytes;
404 if (pgpath->pg->ps.type->start_io)
405 pgpath->pg->ps.type->start_io(&pgpath->pg->ps,
406 &pgpath->path,
407 nr_bytes);
408 } else {
409 __pg_init_all_paths(m);
410 r = DM_MAPIO_REQUEUE;
411 }
412 } else {
413 /* No path */
414 if (__must_push_back(m))
415 r = DM_MAPIO_REQUEUE;
416 else
417 r = -EIO; /* Failed */
418 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700419
420 spin_unlock_irqrestore(&m->lock, flags);
421
422 return r;
423}
424
425/*
426 * If we run out of usable paths, should we queue I/O or error it?
427 */
Alasdair G Kergon485ef692005-09-27 21:45:45 -0700428static int queue_if_no_path(struct multipath *m, unsigned queue_if_no_path,
429 unsigned save_old_value)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700430{
431 unsigned long flags;
432
433 spin_lock_irqsave(&m->lock, flags);
434
Alasdair G Kergon485ef692005-09-27 21:45:45 -0700435 if (save_old_value)
436 m->saved_queue_if_no_path = m->queue_if_no_path;
437 else
438 m->saved_queue_if_no_path = queue_if_no_path;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700439 m->queue_if_no_path = queue_if_no_path;
Hannes Reineckee8099172014-02-28 15:33:44 +0100440 if (!m->queue_if_no_path)
Hannes Reinecke3e9f1be2014-02-28 15:33:45 +0100441 dm_table_run_md_queue_async(m->ti->table);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700442
443 spin_unlock_irqrestore(&m->lock, flags);
444
445 return 0;
446}
447
Linus Torvalds1da177e2005-04-16 15:20:36 -0700448/*
449 * An event is triggered whenever a path is taken out of use.
450 * Includes path failure and PG bypass.
451 */
David Howellsc4028952006-11-22 14:57:56 +0000452static void trigger_event(struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700453{
David Howellsc4028952006-11-22 14:57:56 +0000454 struct multipath *m =
455 container_of(work, struct multipath, trigger_event);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700456
457 dm_table_event(m->ti->table);
458}
459
460/*-----------------------------------------------------------------
461 * Constructor/argument parsing:
462 * <#multipath feature args> [<arg>]*
463 * <#hw_handler args> [hw_handler [<arg>]*]
464 * <#priority groups>
465 * <initial priority group>
466 * [<selector> <#selector args> [<arg>]*
467 * <#paths> <#per-path selector args>
468 * [<path> [<arg>]* ]+ ]+
469 *---------------------------------------------------------------*/
Mike Snitzer498f0102011-08-02 12:32:04 +0100470static int parse_path_selector(struct dm_arg_set *as, struct priority_group *pg,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700471 struct dm_target *ti)
472{
473 int r;
474 struct path_selector_type *pst;
475 unsigned ps_argc;
476
Mike Snitzer498f0102011-08-02 12:32:04 +0100477 static struct dm_arg _args[] = {
Alasdair G Kergon72d94862006-06-26 00:27:35 -0700478 {0, 1024, "invalid number of path selector args"},
Linus Torvalds1da177e2005-04-16 15:20:36 -0700479 };
480
Mike Snitzer498f0102011-08-02 12:32:04 +0100481 pst = dm_get_path_selector(dm_shift_arg(as));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700482 if (!pst) {
Alasdair G Kergon72d94862006-06-26 00:27:35 -0700483 ti->error = "unknown path selector type";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700484 return -EINVAL;
485 }
486
Mike Snitzer498f0102011-08-02 12:32:04 +0100487 r = dm_read_arg_group(_args, as, &ps_argc, &ti->error);
Mikulas Patocka371b2e32008-07-21 12:00:24 +0100488 if (r) {
489 dm_put_path_selector(pst);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700490 return -EINVAL;
Mikulas Patocka371b2e32008-07-21 12:00:24 +0100491 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700492
493 r = pst->create(&pg->ps, ps_argc, as->argv);
494 if (r) {
495 dm_put_path_selector(pst);
Alasdair G Kergon72d94862006-06-26 00:27:35 -0700496 ti->error = "path selector constructor failed";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700497 return r;
498 }
499
500 pg->ps.type = pst;
Mike Snitzer498f0102011-08-02 12:32:04 +0100501 dm_consume_args(as, ps_argc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700502
503 return 0;
504}
505
Mike Snitzer498f0102011-08-02 12:32:04 +0100506static struct pgpath *parse_path(struct dm_arg_set *as, struct path_selector *ps,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700507 struct dm_target *ti)
508{
509 int r;
510 struct pgpath *p;
Hannes Reineckeae11b1b2008-07-17 17:49:02 -0700511 struct multipath *m = ti->private;
Mike Snitzera58a9352012-07-27 15:08:04 +0100512 struct request_queue *q = NULL;
513 const char *attached_handler_name;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700514
515 /* we need at least a path arg */
516 if (as->argc < 1) {
Alasdair G Kergon72d94862006-06-26 00:27:35 -0700517 ti->error = "no device given";
Benjamin Marzinski01460f32008-10-10 13:36:57 +0100518 return ERR_PTR(-EINVAL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700519 }
520
521 p = alloc_pgpath();
522 if (!p)
Benjamin Marzinski01460f32008-10-10 13:36:57 +0100523 return ERR_PTR(-ENOMEM);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700524
Mike Snitzer498f0102011-08-02 12:32:04 +0100525 r = dm_get_device(ti, dm_shift_arg(as), dm_table_get_mode(ti->table),
Nikanth Karthikesan8215d6e2010-03-06 02:32:27 +0000526 &p->path.dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700527 if (r) {
Alasdair G Kergon72d94862006-06-26 00:27:35 -0700528 ti->error = "error getting device";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700529 goto bad;
530 }
531
Mike Snitzera58a9352012-07-27 15:08:04 +0100532 if (m->retain_attached_hw_handler || m->hw_handler_name)
533 q = bdev_get_queue(p->path.dev->bdev);
Hannes Reineckea0cf7ea2009-06-22 10:12:11 +0100534
Mike Snitzera58a9352012-07-27 15:08:04 +0100535 if (m->retain_attached_hw_handler) {
536 attached_handler_name = scsi_dh_attached_handler_name(q, GFP_KERNEL);
537 if (attached_handler_name) {
538 /*
539 * Reset hw_handler_name to match the attached handler
540 * and clear any hw_handler_params associated with the
541 * ignored handler.
542 *
543 * NB. This modifies the table line to show the actual
544 * handler instead of the original table passed in.
545 */
546 kfree(m->hw_handler_name);
547 m->hw_handler_name = attached_handler_name;
548
549 kfree(m->hw_handler_params);
550 m->hw_handler_params = NULL;
551 }
552 }
553
554 if (m->hw_handler_name) {
555 /*
556 * Increments scsi_dh reference, even when using an
557 * already-attached handler.
558 */
Hannes Reineckea0cf7ea2009-06-22 10:12:11 +0100559 r = scsi_dh_attach(q, m->hw_handler_name);
560 if (r == -EBUSY) {
561 /*
Mike Snitzera58a9352012-07-27 15:08:04 +0100562 * Already attached to different hw_handler:
Hannes Reineckea0cf7ea2009-06-22 10:12:11 +0100563 * try to reattach with correct one.
564 */
565 scsi_dh_detach(q);
566 r = scsi_dh_attach(q, m->hw_handler_name);
567 }
568
Hannes Reineckeae11b1b2008-07-17 17:49:02 -0700569 if (r < 0) {
Hannes Reineckea0cf7ea2009-06-22 10:12:11 +0100570 ti->error = "error attaching hardware handler";
Hannes Reineckeae11b1b2008-07-17 17:49:02 -0700571 dm_put_device(ti, p->path.dev);
572 goto bad;
573 }
Chandra Seetharaman2bfd2e12009-08-03 12:42:45 -0700574
575 if (m->hw_handler_params) {
576 r = scsi_dh_set_params(q, m->hw_handler_params);
577 if (r < 0) {
578 ti->error = "unable to set hardware "
579 "handler parameters";
580 scsi_dh_detach(q);
581 dm_put_device(ti, p->path.dev);
582 goto bad;
583 }
584 }
Hannes Reineckeae11b1b2008-07-17 17:49:02 -0700585 }
586
Linus Torvalds1da177e2005-04-16 15:20:36 -0700587 r = ps->type->add_path(ps, &p->path, as->argc, as->argv, &ti->error);
588 if (r) {
589 dm_put_device(ti, p->path.dev);
590 goto bad;
591 }
592
593 return p;
594
595 bad:
596 free_pgpath(p);
Benjamin Marzinski01460f32008-10-10 13:36:57 +0100597 return ERR_PTR(r);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700598}
599
Mike Snitzer498f0102011-08-02 12:32:04 +0100600static struct priority_group *parse_priority_group(struct dm_arg_set *as,
Micha³ Miros³aw28f16c22006-10-03 01:15:33 -0700601 struct multipath *m)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700602{
Mike Snitzer498f0102011-08-02 12:32:04 +0100603 static struct dm_arg _args[] = {
Alasdair G Kergon72d94862006-06-26 00:27:35 -0700604 {1, 1024, "invalid number of paths"},
605 {0, 1024, "invalid number of selector args"}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700606 };
607
608 int r;
Mike Snitzer498f0102011-08-02 12:32:04 +0100609 unsigned i, nr_selector_args, nr_args;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700610 struct priority_group *pg;
Micha³ Miros³aw28f16c22006-10-03 01:15:33 -0700611 struct dm_target *ti = m->ti;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700612
613 if (as->argc < 2) {
614 as->argc = 0;
Benjamin Marzinski01460f32008-10-10 13:36:57 +0100615 ti->error = "not enough priority group arguments";
616 return ERR_PTR(-EINVAL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700617 }
618
619 pg = alloc_priority_group();
620 if (!pg) {
Alasdair G Kergon72d94862006-06-26 00:27:35 -0700621 ti->error = "couldn't allocate priority group";
Benjamin Marzinski01460f32008-10-10 13:36:57 +0100622 return ERR_PTR(-ENOMEM);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700623 }
624 pg->m = m;
625
626 r = parse_path_selector(as, pg, ti);
627 if (r)
628 goto bad;
629
630 /*
631 * read the paths
632 */
Mike Snitzer498f0102011-08-02 12:32:04 +0100633 r = dm_read_arg(_args, as, &pg->nr_pgpaths, &ti->error);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700634 if (r)
635 goto bad;
636
Mike Snitzer498f0102011-08-02 12:32:04 +0100637 r = dm_read_arg(_args + 1, as, &nr_selector_args, &ti->error);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700638 if (r)
639 goto bad;
640
Mike Snitzer498f0102011-08-02 12:32:04 +0100641 nr_args = 1 + nr_selector_args;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700642 for (i = 0; i < pg->nr_pgpaths; i++) {
643 struct pgpath *pgpath;
Mike Snitzer498f0102011-08-02 12:32:04 +0100644 struct dm_arg_set path_args;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700645
Mike Snitzer498f0102011-08-02 12:32:04 +0100646 if (as->argc < nr_args) {
Mikulas Patocka148acff2008-07-21 12:00:30 +0100647 ti->error = "not enough path parameters";
Alasdair G Kergon6bbf79a2010-08-12 04:13:49 +0100648 r = -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700649 goto bad;
Mikulas Patocka148acff2008-07-21 12:00:30 +0100650 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700651
Mike Snitzer498f0102011-08-02 12:32:04 +0100652 path_args.argc = nr_args;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700653 path_args.argv = as->argv;
654
655 pgpath = parse_path(&path_args, &pg->ps, ti);
Benjamin Marzinski01460f32008-10-10 13:36:57 +0100656 if (IS_ERR(pgpath)) {
657 r = PTR_ERR(pgpath);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700658 goto bad;
Benjamin Marzinski01460f32008-10-10 13:36:57 +0100659 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700660
661 pgpath->pg = pg;
662 list_add_tail(&pgpath->list, &pg->pgpaths);
Mike Snitzer498f0102011-08-02 12:32:04 +0100663 dm_consume_args(as, nr_args);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700664 }
665
666 return pg;
667
668 bad:
669 free_priority_group(pg, ti);
Benjamin Marzinski01460f32008-10-10 13:36:57 +0100670 return ERR_PTR(r);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700671}
672
Mike Snitzer498f0102011-08-02 12:32:04 +0100673static int parse_hw_handler(struct dm_arg_set *as, struct multipath *m)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700674{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700675 unsigned hw_argc;
Chandra Seetharaman2bfd2e12009-08-03 12:42:45 -0700676 int ret;
Micha³ Miros³aw28f16c22006-10-03 01:15:33 -0700677 struct dm_target *ti = m->ti;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700678
Mike Snitzer498f0102011-08-02 12:32:04 +0100679 static struct dm_arg _args[] = {
Alasdair G Kergon72d94862006-06-26 00:27:35 -0700680 {0, 1024, "invalid number of hardware handler args"},
Linus Torvalds1da177e2005-04-16 15:20:36 -0700681 };
682
Mike Snitzer498f0102011-08-02 12:32:04 +0100683 if (dm_read_arg_group(_args, as, &hw_argc, &ti->error))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700684 return -EINVAL;
685
686 if (!hw_argc)
687 return 0;
688
Mike Snitzer498f0102011-08-02 12:32:04 +0100689 m->hw_handler_name = kstrdup(dm_shift_arg(as), GFP_KERNEL);
Mike Snitzer510193a2012-05-12 01:43:21 +0100690 if (!try_then_request_module(scsi_dh_handler_exist(m->hw_handler_name),
691 "scsi_dh_%s", m->hw_handler_name)) {
Alasdair G Kergon72d94862006-06-26 00:27:35 -0700692 ti->error = "unknown hardware handler type";
Chandra Seetharaman2bfd2e12009-08-03 12:42:45 -0700693 ret = -EINVAL;
694 goto fail;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700695 }
Chandra Seetharaman14e98c52008-11-13 23:39:06 +0000696
Chandra Seetharaman2bfd2e12009-08-03 12:42:45 -0700697 if (hw_argc > 1) {
698 char *p;
699 int i, j, len = 4;
700
701 for (i = 0; i <= hw_argc - 2; i++)
702 len += strlen(as->argv[i]) + 1;
703 p = m->hw_handler_params = kzalloc(len, GFP_KERNEL);
704 if (!p) {
705 ti->error = "memory allocation failed";
706 ret = -ENOMEM;
707 goto fail;
708 }
709 j = sprintf(p, "%d", hw_argc - 1);
710 for (i = 0, p+=j+1; i <= hw_argc - 2; i++, p+=j+1)
711 j = sprintf(p, "%s", as->argv[i]);
712 }
Mike Snitzer498f0102011-08-02 12:32:04 +0100713 dm_consume_args(as, hw_argc - 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700714
715 return 0;
Chandra Seetharaman2bfd2e12009-08-03 12:42:45 -0700716fail:
717 kfree(m->hw_handler_name);
718 m->hw_handler_name = NULL;
719 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700720}
721
Mike Snitzer498f0102011-08-02 12:32:04 +0100722static int parse_features(struct dm_arg_set *as, struct multipath *m)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700723{
724 int r;
725 unsigned argc;
Micha³ Miros³aw28f16c22006-10-03 01:15:33 -0700726 struct dm_target *ti = m->ti;
Mike Snitzer498f0102011-08-02 12:32:04 +0100727 const char *arg_name;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700728
Mike Snitzer498f0102011-08-02 12:32:04 +0100729 static struct dm_arg _args[] = {
Mike Snitzera58a9352012-07-27 15:08:04 +0100730 {0, 6, "invalid number of feature args"},
Dave Wysochanskic9e45582007-10-19 22:47:53 +0100731 {1, 50, "pg_init_retries must be between 1 and 50"},
Chandra Seetharaman4e2d19e2011-01-13 20:00:01 +0000732 {0, 60000, "pg_init_delay_msecs must be between 0 and 60000"},
Linus Torvalds1da177e2005-04-16 15:20:36 -0700733 };
734
Mike Snitzer498f0102011-08-02 12:32:04 +0100735 r = dm_read_arg_group(_args, as, &argc, &ti->error);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700736 if (r)
737 return -EINVAL;
738
739 if (!argc)
740 return 0;
741
Dave Wysochanskic9e45582007-10-19 22:47:53 +0100742 do {
Mike Snitzer498f0102011-08-02 12:32:04 +0100743 arg_name = dm_shift_arg(as);
Dave Wysochanskic9e45582007-10-19 22:47:53 +0100744 argc--;
745
Mike Snitzer498f0102011-08-02 12:32:04 +0100746 if (!strcasecmp(arg_name, "queue_if_no_path")) {
Dave Wysochanskic9e45582007-10-19 22:47:53 +0100747 r = queue_if_no_path(m, 1, 0);
748 continue;
749 }
750
Mike Snitzera58a9352012-07-27 15:08:04 +0100751 if (!strcasecmp(arg_name, "retain_attached_hw_handler")) {
752 m->retain_attached_hw_handler = 1;
753 continue;
754 }
755
Mike Snitzer498f0102011-08-02 12:32:04 +0100756 if (!strcasecmp(arg_name, "pg_init_retries") &&
Dave Wysochanskic9e45582007-10-19 22:47:53 +0100757 (argc >= 1)) {
Mike Snitzer498f0102011-08-02 12:32:04 +0100758 r = dm_read_arg(_args + 1, as, &m->pg_init_retries, &ti->error);
Dave Wysochanskic9e45582007-10-19 22:47:53 +0100759 argc--;
760 continue;
761 }
762
Mike Snitzer498f0102011-08-02 12:32:04 +0100763 if (!strcasecmp(arg_name, "pg_init_delay_msecs") &&
Chandra Seetharaman4e2d19e2011-01-13 20:00:01 +0000764 (argc >= 1)) {
Mike Snitzer498f0102011-08-02 12:32:04 +0100765 r = dm_read_arg(_args + 2, as, &m->pg_init_delay_msecs, &ti->error);
Chandra Seetharaman4e2d19e2011-01-13 20:00:01 +0000766 argc--;
767 continue;
768 }
769
Linus Torvalds1da177e2005-04-16 15:20:36 -0700770 ti->error = "Unrecognised multipath feature request";
Dave Wysochanskic9e45582007-10-19 22:47:53 +0100771 r = -EINVAL;
772 } while (argc && !r);
773
774 return r;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700775}
776
777static int multipath_ctr(struct dm_target *ti, unsigned int argc,
778 char **argv)
779{
Mike Snitzer498f0102011-08-02 12:32:04 +0100780 /* target arguments */
781 static struct dm_arg _args[] = {
Mike Snitzera490a072011-03-24 13:54:33 +0000782 {0, 1024, "invalid number of priority groups"},
783 {0, 1024, "invalid initial priority group number"},
Linus Torvalds1da177e2005-04-16 15:20:36 -0700784 };
785
786 int r;
787 struct multipath *m;
Mike Snitzer498f0102011-08-02 12:32:04 +0100788 struct dm_arg_set as;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700789 unsigned pg_count = 0;
790 unsigned next_pg_num;
791
792 as.argc = argc;
793 as.argv = argv;
794
Micha³ Miros³aw28f16c22006-10-03 01:15:33 -0700795 m = alloc_multipath(ti);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700796 if (!m) {
Alasdair G Kergon72d94862006-06-26 00:27:35 -0700797 ti->error = "can't allocate multipath";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700798 return -EINVAL;
799 }
800
Micha³ Miros³aw28f16c22006-10-03 01:15:33 -0700801 r = parse_features(&as, m);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700802 if (r)
803 goto bad;
804
Micha³ Miros³aw28f16c22006-10-03 01:15:33 -0700805 r = parse_hw_handler(&as, m);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700806 if (r)
807 goto bad;
808
Mike Snitzer498f0102011-08-02 12:32:04 +0100809 r = dm_read_arg(_args, &as, &m->nr_priority_groups, &ti->error);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700810 if (r)
811 goto bad;
812
Mike Snitzer498f0102011-08-02 12:32:04 +0100813 r = dm_read_arg(_args + 1, &as, &next_pg_num, &ti->error);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700814 if (r)
815 goto bad;
816
Mike Snitzera490a072011-03-24 13:54:33 +0000817 if ((!m->nr_priority_groups && next_pg_num) ||
818 (m->nr_priority_groups && !next_pg_num)) {
819 ti->error = "invalid initial priority group";
820 r = -EINVAL;
821 goto bad;
822 }
823
Linus Torvalds1da177e2005-04-16 15:20:36 -0700824 /* parse the priority groups */
825 while (as.argc) {
826 struct priority_group *pg;
827
Micha³ Miros³aw28f16c22006-10-03 01:15:33 -0700828 pg = parse_priority_group(&as, m);
Benjamin Marzinski01460f32008-10-10 13:36:57 +0100829 if (IS_ERR(pg)) {
830 r = PTR_ERR(pg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700831 goto bad;
832 }
833
834 m->nr_valid_paths += pg->nr_pgpaths;
835 list_add_tail(&pg->list, &m->priority_groups);
836 pg_count++;
837 pg->pg_num = pg_count;
838 if (!--next_pg_num)
839 m->next_pg = pg;
840 }
841
842 if (pg_count != m->nr_priority_groups) {
Alasdair G Kergon72d94862006-06-26 00:27:35 -0700843 ti->error = "priority group count mismatch";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700844 r = -EINVAL;
845 goto bad;
846 }
847
Alasdair G Kergon55a62ee2013-03-01 22:45:47 +0000848 ti->num_flush_bios = 1;
849 ti->num_discard_bios = 1;
Mike Snitzer042bcef2013-05-10 14:37:16 +0100850 ti->num_write_same_bios = 1;
Mikulas Patocka86279212009-06-22 10:12:24 +0100851
Linus Torvalds1da177e2005-04-16 15:20:36 -0700852 return 0;
853
854 bad:
855 free_multipath(m);
856 return r;
857}
858
Kiyoshi Ueda2bded7b2010-03-06 02:32:13 +0000859static void multipath_wait_for_pg_init_completion(struct multipath *m)
860{
861 DECLARE_WAITQUEUE(wait, current);
862 unsigned long flags;
863
864 add_wait_queue(&m->pg_init_wait, &wait);
865
866 while (1) {
867 set_current_state(TASK_UNINTERRUPTIBLE);
868
869 spin_lock_irqsave(&m->lock, flags);
870 if (!m->pg_init_in_progress) {
871 spin_unlock_irqrestore(&m->lock, flags);
872 break;
873 }
874 spin_unlock_irqrestore(&m->lock, flags);
875
876 io_schedule();
877 }
878 set_current_state(TASK_RUNNING);
879
880 remove_wait_queue(&m->pg_init_wait, &wait);
881}
882
883static void flush_multipath_work(struct multipath *m)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700884{
Shiva Krishna Merla954a73d2013-10-30 03:26:38 +0000885 unsigned long flags;
886
887 spin_lock_irqsave(&m->lock, flags);
888 m->pg_init_disabled = 1;
889 spin_unlock_irqrestore(&m->lock, flags);
890
Chandra Seetharamanbab7cfc2008-05-01 14:50:22 -0700891 flush_workqueue(kmpath_handlerd);
Kiyoshi Ueda2bded7b2010-03-06 02:32:13 +0000892 multipath_wait_for_pg_init_completion(m);
Alasdair G Kergona044d012005-07-12 15:53:02 -0700893 flush_workqueue(kmultipathd);
Tejun Heo43829732012-08-20 14:51:24 -0700894 flush_work(&m->trigger_event);
Shiva Krishna Merla954a73d2013-10-30 03:26:38 +0000895
896 spin_lock_irqsave(&m->lock, flags);
897 m->pg_init_disabled = 0;
898 spin_unlock_irqrestore(&m->lock, flags);
Kiyoshi Ueda6df400a2009-12-10 23:52:19 +0000899}
900
901static void multipath_dtr(struct dm_target *ti)
902{
903 struct multipath *m = ti->private;
904
Kiyoshi Ueda2bded7b2010-03-06 02:32:13 +0000905 flush_multipath_work(m);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700906 free_multipath(m);
907}
908
909/*
Kiyoshi Uedaf40c67f2009-06-22 10:12:37 +0100910 * Map cloned requests
Linus Torvalds1da177e2005-04-16 15:20:36 -0700911 */
Kiyoshi Uedaf40c67f2009-06-22 10:12:37 +0100912static int multipath_map(struct dm_target *ti, struct request *clone,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700913 union map_info *map_context)
914{
915 int r;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700916 struct multipath *m = (struct multipath *) ti->private;
917
Jun'ichi Nomura466891f2012-03-28 18:41:25 +0100918 if (set_mapinfo(m, map_context) < 0)
Kiyoshi Uedaf40c67f2009-06-22 10:12:37 +0100919 /* ENOMEM, requeue */
920 return DM_MAPIO_REQUEUE;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700921
Kiyoshi Uedaf40c67f2009-06-22 10:12:37 +0100922 clone->cmd_flags |= REQ_FAILFAST_TRANSPORT;
Hannes Reineckee8099172014-02-28 15:33:44 +0100923 r = map_io(m, clone, map_context);
Kiyoshi Ueda45e15722006-12-08 02:41:10 -0800924 if (r < 0 || r == DM_MAPIO_REQUEUE)
Jun'ichi Nomura466891f2012-03-28 18:41:25 +0100925 clear_mapinfo(m, map_context);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700926
927 return r;
928}
929
930/*
931 * Take a path out of use.
932 */
933static int fail_path(struct pgpath *pgpath)
934{
935 unsigned long flags;
936 struct multipath *m = pgpath->pg->m;
937
938 spin_lock_irqsave(&m->lock, flags);
939
Kiyoshi Ueda66800732008-10-10 13:36:58 +0100940 if (!pgpath->is_active)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700941 goto out;
942
Alasdair G Kergon72d94862006-06-26 00:27:35 -0700943 DMWARN("Failing path %s.", pgpath->path.dev->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700944
945 pgpath->pg->ps.type->fail_path(&pgpath->pg->ps, &pgpath->path);
Kiyoshi Ueda66800732008-10-10 13:36:58 +0100946 pgpath->is_active = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700947 pgpath->fail_count++;
948
949 m->nr_valid_paths--;
950
951 if (pgpath == m->current_pgpath)
952 m->current_pgpath = NULL;
953
Mike Andersonb15546f2007-10-19 22:48:02 +0100954 dm_path_uevent(DM_UEVENT_PATH_FAILED, m->ti,
955 pgpath->path.dev->name, m->nr_valid_paths);
956
Alasdair G Kergonfe9cf302009-01-06 03:05:13 +0000957 schedule_work(&m->trigger_event);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700958
959out:
960 spin_unlock_irqrestore(&m->lock, flags);
961
962 return 0;
963}
964
965/*
966 * Reinstate a previously-failed path
967 */
968static int reinstate_path(struct pgpath *pgpath)
969{
970 int r = 0;
971 unsigned long flags;
972 struct multipath *m = pgpath->pg->m;
973
974 spin_lock_irqsave(&m->lock, flags);
975
Kiyoshi Ueda66800732008-10-10 13:36:58 +0100976 if (pgpath->is_active)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700977 goto out;
978
Alasdair G Kergondef052d2008-07-21 12:00:31 +0100979 if (!pgpath->pg->ps.type->reinstate_path) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700980 DMWARN("Reinstate path not supported by path selector %s",
981 pgpath->pg->ps.type->name);
982 r = -EINVAL;
983 goto out;
984 }
985
986 r = pgpath->pg->ps.type->reinstate_path(&pgpath->pg->ps, &pgpath->path);
987 if (r)
988 goto out;
989
Kiyoshi Ueda66800732008-10-10 13:36:58 +0100990 pgpath->is_active = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700991
Hannes Reineckee8099172014-02-28 15:33:44 +0100992 if (!m->nr_valid_paths++) {
Chandra Seetharamane54f77d2009-06-22 10:12:12 +0100993 m->current_pgpath = NULL;
Hannes Reinecke3e9f1be2014-02-28 15:33:45 +0100994 dm_table_run_md_queue_async(m->ti->table);
Chandra Seetharamane54f77d2009-06-22 10:12:12 +0100995 } else if (m->hw_handler_name && (m->current_pg == pgpath->pg)) {
Chandra Seetharaman4e2d19e2011-01-13 20:00:01 +0000996 if (queue_work(kmpath_handlerd, &pgpath->activate_path.work))
Chandra Seetharamane54f77d2009-06-22 10:12:12 +0100997 m->pg_init_in_progress++;
998 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700999
Mike Andersonb15546f2007-10-19 22:48:02 +01001000 dm_path_uevent(DM_UEVENT_PATH_REINSTATED, m->ti,
1001 pgpath->path.dev->name, m->nr_valid_paths);
1002
Alasdair G Kergonfe9cf302009-01-06 03:05:13 +00001003 schedule_work(&m->trigger_event);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001004
1005out:
1006 spin_unlock_irqrestore(&m->lock, flags);
1007
1008 return r;
1009}
1010
1011/*
1012 * Fail or reinstate all paths that match the provided struct dm_dev.
1013 */
1014static int action_dev(struct multipath *m, struct dm_dev *dev,
1015 action_fn action)
1016{
Mike Snitzer19040c02011-03-24 13:54:31 +00001017 int r = -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001018 struct pgpath *pgpath;
1019 struct priority_group *pg;
1020
1021 list_for_each_entry(pg, &m->priority_groups, list) {
1022 list_for_each_entry(pgpath, &pg->pgpaths, list) {
1023 if (pgpath->path.dev == dev)
1024 r = action(pgpath);
1025 }
1026 }
1027
1028 return r;
1029}
1030
1031/*
1032 * Temporarily try to avoid having to use the specified PG
1033 */
1034static void bypass_pg(struct multipath *m, struct priority_group *pg,
1035 int bypassed)
1036{
1037 unsigned long flags;
1038
1039 spin_lock_irqsave(&m->lock, flags);
1040
1041 pg->bypassed = bypassed;
1042 m->current_pgpath = NULL;
1043 m->current_pg = NULL;
1044
1045 spin_unlock_irqrestore(&m->lock, flags);
1046
Alasdair G Kergonfe9cf302009-01-06 03:05:13 +00001047 schedule_work(&m->trigger_event);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001048}
1049
1050/*
1051 * Switch to using the specified PG from the next I/O that gets mapped
1052 */
1053static int switch_pg_num(struct multipath *m, const char *pgstr)
1054{
1055 struct priority_group *pg;
1056 unsigned pgnum;
1057 unsigned long flags;
Mikulas Patocka31998ef2012-03-28 18:41:26 +01001058 char dummy;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001059
Mikulas Patocka31998ef2012-03-28 18:41:26 +01001060 if (!pgstr || (sscanf(pgstr, "%u%c", &pgnum, &dummy) != 1) || !pgnum ||
Linus Torvalds1da177e2005-04-16 15:20:36 -07001061 (pgnum > m->nr_priority_groups)) {
1062 DMWARN("invalid PG number supplied to switch_pg_num");
1063 return -EINVAL;
1064 }
1065
1066 spin_lock_irqsave(&m->lock, flags);
1067 list_for_each_entry(pg, &m->priority_groups, list) {
1068 pg->bypassed = 0;
1069 if (--pgnum)
1070 continue;
1071
1072 m->current_pgpath = NULL;
1073 m->current_pg = NULL;
1074 m->next_pg = pg;
1075 }
1076 spin_unlock_irqrestore(&m->lock, flags);
1077
Alasdair G Kergonfe9cf302009-01-06 03:05:13 +00001078 schedule_work(&m->trigger_event);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001079 return 0;
1080}
1081
1082/*
1083 * Set/clear bypassed status of a PG.
1084 * PGs are numbered upwards from 1 in the order they were declared.
1085 */
1086static int bypass_pg_num(struct multipath *m, const char *pgstr, int bypassed)
1087{
1088 struct priority_group *pg;
1089 unsigned pgnum;
Mikulas Patocka31998ef2012-03-28 18:41:26 +01001090 char dummy;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001091
Mikulas Patocka31998ef2012-03-28 18:41:26 +01001092 if (!pgstr || (sscanf(pgstr, "%u%c", &pgnum, &dummy) != 1) || !pgnum ||
Linus Torvalds1da177e2005-04-16 15:20:36 -07001093 (pgnum > m->nr_priority_groups)) {
1094 DMWARN("invalid PG number supplied to bypass_pg");
1095 return -EINVAL;
1096 }
1097
1098 list_for_each_entry(pg, &m->priority_groups, list) {
1099 if (!--pgnum)
1100 break;
1101 }
1102
1103 bypass_pg(m, pg, bypassed);
1104 return 0;
1105}
1106
1107/*
Dave Wysochanskic9e45582007-10-19 22:47:53 +01001108 * Should we retry pg_init immediately?
1109 */
1110static int pg_init_limit_reached(struct multipath *m, struct pgpath *pgpath)
1111{
1112 unsigned long flags;
1113 int limit_reached = 0;
1114
1115 spin_lock_irqsave(&m->lock, flags);
1116
Shiva Krishna Merla954a73d2013-10-30 03:26:38 +00001117 if (m->pg_init_count <= m->pg_init_retries && !m->pg_init_disabled)
Dave Wysochanskic9e45582007-10-19 22:47:53 +01001118 m->pg_init_required = 1;
1119 else
1120 limit_reached = 1;
1121
1122 spin_unlock_irqrestore(&m->lock, flags);
1123
1124 return limit_reached;
1125}
1126
Chandra Seetharaman3ae31f62009-10-21 09:22:46 -07001127static void pg_init_done(void *data, int errors)
Chandra Seetharamancfae5c92008-05-01 14:50:11 -07001128{
Moger, Babu83c0d5d2010-03-06 02:29:45 +00001129 struct pgpath *pgpath = data;
Chandra Seetharamancfae5c92008-05-01 14:50:11 -07001130 struct priority_group *pg = pgpath->pg;
1131 struct multipath *m = pg->m;
1132 unsigned long flags;
Chandra Seetharaman4e2d19e2011-01-13 20:00:01 +00001133 unsigned delay_retry = 0;
Chandra Seetharamancfae5c92008-05-01 14:50:11 -07001134
1135 /* device or driver problems */
1136 switch (errors) {
1137 case SCSI_DH_OK:
1138 break;
1139 case SCSI_DH_NOSYS:
1140 if (!m->hw_handler_name) {
1141 errors = 0;
1142 break;
1143 }
Moger, Babuf7b934c2010-03-06 02:29:49 +00001144 DMERR("Could not failover the device: Handler scsi_dh_%s "
1145 "Error %d.", m->hw_handler_name, errors);
Chandra Seetharamancfae5c92008-05-01 14:50:11 -07001146 /*
1147 * Fail path for now, so we do not ping pong
1148 */
1149 fail_path(pgpath);
1150 break;
1151 case SCSI_DH_DEV_TEMP_BUSY:
1152 /*
1153 * Probably doing something like FW upgrade on the
1154 * controller so try the other pg.
1155 */
1156 bypass_pg(m, pg, 1);
1157 break;
Chandra Seetharamancfae5c92008-05-01 14:50:11 -07001158 case SCSI_DH_RETRY:
Chandra Seetharaman4e2d19e2011-01-13 20:00:01 +00001159 /* Wait before retrying. */
1160 delay_retry = 1;
Chandra Seetharamancfae5c92008-05-01 14:50:11 -07001161 case SCSI_DH_IMM_RETRY:
1162 case SCSI_DH_RES_TEMP_UNAVAIL:
1163 if (pg_init_limit_reached(m, pgpath))
1164 fail_path(pgpath);
1165 errors = 0;
1166 break;
1167 default:
1168 /*
1169 * We probably do not want to fail the path for a device
1170 * error, but this is what the old dm did. In future
1171 * patches we can do more advanced handling.
1172 */
1173 fail_path(pgpath);
1174 }
1175
1176 spin_lock_irqsave(&m->lock, flags);
1177 if (errors) {
Chandra Seetharamane54f77d2009-06-22 10:12:12 +01001178 if (pgpath == m->current_pgpath) {
1179 DMERR("Could not failover device. Error %d.", errors);
1180 m->current_pgpath = NULL;
1181 m->current_pg = NULL;
1182 }
Kiyoshi Uedad0259bf2010-03-06 02:30:02 +00001183 } else if (!m->pg_init_required)
Chandra Seetharamancfae5c92008-05-01 14:50:11 -07001184 pg->bypassed = 0;
Chandra Seetharamancfae5c92008-05-01 14:50:11 -07001185
Kiyoshi Uedad0259bf2010-03-06 02:30:02 +00001186 if (--m->pg_init_in_progress)
1187 /* Activations of other paths are still on going */
1188 goto out;
1189
Hannes Reinecke3e9f1be2014-02-28 15:33:45 +01001190 if (m->pg_init_required) {
1191 m->pg_init_delay_retry = delay_retry;
1192 if (__pg_init_all_paths(m))
1193 goto out;
1194 }
1195 m->queue_io = 0;
Kiyoshi Uedad0259bf2010-03-06 02:30:02 +00001196
Kiyoshi Ueda2bded7b2010-03-06 02:32:13 +00001197 /*
1198 * Wake up any thread waiting to suspend.
1199 */
1200 wake_up(&m->pg_init_wait);
1201
Kiyoshi Uedad0259bf2010-03-06 02:30:02 +00001202out:
Chandra Seetharamancfae5c92008-05-01 14:50:11 -07001203 spin_unlock_irqrestore(&m->lock, flags);
1204}
1205
Chandra Seetharamanbab7cfc2008-05-01 14:50:22 -07001206static void activate_path(struct work_struct *work)
1207{
Chandra Seetharamane54f77d2009-06-22 10:12:12 +01001208 struct pgpath *pgpath =
Chandra Seetharaman4e2d19e2011-01-13 20:00:01 +00001209 container_of(work, struct pgpath, activate_path.work);
Chandra Seetharamanbab7cfc2008-05-01 14:50:22 -07001210
Chandra Seetharaman3ae31f62009-10-21 09:22:46 -07001211 scsi_dh_activate(bdev_get_queue(pgpath->path.dev->bdev),
Moger, Babu83c0d5d2010-03-06 02:29:45 +00001212 pg_init_done, pgpath);
Chandra Seetharamanbab7cfc2008-05-01 14:50:22 -07001213}
1214
Hannes Reinecke7e782af2013-07-01 15:16:26 +02001215static int noretry_error(int error)
1216{
1217 switch (error) {
1218 case -EOPNOTSUPP:
1219 case -EREMOTEIO:
1220 case -EILSEQ:
1221 case -ENODATA:
Jun'ichi Nomuracc9d3c32013-09-13 14:54:30 +09001222 case -ENOSPC:
Hannes Reinecke7e782af2013-07-01 15:16:26 +02001223 return 1;
1224 }
1225
1226 /* Anything else could be a path failure, so should be retried */
1227 return 0;
1228}
1229
Linus Torvalds1da177e2005-04-16 15:20:36 -07001230/*
1231 * end_io handling
1232 */
Kiyoshi Uedaf40c67f2009-06-22 10:12:37 +01001233static int do_end_io(struct multipath *m, struct request *clone,
Alasdair G Kergon028867a2007-07-12 17:26:32 +01001234 int error, struct dm_mpath_io *mpio)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001235{
Kiyoshi Uedaf40c67f2009-06-22 10:12:37 +01001236 /*
1237 * We don't queue any clone request inside the multipath target
1238 * during end I/O handling, since those clone requests don't have
1239 * bio clones. If we queue them inside the multipath target,
1240 * we need to make bio clones, that requires memory allocation.
1241 * (See drivers/md/dm.c:end_clone_bio() about why the clone requests
1242 * don't have bio clones.)
1243 * Instead of queueing the clone request here, we queue the original
1244 * request into dm core, which will remake a clone request and
1245 * clone bios for it and resubmit it later.
1246 */
1247 int r = DM_ENDIO_REQUEUE;
Stefan Bader640eb3b2005-11-21 21:32:35 -08001248 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001249
Kiyoshi Uedaf40c67f2009-06-22 10:12:37 +01001250 if (!error && !clone->errors)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001251 return 0; /* I/O complete */
1252
Mike Snitzerf84cb8a2013-09-19 12:13:58 -04001253 if (noretry_error(error)) {
1254 if ((clone->cmd_flags & REQ_WRITE_SAME) &&
1255 !clone->q->limits.max_write_same_sectors) {
1256 struct queue_limits *limits;
1257
1258 /* device doesn't really support WRITE SAME, disable it */
1259 limits = dm_get_queue_limits(dm_table_get_md(m->ti->table));
1260 limits->max_write_same_sectors = 0;
1261 }
Mike Snitzer959eb4e2010-08-12 04:14:32 +01001262 return error;
Mike Snitzerf84cb8a2013-09-19 12:13:58 -04001263 }
Mike Snitzer959eb4e2010-08-12 04:14:32 +01001264
Chandra Seetharamancfae5c92008-05-01 14:50:11 -07001265 if (mpio->pgpath)
1266 fail_path(mpio->pgpath);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001267
Stefan Bader640eb3b2005-11-21 21:32:35 -08001268 spin_lock_irqsave(&m->lock, flags);
Hannes Reinecke751b2a72011-01-18 10:13:12 +01001269 if (!m->nr_valid_paths) {
1270 if (!m->queue_if_no_path) {
1271 if (!__must_push_back(m))
1272 r = -EIO;
1273 } else {
1274 if (error == -EBADE)
1275 r = error;
1276 }
1277 }
Stefan Bader640eb3b2005-11-21 21:32:35 -08001278 spin_unlock_irqrestore(&m->lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001279
Kiyoshi Uedaf40c67f2009-06-22 10:12:37 +01001280 return r;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001281}
1282
Kiyoshi Uedaf40c67f2009-06-22 10:12:37 +01001283static int multipath_end_io(struct dm_target *ti, struct request *clone,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001284 int error, union map_info *map_context)
1285{
Alasdair G Kergon028867a2007-07-12 17:26:32 +01001286 struct multipath *m = ti->private;
1287 struct dm_mpath_io *mpio = map_context->ptr;
Wei Yongjuna71a2612012-10-12 16:59:42 +01001288 struct pgpath *pgpath;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001289 struct path_selector *ps;
1290 int r;
1291
Jun'ichi Nomura466891f2012-03-28 18:41:25 +01001292 BUG_ON(!mpio);
1293
Kiyoshi Uedaf40c67f2009-06-22 10:12:37 +01001294 r = do_end_io(m, clone, error, mpio);
Wei Yongjuna71a2612012-10-12 16:59:42 +01001295 pgpath = mpio->pgpath;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001296 if (pgpath) {
1297 ps = &pgpath->pg->ps;
1298 if (ps->type->end_io)
Kiyoshi Ueda02ab8232009-06-22 10:12:27 +01001299 ps->type->end_io(ps, &pgpath->path, mpio->nr_bytes);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001300 }
Jun'ichi Nomura466891f2012-03-28 18:41:25 +01001301 clear_mapinfo(m, map_context);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001302
1303 return r;
1304}
1305
1306/*
1307 * Suspend can't complete until all the I/O is processed so if
Alasdair G Kergon436d4102005-07-12 15:53:03 -07001308 * the last path fails we must error any remaining I/O.
1309 * Note that if the freeze_bdev fails while suspending, the
1310 * queue_if_no_path state is lost - userspace should reset it.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001311 */
1312static void multipath_presuspend(struct dm_target *ti)
1313{
1314 struct multipath *m = (struct multipath *) ti->private;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001315
Alasdair G Kergon485ef692005-09-27 21:45:45 -07001316 queue_if_no_path(m, 0, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001317}
1318
Kiyoshi Ueda6df400a2009-12-10 23:52:19 +00001319static void multipath_postsuspend(struct dm_target *ti)
1320{
Mike Anderson6380f262009-12-10 23:52:21 +00001321 struct multipath *m = ti->private;
1322
1323 mutex_lock(&m->work_mutex);
Kiyoshi Ueda2bded7b2010-03-06 02:32:13 +00001324 flush_multipath_work(m);
Mike Anderson6380f262009-12-10 23:52:21 +00001325 mutex_unlock(&m->work_mutex);
Kiyoshi Ueda6df400a2009-12-10 23:52:19 +00001326}
1327
Alasdair G Kergon436d4102005-07-12 15:53:03 -07001328/*
1329 * Restore the queue_if_no_path setting.
1330 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001331static void multipath_resume(struct dm_target *ti)
1332{
1333 struct multipath *m = (struct multipath *) ti->private;
1334 unsigned long flags;
1335
1336 spin_lock_irqsave(&m->lock, flags);
Alasdair G Kergon436d4102005-07-12 15:53:03 -07001337 m->queue_if_no_path = m->saved_queue_if_no_path;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001338 spin_unlock_irqrestore(&m->lock, flags);
1339}
1340
1341/*
1342 * Info output has the following format:
1343 * num_multipath_feature_args [multipath_feature_args]*
1344 * num_handler_status_args [handler_status_args]*
1345 * num_groups init_group_number
1346 * [A|D|E num_ps_status_args [ps_status_args]*
1347 * num_paths num_selector_args
1348 * [path_dev A|F fail_count [selector_args]* ]+ ]+
1349 *
1350 * Table output has the following format (identical to the constructor string):
1351 * num_feature_args [features_args]*
1352 * num_handler_args hw_handler [hw_handler_args]*
1353 * num_groups init_group_number
1354 * [priority selector-name num_ps_args [ps_args]*
1355 * num_paths num_selector_args [path_dev [selector_args]* ]+ ]+
1356 */
Mikulas Patockafd7c0922013-03-01 22:45:44 +00001357static void multipath_status(struct dm_target *ti, status_type_t type,
1358 unsigned status_flags, char *result, unsigned maxlen)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001359{
1360 int sz = 0;
1361 unsigned long flags;
1362 struct multipath *m = (struct multipath *) ti->private;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001363 struct priority_group *pg;
1364 struct pgpath *p;
1365 unsigned pg_num;
1366 char state;
1367
1368 spin_lock_irqsave(&m->lock, flags);
1369
1370 /* Features */
1371 if (type == STATUSTYPE_INFO)
Hannes Reineckee8099172014-02-28 15:33:44 +01001372 DMEMIT("2 %u %u ", m->queue_io, m->pg_init_count);
Dave Wysochanskic9e45582007-10-19 22:47:53 +01001373 else {
1374 DMEMIT("%u ", m->queue_if_no_path +
Chandra Seetharaman4e2d19e2011-01-13 20:00:01 +00001375 (m->pg_init_retries > 0) * 2 +
Mike Snitzera58a9352012-07-27 15:08:04 +01001376 (m->pg_init_delay_msecs != DM_PG_INIT_DELAY_DEFAULT) * 2 +
1377 m->retain_attached_hw_handler);
Dave Wysochanskic9e45582007-10-19 22:47:53 +01001378 if (m->queue_if_no_path)
1379 DMEMIT("queue_if_no_path ");
1380 if (m->pg_init_retries)
1381 DMEMIT("pg_init_retries %u ", m->pg_init_retries);
Chandra Seetharaman4e2d19e2011-01-13 20:00:01 +00001382 if (m->pg_init_delay_msecs != DM_PG_INIT_DELAY_DEFAULT)
1383 DMEMIT("pg_init_delay_msecs %u ", m->pg_init_delay_msecs);
Mike Snitzera58a9352012-07-27 15:08:04 +01001384 if (m->retain_attached_hw_handler)
1385 DMEMIT("retain_attached_hw_handler ");
Dave Wysochanskic9e45582007-10-19 22:47:53 +01001386 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001387
Chandra Seetharamancfae5c92008-05-01 14:50:11 -07001388 if (!m->hw_handler_name || type == STATUSTYPE_INFO)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001389 DMEMIT("0 ");
1390 else
Chandra Seetharamancfae5c92008-05-01 14:50:11 -07001391 DMEMIT("1 %s ", m->hw_handler_name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001392
1393 DMEMIT("%u ", m->nr_priority_groups);
1394
1395 if (m->next_pg)
1396 pg_num = m->next_pg->pg_num;
1397 else if (m->current_pg)
1398 pg_num = m->current_pg->pg_num;
1399 else
Mike Snitzera490a072011-03-24 13:54:33 +00001400 pg_num = (m->nr_priority_groups ? 1 : 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001401
1402 DMEMIT("%u ", pg_num);
1403
1404 switch (type) {
1405 case STATUSTYPE_INFO:
1406 list_for_each_entry(pg, &m->priority_groups, list) {
1407 if (pg->bypassed)
1408 state = 'D'; /* Disabled */
1409 else if (pg == m->current_pg)
1410 state = 'A'; /* Currently Active */
1411 else
1412 state = 'E'; /* Enabled */
1413
1414 DMEMIT("%c ", state);
1415
1416 if (pg->ps.type->status)
1417 sz += pg->ps.type->status(&pg->ps, NULL, type,
1418 result + sz,
1419 maxlen - sz);
1420 else
1421 DMEMIT("0 ");
1422
1423 DMEMIT("%u %u ", pg->nr_pgpaths,
1424 pg->ps.type->info_args);
1425
1426 list_for_each_entry(p, &pg->pgpaths, list) {
1427 DMEMIT("%s %s %u ", p->path.dev->name,
Kiyoshi Ueda66800732008-10-10 13:36:58 +01001428 p->is_active ? "A" : "F",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001429 p->fail_count);
1430 if (pg->ps.type->status)
1431 sz += pg->ps.type->status(&pg->ps,
1432 &p->path, type, result + sz,
1433 maxlen - sz);
1434 }
1435 }
1436 break;
1437
1438 case STATUSTYPE_TABLE:
1439 list_for_each_entry(pg, &m->priority_groups, list) {
1440 DMEMIT("%s ", pg->ps.type->name);
1441
1442 if (pg->ps.type->status)
1443 sz += pg->ps.type->status(&pg->ps, NULL, type,
1444 result + sz,
1445 maxlen - sz);
1446 else
1447 DMEMIT("0 ");
1448
1449 DMEMIT("%u %u ", pg->nr_pgpaths,
1450 pg->ps.type->table_args);
1451
1452 list_for_each_entry(p, &pg->pgpaths, list) {
1453 DMEMIT("%s ", p->path.dev->name);
1454 if (pg->ps.type->status)
1455 sz += pg->ps.type->status(&pg->ps,
1456 &p->path, type, result + sz,
1457 maxlen - sz);
1458 }
1459 }
1460 break;
1461 }
1462
1463 spin_unlock_irqrestore(&m->lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001464}
1465
1466static int multipath_message(struct dm_target *ti, unsigned argc, char **argv)
1467{
Mike Anderson6380f262009-12-10 23:52:21 +00001468 int r = -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001469 struct dm_dev *dev;
1470 struct multipath *m = (struct multipath *) ti->private;
1471 action_fn action;
1472
Mike Anderson6380f262009-12-10 23:52:21 +00001473 mutex_lock(&m->work_mutex);
1474
Kiyoshi Uedac2f3d242009-12-10 23:52:27 +00001475 if (dm_suspended(ti)) {
1476 r = -EBUSY;
1477 goto out;
1478 }
1479
Linus Torvalds1da177e2005-04-16 15:20:36 -07001480 if (argc == 1) {
Mike Snitzer498f0102011-08-02 12:32:04 +01001481 if (!strcasecmp(argv[0], "queue_if_no_path")) {
Mike Anderson6380f262009-12-10 23:52:21 +00001482 r = queue_if_no_path(m, 1, 0);
1483 goto out;
Mike Snitzer498f0102011-08-02 12:32:04 +01001484 } else if (!strcasecmp(argv[0], "fail_if_no_path")) {
Mike Anderson6380f262009-12-10 23:52:21 +00001485 r = queue_if_no_path(m, 0, 0);
1486 goto out;
1487 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001488 }
1489
Mike Anderson6380f262009-12-10 23:52:21 +00001490 if (argc != 2) {
1491 DMWARN("Unrecognised multipath message received.");
1492 goto out;
1493 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001494
Mike Snitzer498f0102011-08-02 12:32:04 +01001495 if (!strcasecmp(argv[0], "disable_group")) {
Mike Anderson6380f262009-12-10 23:52:21 +00001496 r = bypass_pg_num(m, argv[1], 1);
1497 goto out;
Mike Snitzer498f0102011-08-02 12:32:04 +01001498 } else if (!strcasecmp(argv[0], "enable_group")) {
Mike Anderson6380f262009-12-10 23:52:21 +00001499 r = bypass_pg_num(m, argv[1], 0);
1500 goto out;
Mike Snitzer498f0102011-08-02 12:32:04 +01001501 } else if (!strcasecmp(argv[0], "switch_group")) {
Mike Anderson6380f262009-12-10 23:52:21 +00001502 r = switch_pg_num(m, argv[1]);
1503 goto out;
Mike Snitzer498f0102011-08-02 12:32:04 +01001504 } else if (!strcasecmp(argv[0], "reinstate_path"))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001505 action = reinstate_path;
Mike Snitzer498f0102011-08-02 12:32:04 +01001506 else if (!strcasecmp(argv[0], "fail_path"))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001507 action = fail_path;
Mike Anderson6380f262009-12-10 23:52:21 +00001508 else {
1509 DMWARN("Unrecognised multipath message received.");
1510 goto out;
1511 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001512
Nikanth Karthikesan8215d6e2010-03-06 02:32:27 +00001513 r = dm_get_device(ti, argv[1], dm_table_get_mode(ti->table), &dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001514 if (r) {
Alasdair G Kergon72d94862006-06-26 00:27:35 -07001515 DMWARN("message: error getting device %s",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001516 argv[1]);
Mike Anderson6380f262009-12-10 23:52:21 +00001517 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001518 }
1519
1520 r = action_dev(m, dev, action);
1521
1522 dm_put_device(ti, dev);
1523
Mike Anderson6380f262009-12-10 23:52:21 +00001524out:
1525 mutex_unlock(&m->work_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001526 return r;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001527}
1528
Al Viro647b3d02007-08-28 22:15:59 -04001529static int multipath_ioctl(struct dm_target *ti, unsigned int cmd,
Milan Broz9af4aa32006-10-03 01:15:20 -07001530 unsigned long arg)
1531{
Mikulas Patocka35991652012-06-03 00:29:58 +01001532 struct multipath *m = ti->private;
Mike Snitzer7ba10aa2012-09-26 23:45:41 +01001533 struct pgpath *pgpath;
Mikulas Patocka35991652012-06-03 00:29:58 +01001534 struct block_device *bdev;
1535 fmode_t mode;
Milan Broz9af4aa32006-10-03 01:15:20 -07001536 unsigned long flags;
Mikulas Patocka35991652012-06-03 00:29:58 +01001537 int r;
1538
Mikulas Patocka35991652012-06-03 00:29:58 +01001539 bdev = NULL;
1540 mode = 0;
1541 r = 0;
Milan Broz9af4aa32006-10-03 01:15:20 -07001542
1543 spin_lock_irqsave(&m->lock, flags);
1544
1545 if (!m->current_pgpath)
Kiyoshi Ueda02ab8232009-06-22 10:12:27 +01001546 __choose_pgpath(m, 0);
Milan Broz9af4aa32006-10-03 01:15:20 -07001547
Mike Snitzer7ba10aa2012-09-26 23:45:41 +01001548 pgpath = m->current_pgpath;
1549
1550 if (pgpath) {
1551 bdev = pgpath->path.dev->bdev;
1552 mode = pgpath->path.dev->mode;
Milan Broze90dae12006-10-03 01:15:22 -07001553 }
Milan Broz9af4aa32006-10-03 01:15:20 -07001554
Mike Snitzer7ba10aa2012-09-26 23:45:41 +01001555 if ((pgpath && m->queue_io) || (!pgpath && m->queue_if_no_path))
Hannes Reinecke6c182cd2013-07-10 23:41:15 +01001556 r = -ENOTCONN;
Milan Broz9af4aa32006-10-03 01:15:20 -07001557 else if (!bdev)
1558 r = -EIO;
1559
1560 spin_unlock_irqrestore(&m->lock, flags);
1561
Paolo Bonziniec8013b2012-01-12 16:01:29 +01001562 /*
1563 * Only pass ioctls through if the device sizes match exactly.
1564 */
Hannes Reineckea1989b32014-02-26 10:07:04 +01001565 if (!bdev || ti->len != i_size_read(bdev->bd_inode) >> SECTOR_SHIFT) {
1566 int err = scsi_verify_blk_ioctl(NULL, cmd);
1567 if (err)
1568 r = err;
1569 }
Paolo Bonziniec8013b2012-01-12 16:01:29 +01001570
Hannes Reinecke3e9f1be2014-02-28 15:33:45 +01001571 if (r == -ENOTCONN && !fatal_signal_pending(current)) {
1572 spin_lock_irqsave(&m->lock, flags);
1573 if (!m->current_pg) {
1574 /* Path status changed, redo selection */
1575 __choose_pgpath(m, 0);
1576 }
1577 if (m->pg_init_required)
1578 __pg_init_all_paths(m);
1579 spin_unlock_irqrestore(&m->lock, flags);
1580 dm_table_run_md_queue_async(m->ti->table);
1581 }
Mikulas Patocka35991652012-06-03 00:29:58 +01001582
Al Viro633a08b2007-08-29 20:34:12 -04001583 return r ? : __blkdev_driver_ioctl(bdev, mode, cmd, arg);
Milan Broz9af4aa32006-10-03 01:15:20 -07001584}
1585
Mike Snitzeraf4874e2009-06-22 10:12:33 +01001586static int multipath_iterate_devices(struct dm_target *ti,
1587 iterate_devices_callout_fn fn, void *data)
1588{
1589 struct multipath *m = ti->private;
1590 struct priority_group *pg;
1591 struct pgpath *p;
1592 int ret = 0;
1593
1594 list_for_each_entry(pg, &m->priority_groups, list) {
1595 list_for_each_entry(p, &pg->pgpaths, list) {
Mike Snitzer5dea2712009-07-23 20:30:42 +01001596 ret = fn(ti, p->path.dev, ti->begin, ti->len, data);
Mike Snitzeraf4874e2009-06-22 10:12:33 +01001597 if (ret)
1598 goto out;
1599 }
1600 }
1601
1602out:
1603 return ret;
1604}
1605
Kiyoshi Uedaf40c67f2009-06-22 10:12:37 +01001606static int __pgpath_busy(struct pgpath *pgpath)
1607{
1608 struct request_queue *q = bdev_get_queue(pgpath->path.dev->bdev);
1609
1610 return dm_underlying_device_busy(q);
1611}
1612
1613/*
1614 * We return "busy", only when we can map I/Os but underlying devices
1615 * are busy (so even if we map I/Os now, the I/Os will wait on
1616 * the underlying queue).
1617 * In other words, if we want to kill I/Os or queue them inside us
1618 * due to map unavailability, we don't return "busy". Otherwise,
1619 * dm core won't give us the I/Os and we can't do what we want.
1620 */
1621static int multipath_busy(struct dm_target *ti)
1622{
1623 int busy = 0, has_active = 0;
1624 struct multipath *m = ti->private;
1625 struct priority_group *pg;
1626 struct pgpath *pgpath;
1627 unsigned long flags;
1628
1629 spin_lock_irqsave(&m->lock, flags);
1630
Hannes Reineckeb63349a2013-10-01 11:49:56 +02001631 /* pg_init in progress, requeue until done */
Hannes Reineckee8099172014-02-28 15:33:44 +01001632 if (!pg_ready(m)) {
Hannes Reineckeb63349a2013-10-01 11:49:56 +02001633 busy = 1;
1634 goto out;
1635 }
Kiyoshi Uedaf40c67f2009-06-22 10:12:37 +01001636 /* Guess which priority_group will be used at next mapping time */
1637 if (unlikely(!m->current_pgpath && m->next_pg))
1638 pg = m->next_pg;
1639 else if (likely(m->current_pg))
1640 pg = m->current_pg;
1641 else
1642 /*
1643 * We don't know which pg will be used at next mapping time.
1644 * We don't call __choose_pgpath() here to avoid to trigger
1645 * pg_init just by busy checking.
1646 * So we don't know whether underlying devices we will be using
1647 * at next mapping time are busy or not. Just try mapping.
1648 */
1649 goto out;
1650
1651 /*
1652 * If there is one non-busy active path at least, the path selector
1653 * will be able to select it. So we consider such a pg as not busy.
1654 */
1655 busy = 1;
1656 list_for_each_entry(pgpath, &pg->pgpaths, list)
1657 if (pgpath->is_active) {
1658 has_active = 1;
1659
1660 if (!__pgpath_busy(pgpath)) {
1661 busy = 0;
1662 break;
1663 }
1664 }
1665
1666 if (!has_active)
1667 /*
1668 * No active path in this pg, so this pg won't be used and
1669 * the current_pg will be changed at next mapping time.
1670 * We need to try mapping to determine it.
1671 */
1672 busy = 0;
1673
1674out:
1675 spin_unlock_irqrestore(&m->lock, flags);
1676
1677 return busy;
1678}
1679
Linus Torvalds1da177e2005-04-16 15:20:36 -07001680/*-----------------------------------------------------------------
1681 * Module setup
1682 *---------------------------------------------------------------*/
1683static struct target_type multipath_target = {
1684 .name = "multipath",
Hannes Reineckee8099172014-02-28 15:33:44 +01001685 .version = {1, 7, 0},
Linus Torvalds1da177e2005-04-16 15:20:36 -07001686 .module = THIS_MODULE,
1687 .ctr = multipath_ctr,
1688 .dtr = multipath_dtr,
Kiyoshi Uedaf40c67f2009-06-22 10:12:37 +01001689 .map_rq = multipath_map,
1690 .rq_end_io = multipath_end_io,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001691 .presuspend = multipath_presuspend,
Kiyoshi Ueda6df400a2009-12-10 23:52:19 +00001692 .postsuspend = multipath_postsuspend,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001693 .resume = multipath_resume,
1694 .status = multipath_status,
1695 .message = multipath_message,
Milan Broz9af4aa32006-10-03 01:15:20 -07001696 .ioctl = multipath_ioctl,
Mike Snitzeraf4874e2009-06-22 10:12:33 +01001697 .iterate_devices = multipath_iterate_devices,
Kiyoshi Uedaf40c67f2009-06-22 10:12:37 +01001698 .busy = multipath_busy,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001699};
1700
1701static int __init dm_multipath_init(void)
1702{
1703 int r;
1704
1705 /* allocate a slab for the dm_ios */
Alasdair G Kergon028867a2007-07-12 17:26:32 +01001706 _mpio_cache = KMEM_CACHE(dm_mpath_io, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001707 if (!_mpio_cache)
1708 return -ENOMEM;
1709
1710 r = dm_register_target(&multipath_target);
1711 if (r < 0) {
Alasdair G Kergon0cd33122007-07-12 17:27:01 +01001712 DMERR("register failed %d", r);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001713 kmem_cache_destroy(_mpio_cache);
1714 return -EINVAL;
1715 }
1716
Tejun Heo4d4d66a2011-01-13 19:59:57 +00001717 kmultipathd = alloc_workqueue("kmpathd", WQ_MEM_RECLAIM, 0);
Alasdair G Kergonc5573082005-05-05 16:16:07 -07001718 if (!kmultipathd) {
Alasdair G Kergon0cd33122007-07-12 17:27:01 +01001719 DMERR("failed to create workqueue kmpathd");
Alasdair G Kergonc5573082005-05-05 16:16:07 -07001720 dm_unregister_target(&multipath_target);
1721 kmem_cache_destroy(_mpio_cache);
1722 return -ENOMEM;
1723 }
1724
Chandra Seetharamanbab7cfc2008-05-01 14:50:22 -07001725 /*
1726 * A separate workqueue is used to handle the device handlers
1727 * to avoid overloading existing workqueue. Overloading the
1728 * old workqueue would also create a bottleneck in the
1729 * path of the storage hardware device activation.
1730 */
Tejun Heo4d4d66a2011-01-13 19:59:57 +00001731 kmpath_handlerd = alloc_ordered_workqueue("kmpath_handlerd",
1732 WQ_MEM_RECLAIM);
Chandra Seetharamanbab7cfc2008-05-01 14:50:22 -07001733 if (!kmpath_handlerd) {
1734 DMERR("failed to create workqueue kmpath_handlerd");
1735 destroy_workqueue(kmultipathd);
1736 dm_unregister_target(&multipath_target);
1737 kmem_cache_destroy(_mpio_cache);
1738 return -ENOMEM;
1739 }
1740
Alasdair G Kergon72d94862006-06-26 00:27:35 -07001741 DMINFO("version %u.%u.%u loaded",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001742 multipath_target.version[0], multipath_target.version[1],
1743 multipath_target.version[2]);
1744
1745 return r;
1746}
1747
1748static void __exit dm_multipath_exit(void)
1749{
Chandra Seetharamanbab7cfc2008-05-01 14:50:22 -07001750 destroy_workqueue(kmpath_handlerd);
Alasdair G Kergonc5573082005-05-05 16:16:07 -07001751 destroy_workqueue(kmultipathd);
1752
Mikulas Patocka10d3bd02009-01-06 03:04:58 +00001753 dm_unregister_target(&multipath_target);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001754 kmem_cache_destroy(_mpio_cache);
1755}
1756
Linus Torvalds1da177e2005-04-16 15:20:36 -07001757module_init(dm_multipath_init);
1758module_exit(dm_multipath_exit);
1759
1760MODULE_DESCRIPTION(DM_NAME " multipath target");
1761MODULE_AUTHOR("Sistina Software <dm-devel@redhat.com>");
1762MODULE_LICENSE("GPL");