blob: 7259eeba6a5892765d011d7498595196081e0fca [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
Mike Snitzere5863d92014-12-17 21:08:12 -050014#include <linux/blkdev.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070015#include <linux/ctype.h>
16#include <linux/init.h>
17#include <linux/mempool.h>
18#include <linux/module.h>
19#include <linux/pagemap.h>
20#include <linux/slab.h>
21#include <linux/time.h>
22#include <linux/workqueue.h>
Mikulas Patocka35991652012-06-03 00:29:58 +010023#include <linux/delay.h>
Chandra Seetharamancfae5c92008-05-01 14:50:11 -070024#include <scsi/scsi_dh.h>
Arun Sharma600634972011-07-26 16:09:06 -070025#include <linux/atomic.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070026
Alasdair G Kergon72d94862006-06-26 00:27:35 -070027#define DM_MSG_PREFIX "multipath"
Chandra Seetharaman4e2d19e2011-01-13 20:00:01 +000028#define DM_PG_INIT_DELAY_MSECS 2000
29#define DM_PG_INIT_DELAY_DEFAULT ((unsigned) -1)
Linus Torvalds1da177e2005-04-16 15:20:36 -070030
31/* Path properties */
32struct pgpath {
33 struct list_head list;
34
35 struct priority_group *pg; /* Owning PG */
Kiyoshi Ueda66800732008-10-10 13:36:58 +010036 unsigned is_active; /* Path status */
Linus Torvalds1da177e2005-04-16 15:20:36 -070037 unsigned fail_count; /* Cumulative failure count */
38
Josef "Jeff" Sipekc922d5f2006-12-08 02:36:33 -080039 struct dm_path path;
Chandra Seetharaman4e2d19e2011-01-13 20:00:01 +000040 struct delayed_work activate_path;
Linus Torvalds1da177e2005-04-16 15:20:36 -070041};
42
43#define path_to_pgpath(__pgp) container_of((__pgp), struct pgpath, path)
44
45/*
46 * Paths are grouped into Priority Groups and numbered from 1 upwards.
47 * Each has a path selector which controls which path gets used.
48 */
49struct priority_group {
50 struct list_head list;
51
52 struct multipath *m; /* Owning multipath instance */
53 struct path_selector ps;
54
55 unsigned pg_num; /* Reference number */
56 unsigned bypassed; /* Temporarily bypass this PG? */
57
58 unsigned nr_pgpaths; /* Number of paths in PG */
59 struct list_head pgpaths;
60};
61
62/* Multipath context */
63struct multipath {
64 struct list_head list;
65 struct dm_target *ti;
66
Chandra Seetharamancfae5c92008-05-01 14:50:11 -070067 const char *hw_handler_name;
Chandra Seetharaman2bfd2e12009-08-03 12:42:45 -070068 char *hw_handler_params;
Chandra Seetharaman4e2d19e2011-01-13 20:00:01 +000069
Mike Snitzer1fbdd2b2012-06-03 00:29:43 +010070 spinlock_t lock;
71
Linus Torvalds1da177e2005-04-16 15:20:36 -070072 unsigned nr_priority_groups;
73 struct list_head priority_groups;
Chandra Seetharaman4e2d19e2011-01-13 20:00:01 +000074
75 wait_queue_head_t pg_init_wait; /* Wait for pg_init completion */
76
Linus Torvalds1da177e2005-04-16 15:20:36 -070077 unsigned pg_init_required; /* pg_init needs calling? */
Alasdair G Kergonc3cd4f62005-07-12 15:53:04 -070078 unsigned pg_init_in_progress; /* Only one pg_init allowed at once */
Chandra Seetharaman4e2d19e2011-01-13 20:00:01 +000079 unsigned pg_init_delay_retry; /* Delay pg_init retry? */
Linus Torvalds1da177e2005-04-16 15:20:36 -070080
81 unsigned nr_valid_paths; /* Total number of usable paths */
82 struct pgpath *current_pgpath;
83 struct priority_group *current_pg;
84 struct priority_group *next_pg; /* Switch to this PG if set */
85 unsigned repeat_count; /* I/Os left before calling PS again */
86
Mike Snitzer1fbdd2b2012-06-03 00:29:43 +010087 unsigned queue_io:1; /* Must we queue all I/O? */
88 unsigned queue_if_no_path:1; /* Queue I/O if last path fails? */
89 unsigned saved_queue_if_no_path:1; /* Saved state during suspension */
Mike Snitzera58a9352012-07-27 15:08:04 +010090 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 +000091 unsigned pg_init_disabled:1; /* pg_init is not currently allowed */
Mike Snitzer1fbdd2b2012-06-03 00:29:43 +010092
Dave Wysochanskic9e45582007-10-19 22:47:53 +010093 unsigned pg_init_retries; /* Number of times to retry pg_init */
94 unsigned pg_init_count; /* Number of times pg_init called */
Chandra Seetharaman4e2d19e2011-01-13 20:00:01 +000095 unsigned pg_init_delay_msecs; /* Number of msecs before pg_init retry */
Linus Torvalds1da177e2005-04-16 15:20:36 -070096
Linus Torvalds1da177e2005-04-16 15:20:36 -070097 struct work_struct trigger_event;
98
99 /*
Alasdair G Kergon028867a2007-07-12 17:26:32 +0100100 * We must use a mempool of dm_mpath_io structs so that we
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101 * can resubmit bios on error.
102 */
103 mempool_t *mpio_pool;
Mike Anderson6380f262009-12-10 23:52:21 +0000104
105 struct mutex work_mutex;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700106};
107
108/*
109 * Context information attached to each bio we process.
110 */
Alasdair G Kergon028867a2007-07-12 17:26:32 +0100111struct dm_mpath_io {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700112 struct pgpath *pgpath;
Kiyoshi Ueda02ab8232009-06-22 10:12:27 +0100113 size_t nr_bytes;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114};
115
116typedef int (*action_fn) (struct pgpath *pgpath);
117
Christoph Lametere18b8902006-12-06 20:33:20 -0800118static struct kmem_cache *_mpio_cache;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119
Chandra Seetharamanbab7cfc2008-05-01 14:50:22 -0700120static struct workqueue_struct *kmultipathd, *kmpath_handlerd;
David Howellsc4028952006-11-22 14:57:56 +0000121static void trigger_event(struct work_struct *work);
Chandra Seetharamanbab7cfc2008-05-01 14:50:22 -0700122static void activate_path(struct work_struct *work);
Hannes Reineckee8099172014-02-28 15:33:44 +0100123static int __pgpath_busy(struct pgpath *pgpath);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700124
125
126/*-----------------------------------------------
127 * Allocation routines
128 *-----------------------------------------------*/
129
130static struct pgpath *alloc_pgpath(void)
131{
Micha³ Miros³awe69fae52006-10-03 01:15:34 -0700132 struct pgpath *pgpath = kzalloc(sizeof(*pgpath), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133
Mike Anderson224cb3e2008-08-29 09:36:09 +0200134 if (pgpath) {
Kiyoshi Ueda66800732008-10-10 13:36:58 +0100135 pgpath->is_active = 1;
Chandra Seetharaman4e2d19e2011-01-13 20:00:01 +0000136 INIT_DELAYED_WORK(&pgpath->activate_path, activate_path);
Mike Anderson224cb3e2008-08-29 09:36:09 +0200137 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138
139 return pgpath;
140}
141
Alasdair G Kergon028867a2007-07-12 17:26:32 +0100142static void free_pgpath(struct pgpath *pgpath)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700143{
144 kfree(pgpath);
145}
146
147static struct priority_group *alloc_priority_group(void)
148{
149 struct priority_group *pg;
150
Micha³ Miros³awe69fae52006-10-03 01:15:34 -0700151 pg = kzalloc(sizeof(*pg), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700152
Micha³ Miros³awe69fae52006-10-03 01:15:34 -0700153 if (pg)
154 INIT_LIST_HEAD(&pg->pgpaths);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700155
156 return pg;
157}
158
159static void free_pgpaths(struct list_head *pgpaths, struct dm_target *ti)
160{
161 struct pgpath *pgpath, *tmp;
162
163 list_for_each_entry_safe(pgpath, tmp, pgpaths, list) {
164 list_del(&pgpath->list);
165 dm_put_device(ti, pgpath->path.dev);
166 free_pgpath(pgpath);
167 }
168}
169
170static void free_priority_group(struct priority_group *pg,
171 struct dm_target *ti)
172{
173 struct path_selector *ps = &pg->ps;
174
175 if (ps->type) {
176 ps->type->destroy(ps);
177 dm_put_path_selector(ps->type);
178 }
179
180 free_pgpaths(&pg->pgpaths, ti);
181 kfree(pg);
182}
183
Micha³ Miros³aw28f16c22006-10-03 01:15:33 -0700184static struct multipath *alloc_multipath(struct dm_target *ti)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700185{
186 struct multipath *m;
Mike Snitzerf4790822013-09-12 18:06:12 -0400187 unsigned min_ios = dm_get_reserved_rq_based_ios();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700188
Micha³ Miros³awe69fae52006-10-03 01:15:34 -0700189 m = kzalloc(sizeof(*m), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700190 if (m) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700191 INIT_LIST_HEAD(&m->priority_groups);
192 spin_lock_init(&m->lock);
193 m->queue_io = 1;
Chandra Seetharaman4e2d19e2011-01-13 20:00:01 +0000194 m->pg_init_delay_msecs = DM_PG_INIT_DELAY_DEFAULT;
David Howellsc4028952006-11-22 14:57:56 +0000195 INIT_WORK(&m->trigger_event, trigger_event);
Kiyoshi Ueda2bded7b2010-03-06 02:32:13 +0000196 init_waitqueue_head(&m->pg_init_wait);
Mike Anderson6380f262009-12-10 23:52:21 +0000197 mutex_init(&m->work_mutex);
Mike Snitzerf4790822013-09-12 18:06:12 -0400198 m->mpio_pool = mempool_create_slab_pool(min_ios, _mpio_cache);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700199 if (!m->mpio_pool) {
200 kfree(m);
201 return NULL;
202 }
Micha³ Miros³aw28f16c22006-10-03 01:15:33 -0700203 m->ti = ti;
204 ti->private = m;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700205 }
206
207 return m;
208}
209
210static void free_multipath(struct multipath *m)
211{
212 struct priority_group *pg, *tmp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700213
214 list_for_each_entry_safe(pg, tmp, &m->priority_groups, list) {
215 list_del(&pg->list);
216 free_priority_group(pg, m->ti);
217 }
218
Chandra Seetharamancfae5c92008-05-01 14:50:11 -0700219 kfree(m->hw_handler_name);
Chandra Seetharaman2bfd2e12009-08-03 12:42:45 -0700220 kfree(m->hw_handler_params);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700221 mempool_destroy(m->mpio_pool);
222 kfree(m);
223}
224
Jun'ichi Nomura466891f2012-03-28 18:41:25 +0100225static int set_mapinfo(struct multipath *m, union map_info *info)
226{
227 struct dm_mpath_io *mpio;
228
229 mpio = mempool_alloc(m->mpio_pool, GFP_ATOMIC);
230 if (!mpio)
231 return -ENOMEM;
232
233 memset(mpio, 0, sizeof(*mpio));
234 info->ptr = mpio;
235
236 return 0;
237}
238
239static void clear_mapinfo(struct multipath *m, union map_info *info)
240{
241 struct dm_mpath_io *mpio = info->ptr;
242
243 info->ptr = NULL;
244 mempool_free(mpio, m->mpio_pool);
245}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700246
247/*-----------------------------------------------
248 * Path selection
249 *-----------------------------------------------*/
250
Hannes Reinecke3e9f1be2014-02-28 15:33:45 +0100251static int __pg_init_all_paths(struct multipath *m)
Kiyoshi Uedafb612642010-03-06 02:32:18 +0000252{
253 struct pgpath *pgpath;
Chandra Seetharaman4e2d19e2011-01-13 20:00:01 +0000254 unsigned long pg_init_delay = 0;
Kiyoshi Uedafb612642010-03-06 02:32:18 +0000255
Hannes Reinecke17f4ff42014-02-28 15:33:42 +0100256 if (m->pg_init_in_progress || m->pg_init_disabled)
Hannes Reinecke3e9f1be2014-02-28 15:33:45 +0100257 return 0;
Hannes Reinecke17f4ff42014-02-28 15:33:42 +0100258
Kiyoshi Uedafb612642010-03-06 02:32:18 +0000259 m->pg_init_count++;
260 m->pg_init_required = 0;
Hannes Reinecke3e9f1be2014-02-28 15:33:45 +0100261
262 /* Check here to reset pg_init_required */
263 if (!m->current_pg)
264 return 0;
265
Chandra Seetharaman4e2d19e2011-01-13 20:00:01 +0000266 if (m->pg_init_delay_retry)
267 pg_init_delay = msecs_to_jiffies(m->pg_init_delay_msecs != DM_PG_INIT_DELAY_DEFAULT ?
268 m->pg_init_delay_msecs : DM_PG_INIT_DELAY_MSECS);
Kiyoshi Uedafb612642010-03-06 02:32:18 +0000269 list_for_each_entry(pgpath, &m->current_pg->pgpaths, list) {
270 /* Skip failed paths */
271 if (!pgpath->is_active)
272 continue;
Chandra Seetharaman4e2d19e2011-01-13 20:00:01 +0000273 if (queue_delayed_work(kmpath_handlerd, &pgpath->activate_path,
274 pg_init_delay))
Kiyoshi Uedafb612642010-03-06 02:32:18 +0000275 m->pg_init_in_progress++;
276 }
Hannes Reinecke3e9f1be2014-02-28 15:33:45 +0100277 return m->pg_init_in_progress;
Kiyoshi Uedafb612642010-03-06 02:32:18 +0000278}
279
Linus Torvalds1da177e2005-04-16 15:20:36 -0700280static void __switch_pg(struct multipath *m, struct pgpath *pgpath)
281{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700282 m->current_pg = pgpath->pg;
283
284 /* Must we initialise the PG first, and queue I/O till it's ready? */
Chandra Seetharamancfae5c92008-05-01 14:50:11 -0700285 if (m->hw_handler_name) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700286 m->pg_init_required = 1;
287 m->queue_io = 1;
288 } else {
289 m->pg_init_required = 0;
290 m->queue_io = 0;
291 }
Dave Wysochanskic9e45582007-10-19 22:47:53 +0100292
293 m->pg_init_count = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700294}
295
Kiyoshi Ueda02ab8232009-06-22 10:12:27 +0100296static int __choose_path_in_pg(struct multipath *m, struct priority_group *pg,
297 size_t nr_bytes)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700298{
Josef "Jeff" Sipekc922d5f2006-12-08 02:36:33 -0800299 struct dm_path *path;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700300
Kiyoshi Ueda02ab8232009-06-22 10:12:27 +0100301 path = pg->ps.type->select_path(&pg->ps, &m->repeat_count, nr_bytes);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700302 if (!path)
303 return -ENXIO;
304
305 m->current_pgpath = path_to_pgpath(path);
306
307 if (m->current_pg != pg)
308 __switch_pg(m, m->current_pgpath);
309
310 return 0;
311}
312
Kiyoshi Ueda02ab8232009-06-22 10:12:27 +0100313static void __choose_pgpath(struct multipath *m, size_t nr_bytes)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700314{
315 struct priority_group *pg;
316 unsigned bypassed = 1;
317
Benjamin Marzinski1f271972014-08-13 13:53:42 -0500318 if (!m->nr_valid_paths) {
319 m->queue_io = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700320 goto failed;
Benjamin Marzinski1f271972014-08-13 13:53:42 -0500321 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700322
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 Reinecke36fcffc2014-02-28 15:33:47 +0100376/*
377 * Map cloned requests
378 */
Mike Snitzere5863d92014-12-17 21:08:12 -0500379static int __multipath_map(struct dm_target *ti, struct request *clone,
380 union map_info *map_context,
381 struct request *rq, struct request **__clone)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700382{
Hannes Reinecke36fcffc2014-02-28 15:33:47 +0100383 struct multipath *m = (struct multipath *) ti->private;
Hannes Reineckee3bde042014-02-28 15:33:46 +0100384 int r = DM_MAPIO_REQUEUE;
Mike Snitzere5863d92014-12-17 21:08:12 -0500385 size_t nr_bytes = clone ? blk_rq_bytes(clone) : blk_rq_bytes(rq);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700386 struct pgpath *pgpath;
Kiyoshi Uedaf40c67f2009-06-22 10:12:37 +0100387 struct block_device *bdev;
Hannes Reineckee3bde042014-02-28 15:33:46 +0100388 struct dm_mpath_io *mpio;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700389
Keith Busch2eb6e1e2014-10-17 17:46:36 -0600390 spin_lock_irq(&m->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700391
392 /* Do we need to select a new pgpath? */
393 if (!m->current_pgpath ||
394 (!m->queue_io && (m->repeat_count && --m->repeat_count == 0)))
Kiyoshi Ueda02ab8232009-06-22 10:12:27 +0100395 __choose_pgpath(m, nr_bytes);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700396
397 pgpath = m->current_pgpath;
398
Mike Snitzer9bf59a62014-02-28 15:33:48 +0100399 if (!pgpath) {
400 if (!__must_push_back(m))
401 r = -EIO; /* Failed */
402 goto out_unlock;
Mike Snitzer6afbc012014-07-08 11:55:09 -0400403 } else if (m->queue_io || m->pg_init_required) {
Hannes Reineckee3bde042014-02-28 15:33:46 +0100404 __pg_init_all_paths(m);
Mike Snitzer9bf59a62014-02-28 15:33:48 +0100405 goto out_unlock;
406 }
Mike Snitzer6afbc012014-07-08 11:55:09 -0400407
Mike Snitzer9bf59a62014-02-28 15:33:48 +0100408 if (set_mapinfo(m, map_context) < 0)
409 /* ENOMEM, requeue */
410 goto out_unlock;
411
Mike Snitzer9bf59a62014-02-28 15:33:48 +0100412 mpio = map_context->ptr;
413 mpio->pgpath = pgpath;
414 mpio->nr_bytes = nr_bytes;
Keith Busch2eb6e1e2014-10-17 17:46:36 -0600415
416 bdev = pgpath->path.dev->bdev;
417
Keith Busch2eb6e1e2014-10-17 17:46:36 -0600418 spin_unlock_irq(&m->lock);
419
Mike Snitzere5863d92014-12-17 21:08:12 -0500420 if (clone) {
Mike Snitzerc5248f72016-02-20 14:02:49 -0500421 /*
422 * Old request-based interface: allocated clone is passed in.
423 * Used by: .request_fn stacked on .request_fn path(s).
424 */
Mike Snitzere5863d92014-12-17 21:08:12 -0500425 clone->q = bdev_get_queue(bdev);
426 clone->rq_disk = bdev->bd_disk;
427 clone->cmd_flags |= REQ_FAILFAST_TRANSPORT;
428 } else {
429 /* blk-mq request-based interface */
430 *__clone = blk_get_request(bdev_get_queue(bdev),
Mike Snitzer02233342015-03-10 23:49:26 -0400431 rq_data_dir(rq), GFP_ATOMIC);
Mike Snitzer4c6dd532015-05-27 15:23:56 -0400432 if (IS_ERR(*__clone)) {
Mike Snitzere5863d92014-12-17 21:08:12 -0500433 /* ENOMEM, requeue */
Mike Snitzer4c6dd532015-05-27 15:23:56 -0400434 clear_mapinfo(m, map_context);
Mike Snitzere5863d92014-12-17 21:08:12 -0500435 return r;
Mike Snitzer4c6dd532015-05-27 15:23:56 -0400436 }
Mike Snitzere5863d92014-12-17 21:08:12 -0500437 (*__clone)->bio = (*__clone)->biotail = NULL;
438 (*__clone)->rq_disk = bdev->bd_disk;
439 (*__clone)->cmd_flags |= REQ_FAILFAST_TRANSPORT;
440 }
441
Mike Snitzer9bf59a62014-02-28 15:33:48 +0100442 if (pgpath->pg->ps.type->start_io)
443 pgpath->pg->ps.type->start_io(&pgpath->pg->ps,
444 &pgpath->path,
445 nr_bytes);
Keith Busch2eb6e1e2014-10-17 17:46:36 -0600446 return DM_MAPIO_REMAPPED;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700447
Hannes Reineckee3bde042014-02-28 15:33:46 +0100448out_unlock:
Keith Busch2eb6e1e2014-10-17 17:46:36 -0600449 spin_unlock_irq(&m->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700450
451 return r;
452}
453
Mike Snitzere5863d92014-12-17 21:08:12 -0500454static int multipath_map(struct dm_target *ti, struct request *clone,
455 union map_info *map_context)
456{
457 return __multipath_map(ti, clone, map_context, NULL, NULL);
458}
459
460static int multipath_clone_and_map(struct dm_target *ti, struct request *rq,
461 union map_info *map_context,
462 struct request **clone)
463{
464 return __multipath_map(ti, NULL, map_context, rq, clone);
465}
466
467static void multipath_release_clone(struct request *clone)
468{
469 blk_put_request(clone);
470}
471
Linus Torvalds1da177e2005-04-16 15:20:36 -0700472/*
473 * If we run out of usable paths, should we queue I/O or error it?
474 */
Alasdair G Kergon485ef692005-09-27 21:45:45 -0700475static int queue_if_no_path(struct multipath *m, unsigned queue_if_no_path,
476 unsigned save_old_value)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700477{
478 unsigned long flags;
479
480 spin_lock_irqsave(&m->lock, flags);
481
Alasdair G Kergon485ef692005-09-27 21:45:45 -0700482 if (save_old_value)
483 m->saved_queue_if_no_path = m->queue_if_no_path;
484 else
485 m->saved_queue_if_no_path = queue_if_no_path;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700486 m->queue_if_no_path = queue_if_no_path;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700487 spin_unlock_irqrestore(&m->lock, flags);
488
Hannes Reinecke63d832c2014-05-26 14:45:39 +0200489 if (!queue_if_no_path)
490 dm_table_run_md_queue_async(m->ti->table);
491
Linus Torvalds1da177e2005-04-16 15:20:36 -0700492 return 0;
493}
494
Linus Torvalds1da177e2005-04-16 15:20:36 -0700495/*
496 * An event is triggered whenever a path is taken out of use.
497 * Includes path failure and PG bypass.
498 */
David Howellsc4028952006-11-22 14:57:56 +0000499static void trigger_event(struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700500{
David Howellsc4028952006-11-22 14:57:56 +0000501 struct multipath *m =
502 container_of(work, struct multipath, trigger_event);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700503
504 dm_table_event(m->ti->table);
505}
506
507/*-----------------------------------------------------------------
508 * Constructor/argument parsing:
509 * <#multipath feature args> [<arg>]*
510 * <#hw_handler args> [hw_handler [<arg>]*]
511 * <#priority groups>
512 * <initial priority group>
513 * [<selector> <#selector args> [<arg>]*
514 * <#paths> <#per-path selector args>
515 * [<path> [<arg>]* ]+ ]+
516 *---------------------------------------------------------------*/
Mike Snitzer498f0102011-08-02 12:32:04 +0100517static int parse_path_selector(struct dm_arg_set *as, struct priority_group *pg,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700518 struct dm_target *ti)
519{
520 int r;
521 struct path_selector_type *pst;
522 unsigned ps_argc;
523
Mike Snitzer498f0102011-08-02 12:32:04 +0100524 static struct dm_arg _args[] = {
Alasdair G Kergon72d94862006-06-26 00:27:35 -0700525 {0, 1024, "invalid number of path selector args"},
Linus Torvalds1da177e2005-04-16 15:20:36 -0700526 };
527
Mike Snitzer498f0102011-08-02 12:32:04 +0100528 pst = dm_get_path_selector(dm_shift_arg(as));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700529 if (!pst) {
Alasdair G Kergon72d94862006-06-26 00:27:35 -0700530 ti->error = "unknown path selector type";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700531 return -EINVAL;
532 }
533
Mike Snitzer498f0102011-08-02 12:32:04 +0100534 r = dm_read_arg_group(_args, as, &ps_argc, &ti->error);
Mikulas Patocka371b2e32008-07-21 12:00:24 +0100535 if (r) {
536 dm_put_path_selector(pst);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700537 return -EINVAL;
Mikulas Patocka371b2e32008-07-21 12:00:24 +0100538 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700539
540 r = pst->create(&pg->ps, ps_argc, as->argv);
541 if (r) {
542 dm_put_path_selector(pst);
Alasdair G Kergon72d94862006-06-26 00:27:35 -0700543 ti->error = "path selector constructor failed";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700544 return r;
545 }
546
547 pg->ps.type = pst;
Mike Snitzer498f0102011-08-02 12:32:04 +0100548 dm_consume_args(as, ps_argc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700549
550 return 0;
551}
552
Mike Snitzer498f0102011-08-02 12:32:04 +0100553static struct pgpath *parse_path(struct dm_arg_set *as, struct path_selector *ps,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700554 struct dm_target *ti)
555{
556 int r;
557 struct pgpath *p;
Hannes Reineckeae11b1b2008-07-17 17:49:02 -0700558 struct multipath *m = ti->private;
Mike Snitzera58a9352012-07-27 15:08:04 +0100559 struct request_queue *q = NULL;
560 const char *attached_handler_name;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700561
562 /* we need at least a path arg */
563 if (as->argc < 1) {
Alasdair G Kergon72d94862006-06-26 00:27:35 -0700564 ti->error = "no device given";
Benjamin Marzinski01460f32008-10-10 13:36:57 +0100565 return ERR_PTR(-EINVAL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700566 }
567
568 p = alloc_pgpath();
569 if (!p)
Benjamin Marzinski01460f32008-10-10 13:36:57 +0100570 return ERR_PTR(-ENOMEM);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700571
Mike Snitzer498f0102011-08-02 12:32:04 +0100572 r = dm_get_device(ti, dm_shift_arg(as), dm_table_get_mode(ti->table),
Nikanth Karthikesan8215d6e2010-03-06 02:32:27 +0000573 &p->path.dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700574 if (r) {
Alasdair G Kergon72d94862006-06-26 00:27:35 -0700575 ti->error = "error getting device";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700576 goto bad;
577 }
578
Mike Snitzera58a9352012-07-27 15:08:04 +0100579 if (m->retain_attached_hw_handler || m->hw_handler_name)
580 q = bdev_get_queue(p->path.dev->bdev);
Hannes Reineckea0cf7ea2009-06-22 10:12:11 +0100581
Mike Snitzera58a9352012-07-27 15:08:04 +0100582 if (m->retain_attached_hw_handler) {
Christoph Hellwig1bab0de2015-08-27 14:16:54 +0200583retain:
Mike Snitzera58a9352012-07-27 15:08:04 +0100584 attached_handler_name = scsi_dh_attached_handler_name(q, GFP_KERNEL);
585 if (attached_handler_name) {
586 /*
587 * Reset hw_handler_name to match the attached handler
588 * and clear any hw_handler_params associated with the
589 * ignored handler.
590 *
591 * NB. This modifies the table line to show the actual
592 * handler instead of the original table passed in.
593 */
594 kfree(m->hw_handler_name);
595 m->hw_handler_name = attached_handler_name;
596
597 kfree(m->hw_handler_params);
598 m->hw_handler_params = NULL;
599 }
600 }
601
602 if (m->hw_handler_name) {
Hannes Reineckea0cf7ea2009-06-22 10:12:11 +0100603 r = scsi_dh_attach(q, m->hw_handler_name);
604 if (r == -EBUSY) {
Christoph Hellwig1bab0de2015-08-27 14:16:54 +0200605 char b[BDEVNAME_SIZE];
Hannes Reineckea0cf7ea2009-06-22 10:12:11 +0100606
Christoph Hellwig1bab0de2015-08-27 14:16:54 +0200607 printk(KERN_INFO "dm-mpath: retaining handler on device %s\n",
608 bdevname(p->path.dev->bdev, b));
609 goto retain;
610 }
Hannes Reineckeae11b1b2008-07-17 17:49:02 -0700611 if (r < 0) {
Hannes Reineckea0cf7ea2009-06-22 10:12:11 +0100612 ti->error = "error attaching hardware handler";
Hannes Reineckeae11b1b2008-07-17 17:49:02 -0700613 dm_put_device(ti, p->path.dev);
614 goto bad;
615 }
Chandra Seetharaman2bfd2e12009-08-03 12:42:45 -0700616
617 if (m->hw_handler_params) {
618 r = scsi_dh_set_params(q, m->hw_handler_params);
619 if (r < 0) {
620 ti->error = "unable to set hardware "
621 "handler parameters";
Chandra Seetharaman2bfd2e12009-08-03 12:42:45 -0700622 dm_put_device(ti, p->path.dev);
623 goto bad;
624 }
625 }
Hannes Reineckeae11b1b2008-07-17 17:49:02 -0700626 }
627
Linus Torvalds1da177e2005-04-16 15:20:36 -0700628 r = ps->type->add_path(ps, &p->path, as->argc, as->argv, &ti->error);
629 if (r) {
630 dm_put_device(ti, p->path.dev);
631 goto bad;
632 }
633
634 return p;
635
636 bad:
637 free_pgpath(p);
Benjamin Marzinski01460f32008-10-10 13:36:57 +0100638 return ERR_PTR(r);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700639}
640
Mike Snitzer498f0102011-08-02 12:32:04 +0100641static struct priority_group *parse_priority_group(struct dm_arg_set *as,
Micha³ Miros³aw28f16c22006-10-03 01:15:33 -0700642 struct multipath *m)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700643{
Mike Snitzer498f0102011-08-02 12:32:04 +0100644 static struct dm_arg _args[] = {
Alasdair G Kergon72d94862006-06-26 00:27:35 -0700645 {1, 1024, "invalid number of paths"},
646 {0, 1024, "invalid number of selector args"}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700647 };
648
649 int r;
Mike Snitzer498f0102011-08-02 12:32:04 +0100650 unsigned i, nr_selector_args, nr_args;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700651 struct priority_group *pg;
Micha³ Miros³aw28f16c22006-10-03 01:15:33 -0700652 struct dm_target *ti = m->ti;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700653
654 if (as->argc < 2) {
655 as->argc = 0;
Benjamin Marzinski01460f32008-10-10 13:36:57 +0100656 ti->error = "not enough priority group arguments";
657 return ERR_PTR(-EINVAL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700658 }
659
660 pg = alloc_priority_group();
661 if (!pg) {
Alasdair G Kergon72d94862006-06-26 00:27:35 -0700662 ti->error = "couldn't allocate priority group";
Benjamin Marzinski01460f32008-10-10 13:36:57 +0100663 return ERR_PTR(-ENOMEM);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700664 }
665 pg->m = m;
666
667 r = parse_path_selector(as, pg, ti);
668 if (r)
669 goto bad;
670
671 /*
672 * read the paths
673 */
Mike Snitzer498f0102011-08-02 12:32:04 +0100674 r = dm_read_arg(_args, as, &pg->nr_pgpaths, &ti->error);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700675 if (r)
676 goto bad;
677
Mike Snitzer498f0102011-08-02 12:32:04 +0100678 r = dm_read_arg(_args + 1, as, &nr_selector_args, &ti->error);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700679 if (r)
680 goto bad;
681
Mike Snitzer498f0102011-08-02 12:32:04 +0100682 nr_args = 1 + nr_selector_args;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700683 for (i = 0; i < pg->nr_pgpaths; i++) {
684 struct pgpath *pgpath;
Mike Snitzer498f0102011-08-02 12:32:04 +0100685 struct dm_arg_set path_args;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700686
Mike Snitzer498f0102011-08-02 12:32:04 +0100687 if (as->argc < nr_args) {
Mikulas Patocka148acff2008-07-21 12:00:30 +0100688 ti->error = "not enough path parameters";
Alasdair G Kergon6bbf79a2010-08-12 04:13:49 +0100689 r = -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700690 goto bad;
Mikulas Patocka148acff2008-07-21 12:00:30 +0100691 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700692
Mike Snitzer498f0102011-08-02 12:32:04 +0100693 path_args.argc = nr_args;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700694 path_args.argv = as->argv;
695
696 pgpath = parse_path(&path_args, &pg->ps, ti);
Benjamin Marzinski01460f32008-10-10 13:36:57 +0100697 if (IS_ERR(pgpath)) {
698 r = PTR_ERR(pgpath);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700699 goto bad;
Benjamin Marzinski01460f32008-10-10 13:36:57 +0100700 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700701
702 pgpath->pg = pg;
703 list_add_tail(&pgpath->list, &pg->pgpaths);
Mike Snitzer498f0102011-08-02 12:32:04 +0100704 dm_consume_args(as, nr_args);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700705 }
706
707 return pg;
708
709 bad:
710 free_priority_group(pg, ti);
Benjamin Marzinski01460f32008-10-10 13:36:57 +0100711 return ERR_PTR(r);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700712}
713
Mike Snitzer498f0102011-08-02 12:32:04 +0100714static int parse_hw_handler(struct dm_arg_set *as, struct multipath *m)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700715{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700716 unsigned hw_argc;
Chandra Seetharaman2bfd2e12009-08-03 12:42:45 -0700717 int ret;
Micha³ Miros³aw28f16c22006-10-03 01:15:33 -0700718 struct dm_target *ti = m->ti;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700719
Mike Snitzer498f0102011-08-02 12:32:04 +0100720 static struct dm_arg _args[] = {
Alasdair G Kergon72d94862006-06-26 00:27:35 -0700721 {0, 1024, "invalid number of hardware handler args"},
Linus Torvalds1da177e2005-04-16 15:20:36 -0700722 };
723
Mike Snitzer498f0102011-08-02 12:32:04 +0100724 if (dm_read_arg_group(_args, as, &hw_argc, &ti->error))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700725 return -EINVAL;
726
727 if (!hw_argc)
728 return 0;
729
Mike Snitzer498f0102011-08-02 12:32:04 +0100730 m->hw_handler_name = kstrdup(dm_shift_arg(as), GFP_KERNEL);
Chandra Seetharaman14e98c52008-11-13 23:39:06 +0000731
Chandra Seetharaman2bfd2e12009-08-03 12:42:45 -0700732 if (hw_argc > 1) {
733 char *p;
734 int i, j, len = 4;
735
736 for (i = 0; i <= hw_argc - 2; i++)
737 len += strlen(as->argv[i]) + 1;
738 p = m->hw_handler_params = kzalloc(len, GFP_KERNEL);
739 if (!p) {
740 ti->error = "memory allocation failed";
741 ret = -ENOMEM;
742 goto fail;
743 }
744 j = sprintf(p, "%d", hw_argc - 1);
745 for (i = 0, p+=j+1; i <= hw_argc - 2; i++, p+=j+1)
746 j = sprintf(p, "%s", as->argv[i]);
747 }
Mike Snitzer498f0102011-08-02 12:32:04 +0100748 dm_consume_args(as, hw_argc - 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700749
750 return 0;
Chandra Seetharaman2bfd2e12009-08-03 12:42:45 -0700751fail:
752 kfree(m->hw_handler_name);
753 m->hw_handler_name = NULL;
754 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700755}
756
Mike Snitzer498f0102011-08-02 12:32:04 +0100757static int parse_features(struct dm_arg_set *as, struct multipath *m)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700758{
759 int r;
760 unsigned argc;
Micha³ Miros³aw28f16c22006-10-03 01:15:33 -0700761 struct dm_target *ti = m->ti;
Mike Snitzer498f0102011-08-02 12:32:04 +0100762 const char *arg_name;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700763
Mike Snitzer498f0102011-08-02 12:32:04 +0100764 static struct dm_arg _args[] = {
Mike Snitzera58a9352012-07-27 15:08:04 +0100765 {0, 6, "invalid number of feature args"},
Dave Wysochanskic9e45582007-10-19 22:47:53 +0100766 {1, 50, "pg_init_retries must be between 1 and 50"},
Chandra Seetharaman4e2d19e2011-01-13 20:00:01 +0000767 {0, 60000, "pg_init_delay_msecs must be between 0 and 60000"},
Linus Torvalds1da177e2005-04-16 15:20:36 -0700768 };
769
Mike Snitzer498f0102011-08-02 12:32:04 +0100770 r = dm_read_arg_group(_args, as, &argc, &ti->error);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700771 if (r)
772 return -EINVAL;
773
774 if (!argc)
775 return 0;
776
Dave Wysochanskic9e45582007-10-19 22:47:53 +0100777 do {
Mike Snitzer498f0102011-08-02 12:32:04 +0100778 arg_name = dm_shift_arg(as);
Dave Wysochanskic9e45582007-10-19 22:47:53 +0100779 argc--;
780
Mike Snitzer498f0102011-08-02 12:32:04 +0100781 if (!strcasecmp(arg_name, "queue_if_no_path")) {
Dave Wysochanskic9e45582007-10-19 22:47:53 +0100782 r = queue_if_no_path(m, 1, 0);
783 continue;
784 }
785
Mike Snitzera58a9352012-07-27 15:08:04 +0100786 if (!strcasecmp(arg_name, "retain_attached_hw_handler")) {
787 m->retain_attached_hw_handler = 1;
788 continue;
789 }
790
Mike Snitzer498f0102011-08-02 12:32:04 +0100791 if (!strcasecmp(arg_name, "pg_init_retries") &&
Dave Wysochanskic9e45582007-10-19 22:47:53 +0100792 (argc >= 1)) {
Mike Snitzer498f0102011-08-02 12:32:04 +0100793 r = dm_read_arg(_args + 1, as, &m->pg_init_retries, &ti->error);
Dave Wysochanskic9e45582007-10-19 22:47:53 +0100794 argc--;
795 continue;
796 }
797
Mike Snitzer498f0102011-08-02 12:32:04 +0100798 if (!strcasecmp(arg_name, "pg_init_delay_msecs") &&
Chandra Seetharaman4e2d19e2011-01-13 20:00:01 +0000799 (argc >= 1)) {
Mike Snitzer498f0102011-08-02 12:32:04 +0100800 r = dm_read_arg(_args + 2, as, &m->pg_init_delay_msecs, &ti->error);
Chandra Seetharaman4e2d19e2011-01-13 20:00:01 +0000801 argc--;
802 continue;
803 }
804
Linus Torvalds1da177e2005-04-16 15:20:36 -0700805 ti->error = "Unrecognised multipath feature request";
Dave Wysochanskic9e45582007-10-19 22:47:53 +0100806 r = -EINVAL;
807 } while (argc && !r);
808
809 return r;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700810}
811
812static int multipath_ctr(struct dm_target *ti, unsigned int argc,
813 char **argv)
814{
Mike Snitzer498f0102011-08-02 12:32:04 +0100815 /* target arguments */
816 static struct dm_arg _args[] = {
Mike Snitzera490a072011-03-24 13:54:33 +0000817 {0, 1024, "invalid number of priority groups"},
818 {0, 1024, "invalid initial priority group number"},
Linus Torvalds1da177e2005-04-16 15:20:36 -0700819 };
820
821 int r;
822 struct multipath *m;
Mike Snitzer498f0102011-08-02 12:32:04 +0100823 struct dm_arg_set as;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700824 unsigned pg_count = 0;
825 unsigned next_pg_num;
826
827 as.argc = argc;
828 as.argv = argv;
829
Micha³ Miros³aw28f16c22006-10-03 01:15:33 -0700830 m = alloc_multipath(ti);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700831 if (!m) {
Alasdair G Kergon72d94862006-06-26 00:27:35 -0700832 ti->error = "can't allocate multipath";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700833 return -EINVAL;
834 }
835
Micha³ Miros³aw28f16c22006-10-03 01:15:33 -0700836 r = parse_features(&as, m);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700837 if (r)
838 goto bad;
839
Micha³ Miros³aw28f16c22006-10-03 01:15:33 -0700840 r = parse_hw_handler(&as, m);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700841 if (r)
842 goto bad;
843
Mike Snitzer498f0102011-08-02 12:32:04 +0100844 r = dm_read_arg(_args, &as, &m->nr_priority_groups, &ti->error);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700845 if (r)
846 goto bad;
847
Mike Snitzer498f0102011-08-02 12:32:04 +0100848 r = dm_read_arg(_args + 1, &as, &next_pg_num, &ti->error);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700849 if (r)
850 goto bad;
851
Mike Snitzera490a072011-03-24 13:54:33 +0000852 if ((!m->nr_priority_groups && next_pg_num) ||
853 (m->nr_priority_groups && !next_pg_num)) {
854 ti->error = "invalid initial priority group";
855 r = -EINVAL;
856 goto bad;
857 }
858
Linus Torvalds1da177e2005-04-16 15:20:36 -0700859 /* parse the priority groups */
860 while (as.argc) {
861 struct priority_group *pg;
862
Micha³ Miros³aw28f16c22006-10-03 01:15:33 -0700863 pg = parse_priority_group(&as, m);
Benjamin Marzinski01460f32008-10-10 13:36:57 +0100864 if (IS_ERR(pg)) {
865 r = PTR_ERR(pg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700866 goto bad;
867 }
868
869 m->nr_valid_paths += pg->nr_pgpaths;
870 list_add_tail(&pg->list, &m->priority_groups);
871 pg_count++;
872 pg->pg_num = pg_count;
873 if (!--next_pg_num)
874 m->next_pg = pg;
875 }
876
877 if (pg_count != m->nr_priority_groups) {
Alasdair G Kergon72d94862006-06-26 00:27:35 -0700878 ti->error = "priority group count mismatch";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700879 r = -EINVAL;
880 goto bad;
881 }
882
Alasdair G Kergon55a62ee2013-03-01 22:45:47 +0000883 ti->num_flush_bios = 1;
884 ti->num_discard_bios = 1;
Mike Snitzer042bcef2013-05-10 14:37:16 +0100885 ti->num_write_same_bios = 1;
Mikulas Patocka86279212009-06-22 10:12:24 +0100886
Linus Torvalds1da177e2005-04-16 15:20:36 -0700887 return 0;
888
889 bad:
890 free_multipath(m);
891 return r;
892}
893
Kiyoshi Ueda2bded7b2010-03-06 02:32:13 +0000894static void multipath_wait_for_pg_init_completion(struct multipath *m)
895{
896 DECLARE_WAITQUEUE(wait, current);
897 unsigned long flags;
898
899 add_wait_queue(&m->pg_init_wait, &wait);
900
901 while (1) {
902 set_current_state(TASK_UNINTERRUPTIBLE);
903
904 spin_lock_irqsave(&m->lock, flags);
905 if (!m->pg_init_in_progress) {
906 spin_unlock_irqrestore(&m->lock, flags);
907 break;
908 }
909 spin_unlock_irqrestore(&m->lock, flags);
910
911 io_schedule();
912 }
913 set_current_state(TASK_RUNNING);
914
915 remove_wait_queue(&m->pg_init_wait, &wait);
916}
917
918static void flush_multipath_work(struct multipath *m)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700919{
Shiva Krishna Merla954a73d2013-10-30 03:26:38 +0000920 unsigned long flags;
921
922 spin_lock_irqsave(&m->lock, flags);
923 m->pg_init_disabled = 1;
924 spin_unlock_irqrestore(&m->lock, flags);
925
Chandra Seetharamanbab7cfc2008-05-01 14:50:22 -0700926 flush_workqueue(kmpath_handlerd);
Kiyoshi Ueda2bded7b2010-03-06 02:32:13 +0000927 multipath_wait_for_pg_init_completion(m);
Alasdair G Kergona044d012005-07-12 15:53:02 -0700928 flush_workqueue(kmultipathd);
Tejun Heo43829732012-08-20 14:51:24 -0700929 flush_work(&m->trigger_event);
Shiva Krishna Merla954a73d2013-10-30 03:26:38 +0000930
931 spin_lock_irqsave(&m->lock, flags);
932 m->pg_init_disabled = 0;
933 spin_unlock_irqrestore(&m->lock, flags);
Kiyoshi Ueda6df400a2009-12-10 23:52:19 +0000934}
935
936static void multipath_dtr(struct dm_target *ti)
937{
938 struct multipath *m = ti->private;
939
Kiyoshi Ueda2bded7b2010-03-06 02:32:13 +0000940 flush_multipath_work(m);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700941 free_multipath(m);
942}
943
944/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700945 * Take a path out of use.
946 */
947static int fail_path(struct pgpath *pgpath)
948{
949 unsigned long flags;
950 struct multipath *m = pgpath->pg->m;
951
952 spin_lock_irqsave(&m->lock, flags);
953
Kiyoshi Ueda66800732008-10-10 13:36:58 +0100954 if (!pgpath->is_active)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700955 goto out;
956
Alasdair G Kergon72d94862006-06-26 00:27:35 -0700957 DMWARN("Failing path %s.", pgpath->path.dev->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700958
959 pgpath->pg->ps.type->fail_path(&pgpath->pg->ps, &pgpath->path);
Kiyoshi Ueda66800732008-10-10 13:36:58 +0100960 pgpath->is_active = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700961 pgpath->fail_count++;
962
963 m->nr_valid_paths--;
964
965 if (pgpath == m->current_pgpath)
966 m->current_pgpath = NULL;
967
Mike Andersonb15546f2007-10-19 22:48:02 +0100968 dm_path_uevent(DM_UEVENT_PATH_FAILED, m->ti,
969 pgpath->path.dev->name, m->nr_valid_paths);
970
Alasdair G Kergonfe9cf302009-01-06 03:05:13 +0000971 schedule_work(&m->trigger_event);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700972
973out:
974 spin_unlock_irqrestore(&m->lock, flags);
975
976 return 0;
977}
978
979/*
980 * Reinstate a previously-failed path
981 */
982static int reinstate_path(struct pgpath *pgpath)
983{
Hannes Reinecke63d832c2014-05-26 14:45:39 +0200984 int r = 0, run_queue = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700985 unsigned long flags;
986 struct multipath *m = pgpath->pg->m;
987
988 spin_lock_irqsave(&m->lock, flags);
989
Kiyoshi Ueda66800732008-10-10 13:36:58 +0100990 if (pgpath->is_active)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700991 goto out;
992
Alasdair G Kergondef052d2008-07-21 12:00:31 +0100993 if (!pgpath->pg->ps.type->reinstate_path) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700994 DMWARN("Reinstate path not supported by path selector %s",
995 pgpath->pg->ps.type->name);
996 r = -EINVAL;
997 goto out;
998 }
999
1000 r = pgpath->pg->ps.type->reinstate_path(&pgpath->pg->ps, &pgpath->path);
1001 if (r)
1002 goto out;
1003
Kiyoshi Ueda66800732008-10-10 13:36:58 +01001004 pgpath->is_active = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001005
Hannes Reineckee8099172014-02-28 15:33:44 +01001006 if (!m->nr_valid_paths++) {
Chandra Seetharamane54f77d2009-06-22 10:12:12 +01001007 m->current_pgpath = NULL;
Hannes Reinecke63d832c2014-05-26 14:45:39 +02001008 run_queue = 1;
Chandra Seetharamane54f77d2009-06-22 10:12:12 +01001009 } else if (m->hw_handler_name && (m->current_pg == pgpath->pg)) {
Chandra Seetharaman4e2d19e2011-01-13 20:00:01 +00001010 if (queue_work(kmpath_handlerd, &pgpath->activate_path.work))
Chandra Seetharamane54f77d2009-06-22 10:12:12 +01001011 m->pg_init_in_progress++;
1012 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001013
Mike Andersonb15546f2007-10-19 22:48:02 +01001014 dm_path_uevent(DM_UEVENT_PATH_REINSTATED, m->ti,
1015 pgpath->path.dev->name, m->nr_valid_paths);
1016
Alasdair G Kergonfe9cf302009-01-06 03:05:13 +00001017 schedule_work(&m->trigger_event);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001018
1019out:
1020 spin_unlock_irqrestore(&m->lock, flags);
Hannes Reinecke63d832c2014-05-26 14:45:39 +02001021 if (run_queue)
1022 dm_table_run_md_queue_async(m->ti->table);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001023
1024 return r;
1025}
1026
1027/*
1028 * Fail or reinstate all paths that match the provided struct dm_dev.
1029 */
1030static int action_dev(struct multipath *m, struct dm_dev *dev,
1031 action_fn action)
1032{
Mike Snitzer19040c02011-03-24 13:54:31 +00001033 int r = -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001034 struct pgpath *pgpath;
1035 struct priority_group *pg;
1036
1037 list_for_each_entry(pg, &m->priority_groups, list) {
1038 list_for_each_entry(pgpath, &pg->pgpaths, list) {
1039 if (pgpath->path.dev == dev)
1040 r = action(pgpath);
1041 }
1042 }
1043
1044 return r;
1045}
1046
1047/*
1048 * Temporarily try to avoid having to use the specified PG
1049 */
1050static void bypass_pg(struct multipath *m, struct priority_group *pg,
1051 int bypassed)
1052{
1053 unsigned long flags;
1054
1055 spin_lock_irqsave(&m->lock, flags);
1056
1057 pg->bypassed = bypassed;
1058 m->current_pgpath = NULL;
1059 m->current_pg = NULL;
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}
1065
1066/*
1067 * Switch to using the specified PG from the next I/O that gets mapped
1068 */
1069static int switch_pg_num(struct multipath *m, const char *pgstr)
1070{
1071 struct priority_group *pg;
1072 unsigned pgnum;
1073 unsigned long flags;
Mikulas Patocka31998ef2012-03-28 18:41:26 +01001074 char dummy;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001075
Mikulas Patocka31998ef2012-03-28 18:41:26 +01001076 if (!pgstr || (sscanf(pgstr, "%u%c", &pgnum, &dummy) != 1) || !pgnum ||
Linus Torvalds1da177e2005-04-16 15:20:36 -07001077 (pgnum > m->nr_priority_groups)) {
1078 DMWARN("invalid PG number supplied to switch_pg_num");
1079 return -EINVAL;
1080 }
1081
1082 spin_lock_irqsave(&m->lock, flags);
1083 list_for_each_entry(pg, &m->priority_groups, list) {
1084 pg->bypassed = 0;
1085 if (--pgnum)
1086 continue;
1087
1088 m->current_pgpath = NULL;
1089 m->current_pg = NULL;
1090 m->next_pg = pg;
1091 }
1092 spin_unlock_irqrestore(&m->lock, flags);
1093
Alasdair G Kergonfe9cf302009-01-06 03:05:13 +00001094 schedule_work(&m->trigger_event);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001095 return 0;
1096}
1097
1098/*
1099 * Set/clear bypassed status of a PG.
1100 * PGs are numbered upwards from 1 in the order they were declared.
1101 */
1102static int bypass_pg_num(struct multipath *m, const char *pgstr, int bypassed)
1103{
1104 struct priority_group *pg;
1105 unsigned pgnum;
Mikulas Patocka31998ef2012-03-28 18:41:26 +01001106 char dummy;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001107
Mikulas Patocka31998ef2012-03-28 18:41:26 +01001108 if (!pgstr || (sscanf(pgstr, "%u%c", &pgnum, &dummy) != 1) || !pgnum ||
Linus Torvalds1da177e2005-04-16 15:20:36 -07001109 (pgnum > m->nr_priority_groups)) {
1110 DMWARN("invalid PG number supplied to bypass_pg");
1111 return -EINVAL;
1112 }
1113
1114 list_for_each_entry(pg, &m->priority_groups, list) {
1115 if (!--pgnum)
1116 break;
1117 }
1118
1119 bypass_pg(m, pg, bypassed);
1120 return 0;
1121}
1122
1123/*
Dave Wysochanskic9e45582007-10-19 22:47:53 +01001124 * Should we retry pg_init immediately?
1125 */
1126static int pg_init_limit_reached(struct multipath *m, struct pgpath *pgpath)
1127{
1128 unsigned long flags;
1129 int limit_reached = 0;
1130
1131 spin_lock_irqsave(&m->lock, flags);
1132
Shiva Krishna Merla954a73d2013-10-30 03:26:38 +00001133 if (m->pg_init_count <= m->pg_init_retries && !m->pg_init_disabled)
Dave Wysochanskic9e45582007-10-19 22:47:53 +01001134 m->pg_init_required = 1;
1135 else
1136 limit_reached = 1;
1137
1138 spin_unlock_irqrestore(&m->lock, flags);
1139
1140 return limit_reached;
1141}
1142
Chandra Seetharaman3ae31f62009-10-21 09:22:46 -07001143static void pg_init_done(void *data, int errors)
Chandra Seetharamancfae5c92008-05-01 14:50:11 -07001144{
Moger, Babu83c0d5d2010-03-06 02:29:45 +00001145 struct pgpath *pgpath = data;
Chandra Seetharamancfae5c92008-05-01 14:50:11 -07001146 struct priority_group *pg = pgpath->pg;
1147 struct multipath *m = pg->m;
1148 unsigned long flags;
Chandra Seetharaman4e2d19e2011-01-13 20:00:01 +00001149 unsigned delay_retry = 0;
Chandra Seetharamancfae5c92008-05-01 14:50:11 -07001150
1151 /* device or driver problems */
1152 switch (errors) {
1153 case SCSI_DH_OK:
1154 break;
1155 case SCSI_DH_NOSYS:
1156 if (!m->hw_handler_name) {
1157 errors = 0;
1158 break;
1159 }
Moger, Babuf7b934c2010-03-06 02:29:49 +00001160 DMERR("Could not failover the device: Handler scsi_dh_%s "
1161 "Error %d.", m->hw_handler_name, errors);
Chandra Seetharamancfae5c92008-05-01 14:50:11 -07001162 /*
1163 * Fail path for now, so we do not ping pong
1164 */
1165 fail_path(pgpath);
1166 break;
1167 case SCSI_DH_DEV_TEMP_BUSY:
1168 /*
1169 * Probably doing something like FW upgrade on the
1170 * controller so try the other pg.
1171 */
1172 bypass_pg(m, pg, 1);
1173 break;
Chandra Seetharamancfae5c92008-05-01 14:50:11 -07001174 case SCSI_DH_RETRY:
Chandra Seetharaman4e2d19e2011-01-13 20:00:01 +00001175 /* Wait before retrying. */
1176 delay_retry = 1;
Chandra Seetharamancfae5c92008-05-01 14:50:11 -07001177 case SCSI_DH_IMM_RETRY:
1178 case SCSI_DH_RES_TEMP_UNAVAIL:
1179 if (pg_init_limit_reached(m, pgpath))
1180 fail_path(pgpath);
1181 errors = 0;
1182 break;
1183 default:
1184 /*
1185 * We probably do not want to fail the path for a device
1186 * error, but this is what the old dm did. In future
1187 * patches we can do more advanced handling.
1188 */
1189 fail_path(pgpath);
1190 }
1191
1192 spin_lock_irqsave(&m->lock, flags);
1193 if (errors) {
Chandra Seetharamane54f77d2009-06-22 10:12:12 +01001194 if (pgpath == m->current_pgpath) {
1195 DMERR("Could not failover device. Error %d.", errors);
1196 m->current_pgpath = NULL;
1197 m->current_pg = NULL;
1198 }
Kiyoshi Uedad0259bf2010-03-06 02:30:02 +00001199 } else if (!m->pg_init_required)
Chandra Seetharamancfae5c92008-05-01 14:50:11 -07001200 pg->bypassed = 0;
Chandra Seetharamancfae5c92008-05-01 14:50:11 -07001201
Kiyoshi Uedad0259bf2010-03-06 02:30:02 +00001202 if (--m->pg_init_in_progress)
1203 /* Activations of other paths are still on going */
1204 goto out;
1205
Hannes Reinecke3e9f1be2014-02-28 15:33:45 +01001206 if (m->pg_init_required) {
1207 m->pg_init_delay_retry = delay_retry;
1208 if (__pg_init_all_paths(m))
1209 goto out;
1210 }
1211 m->queue_io = 0;
Kiyoshi Uedad0259bf2010-03-06 02:30:02 +00001212
Kiyoshi Ueda2bded7b2010-03-06 02:32:13 +00001213 /*
1214 * Wake up any thread waiting to suspend.
1215 */
1216 wake_up(&m->pg_init_wait);
1217
Kiyoshi Uedad0259bf2010-03-06 02:30:02 +00001218out:
Chandra Seetharamancfae5c92008-05-01 14:50:11 -07001219 spin_unlock_irqrestore(&m->lock, flags);
1220}
1221
Chandra Seetharamanbab7cfc2008-05-01 14:50:22 -07001222static void activate_path(struct work_struct *work)
1223{
Chandra Seetharamane54f77d2009-06-22 10:12:12 +01001224 struct pgpath *pgpath =
Chandra Seetharaman4e2d19e2011-01-13 20:00:01 +00001225 container_of(work, struct pgpath, activate_path.work);
Chandra Seetharamanbab7cfc2008-05-01 14:50:22 -07001226
Hannes Reinecke3a017502014-02-28 15:33:49 +01001227 if (pgpath->is_active)
1228 scsi_dh_activate(bdev_get_queue(pgpath->path.dev->bdev),
1229 pg_init_done, pgpath);
1230 else
1231 pg_init_done(pgpath, SCSI_DH_DEV_OFFLINED);
Chandra Seetharamanbab7cfc2008-05-01 14:50:22 -07001232}
1233
Hannes Reinecke7e782af2013-07-01 15:16:26 +02001234static int noretry_error(int error)
1235{
1236 switch (error) {
1237 case -EOPNOTSUPP:
1238 case -EREMOTEIO:
1239 case -EILSEQ:
1240 case -ENODATA:
Jun'ichi Nomuracc9d3c32013-09-13 14:54:30 +09001241 case -ENOSPC:
Hannes Reinecke7e782af2013-07-01 15:16:26 +02001242 return 1;
1243 }
1244
1245 /* Anything else could be a path failure, so should be retried */
1246 return 0;
1247}
1248
Linus Torvalds1da177e2005-04-16 15:20:36 -07001249/*
1250 * end_io handling
1251 */
Kiyoshi Uedaf40c67f2009-06-22 10:12:37 +01001252static int do_end_io(struct multipath *m, struct request *clone,
Alasdair G Kergon028867a2007-07-12 17:26:32 +01001253 int error, struct dm_mpath_io *mpio)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001254{
Kiyoshi Uedaf40c67f2009-06-22 10:12:37 +01001255 /*
1256 * We don't queue any clone request inside the multipath target
1257 * during end I/O handling, since those clone requests don't have
1258 * bio clones. If we queue them inside the multipath target,
1259 * we need to make bio clones, that requires memory allocation.
1260 * (See drivers/md/dm.c:end_clone_bio() about why the clone requests
1261 * don't have bio clones.)
1262 * Instead of queueing the clone request here, we queue the original
1263 * request into dm core, which will remake a clone request and
1264 * clone bios for it and resubmit it later.
1265 */
1266 int r = DM_ENDIO_REQUEUE;
Stefan Bader640eb3b2005-11-21 21:32:35 -08001267 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001268
Kiyoshi Uedaf40c67f2009-06-22 10:12:37 +01001269 if (!error && !clone->errors)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001270 return 0; /* I/O complete */
1271
Mike Snitzer7eee4ae2014-06-02 15:50:06 -04001272 if (noretry_error(error))
Mike Snitzer959eb4e2010-08-12 04:14:32 +01001273 return error;
1274
Chandra Seetharamancfae5c92008-05-01 14:50:11 -07001275 if (mpio->pgpath)
1276 fail_path(mpio->pgpath);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001277
Stefan Bader640eb3b2005-11-21 21:32:35 -08001278 spin_lock_irqsave(&m->lock, flags);
Hannes Reinecke751b2a72011-01-18 10:13:12 +01001279 if (!m->nr_valid_paths) {
1280 if (!m->queue_if_no_path) {
1281 if (!__must_push_back(m))
1282 r = -EIO;
1283 } else {
1284 if (error == -EBADE)
1285 r = error;
1286 }
1287 }
Stefan Bader640eb3b2005-11-21 21:32:35 -08001288 spin_unlock_irqrestore(&m->lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001289
Kiyoshi Uedaf40c67f2009-06-22 10:12:37 +01001290 return r;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001291}
1292
Kiyoshi Uedaf40c67f2009-06-22 10:12:37 +01001293static int multipath_end_io(struct dm_target *ti, struct request *clone,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001294 int error, union map_info *map_context)
1295{
Alasdair G Kergon028867a2007-07-12 17:26:32 +01001296 struct multipath *m = ti->private;
1297 struct dm_mpath_io *mpio = map_context->ptr;
Wei Yongjuna71a2612012-10-12 16:59:42 +01001298 struct pgpath *pgpath;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001299 struct path_selector *ps;
1300 int r;
1301
Jun'ichi Nomura466891f2012-03-28 18:41:25 +01001302 BUG_ON(!mpio);
1303
Kiyoshi Uedaf40c67f2009-06-22 10:12:37 +01001304 r = do_end_io(m, clone, error, mpio);
Wei Yongjuna71a2612012-10-12 16:59:42 +01001305 pgpath = mpio->pgpath;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001306 if (pgpath) {
1307 ps = &pgpath->pg->ps;
1308 if (ps->type->end_io)
Kiyoshi Ueda02ab8232009-06-22 10:12:27 +01001309 ps->type->end_io(ps, &pgpath->path, mpio->nr_bytes);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001310 }
Jun'ichi Nomura466891f2012-03-28 18:41:25 +01001311 clear_mapinfo(m, map_context);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001312
1313 return r;
1314}
1315
1316/*
1317 * Suspend can't complete until all the I/O is processed so if
Alasdair G Kergon436d4102005-07-12 15:53:03 -07001318 * the last path fails we must error any remaining I/O.
1319 * Note that if the freeze_bdev fails while suspending, the
1320 * queue_if_no_path state is lost - userspace should reset it.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001321 */
1322static void multipath_presuspend(struct dm_target *ti)
1323{
1324 struct multipath *m = (struct multipath *) ti->private;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001325
Alasdair G Kergon485ef692005-09-27 21:45:45 -07001326 queue_if_no_path(m, 0, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001327}
1328
Kiyoshi Ueda6df400a2009-12-10 23:52:19 +00001329static void multipath_postsuspend(struct dm_target *ti)
1330{
Mike Anderson6380f262009-12-10 23:52:21 +00001331 struct multipath *m = ti->private;
1332
1333 mutex_lock(&m->work_mutex);
Kiyoshi Ueda2bded7b2010-03-06 02:32:13 +00001334 flush_multipath_work(m);
Mike Anderson6380f262009-12-10 23:52:21 +00001335 mutex_unlock(&m->work_mutex);
Kiyoshi Ueda6df400a2009-12-10 23:52:19 +00001336}
1337
Alasdair G Kergon436d4102005-07-12 15:53:03 -07001338/*
1339 * Restore the queue_if_no_path setting.
1340 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001341static void multipath_resume(struct dm_target *ti)
1342{
1343 struct multipath *m = (struct multipath *) ti->private;
1344 unsigned long flags;
1345
1346 spin_lock_irqsave(&m->lock, flags);
Alasdair G Kergon436d4102005-07-12 15:53:03 -07001347 m->queue_if_no_path = m->saved_queue_if_no_path;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001348 spin_unlock_irqrestore(&m->lock, flags);
1349}
1350
1351/*
1352 * Info output has the following format:
1353 * num_multipath_feature_args [multipath_feature_args]*
1354 * num_handler_status_args [handler_status_args]*
1355 * num_groups init_group_number
1356 * [A|D|E num_ps_status_args [ps_status_args]*
1357 * num_paths num_selector_args
1358 * [path_dev A|F fail_count [selector_args]* ]+ ]+
1359 *
1360 * Table output has the following format (identical to the constructor string):
1361 * num_feature_args [features_args]*
1362 * num_handler_args hw_handler [hw_handler_args]*
1363 * num_groups init_group_number
1364 * [priority selector-name num_ps_args [ps_args]*
1365 * num_paths num_selector_args [path_dev [selector_args]* ]+ ]+
1366 */
Mikulas Patockafd7c0922013-03-01 22:45:44 +00001367static void multipath_status(struct dm_target *ti, status_type_t type,
1368 unsigned status_flags, char *result, unsigned maxlen)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001369{
1370 int sz = 0;
1371 unsigned long flags;
1372 struct multipath *m = (struct multipath *) ti->private;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001373 struct priority_group *pg;
1374 struct pgpath *p;
1375 unsigned pg_num;
1376 char state;
1377
1378 spin_lock_irqsave(&m->lock, flags);
1379
1380 /* Features */
1381 if (type == STATUSTYPE_INFO)
Hannes Reineckee8099172014-02-28 15:33:44 +01001382 DMEMIT("2 %u %u ", m->queue_io, m->pg_init_count);
Dave Wysochanskic9e45582007-10-19 22:47:53 +01001383 else {
1384 DMEMIT("%u ", m->queue_if_no_path +
Chandra Seetharaman4e2d19e2011-01-13 20:00:01 +00001385 (m->pg_init_retries > 0) * 2 +
Mike Snitzera58a9352012-07-27 15:08:04 +01001386 (m->pg_init_delay_msecs != DM_PG_INIT_DELAY_DEFAULT) * 2 +
1387 m->retain_attached_hw_handler);
Dave Wysochanskic9e45582007-10-19 22:47:53 +01001388 if (m->queue_if_no_path)
1389 DMEMIT("queue_if_no_path ");
1390 if (m->pg_init_retries)
1391 DMEMIT("pg_init_retries %u ", m->pg_init_retries);
Chandra Seetharaman4e2d19e2011-01-13 20:00:01 +00001392 if (m->pg_init_delay_msecs != DM_PG_INIT_DELAY_DEFAULT)
1393 DMEMIT("pg_init_delay_msecs %u ", m->pg_init_delay_msecs);
Mike Snitzera58a9352012-07-27 15:08:04 +01001394 if (m->retain_attached_hw_handler)
1395 DMEMIT("retain_attached_hw_handler ");
Dave Wysochanskic9e45582007-10-19 22:47:53 +01001396 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001397
Chandra Seetharamancfae5c92008-05-01 14:50:11 -07001398 if (!m->hw_handler_name || type == STATUSTYPE_INFO)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001399 DMEMIT("0 ");
1400 else
Chandra Seetharamancfae5c92008-05-01 14:50:11 -07001401 DMEMIT("1 %s ", m->hw_handler_name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001402
1403 DMEMIT("%u ", m->nr_priority_groups);
1404
1405 if (m->next_pg)
1406 pg_num = m->next_pg->pg_num;
1407 else if (m->current_pg)
1408 pg_num = m->current_pg->pg_num;
1409 else
Mike Snitzera490a072011-03-24 13:54:33 +00001410 pg_num = (m->nr_priority_groups ? 1 : 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001411
1412 DMEMIT("%u ", pg_num);
1413
1414 switch (type) {
1415 case STATUSTYPE_INFO:
1416 list_for_each_entry(pg, &m->priority_groups, list) {
1417 if (pg->bypassed)
1418 state = 'D'; /* Disabled */
1419 else if (pg == m->current_pg)
1420 state = 'A'; /* Currently Active */
1421 else
1422 state = 'E'; /* Enabled */
1423
1424 DMEMIT("%c ", state);
1425
1426 if (pg->ps.type->status)
1427 sz += pg->ps.type->status(&pg->ps, NULL, type,
1428 result + sz,
1429 maxlen - sz);
1430 else
1431 DMEMIT("0 ");
1432
1433 DMEMIT("%u %u ", pg->nr_pgpaths,
1434 pg->ps.type->info_args);
1435
1436 list_for_each_entry(p, &pg->pgpaths, list) {
1437 DMEMIT("%s %s %u ", p->path.dev->name,
Kiyoshi Ueda66800732008-10-10 13:36:58 +01001438 p->is_active ? "A" : "F",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001439 p->fail_count);
1440 if (pg->ps.type->status)
1441 sz += pg->ps.type->status(&pg->ps,
1442 &p->path, type, result + sz,
1443 maxlen - sz);
1444 }
1445 }
1446 break;
1447
1448 case STATUSTYPE_TABLE:
1449 list_for_each_entry(pg, &m->priority_groups, list) {
1450 DMEMIT("%s ", pg->ps.type->name);
1451
1452 if (pg->ps.type->status)
1453 sz += pg->ps.type->status(&pg->ps, NULL, type,
1454 result + sz,
1455 maxlen - sz);
1456 else
1457 DMEMIT("0 ");
1458
1459 DMEMIT("%u %u ", pg->nr_pgpaths,
1460 pg->ps.type->table_args);
1461
1462 list_for_each_entry(p, &pg->pgpaths, list) {
1463 DMEMIT("%s ", p->path.dev->name);
1464 if (pg->ps.type->status)
1465 sz += pg->ps.type->status(&pg->ps,
1466 &p->path, type, result + sz,
1467 maxlen - sz);
1468 }
1469 }
1470 break;
1471 }
1472
1473 spin_unlock_irqrestore(&m->lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001474}
1475
1476static int multipath_message(struct dm_target *ti, unsigned argc, char **argv)
1477{
Mike Anderson6380f262009-12-10 23:52:21 +00001478 int r = -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001479 struct dm_dev *dev;
1480 struct multipath *m = (struct multipath *) ti->private;
1481 action_fn action;
1482
Mike Anderson6380f262009-12-10 23:52:21 +00001483 mutex_lock(&m->work_mutex);
1484
Kiyoshi Uedac2f3d242009-12-10 23:52:27 +00001485 if (dm_suspended(ti)) {
1486 r = -EBUSY;
1487 goto out;
1488 }
1489
Linus Torvalds1da177e2005-04-16 15:20:36 -07001490 if (argc == 1) {
Mike Snitzer498f0102011-08-02 12:32:04 +01001491 if (!strcasecmp(argv[0], "queue_if_no_path")) {
Mike Anderson6380f262009-12-10 23:52:21 +00001492 r = queue_if_no_path(m, 1, 0);
1493 goto out;
Mike Snitzer498f0102011-08-02 12:32:04 +01001494 } else if (!strcasecmp(argv[0], "fail_if_no_path")) {
Mike Anderson6380f262009-12-10 23:52:21 +00001495 r = queue_if_no_path(m, 0, 0);
1496 goto out;
1497 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001498 }
1499
Mike Anderson6380f262009-12-10 23:52:21 +00001500 if (argc != 2) {
Jose Castilloa356e422014-01-29 17:52:45 +01001501 DMWARN("Invalid multipath message arguments. Expected 2 arguments, got %d.", argc);
Mike Anderson6380f262009-12-10 23:52:21 +00001502 goto out;
1503 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001504
Mike Snitzer498f0102011-08-02 12:32:04 +01001505 if (!strcasecmp(argv[0], "disable_group")) {
Mike Anderson6380f262009-12-10 23:52:21 +00001506 r = bypass_pg_num(m, argv[1], 1);
1507 goto out;
Mike Snitzer498f0102011-08-02 12:32:04 +01001508 } else if (!strcasecmp(argv[0], "enable_group")) {
Mike Anderson6380f262009-12-10 23:52:21 +00001509 r = bypass_pg_num(m, argv[1], 0);
1510 goto out;
Mike Snitzer498f0102011-08-02 12:32:04 +01001511 } else if (!strcasecmp(argv[0], "switch_group")) {
Mike Anderson6380f262009-12-10 23:52:21 +00001512 r = switch_pg_num(m, argv[1]);
1513 goto out;
Mike Snitzer498f0102011-08-02 12:32:04 +01001514 } else if (!strcasecmp(argv[0], "reinstate_path"))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001515 action = reinstate_path;
Mike Snitzer498f0102011-08-02 12:32:04 +01001516 else if (!strcasecmp(argv[0], "fail_path"))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001517 action = fail_path;
Mike Anderson6380f262009-12-10 23:52:21 +00001518 else {
Jose Castilloa356e422014-01-29 17:52:45 +01001519 DMWARN("Unrecognised multipath message received: %s", argv[0]);
Mike Anderson6380f262009-12-10 23:52:21 +00001520 goto out;
1521 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001522
Nikanth Karthikesan8215d6e2010-03-06 02:32:27 +00001523 r = dm_get_device(ti, argv[1], dm_table_get_mode(ti->table), &dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001524 if (r) {
Alasdair G Kergon72d94862006-06-26 00:27:35 -07001525 DMWARN("message: error getting device %s",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001526 argv[1]);
Mike Anderson6380f262009-12-10 23:52:21 +00001527 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001528 }
1529
1530 r = action_dev(m, dev, action);
1531
1532 dm_put_device(ti, dev);
1533
Mike Anderson6380f262009-12-10 23:52:21 +00001534out:
1535 mutex_unlock(&m->work_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001536 return r;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001537}
1538
Christoph Hellwige56f81e2015-10-15 14:10:50 +02001539static int multipath_prepare_ioctl(struct dm_target *ti,
1540 struct block_device **bdev, fmode_t *mode)
Milan Broz9af4aa32006-10-03 01:15:20 -07001541{
Mikulas Patocka35991652012-06-03 00:29:58 +01001542 struct multipath *m = ti->private;
Milan Broz9af4aa32006-10-03 01:15:20 -07001543 unsigned long flags;
Mikulas Patocka35991652012-06-03 00:29:58 +01001544 int r;
1545
Milan Broz9af4aa32006-10-03 01:15:20 -07001546 spin_lock_irqsave(&m->lock, flags);
1547
1548 if (!m->current_pgpath)
Kiyoshi Ueda02ab8232009-06-22 10:12:27 +01001549 __choose_pgpath(m, 0);
Milan Broz9af4aa32006-10-03 01:15:20 -07001550
Junichi Nomura43e43c92015-11-17 09:36:56 +00001551 if (m->current_pgpath) {
1552 if (!m->queue_io) {
1553 *bdev = m->current_pgpath->path.dev->bdev;
1554 *mode = m->current_pgpath->path.dev->mode;
1555 r = 0;
1556 } else {
1557 /* pg_init has not started or completed */
1558 r = -ENOTCONN;
1559 }
1560 } else {
1561 /* No path is available */
1562 if (m->queue_if_no_path)
1563 r = -ENOTCONN;
1564 else
1565 r = -EIO;
Milan Broze90dae12006-10-03 01:15:22 -07001566 }
Milan Broz9af4aa32006-10-03 01:15:20 -07001567
Milan Broz9af4aa32006-10-03 01:15:20 -07001568 spin_unlock_irqrestore(&m->lock, flags);
1569
Junichi Nomura5bbbfdf2015-11-17 09:39:26 +00001570 if (r == -ENOTCONN) {
Hannes Reinecke3e9f1be2014-02-28 15:33:45 +01001571 spin_lock_irqsave(&m->lock, flags);
1572 if (!m->current_pg) {
1573 /* Path status changed, redo selection */
1574 __choose_pgpath(m, 0);
1575 }
1576 if (m->pg_init_required)
1577 __pg_init_all_paths(m);
Mike Snitzer4cdd2ad2014-05-13 13:49:39 -04001578 spin_unlock_irqrestore(&m->lock, flags);
Hannes Reinecke63d832c2014-05-26 14:45:39 +02001579 dm_table_run_md_queue_async(m->ti->table);
Hannes Reinecke3e9f1be2014-02-28 15:33:45 +01001580 }
Mikulas Patocka35991652012-06-03 00:29:58 +01001581
Christoph Hellwige56f81e2015-10-15 14:10:50 +02001582 /*
1583 * Only pass ioctls through if the device sizes match exactly.
1584 */
1585 if (!r && ti->len != i_size_read((*bdev)->bd_inode) >> SECTOR_SHIFT)
1586 return 1;
1587 return r;
Milan Broz9af4aa32006-10-03 01:15:20 -07001588}
1589
Mike Snitzeraf4874e2009-06-22 10:12:33 +01001590static int multipath_iterate_devices(struct dm_target *ti,
1591 iterate_devices_callout_fn fn, void *data)
1592{
1593 struct multipath *m = ti->private;
1594 struct priority_group *pg;
1595 struct pgpath *p;
1596 int ret = 0;
1597
1598 list_for_each_entry(pg, &m->priority_groups, list) {
1599 list_for_each_entry(p, &pg->pgpaths, list) {
Mike Snitzer5dea2712009-07-23 20:30:42 +01001600 ret = fn(ti, p->path.dev, ti->begin, ti->len, data);
Mike Snitzeraf4874e2009-06-22 10:12:33 +01001601 if (ret)
1602 goto out;
1603 }
1604 }
1605
1606out:
1607 return ret;
1608}
1609
Kiyoshi Uedaf40c67f2009-06-22 10:12:37 +01001610static int __pgpath_busy(struct pgpath *pgpath)
1611{
1612 struct request_queue *q = bdev_get_queue(pgpath->path.dev->bdev);
1613
Mike Snitzer52b09912015-02-23 16:36:41 -05001614 return blk_lld_busy(q);
Kiyoshi Uedaf40c67f2009-06-22 10:12:37 +01001615}
1616
1617/*
1618 * We return "busy", only when we can map I/Os but underlying devices
1619 * are busy (so even if we map I/Os now, the I/Os will wait on
1620 * the underlying queue).
1621 * In other words, if we want to kill I/Os or queue them inside us
1622 * due to map unavailability, we don't return "busy". Otherwise,
1623 * dm core won't give us the I/Os and we can't do what we want.
1624 */
1625static int multipath_busy(struct dm_target *ti)
1626{
1627 int busy = 0, has_active = 0;
1628 struct multipath *m = ti->private;
1629 struct priority_group *pg;
1630 struct pgpath *pgpath;
1631 unsigned long flags;
1632
1633 spin_lock_irqsave(&m->lock, flags);
1634
Jun'ichi Nomura7a7a3b42014-07-08 00:55:14 +00001635 /* pg_init in progress or no paths available */
1636 if (m->pg_init_in_progress ||
1637 (!m->nr_valid_paths && m->queue_if_no_path)) {
Hannes Reineckeb63349a2013-10-01 11:49:56 +02001638 busy = 1;
1639 goto out;
1640 }
Kiyoshi Uedaf40c67f2009-06-22 10:12:37 +01001641 /* Guess which priority_group will be used at next mapping time */
1642 if (unlikely(!m->current_pgpath && m->next_pg))
1643 pg = m->next_pg;
1644 else if (likely(m->current_pg))
1645 pg = m->current_pg;
1646 else
1647 /*
1648 * We don't know which pg will be used at next mapping time.
1649 * We don't call __choose_pgpath() here to avoid to trigger
1650 * pg_init just by busy checking.
1651 * So we don't know whether underlying devices we will be using
1652 * at next mapping time are busy or not. Just try mapping.
1653 */
1654 goto out;
1655
1656 /*
1657 * If there is one non-busy active path at least, the path selector
1658 * will be able to select it. So we consider such a pg as not busy.
1659 */
1660 busy = 1;
1661 list_for_each_entry(pgpath, &pg->pgpaths, list)
1662 if (pgpath->is_active) {
1663 has_active = 1;
1664
1665 if (!__pgpath_busy(pgpath)) {
1666 busy = 0;
1667 break;
1668 }
1669 }
1670
1671 if (!has_active)
1672 /*
1673 * No active path in this pg, so this pg won't be used and
1674 * the current_pg will be changed at next mapping time.
1675 * We need to try mapping to determine it.
1676 */
1677 busy = 0;
1678
1679out:
1680 spin_unlock_irqrestore(&m->lock, flags);
1681
1682 return busy;
1683}
1684
Linus Torvalds1da177e2005-04-16 15:20:36 -07001685/*-----------------------------------------------------------------
1686 * Module setup
1687 *---------------------------------------------------------------*/
1688static struct target_type multipath_target = {
1689 .name = "multipath",
Mike Snitzer16f12262016-01-31 17:22:27 -05001690 .version = {1, 11, 0},
1691 .features = DM_TARGET_SINGLETON | DM_TARGET_IMMUTABLE,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001692 .module = THIS_MODULE,
1693 .ctr = multipath_ctr,
1694 .dtr = multipath_dtr,
Kiyoshi Uedaf40c67f2009-06-22 10:12:37 +01001695 .map_rq = multipath_map,
Mike Snitzere5863d92014-12-17 21:08:12 -05001696 .clone_and_map_rq = multipath_clone_and_map,
1697 .release_clone_rq = multipath_release_clone,
Kiyoshi Uedaf40c67f2009-06-22 10:12:37 +01001698 .rq_end_io = multipath_end_io,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001699 .presuspend = multipath_presuspend,
Kiyoshi Ueda6df400a2009-12-10 23:52:19 +00001700 .postsuspend = multipath_postsuspend,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001701 .resume = multipath_resume,
1702 .status = multipath_status,
1703 .message = multipath_message,
Christoph Hellwige56f81e2015-10-15 14:10:50 +02001704 .prepare_ioctl = multipath_prepare_ioctl,
Mike Snitzeraf4874e2009-06-22 10:12:33 +01001705 .iterate_devices = multipath_iterate_devices,
Kiyoshi Uedaf40c67f2009-06-22 10:12:37 +01001706 .busy = multipath_busy,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001707};
1708
1709static int __init dm_multipath_init(void)
1710{
1711 int r;
1712
1713 /* allocate a slab for the dm_ios */
Alasdair G Kergon028867a2007-07-12 17:26:32 +01001714 _mpio_cache = KMEM_CACHE(dm_mpath_io, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001715 if (!_mpio_cache)
1716 return -ENOMEM;
1717
1718 r = dm_register_target(&multipath_target);
1719 if (r < 0) {
Alasdair G Kergon0cd33122007-07-12 17:27:01 +01001720 DMERR("register failed %d", r);
Johannes Thumshirnff658e92015-01-11 12:45:23 +01001721 r = -EINVAL;
1722 goto bad_register_target;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001723 }
1724
Tejun Heo4d4d66a2011-01-13 19:59:57 +00001725 kmultipathd = alloc_workqueue("kmpathd", WQ_MEM_RECLAIM, 0);
Alasdair G Kergonc5573082005-05-05 16:16:07 -07001726 if (!kmultipathd) {
Alasdair G Kergon0cd33122007-07-12 17:27:01 +01001727 DMERR("failed to create workqueue kmpathd");
Johannes Thumshirnff658e92015-01-11 12:45:23 +01001728 r = -ENOMEM;
1729 goto bad_alloc_kmultipathd;
Alasdair G Kergonc5573082005-05-05 16:16:07 -07001730 }
1731
Chandra Seetharamanbab7cfc2008-05-01 14:50:22 -07001732 /*
1733 * A separate workqueue is used to handle the device handlers
1734 * to avoid overloading existing workqueue. Overloading the
1735 * old workqueue would also create a bottleneck in the
1736 * path of the storage hardware device activation.
1737 */
Tejun Heo4d4d66a2011-01-13 19:59:57 +00001738 kmpath_handlerd = alloc_ordered_workqueue("kmpath_handlerd",
1739 WQ_MEM_RECLAIM);
Chandra Seetharamanbab7cfc2008-05-01 14:50:22 -07001740 if (!kmpath_handlerd) {
1741 DMERR("failed to create workqueue kmpath_handlerd");
Johannes Thumshirnff658e92015-01-11 12:45:23 +01001742 r = -ENOMEM;
1743 goto bad_alloc_kmpath_handlerd;
Chandra Seetharamanbab7cfc2008-05-01 14:50:22 -07001744 }
1745
Alasdair G Kergon72d94862006-06-26 00:27:35 -07001746 DMINFO("version %u.%u.%u loaded",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001747 multipath_target.version[0], multipath_target.version[1],
1748 multipath_target.version[2]);
1749
Johannes Thumshirnff658e92015-01-11 12:45:23 +01001750 return 0;
1751
1752bad_alloc_kmpath_handlerd:
1753 destroy_workqueue(kmultipathd);
1754bad_alloc_kmultipathd:
1755 dm_unregister_target(&multipath_target);
1756bad_register_target:
1757 kmem_cache_destroy(_mpio_cache);
1758
Linus Torvalds1da177e2005-04-16 15:20:36 -07001759 return r;
1760}
1761
1762static void __exit dm_multipath_exit(void)
1763{
Chandra Seetharamanbab7cfc2008-05-01 14:50:22 -07001764 destroy_workqueue(kmpath_handlerd);
Alasdair G Kergonc5573082005-05-05 16:16:07 -07001765 destroy_workqueue(kmultipathd);
1766
Mikulas Patocka10d3bd02009-01-06 03:04:58 +00001767 dm_unregister_target(&multipath_target);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001768 kmem_cache_destroy(_mpio_cache);
1769}
1770
Linus Torvalds1da177e2005-04-16 15:20:36 -07001771module_init(dm_multipath_init);
1772module_exit(dm_multipath_exit);
1773
1774MODULE_DESCRIPTION(DM_NAME " multipath target");
1775MODULE_AUTHOR("Sistina Software <dm-devel@redhat.com>");
1776MODULE_LICENSE("GPL");