2 * Copyright (C) 2003 Sistina Software Limited.
3 * Copyright (C) 2004-2005 Red Hat, Inc. All rights reserved.
5 * This file is released under the GPL.
8 #include <linux/device-mapper.h>
10 #include "dm-path-selector.h"
11 #include "dm-uevent.h"
13 #include <linux/ctype.h>
14 #include <linux/init.h>
15 #include <linux/mempool.h>
16 #include <linux/module.h>
17 #include <linux/pagemap.h>
18 #include <linux/slab.h>
19 #include <linux/time.h>
20 #include <linux/workqueue.h>
21 #include <scsi/scsi_dh.h>
22 #include <asm/atomic.h>
24 #define DM_MSG_PREFIX "multipath"
25 #define MESG_STR(x) x, sizeof(x)
29 struct list_head list;
31 struct priority_group *pg; /* Owning PG */
32 unsigned is_active; /* Path status */
33 unsigned fail_count; /* Cumulative failure count */
36 struct work_struct deactivate_path;
37 struct work_struct activate_path;
40 #define path_to_pgpath(__pgp) container_of((__pgp), struct pgpath, path)
43 * Paths are grouped into Priority Groups and numbered from 1 upwards.
44 * Each has a path selector which controls which path gets used.
46 struct priority_group {
47 struct list_head list;
49 struct multipath *m; /* Owning multipath instance */
50 struct path_selector ps;
52 unsigned pg_num; /* Reference number */
53 unsigned bypassed; /* Temporarily bypass this PG? */
55 unsigned nr_pgpaths; /* Number of paths in PG */
56 struct list_head pgpaths;
59 /* Multipath context */
61 struct list_head list;
66 const char *hw_handler_name;
67 unsigned nr_priority_groups;
68 struct list_head priority_groups;
69 unsigned pg_init_required; /* pg_init needs calling? */
70 unsigned pg_init_in_progress; /* Only one pg_init allowed at once */
72 unsigned nr_valid_paths; /* Total number of usable paths */
73 struct pgpath *current_pgpath;
74 struct priority_group *current_pg;
75 struct priority_group *next_pg; /* Switch to this PG if set */
76 unsigned repeat_count; /* I/Os left before calling PS again */
78 unsigned queue_io; /* Must we queue all I/O? */
79 unsigned queue_if_no_path; /* Queue I/O if last path fails? */
80 unsigned saved_queue_if_no_path;/* Saved state during suspension */
81 unsigned pg_init_retries; /* Number of times to retry pg_init */
82 unsigned pg_init_count; /* Number of times pg_init called */
84 struct work_struct process_queued_ios;
85 struct list_head queued_ios;
88 struct work_struct trigger_event;
91 * We must use a mempool of dm_mpath_io structs so that we
92 * can resubmit bios on error.
98 * Context information attached to each bio we process.
101 struct pgpath *pgpath;
105 typedef int (*action_fn) (struct pgpath *pgpath);
107 #define MIN_IOS 256 /* Mempool size */
109 static struct kmem_cache *_mpio_cache;
111 static struct workqueue_struct *kmultipathd, *kmpath_handlerd;
112 static void process_queued_ios(struct work_struct *work);
113 static void trigger_event(struct work_struct *work);
114 static void activate_path(struct work_struct *work);
115 static void deactivate_path(struct work_struct *work);
118 /*-----------------------------------------------
119 * Allocation routines
120 *-----------------------------------------------*/
122 static struct pgpath *alloc_pgpath(void)
124 struct pgpath *pgpath = kzalloc(sizeof(*pgpath), GFP_KERNEL);
127 pgpath->is_active = 1;
128 INIT_WORK(&pgpath->deactivate_path, deactivate_path);
129 INIT_WORK(&pgpath->activate_path, activate_path);
135 static void free_pgpath(struct pgpath *pgpath)
140 static void deactivate_path(struct work_struct *work)
142 struct pgpath *pgpath =
143 container_of(work, struct pgpath, deactivate_path);
145 blk_abort_queue(pgpath->path.dev->bdev->bd_disk->queue);
148 static struct priority_group *alloc_priority_group(void)
150 struct priority_group *pg;
152 pg = kzalloc(sizeof(*pg), GFP_KERNEL);
155 INIT_LIST_HEAD(&pg->pgpaths);
160 static void free_pgpaths(struct list_head *pgpaths, struct dm_target *ti)
162 struct pgpath *pgpath, *tmp;
163 struct multipath *m = ti->private;
165 list_for_each_entry_safe(pgpath, tmp, pgpaths, list) {
166 list_del(&pgpath->list);
167 if (m->hw_handler_name)
168 scsi_dh_detach(bdev_get_queue(pgpath->path.dev->bdev));
169 dm_put_device(ti, pgpath->path.dev);
174 static void free_priority_group(struct priority_group *pg,
175 struct dm_target *ti)
177 struct path_selector *ps = &pg->ps;
180 ps->type->destroy(ps);
181 dm_put_path_selector(ps->type);
184 free_pgpaths(&pg->pgpaths, ti);
188 static struct multipath *alloc_multipath(struct dm_target *ti)
192 m = kzalloc(sizeof(*m), GFP_KERNEL);
194 INIT_LIST_HEAD(&m->priority_groups);
195 INIT_LIST_HEAD(&m->queued_ios);
196 spin_lock_init(&m->lock);
198 INIT_WORK(&m->process_queued_ios, process_queued_ios);
199 INIT_WORK(&m->trigger_event, trigger_event);
200 m->mpio_pool = mempool_create_slab_pool(MIN_IOS, _mpio_cache);
212 static void free_multipath(struct multipath *m)
214 struct priority_group *pg, *tmp;
216 list_for_each_entry_safe(pg, tmp, &m->priority_groups, list) {
218 free_priority_group(pg, m->ti);
221 kfree(m->hw_handler_name);
222 mempool_destroy(m->mpio_pool);
227 /*-----------------------------------------------
229 *-----------------------------------------------*/
231 static void __switch_pg(struct multipath *m, struct pgpath *pgpath)
233 m->current_pg = pgpath->pg;
235 /* Must we initialise the PG first, and queue I/O till it's ready? */
236 if (m->hw_handler_name) {
237 m->pg_init_required = 1;
240 m->pg_init_required = 0;
244 m->pg_init_count = 0;
247 static int __choose_path_in_pg(struct multipath *m, struct priority_group *pg,
250 struct dm_path *path;
252 path = pg->ps.type->select_path(&pg->ps, &m->repeat_count, nr_bytes);
256 m->current_pgpath = path_to_pgpath(path);
258 if (m->current_pg != pg)
259 __switch_pg(m, m->current_pgpath);
264 static void __choose_pgpath(struct multipath *m, size_t nr_bytes)
266 struct priority_group *pg;
267 unsigned bypassed = 1;
269 if (!m->nr_valid_paths)
272 /* Were we instructed to switch PG? */
276 if (!__choose_path_in_pg(m, pg, nr_bytes))
280 /* Don't change PG until it has no remaining paths */
281 if (m->current_pg && !__choose_path_in_pg(m, m->current_pg, nr_bytes))
285 * Loop through priority groups until we find a valid path.
286 * First time we skip PGs marked 'bypassed'.
287 * Second time we only try the ones we skipped.
290 list_for_each_entry(pg, &m->priority_groups, list) {
291 if (pg->bypassed == bypassed)
293 if (!__choose_path_in_pg(m, pg, nr_bytes))
296 } while (bypassed--);
299 m->current_pgpath = NULL;
300 m->current_pg = NULL;
304 * Check whether bios must be queued in the device-mapper core rather
305 * than here in the target.
307 * m->lock must be held on entry.
309 * If m->queue_if_no_path and m->saved_queue_if_no_path hold the
310 * same value then we are not between multipath_presuspend()
311 * and multipath_resume() calls and we have no need to check
312 * for the DMF_NOFLUSH_SUSPENDING flag.
314 static int __must_push_back(struct multipath *m)
316 return (m->queue_if_no_path != m->saved_queue_if_no_path &&
317 dm_noflush_suspending(m->ti));
320 static int map_io(struct multipath *m, struct request *clone,
321 struct dm_mpath_io *mpio, unsigned was_queued)
323 int r = DM_MAPIO_REMAPPED;
324 size_t nr_bytes = blk_rq_bytes(clone);
326 struct pgpath *pgpath;
327 struct block_device *bdev;
329 spin_lock_irqsave(&m->lock, flags);
331 /* Do we need to select a new pgpath? */
332 if (!m->current_pgpath ||
333 (!m->queue_io && (m->repeat_count && --m->repeat_count == 0)))
334 __choose_pgpath(m, nr_bytes);
336 pgpath = m->current_pgpath;
341 if ((pgpath && m->queue_io) ||
342 (!pgpath && m->queue_if_no_path)) {
343 /* Queue for the daemon to resubmit */
344 list_add_tail(&clone->queuelist, &m->queued_ios);
346 if ((m->pg_init_required && !m->pg_init_in_progress) ||
348 queue_work(kmultipathd, &m->process_queued_ios);
350 r = DM_MAPIO_SUBMITTED;
352 bdev = pgpath->path.dev->bdev;
353 clone->q = bdev_get_queue(bdev);
354 clone->rq_disk = bdev->bd_disk;
355 } else if (__must_push_back(m))
356 r = DM_MAPIO_REQUEUE;
358 r = -EIO; /* Failed */
360 mpio->pgpath = pgpath;
361 mpio->nr_bytes = nr_bytes;
363 if (r == DM_MAPIO_REMAPPED && pgpath->pg->ps.type->start_io)
364 pgpath->pg->ps.type->start_io(&pgpath->pg->ps, &pgpath->path,
367 spin_unlock_irqrestore(&m->lock, flags);
373 * If we run out of usable paths, should we queue I/O or error it?
375 static int queue_if_no_path(struct multipath *m, unsigned queue_if_no_path,
376 unsigned save_old_value)
380 spin_lock_irqsave(&m->lock, flags);
383 m->saved_queue_if_no_path = m->queue_if_no_path;
385 m->saved_queue_if_no_path = queue_if_no_path;
386 m->queue_if_no_path = queue_if_no_path;
387 if (!m->queue_if_no_path && m->queue_size)
388 queue_work(kmultipathd, &m->process_queued_ios);
390 spin_unlock_irqrestore(&m->lock, flags);
395 /*-----------------------------------------------------------------
396 * The multipath daemon is responsible for resubmitting queued ios.
397 *---------------------------------------------------------------*/
399 static void dispatch_queued_ios(struct multipath *m)
403 struct dm_mpath_io *mpio;
404 union map_info *info;
405 struct request *clone, *n;
408 spin_lock_irqsave(&m->lock, flags);
409 list_splice_init(&m->queued_ios, &cl);
410 spin_unlock_irqrestore(&m->lock, flags);
412 list_for_each_entry_safe(clone, n, &cl, queuelist) {
413 list_del_init(&clone->queuelist);
415 info = dm_get_rq_mapinfo(clone);
418 r = map_io(m, clone, mpio, 1);
420 mempool_free(mpio, m->mpio_pool);
421 dm_kill_unmapped_request(clone, r);
422 } else if (r == DM_MAPIO_REMAPPED)
423 dm_dispatch_request(clone);
424 else if (r == DM_MAPIO_REQUEUE) {
425 mempool_free(mpio, m->mpio_pool);
426 dm_requeue_unmapped_request(clone);
431 static void process_queued_ios(struct work_struct *work)
433 struct multipath *m =
434 container_of(work, struct multipath, process_queued_ios);
435 struct pgpath *pgpath = NULL, *tmp;
436 unsigned must_queue = 1;
439 spin_lock_irqsave(&m->lock, flags);
444 if (!m->current_pgpath)
445 __choose_pgpath(m, 0);
447 pgpath = m->current_pgpath;
449 if ((pgpath && !m->queue_io) ||
450 (!pgpath && !m->queue_if_no_path))
453 if (m->pg_init_required && !m->pg_init_in_progress && pgpath) {
455 m->pg_init_required = 0;
456 list_for_each_entry(tmp, &pgpath->pg->pgpaths, list) {
457 if (queue_work(kmpath_handlerd, &tmp->activate_path))
458 m->pg_init_in_progress++;
462 spin_unlock_irqrestore(&m->lock, flags);
464 dispatch_queued_ios(m);
468 * An event is triggered whenever a path is taken out of use.
469 * Includes path failure and PG bypass.
471 static void trigger_event(struct work_struct *work)
473 struct multipath *m =
474 container_of(work, struct multipath, trigger_event);
476 dm_table_event(m->ti->table);
479 /*-----------------------------------------------------------------
480 * Constructor/argument parsing:
481 * <#multipath feature args> [<arg>]*
482 * <#hw_handler args> [hw_handler [<arg>]*]
484 * <initial priority group>
485 * [<selector> <#selector args> [<arg>]*
486 * <#paths> <#per-path selector args>
487 * [<path> [<arg>]* ]+ ]+
488 *---------------------------------------------------------------*/
495 static int read_param(struct param *param, char *str, unsigned *v, char **error)
498 (sscanf(str, "%u", v) != 1) ||
501 *error = param->error;
513 static char *shift(struct arg_set *as)
527 static void consume(struct arg_set *as, unsigned n)
529 BUG_ON (as->argc < n);
534 static int parse_path_selector(struct arg_set *as, struct priority_group *pg,
535 struct dm_target *ti)
538 struct path_selector_type *pst;
541 static struct param _params[] = {
542 {0, 1024, "invalid number of path selector args"},
545 pst = dm_get_path_selector(shift(as));
547 ti->error = "unknown path selector type";
551 r = read_param(_params, shift(as), &ps_argc, &ti->error);
553 dm_put_path_selector(pst);
557 if (ps_argc > as->argc) {
558 dm_put_path_selector(pst);
559 ti->error = "not enough arguments for path selector";
563 r = pst->create(&pg->ps, ps_argc, as->argv);
565 dm_put_path_selector(pst);
566 ti->error = "path selector constructor failed";
571 consume(as, ps_argc);
576 static struct pgpath *parse_path(struct arg_set *as, struct path_selector *ps,
577 struct dm_target *ti)
581 struct multipath *m = ti->private;
583 /* we need at least a path arg */
585 ti->error = "no device given";
586 return ERR_PTR(-EINVAL);
591 return ERR_PTR(-ENOMEM);
593 r = dm_get_device(ti, shift(as), ti->begin, ti->len,
594 dm_table_get_mode(ti->table), &p->path.dev);
596 ti->error = "error getting device";
600 if (m->hw_handler_name) {
601 struct request_queue *q = bdev_get_queue(p->path.dev->bdev);
603 r = scsi_dh_attach(q, m->hw_handler_name);
606 * Already attached to different hw_handler,
607 * try to reattach with correct one.
610 r = scsi_dh_attach(q, m->hw_handler_name);
614 ti->error = "error attaching hardware handler";
615 dm_put_device(ti, p->path.dev);
620 r = ps->type->add_path(ps, &p->path, as->argc, as->argv, &ti->error);
622 dm_put_device(ti, p->path.dev);
633 static struct priority_group *parse_priority_group(struct arg_set *as,
636 static struct param _params[] = {
637 {1, 1024, "invalid number of paths"},
638 {0, 1024, "invalid number of selector args"}
642 unsigned i, nr_selector_args, nr_params;
643 struct priority_group *pg;
644 struct dm_target *ti = m->ti;
648 ti->error = "not enough priority group arguments";
649 return ERR_PTR(-EINVAL);
652 pg = alloc_priority_group();
654 ti->error = "couldn't allocate priority group";
655 return ERR_PTR(-ENOMEM);
659 r = parse_path_selector(as, pg, ti);
666 r = read_param(_params, shift(as), &pg->nr_pgpaths, &ti->error);
670 r = read_param(_params + 1, shift(as), &nr_selector_args, &ti->error);
674 nr_params = 1 + nr_selector_args;
675 for (i = 0; i < pg->nr_pgpaths; i++) {
676 struct pgpath *pgpath;
677 struct arg_set path_args;
679 if (as->argc < nr_params) {
680 ti->error = "not enough path parameters";
684 path_args.argc = nr_params;
685 path_args.argv = as->argv;
687 pgpath = parse_path(&path_args, &pg->ps, ti);
688 if (IS_ERR(pgpath)) {
694 list_add_tail(&pgpath->list, &pg->pgpaths);
695 consume(as, nr_params);
701 free_priority_group(pg, ti);
705 static int parse_hw_handler(struct arg_set *as, struct multipath *m)
708 struct dm_target *ti = m->ti;
710 static struct param _params[] = {
711 {0, 1024, "invalid number of hardware handler args"},
714 if (read_param(_params, shift(as), &hw_argc, &ti->error))
720 if (hw_argc > as->argc) {
721 ti->error = "not enough arguments for hardware handler";
725 m->hw_handler_name = kstrdup(shift(as), GFP_KERNEL);
726 request_module("scsi_dh_%s", m->hw_handler_name);
727 if (scsi_dh_handler_exist(m->hw_handler_name) == 0) {
728 ti->error = "unknown hardware handler type";
729 kfree(m->hw_handler_name);
730 m->hw_handler_name = NULL;
735 DMWARN("Ignoring user-specified arguments for "
736 "hardware handler \"%s\"", m->hw_handler_name);
737 consume(as, hw_argc - 1);
742 static int parse_features(struct arg_set *as, struct multipath *m)
746 struct dm_target *ti = m->ti;
747 const char *param_name;
749 static struct param _params[] = {
750 {0, 3, "invalid number of feature args"},
751 {1, 50, "pg_init_retries must be between 1 and 50"},
754 r = read_param(_params, shift(as), &argc, &ti->error);
762 param_name = shift(as);
765 if (!strnicmp(param_name, MESG_STR("queue_if_no_path"))) {
766 r = queue_if_no_path(m, 1, 0);
770 if (!strnicmp(param_name, MESG_STR("pg_init_retries")) &&
772 r = read_param(_params + 1, shift(as),
773 &m->pg_init_retries, &ti->error);
778 ti->error = "Unrecognised multipath feature request";
780 } while (argc && !r);
785 static int multipath_ctr(struct dm_target *ti, unsigned int argc,
788 /* target parameters */
789 static struct param _params[] = {
790 {1, 1024, "invalid number of priority groups"},
791 {1, 1024, "invalid initial priority group number"},
797 unsigned pg_count = 0;
798 unsigned next_pg_num;
803 m = alloc_multipath(ti);
805 ti->error = "can't allocate multipath";
809 r = parse_features(&as, m);
813 r = parse_hw_handler(&as, m);
817 r = read_param(_params, shift(&as), &m->nr_priority_groups, &ti->error);
821 r = read_param(_params + 1, shift(&as), &next_pg_num, &ti->error);
825 /* parse the priority groups */
827 struct priority_group *pg;
829 pg = parse_priority_group(&as, m);
835 m->nr_valid_paths += pg->nr_pgpaths;
836 list_add_tail(&pg->list, &m->priority_groups);
838 pg->pg_num = pg_count;
843 if (pg_count != m->nr_priority_groups) {
844 ti->error = "priority group count mismatch";
849 ti->num_flush_requests = 1;
858 static void multipath_dtr(struct dm_target *ti)
860 struct multipath *m = (struct multipath *) ti->private;
862 flush_workqueue(kmpath_handlerd);
863 flush_workqueue(kmultipathd);
864 flush_scheduled_work();
869 * Map cloned requests
871 static int multipath_map(struct dm_target *ti, struct request *clone,
872 union map_info *map_context)
875 struct dm_mpath_io *mpio;
876 struct multipath *m = (struct multipath *) ti->private;
878 mpio = mempool_alloc(m->mpio_pool, GFP_ATOMIC);
880 /* ENOMEM, requeue */
881 return DM_MAPIO_REQUEUE;
882 memset(mpio, 0, sizeof(*mpio));
884 map_context->ptr = mpio;
885 clone->cmd_flags |= REQ_FAILFAST_TRANSPORT;
886 r = map_io(m, clone, mpio, 0);
887 if (r < 0 || r == DM_MAPIO_REQUEUE)
888 mempool_free(mpio, m->mpio_pool);
894 * Take a path out of use.
896 static int fail_path(struct pgpath *pgpath)
899 struct multipath *m = pgpath->pg->m;
901 spin_lock_irqsave(&m->lock, flags);
903 if (!pgpath->is_active)
906 DMWARN("Failing path %s.", pgpath->path.dev->name);
908 pgpath->pg->ps.type->fail_path(&pgpath->pg->ps, &pgpath->path);
909 pgpath->is_active = 0;
910 pgpath->fail_count++;
914 if (pgpath == m->current_pgpath)
915 m->current_pgpath = NULL;
917 dm_path_uevent(DM_UEVENT_PATH_FAILED, m->ti,
918 pgpath->path.dev->name, m->nr_valid_paths);
920 schedule_work(&m->trigger_event);
921 queue_work(kmultipathd, &pgpath->deactivate_path);
924 spin_unlock_irqrestore(&m->lock, flags);
930 * Reinstate a previously-failed path
932 static int reinstate_path(struct pgpath *pgpath)
936 struct multipath *m = pgpath->pg->m;
938 spin_lock_irqsave(&m->lock, flags);
940 if (pgpath->is_active)
943 if (!pgpath->pg->ps.type->reinstate_path) {
944 DMWARN("Reinstate path not supported by path selector %s",
945 pgpath->pg->ps.type->name);
950 r = pgpath->pg->ps.type->reinstate_path(&pgpath->pg->ps, &pgpath->path);
954 pgpath->is_active = 1;
956 if (!m->nr_valid_paths++ && m->queue_size) {
957 m->current_pgpath = NULL;
958 queue_work(kmultipathd, &m->process_queued_ios);
959 } else if (m->hw_handler_name && (m->current_pg == pgpath->pg)) {
960 if (queue_work(kmpath_handlerd, &pgpath->activate_path))
961 m->pg_init_in_progress++;
964 dm_path_uevent(DM_UEVENT_PATH_REINSTATED, m->ti,
965 pgpath->path.dev->name, m->nr_valid_paths);
967 schedule_work(&m->trigger_event);
970 spin_unlock_irqrestore(&m->lock, flags);
976 * Fail or reinstate all paths that match the provided struct dm_dev.
978 static int action_dev(struct multipath *m, struct dm_dev *dev,
982 struct pgpath *pgpath;
983 struct priority_group *pg;
985 list_for_each_entry(pg, &m->priority_groups, list) {
986 list_for_each_entry(pgpath, &pg->pgpaths, list) {
987 if (pgpath->path.dev == dev)
996 * Temporarily try to avoid having to use the specified PG
998 static void bypass_pg(struct multipath *m, struct priority_group *pg,
1001 unsigned long flags;
1003 spin_lock_irqsave(&m->lock, flags);
1005 pg->bypassed = bypassed;
1006 m->current_pgpath = NULL;
1007 m->current_pg = NULL;
1009 spin_unlock_irqrestore(&m->lock, flags);
1011 schedule_work(&m->trigger_event);
1015 * Switch to using the specified PG from the next I/O that gets mapped
1017 static int switch_pg_num(struct multipath *m, const char *pgstr)
1019 struct priority_group *pg;
1021 unsigned long flags;
1023 if (!pgstr || (sscanf(pgstr, "%u", &pgnum) != 1) || !pgnum ||
1024 (pgnum > m->nr_priority_groups)) {
1025 DMWARN("invalid PG number supplied to switch_pg_num");
1029 spin_lock_irqsave(&m->lock, flags);
1030 list_for_each_entry(pg, &m->priority_groups, list) {
1035 m->current_pgpath = NULL;
1036 m->current_pg = NULL;
1039 spin_unlock_irqrestore(&m->lock, flags);
1041 schedule_work(&m->trigger_event);
1046 * Set/clear bypassed status of a PG.
1047 * PGs are numbered upwards from 1 in the order they were declared.
1049 static int bypass_pg_num(struct multipath *m, const char *pgstr, int bypassed)
1051 struct priority_group *pg;
1054 if (!pgstr || (sscanf(pgstr, "%u", &pgnum) != 1) || !pgnum ||
1055 (pgnum > m->nr_priority_groups)) {
1056 DMWARN("invalid PG number supplied to bypass_pg");
1060 list_for_each_entry(pg, &m->priority_groups, list) {
1065 bypass_pg(m, pg, bypassed);
1070 * Should we retry pg_init immediately?
1072 static int pg_init_limit_reached(struct multipath *m, struct pgpath *pgpath)
1074 unsigned long flags;
1075 int limit_reached = 0;
1077 spin_lock_irqsave(&m->lock, flags);
1079 if (m->pg_init_count <= m->pg_init_retries)
1080 m->pg_init_required = 1;
1084 spin_unlock_irqrestore(&m->lock, flags);
1086 return limit_reached;
1089 static void pg_init_done(struct dm_path *path, int errors)
1091 struct pgpath *pgpath = path_to_pgpath(path);
1092 struct priority_group *pg = pgpath->pg;
1093 struct multipath *m = pg->m;
1094 unsigned long flags;
1096 /* device or driver problems */
1101 if (!m->hw_handler_name) {
1105 DMERR("Cannot failover device because scsi_dh_%s was not "
1106 "loaded.", m->hw_handler_name);
1108 * Fail path for now, so we do not ping pong
1112 case SCSI_DH_DEV_TEMP_BUSY:
1114 * Probably doing something like FW upgrade on the
1115 * controller so try the other pg.
1117 bypass_pg(m, pg, 1);
1119 /* TODO: For SCSI_DH_RETRY we should wait a couple seconds */
1121 case SCSI_DH_IMM_RETRY:
1122 case SCSI_DH_RES_TEMP_UNAVAIL:
1123 if (pg_init_limit_reached(m, pgpath))
1129 * We probably do not want to fail the path for a device
1130 * error, but this is what the old dm did. In future
1131 * patches we can do more advanced handling.
1136 spin_lock_irqsave(&m->lock, flags);
1138 if (pgpath == m->current_pgpath) {
1139 DMERR("Could not failover device. Error %d.", errors);
1140 m->current_pgpath = NULL;
1141 m->current_pg = NULL;
1143 } else if (!m->pg_init_required) {
1148 m->pg_init_in_progress--;
1149 if (!m->pg_init_in_progress)
1150 queue_work(kmultipathd, &m->process_queued_ios);
1151 spin_unlock_irqrestore(&m->lock, flags);
1154 static void activate_path(struct work_struct *work)
1157 struct pgpath *pgpath =
1158 container_of(work, struct pgpath, activate_path);
1160 ret = scsi_dh_activate(bdev_get_queue(pgpath->path.dev->bdev));
1161 pg_init_done(&pgpath->path, ret);
1167 static int do_end_io(struct multipath *m, struct request *clone,
1168 int error, struct dm_mpath_io *mpio)
1171 * We don't queue any clone request inside the multipath target
1172 * during end I/O handling, since those clone requests don't have
1173 * bio clones. If we queue them inside the multipath target,
1174 * we need to make bio clones, that requires memory allocation.
1175 * (See drivers/md/dm.c:end_clone_bio() about why the clone requests
1176 * don't have bio clones.)
1177 * Instead of queueing the clone request here, we queue the original
1178 * request into dm core, which will remake a clone request and
1179 * clone bios for it and resubmit it later.
1181 int r = DM_ENDIO_REQUEUE;
1182 unsigned long flags;
1184 if (!error && !clone->errors)
1185 return 0; /* I/O complete */
1187 if (error == -EOPNOTSUPP)
1191 fail_path(mpio->pgpath);
1193 spin_lock_irqsave(&m->lock, flags);
1194 if (!m->nr_valid_paths && !m->queue_if_no_path && !__must_push_back(m))
1196 spin_unlock_irqrestore(&m->lock, flags);
1201 static int multipath_end_io(struct dm_target *ti, struct request *clone,
1202 int error, union map_info *map_context)
1204 struct multipath *m = ti->private;
1205 struct dm_mpath_io *mpio = map_context->ptr;
1206 struct pgpath *pgpath = mpio->pgpath;
1207 struct path_selector *ps;
1210 r = do_end_io(m, clone, error, mpio);
1212 ps = &pgpath->pg->ps;
1213 if (ps->type->end_io)
1214 ps->type->end_io(ps, &pgpath->path, mpio->nr_bytes);
1216 mempool_free(mpio, m->mpio_pool);
1222 * Suspend can't complete until all the I/O is processed so if
1223 * the last path fails we must error any remaining I/O.
1224 * Note that if the freeze_bdev fails while suspending, the
1225 * queue_if_no_path state is lost - userspace should reset it.
1227 static void multipath_presuspend(struct dm_target *ti)
1229 struct multipath *m = (struct multipath *) ti->private;
1231 queue_if_no_path(m, 0, 1);
1235 * Restore the queue_if_no_path setting.
1237 static void multipath_resume(struct dm_target *ti)
1239 struct multipath *m = (struct multipath *) ti->private;
1240 unsigned long flags;
1242 spin_lock_irqsave(&m->lock, flags);
1243 m->queue_if_no_path = m->saved_queue_if_no_path;
1244 spin_unlock_irqrestore(&m->lock, flags);
1248 * Info output has the following format:
1249 * num_multipath_feature_args [multipath_feature_args]*
1250 * num_handler_status_args [handler_status_args]*
1251 * num_groups init_group_number
1252 * [A|D|E num_ps_status_args [ps_status_args]*
1253 * num_paths num_selector_args
1254 * [path_dev A|F fail_count [selector_args]* ]+ ]+
1256 * Table output has the following format (identical to the constructor string):
1257 * num_feature_args [features_args]*
1258 * num_handler_args hw_handler [hw_handler_args]*
1259 * num_groups init_group_number
1260 * [priority selector-name num_ps_args [ps_args]*
1261 * num_paths num_selector_args [path_dev [selector_args]* ]+ ]+
1263 static int multipath_status(struct dm_target *ti, status_type_t type,
1264 char *result, unsigned int maxlen)
1267 unsigned long flags;
1268 struct multipath *m = (struct multipath *) ti->private;
1269 struct priority_group *pg;
1274 spin_lock_irqsave(&m->lock, flags);
1277 if (type == STATUSTYPE_INFO)
1278 DMEMIT("2 %u %u ", m->queue_size, m->pg_init_count);
1280 DMEMIT("%u ", m->queue_if_no_path +
1281 (m->pg_init_retries > 0) * 2);
1282 if (m->queue_if_no_path)
1283 DMEMIT("queue_if_no_path ");
1284 if (m->pg_init_retries)
1285 DMEMIT("pg_init_retries %u ", m->pg_init_retries);
1288 if (!m->hw_handler_name || type == STATUSTYPE_INFO)
1291 DMEMIT("1 %s ", m->hw_handler_name);
1293 DMEMIT("%u ", m->nr_priority_groups);
1296 pg_num = m->next_pg->pg_num;
1297 else if (m->current_pg)
1298 pg_num = m->current_pg->pg_num;
1302 DMEMIT("%u ", pg_num);
1305 case STATUSTYPE_INFO:
1306 list_for_each_entry(pg, &m->priority_groups, list) {
1308 state = 'D'; /* Disabled */
1309 else if (pg == m->current_pg)
1310 state = 'A'; /* Currently Active */
1312 state = 'E'; /* Enabled */
1314 DMEMIT("%c ", state);
1316 if (pg->ps.type->status)
1317 sz += pg->ps.type->status(&pg->ps, NULL, type,
1323 DMEMIT("%u %u ", pg->nr_pgpaths,
1324 pg->ps.type->info_args);
1326 list_for_each_entry(p, &pg->pgpaths, list) {
1327 DMEMIT("%s %s %u ", p->path.dev->name,
1328 p->is_active ? "A" : "F",
1330 if (pg->ps.type->status)
1331 sz += pg->ps.type->status(&pg->ps,
1332 &p->path, type, result + sz,
1338 case STATUSTYPE_TABLE:
1339 list_for_each_entry(pg, &m->priority_groups, list) {
1340 DMEMIT("%s ", pg->ps.type->name);
1342 if (pg->ps.type->status)
1343 sz += pg->ps.type->status(&pg->ps, NULL, type,
1349 DMEMIT("%u %u ", pg->nr_pgpaths,
1350 pg->ps.type->table_args);
1352 list_for_each_entry(p, &pg->pgpaths, list) {
1353 DMEMIT("%s ", p->path.dev->name);
1354 if (pg->ps.type->status)
1355 sz += pg->ps.type->status(&pg->ps,
1356 &p->path, type, result + sz,
1363 spin_unlock_irqrestore(&m->lock, flags);
1368 static int multipath_message(struct dm_target *ti, unsigned argc, char **argv)
1372 struct multipath *m = (struct multipath *) ti->private;
1376 if (!strnicmp(argv[0], MESG_STR("queue_if_no_path")))
1377 return queue_if_no_path(m, 1, 0);
1378 else if (!strnicmp(argv[0], MESG_STR("fail_if_no_path")))
1379 return queue_if_no_path(m, 0, 0);
1385 if (!strnicmp(argv[0], MESG_STR("disable_group")))
1386 return bypass_pg_num(m, argv[1], 1);
1387 else if (!strnicmp(argv[0], MESG_STR("enable_group")))
1388 return bypass_pg_num(m, argv[1], 0);
1389 else if (!strnicmp(argv[0], MESG_STR("switch_group")))
1390 return switch_pg_num(m, argv[1]);
1391 else if (!strnicmp(argv[0], MESG_STR("reinstate_path")))
1392 action = reinstate_path;
1393 else if (!strnicmp(argv[0], MESG_STR("fail_path")))
1398 r = dm_get_device(ti, argv[1], ti->begin, ti->len,
1399 dm_table_get_mode(ti->table), &dev);
1401 DMWARN("message: error getting device %s",
1406 r = action_dev(m, dev, action);
1408 dm_put_device(ti, dev);
1413 DMWARN("Unrecognised multipath message received.");
1417 static int multipath_ioctl(struct dm_target *ti, unsigned int cmd,
1420 struct multipath *m = (struct multipath *) ti->private;
1421 struct block_device *bdev = NULL;
1423 unsigned long flags;
1426 spin_lock_irqsave(&m->lock, flags);
1428 if (!m->current_pgpath)
1429 __choose_pgpath(m, 0);
1431 if (m->current_pgpath) {
1432 bdev = m->current_pgpath->path.dev->bdev;
1433 mode = m->current_pgpath->path.dev->mode;
1441 spin_unlock_irqrestore(&m->lock, flags);
1443 return r ? : __blkdev_driver_ioctl(bdev, mode, cmd, arg);
1446 static int multipath_iterate_devices(struct dm_target *ti,
1447 iterate_devices_callout_fn fn, void *data)
1449 struct multipath *m = ti->private;
1450 struct priority_group *pg;
1454 list_for_each_entry(pg, &m->priority_groups, list) {
1455 list_for_each_entry(p, &pg->pgpaths, list) {
1456 ret = fn(ti, p->path.dev, ti->begin, data);
1466 static int __pgpath_busy(struct pgpath *pgpath)
1468 struct request_queue *q = bdev_get_queue(pgpath->path.dev->bdev);
1470 return dm_underlying_device_busy(q);
1474 * We return "busy", only when we can map I/Os but underlying devices
1475 * are busy (so even if we map I/Os now, the I/Os will wait on
1476 * the underlying queue).
1477 * In other words, if we want to kill I/Os or queue them inside us
1478 * due to map unavailability, we don't return "busy". Otherwise,
1479 * dm core won't give us the I/Os and we can't do what we want.
1481 static int multipath_busy(struct dm_target *ti)
1483 int busy = 0, has_active = 0;
1484 struct multipath *m = ti->private;
1485 struct priority_group *pg;
1486 struct pgpath *pgpath;
1487 unsigned long flags;
1489 spin_lock_irqsave(&m->lock, flags);
1491 /* Guess which priority_group will be used at next mapping time */
1492 if (unlikely(!m->current_pgpath && m->next_pg))
1494 else if (likely(m->current_pg))
1498 * We don't know which pg will be used at next mapping time.
1499 * We don't call __choose_pgpath() here to avoid to trigger
1500 * pg_init just by busy checking.
1501 * So we don't know whether underlying devices we will be using
1502 * at next mapping time are busy or not. Just try mapping.
1507 * If there is one non-busy active path at least, the path selector
1508 * will be able to select it. So we consider such a pg as not busy.
1511 list_for_each_entry(pgpath, &pg->pgpaths, list)
1512 if (pgpath->is_active) {
1515 if (!__pgpath_busy(pgpath)) {
1523 * No active path in this pg, so this pg won't be used and
1524 * the current_pg will be changed at next mapping time.
1525 * We need to try mapping to determine it.
1530 spin_unlock_irqrestore(&m->lock, flags);
1535 /*-----------------------------------------------------------------
1537 *---------------------------------------------------------------*/
1538 static struct target_type multipath_target = {
1539 .name = "multipath",
1540 .version = {1, 1, 0},
1541 .module = THIS_MODULE,
1542 .ctr = multipath_ctr,
1543 .dtr = multipath_dtr,
1544 .map_rq = multipath_map,
1545 .rq_end_io = multipath_end_io,
1546 .presuspend = multipath_presuspend,
1547 .resume = multipath_resume,
1548 .status = multipath_status,
1549 .message = multipath_message,
1550 .ioctl = multipath_ioctl,
1551 .iterate_devices = multipath_iterate_devices,
1552 .busy = multipath_busy,
1555 static int __init dm_multipath_init(void)
1559 /* allocate a slab for the dm_ios */
1560 _mpio_cache = KMEM_CACHE(dm_mpath_io, 0);
1564 r = dm_register_target(&multipath_target);
1566 DMERR("register failed %d", r);
1567 kmem_cache_destroy(_mpio_cache);
1571 kmultipathd = create_workqueue("kmpathd");
1573 DMERR("failed to create workqueue kmpathd");
1574 dm_unregister_target(&multipath_target);
1575 kmem_cache_destroy(_mpio_cache);
1580 * A separate workqueue is used to handle the device handlers
1581 * to avoid overloading existing workqueue. Overloading the
1582 * old workqueue would also create a bottleneck in the
1583 * path of the storage hardware device activation.
1585 kmpath_handlerd = create_singlethread_workqueue("kmpath_handlerd");
1586 if (!kmpath_handlerd) {
1587 DMERR("failed to create workqueue kmpath_handlerd");
1588 destroy_workqueue(kmultipathd);
1589 dm_unregister_target(&multipath_target);
1590 kmem_cache_destroy(_mpio_cache);
1594 DMINFO("version %u.%u.%u loaded",
1595 multipath_target.version[0], multipath_target.version[1],
1596 multipath_target.version[2]);
1601 static void __exit dm_multipath_exit(void)
1603 destroy_workqueue(kmpath_handlerd);
1604 destroy_workqueue(kmultipathd);
1606 dm_unregister_target(&multipath_target);
1607 kmem_cache_destroy(_mpio_cache);
1610 module_init(dm_multipath_init);
1611 module_exit(dm_multipath_exit);
1613 MODULE_DESCRIPTION(DM_NAME " multipath target");
1614 MODULE_AUTHOR("Sistina Software <dm-devel@redhat.com>");
1615 MODULE_LICENSE("GPL");