Merge tag 'microblaze-3.19-rc1' of git://git.monstr.eu/linux-2.6-microblaze
[deliverable/linux.git] / drivers / md / dm-mpath.c
CommitLineData
1da177e4
LT
1/*
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
586e80e6
MP
8#include <linux/device-mapper.h>
9
f4790826 10#include "dm.h"
1da177e4 11#include "dm-path-selector.h"
b15546f9 12#include "dm-uevent.h"
1da177e4
LT
13
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>
35991652 22#include <linux/delay.h>
cfae5c9b 23#include <scsi/scsi_dh.h>
60063497 24#include <linux/atomic.h>
1da177e4 25
72d94861 26#define DM_MSG_PREFIX "multipath"
4e2d19e4
CS
27#define DM_PG_INIT_DELAY_MSECS 2000
28#define DM_PG_INIT_DELAY_DEFAULT ((unsigned) -1)
1da177e4
LT
29
30/* Path properties */
31struct pgpath {
32 struct list_head list;
33
34 struct priority_group *pg; /* Owning PG */
6680073d 35 unsigned is_active; /* Path status */
1da177e4
LT
36 unsigned fail_count; /* Cumulative failure count */
37
c922d5f7 38 struct dm_path path;
4e2d19e4 39 struct delayed_work activate_path;
1da177e4
LT
40};
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
cfae5c9b 66 const char *hw_handler_name;
2bfd2e13 67 char *hw_handler_params;
4e2d19e4 68
1fbdd2b3
MS
69 spinlock_t lock;
70
1da177e4
LT
71 unsigned nr_priority_groups;
72 struct list_head priority_groups;
4e2d19e4
CS
73
74 wait_queue_head_t pg_init_wait; /* Wait for pg_init completion */
75
1da177e4 76 unsigned pg_init_required; /* pg_init needs calling? */
c3cd4f6b 77 unsigned pg_init_in_progress; /* Only one pg_init allowed at once */
4e2d19e4 78 unsigned pg_init_delay_retry; /* Delay pg_init retry? */
1da177e4
LT
79
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
1fbdd2b3
MS
86 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 */
a58a935d 89 unsigned retain_attached_hw_handler:1; /* If there's already a hw_handler present, don't change it. */
954a73d5 90 unsigned pg_init_disabled:1; /* pg_init is not currently allowed */
1fbdd2b3 91
c9e45581
DW
92 unsigned pg_init_retries; /* Number of times to retry pg_init */
93 unsigned pg_init_count; /* Number of times pg_init called */
4e2d19e4 94 unsigned pg_init_delay_msecs; /* Number of msecs before pg_init retry */
1da177e4 95
1da177e4
LT
96 struct work_struct trigger_event;
97
98 /*
028867ac 99 * We must use a mempool of dm_mpath_io structs so that we
1da177e4
LT
100 * can resubmit bios on error.
101 */
102 mempool_t *mpio_pool;
6380f26f
MA
103
104 struct mutex work_mutex;
1da177e4
LT
105};
106
107/*
108 * Context information attached to each bio we process.
109 */
028867ac 110struct dm_mpath_io {
1da177e4 111 struct pgpath *pgpath;
02ab823f 112 size_t nr_bytes;
1da177e4
LT
113};
114
115typedef int (*action_fn) (struct pgpath *pgpath);
116
e18b890b 117static struct kmem_cache *_mpio_cache;
1da177e4 118
bab7cfc7 119static struct workqueue_struct *kmultipathd, *kmpath_handlerd;
c4028958 120static void trigger_event(struct work_struct *work);
bab7cfc7 121static void activate_path(struct work_struct *work);
e8099177 122static int __pgpath_busy(struct pgpath *pgpath);
1da177e4
LT
123
124
125/*-----------------------------------------------
126 * Allocation routines
127 *-----------------------------------------------*/
128
129static struct pgpath *alloc_pgpath(void)
130{
e69fae56 131 struct pgpath *pgpath = kzalloc(sizeof(*pgpath), GFP_KERNEL);
1da177e4 132
224cb3e9 133 if (pgpath) {
6680073d 134 pgpath->is_active = 1;
4e2d19e4 135 INIT_DELAYED_WORK(&pgpath->activate_path, activate_path);
224cb3e9 136 }
1da177e4
LT
137
138 return pgpath;
139}
140
028867ac 141static void free_pgpath(struct pgpath *pgpath)
1da177e4
LT
142{
143 kfree(pgpath);
144}
145
146static struct priority_group *alloc_priority_group(void)
147{
148 struct priority_group *pg;
149
e69fae56 150 pg = kzalloc(sizeof(*pg), GFP_KERNEL);
1da177e4 151
e69fae56
MM
152 if (pg)
153 INIT_LIST_HEAD(&pg->pgpaths);
1da177e4
LT
154
155 return pg;
156}
157
158static void free_pgpaths(struct list_head *pgpaths, struct dm_target *ti)
159{
160 struct pgpath *pgpath, *tmp;
ae11b1b3 161 struct multipath *m = ti->private;
1da177e4
LT
162
163 list_for_each_entry_safe(pgpath, tmp, pgpaths, list) {
164 list_del(&pgpath->list);
ae11b1b3
HR
165 if (m->hw_handler_name)
166 scsi_dh_detach(bdev_get_queue(pgpath->path.dev->bdev));
1da177e4
LT
167 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
28f16c20 186static struct multipath *alloc_multipath(struct dm_target *ti)
1da177e4
LT
187{
188 struct multipath *m;
f4790826 189 unsigned min_ios = dm_get_reserved_rq_based_ios();
1da177e4 190
e69fae56 191 m = kzalloc(sizeof(*m), GFP_KERNEL);
1da177e4 192 if (m) {
1da177e4
LT
193 INIT_LIST_HEAD(&m->priority_groups);
194 spin_lock_init(&m->lock);
195 m->queue_io = 1;
4e2d19e4 196 m->pg_init_delay_msecs = DM_PG_INIT_DELAY_DEFAULT;
c4028958 197 INIT_WORK(&m->trigger_event, trigger_event);
2bded7bd 198 init_waitqueue_head(&m->pg_init_wait);
6380f26f 199 mutex_init(&m->work_mutex);
f4790826 200 m->mpio_pool = mempool_create_slab_pool(min_ios, _mpio_cache);
1da177e4
LT
201 if (!m->mpio_pool) {
202 kfree(m);
203 return NULL;
204 }
28f16c20
MM
205 m->ti = ti;
206 ti->private = m;
1da177e4
LT
207 }
208
209 return m;
210}
211
212static void free_multipath(struct multipath *m)
213{
214 struct priority_group *pg, *tmp;
1da177e4
LT
215
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
cfae5c9b 221 kfree(m->hw_handler_name);
2bfd2e13 222 kfree(m->hw_handler_params);
1da177e4
LT
223 mempool_destroy(m->mpio_pool);
224 kfree(m);
225}
226
466891f9
JN
227static 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}
1da177e4
LT
248
249/*-----------------------------------------------
250 * Path selection
251 *-----------------------------------------------*/
252
3e9f1be1 253static int __pg_init_all_paths(struct multipath *m)
fb612642
KU
254{
255 struct pgpath *pgpath;
4e2d19e4 256 unsigned long pg_init_delay = 0;
fb612642 257
17f4ff45 258 if (m->pg_init_in_progress || m->pg_init_disabled)
3e9f1be1 259 return 0;
17f4ff45 260
fb612642
KU
261 m->pg_init_count++;
262 m->pg_init_required = 0;
3e9f1be1
HR
263
264 /* Check here to reset pg_init_required */
265 if (!m->current_pg)
266 return 0;
267
4e2d19e4
CS
268 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);
fb612642
KU
271 list_for_each_entry(pgpath, &m->current_pg->pgpaths, list) {
272 /* Skip failed paths */
273 if (!pgpath->is_active)
274 continue;
4e2d19e4
CS
275 if (queue_delayed_work(kmpath_handlerd, &pgpath->activate_path,
276 pg_init_delay))
fb612642
KU
277 m->pg_init_in_progress++;
278 }
3e9f1be1 279 return m->pg_init_in_progress;
fb612642
KU
280}
281
1da177e4
LT
282static void __switch_pg(struct multipath *m, struct pgpath *pgpath)
283{
1da177e4
LT
284 m->current_pg = pgpath->pg;
285
286 /* Must we initialise the PG first, and queue I/O till it's ready? */
cfae5c9b 287 if (m->hw_handler_name) {
1da177e4
LT
288 m->pg_init_required = 1;
289 m->queue_io = 1;
290 } else {
291 m->pg_init_required = 0;
292 m->queue_io = 0;
293 }
c9e45581
DW
294
295 m->pg_init_count = 0;
1da177e4
LT
296}
297
02ab823f
KU
298static int __choose_path_in_pg(struct multipath *m, struct priority_group *pg,
299 size_t nr_bytes)
1da177e4 300{
c922d5f7 301 struct dm_path *path;
1da177e4 302
02ab823f 303 path = pg->ps.type->select_path(&pg->ps, &m->repeat_count, nr_bytes);
1da177e4
LT
304 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
02ab823f 315static void __choose_pgpath(struct multipath *m, size_t nr_bytes)
1da177e4
LT
316{
317 struct priority_group *pg;
318 unsigned bypassed = 1;
319
1f271972
BM
320 if (!m->nr_valid_paths) {
321 m->queue_io = 0;
1da177e4 322 goto failed;
1f271972 323 }
1da177e4
LT
324
325 /* Were we instructed to switch PG? */
326 if (m->next_pg) {
327 pg = m->next_pg;
328 m->next_pg = NULL;
02ab823f 329 if (!__choose_path_in_pg(m, pg, nr_bytes))
1da177e4
LT
330 return;
331 }
332
333 /* Don't change PG until it has no remaining paths */
02ab823f 334 if (m->current_pg && !__choose_path_in_pg(m, m->current_pg, nr_bytes))
1da177e4
LT
335 return;
336
337 /*
338 * Loop through priority groups until we find a valid path.
339 * First time we skip PGs marked 'bypassed'.
f220fd4e
MC
340 * Second time we only try the ones we skipped, but set
341 * pg_init_delay_retry so we do not hammer controllers.
1da177e4
LT
342 */
343 do {
344 list_for_each_entry(pg, &m->priority_groups, list) {
345 if (pg->bypassed == bypassed)
346 continue;
f220fd4e
MC
347 if (!__choose_path_in_pg(m, pg, nr_bytes)) {
348 if (!bypassed)
349 m->pg_init_delay_retry = 1;
1da177e4 350 return;
f220fd4e 351 }
1da177e4
LT
352 }
353 } while (bypassed--);
354
355failed:
356 m->current_pgpath = NULL;
357 m->current_pg = NULL;
358}
359
45e15720
KU
360/*
361 * Check whether bios must be queued in the device-mapper core rather
362 * than here in the target.
363 *
364 * m->lock must be held on entry.
365 *
366 * If m->queue_if_no_path and m->saved_queue_if_no_path hold the
367 * same value then we are not between multipath_presuspend()
368 * and multipath_resume() calls and we have no need to check
369 * for the DMF_NOFLUSH_SUSPENDING flag.
370 */
371static int __must_push_back(struct multipath *m)
372{
e8099177
HR
373 return (m->queue_if_no_path ||
374 (m->queue_if_no_path != m->saved_queue_if_no_path &&
375 dm_noflush_suspending(m->ti)));
45e15720
KU
376}
377
36fcffcc
HR
378/*
379 * Map cloned requests
380 */
381static int multipath_map(struct dm_target *ti, struct request *clone,
382 union map_info *map_context)
1da177e4 383{
36fcffcc 384 struct multipath *m = (struct multipath *) ti->private;
e3bde04f 385 int r = DM_MAPIO_REQUEUE;
f40c67f0 386 size_t nr_bytes = blk_rq_bytes(clone);
1da177e4
LT
387 unsigned long flags;
388 struct pgpath *pgpath;
f40c67f0 389 struct block_device *bdev;
e3bde04f 390 struct dm_mpath_io *mpio;
1da177e4
LT
391
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)))
02ab823f 397 __choose_pgpath(m, nr_bytes);
1da177e4
LT
398
399 pgpath = m->current_pgpath;
400
9bf59a61
MS
401 if (!pgpath) {
402 if (!__must_push_back(m))
403 r = -EIO; /* Failed */
404 goto out_unlock;
6afbc01d 405 } else if (m->queue_io || m->pg_init_required) {
e3bde04f 406 __pg_init_all_paths(m);
9bf59a61
MS
407 goto out_unlock;
408 }
6afbc01d 409
9bf59a61
MS
410 if (set_mapinfo(m, map_context) < 0)
411 /* ENOMEM, requeue */
412 goto out_unlock;
413
414 bdev = pgpath->path.dev->bdev;
415 clone->q = bdev_get_queue(bdev);
416 clone->rq_disk = bdev->bd_disk;
417 clone->cmd_flags |= REQ_FAILFAST_TRANSPORT;
418 mpio = map_context->ptr;
419 mpio->pgpath = pgpath;
420 mpio->nr_bytes = nr_bytes;
421 if (pgpath->pg->ps.type->start_io)
422 pgpath->pg->ps.type->start_io(&pgpath->pg->ps,
423 &pgpath->path,
424 nr_bytes);
425 r = DM_MAPIO_REMAPPED;
1da177e4 426
e3bde04f 427out_unlock:
1da177e4
LT
428 spin_unlock_irqrestore(&m->lock, flags);
429
430 return r;
431}
432
433/*
434 * If we run out of usable paths, should we queue I/O or error it?
435 */
485ef69e
AK
436static int queue_if_no_path(struct multipath *m, unsigned queue_if_no_path,
437 unsigned save_old_value)
1da177e4
LT
438{
439 unsigned long flags;
440
441 spin_lock_irqsave(&m->lock, flags);
442
485ef69e
AK
443 if (save_old_value)
444 m->saved_queue_if_no_path = m->queue_if_no_path;
445 else
446 m->saved_queue_if_no_path = queue_if_no_path;
1da177e4 447 m->queue_if_no_path = queue_if_no_path;
1da177e4
LT
448 spin_unlock_irqrestore(&m->lock, flags);
449
63d832c3
HR
450 if (!queue_if_no_path)
451 dm_table_run_md_queue_async(m->ti->table);
452
1da177e4
LT
453 return 0;
454}
455
1da177e4
LT
456/*
457 * An event is triggered whenever a path is taken out of use.
458 * Includes path failure and PG bypass.
459 */
c4028958 460static void trigger_event(struct work_struct *work)
1da177e4 461{
c4028958
DH
462 struct multipath *m =
463 container_of(work, struct multipath, trigger_event);
1da177e4
LT
464
465 dm_table_event(m->ti->table);
466}
467
468/*-----------------------------------------------------------------
469 * Constructor/argument parsing:
470 * <#multipath feature args> [<arg>]*
471 * <#hw_handler args> [hw_handler [<arg>]*]
472 * <#priority groups>
473 * <initial priority group>
474 * [<selector> <#selector args> [<arg>]*
475 * <#paths> <#per-path selector args>
476 * [<path> [<arg>]* ]+ ]+
477 *---------------------------------------------------------------*/
498f0103 478static int parse_path_selector(struct dm_arg_set *as, struct priority_group *pg,
1da177e4
LT
479 struct dm_target *ti)
480{
481 int r;
482 struct path_selector_type *pst;
483 unsigned ps_argc;
484
498f0103 485 static struct dm_arg _args[] = {
72d94861 486 {0, 1024, "invalid number of path selector args"},
1da177e4
LT
487 };
488
498f0103 489 pst = dm_get_path_selector(dm_shift_arg(as));
1da177e4 490 if (!pst) {
72d94861 491 ti->error = "unknown path selector type";
1da177e4
LT
492 return -EINVAL;
493 }
494
498f0103 495 r = dm_read_arg_group(_args, as, &ps_argc, &ti->error);
371b2e34
MP
496 if (r) {
497 dm_put_path_selector(pst);
1da177e4 498 return -EINVAL;
371b2e34 499 }
1da177e4
LT
500
501 r = pst->create(&pg->ps, ps_argc, as->argv);
502 if (r) {
503 dm_put_path_selector(pst);
72d94861 504 ti->error = "path selector constructor failed";
1da177e4
LT
505 return r;
506 }
507
508 pg->ps.type = pst;
498f0103 509 dm_consume_args(as, ps_argc);
1da177e4
LT
510
511 return 0;
512}
513
498f0103 514static struct pgpath *parse_path(struct dm_arg_set *as, struct path_selector *ps,
1da177e4
LT
515 struct dm_target *ti)
516{
517 int r;
518 struct pgpath *p;
ae11b1b3 519 struct multipath *m = ti->private;
a58a935d
MS
520 struct request_queue *q = NULL;
521 const char *attached_handler_name;
1da177e4
LT
522
523 /* we need at least a path arg */
524 if (as->argc < 1) {
72d94861 525 ti->error = "no device given";
01460f35 526 return ERR_PTR(-EINVAL);
1da177e4
LT
527 }
528
529 p = alloc_pgpath();
530 if (!p)
01460f35 531 return ERR_PTR(-ENOMEM);
1da177e4 532
498f0103 533 r = dm_get_device(ti, dm_shift_arg(as), dm_table_get_mode(ti->table),
8215d6ec 534 &p->path.dev);
1da177e4 535 if (r) {
72d94861 536 ti->error = "error getting device";
1da177e4
LT
537 goto bad;
538 }
539
a58a935d
MS
540 if (m->retain_attached_hw_handler || m->hw_handler_name)
541 q = bdev_get_queue(p->path.dev->bdev);
542
543 if (m->retain_attached_hw_handler) {
544 attached_handler_name = scsi_dh_attached_handler_name(q, GFP_KERNEL);
545 if (attached_handler_name) {
546 /*
547 * Reset hw_handler_name to match the attached handler
548 * and clear any hw_handler_params associated with the
549 * ignored handler.
550 *
551 * NB. This modifies the table line to show the actual
552 * handler instead of the original table passed in.
553 */
554 kfree(m->hw_handler_name);
555 m->hw_handler_name = attached_handler_name;
556
557 kfree(m->hw_handler_params);
558 m->hw_handler_params = NULL;
559 }
560 }
a0cf7ea9 561
a58a935d
MS
562 if (m->hw_handler_name) {
563 /*
564 * Increments scsi_dh reference, even when using an
565 * already-attached handler.
566 */
a0cf7ea9
HR
567 r = scsi_dh_attach(q, m->hw_handler_name);
568 if (r == -EBUSY) {
569 /*
a58a935d 570 * Already attached to different hw_handler:
a0cf7ea9
HR
571 * try to reattach with correct one.
572 */
573 scsi_dh_detach(q);
574 r = scsi_dh_attach(q, m->hw_handler_name);
575 }
576
ae11b1b3 577 if (r < 0) {
a0cf7ea9 578 ti->error = "error attaching hardware handler";
ae11b1b3
HR
579 dm_put_device(ti, p->path.dev);
580 goto bad;
581 }
2bfd2e13
CS
582
583 if (m->hw_handler_params) {
584 r = scsi_dh_set_params(q, m->hw_handler_params);
585 if (r < 0) {
586 ti->error = "unable to set hardware "
587 "handler parameters";
588 scsi_dh_detach(q);
589 dm_put_device(ti, p->path.dev);
590 goto bad;
591 }
592 }
ae11b1b3
HR
593 }
594
1da177e4
LT
595 r = ps->type->add_path(ps, &p->path, as->argc, as->argv, &ti->error);
596 if (r) {
597 dm_put_device(ti, p->path.dev);
598 goto bad;
599 }
600
601 return p;
602
603 bad:
604 free_pgpath(p);
01460f35 605 return ERR_PTR(r);
1da177e4
LT
606}
607
498f0103 608static struct priority_group *parse_priority_group(struct dm_arg_set *as,
28f16c20 609 struct multipath *m)
1da177e4 610{
498f0103 611 static struct dm_arg _args[] = {
72d94861
AK
612 {1, 1024, "invalid number of paths"},
613 {0, 1024, "invalid number of selector args"}
1da177e4
LT
614 };
615
616 int r;
498f0103 617 unsigned i, nr_selector_args, nr_args;
1da177e4 618 struct priority_group *pg;
28f16c20 619 struct dm_target *ti = m->ti;
1da177e4
LT
620
621 if (as->argc < 2) {
622 as->argc = 0;
01460f35
BM
623 ti->error = "not enough priority group arguments";
624 return ERR_PTR(-EINVAL);
1da177e4
LT
625 }
626
627 pg = alloc_priority_group();
628 if (!pg) {
72d94861 629 ti->error = "couldn't allocate priority group";
01460f35 630 return ERR_PTR(-ENOMEM);
1da177e4
LT
631 }
632 pg->m = m;
633
634 r = parse_path_selector(as, pg, ti);
635 if (r)
636 goto bad;
637
638 /*
639 * read the paths
640 */
498f0103 641 r = dm_read_arg(_args, as, &pg->nr_pgpaths, &ti->error);
1da177e4
LT
642 if (r)
643 goto bad;
644
498f0103 645 r = dm_read_arg(_args + 1, as, &nr_selector_args, &ti->error);
1da177e4
LT
646 if (r)
647 goto bad;
648
498f0103 649 nr_args = 1 + nr_selector_args;
1da177e4
LT
650 for (i = 0; i < pg->nr_pgpaths; i++) {
651 struct pgpath *pgpath;
498f0103 652 struct dm_arg_set path_args;
1da177e4 653
498f0103 654 if (as->argc < nr_args) {
148acff6 655 ti->error = "not enough path parameters";
6bbf79a1 656 r = -EINVAL;
1da177e4 657 goto bad;
148acff6 658 }
1da177e4 659
498f0103 660 path_args.argc = nr_args;
1da177e4
LT
661 path_args.argv = as->argv;
662
663 pgpath = parse_path(&path_args, &pg->ps, ti);
01460f35
BM
664 if (IS_ERR(pgpath)) {
665 r = PTR_ERR(pgpath);
1da177e4 666 goto bad;
01460f35 667 }
1da177e4
LT
668
669 pgpath->pg = pg;
670 list_add_tail(&pgpath->list, &pg->pgpaths);
498f0103 671 dm_consume_args(as, nr_args);
1da177e4
LT
672 }
673
674 return pg;
675
676 bad:
677 free_priority_group(pg, ti);
01460f35 678 return ERR_PTR(r);
1da177e4
LT
679}
680
498f0103 681static int parse_hw_handler(struct dm_arg_set *as, struct multipath *m)
1da177e4 682{
1da177e4 683 unsigned hw_argc;
2bfd2e13 684 int ret;
28f16c20 685 struct dm_target *ti = m->ti;
1da177e4 686
498f0103 687 static struct dm_arg _args[] = {
72d94861 688 {0, 1024, "invalid number of hardware handler args"},
1da177e4
LT
689 };
690
498f0103 691 if (dm_read_arg_group(_args, as, &hw_argc, &ti->error))
1da177e4
LT
692 return -EINVAL;
693
694 if (!hw_argc)
695 return 0;
696
498f0103 697 m->hw_handler_name = kstrdup(dm_shift_arg(as), GFP_KERNEL);
510193a2
MS
698 if (!try_then_request_module(scsi_dh_handler_exist(m->hw_handler_name),
699 "scsi_dh_%s", m->hw_handler_name)) {
72d94861 700 ti->error = "unknown hardware handler type";
2bfd2e13
CS
701 ret = -EINVAL;
702 goto fail;
1da177e4 703 }
14e98c5c 704
2bfd2e13
CS
705 if (hw_argc > 1) {
706 char *p;
707 int i, j, len = 4;
708
709 for (i = 0; i <= hw_argc - 2; i++)
710 len += strlen(as->argv[i]) + 1;
711 p = m->hw_handler_params = kzalloc(len, GFP_KERNEL);
712 if (!p) {
713 ti->error = "memory allocation failed";
714 ret = -ENOMEM;
715 goto fail;
716 }
717 j = sprintf(p, "%d", hw_argc - 1);
718 for (i = 0, p+=j+1; i <= hw_argc - 2; i++, p+=j+1)
719 j = sprintf(p, "%s", as->argv[i]);
720 }
498f0103 721 dm_consume_args(as, hw_argc - 1);
1da177e4
LT
722
723 return 0;
2bfd2e13
CS
724fail:
725 kfree(m->hw_handler_name);
726 m->hw_handler_name = NULL;
727 return ret;
1da177e4
LT
728}
729
498f0103 730static int parse_features(struct dm_arg_set *as, struct multipath *m)
1da177e4
LT
731{
732 int r;
733 unsigned argc;
28f16c20 734 struct dm_target *ti = m->ti;
498f0103 735 const char *arg_name;
1da177e4 736
498f0103 737 static struct dm_arg _args[] = {
a58a935d 738 {0, 6, "invalid number of feature args"},
c9e45581 739 {1, 50, "pg_init_retries must be between 1 and 50"},
4e2d19e4 740 {0, 60000, "pg_init_delay_msecs must be between 0 and 60000"},
1da177e4
LT
741 };
742
498f0103 743 r = dm_read_arg_group(_args, as, &argc, &ti->error);
1da177e4
LT
744 if (r)
745 return -EINVAL;
746
747 if (!argc)
748 return 0;
749
c9e45581 750 do {
498f0103 751 arg_name = dm_shift_arg(as);
c9e45581
DW
752 argc--;
753
498f0103 754 if (!strcasecmp(arg_name, "queue_if_no_path")) {
c9e45581
DW
755 r = queue_if_no_path(m, 1, 0);
756 continue;
757 }
758
a58a935d
MS
759 if (!strcasecmp(arg_name, "retain_attached_hw_handler")) {
760 m->retain_attached_hw_handler = 1;
761 continue;
762 }
763
498f0103 764 if (!strcasecmp(arg_name, "pg_init_retries") &&
c9e45581 765 (argc >= 1)) {
498f0103 766 r = dm_read_arg(_args + 1, as, &m->pg_init_retries, &ti->error);
c9e45581
DW
767 argc--;
768 continue;
769 }
770
498f0103 771 if (!strcasecmp(arg_name, "pg_init_delay_msecs") &&
4e2d19e4 772 (argc >= 1)) {
498f0103 773 r = dm_read_arg(_args + 2, as, &m->pg_init_delay_msecs, &ti->error);
4e2d19e4
CS
774 argc--;
775 continue;
776 }
777
1da177e4 778 ti->error = "Unrecognised multipath feature request";
c9e45581
DW
779 r = -EINVAL;
780 } while (argc && !r);
781
782 return r;
1da177e4
LT
783}
784
785static int multipath_ctr(struct dm_target *ti, unsigned int argc,
786 char **argv)
787{
498f0103
MS
788 /* target arguments */
789 static struct dm_arg _args[] = {
a490a07a
MS
790 {0, 1024, "invalid number of priority groups"},
791 {0, 1024, "invalid initial priority group number"},
1da177e4
LT
792 };
793
794 int r;
795 struct multipath *m;
498f0103 796 struct dm_arg_set as;
1da177e4
LT
797 unsigned pg_count = 0;
798 unsigned next_pg_num;
799
800 as.argc = argc;
801 as.argv = argv;
802
28f16c20 803 m = alloc_multipath(ti);
1da177e4 804 if (!m) {
72d94861 805 ti->error = "can't allocate multipath";
1da177e4
LT
806 return -EINVAL;
807 }
808
28f16c20 809 r = parse_features(&as, m);
1da177e4
LT
810 if (r)
811 goto bad;
812
28f16c20 813 r = parse_hw_handler(&as, m);
1da177e4
LT
814 if (r)
815 goto bad;
816
498f0103 817 r = dm_read_arg(_args, &as, &m->nr_priority_groups, &ti->error);
1da177e4
LT
818 if (r)
819 goto bad;
820
498f0103 821 r = dm_read_arg(_args + 1, &as, &next_pg_num, &ti->error);
1da177e4
LT
822 if (r)
823 goto bad;
824
a490a07a
MS
825 if ((!m->nr_priority_groups && next_pg_num) ||
826 (m->nr_priority_groups && !next_pg_num)) {
827 ti->error = "invalid initial priority group";
828 r = -EINVAL;
829 goto bad;
830 }
831
1da177e4
LT
832 /* parse the priority groups */
833 while (as.argc) {
834 struct priority_group *pg;
835
28f16c20 836 pg = parse_priority_group(&as, m);
01460f35
BM
837 if (IS_ERR(pg)) {
838 r = PTR_ERR(pg);
1da177e4
LT
839 goto bad;
840 }
841
842 m->nr_valid_paths += pg->nr_pgpaths;
843 list_add_tail(&pg->list, &m->priority_groups);
844 pg_count++;
845 pg->pg_num = pg_count;
846 if (!--next_pg_num)
847 m->next_pg = pg;
848 }
849
850 if (pg_count != m->nr_priority_groups) {
72d94861 851 ti->error = "priority group count mismatch";
1da177e4
LT
852 r = -EINVAL;
853 goto bad;
854 }
855
55a62eef
AK
856 ti->num_flush_bios = 1;
857 ti->num_discard_bios = 1;
042bcef8 858 ti->num_write_same_bios = 1;
8627921f 859
1da177e4
LT
860 return 0;
861
862 bad:
863 free_multipath(m);
864 return r;
865}
866
2bded7bd
KU
867static void multipath_wait_for_pg_init_completion(struct multipath *m)
868{
869 DECLARE_WAITQUEUE(wait, current);
870 unsigned long flags;
871
872 add_wait_queue(&m->pg_init_wait, &wait);
873
874 while (1) {
875 set_current_state(TASK_UNINTERRUPTIBLE);
876
877 spin_lock_irqsave(&m->lock, flags);
878 if (!m->pg_init_in_progress) {
879 spin_unlock_irqrestore(&m->lock, flags);
880 break;
881 }
882 spin_unlock_irqrestore(&m->lock, flags);
883
884 io_schedule();
885 }
886 set_current_state(TASK_RUNNING);
887
888 remove_wait_queue(&m->pg_init_wait, &wait);
889}
890
891static void flush_multipath_work(struct multipath *m)
1da177e4 892{
954a73d5
SKM
893 unsigned long flags;
894
895 spin_lock_irqsave(&m->lock, flags);
896 m->pg_init_disabled = 1;
897 spin_unlock_irqrestore(&m->lock, flags);
898
bab7cfc7 899 flush_workqueue(kmpath_handlerd);
2bded7bd 900 multipath_wait_for_pg_init_completion(m);
a044d016 901 flush_workqueue(kmultipathd);
43829731 902 flush_work(&m->trigger_event);
954a73d5
SKM
903
904 spin_lock_irqsave(&m->lock, flags);
905 m->pg_init_disabled = 0;
906 spin_unlock_irqrestore(&m->lock, flags);
6df400ab
KU
907}
908
909static void multipath_dtr(struct dm_target *ti)
910{
911 struct multipath *m = ti->private;
912
2bded7bd 913 flush_multipath_work(m);
1da177e4
LT
914 free_multipath(m);
915}
916
1da177e4
LT
917/*
918 * Take a path out of use.
919 */
920static int fail_path(struct pgpath *pgpath)
921{
922 unsigned long flags;
923 struct multipath *m = pgpath->pg->m;
924
925 spin_lock_irqsave(&m->lock, flags);
926
6680073d 927 if (!pgpath->is_active)
1da177e4
LT
928 goto out;
929
72d94861 930 DMWARN("Failing path %s.", pgpath->path.dev->name);
1da177e4
LT
931
932 pgpath->pg->ps.type->fail_path(&pgpath->pg->ps, &pgpath->path);
6680073d 933 pgpath->is_active = 0;
1da177e4
LT
934 pgpath->fail_count++;
935
936 m->nr_valid_paths--;
937
938 if (pgpath == m->current_pgpath)
939 m->current_pgpath = NULL;
940
b15546f9
MA
941 dm_path_uevent(DM_UEVENT_PATH_FAILED, m->ti,
942 pgpath->path.dev->name, m->nr_valid_paths);
943
fe9cf30e 944 schedule_work(&m->trigger_event);
1da177e4
LT
945
946out:
947 spin_unlock_irqrestore(&m->lock, flags);
948
949 return 0;
950}
951
952/*
953 * Reinstate a previously-failed path
954 */
955static int reinstate_path(struct pgpath *pgpath)
956{
63d832c3 957 int r = 0, run_queue = 0;
1da177e4
LT
958 unsigned long flags;
959 struct multipath *m = pgpath->pg->m;
960
961 spin_lock_irqsave(&m->lock, flags);
962
6680073d 963 if (pgpath->is_active)
1da177e4
LT
964 goto out;
965
def052d2 966 if (!pgpath->pg->ps.type->reinstate_path) {
1da177e4
LT
967 DMWARN("Reinstate path not supported by path selector %s",
968 pgpath->pg->ps.type->name);
969 r = -EINVAL;
970 goto out;
971 }
972
973 r = pgpath->pg->ps.type->reinstate_path(&pgpath->pg->ps, &pgpath->path);
974 if (r)
975 goto out;
976
6680073d 977 pgpath->is_active = 1;
1da177e4 978
e8099177 979 if (!m->nr_valid_paths++) {
e54f77dd 980 m->current_pgpath = NULL;
63d832c3 981 run_queue = 1;
e54f77dd 982 } else if (m->hw_handler_name && (m->current_pg == pgpath->pg)) {
4e2d19e4 983 if (queue_work(kmpath_handlerd, &pgpath->activate_path.work))
e54f77dd
CS
984 m->pg_init_in_progress++;
985 }
1da177e4 986
b15546f9
MA
987 dm_path_uevent(DM_UEVENT_PATH_REINSTATED, m->ti,
988 pgpath->path.dev->name, m->nr_valid_paths);
989
fe9cf30e 990 schedule_work(&m->trigger_event);
1da177e4
LT
991
992out:
993 spin_unlock_irqrestore(&m->lock, flags);
63d832c3
HR
994 if (run_queue)
995 dm_table_run_md_queue_async(m->ti->table);
1da177e4
LT
996
997 return r;
998}
999
1000/*
1001 * Fail or reinstate all paths that match the provided struct dm_dev.
1002 */
1003static int action_dev(struct multipath *m, struct dm_dev *dev,
1004 action_fn action)
1005{
19040c0b 1006 int r = -EINVAL;
1da177e4
LT
1007 struct pgpath *pgpath;
1008 struct priority_group *pg;
1009
1010 list_for_each_entry(pg, &m->priority_groups, list) {
1011 list_for_each_entry(pgpath, &pg->pgpaths, list) {
1012 if (pgpath->path.dev == dev)
1013 r = action(pgpath);
1014 }
1015 }
1016
1017 return r;
1018}
1019
1020/*
1021 * Temporarily try to avoid having to use the specified PG
1022 */
1023static void bypass_pg(struct multipath *m, struct priority_group *pg,
1024 int bypassed)
1025{
1026 unsigned long flags;
1027
1028 spin_lock_irqsave(&m->lock, flags);
1029
1030 pg->bypassed = bypassed;
1031 m->current_pgpath = NULL;
1032 m->current_pg = NULL;
1033
1034 spin_unlock_irqrestore(&m->lock, flags);
1035
fe9cf30e 1036 schedule_work(&m->trigger_event);
1da177e4
LT
1037}
1038
1039/*
1040 * Switch to using the specified PG from the next I/O that gets mapped
1041 */
1042static int switch_pg_num(struct multipath *m, const char *pgstr)
1043{
1044 struct priority_group *pg;
1045 unsigned pgnum;
1046 unsigned long flags;
31998ef1 1047 char dummy;
1da177e4 1048
31998ef1 1049 if (!pgstr || (sscanf(pgstr, "%u%c", &pgnum, &dummy) != 1) || !pgnum ||
1da177e4
LT
1050 (pgnum > m->nr_priority_groups)) {
1051 DMWARN("invalid PG number supplied to switch_pg_num");
1052 return -EINVAL;
1053 }
1054
1055 spin_lock_irqsave(&m->lock, flags);
1056 list_for_each_entry(pg, &m->priority_groups, list) {
1057 pg->bypassed = 0;
1058 if (--pgnum)
1059 continue;
1060
1061 m->current_pgpath = NULL;
1062 m->current_pg = NULL;
1063 m->next_pg = pg;
1064 }
1065 spin_unlock_irqrestore(&m->lock, flags);
1066
fe9cf30e 1067 schedule_work(&m->trigger_event);
1da177e4
LT
1068 return 0;
1069}
1070
1071/*
1072 * Set/clear bypassed status of a PG.
1073 * PGs are numbered upwards from 1 in the order they were declared.
1074 */
1075static int bypass_pg_num(struct multipath *m, const char *pgstr, int bypassed)
1076{
1077 struct priority_group *pg;
1078 unsigned pgnum;
31998ef1 1079 char dummy;
1da177e4 1080
31998ef1 1081 if (!pgstr || (sscanf(pgstr, "%u%c", &pgnum, &dummy) != 1) || !pgnum ||
1da177e4
LT
1082 (pgnum > m->nr_priority_groups)) {
1083 DMWARN("invalid PG number supplied to bypass_pg");
1084 return -EINVAL;
1085 }
1086
1087 list_for_each_entry(pg, &m->priority_groups, list) {
1088 if (!--pgnum)
1089 break;
1090 }
1091
1092 bypass_pg(m, pg, bypassed);
1093 return 0;
1094}
1095
c9e45581
DW
1096/*
1097 * Should we retry pg_init immediately?
1098 */
1099static int pg_init_limit_reached(struct multipath *m, struct pgpath *pgpath)
1100{
1101 unsigned long flags;
1102 int limit_reached = 0;
1103
1104 spin_lock_irqsave(&m->lock, flags);
1105
954a73d5 1106 if (m->pg_init_count <= m->pg_init_retries && !m->pg_init_disabled)
c9e45581
DW
1107 m->pg_init_required = 1;
1108 else
1109 limit_reached = 1;
1110
1111 spin_unlock_irqrestore(&m->lock, flags);
1112
1113 return limit_reached;
1114}
1115
3ae31f6a 1116static void pg_init_done(void *data, int errors)
cfae5c9b 1117{
83c0d5d5 1118 struct pgpath *pgpath = data;
cfae5c9b
CS
1119 struct priority_group *pg = pgpath->pg;
1120 struct multipath *m = pg->m;
1121 unsigned long flags;
4e2d19e4 1122 unsigned delay_retry = 0;
cfae5c9b
CS
1123
1124 /* device or driver problems */
1125 switch (errors) {
1126 case SCSI_DH_OK:
1127 break;
1128 case SCSI_DH_NOSYS:
1129 if (!m->hw_handler_name) {
1130 errors = 0;
1131 break;
1132 }
f7b934c8
MB
1133 DMERR("Could not failover the device: Handler scsi_dh_%s "
1134 "Error %d.", m->hw_handler_name, errors);
cfae5c9b
CS
1135 /*
1136 * Fail path for now, so we do not ping pong
1137 */
1138 fail_path(pgpath);
1139 break;
1140 case SCSI_DH_DEV_TEMP_BUSY:
1141 /*
1142 * Probably doing something like FW upgrade on the
1143 * controller so try the other pg.
1144 */
1145 bypass_pg(m, pg, 1);
1146 break;
cfae5c9b 1147 case SCSI_DH_RETRY:
4e2d19e4
CS
1148 /* Wait before retrying. */
1149 delay_retry = 1;
cfae5c9b
CS
1150 case SCSI_DH_IMM_RETRY:
1151 case SCSI_DH_RES_TEMP_UNAVAIL:
1152 if (pg_init_limit_reached(m, pgpath))
1153 fail_path(pgpath);
1154 errors = 0;
1155 break;
1156 default:
1157 /*
1158 * We probably do not want to fail the path for a device
1159 * error, but this is what the old dm did. In future
1160 * patches we can do more advanced handling.
1161 */
1162 fail_path(pgpath);
1163 }
1164
1165 spin_lock_irqsave(&m->lock, flags);
1166 if (errors) {
e54f77dd
CS
1167 if (pgpath == m->current_pgpath) {
1168 DMERR("Could not failover device. Error %d.", errors);
1169 m->current_pgpath = NULL;
1170 m->current_pg = NULL;
1171 }
d0259bf0 1172 } else if (!m->pg_init_required)
cfae5c9b 1173 pg->bypassed = 0;
cfae5c9b 1174
d0259bf0
KU
1175 if (--m->pg_init_in_progress)
1176 /* Activations of other paths are still on going */
1177 goto out;
1178
3e9f1be1
HR
1179 if (m->pg_init_required) {
1180 m->pg_init_delay_retry = delay_retry;
1181 if (__pg_init_all_paths(m))
1182 goto out;
1183 }
1184 m->queue_io = 0;
d0259bf0 1185
2bded7bd
KU
1186 /*
1187 * Wake up any thread waiting to suspend.
1188 */
1189 wake_up(&m->pg_init_wait);
1190
d0259bf0 1191out:
cfae5c9b
CS
1192 spin_unlock_irqrestore(&m->lock, flags);
1193}
1194
bab7cfc7
CS
1195static void activate_path(struct work_struct *work)
1196{
e54f77dd 1197 struct pgpath *pgpath =
4e2d19e4 1198 container_of(work, struct pgpath, activate_path.work);
bab7cfc7 1199
3a017509
HR
1200 if (pgpath->is_active)
1201 scsi_dh_activate(bdev_get_queue(pgpath->path.dev->bdev),
1202 pg_init_done, pgpath);
1203 else
1204 pg_init_done(pgpath, SCSI_DH_DEV_OFFLINED);
bab7cfc7
CS
1205}
1206
7e782af5
HR
1207static int noretry_error(int error)
1208{
1209 switch (error) {
1210 case -EOPNOTSUPP:
1211 case -EREMOTEIO:
1212 case -EILSEQ:
1213 case -ENODATA:
cc9d3c38 1214 case -ENOSPC:
7e782af5
HR
1215 return 1;
1216 }
1217
1218 /* Anything else could be a path failure, so should be retried */
1219 return 0;
1220}
1221
1da177e4
LT
1222/*
1223 * end_io handling
1224 */
f40c67f0 1225static int do_end_io(struct multipath *m, struct request *clone,
028867ac 1226 int error, struct dm_mpath_io *mpio)
1da177e4 1227{
f40c67f0
KU
1228 /*
1229 * We don't queue any clone request inside the multipath target
1230 * during end I/O handling, since those clone requests don't have
1231 * bio clones. If we queue them inside the multipath target,
1232 * we need to make bio clones, that requires memory allocation.
1233 * (See drivers/md/dm.c:end_clone_bio() about why the clone requests
1234 * don't have bio clones.)
1235 * Instead of queueing the clone request here, we queue the original
1236 * request into dm core, which will remake a clone request and
1237 * clone bios for it and resubmit it later.
1238 */
1239 int r = DM_ENDIO_REQUEUE;
640eb3b0 1240 unsigned long flags;
1da177e4 1241
f40c67f0 1242 if (!error && !clone->errors)
1da177e4
LT
1243 return 0; /* I/O complete */
1244
7eee4ae2 1245 if (noretry_error(error))
959eb4e5
MS
1246 return error;
1247
cfae5c9b
CS
1248 if (mpio->pgpath)
1249 fail_path(mpio->pgpath);
1da177e4 1250
640eb3b0 1251 spin_lock_irqsave(&m->lock, flags);
751b2a7d
HR
1252 if (!m->nr_valid_paths) {
1253 if (!m->queue_if_no_path) {
1254 if (!__must_push_back(m))
1255 r = -EIO;
1256 } else {
1257 if (error == -EBADE)
1258 r = error;
1259 }
1260 }
640eb3b0 1261 spin_unlock_irqrestore(&m->lock, flags);
1da177e4 1262
f40c67f0 1263 return r;
1da177e4
LT
1264}
1265
f40c67f0 1266static int multipath_end_io(struct dm_target *ti, struct request *clone,
1da177e4
LT
1267 int error, union map_info *map_context)
1268{
028867ac
AK
1269 struct multipath *m = ti->private;
1270 struct dm_mpath_io *mpio = map_context->ptr;
a71a261f 1271 struct pgpath *pgpath;
1da177e4
LT
1272 struct path_selector *ps;
1273 int r;
1274
466891f9
JN
1275 BUG_ON(!mpio);
1276
f40c67f0 1277 r = do_end_io(m, clone, error, mpio);
a71a261f 1278 pgpath = mpio->pgpath;
1da177e4
LT
1279 if (pgpath) {
1280 ps = &pgpath->pg->ps;
1281 if (ps->type->end_io)
02ab823f 1282 ps->type->end_io(ps, &pgpath->path, mpio->nr_bytes);
1da177e4 1283 }
466891f9 1284 clear_mapinfo(m, map_context);
1da177e4
LT
1285
1286 return r;
1287}
1288
1289/*
1290 * Suspend can't complete until all the I/O is processed so if
436d4108
AK
1291 * the last path fails we must error any remaining I/O.
1292 * Note that if the freeze_bdev fails while suspending, the
1293 * queue_if_no_path state is lost - userspace should reset it.
1da177e4
LT
1294 */
1295static void multipath_presuspend(struct dm_target *ti)
1296{
1297 struct multipath *m = (struct multipath *) ti->private;
1da177e4 1298
485ef69e 1299 queue_if_no_path(m, 0, 1);
1da177e4
LT
1300}
1301
6df400ab
KU
1302static void multipath_postsuspend(struct dm_target *ti)
1303{
6380f26f
MA
1304 struct multipath *m = ti->private;
1305
1306 mutex_lock(&m->work_mutex);
2bded7bd 1307 flush_multipath_work(m);
6380f26f 1308 mutex_unlock(&m->work_mutex);
6df400ab
KU
1309}
1310
436d4108
AK
1311/*
1312 * Restore the queue_if_no_path setting.
1313 */
1da177e4
LT
1314static void multipath_resume(struct dm_target *ti)
1315{
1316 struct multipath *m = (struct multipath *) ti->private;
1317 unsigned long flags;
1318
1319 spin_lock_irqsave(&m->lock, flags);
436d4108 1320 m->queue_if_no_path = m->saved_queue_if_no_path;
1da177e4
LT
1321 spin_unlock_irqrestore(&m->lock, flags);
1322}
1323
1324/*
1325 * Info output has the following format:
1326 * num_multipath_feature_args [multipath_feature_args]*
1327 * num_handler_status_args [handler_status_args]*
1328 * num_groups init_group_number
1329 * [A|D|E num_ps_status_args [ps_status_args]*
1330 * num_paths num_selector_args
1331 * [path_dev A|F fail_count [selector_args]* ]+ ]+
1332 *
1333 * Table output has the following format (identical to the constructor string):
1334 * num_feature_args [features_args]*
1335 * num_handler_args hw_handler [hw_handler_args]*
1336 * num_groups init_group_number
1337 * [priority selector-name num_ps_args [ps_args]*
1338 * num_paths num_selector_args [path_dev [selector_args]* ]+ ]+
1339 */
fd7c092e
MP
1340static void multipath_status(struct dm_target *ti, status_type_t type,
1341 unsigned status_flags, char *result, unsigned maxlen)
1da177e4
LT
1342{
1343 int sz = 0;
1344 unsigned long flags;
1345 struct multipath *m = (struct multipath *) ti->private;
1da177e4
LT
1346 struct priority_group *pg;
1347 struct pgpath *p;
1348 unsigned pg_num;
1349 char state;
1350
1351 spin_lock_irqsave(&m->lock, flags);
1352
1353 /* Features */
1354 if (type == STATUSTYPE_INFO)
e8099177 1355 DMEMIT("2 %u %u ", m->queue_io, m->pg_init_count);
c9e45581
DW
1356 else {
1357 DMEMIT("%u ", m->queue_if_no_path +
4e2d19e4 1358 (m->pg_init_retries > 0) * 2 +
a58a935d
MS
1359 (m->pg_init_delay_msecs != DM_PG_INIT_DELAY_DEFAULT) * 2 +
1360 m->retain_attached_hw_handler);
c9e45581
DW
1361 if (m->queue_if_no_path)
1362 DMEMIT("queue_if_no_path ");
1363 if (m->pg_init_retries)
1364 DMEMIT("pg_init_retries %u ", m->pg_init_retries);
4e2d19e4
CS
1365 if (m->pg_init_delay_msecs != DM_PG_INIT_DELAY_DEFAULT)
1366 DMEMIT("pg_init_delay_msecs %u ", m->pg_init_delay_msecs);
a58a935d
MS
1367 if (m->retain_attached_hw_handler)
1368 DMEMIT("retain_attached_hw_handler ");
c9e45581 1369 }
1da177e4 1370
cfae5c9b 1371 if (!m->hw_handler_name || type == STATUSTYPE_INFO)
1da177e4
LT
1372 DMEMIT("0 ");
1373 else
cfae5c9b 1374 DMEMIT("1 %s ", m->hw_handler_name);
1da177e4
LT
1375
1376 DMEMIT("%u ", m->nr_priority_groups);
1377
1378 if (m->next_pg)
1379 pg_num = m->next_pg->pg_num;
1380 else if (m->current_pg)
1381 pg_num = m->current_pg->pg_num;
1382 else
a490a07a 1383 pg_num = (m->nr_priority_groups ? 1 : 0);
1da177e4
LT
1384
1385 DMEMIT("%u ", pg_num);
1386
1387 switch (type) {
1388 case STATUSTYPE_INFO:
1389 list_for_each_entry(pg, &m->priority_groups, list) {
1390 if (pg->bypassed)
1391 state = 'D'; /* Disabled */
1392 else if (pg == m->current_pg)
1393 state = 'A'; /* Currently Active */
1394 else
1395 state = 'E'; /* Enabled */
1396
1397 DMEMIT("%c ", state);
1398
1399 if (pg->ps.type->status)
1400 sz += pg->ps.type->status(&pg->ps, NULL, type,
1401 result + sz,
1402 maxlen - sz);
1403 else
1404 DMEMIT("0 ");
1405
1406 DMEMIT("%u %u ", pg->nr_pgpaths,
1407 pg->ps.type->info_args);
1408
1409 list_for_each_entry(p, &pg->pgpaths, list) {
1410 DMEMIT("%s %s %u ", p->path.dev->name,
6680073d 1411 p->is_active ? "A" : "F",
1da177e4
LT
1412 p->fail_count);
1413 if (pg->ps.type->status)
1414 sz += pg->ps.type->status(&pg->ps,
1415 &p->path, type, result + sz,
1416 maxlen - sz);
1417 }
1418 }
1419 break;
1420
1421 case STATUSTYPE_TABLE:
1422 list_for_each_entry(pg, &m->priority_groups, list) {
1423 DMEMIT("%s ", pg->ps.type->name);
1424
1425 if (pg->ps.type->status)
1426 sz += pg->ps.type->status(&pg->ps, NULL, type,
1427 result + sz,
1428 maxlen - sz);
1429 else
1430 DMEMIT("0 ");
1431
1432 DMEMIT("%u %u ", pg->nr_pgpaths,
1433 pg->ps.type->table_args);
1434
1435 list_for_each_entry(p, &pg->pgpaths, list) {
1436 DMEMIT("%s ", p->path.dev->name);
1437 if (pg->ps.type->status)
1438 sz += pg->ps.type->status(&pg->ps,
1439 &p->path, type, result + sz,
1440 maxlen - sz);
1441 }
1442 }
1443 break;
1444 }
1445
1446 spin_unlock_irqrestore(&m->lock, flags);
1da177e4
LT
1447}
1448
1449static int multipath_message(struct dm_target *ti, unsigned argc, char **argv)
1450{
6380f26f 1451 int r = -EINVAL;
1da177e4
LT
1452 struct dm_dev *dev;
1453 struct multipath *m = (struct multipath *) ti->private;
1454 action_fn action;
1455
6380f26f
MA
1456 mutex_lock(&m->work_mutex);
1457
c2f3d24b
KU
1458 if (dm_suspended(ti)) {
1459 r = -EBUSY;
1460 goto out;
1461 }
1462
1da177e4 1463 if (argc == 1) {
498f0103 1464 if (!strcasecmp(argv[0], "queue_if_no_path")) {
6380f26f
MA
1465 r = queue_if_no_path(m, 1, 0);
1466 goto out;
498f0103 1467 } else if (!strcasecmp(argv[0], "fail_if_no_path")) {
6380f26f
MA
1468 r = queue_if_no_path(m, 0, 0);
1469 goto out;
1470 }
1da177e4
LT
1471 }
1472
6380f26f 1473 if (argc != 2) {
a356e426 1474 DMWARN("Invalid multipath message arguments. Expected 2 arguments, got %d.", argc);
6380f26f
MA
1475 goto out;
1476 }
1da177e4 1477
498f0103 1478 if (!strcasecmp(argv[0], "disable_group")) {
6380f26f
MA
1479 r = bypass_pg_num(m, argv[1], 1);
1480 goto out;
498f0103 1481 } else if (!strcasecmp(argv[0], "enable_group")) {
6380f26f
MA
1482 r = bypass_pg_num(m, argv[1], 0);
1483 goto out;
498f0103 1484 } else if (!strcasecmp(argv[0], "switch_group")) {
6380f26f
MA
1485 r = switch_pg_num(m, argv[1]);
1486 goto out;
498f0103 1487 } else if (!strcasecmp(argv[0], "reinstate_path"))
1da177e4 1488 action = reinstate_path;
498f0103 1489 else if (!strcasecmp(argv[0], "fail_path"))
1da177e4 1490 action = fail_path;
6380f26f 1491 else {
a356e426 1492 DMWARN("Unrecognised multipath message received: %s", argv[0]);
6380f26f
MA
1493 goto out;
1494 }
1da177e4 1495
8215d6ec 1496 r = dm_get_device(ti, argv[1], dm_table_get_mode(ti->table), &dev);
1da177e4 1497 if (r) {
72d94861 1498 DMWARN("message: error getting device %s",
1da177e4 1499 argv[1]);
6380f26f 1500 goto out;
1da177e4
LT
1501 }
1502
1503 r = action_dev(m, dev, action);
1504
1505 dm_put_device(ti, dev);
1506
6380f26f
MA
1507out:
1508 mutex_unlock(&m->work_mutex);
1da177e4 1509 return r;
1da177e4
LT
1510}
1511
647b3d00 1512static int multipath_ioctl(struct dm_target *ti, unsigned int cmd,
9af4aa30
MB
1513 unsigned long arg)
1514{
35991652 1515 struct multipath *m = ti->private;
7ba10aa6 1516 struct pgpath *pgpath;
35991652
MP
1517 struct block_device *bdev;
1518 fmode_t mode;
9af4aa30 1519 unsigned long flags;
35991652
MP
1520 int r;
1521
35991652
MP
1522 bdev = NULL;
1523 mode = 0;
1524 r = 0;
9af4aa30
MB
1525
1526 spin_lock_irqsave(&m->lock, flags);
1527
1528 if (!m->current_pgpath)
02ab823f 1529 __choose_pgpath(m, 0);
9af4aa30 1530
7ba10aa6
MS
1531 pgpath = m->current_pgpath;
1532
1533 if (pgpath) {
1534 bdev = pgpath->path.dev->bdev;
1535 mode = pgpath->path.dev->mode;
e90dae1f 1536 }
9af4aa30 1537
7ba10aa6 1538 if ((pgpath && m->queue_io) || (!pgpath && m->queue_if_no_path))
6c182cd8 1539 r = -ENOTCONN;
9af4aa30
MB
1540 else if (!bdev)
1541 r = -EIO;
1542
1543 spin_unlock_irqrestore(&m->lock, flags);
1544
ec8013be
PB
1545 /*
1546 * Only pass ioctls through if the device sizes match exactly.
1547 */
a1989b33
HR
1548 if (!bdev || ti->len != i_size_read(bdev->bd_inode) >> SECTOR_SHIFT) {
1549 int err = scsi_verify_blk_ioctl(NULL, cmd);
1550 if (err)
1551 r = err;
1552 }
ec8013be 1553
3e9f1be1
HR
1554 if (r == -ENOTCONN && !fatal_signal_pending(current)) {
1555 spin_lock_irqsave(&m->lock, flags);
1556 if (!m->current_pg) {
1557 /* Path status changed, redo selection */
1558 __choose_pgpath(m, 0);
1559 }
1560 if (m->pg_init_required)
1561 __pg_init_all_paths(m);
4cdd2ad7 1562 spin_unlock_irqrestore(&m->lock, flags);
63d832c3 1563 dm_table_run_md_queue_async(m->ti->table);
3e9f1be1 1564 }
35991652 1565
633a08b8 1566 return r ? : __blkdev_driver_ioctl(bdev, mode, cmd, arg);
9af4aa30
MB
1567}
1568
af4874e0
MS
1569static int multipath_iterate_devices(struct dm_target *ti,
1570 iterate_devices_callout_fn fn, void *data)
1571{
1572 struct multipath *m = ti->private;
1573 struct priority_group *pg;
1574 struct pgpath *p;
1575 int ret = 0;
1576
1577 list_for_each_entry(pg, &m->priority_groups, list) {
1578 list_for_each_entry(p, &pg->pgpaths, list) {
5dea271b 1579 ret = fn(ti, p->path.dev, ti->begin, ti->len, data);
af4874e0
MS
1580 if (ret)
1581 goto out;
1582 }
1583 }
1584
1585out:
1586 return ret;
1587}
1588
f40c67f0
KU
1589static int __pgpath_busy(struct pgpath *pgpath)
1590{
1591 struct request_queue *q = bdev_get_queue(pgpath->path.dev->bdev);
1592
1593 return dm_underlying_device_busy(q);
1594}
1595
1596/*
1597 * We return "busy", only when we can map I/Os but underlying devices
1598 * are busy (so even if we map I/Os now, the I/Os will wait on
1599 * the underlying queue).
1600 * In other words, if we want to kill I/Os or queue them inside us
1601 * due to map unavailability, we don't return "busy". Otherwise,
1602 * dm core won't give us the I/Os and we can't do what we want.
1603 */
1604static int multipath_busy(struct dm_target *ti)
1605{
1606 int busy = 0, has_active = 0;
1607 struct multipath *m = ti->private;
1608 struct priority_group *pg;
1609 struct pgpath *pgpath;
1610 unsigned long flags;
1611
1612 spin_lock_irqsave(&m->lock, flags);
1613
7a7a3b45
JN
1614 /* pg_init in progress or no paths available */
1615 if (m->pg_init_in_progress ||
1616 (!m->nr_valid_paths && m->queue_if_no_path)) {
b63349a7
HR
1617 busy = 1;
1618 goto out;
1619 }
f40c67f0
KU
1620 /* Guess which priority_group will be used at next mapping time */
1621 if (unlikely(!m->current_pgpath && m->next_pg))
1622 pg = m->next_pg;
1623 else if (likely(m->current_pg))
1624 pg = m->current_pg;
1625 else
1626 /*
1627 * We don't know which pg will be used at next mapping time.
1628 * We don't call __choose_pgpath() here to avoid to trigger
1629 * pg_init just by busy checking.
1630 * So we don't know whether underlying devices we will be using
1631 * at next mapping time are busy or not. Just try mapping.
1632 */
1633 goto out;
1634
1635 /*
1636 * If there is one non-busy active path at least, the path selector
1637 * will be able to select it. So we consider such a pg as not busy.
1638 */
1639 busy = 1;
1640 list_for_each_entry(pgpath, &pg->pgpaths, list)
1641 if (pgpath->is_active) {
1642 has_active = 1;
1643
1644 if (!__pgpath_busy(pgpath)) {
1645 busy = 0;
1646 break;
1647 }
1648 }
1649
1650 if (!has_active)
1651 /*
1652 * No active path in this pg, so this pg won't be used and
1653 * the current_pg will be changed at next mapping time.
1654 * We need to try mapping to determine it.
1655 */
1656 busy = 0;
1657
1658out:
1659 spin_unlock_irqrestore(&m->lock, flags);
1660
1661 return busy;
1662}
1663
1da177e4
LT
1664/*-----------------------------------------------------------------
1665 * Module setup
1666 *---------------------------------------------------------------*/
1667static struct target_type multipath_target = {
1668 .name = "multipath",
e8099177 1669 .version = {1, 7, 0},
1da177e4
LT
1670 .module = THIS_MODULE,
1671 .ctr = multipath_ctr,
1672 .dtr = multipath_dtr,
f40c67f0
KU
1673 .map_rq = multipath_map,
1674 .rq_end_io = multipath_end_io,
1da177e4 1675 .presuspend = multipath_presuspend,
6df400ab 1676 .postsuspend = multipath_postsuspend,
1da177e4
LT
1677 .resume = multipath_resume,
1678 .status = multipath_status,
1679 .message = multipath_message,
9af4aa30 1680 .ioctl = multipath_ioctl,
af4874e0 1681 .iterate_devices = multipath_iterate_devices,
f40c67f0 1682 .busy = multipath_busy,
1da177e4
LT
1683};
1684
1685static int __init dm_multipath_init(void)
1686{
1687 int r;
1688
1689 /* allocate a slab for the dm_ios */
028867ac 1690 _mpio_cache = KMEM_CACHE(dm_mpath_io, 0);
1da177e4
LT
1691 if (!_mpio_cache)
1692 return -ENOMEM;
1693
1694 r = dm_register_target(&multipath_target);
1695 if (r < 0) {
0cd33124 1696 DMERR("register failed %d", r);
1da177e4
LT
1697 kmem_cache_destroy(_mpio_cache);
1698 return -EINVAL;
1699 }
1700
4d4d66ab 1701 kmultipathd = alloc_workqueue("kmpathd", WQ_MEM_RECLAIM, 0);
c557308e 1702 if (!kmultipathd) {
0cd33124 1703 DMERR("failed to create workqueue kmpathd");
c557308e
AK
1704 dm_unregister_target(&multipath_target);
1705 kmem_cache_destroy(_mpio_cache);
1706 return -ENOMEM;
1707 }
1708
bab7cfc7
CS
1709 /*
1710 * A separate workqueue is used to handle the device handlers
1711 * to avoid overloading existing workqueue. Overloading the
1712 * old workqueue would also create a bottleneck in the
1713 * path of the storage hardware device activation.
1714 */
4d4d66ab
TH
1715 kmpath_handlerd = alloc_ordered_workqueue("kmpath_handlerd",
1716 WQ_MEM_RECLAIM);
bab7cfc7
CS
1717 if (!kmpath_handlerd) {
1718 DMERR("failed to create workqueue kmpath_handlerd");
1719 destroy_workqueue(kmultipathd);
1720 dm_unregister_target(&multipath_target);
1721 kmem_cache_destroy(_mpio_cache);
1722 return -ENOMEM;
1723 }
1724
72d94861 1725 DMINFO("version %u.%u.%u loaded",
1da177e4
LT
1726 multipath_target.version[0], multipath_target.version[1],
1727 multipath_target.version[2]);
1728
1729 return r;
1730}
1731
1732static void __exit dm_multipath_exit(void)
1733{
bab7cfc7 1734 destroy_workqueue(kmpath_handlerd);
c557308e
AK
1735 destroy_workqueue(kmultipathd);
1736
10d3bd09 1737 dm_unregister_target(&multipath_target);
1da177e4
LT
1738 kmem_cache_destroy(_mpio_cache);
1739}
1740
1da177e4
LT
1741module_init(dm_multipath_init);
1742module_exit(dm_multipath_exit);
1743
1744MODULE_DESCRIPTION(DM_NAME " multipath target");
1745MODULE_AUTHOR("Sistina Software <dm-devel@redhat.com>");
1746MODULE_LICENSE("GPL");
This page took 0.870726 seconds and 5 git commands to generate.