1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * multipath.c : Multiple Devices driver for Linux
5 * Copyright (C) 1999, 2000, 2001 Ingo Molnar, Red Hat
7 * Copyright (C) 1996, 1997, 1998 Ingo Molnar, Miguel de Icaza, Gadi Oxman
9 * MULTIPATH management functions.
11 * derived from raid1.c.
14 #include <linux/blkdev.h>
15 #include <linux/module.h>
16 #include <linux/raid/md_u.h>
17 #include <linux/seq_file.h>
18 #include <linux/slab.h>
20 #include "md-multipath.h"
22 #define MAX_WORK_PER_DISK 128
24 #define NR_RESERVED_BUFS 32
26 static int multipath_map (struct mpconf *conf)
28 int i, disks = conf->raid_disks;
31 * Later we do read balancing on the read side
32 * now we use the first available disk.
36 for (i = 0; i < disks; i++) {
37 struct md_rdev *rdev = rcu_dereference(conf->multipaths[i].rdev);
38 if (rdev && test_bit(In_sync, &rdev->flags) &&
39 !test_bit(Faulty, &rdev->flags)) {
40 atomic_inc(&rdev->nr_pending);
47 pr_crit_ratelimited("multipath_map(): no more operational IO paths?\n");
51 static void multipath_reschedule_retry (struct multipath_bh *mp_bh)
54 struct mddev *mddev = mp_bh->mddev;
55 struct mpconf *conf = mddev->private;
57 spin_lock_irqsave(&conf->device_lock, flags);
58 list_add(&mp_bh->retry_list, &conf->retry_list);
59 spin_unlock_irqrestore(&conf->device_lock, flags);
60 md_wakeup_thread(mddev->thread);
64 * multipath_end_bh_io() is called when we have finished servicing a multipathed
65 * operation and are ready to return a success/failure code to the buffer
68 static void multipath_end_bh_io(struct multipath_bh *mp_bh, blk_status_t status)
70 struct bio *bio = mp_bh->master_bio;
71 struct mpconf *conf = mp_bh->mddev->private;
73 bio->bi_status = status;
75 mempool_free(mp_bh, &conf->pool);
78 static void multipath_end_request(struct bio *bio)
80 struct multipath_bh *mp_bh = bio->bi_private;
81 struct mpconf *conf = mp_bh->mddev->private;
82 struct md_rdev *rdev = conf->multipaths[mp_bh->path].rdev;
85 multipath_end_bh_io(mp_bh, 0);
86 else if (!(bio->bi_opf & REQ_RAHEAD)) {
90 md_error (mp_bh->mddev, rdev);
91 pr_info("multipath: %pg: rescheduling sector %llu\n",
93 (unsigned long long)bio->bi_iter.bi_sector);
94 multipath_reschedule_retry(mp_bh);
96 multipath_end_bh_io(mp_bh, bio->bi_status);
97 rdev_dec_pending(rdev, conf->mddev);
100 static bool multipath_make_request(struct mddev *mddev, struct bio * bio)
102 struct mpconf *conf = mddev->private;
103 struct multipath_bh * mp_bh;
104 struct multipath_info *multipath;
106 if (unlikely(bio->bi_opf & REQ_PREFLUSH)
107 && md_flush_request(mddev, bio))
110 mp_bh = mempool_alloc(&conf->pool, GFP_NOIO);
112 mp_bh->master_bio = bio;
113 mp_bh->mddev = mddev;
115 mp_bh->path = multipath_map(conf);
116 if (mp_bh->path < 0) {
118 mempool_free(mp_bh, &conf->pool);
121 multipath = conf->multipaths + mp_bh->path;
123 bio_init_clone(multipath->rdev->bdev, &mp_bh->bio, bio, GFP_NOIO);
125 mp_bh->bio.bi_iter.bi_sector += multipath->rdev->data_offset;
126 mp_bh->bio.bi_opf |= REQ_FAILFAST_TRANSPORT;
127 mp_bh->bio.bi_end_io = multipath_end_request;
128 mp_bh->bio.bi_private = mp_bh;
129 mddev_check_write_zeroes(mddev, &mp_bh->bio);
130 submit_bio_noacct(&mp_bh->bio);
134 static void multipath_status(struct seq_file *seq, struct mddev *mddev)
136 struct mpconf *conf = mddev->private;
139 seq_printf (seq, " [%d/%d] [", conf->raid_disks,
140 conf->raid_disks - mddev->degraded);
142 for (i = 0; i < conf->raid_disks; i++) {
143 struct md_rdev *rdev = rcu_dereference(conf->multipaths[i].rdev);
144 seq_printf (seq, "%s", rdev && test_bit(In_sync, &rdev->flags) ? "U" : "_");
151 * Careful, this can execute in IRQ contexts as well!
153 static void multipath_error (struct mddev *mddev, struct md_rdev *rdev)
155 struct mpconf *conf = mddev->private;
157 if (conf->raid_disks - mddev->degraded <= 1) {
159 * Uh oh, we can do nothing if this is our last path, but
160 * first check if this is a queued request for a device
161 * which has just failed.
163 pr_warn("multipath: only one IO path left and IO error.\n");
164 /* leave it active... it's all we have */
168 * Mark disk as unusable
170 if (test_and_clear_bit(In_sync, &rdev->flags)) {
172 spin_lock_irqsave(&conf->device_lock, flags);
174 spin_unlock_irqrestore(&conf->device_lock, flags);
176 set_bit(Faulty, &rdev->flags);
177 set_bit(MD_SB_CHANGE_DEVS, &mddev->sb_flags);
178 pr_err("multipath: IO failure on %pg, disabling IO path.\n"
179 "multipath: Operation continuing on %d IO paths.\n",
181 conf->raid_disks - mddev->degraded);
184 static void print_multipath_conf (struct mpconf *conf)
187 struct multipath_info *tmp;
189 pr_debug("MULTIPATH conf printout:\n");
191 pr_debug("(conf==NULL)\n");
194 pr_debug(" --- wd:%d rd:%d\n", conf->raid_disks - conf->mddev->degraded,
197 for (i = 0; i < conf->raid_disks; i++) {
198 tmp = conf->multipaths + i;
200 pr_debug(" disk%d, o:%d, dev:%pg\n",
201 i,!test_bit(Faulty, &tmp->rdev->flags),
206 static int multipath_add_disk(struct mddev *mddev, struct md_rdev *rdev)
208 struct mpconf *conf = mddev->private;
211 struct multipath_info *p;
213 int last = mddev->raid_disks - 1;
215 if (rdev->raid_disk >= 0)
216 first = last = rdev->raid_disk;
218 print_multipath_conf(conf);
220 for (path = first; path <= last; path++)
221 if ((p=conf->multipaths+path)->rdev == NULL) {
222 disk_stack_limits(mddev->gendisk, rdev->bdev,
223 rdev->data_offset << 9);
225 err = md_integrity_add_rdev(rdev, mddev);
228 spin_lock_irq(&conf->device_lock);
230 rdev->raid_disk = path;
231 set_bit(In_sync, &rdev->flags);
232 spin_unlock_irq(&conf->device_lock);
233 rcu_assign_pointer(p->rdev, rdev);
238 print_multipath_conf(conf);
243 static int multipath_remove_disk(struct mddev *mddev, struct md_rdev *rdev)
245 struct mpconf *conf = mddev->private;
247 int number = rdev->raid_disk;
248 struct multipath_info *p = conf->multipaths + number;
250 print_multipath_conf(conf);
252 if (rdev == p->rdev) {
253 if (test_bit(In_sync, &rdev->flags) ||
254 atomic_read(&rdev->nr_pending)) {
255 pr_warn("hot-remove-disk, slot %d is identified but is still operational!\n", number);
260 if (!test_bit(RemoveSynchronized, &rdev->flags)) {
262 if (atomic_read(&rdev->nr_pending)) {
263 /* lost the race, try later */
269 err = md_integrity_register(mddev);
273 print_multipath_conf(conf);
278 * This is a kernel thread which:
280 * 1. Retries failed read operations on working multipaths.
281 * 2. Updates the raid superblock when problems encounter.
282 * 3. Performs writes following reads for array syncronising.
285 static void multipathd(struct md_thread *thread)
287 struct mddev *mddev = thread->mddev;
288 struct multipath_bh *mp_bh;
291 struct mpconf *conf = mddev->private;
292 struct list_head *head = &conf->retry_list;
294 md_check_recovery(mddev);
296 spin_lock_irqsave(&conf->device_lock, flags);
297 if (list_empty(head))
299 mp_bh = list_entry(head->prev, struct multipath_bh, retry_list);
300 list_del(head->prev);
301 spin_unlock_irqrestore(&conf->device_lock, flags);
304 bio->bi_iter.bi_sector = mp_bh->master_bio->bi_iter.bi_sector;
306 if ((mp_bh->path = multipath_map (conf))<0) {
307 pr_err("multipath: %pg: unrecoverable IO read error for block %llu\n",
309 (unsigned long long)bio->bi_iter.bi_sector);
310 multipath_end_bh_io(mp_bh, BLK_STS_IOERR);
312 pr_err("multipath: %pg: redirecting sector %llu to another IO path\n",
314 (unsigned long long)bio->bi_iter.bi_sector);
315 *bio = *(mp_bh->master_bio);
316 bio->bi_iter.bi_sector +=
317 conf->multipaths[mp_bh->path].rdev->data_offset;
318 bio_set_dev(bio, conf->multipaths[mp_bh->path].rdev->bdev);
319 bio->bi_opf |= REQ_FAILFAST_TRANSPORT;
320 bio->bi_end_io = multipath_end_request;
321 bio->bi_private = mp_bh;
322 submit_bio_noacct(bio);
325 spin_unlock_irqrestore(&conf->device_lock, flags);
328 static sector_t multipath_size(struct mddev *mddev, sector_t sectors, int raid_disks)
330 WARN_ONCE(sectors || raid_disks,
331 "%s does not support generic reshape\n", __func__);
333 return mddev->dev_sectors;
336 static int multipath_run (struct mddev *mddev)
340 struct multipath_info *disk;
341 struct md_rdev *rdev;
345 if (md_check_no_bitmap(mddev))
348 if (mddev->level != LEVEL_MULTIPATH) {
349 pr_warn("multipath: %s: raid level not set to multipath IO (%d)\n",
350 mdname(mddev), mddev->level);
354 * copy the already verified devices into our private MULTIPATH
355 * bookkeeping area. [whatever we allocate in multipath_run(),
356 * should be freed in multipath_free()]
359 conf = kzalloc(sizeof(struct mpconf), GFP_KERNEL);
360 mddev->private = conf;
364 conf->multipaths = kcalloc(mddev->raid_disks,
365 sizeof(struct multipath_info),
367 if (!conf->multipaths)
371 rdev_for_each(rdev, mddev) {
372 disk_idx = rdev->raid_disk;
374 disk_idx >= mddev->raid_disks)
377 disk = conf->multipaths + disk_idx;
379 disk_stack_limits(mddev->gendisk, rdev->bdev,
380 rdev->data_offset << 9);
382 if (!test_bit(Faulty, &rdev->flags))
386 conf->raid_disks = mddev->raid_disks;
388 spin_lock_init(&conf->device_lock);
389 INIT_LIST_HEAD(&conf->retry_list);
391 if (!working_disks) {
392 pr_warn("multipath: no operational IO paths for %s\n",
396 mddev->degraded = conf->raid_disks - working_disks;
398 ret = mempool_init_kmalloc_pool(&conf->pool, NR_RESERVED_BUFS,
399 sizeof(struct multipath_bh));
403 mddev->thread = md_register_thread(multipathd, mddev,
408 pr_info("multipath: array %s active with %d out of %d IO paths\n",
409 mdname(mddev), conf->raid_disks - mddev->degraded,
412 * Ok, everything is just fine now
414 md_set_array_sectors(mddev, multipath_size(mddev, 0, 0));
416 if (md_integrity_register(mddev))
422 mempool_exit(&conf->pool);
423 kfree(conf->multipaths);
425 mddev->private = NULL;
430 static void multipath_free(struct mddev *mddev, void *priv)
432 struct mpconf *conf = priv;
434 mempool_exit(&conf->pool);
435 kfree(conf->multipaths);
439 static struct md_personality multipath_personality =
442 .level = LEVEL_MULTIPATH,
443 .owner = THIS_MODULE,
444 .make_request = multipath_make_request,
445 .run = multipath_run,
446 .free = multipath_free,
447 .status = multipath_status,
448 .error_handler = multipath_error,
449 .hot_add_disk = multipath_add_disk,
450 .hot_remove_disk= multipath_remove_disk,
451 .size = multipath_size,
454 static int __init multipath_init (void)
456 return register_md_personality (&multipath_personality);
459 static void __exit multipath_exit (void)
461 unregister_md_personality (&multipath_personality);
464 module_init(multipath_init);
465 module_exit(multipath_exit);
466 MODULE_LICENSE("GPL");
467 MODULE_DESCRIPTION("simple multi-path personality for MD (deprecated)");
468 MODULE_ALIAS("md-personality-7"); /* MULTIPATH */
469 MODULE_ALIAS("md-multipath");
470 MODULE_ALIAS("md-level--4");