blob: 07ca77f2943800c501d8efaf52416a17ca7f2291 [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
Hannes Reinecke36fcffc2014-02-28 15:33:47 +0100378/*
379 * Map cloned requests
380 */
381static int multipath_map(struct dm_target *ti, struct request *clone,
382 union map_info *map_context)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700383{
Hannes Reinecke36fcffc2014-02-28 15:33:47 +0100384 struct multipath *m = (struct multipath *) ti->private;
Hannes Reineckee3bde042014-02-28 15:33:46 +0100385 int r = DM_MAPIO_REQUEUE;
Kiyoshi Uedaf40c67f2009-06-22 10:12:37 +0100386 size_t nr_bytes = blk_rq_bytes(clone);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700387 unsigned long flags;
388 struct pgpath *pgpath;
Kiyoshi Uedaf40c67f2009-06-22 10:12:37 +0100389 struct block_device *bdev;
Hannes Reineckee3bde042014-02-28 15:33:46 +0100390 struct dm_mpath_io *mpio;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700391
392 spin_lock_irqsave(&m->lock, flags);
393
394 /* Do we need to select a new pgpath? */
395 if (!m->current_pgpath ||
396 (!m->queue_io && (m->repeat_count && --m->repeat_count == 0)))
Kiyoshi Ueda02ab8232009-06-22 10:12:27 +0100397 __choose_pgpath(m, nr_bytes);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700398
399 pgpath = m->current_pgpath;
400
Hannes Reineckee8099172014-02-28 15:33:44 +0100401 if (pgpath) {
402 if (pg_ready(m)) {
Hannes Reineckee3bde042014-02-28 15:33:46 +0100403 if (set_mapinfo(m, map_context) < 0)
404 /* ENOMEM, requeue */
405 goto out_unlock;
406
Hannes Reineckee8099172014-02-28 15:33:44 +0100407 bdev = pgpath->path.dev->bdev;
408 clone->q = bdev_get_queue(bdev);
409 clone->rq_disk = bdev->bd_disk;
Hannes Reineckee3bde042014-02-28 15:33:46 +0100410 clone->cmd_flags |= REQ_FAILFAST_TRANSPORT;
411 mpio = map_context->ptr;
Hannes Reineckee8099172014-02-28 15:33:44 +0100412 mpio->pgpath = pgpath;
413 mpio->nr_bytes = nr_bytes;
414 if (pgpath->pg->ps.type->start_io)
415 pgpath->pg->ps.type->start_io(&pgpath->pg->ps,
416 &pgpath->path,
417 nr_bytes);
Hannes Reineckee3bde042014-02-28 15:33:46 +0100418 r = DM_MAPIO_REMAPPED;
419 goto out_unlock;
Hannes Reineckee8099172014-02-28 15:33:44 +0100420 }
Hannes Reineckee3bde042014-02-28 15:33:46 +0100421 __pg_init_all_paths(m);
422 } else if (!__must_push_back(m))
423 r = -EIO; /* Failed */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700424
Hannes Reineckee3bde042014-02-28 15:33:46 +0100425out_unlock:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700426 spin_unlock_irqrestore(&m->lock, flags);
427
428 return r;
429}
430
431/*
432 * If we run out of usable paths, should we queue I/O or error it?
433 */
Alasdair G Kergon485ef692005-09-27 21:45:45 -0700434static int queue_if_no_path(struct multipath *m, unsigned queue_if_no_path,
435 unsigned save_old_value)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700436{
437 unsigned long flags;
438
439 spin_lock_irqsave(&m->lock, flags);
440
Alasdair G Kergon485ef692005-09-27 21:45:45 -0700441 if (save_old_value)
442 m->saved_queue_if_no_path = m->queue_if_no_path;
443 else
444 m->saved_queue_if_no_path = queue_if_no_path;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700445 m->queue_if_no_path = queue_if_no_path;
Hannes Reineckee8099172014-02-28 15:33:44 +0100446 if (!m->queue_if_no_path)
Hannes Reinecke3e9f1be2014-02-28 15:33:45 +0100447 dm_table_run_md_queue_async(m->ti->table);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700448
449 spin_unlock_irqrestore(&m->lock, flags);
450
451 return 0;
452}
453
Linus Torvalds1da177e2005-04-16 15:20:36 -0700454/*
455 * An event is triggered whenever a path is taken out of use.
456 * Includes path failure and PG bypass.
457 */
David Howellsc4028952006-11-22 14:57:56 +0000458static void trigger_event(struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700459{
David Howellsc4028952006-11-22 14:57:56 +0000460 struct multipath *m =
461 container_of(work, struct multipath, trigger_event);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700462
463 dm_table_event(m->ti->table);
464}
465
466/*-----------------------------------------------------------------
467 * Constructor/argument parsing:
468 * <#multipath feature args> [<arg>]*
469 * <#hw_handler args> [hw_handler [<arg>]*]
470 * <#priority groups>
471 * <initial priority group>
472 * [<selector> <#selector args> [<arg>]*
473 * <#paths> <#per-path selector args>
474 * [<path> [<arg>]* ]+ ]+
475 *---------------------------------------------------------------*/
Mike Snitzer498f0102011-08-02 12:32:04 +0100476static int parse_path_selector(struct dm_arg_set *as, struct priority_group *pg,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700477 struct dm_target *ti)
478{
479 int r;
480 struct path_selector_type *pst;
481 unsigned ps_argc;
482
Mike Snitzer498f0102011-08-02 12:32:04 +0100483 static struct dm_arg _args[] = {
Alasdair G Kergon72d94862006-06-26 00:27:35 -0700484 {0, 1024, "invalid number of path selector args"},
Linus Torvalds1da177e2005-04-16 15:20:36 -0700485 };
486
Mike Snitzer498f0102011-08-02 12:32:04 +0100487 pst = dm_get_path_selector(dm_shift_arg(as));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700488 if (!pst) {
Alasdair G Kergon72d94862006-06-26 00:27:35 -0700489 ti->error = "unknown path selector type";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700490 return -EINVAL;
491 }
492
Mike Snitzer498f0102011-08-02 12:32:04 +0100493 r = dm_read_arg_group(_args, as, &ps_argc, &ti->error);
Mikulas Patocka371b2e32008-07-21 12:00:24 +0100494 if (r) {
495 dm_put_path_selector(pst);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700496 return -EINVAL;
Mikulas Patocka371b2e32008-07-21 12:00:24 +0100497 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700498
499 r = pst->create(&pg->ps, ps_argc, as->argv);
500 if (r) {
501 dm_put_path_selector(pst);
Alasdair G Kergon72d94862006-06-26 00:27:35 -0700502 ti->error = "path selector constructor failed";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700503 return r;
504 }
505
506 pg->ps.type = pst;
Mike Snitzer498f0102011-08-02 12:32:04 +0100507 dm_consume_args(as, ps_argc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700508
509 return 0;
510}
511
Mike Snitzer498f0102011-08-02 12:32:04 +0100512static struct pgpath *parse_path(struct dm_arg_set *as, struct path_selector *ps,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700513 struct dm_target *ti)
514{
515 int r;
516 struct pgpath *p;
Hannes Reineckeae11b1b2008-07-17 17:49:02 -0700517 struct multipath *m = ti->private;
Mike Snitzera58a9352012-07-27 15:08:04 +0100518 struct request_queue *q = NULL;
519 const char *attached_handler_name;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700520
521 /* we need at least a path arg */
522 if (as->argc < 1) {
Alasdair G Kergon72d94862006-06-26 00:27:35 -0700523 ti->error = "no device given";
Benjamin Marzinski01460f32008-10-10 13:36:57 +0100524 return ERR_PTR(-EINVAL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700525 }
526
527 p = alloc_pgpath();
528 if (!p)
Benjamin Marzinski01460f32008-10-10 13:36:57 +0100529 return ERR_PTR(-ENOMEM);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700530
Mike Snitzer498f0102011-08-02 12:32:04 +0100531 r = dm_get_device(ti, dm_shift_arg(as), dm_table_get_mode(ti->table),
Nikanth Karthikesan8215d6e2010-03-06 02:32:27 +0000532 &p->path.dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700533 if (r) {
Alasdair G Kergon72d94862006-06-26 00:27:35 -0700534 ti->error = "error getting device";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700535 goto bad;
536 }
537
Mike Snitzera58a9352012-07-27 15:08:04 +0100538 if (m->retain_attached_hw_handler || m->hw_handler_name)
539 q = bdev_get_queue(p->path.dev->bdev);
Hannes Reineckea0cf7ea2009-06-22 10:12:11 +0100540
Mike Snitzera58a9352012-07-27 15:08:04 +0100541 if (m->retain_attached_hw_handler) {
542 attached_handler_name = scsi_dh_attached_handler_name(q, GFP_KERNEL);
543 if (attached_handler_name) {
544 /*
545 * Reset hw_handler_name to match the attached handler
546 * and clear any hw_handler_params associated with the
547 * ignored handler.
548 *
549 * NB. This modifies the table line to show the actual
550 * handler instead of the original table passed in.
551 */
552 kfree(m->hw_handler_name);
553 m->hw_handler_name = attached_handler_name;
554
555 kfree(m->hw_handler_params);
556 m->hw_handler_params = NULL;
557 }
558 }
559
560 if (m->hw_handler_name) {
561 /*
562 * Increments scsi_dh reference, even when using an
563 * already-attached handler.
564 */
Hannes Reineckea0cf7ea2009-06-22 10:12:11 +0100565 r = scsi_dh_attach(q, m->hw_handler_name);
566 if (r == -EBUSY) {
567 /*
Mike Snitzera58a9352012-07-27 15:08:04 +0100568 * Already attached to different hw_handler:
Hannes Reineckea0cf7ea2009-06-22 10:12:11 +0100569 * try to reattach with correct one.
570 */
571 scsi_dh_detach(q);
572 r = scsi_dh_attach(q, m->hw_handler_name);
573 }
574
Hannes Reineckeae11b1b2008-07-17 17:49:02 -0700575 if (r < 0) {
Hannes Reineckea0cf7ea2009-06-22 10:12:11 +0100576 ti->error = "error attaching hardware handler";
Hannes Reineckeae11b1b2008-07-17 17:49:02 -0700577 dm_put_device(ti, p->path.dev);
578 goto bad;
579 }
Chandra Seetharaman2bfd2e12009-08-03 12:42:45 -0700580
581 if (m->hw_handler_params) {
582 r = scsi_dh_set_params(q, m->hw_handler_params);
583 if (r < 0) {
584 ti->error = "unable to set hardware "
585 "handler parameters";
586 scsi_dh_detach(q);
587 dm_put_device(ti, p->path.dev);
588 goto bad;
589 }
590 }
Hannes Reineckeae11b1b2008-07-17 17:49:02 -0700591 }
592
Linus Torvalds1da177e2005-04-16 15:20:36 -0700593 r = ps->type->add_path(ps, &p->path, as->argc, as->argv, &ti->error);
594 if (r) {
595 dm_put_device(ti, p->path.dev);
596 goto bad;
597 }
598
599 return p;
600
601 bad:
602 free_pgpath(p);
Benjamin Marzinski01460f32008-10-10 13:36:57 +0100603 return ERR_PTR(r);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700604}
605
Mike Snitzer498f0102011-08-02 12:32:04 +0100606static struct priority_group *parse_priority_group(struct dm_arg_set *as,
Micha³ Miros³aw28f16c22006-10-03 01:15:33 -0700607 struct multipath *m)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700608{
Mike Snitzer498f0102011-08-02 12:32:04 +0100609 static struct dm_arg _args[] = {
Alasdair G Kergon72d94862006-06-26 00:27:35 -0700610 {1, 1024, "invalid number of paths"},
611 {0, 1024, "invalid number of selector args"}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700612 };
613
614 int r;
Mike Snitzer498f0102011-08-02 12:32:04 +0100615 unsigned i, nr_selector_args, nr_args;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700616 struct priority_group *pg;
Micha³ Miros³aw28f16c22006-10-03 01:15:33 -0700617 struct dm_target *ti = m->ti;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700618
619 if (as->argc < 2) {
620 as->argc = 0;
Benjamin Marzinski01460f32008-10-10 13:36:57 +0100621 ti->error = "not enough priority group arguments";
622 return ERR_PTR(-EINVAL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700623 }
624
625 pg = alloc_priority_group();
626 if (!pg) {
Alasdair G Kergon72d94862006-06-26 00:27:35 -0700627 ti->error = "couldn't allocate priority group";
Benjamin Marzinski01460f32008-10-10 13:36:57 +0100628 return ERR_PTR(-ENOMEM);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700629 }
630 pg->m = m;
631
632 r = parse_path_selector(as, pg, ti);
633 if (r)
634 goto bad;
635
636 /*
637 * read the paths
638 */
Mike Snitzer498f0102011-08-02 12:32:04 +0100639 r = dm_read_arg(_args, as, &pg->nr_pgpaths, &ti->error);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700640 if (r)
641 goto bad;
642
Mike Snitzer498f0102011-08-02 12:32:04 +0100643 r = dm_read_arg(_args + 1, as, &nr_selector_args, &ti->error);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700644 if (r)
645 goto bad;
646
Mike Snitzer498f0102011-08-02 12:32:04 +0100647 nr_args = 1 + nr_selector_args;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700648 for (i = 0; i < pg->nr_pgpaths; i++) {
649 struct pgpath *pgpath;
Mike Snitzer498f0102011-08-02 12:32:04 +0100650 struct dm_arg_set path_args;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700651
Mike Snitzer498f0102011-08-02 12:32:04 +0100652 if (as->argc < nr_args) {
Mikulas Patocka148acff2008-07-21 12:00:30 +0100653 ti->error = "not enough path parameters";
Alasdair G Kergon6bbf79a2010-08-12 04:13:49 +0100654 r = -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700655 goto bad;
Mikulas Patocka148acff2008-07-21 12:00:30 +0100656 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700657
Mike Snitzer498f0102011-08-02 12:32:04 +0100658 path_args.argc = nr_args;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700659 path_args.argv = as->argv;
660
661 pgpath = parse_path(&path_args, &pg->ps, ti);
Benjamin Marzinski01460f32008-10-10 13:36:57 +0100662 if (IS_ERR(pgpath)) {
663 r = PTR_ERR(pgpath);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700664 goto bad;
Benjamin Marzinski01460f32008-10-10 13:36:57 +0100665 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700666
667 pgpath->pg = pg;
668 list_add_tail(&pgpath->list, &pg->pgpaths);
Mike Snitzer498f0102011-08-02 12:32:04 +0100669 dm_consume_args(as, nr_args);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700670 }
671
672 return pg;
673
674 bad:
675 free_priority_group(pg, ti);
Benjamin Marzinski01460f32008-10-10 13:36:57 +0100676 return ERR_PTR(r);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700677}
678
Mike Snitzer498f0102011-08-02 12:32:04 +0100679static int parse_hw_handler(struct dm_arg_set *as, struct multipath *m)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700680{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700681 unsigned hw_argc;
Chandra Seetharaman2bfd2e12009-08-03 12:42:45 -0700682 int ret;
Micha³ Miros³aw28f16c22006-10-03 01:15:33 -0700683 struct dm_target *ti = m->ti;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700684
Mike Snitzer498f0102011-08-02 12:32:04 +0100685 static struct dm_arg _args[] = {
Alasdair G Kergon72d94862006-06-26 00:27:35 -0700686 {0, 1024, "invalid number of hardware handler args"},
Linus Torvalds1da177e2005-04-16 15:20:36 -0700687 };
688
Mike Snitzer498f0102011-08-02 12:32:04 +0100689 if (dm_read_arg_group(_args, as, &hw_argc, &ti->error))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700690 return -EINVAL;
691
692 if (!hw_argc)
693 return 0;
694
Mike Snitzer498f0102011-08-02 12:32:04 +0100695 m->hw_handler_name = kstrdup(dm_shift_arg(as), GFP_KERNEL);
Mike Snitzer510193a2012-05-12 01:43:21 +0100696 if (!try_then_request_module(scsi_dh_handler_exist(m->hw_handler_name),
697 "scsi_dh_%s", m->hw_handler_name)) {
Alasdair G Kergon72d94862006-06-26 00:27:35 -0700698 ti->error = "unknown hardware handler type";
Chandra Seetharaman2bfd2e12009-08-03 12:42:45 -0700699 ret = -EINVAL;
700 goto fail;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700701 }
Chandra Seetharaman14e98c52008-11-13 23:39:06 +0000702
Chandra Seetharaman2bfd2e12009-08-03 12:42:45 -0700703 if (hw_argc > 1) {
704 char *p;
705 int i, j, len = 4;
706
707 for (i = 0; i <= hw_argc - 2; i++)
708 len += strlen(as->argv[i]) + 1;
709 p = m->hw_handler_params = kzalloc(len, GFP_KERNEL);
710 if (!p) {
711 ti->error = "memory allocation failed";
712 ret = -ENOMEM;
713 goto fail;
714 }
715 j = sprintf(p, "%d", hw_argc - 1);
716 for (i = 0, p+=j+1; i <= hw_argc - 2; i++, p+=j+1)
717 j = sprintf(p, "%s", as->argv[i]);
718 }
Mike Snitzer498f0102011-08-02 12:32:04 +0100719 dm_consume_args(as, hw_argc - 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700720
721 return 0;
Chandra Seetharaman2bfd2e12009-08-03 12:42:45 -0700722fail:
723 kfree(m->hw_handler_name);
724 m->hw_handler_name = NULL;
725 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700726}
727
Mike Snitzer498f0102011-08-02 12:32:04 +0100728static int parse_features(struct dm_arg_set *as, struct multipath *m)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700729{
730 int r;
731 unsigned argc;
Micha³ Miros³aw28f16c22006-10-03 01:15:33 -0700732 struct dm_target *ti = m->ti;
Mike Snitzer498f0102011-08-02 12:32:04 +0100733 const char *arg_name;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700734
Mike Snitzer498f0102011-08-02 12:32:04 +0100735 static struct dm_arg _args[] = {
Mike Snitzera58a9352012-07-27 15:08:04 +0100736 {0, 6, "invalid number of feature args"},
Dave Wysochanskic9e45582007-10-19 22:47:53 +0100737 {1, 50, "pg_init_retries must be between 1 and 50"},
Chandra Seetharaman4e2d19e2011-01-13 20:00:01 +0000738 {0, 60000, "pg_init_delay_msecs must be between 0 and 60000"},
Linus Torvalds1da177e2005-04-16 15:20:36 -0700739 };
740
Mike Snitzer498f0102011-08-02 12:32:04 +0100741 r = dm_read_arg_group(_args, as, &argc, &ti->error);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700742 if (r)
743 return -EINVAL;
744
745 if (!argc)
746 return 0;
747
Dave Wysochanskic9e45582007-10-19 22:47:53 +0100748 do {
Mike Snitzer498f0102011-08-02 12:32:04 +0100749 arg_name = dm_shift_arg(as);
Dave Wysochanskic9e45582007-10-19 22:47:53 +0100750 argc--;
751
Mike Snitzer498f0102011-08-02 12:32:04 +0100752 if (!strcasecmp(arg_name, "queue_if_no_path")) {
Dave Wysochanskic9e45582007-10-19 22:47:53 +0100753 r = queue_if_no_path(m, 1, 0);
754 continue;
755 }
756
Mike Snitzera58a9352012-07-27 15:08:04 +0100757 if (!strcasecmp(arg_name, "retain_attached_hw_handler")) {
758 m->retain_attached_hw_handler = 1;
759 continue;
760 }
761
Mike Snitzer498f0102011-08-02 12:32:04 +0100762 if (!strcasecmp(arg_name, "pg_init_retries") &&
Dave Wysochanskic9e45582007-10-19 22:47:53 +0100763 (argc >= 1)) {
Mike Snitzer498f0102011-08-02 12:32:04 +0100764 r = dm_read_arg(_args + 1, as, &m->pg_init_retries, &ti->error);
Dave Wysochanskic9e45582007-10-19 22:47:53 +0100765 argc--;
766 continue;
767 }
768
Mike Snitzer498f0102011-08-02 12:32:04 +0100769 if (!strcasecmp(arg_name, "pg_init_delay_msecs") &&
Chandra Seetharaman4e2d19e2011-01-13 20:00:01 +0000770 (argc >= 1)) {
Mike Snitzer498f0102011-08-02 12:32:04 +0100771 r = dm_read_arg(_args + 2, as, &m->pg_init_delay_msecs, &ti->error);
Chandra Seetharaman4e2d19e2011-01-13 20:00:01 +0000772 argc--;
773 continue;
774 }
775
Linus Torvalds1da177e2005-04-16 15:20:36 -0700776 ti->error = "Unrecognised multipath feature request";
Dave Wysochanskic9e45582007-10-19 22:47:53 +0100777 r = -EINVAL;
778 } while (argc && !r);
779
780 return r;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700781}
782
783static int multipath_ctr(struct dm_target *ti, unsigned int argc,
784 char **argv)
785{
Mike Snitzer498f0102011-08-02 12:32:04 +0100786 /* target arguments */
787 static struct dm_arg _args[] = {
Mike Snitzera490a072011-03-24 13:54:33 +0000788 {0, 1024, "invalid number of priority groups"},
789 {0, 1024, "invalid initial priority group number"},
Linus Torvalds1da177e2005-04-16 15:20:36 -0700790 };
791
792 int r;
793 struct multipath *m;
Mike Snitzer498f0102011-08-02 12:32:04 +0100794 struct dm_arg_set as;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700795 unsigned pg_count = 0;
796 unsigned next_pg_num;
797
798 as.argc = argc;
799 as.argv = argv;
800
Micha³ Miros³aw28f16c22006-10-03 01:15:33 -0700801 m = alloc_multipath(ti);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700802 if (!m) {
Alasdair G Kergon72d94862006-06-26 00:27:35 -0700803 ti->error = "can't allocate multipath";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700804 return -EINVAL;
805 }
806
Micha³ Miros³aw28f16c22006-10-03 01:15:33 -0700807 r = parse_features(&as, m);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700808 if (r)
809 goto bad;
810
Micha³ Miros³aw28f16c22006-10-03 01:15:33 -0700811 r = parse_hw_handler(&as, m);
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, &as, &m->nr_priority_groups, &ti->error);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700816 if (r)
817 goto bad;
818
Mike Snitzer498f0102011-08-02 12:32:04 +0100819 r = dm_read_arg(_args + 1, &as, &next_pg_num, &ti->error);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700820 if (r)
821 goto bad;
822
Mike Snitzera490a072011-03-24 13:54:33 +0000823 if ((!m->nr_priority_groups && next_pg_num) ||
824 (m->nr_priority_groups && !next_pg_num)) {
825 ti->error = "invalid initial priority group";
826 r = -EINVAL;
827 goto bad;
828 }
829
Linus Torvalds1da177e2005-04-16 15:20:36 -0700830 /* parse the priority groups */
831 while (as.argc) {
832 struct priority_group *pg;
833
Micha³ Miros³aw28f16c22006-10-03 01:15:33 -0700834 pg = parse_priority_group(&as, m);
Benjamin Marzinski01460f32008-10-10 13:36:57 +0100835 if (IS_ERR(pg)) {
836 r = PTR_ERR(pg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700837 goto bad;
838 }
839
840 m->nr_valid_paths += pg->nr_pgpaths;
841 list_add_tail(&pg->list, &m->priority_groups);
842 pg_count++;
843 pg->pg_num = pg_count;
844 if (!--next_pg_num)
845 m->next_pg = pg;
846 }
847
848 if (pg_count != m->nr_priority_groups) {
Alasdair G Kergon72d94862006-06-26 00:27:35 -0700849 ti->error = "priority group count mismatch";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700850 r = -EINVAL;
851 goto bad;
852 }
853
Alasdair G Kergon55a62ee2013-03-01 22:45:47 +0000854 ti->num_flush_bios = 1;
855 ti->num_discard_bios = 1;
Mike Snitzer042bcef2013-05-10 14:37:16 +0100856 ti->num_write_same_bios = 1;
Mikulas Patocka86279212009-06-22 10:12:24 +0100857
Linus Torvalds1da177e2005-04-16 15:20:36 -0700858 return 0;
859
860 bad:
861 free_multipath(m);
862 return r;
863}
864
Kiyoshi Ueda2bded7b2010-03-06 02:32:13 +0000865static void multipath_wait_for_pg_init_completion(struct multipath *m)
866{
867 DECLARE_WAITQUEUE(wait, current);
868 unsigned long flags;
869
870 add_wait_queue(&m->pg_init_wait, &wait);
871
872 while (1) {
873 set_current_state(TASK_UNINTERRUPTIBLE);
874
875 spin_lock_irqsave(&m->lock, flags);
876 if (!m->pg_init_in_progress) {
877 spin_unlock_irqrestore(&m->lock, flags);
878 break;
879 }
880 spin_unlock_irqrestore(&m->lock, flags);
881
882 io_schedule();
883 }
884 set_current_state(TASK_RUNNING);
885
886 remove_wait_queue(&m->pg_init_wait, &wait);
887}
888
889static void flush_multipath_work(struct multipath *m)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700890{
Shiva Krishna Merla954a73d2013-10-30 03:26:38 +0000891 unsigned long flags;
892
893 spin_lock_irqsave(&m->lock, flags);
894 m->pg_init_disabled = 1;
895 spin_unlock_irqrestore(&m->lock, flags);
896
Chandra Seetharamanbab7cfc2008-05-01 14:50:22 -0700897 flush_workqueue(kmpath_handlerd);
Kiyoshi Ueda2bded7b2010-03-06 02:32:13 +0000898 multipath_wait_for_pg_init_completion(m);
Alasdair G Kergona044d012005-07-12 15:53:02 -0700899 flush_workqueue(kmultipathd);
Tejun Heo43829732012-08-20 14:51:24 -0700900 flush_work(&m->trigger_event);
Shiva Krishna Merla954a73d2013-10-30 03:26:38 +0000901
902 spin_lock_irqsave(&m->lock, flags);
903 m->pg_init_disabled = 0;
904 spin_unlock_irqrestore(&m->lock, flags);
Kiyoshi Ueda6df400a2009-12-10 23:52:19 +0000905}
906
907static void multipath_dtr(struct dm_target *ti)
908{
909 struct multipath *m = ti->private;
910
Kiyoshi Ueda2bded7b2010-03-06 02:32:13 +0000911 flush_multipath_work(m);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700912 free_multipath(m);
913}
914
915/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700916 * Take a path out of use.
917 */
918static int fail_path(struct pgpath *pgpath)
919{
920 unsigned long flags;
921 struct multipath *m = pgpath->pg->m;
922
923 spin_lock_irqsave(&m->lock, flags);
924
Kiyoshi Ueda66800732008-10-10 13:36:58 +0100925 if (!pgpath->is_active)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700926 goto out;
927
Alasdair G Kergon72d94862006-06-26 00:27:35 -0700928 DMWARN("Failing path %s.", pgpath->path.dev->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700929
930 pgpath->pg->ps.type->fail_path(&pgpath->pg->ps, &pgpath->path);
Kiyoshi Ueda66800732008-10-10 13:36:58 +0100931 pgpath->is_active = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700932 pgpath->fail_count++;
933
934 m->nr_valid_paths--;
935
936 if (pgpath == m->current_pgpath)
937 m->current_pgpath = NULL;
938
Mike Andersonb15546f2007-10-19 22:48:02 +0100939 dm_path_uevent(DM_UEVENT_PATH_FAILED, m->ti,
940 pgpath->path.dev->name, m->nr_valid_paths);
941
Alasdair G Kergonfe9cf302009-01-06 03:05:13 +0000942 schedule_work(&m->trigger_event);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700943
944out:
945 spin_unlock_irqrestore(&m->lock, flags);
946
947 return 0;
948}
949
950/*
951 * Reinstate a previously-failed path
952 */
953static int reinstate_path(struct pgpath *pgpath)
954{
955 int r = 0;
956 unsigned long flags;
957 struct multipath *m = pgpath->pg->m;
958
959 spin_lock_irqsave(&m->lock, flags);
960
Kiyoshi Ueda66800732008-10-10 13:36:58 +0100961 if (pgpath->is_active)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700962 goto out;
963
Alasdair G Kergondef052d2008-07-21 12:00:31 +0100964 if (!pgpath->pg->ps.type->reinstate_path) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700965 DMWARN("Reinstate path not supported by path selector %s",
966 pgpath->pg->ps.type->name);
967 r = -EINVAL;
968 goto out;
969 }
970
971 r = pgpath->pg->ps.type->reinstate_path(&pgpath->pg->ps, &pgpath->path);
972 if (r)
973 goto out;
974
Kiyoshi Ueda66800732008-10-10 13:36:58 +0100975 pgpath->is_active = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700976
Hannes Reineckee8099172014-02-28 15:33:44 +0100977 if (!m->nr_valid_paths++) {
Chandra Seetharamane54f77d2009-06-22 10:12:12 +0100978 m->current_pgpath = NULL;
Hannes Reinecke3e9f1be2014-02-28 15:33:45 +0100979 dm_table_run_md_queue_async(m->ti->table);
Chandra Seetharamane54f77d2009-06-22 10:12:12 +0100980 } else if (m->hw_handler_name && (m->current_pg == pgpath->pg)) {
Chandra Seetharaman4e2d19e2011-01-13 20:00:01 +0000981 if (queue_work(kmpath_handlerd, &pgpath->activate_path.work))
Chandra Seetharamane54f77d2009-06-22 10:12:12 +0100982 m->pg_init_in_progress++;
983 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700984
Mike Andersonb15546f2007-10-19 22:48:02 +0100985 dm_path_uevent(DM_UEVENT_PATH_REINSTATED, m->ti,
986 pgpath->path.dev->name, m->nr_valid_paths);
987
Alasdair G Kergonfe9cf302009-01-06 03:05:13 +0000988 schedule_work(&m->trigger_event);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700989
990out:
991 spin_unlock_irqrestore(&m->lock, flags);
992
993 return r;
994}
995
996/*
997 * Fail or reinstate all paths that match the provided struct dm_dev.
998 */
999static int action_dev(struct multipath *m, struct dm_dev *dev,
1000 action_fn action)
1001{
Mike Snitzer19040c02011-03-24 13:54:31 +00001002 int r = -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001003 struct pgpath *pgpath;
1004 struct priority_group *pg;
1005
1006 list_for_each_entry(pg, &m->priority_groups, list) {
1007 list_for_each_entry(pgpath, &pg->pgpaths, list) {
1008 if (pgpath->path.dev == dev)
1009 r = action(pgpath);
1010 }
1011 }
1012
1013 return r;
1014}
1015
1016/*
1017 * Temporarily try to avoid having to use the specified PG
1018 */
1019static void bypass_pg(struct multipath *m, struct priority_group *pg,
1020 int bypassed)
1021{
1022 unsigned long flags;
1023
1024 spin_lock_irqsave(&m->lock, flags);
1025
1026 pg->bypassed = bypassed;
1027 m->current_pgpath = NULL;
1028 m->current_pg = NULL;
1029
1030 spin_unlock_irqrestore(&m->lock, flags);
1031
Alasdair G Kergonfe9cf302009-01-06 03:05:13 +00001032 schedule_work(&m->trigger_event);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001033}
1034
1035/*
1036 * Switch to using the specified PG from the next I/O that gets mapped
1037 */
1038static int switch_pg_num(struct multipath *m, const char *pgstr)
1039{
1040 struct priority_group *pg;
1041 unsigned pgnum;
1042 unsigned long flags;
Mikulas Patocka31998ef2012-03-28 18:41:26 +01001043 char dummy;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001044
Mikulas Patocka31998ef2012-03-28 18:41:26 +01001045 if (!pgstr || (sscanf(pgstr, "%u%c", &pgnum, &dummy) != 1) || !pgnum ||
Linus Torvalds1da177e2005-04-16 15:20:36 -07001046 (pgnum > m->nr_priority_groups)) {
1047 DMWARN("invalid PG number supplied to switch_pg_num");
1048 return -EINVAL;
1049 }
1050
1051 spin_lock_irqsave(&m->lock, flags);
1052 list_for_each_entry(pg, &m->priority_groups, list) {
1053 pg->bypassed = 0;
1054 if (--pgnum)
1055 continue;
1056
1057 m->current_pgpath = NULL;
1058 m->current_pg = NULL;
1059 m->next_pg = pg;
1060 }
1061 spin_unlock_irqrestore(&m->lock, flags);
1062
Alasdair G Kergonfe9cf302009-01-06 03:05:13 +00001063 schedule_work(&m->trigger_event);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001064 return 0;
1065}
1066
1067/*
1068 * Set/clear bypassed status of a PG.
1069 * PGs are numbered upwards from 1 in the order they were declared.
1070 */
1071static int bypass_pg_num(struct multipath *m, const char *pgstr, int bypassed)
1072{
1073 struct priority_group *pg;
1074 unsigned pgnum;
Mikulas Patocka31998ef2012-03-28 18:41:26 +01001075 char dummy;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001076
Mikulas Patocka31998ef2012-03-28 18:41:26 +01001077 if (!pgstr || (sscanf(pgstr, "%u%c", &pgnum, &dummy) != 1) || !pgnum ||
Linus Torvalds1da177e2005-04-16 15:20:36 -07001078 (pgnum > m->nr_priority_groups)) {
1079 DMWARN("invalid PG number supplied to bypass_pg");
1080 return -EINVAL;
1081 }
1082
1083 list_for_each_entry(pg, &m->priority_groups, list) {
1084 if (!--pgnum)
1085 break;
1086 }
1087
1088 bypass_pg(m, pg, bypassed);
1089 return 0;
1090}
1091
1092/*
Dave Wysochanskic9e45582007-10-19 22:47:53 +01001093 * Should we retry pg_init immediately?
1094 */
1095static int pg_init_limit_reached(struct multipath *m, struct pgpath *pgpath)
1096{
1097 unsigned long flags;
1098 int limit_reached = 0;
1099
1100 spin_lock_irqsave(&m->lock, flags);
1101
Shiva Krishna Merla954a73d2013-10-30 03:26:38 +00001102 if (m->pg_init_count <= m->pg_init_retries && !m->pg_init_disabled)
Dave Wysochanskic9e45582007-10-19 22:47:53 +01001103 m->pg_init_required = 1;
1104 else
1105 limit_reached = 1;
1106
1107 spin_unlock_irqrestore(&m->lock, flags);
1108
1109 return limit_reached;
1110}
1111
Chandra Seetharaman3ae31f62009-10-21 09:22:46 -07001112static void pg_init_done(void *data, int errors)
Chandra Seetharamancfae5c92008-05-01 14:50:11 -07001113{
Moger, Babu83c0d5d2010-03-06 02:29:45 +00001114 struct pgpath *pgpath = data;
Chandra Seetharamancfae5c92008-05-01 14:50:11 -07001115 struct priority_group *pg = pgpath->pg;
1116 struct multipath *m = pg->m;
1117 unsigned long flags;
Chandra Seetharaman4e2d19e2011-01-13 20:00:01 +00001118 unsigned delay_retry = 0;
Chandra Seetharamancfae5c92008-05-01 14:50:11 -07001119
1120 /* device or driver problems */
1121 switch (errors) {
1122 case SCSI_DH_OK:
1123 break;
1124 case SCSI_DH_NOSYS:
1125 if (!m->hw_handler_name) {
1126 errors = 0;
1127 break;
1128 }
Moger, Babuf7b934c2010-03-06 02:29:49 +00001129 DMERR("Could not failover the device: Handler scsi_dh_%s "
1130 "Error %d.", m->hw_handler_name, errors);
Chandra Seetharamancfae5c92008-05-01 14:50:11 -07001131 /*
1132 * Fail path for now, so we do not ping pong
1133 */
1134 fail_path(pgpath);
1135 break;
1136 case SCSI_DH_DEV_TEMP_BUSY:
1137 /*
1138 * Probably doing something like FW upgrade on the
1139 * controller so try the other pg.
1140 */
1141 bypass_pg(m, pg, 1);
1142 break;
Chandra Seetharamancfae5c92008-05-01 14:50:11 -07001143 case SCSI_DH_RETRY:
Chandra Seetharaman4e2d19e2011-01-13 20:00:01 +00001144 /* Wait before retrying. */
1145 delay_retry = 1;
Chandra Seetharamancfae5c92008-05-01 14:50:11 -07001146 case SCSI_DH_IMM_RETRY:
1147 case SCSI_DH_RES_TEMP_UNAVAIL:
1148 if (pg_init_limit_reached(m, pgpath))
1149 fail_path(pgpath);
1150 errors = 0;
1151 break;
1152 default:
1153 /*
1154 * We probably do not want to fail the path for a device
1155 * error, but this is what the old dm did. In future
1156 * patches we can do more advanced handling.
1157 */
1158 fail_path(pgpath);
1159 }
1160
1161 spin_lock_irqsave(&m->lock, flags);
1162 if (errors) {
Chandra Seetharamane54f77d2009-06-22 10:12:12 +01001163 if (pgpath == m->current_pgpath) {
1164 DMERR("Could not failover device. Error %d.", errors);
1165 m->current_pgpath = NULL;
1166 m->current_pg = NULL;
1167 }
Kiyoshi Uedad0259bf2010-03-06 02:30:02 +00001168 } else if (!m->pg_init_required)
Chandra Seetharamancfae5c92008-05-01 14:50:11 -07001169 pg->bypassed = 0;
Chandra Seetharamancfae5c92008-05-01 14:50:11 -07001170
Kiyoshi Uedad0259bf2010-03-06 02:30:02 +00001171 if (--m->pg_init_in_progress)
1172 /* Activations of other paths are still on going */
1173 goto out;
1174
Hannes Reinecke3e9f1be2014-02-28 15:33:45 +01001175 if (m->pg_init_required) {
1176 m->pg_init_delay_retry = delay_retry;
1177 if (__pg_init_all_paths(m))
1178 goto out;
1179 }
1180 m->queue_io = 0;
Kiyoshi Uedad0259bf2010-03-06 02:30:02 +00001181
Kiyoshi Ueda2bded7b2010-03-06 02:32:13 +00001182 /*
1183 * Wake up any thread waiting to suspend.
1184 */
1185 wake_up(&m->pg_init_wait);
1186
Kiyoshi Uedad0259bf2010-03-06 02:30:02 +00001187out:
Chandra Seetharamancfae5c92008-05-01 14:50:11 -07001188 spin_unlock_irqrestore(&m->lock, flags);
1189}
1190
Chandra Seetharamanbab7cfc2008-05-01 14:50:22 -07001191static void activate_path(struct work_struct *work)
1192{
Chandra Seetharamane54f77d2009-06-22 10:12:12 +01001193 struct pgpath *pgpath =
Chandra Seetharaman4e2d19e2011-01-13 20:00:01 +00001194 container_of(work, struct pgpath, activate_path.work);
Chandra Seetharamanbab7cfc2008-05-01 14:50:22 -07001195
Chandra Seetharaman3ae31f62009-10-21 09:22:46 -07001196 scsi_dh_activate(bdev_get_queue(pgpath->path.dev->bdev),
Moger, Babu83c0d5d2010-03-06 02:29:45 +00001197 pg_init_done, pgpath);
Chandra Seetharamanbab7cfc2008-05-01 14:50:22 -07001198}
1199
Hannes Reinecke7e782af2013-07-01 15:16:26 +02001200static int noretry_error(int error)
1201{
1202 switch (error) {
1203 case -EOPNOTSUPP:
1204 case -EREMOTEIO:
1205 case -EILSEQ:
1206 case -ENODATA:
Jun'ichi Nomuracc9d3c32013-09-13 14:54:30 +09001207 case -ENOSPC:
Hannes Reinecke7e782af2013-07-01 15:16:26 +02001208 return 1;
1209 }
1210
1211 /* Anything else could be a path failure, so should be retried */
1212 return 0;
1213}
1214
Linus Torvalds1da177e2005-04-16 15:20:36 -07001215/*
1216 * end_io handling
1217 */
Kiyoshi Uedaf40c67f2009-06-22 10:12:37 +01001218static int do_end_io(struct multipath *m, struct request *clone,
Alasdair G Kergon028867a2007-07-12 17:26:32 +01001219 int error, struct dm_mpath_io *mpio)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001220{
Kiyoshi Uedaf40c67f2009-06-22 10:12:37 +01001221 /*
1222 * We don't queue any clone request inside the multipath target
1223 * during end I/O handling, since those clone requests don't have
1224 * bio clones. If we queue them inside the multipath target,
1225 * we need to make bio clones, that requires memory allocation.
1226 * (See drivers/md/dm.c:end_clone_bio() about why the clone requests
1227 * don't have bio clones.)
1228 * Instead of queueing the clone request here, we queue the original
1229 * request into dm core, which will remake a clone request and
1230 * clone bios for it and resubmit it later.
1231 */
1232 int r = DM_ENDIO_REQUEUE;
Stefan Bader640eb3b2005-11-21 21:32:35 -08001233 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001234
Kiyoshi Uedaf40c67f2009-06-22 10:12:37 +01001235 if (!error && !clone->errors)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001236 return 0; /* I/O complete */
1237
Mike Snitzerf84cb8a2013-09-19 12:13:58 -04001238 if (noretry_error(error)) {
1239 if ((clone->cmd_flags & REQ_WRITE_SAME) &&
1240 !clone->q->limits.max_write_same_sectors) {
1241 struct queue_limits *limits;
1242
1243 /* device doesn't really support WRITE SAME, disable it */
1244 limits = dm_get_queue_limits(dm_table_get_md(m->ti->table));
1245 limits->max_write_same_sectors = 0;
1246 }
Mike Snitzer959eb4e2010-08-12 04:14:32 +01001247 return error;
Mike Snitzerf84cb8a2013-09-19 12:13:58 -04001248 }
Mike Snitzer959eb4e2010-08-12 04:14:32 +01001249
Chandra Seetharamancfae5c92008-05-01 14:50:11 -07001250 if (mpio->pgpath)
1251 fail_path(mpio->pgpath);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001252
Stefan Bader640eb3b2005-11-21 21:32:35 -08001253 spin_lock_irqsave(&m->lock, flags);
Hannes Reinecke751b2a72011-01-18 10:13:12 +01001254 if (!m->nr_valid_paths) {
1255 if (!m->queue_if_no_path) {
1256 if (!__must_push_back(m))
1257 r = -EIO;
1258 } else {
1259 if (error == -EBADE)
1260 r = error;
1261 }
1262 }
Stefan Bader640eb3b2005-11-21 21:32:35 -08001263 spin_unlock_irqrestore(&m->lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001264
Kiyoshi Uedaf40c67f2009-06-22 10:12:37 +01001265 return r;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001266}
1267
Kiyoshi Uedaf40c67f2009-06-22 10:12:37 +01001268static int multipath_end_io(struct dm_target *ti, struct request *clone,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001269 int error, union map_info *map_context)
1270{
Alasdair G Kergon028867a2007-07-12 17:26:32 +01001271 struct multipath *m = ti->private;
1272 struct dm_mpath_io *mpio = map_context->ptr;
Wei Yongjuna71a2612012-10-12 16:59:42 +01001273 struct pgpath *pgpath;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001274 struct path_selector *ps;
1275 int r;
1276
Jun'ichi Nomura466891f2012-03-28 18:41:25 +01001277 BUG_ON(!mpio);
1278
Kiyoshi Uedaf40c67f2009-06-22 10:12:37 +01001279 r = do_end_io(m, clone, error, mpio);
Wei Yongjuna71a2612012-10-12 16:59:42 +01001280 pgpath = mpio->pgpath;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001281 if (pgpath) {
1282 ps = &pgpath->pg->ps;
1283 if (ps->type->end_io)
Kiyoshi Ueda02ab8232009-06-22 10:12:27 +01001284 ps->type->end_io(ps, &pgpath->path, mpio->nr_bytes);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001285 }
Jun'ichi Nomura466891f2012-03-28 18:41:25 +01001286 clear_mapinfo(m, map_context);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001287
1288 return r;
1289}
1290
1291/*
1292 * Suspend can't complete until all the I/O is processed so if
Alasdair G Kergon436d4102005-07-12 15:53:03 -07001293 * the last path fails we must error any remaining I/O.
1294 * Note that if the freeze_bdev fails while suspending, the
1295 * queue_if_no_path state is lost - userspace should reset it.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001296 */
1297static void multipath_presuspend(struct dm_target *ti)
1298{
1299 struct multipath *m = (struct multipath *) ti->private;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001300
Alasdair G Kergon485ef692005-09-27 21:45:45 -07001301 queue_if_no_path(m, 0, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001302}
1303
Kiyoshi Ueda6df400a2009-12-10 23:52:19 +00001304static void multipath_postsuspend(struct dm_target *ti)
1305{
Mike Anderson6380f262009-12-10 23:52:21 +00001306 struct multipath *m = ti->private;
1307
1308 mutex_lock(&m->work_mutex);
Kiyoshi Ueda2bded7b2010-03-06 02:32:13 +00001309 flush_multipath_work(m);
Mike Anderson6380f262009-12-10 23:52:21 +00001310 mutex_unlock(&m->work_mutex);
Kiyoshi Ueda6df400a2009-12-10 23:52:19 +00001311}
1312
Alasdair G Kergon436d4102005-07-12 15:53:03 -07001313/*
1314 * Restore the queue_if_no_path setting.
1315 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001316static void multipath_resume(struct dm_target *ti)
1317{
1318 struct multipath *m = (struct multipath *) ti->private;
1319 unsigned long flags;
1320
1321 spin_lock_irqsave(&m->lock, flags);
Alasdair G Kergon436d4102005-07-12 15:53:03 -07001322 m->queue_if_no_path = m->saved_queue_if_no_path;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001323 spin_unlock_irqrestore(&m->lock, flags);
1324}
1325
1326/*
1327 * Info output has the following format:
1328 * num_multipath_feature_args [multipath_feature_args]*
1329 * num_handler_status_args [handler_status_args]*
1330 * num_groups init_group_number
1331 * [A|D|E num_ps_status_args [ps_status_args]*
1332 * num_paths num_selector_args
1333 * [path_dev A|F fail_count [selector_args]* ]+ ]+
1334 *
1335 * Table output has the following format (identical to the constructor string):
1336 * num_feature_args [features_args]*
1337 * num_handler_args hw_handler [hw_handler_args]*
1338 * num_groups init_group_number
1339 * [priority selector-name num_ps_args [ps_args]*
1340 * num_paths num_selector_args [path_dev [selector_args]* ]+ ]+
1341 */
Mikulas Patockafd7c0922013-03-01 22:45:44 +00001342static void multipath_status(struct dm_target *ti, status_type_t type,
1343 unsigned status_flags, char *result, unsigned maxlen)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001344{
1345 int sz = 0;
1346 unsigned long flags;
1347 struct multipath *m = (struct multipath *) ti->private;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001348 struct priority_group *pg;
1349 struct pgpath *p;
1350 unsigned pg_num;
1351 char state;
1352
1353 spin_lock_irqsave(&m->lock, flags);
1354
1355 /* Features */
1356 if (type == STATUSTYPE_INFO)
Hannes Reineckee8099172014-02-28 15:33:44 +01001357 DMEMIT("2 %u %u ", m->queue_io, m->pg_init_count);
Dave Wysochanskic9e45582007-10-19 22:47:53 +01001358 else {
1359 DMEMIT("%u ", m->queue_if_no_path +
Chandra Seetharaman4e2d19e2011-01-13 20:00:01 +00001360 (m->pg_init_retries > 0) * 2 +
Mike Snitzera58a9352012-07-27 15:08:04 +01001361 (m->pg_init_delay_msecs != DM_PG_INIT_DELAY_DEFAULT) * 2 +
1362 m->retain_attached_hw_handler);
Dave Wysochanskic9e45582007-10-19 22:47:53 +01001363 if (m->queue_if_no_path)
1364 DMEMIT("queue_if_no_path ");
1365 if (m->pg_init_retries)
1366 DMEMIT("pg_init_retries %u ", m->pg_init_retries);
Chandra Seetharaman4e2d19e2011-01-13 20:00:01 +00001367 if (m->pg_init_delay_msecs != DM_PG_INIT_DELAY_DEFAULT)
1368 DMEMIT("pg_init_delay_msecs %u ", m->pg_init_delay_msecs);
Mike Snitzera58a9352012-07-27 15:08:04 +01001369 if (m->retain_attached_hw_handler)
1370 DMEMIT("retain_attached_hw_handler ");
Dave Wysochanskic9e45582007-10-19 22:47:53 +01001371 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001372
Chandra Seetharamancfae5c92008-05-01 14:50:11 -07001373 if (!m->hw_handler_name || type == STATUSTYPE_INFO)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001374 DMEMIT("0 ");
1375 else
Chandra Seetharamancfae5c92008-05-01 14:50:11 -07001376 DMEMIT("1 %s ", m->hw_handler_name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001377
1378 DMEMIT("%u ", m->nr_priority_groups);
1379
1380 if (m->next_pg)
1381 pg_num = m->next_pg->pg_num;
1382 else if (m->current_pg)
1383 pg_num = m->current_pg->pg_num;
1384 else
Mike Snitzera490a072011-03-24 13:54:33 +00001385 pg_num = (m->nr_priority_groups ? 1 : 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001386
1387 DMEMIT("%u ", pg_num);
1388
1389 switch (type) {
1390 case STATUSTYPE_INFO:
1391 list_for_each_entry(pg, &m->priority_groups, list) {
1392 if (pg->bypassed)
1393 state = 'D'; /* Disabled */
1394 else if (pg == m->current_pg)
1395 state = 'A'; /* Currently Active */
1396 else
1397 state = 'E'; /* Enabled */
1398
1399 DMEMIT("%c ", state);
1400
1401 if (pg->ps.type->status)
1402 sz += pg->ps.type->status(&pg->ps, NULL, type,
1403 result + sz,
1404 maxlen - sz);
1405 else
1406 DMEMIT("0 ");
1407
1408 DMEMIT("%u %u ", pg->nr_pgpaths,
1409 pg->ps.type->info_args);
1410
1411 list_for_each_entry(p, &pg->pgpaths, list) {
1412 DMEMIT("%s %s %u ", p->path.dev->name,
Kiyoshi Ueda66800732008-10-10 13:36:58 +01001413 p->is_active ? "A" : "F",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001414 p->fail_count);
1415 if (pg->ps.type->status)
1416 sz += pg->ps.type->status(&pg->ps,
1417 &p->path, type, result + sz,
1418 maxlen - sz);
1419 }
1420 }
1421 break;
1422
1423 case STATUSTYPE_TABLE:
1424 list_for_each_entry(pg, &m->priority_groups, list) {
1425 DMEMIT("%s ", pg->ps.type->name);
1426
1427 if (pg->ps.type->status)
1428 sz += pg->ps.type->status(&pg->ps, NULL, type,
1429 result + sz,
1430 maxlen - sz);
1431 else
1432 DMEMIT("0 ");
1433
1434 DMEMIT("%u %u ", pg->nr_pgpaths,
1435 pg->ps.type->table_args);
1436
1437 list_for_each_entry(p, &pg->pgpaths, list) {
1438 DMEMIT("%s ", p->path.dev->name);
1439 if (pg->ps.type->status)
1440 sz += pg->ps.type->status(&pg->ps,
1441 &p->path, type, result + sz,
1442 maxlen - sz);
1443 }
1444 }
1445 break;
1446 }
1447
1448 spin_unlock_irqrestore(&m->lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001449}
1450
1451static int multipath_message(struct dm_target *ti, unsigned argc, char **argv)
1452{
Mike Anderson6380f262009-12-10 23:52:21 +00001453 int r = -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001454 struct dm_dev *dev;
1455 struct multipath *m = (struct multipath *) ti->private;
1456 action_fn action;
1457
Mike Anderson6380f262009-12-10 23:52:21 +00001458 mutex_lock(&m->work_mutex);
1459
Kiyoshi Uedac2f3d242009-12-10 23:52:27 +00001460 if (dm_suspended(ti)) {
1461 r = -EBUSY;
1462 goto out;
1463 }
1464
Linus Torvalds1da177e2005-04-16 15:20:36 -07001465 if (argc == 1) {
Mike Snitzer498f0102011-08-02 12:32:04 +01001466 if (!strcasecmp(argv[0], "queue_if_no_path")) {
Mike Anderson6380f262009-12-10 23:52:21 +00001467 r = queue_if_no_path(m, 1, 0);
1468 goto out;
Mike Snitzer498f0102011-08-02 12:32:04 +01001469 } else if (!strcasecmp(argv[0], "fail_if_no_path")) {
Mike Anderson6380f262009-12-10 23:52:21 +00001470 r = queue_if_no_path(m, 0, 0);
1471 goto out;
1472 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001473 }
1474
Mike Anderson6380f262009-12-10 23:52:21 +00001475 if (argc != 2) {
1476 DMWARN("Unrecognised multipath message received.");
1477 goto out;
1478 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001479
Mike Snitzer498f0102011-08-02 12:32:04 +01001480 if (!strcasecmp(argv[0], "disable_group")) {
Mike Anderson6380f262009-12-10 23:52:21 +00001481 r = bypass_pg_num(m, argv[1], 1);
1482 goto out;
Mike Snitzer498f0102011-08-02 12:32:04 +01001483 } else if (!strcasecmp(argv[0], "enable_group")) {
Mike Anderson6380f262009-12-10 23:52:21 +00001484 r = bypass_pg_num(m, argv[1], 0);
1485 goto out;
Mike Snitzer498f0102011-08-02 12:32:04 +01001486 } else if (!strcasecmp(argv[0], "switch_group")) {
Mike Anderson6380f262009-12-10 23:52:21 +00001487 r = switch_pg_num(m, argv[1]);
1488 goto out;
Mike Snitzer498f0102011-08-02 12:32:04 +01001489 } else if (!strcasecmp(argv[0], "reinstate_path"))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001490 action = reinstate_path;
Mike Snitzer498f0102011-08-02 12:32:04 +01001491 else if (!strcasecmp(argv[0], "fail_path"))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001492 action = fail_path;
Mike Anderson6380f262009-12-10 23:52:21 +00001493 else {
1494 DMWARN("Unrecognised multipath message received.");
1495 goto out;
1496 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001497
Nikanth Karthikesan8215d6e2010-03-06 02:32:27 +00001498 r = dm_get_device(ti, argv[1], dm_table_get_mode(ti->table), &dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001499 if (r) {
Alasdair G Kergon72d94862006-06-26 00:27:35 -07001500 DMWARN("message: error getting device %s",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001501 argv[1]);
Mike Anderson6380f262009-12-10 23:52:21 +00001502 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001503 }
1504
1505 r = action_dev(m, dev, action);
1506
1507 dm_put_device(ti, dev);
1508
Mike Anderson6380f262009-12-10 23:52:21 +00001509out:
1510 mutex_unlock(&m->work_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001511 return r;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001512}
1513
Al Viro647b3d02007-08-28 22:15:59 -04001514static int multipath_ioctl(struct dm_target *ti, unsigned int cmd,
Milan Broz9af4aa32006-10-03 01:15:20 -07001515 unsigned long arg)
1516{
Mikulas Patocka35991652012-06-03 00:29:58 +01001517 struct multipath *m = ti->private;
Mike Snitzer7ba10aa2012-09-26 23:45:41 +01001518 struct pgpath *pgpath;
Mikulas Patocka35991652012-06-03 00:29:58 +01001519 struct block_device *bdev;
1520 fmode_t mode;
Milan Broz9af4aa32006-10-03 01:15:20 -07001521 unsigned long flags;
Mikulas Patocka35991652012-06-03 00:29:58 +01001522 int r;
1523
Mikulas Patocka35991652012-06-03 00:29:58 +01001524 bdev = NULL;
1525 mode = 0;
1526 r = 0;
Milan Broz9af4aa32006-10-03 01:15:20 -07001527
1528 spin_lock_irqsave(&m->lock, flags);
1529
1530 if (!m->current_pgpath)
Kiyoshi Ueda02ab8232009-06-22 10:12:27 +01001531 __choose_pgpath(m, 0);
Milan Broz9af4aa32006-10-03 01:15:20 -07001532
Mike Snitzer7ba10aa2012-09-26 23:45:41 +01001533 pgpath = m->current_pgpath;
1534
1535 if (pgpath) {
1536 bdev = pgpath->path.dev->bdev;
1537 mode = pgpath->path.dev->mode;
Milan Broze90dae12006-10-03 01:15:22 -07001538 }
Milan Broz9af4aa32006-10-03 01:15:20 -07001539
Mike Snitzer7ba10aa2012-09-26 23:45:41 +01001540 if ((pgpath && m->queue_io) || (!pgpath && m->queue_if_no_path))
Hannes Reinecke6c182cd2013-07-10 23:41:15 +01001541 r = -ENOTCONN;
Milan Broz9af4aa32006-10-03 01:15:20 -07001542 else if (!bdev)
1543 r = -EIO;
1544
1545 spin_unlock_irqrestore(&m->lock, flags);
1546
Paolo Bonziniec8013b2012-01-12 16:01:29 +01001547 /*
1548 * Only pass ioctls through if the device sizes match exactly.
1549 */
Hannes Reineckea1989b32014-02-26 10:07:04 +01001550 if (!bdev || ti->len != i_size_read(bdev->bd_inode) >> SECTOR_SHIFT) {
1551 int err = scsi_verify_blk_ioctl(NULL, cmd);
1552 if (err)
1553 r = err;
1554 }
Paolo Bonziniec8013b2012-01-12 16:01:29 +01001555
Hannes Reinecke3e9f1be2014-02-28 15:33:45 +01001556 if (r == -ENOTCONN && !fatal_signal_pending(current)) {
1557 spin_lock_irqsave(&m->lock, flags);
1558 if (!m->current_pg) {
1559 /* Path status changed, redo selection */
1560 __choose_pgpath(m, 0);
1561 }
1562 if (m->pg_init_required)
1563 __pg_init_all_paths(m);
1564 spin_unlock_irqrestore(&m->lock, flags);
1565 dm_table_run_md_queue_async(m->ti->table);
1566 }
Mikulas Patocka35991652012-06-03 00:29:58 +01001567
Al Viro633a08b2007-08-29 20:34:12 -04001568 return r ? : __blkdev_driver_ioctl(bdev, mode, cmd, arg);
Milan Broz9af4aa32006-10-03 01:15:20 -07001569}
1570
Mike Snitzeraf4874e2009-06-22 10:12:33 +01001571static int multipath_iterate_devices(struct dm_target *ti,
1572 iterate_devices_callout_fn fn, void *data)
1573{
1574 struct multipath *m = ti->private;
1575 struct priority_group *pg;
1576 struct pgpath *p;
1577 int ret = 0;
1578
1579 list_for_each_entry(pg, &m->priority_groups, list) {
1580 list_for_each_entry(p, &pg->pgpaths, list) {
Mike Snitzer5dea2712009-07-23 20:30:42 +01001581 ret = fn(ti, p->path.dev, ti->begin, ti->len, data);
Mike Snitzeraf4874e2009-06-22 10:12:33 +01001582 if (ret)
1583 goto out;
1584 }
1585 }
1586
1587out:
1588 return ret;
1589}
1590
Kiyoshi Uedaf40c67f2009-06-22 10:12:37 +01001591static int __pgpath_busy(struct pgpath *pgpath)
1592{
1593 struct request_queue *q = bdev_get_queue(pgpath->path.dev->bdev);
1594
1595 return dm_underlying_device_busy(q);
1596}
1597
1598/*
1599 * We return "busy", only when we can map I/Os but underlying devices
1600 * are busy (so even if we map I/Os now, the I/Os will wait on
1601 * the underlying queue).
1602 * In other words, if we want to kill I/Os or queue them inside us
1603 * due to map unavailability, we don't return "busy". Otherwise,
1604 * dm core won't give us the I/Os and we can't do what we want.
1605 */
1606static int multipath_busy(struct dm_target *ti)
1607{
1608 int busy = 0, has_active = 0;
1609 struct multipath *m = ti->private;
1610 struct priority_group *pg;
1611 struct pgpath *pgpath;
1612 unsigned long flags;
1613
1614 spin_lock_irqsave(&m->lock, flags);
1615
Hannes Reineckeb63349a2013-10-01 11:49:56 +02001616 /* pg_init in progress, requeue until done */
Hannes Reineckee8099172014-02-28 15:33:44 +01001617 if (!pg_ready(m)) {
Hannes Reineckeb63349a2013-10-01 11:49:56 +02001618 busy = 1;
1619 goto out;
1620 }
Kiyoshi Uedaf40c67f2009-06-22 10:12:37 +01001621 /* Guess which priority_group will be used at next mapping time */
1622 if (unlikely(!m->current_pgpath && m->next_pg))
1623 pg = m->next_pg;
1624 else if (likely(m->current_pg))
1625 pg = m->current_pg;
1626 else
1627 /*
1628 * We don't know which pg will be used at next mapping time.
1629 * We don't call __choose_pgpath() here to avoid to trigger
1630 * pg_init just by busy checking.
1631 * So we don't know whether underlying devices we will be using
1632 * at next mapping time are busy or not. Just try mapping.
1633 */
1634 goto out;
1635
1636 /*
1637 * If there is one non-busy active path at least, the path selector
1638 * will be able to select it. So we consider such a pg as not busy.
1639 */
1640 busy = 1;
1641 list_for_each_entry(pgpath, &pg->pgpaths, list)
1642 if (pgpath->is_active) {
1643 has_active = 1;
1644
1645 if (!__pgpath_busy(pgpath)) {
1646 busy = 0;
1647 break;
1648 }
1649 }
1650
1651 if (!has_active)
1652 /*
1653 * No active path in this pg, so this pg won't be used and
1654 * the current_pg will be changed at next mapping time.
1655 * We need to try mapping to determine it.
1656 */
1657 busy = 0;
1658
1659out:
1660 spin_unlock_irqrestore(&m->lock, flags);
1661
1662 return busy;
1663}
1664
Linus Torvalds1da177e2005-04-16 15:20:36 -07001665/*-----------------------------------------------------------------
1666 * Module setup
1667 *---------------------------------------------------------------*/
1668static struct target_type multipath_target = {
1669 .name = "multipath",
Hannes Reineckee8099172014-02-28 15:33:44 +01001670 .version = {1, 7, 0},
Linus Torvalds1da177e2005-04-16 15:20:36 -07001671 .module = THIS_MODULE,
1672 .ctr = multipath_ctr,
1673 .dtr = multipath_dtr,
Kiyoshi Uedaf40c67f2009-06-22 10:12:37 +01001674 .map_rq = multipath_map,
1675 .rq_end_io = multipath_end_io,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001676 .presuspend = multipath_presuspend,
Kiyoshi Ueda6df400a2009-12-10 23:52:19 +00001677 .postsuspend = multipath_postsuspend,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001678 .resume = multipath_resume,
1679 .status = multipath_status,
1680 .message = multipath_message,
Milan Broz9af4aa32006-10-03 01:15:20 -07001681 .ioctl = multipath_ioctl,
Mike Snitzeraf4874e2009-06-22 10:12:33 +01001682 .iterate_devices = multipath_iterate_devices,
Kiyoshi Uedaf40c67f2009-06-22 10:12:37 +01001683 .busy = multipath_busy,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001684};
1685
1686static int __init dm_multipath_init(void)
1687{
1688 int r;
1689
1690 /* allocate a slab for the dm_ios */
Alasdair G Kergon028867a2007-07-12 17:26:32 +01001691 _mpio_cache = KMEM_CACHE(dm_mpath_io, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001692 if (!_mpio_cache)
1693 return -ENOMEM;
1694
1695 r = dm_register_target(&multipath_target);
1696 if (r < 0) {
Alasdair G Kergon0cd33122007-07-12 17:27:01 +01001697 DMERR("register failed %d", r);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001698 kmem_cache_destroy(_mpio_cache);
1699 return -EINVAL;
1700 }
1701
Tejun Heo4d4d66a2011-01-13 19:59:57 +00001702 kmultipathd = alloc_workqueue("kmpathd", WQ_MEM_RECLAIM, 0);
Alasdair G Kergonc5573082005-05-05 16:16:07 -07001703 if (!kmultipathd) {
Alasdair G Kergon0cd33122007-07-12 17:27:01 +01001704 DMERR("failed to create workqueue kmpathd");
Alasdair G Kergonc5573082005-05-05 16:16:07 -07001705 dm_unregister_target(&multipath_target);
1706 kmem_cache_destroy(_mpio_cache);
1707 return -ENOMEM;
1708 }
1709
Chandra Seetharamanbab7cfc2008-05-01 14:50:22 -07001710 /*
1711 * A separate workqueue is used to handle the device handlers
1712 * to avoid overloading existing workqueue. Overloading the
1713 * old workqueue would also create a bottleneck in the
1714 * path of the storage hardware device activation.
1715 */
Tejun Heo4d4d66a2011-01-13 19:59:57 +00001716 kmpath_handlerd = alloc_ordered_workqueue("kmpath_handlerd",
1717 WQ_MEM_RECLAIM);
Chandra Seetharamanbab7cfc2008-05-01 14:50:22 -07001718 if (!kmpath_handlerd) {
1719 DMERR("failed to create workqueue kmpath_handlerd");
1720 destroy_workqueue(kmultipathd);
1721 dm_unregister_target(&multipath_target);
1722 kmem_cache_destroy(_mpio_cache);
1723 return -ENOMEM;
1724 }
1725
Alasdair G Kergon72d94862006-06-26 00:27:35 -07001726 DMINFO("version %u.%u.%u loaded",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001727 multipath_target.version[0], multipath_target.version[1],
1728 multipath_target.version[2]);
1729
1730 return r;
1731}
1732
1733static void __exit dm_multipath_exit(void)
1734{
Chandra Seetharamanbab7cfc2008-05-01 14:50:22 -07001735 destroy_workqueue(kmpath_handlerd);
Alasdair G Kergonc5573082005-05-05 16:16:07 -07001736 destroy_workqueue(kmultipathd);
1737
Mikulas Patocka10d3bd02009-01-06 03:04:58 +00001738 dm_unregister_target(&multipath_target);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001739 kmem_cache_destroy(_mpio_cache);
1740}
1741
Linus Torvalds1da177e2005-04-16 15:20:36 -07001742module_init(dm_multipath_init);
1743module_exit(dm_multipath_exit);
1744
1745MODULE_DESCRIPTION(DM_NAME " multipath target");
1746MODULE_AUTHOR("Sistina Software <dm-devel@redhat.com>");
1747MODULE_LICENSE("GPL");