drivers/md/dm-mpath.c

   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
   8 #include "dm.h"
   9 #include "dm-path-selector.h"
  10 #include "dm-hw-handler.h"
  11 #include "dm-bio-list.h"
  12 #include "dm-bio-record.h"
  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>
  22 #include <asm/atomic.h>
  23
  24 #define MESG_STR(x) x, sizeof(x)
  25
  26 /* Path properties */
  27 struct pgpath {
  28         struct list_head list;
  29
  30         struct priority_group *pg;      /* Owning PG */
  31         unsigned fail_count;            /* Cumulative failure count */
  32
  33         struct path path;
  34 };
  35
  36 #define path_to_pgpath(__pgp) container_of((__pgp), struct pgpath, path)
  37
  38 /*
  39  * Paths are grouped into Priority Groups and numbered from 1 upwards.
  40  * Each has a path selector which controls which path gets used.
  41  */
  42 struct priority_group {
  43         struct list_head list;
  44
  45         struct multipath *m;            /* Owning multipath instance */
  46         struct path_selector ps;
  47
  48         unsigned pg_num;                /* Reference number */
  49         unsigned bypassed;              /* Temporarily bypass this PG? */
  50
  51         unsigned nr_pgpaths;            /* Number of paths in PG */
  52         struct list_head pgpaths;
  53 };
  54
  55 /* Multipath context */
  56 struct multipath {
  57         struct list_head list;
  58         struct dm_target *ti;
  59
  60         spinlock_t lock;
  61
  62         struct hw_handler hw_handler;
  63         unsigned nr_priority_groups;
  64         struct list_head priority_groups;
  65         unsigned pg_init_required;      /* pg_init needs calling? */
  66         unsigned pg_init_in_progress;   /* Only one pg_init allowed at once */
  67
  68         unsigned nr_valid_paths;        /* Total number of usable paths */
  69         struct pgpath *current_pgpath;
  70         struct priority_group *current_pg;
  71         struct priority_group *next_pg; /* Switch to this PG if set */
  72         unsigned repeat_count;          /* I/Os left before calling PS again */
  73
  74         unsigned queue_io;              /* Must we queue all I/O? */
  75         unsigned queue_if_no_path;      /* Queue I/O if last path fails? */
  76         unsigned saved_queue_if_no_path;/* Saved state during suspension */
  77
  78         struct work_struct process_queued_ios;
  79         struct bio_list queued_ios;
  80         unsigned queue_size;
  81
  82         struct work_struct trigger_event;
  83
  84         /*
  85          * We must use a mempool of mpath_io structs so that we
  86          * can resubmit bios on error.
  87          */
  88         mempool_t *mpio_pool;
  89 };
  90
  91 /*
  92  * Context information attached to each bio we process.
  93  */
  94 struct mpath_io {
  95         struct pgpath *pgpath;
  96         struct dm_bio_details details;
  97 };
  98
  99 typedef int (*action_fn) (struct pgpath *pgpath);
 100
 101 #define MIN_IOS 256     /* Mempool size */
 102
 103 static kmem_cache_t *_mpio_cache;
 104
 105 struct workqueue_struct *kmultipathd;
 106 static void process_queued_ios(void *data);
 107 static void trigger_event(void *data);
 108
 109
 110 /*-----------------------------------------------
 111  * Allocation routines
 112  *-----------------------------------------------*/
 113
 114 static struct pgpath *alloc_pgpath(void)
 115 {
 116         struct pgpath *pgpath = kmalloc(sizeof(*pgpath), GFP_KERNEL);
 117
 118         if (pgpath) {
 119                 memset(pgpath, 0, sizeof(*pgpath));
 120                 pgpath->path.is_active = 1;
 121         }
 122
 123         return pgpath;
 124 }
 125
 126 static inline void free_pgpath(struct pgpath *pgpath)
 127 {
 128         kfree(pgpath);
 129 }
 130
 131 static struct priority_group *alloc_priority_group(void)
 132 {
 133         struct priority_group *pg;
 134
 135         pg = kmalloc(sizeof(*pg), GFP_KERNEL);
 136         if (!pg)
 137                 return NULL;
 138
 139         memset(pg, 0, sizeof(*pg));
 140         INIT_LIST_HEAD(&pg->pgpaths);
 141
 142         return pg;
 143 }
 144
 145 static void free_pgpaths(struct list_head *pgpaths, struct dm_target *ti)
 146 {
 147         struct pgpath *pgpath, *tmp;
 148
 149         list_for_each_entry_safe(pgpath, tmp, pgpaths, list) {
 150                 list_del(&pgpath->list);
 151                 dm_put_device(ti, pgpath->path.dev);
 152                 free_pgpath(pgpath);
 153         }
 154 }
 155
 156 static void free_priority_group(struct priority_group *pg,
 157                                 struct dm_target *ti)
 158 {
 159         struct path_selector *ps = &pg->ps;
 160
 161         if (ps->type) {
 162                 ps->type->destroy(ps);
 163                 dm_put_path_selector(ps->type);
 164         }
 165
 166         free_pgpaths(&pg->pgpaths, ti);
 167         kfree(pg);
 168 }
 169
 170 static struct multipath *alloc_multipath(void)
 171 {
 172         struct multipath *m;
 173
 174         m = kmalloc(sizeof(*m), GFP_KERNEL);
 175         if (m) {
 176                 memset(m, 0, sizeof(*m));
 177                 INIT_LIST_HEAD(&m->priority_groups);
 178                 spin_lock_init(&m->lock);
 179                 m->queue_io = 1;
 180                 INIT_WORK(&m->process_queued_ios, process_queued_ios, m);
 181                 INIT_WORK(&m->trigger_event, trigger_event, m);
 182                 m->mpio_pool = mempool_create_slab_pool(MIN_IOS, _mpio_cache);
 183                 if (!m->mpio_pool) {
 184                         kfree(m);
 185                         return NULL;
 186                 }
 187         }
 188
 189         return m;
 190 }
 191
 192 static void free_multipath(struct multipath *m)
 193 {
 194         struct priority_group *pg, *tmp;
 195         struct hw_handler *hwh = &m->hw_handler;
 196
 197         list_for_each_entry_safe(pg, tmp, &m->priority_groups, list) {
 198                 list_del(&pg->list);
 199                 free_priority_group(pg, m->ti);
 200         }
 201
 202         if (hwh->type) {
 203                 hwh->type->destroy(hwh);
 204                 dm_put_hw_handler(hwh->type);
 205         }
 206
 207         mempool_destroy(m->mpio_pool);
 208         kfree(m);
 209 }
 210
 211
 212 /*-----------------------------------------------
 213  * Path selection
 214  *-----------------------------------------------*/
 215
 216 static void __switch_pg(struct multipath *m, struct pgpath *pgpath)
 217 {
 218         struct hw_handler *hwh = &m->hw_handler;
 219
 220         m->current_pg = pgpath->pg;
 221
 222         /* Must we initialise the PG first, and queue I/O till it's ready? */
 223         if (hwh->type && hwh->type->pg_init) {
 224                 m->pg_init_required = 1;
 225                 m->queue_io = 1;
 226         } else {
 227                 m->pg_init_required = 0;
 228                 m->queue_io = 0;
 229         }
 230 }
 231
 232 static int __choose_path_in_pg(struct multipath *m, struct priority_group *pg)
 233 {
 234         struct path *path;
 235
 236         path = pg->ps.type->select_path(&pg->ps, &m->repeat_count);
 237         if (!path)
 238                 return -ENXIO;
 239
 240         m->current_pgpath = path_to_pgpath(path);
 241
 242         if (m->current_pg != pg)
 243                 __switch_pg(m, m->current_pgpath);
 244
 245         return 0;
 246 }
 247
 248 static void __choose_pgpath(struct multipath *m)
 249 {
 250         struct priority_group *pg;
 251         unsigned bypassed = 1;
 252
 253         if (!m->nr_valid_paths)
 254                 goto failed;
 255
 256         /* Were we instructed to switch PG? */
 257         if (m->next_pg) {
 258                 pg = m->next_pg;
 259                 m->next_pg = NULL;
 260                 if (!__choose_path_in_pg(m, pg))
 261                         return;
 262         }
 263
 264         /* Don't change PG until it has no remaining paths */
 265         if (m->current_pg && !__choose_path_in_pg(m, m->current_pg))
 266                 return;
 267
 268         /*
 269          * Loop through priority groups until we find a valid path.
 270          * First time we skip PGs marked 'bypassed'.
 271          * Second time we only try the ones we skipped.
 272          */
 273         do {
 274                 list_for_each_entry(pg, &m->priority_groups, list) {
 275                         if (pg->bypassed == bypassed)
 276                                 continue;
 277                         if (!__choose_path_in_pg(m, pg))
 278                                 return;
 279                 }
 280         } while (bypassed--);
 281
 282 failed:
 283         m->current_pgpath = NULL;
 284         m->current_pg = NULL;
 285 }
 286
 287 static int map_io(struct multipath *m, struct bio *bio, struct mpath_io *mpio,
 288                   unsigned was_queued)
 289 {
 290         int r = 1;
 291         unsigned long flags;
 292         struct pgpath *pgpath;
 293
 294         spin_lock_irqsave(&m->lock, flags);
 295
 296         /* Do we need to select a new pgpath? */
 297         if (!m->current_pgpath ||
 298             (!m->queue_io && (m->repeat_count && --m->repeat_count == 0)))
 299                 __choose_pgpath(m);
 300
 301         pgpath = m->current_pgpath;
 302
 303         if (was_queued)
 304                 m->queue_size--;
 305
 306         if ((pgpath && m->queue_io) ||
 307             (!pgpath && m->queue_if_no_path)) {
 308                 /* Queue for the daemon to resubmit */
 309                 bio_list_add(&m->queued_ios, bio);
 310                 m->queue_size++;
 311                 if ((m->pg_init_required && !m->pg_init_in_progress) ||
 312                     !m->queue_io)
 313                         queue_work(kmultipathd, &m->process_queued_ios);
 314                 pgpath = NULL;
 315                 r = 0;
 316         } else if (!pgpath)
 317                 r = -EIO;               /* Failed */
 318         else
 319                 bio->bi_bdev = pgpath->path.dev->bdev;
 320
 321         mpio->pgpath = pgpath;
 322
 323         spin_unlock_irqrestore(&m->lock, flags);
 324
 325         return r;
 326 }
 327
 328 /*
 329  * If we run out of usable paths, should we queue I/O or error it?
 330  */
 331 static int queue_if_no_path(struct multipath *m, unsigned queue_if_no_path,
 332                             unsigned save_old_value)
 333 {
 334         unsigned long flags;
 335
 336         spin_lock_irqsave(&m->lock, flags);
 337
 338         if (save_old_value)
 339                 m->saved_queue_if_no_path = m->queue_if_no_path;
 340         else
 341                 m->saved_queue_if_no_path = queue_if_no_path;
 342         m->queue_if_no_path = queue_if_no_path;
 343         if (!m->queue_if_no_path && m->queue_size)
 344                 queue_work(kmultipathd, &m->process_queued_ios);
 345
 346         spin_unlock_irqrestore(&m->lock, flags);
 347
 348         return 0;
 349 }
 350
 351 /*-----------------------------------------------------------------
 352  * The multipath daemon is responsible for resubmitting queued ios.
 353  *---------------------------------------------------------------*/
 354
 355 static void dispatch_queued_ios(struct multipath *m)
 356 {
 357         int r;
 358         unsigned long flags;
 359         struct bio *bio = NULL, *next;
 360         struct mpath_io *mpio;
 361         union map_info *info;
 362
 363         spin_lock_irqsave(&m->lock, flags);
 364         bio = bio_list_get(&m->queued_ios);
 365         spin_unlock_irqrestore(&m->lock, flags);
 366
 367         while (bio) {
 368                 next = bio->bi_next;
 369                 bio->bi_next = NULL;
 370
 371                 info = dm_get_mapinfo(bio);
 372                 mpio = info->ptr;
 373
 374                 r = map_io(m, bio, mpio, 1);
 375                 if (r < 0)
 376                         bio_endio(bio, bio->bi_size, r);
 377                 else if (r == 1)
 378                         generic_make_request(bio);
 379
 380                 bio = next;
 381         }
 382 }
 383
 384 static void process_queued_ios(void *data)
 385 {
 386         struct multipath *m = (struct multipath *) data;
 387         struct hw_handler *hwh = &m->hw_handler;
 388         struct pgpath *pgpath = NULL;
 389         unsigned init_required = 0, must_queue = 1;
 390         unsigned long flags;
 391
 392         spin_lock_irqsave(&m->lock, flags);
 393
 394         if (!m->queue_size)
 395                 goto out;
 396
 397         if (!m->current_pgpath)
 398                 __choose_pgpath(m);
 399
 400         pgpath = m->current_pgpath;
 401
 402         if ((pgpath && !m->queue_io) ||
 403             (!pgpath && !m->queue_if_no_path))
 404                 must_queue = 0;
 405
 406         if (m->pg_init_required && !m->pg_init_in_progress) {
 407                 m->pg_init_required = 0;
 408                 m->pg_init_in_progress = 1;
 409                 init_required = 1;
 410         }
 411
 412 out:
 413         spin_unlock_irqrestore(&m->lock, flags);
 414
 415         if (init_required)
 416                 hwh->type->pg_init(hwh, pgpath->pg->bypassed, &pgpath->path);
 417
 418         if (!must_queue)
 419                 dispatch_queued_ios(m);
 420 }
 421
 422 /*
 423  * An event is triggered whenever a path is taken out of use.
 424  * Includes path failure and PG bypass.
 425  */
 426 static void trigger_event(void *data)
 427 {
 428         struct multipath *m = (struct multipath *) data;
 429
 430         dm_table_event(m->ti->table);
 431 }
 432
 433 /*-----------------------------------------------------------------
 434  * Constructor/argument parsing:
 435  * <#multipath feature args> [<arg>]*
 436  * <#hw_handler args> [hw_handler [<arg>]*]
 437  * <#priority groups>
 438  * <initial priority group>
 439  *     [<selector> <#selector args> [<arg>]*
 440  *      <#paths> <#per-path selector args>
 441  *         [<path> [<arg>]* ]+ ]+
 442  *---------------------------------------------------------------*/
 443 struct param {
 444         unsigned min;
 445         unsigned max;
 446         char *error;
 447 };
 448
 449 #define ESTR(s) ("dm-multipath: " s)
 450
 451 static int read_param(struct param *param, char *str, unsigned *v, char **error)
 452 {
 453         if (!str ||
 454             (sscanf(str, "%u", v) != 1) ||
 455             (*v < param->min) ||
 456             (*v > param->max)) {
 457                 *error = param->error;
 458                 return -EINVAL;
 459         }
 460
 461         return 0;
 462 }
 463
 464 struct arg_set {
 465         unsigned argc;
 466         char **argv;
 467 };
 468
 469 static char *shift(struct arg_set *as)
 470 {
 471         char *r;
 472
 473         if (as->argc) {
 474                 as->argc--;
 475                 r = *as->argv;
 476                 as->argv++;
 477                 return r;
 478         }
 479
 480         return NULL;
 481 }
 482
 483 static void consume(struct arg_set *as, unsigned n)
 484 {
 485         BUG_ON (as->argc < n);
 486         as->argc -= n;
 487         as->argv += n;
 488 }
 489
 490 static int parse_path_selector(struct arg_set *as, struct priority_group *pg,
 491                                struct dm_target *ti)
 492 {
 493         int r;
 494         struct path_selector_type *pst;
 495         unsigned ps_argc;
 496
 497         static struct param _params[] = {
 498                 {0, 1024, ESTR("invalid number of path selector args")},
 499         };
 500
 501         pst = dm_get_path_selector(shift(as));
 502         if (!pst) {
 503                 ti->error = ESTR("unknown path selector type");
 504                 return -EINVAL;
 505         }
 506
 507         r = read_param(_params, shift(as), &ps_argc, &ti->error);
 508         if (r)
 509                 return -EINVAL;
 510
 511         r = pst->create(&pg->ps, ps_argc, as->argv);
 512         if (r) {
 513                 dm_put_path_selector(pst);
 514                 ti->error = ESTR("path selector constructor failed");
 515                 return r;
 516         }
 517
 518         pg->ps.type = pst;
 519         consume(as, ps_argc);
 520
 521         return 0;
 522 }
 523
 524 static struct pgpath *parse_path(struct arg_set *as, struct path_selector *ps,
 525                                struct dm_target *ti)
 526 {
 527         int r;
 528         struct pgpath *p;
 529
 530         /* we need at least a path arg */
 531         if (as->argc < 1) {
 532                 ti->error = ESTR("no device given");
 533                 return NULL;
 534         }
 535
 536         p = alloc_pgpath();
 537         if (!p)
 538                 return NULL;
 539
 540         r = dm_get_device(ti, shift(as), ti->begin, ti->len,
 541                           dm_table_get_mode(ti->table), &p->path.dev);
 542         if (r) {
 543                 ti->error = ESTR("error getting device");
 544                 goto bad;
 545         }
 546
 547         r = ps->type->add_path(ps, &p->path, as->argc, as->argv, &ti->error);
 548         if (r) {
 549                 dm_put_device(ti, p->path.dev);
 550                 goto bad;
 551         }
 552
 553         return p;
 554
 555  bad:
 556         free_pgpath(p);
 557         return NULL;
 558 }
 559
 560 static struct priority_group *parse_priority_group(struct arg_set *as,
 561                                                    struct multipath *m,
 562                                                    struct dm_target *ti)
 563 {
 564         static struct param _params[] = {
 565                 {1, 1024, ESTR("invalid number of paths")},
 566                 {0, 1024, ESTR("invalid number of selector args")}
 567         };
 568
 569         int r;
 570         unsigned i, nr_selector_args, nr_params;
 571         struct priority_group *pg;
 572
 573         if (as->argc < 2) {
 574                 as->argc = 0;
 575                 ti->error = ESTR("not enough priority group aruments");
 576                 return NULL;
 577         }
 578
 579         pg = alloc_priority_group();
 580         if (!pg) {
 581                 ti->error = ESTR("couldn't allocate priority group");
 582                 return NULL;
 583         }
 584         pg->m = m;
 585
 586         r = parse_path_selector(as, pg, ti);
 587         if (r)
 588                 goto bad;
 589
 590         /*
 591          * read the paths
 592          */
 593         r = read_param(_params, shift(as), &pg->nr_pgpaths, &ti->error);
 594         if (r)
 595                 goto bad;
 596
 597         r = read_param(_params + 1, shift(as), &nr_selector_args, &ti->error);
 598         if (r)
 599                 goto bad;
 600
 601         nr_params = 1 + nr_selector_args;
 602         for (i = 0; i < pg->nr_pgpaths; i++) {
 603                 struct pgpath *pgpath;
 604                 struct arg_set path_args;
 605
 606                 if (as->argc < nr_params)
 607                         goto bad;
 608
 609                 path_args.argc = nr_params;
 610                 path_args.argv = as->argv;
 611
 612                 pgpath = parse_path(&path_args, &pg->ps, ti);
 613                 if (!pgpath)
 614                         goto bad;
 615
 616                 pgpath->pg = pg;
 617                 list_add_tail(&pgpath->list, &pg->pgpaths);
 618                 consume(as, nr_params);
 619         }
 620
 621         return pg;
 622
 623  bad:
 624         free_priority_group(pg, ti);
 625         return NULL;
 626 }
 627
 628 static int parse_hw_handler(struct arg_set *as, struct multipath *m,
 629                             struct dm_target *ti)
 630 {
 631         int r;
 632         struct hw_handler_type *hwht;
 633         unsigned hw_argc;
 634
 635         static struct param _params[] = {
 636                 {0, 1024, ESTR("invalid number of hardware handler args")},
 637         };
 638
 639         r = read_param(_params, shift(as), &hw_argc, &ti->error);
 640         if (r)
 641                 return -EINVAL;
 642
 643         if (!hw_argc)
 644                 return 0;
 645
 646         hwht = dm_get_hw_handler(shift(as));
 647         if (!hwht) {
 648                 ti->error = ESTR("unknown hardware handler type");
 649                 return -EINVAL;
 650         }
 651
 652         r = hwht->create(&m->hw_handler, hw_argc - 1, as->argv);
 653         if (r) {
 654                 dm_put_hw_handler(hwht);
 655                 ti->error = ESTR("hardware handler constructor failed");
 656                 return r;
 657         }
 658
 659         m->hw_handler.type = hwht;
 660         consume(as, hw_argc - 1);
 661
 662         return 0;
 663 }
 664
 665 static int parse_features(struct arg_set *as, struct multipath *m,
 666                           struct dm_target *ti)
 667 {
 668         int r;
 669         unsigned argc;
 670
 671         static struct param _params[] = {
 672                 {0, 1, ESTR("invalid number of feature args")},
 673         };
 674
 675         r = read_param(_params, shift(as), &argc, &ti->error);
 676         if (r)
 677                 return -EINVAL;
 678
 679         if (!argc)
 680                 return 0;
 681
 682         if (!strnicmp(shift(as), MESG_STR("queue_if_no_path")))
 683                 return queue_if_no_path(m, 1, 0);
 684         else {
 685                 ti->error = "Unrecognised multipath feature request";
 686                 return -EINVAL;
 687         }
 688 }
 689
 690 static int multipath_ctr(struct dm_target *ti, unsigned int argc,
 691                          char **argv)
 692 {
 693         /* target parameters */
 694         static struct param _params[] = {
 695                 {1, 1024, ESTR("invalid number of priority groups")},
 696                 {1, 1024, ESTR("invalid initial priority group number")},
 697         };
 698
 699         int r;
 700         struct multipath *m;
 701         struct arg_set as;
 702         unsigned pg_count = 0;
 703         unsigned next_pg_num;
 704
 705         as.argc = argc;
 706         as.argv = argv;
 707
 708         m = alloc_multipath();
 709         if (!m) {
 710                 ti->error = ESTR("can't allocate multipath");
 711                 return -EINVAL;
 712         }
 713
 714         m->ti = ti;
 715
 716         r = parse_features(&as, m, ti);
 717         if (r)
 718                 goto bad;
 719
 720         r = parse_hw_handler(&as, m, ti);
 721         if (r)
 722                 goto bad;
 723
 724         r = read_param(_params, shift(&as), &m->nr_priority_groups, &ti->error);
 725         if (r)
 726                 goto bad;
 727
 728         r = read_param(_params + 1, shift(&as), &next_pg_num, &ti->error);
 729         if (r)
 730                 goto bad;
 731
 732         /* parse the priority groups */
 733         while (as.argc) {
 734                 struct priority_group *pg;
 735
 736                 pg = parse_priority_group(&as, m, ti);
 737                 if (!pg) {
 738                         r = -EINVAL;
 739                         goto bad;
 740                 }
 741
 742                 m->nr_valid_paths += pg->nr_pgpaths;
 743                 list_add_tail(&pg->list, &m->priority_groups);
 744                 pg_count++;
 745                 pg->pg_num = pg_count;
 746                 if (!--next_pg_num)
 747                         m->next_pg = pg;
 748         }
 749
 750         if (pg_count != m->nr_priority_groups) {
 751                 ti->error = ESTR("priority group count mismatch");
 752                 r = -EINVAL;
 753                 goto bad;
 754         }
 755
 756         ti->private = m;
 757
 758         return 0;
 759
 760  bad:
 761         free_multipath(m);
 762         return r;
 763 }
 764
 765 static void multipath_dtr(struct dm_target *ti)
 766 {
 767         struct multipath *m = (struct multipath *) ti->private;
 768
 769         flush_workqueue(kmultipathd);
 770         free_multipath(m);
 771 }
 772
 773 /*
 774  * Map bios, recording original fields for later in case we have to resubmit
 775  */
 776 static int multipath_map(struct dm_target *ti, struct bio *bio,
 777                          union map_info *map_context)
 778 {
 779         int r;
 780         struct mpath_io *mpio;
 781         struct multipath *m = (struct multipath *) ti->private;
 782
 783         if (bio_barrier(bio))
 784                 return -EOPNOTSUPP;
 785
 786         mpio = mempool_alloc(m->mpio_pool, GFP_NOIO);
 787         dm_bio_record(&mpio->details, bio);
 788
 789         map_context->ptr = mpio;
 790         bio->bi_rw |= (1 << BIO_RW_FAILFAST);
 791         r = map_io(m, bio, mpio, 0);
 792         if (r < 0)
 793                 mempool_free(mpio, m->mpio_pool);
 794
 795         return r;
 796 }
 797
 798 /*
 799  * Take a path out of use.
 800  */
 801 static int fail_path(struct pgpath *pgpath)
 802 {
 803         unsigned long flags;
 804         struct multipath *m = pgpath->pg->m;
 805
 806         spin_lock_irqsave(&m->lock, flags);
 807
 808         if (!pgpath->path.is_active)
 809                 goto out;
 810
 811         DMWARN("dm-multipath: Failing path %s.", pgpath->path.dev->name);
 812
 813         pgpath->pg->ps.type->fail_path(&pgpath->pg->ps, &pgpath->path);
 814         pgpath->path.is_active = 0;
 815         pgpath->fail_count++;
 816
 817         m->nr_valid_paths--;
 818
 819         if (pgpath == m->current_pgpath)
 820                 m->current_pgpath = NULL;
 821
 822         queue_work(kmultipathd, &m->trigger_event);
 823
 824 out:
 825         spin_unlock_irqrestore(&m->lock, flags);
 826
 827         return 0;
 828 }
 829
 830 /*
 831  * Reinstate a previously-failed path
 832  */
 833 static int reinstate_path(struct pgpath *pgpath)
 834 {
 835         int r = 0;
 836         unsigned long flags;
 837         struct multipath *m = pgpath->pg->m;
 838
 839         spin_lock_irqsave(&m->lock, flags);
 840
 841         if (pgpath->path.is_active)
 842                 goto out;
 843
 844         if (!pgpath->pg->ps.type) {
 845                 DMWARN("Reinstate path not supported by path selector %s",
 846                        pgpath->pg->ps.type->name);
 847                 r = -EINVAL;
 848                 goto out;
 849         }
 850
 851         r = pgpath->pg->ps.type->reinstate_path(&pgpath->pg->ps, &pgpath->path);
 852         if (r)
 853                 goto out;
 854
 855         pgpath->path.is_active = 1;
 856
 857         m->current_pgpath = NULL;
 858         if (!m->nr_valid_paths++ && m->queue_size)
 859                 queue_work(kmultipathd, &m->process_queued_ios);
 860
 861         queue_work(kmultipathd, &m->trigger_event);
 862
 863 out:
 864         spin_unlock_irqrestore(&m->lock, flags);
 865
 866         return r;
 867 }
 868
 869 /*
 870  * Fail or reinstate all paths that match the provided struct dm_dev.
 871  */
 872 static int action_dev(struct multipath *m, struct dm_dev *dev,
 873                       action_fn action)
 874 {
 875         int r = 0;
 876         struct pgpath *pgpath;
 877         struct priority_group *pg;
 878
 879         list_for_each_entry(pg, &m->priority_groups, list) {
 880                 list_for_each_entry(pgpath, &pg->pgpaths, list) {
 881                         if (pgpath->path.dev == dev)
 882                                 r = action(pgpath);
 883                 }
 884         }
 885
 886         return r;
 887 }
 888
 889 /*
 890  * Temporarily try to avoid having to use the specified PG
 891  */
 892 static void bypass_pg(struct multipath *m, struct priority_group *pg,
 893                       int bypassed)
 894 {
 895         unsigned long flags;
 896
 897         spin_lock_irqsave(&m->lock, flags);
 898
 899         pg->bypassed = bypassed;
 900         m->current_pgpath = NULL;
 901         m->current_pg = NULL;
 902
 903         spin_unlock_irqrestore(&m->lock, flags);
 904
 905         queue_work(kmultipathd, &m->trigger_event);
 906 }
 907
 908 /*
 909  * Switch to using the specified PG from the next I/O that gets mapped
 910  */
 911 static int switch_pg_num(struct multipath *m, const char *pgstr)
 912 {
 913         struct priority_group *pg;
 914         unsigned pgnum;
 915         unsigned long flags;
 916
 917         if (!pgstr || (sscanf(pgstr, "%u", &pgnum) != 1) || !pgnum ||
 918             (pgnum > m->nr_priority_groups)) {
 919                 DMWARN("invalid PG number supplied to switch_pg_num");
 920                 return -EINVAL;
 921         }
 922
 923         spin_lock_irqsave(&m->lock, flags);
 924         list_for_each_entry(pg, &m->priority_groups, list) {
 925                 pg->bypassed = 0;
 926                 if (--pgnum)
 927                         continue;
 928
 929                 m->current_pgpath = NULL;
 930                 m->current_pg = NULL;
 931                 m->next_pg = pg;
 932         }
 933         spin_unlock_irqrestore(&m->lock, flags);
 934
 935         queue_work(kmultipathd, &m->trigger_event);
 936         return 0;
 937 }
 938
 939 /*
 940  * Set/clear bypassed status of a PG.
 941  * PGs are numbered upwards from 1 in the order they were declared.
 942  */
 943 static int bypass_pg_num(struct multipath *m, const char *pgstr, int bypassed)
 944 {
 945         struct priority_group *pg;
 946         unsigned pgnum;
 947
 948         if (!pgstr || (sscanf(pgstr, "%u", &pgnum) != 1) || !pgnum ||
 949             (pgnum > m->nr_priority_groups)) {
 950                 DMWARN("invalid PG number supplied to bypass_pg");
 951                 return -EINVAL;
 952         }
 953
 954         list_for_each_entry(pg, &m->priority_groups, list) {
 955                 if (!--pgnum)
 956                         break;
 957         }
 958
 959         bypass_pg(m, pg, bypassed);
 960         return 0;
 961 }
 962
 963 /*
 964  * pg_init must call this when it has completed its initialisation
 965  */
 966 void dm_pg_init_complete(struct path *path, unsigned err_flags)
 967 {
 968         struct pgpath *pgpath = path_to_pgpath(path);
 969         struct priority_group *pg = pgpath->pg;
 970         struct multipath *m = pg->m;
 971         unsigned long flags;
 972
 973         /* We insist on failing the path if the PG is already bypassed. */
 974         if (err_flags && pg->bypassed)
 975                 err_flags |= MP_FAIL_PATH;
 976
 977         if (err_flags & MP_FAIL_PATH)
 978                 fail_path(pgpath);
 979
 980         if (err_flags & MP_BYPASS_PG)
 981                 bypass_pg(m, pg, 1);
 982
 983         spin_lock_irqsave(&m->lock, flags);
 984         if (err_flags) {
 985                 m->current_pgpath = NULL;
 986                 m->current_pg = NULL;
 987         } else if (!m->pg_init_required)
 988                 m->queue_io = 0;
 989
 990         m->pg_init_in_progress = 0;
 991         queue_work(kmultipathd, &m->process_queued_ios);
 992         spin_unlock_irqrestore(&m->lock, flags);
 993 }
 994
 995 /*
 996  * end_io handling
 997  */
 998 static int do_end_io(struct multipath *m, struct bio *bio,
 999                      int error, struct mpath_io *mpio)
1000 {
1001         struct hw_handler *hwh = &m->hw_handler;
1002         unsigned err_flags = MP_FAIL_PATH;      /* Default behavior */
1003         unsigned long flags;
1004
1005         if (!error)
1006                 return 0;       /* I/O complete */
1007
1008         if ((error == -EWOULDBLOCK) && bio_rw_ahead(bio))
1009                 return error;
1010
1011         if (error == -EOPNOTSUPP)
1012                 return error;
1013
1014         spin_lock_irqsave(&m->lock, flags);
1015         if (!m->nr_valid_paths) {
1016                 if (!m->queue_if_no_path) {
1017                         spin_unlock_irqrestore(&m->lock, flags);
1018                         return -EIO;
1019                 } else {
1020                         spin_unlock_irqrestore(&m->lock, flags);
1021                         goto requeue;
1022                 }
1023         }
1024         spin_unlock_irqrestore(&m->lock, flags);
1025
1026         if (hwh->type && hwh->type->error)
1027                 err_flags = hwh->type->error(hwh, bio);
1028
1029         if (mpio->pgpath) {
1030                 if (err_flags & MP_FAIL_PATH)
1031                         fail_path(mpio->pgpath);
1032
1033                 if (err_flags & MP_BYPASS_PG)
1034                         bypass_pg(m, mpio->pgpath->pg, 1);
1035         }
1036
1037         if (err_flags & MP_ERROR_IO)
1038                 return -EIO;
1039
1040       requeue:
1041         dm_bio_restore(&mpio->details, bio);
1042
1043         /* queue for the daemon to resubmit or fail */
1044         spin_lock_irqsave(&m->lock, flags);
1045         bio_list_add(&m->queued_ios, bio);
1046         m->queue_size++;
1047         if (!m->queue_io)
1048                 queue_work(kmultipathd, &m->process_queued_ios);
1049         spin_unlock_irqrestore(&m->lock, flags);
1050
1051         return 1;       /* io not complete */
1052 }
1053
1054 static int multipath_end_io(struct dm_target *ti, struct bio *bio,
1055                             int error, union map_info *map_context)
1056 {
1057         struct multipath *m = (struct multipath *) ti->private;
1058         struct mpath_io *mpio = (struct mpath_io *) map_context->ptr;
1059         struct pgpath *pgpath = mpio->pgpath;
1060         struct path_selector *ps;
1061         int r;
1062
1063         r  = do_end_io(m, bio, error, mpio);
1064         if (pgpath) {
1065                 ps = &pgpath->pg->ps;
1066                 if (ps->type->end_io)
1067                         ps->type->end_io(ps, &pgpath->path);
1068         }
1069         if (r <= 0)
1070                 mempool_free(mpio, m->mpio_pool);
1071
1072         return r;
1073 }
1074
1075 /*
1076  * Suspend can't complete until all the I/O is processed so if
1077  * the last path fails we must error any remaining I/O.
1078  * Note that if the freeze_bdev fails while suspending, the
1079  * queue_if_no_path state is lost - userspace should reset it.
1080  */
1081 static void multipath_presuspend(struct dm_target *ti)
1082 {
1083         struct multipath *m = (struct multipath *) ti->private;
1084
1085         queue_if_no_path(m, 0, 1);
1086 }
1087
1088 /*
1089  * Restore the queue_if_no_path setting.
1090  */
1091 static void multipath_resume(struct dm_target *ti)
1092 {
1093         struct multipath *m = (struct multipath *) ti->private;
1094         unsigned long flags;
1095
1096         spin_lock_irqsave(&m->lock, flags);
1097         m->queue_if_no_path = m->saved_queue_if_no_path;
1098         spin_unlock_irqrestore(&m->lock, flags);
1099 }
1100
1101 /*
1102  * Info output has the following format:
1103  * num_multipath_feature_args [multipath_feature_args]*
1104  * num_handler_status_args [handler_status_args]*
1105  * num_groups init_group_number
1106  *            [A|D|E num_ps_status_args [ps_status_args]*
1107  *             num_paths num_selector_args
1108  *             [path_dev A|F fail_count [selector_args]* ]+ ]+
1109  *
1110  * Table output has the following format (identical to the constructor string):
1111  * num_feature_args [features_args]*
1112  * num_handler_args hw_handler [hw_handler_args]*
1113  * num_groups init_group_number
1114  *     [priority selector-name num_ps_args [ps_args]*
1115  *      num_paths num_selector_args [path_dev [selector_args]* ]+ ]+
1116  */
1117 static int multipath_status(struct dm_target *ti, status_type_t type,
1118                             char *result, unsigned int maxlen)
1119 {
1120         int sz = 0;
1121         unsigned long flags;
1122         struct multipath *m = (struct multipath *) ti->private;
1123         struct hw_handler *hwh = &m->hw_handler;
1124         struct priority_group *pg;
1125         struct pgpath *p;
1126         unsigned pg_num;
1127         char state;
1128
1129         spin_lock_irqsave(&m->lock, flags);
1130
1131         /* Features */
1132         if (type == STATUSTYPE_INFO)
1133                 DMEMIT("1 %u ", m->queue_size);
1134         else if (m->queue_if_no_path)
1135                 DMEMIT("1 queue_if_no_path ");
1136         else
1137                 DMEMIT("0 ");
1138
1139         if (hwh->type && hwh->type->status)
1140                 sz += hwh->type->status(hwh, type, result + sz, maxlen - sz);
1141         else if (!hwh->type || type == STATUSTYPE_INFO)
1142                 DMEMIT("0 ");
1143         else
1144                 DMEMIT("1 %s ", hwh->type->name);
1145
1146         DMEMIT("%u ", m->nr_priority_groups);
1147
1148         if (m->next_pg)
1149                 pg_num = m->next_pg->pg_num;
1150         else if (m->current_pg)
1151                 pg_num = m->current_pg->pg_num;
1152         else
1153                         pg_num = 1;
1154
1155         DMEMIT("%u ", pg_num);
1156
1157         switch (type) {
1158         case STATUSTYPE_INFO:
1159                 list_for_each_entry(pg, &m->priority_groups, list) {
1160                         if (pg->bypassed)
1161                                 state = 'D';    /* Disabled */
1162                         else if (pg == m->current_pg)
1163                                 state = 'A';    /* Currently Active */
1164                         else
1165                                 state = 'E';    /* Enabled */
1166
1167                         DMEMIT("%c ", state);
1168
1169                         if (pg->ps.type->status)
1170                                 sz += pg->ps.type->status(&pg->ps, NULL, type,
1171                                                           result + sz,
1172                                                           maxlen - sz);
1173                         else
1174                                 DMEMIT("0 ");
1175
1176                         DMEMIT("%u %u ", pg->nr_pgpaths,
1177                                pg->ps.type->info_args);
1178
1179                         list_for_each_entry(p, &pg->pgpaths, list) {
1180                                 DMEMIT("%s %s %u ", p->path.dev->name,
1181                                        p->path.is_active ? "A" : "F",
1182                                        p->fail_count);
1183                                 if (pg->ps.type->status)
1184                                         sz += pg->ps.type->status(&pg->ps,
1185                                               &p->path, type, result + sz,
1186                                               maxlen - sz);
1187                         }
1188                 }
1189                 break;
1190
1191         case STATUSTYPE_TABLE:
1192                 list_for_each_entry(pg, &m->priority_groups, list) {
1193                         DMEMIT("%s ", pg->ps.type->name);
1194
1195                         if (pg->ps.type->status)
1196                                 sz += pg->ps.type->status(&pg->ps, NULL, type,
1197                                                           result + sz,
1198                                                           maxlen - sz);
1199                         else
1200                                 DMEMIT("0 ");
1201
1202                         DMEMIT("%u %u ", pg->nr_pgpaths,
1203                                pg->ps.type->table_args);
1204
1205                         list_for_each_entry(p, &pg->pgpaths, list) {
1206                                 DMEMIT("%s ", p->path.dev->name);
1207                                 if (pg->ps.type->status)
1208                                         sz += pg->ps.type->status(&pg->ps,
1209                                               &p->path, type, result + sz,
1210                                               maxlen - sz);
1211                         }
1212                 }
1213                 break;
1214         }
1215
1216         spin_unlock_irqrestore(&m->lock, flags);
1217
1218         return 0;
1219 }
1220
1221 static int multipath_message(struct dm_target *ti, unsigned argc, char **argv)
1222 {
1223         int r;
1224         struct dm_dev *dev;
1225         struct multipath *m = (struct multipath *) ti->private;
1226         action_fn action;
1227
1228         if (argc == 1) {
1229                 if (!strnicmp(argv[0], MESG_STR("queue_if_no_path")))
1230                         return queue_if_no_path(m, 1, 0);
1231                 else if (!strnicmp(argv[0], MESG_STR("fail_if_no_path")))
1232                         return queue_if_no_path(m, 0, 0);
1233         }
1234
1235         if (argc != 2)
1236                 goto error;
1237
1238         if (!strnicmp(argv[0], MESG_STR("disable_group")))
1239                 return bypass_pg_num(m, argv[1], 1);
1240         else if (!strnicmp(argv[0], MESG_STR("enable_group")))
1241                 return bypass_pg_num(m, argv[1], 0);
1242         else if (!strnicmp(argv[0], MESG_STR("switch_group")))
1243                 return switch_pg_num(m, argv[1]);
1244         else if (!strnicmp(argv[0], MESG_STR("reinstate_path")))
1245                 action = reinstate_path;
1246         else if (!strnicmp(argv[0], MESG_STR("fail_path")))
1247                 action = fail_path;
1248         else
1249                 goto error;
1250
1251         r = dm_get_device(ti, argv[1], ti->begin, ti->len,
1252                           dm_table_get_mode(ti->table), &dev);
1253         if (r) {
1254                 DMWARN("dm-multipath message: error getting device %s",
1255                        argv[1]);
1256                 return -EINVAL;
1257         }
1258
1259         r = action_dev(m, dev, action);
1260
1261         dm_put_device(ti, dev);
1262
1263         return r;
1264
1265 error:
1266         DMWARN("Unrecognised multipath message received.");
1267         return -EINVAL;
1268 }
1269
1270 /*-----------------------------------------------------------------
1271  * Module setup
1272  *---------------------------------------------------------------*/
1273 static struct target_type multipath_target = {
1274         .name = "multipath",
1275         .version = {1, 0, 4},
1276         .module = THIS_MODULE,
1277         .ctr = multipath_ctr,
1278         .dtr = multipath_dtr,
1279         .map = multipath_map,
1280         .end_io = multipath_end_io,
1281         .presuspend = multipath_presuspend,
1282         .resume = multipath_resume,
1283         .status = multipath_status,
1284         .message = multipath_message,
1285 };
1286
1287 static int __init dm_multipath_init(void)
1288 {
1289         int r;
1290
1291         /* allocate a slab for the dm_ios */
1292         _mpio_cache = kmem_cache_create("dm_mpath", sizeof(struct mpath_io),
1293                                         0, 0, NULL, NULL);
1294         if (!_mpio_cache)
1295                 return -ENOMEM;
1296
1297         r = dm_register_target(&multipath_target);
1298         if (r < 0) {
1299                 DMERR("%s: register failed %d", multipath_target.name, r);
1300                 kmem_cache_destroy(_mpio_cache);
1301                 return -EINVAL;
1302         }
1303
1304         kmultipathd = create_workqueue("kmpathd");
1305         if (!kmultipathd) {
1306                 DMERR("%s: failed to create workqueue kmpathd",
1307                                 multipath_target.name);
1308                 dm_unregister_target(&multipath_target);
1309                 kmem_cache_destroy(_mpio_cache);
1310                 return -ENOMEM;
1311         }
1312
1313         DMINFO("dm-multipath version %u.%u.%u loaded",
1314                multipath_target.version[0], multipath_target.version[1],
1315                multipath_target.version[2]);
1316
1317         return r;
1318 }
1319
1320 static void __exit dm_multipath_exit(void)
1321 {
1322         int r;
1323
1324         destroy_workqueue(kmultipathd);
1325
1326         r = dm_unregister_target(&multipath_target);
1327         if (r < 0)
1328                 DMERR("%s: target unregister failed %d",
1329                       multipath_target.name, r);
1330         kmem_cache_destroy(_mpio_cache);
1331 }
1332
1333 EXPORT_SYMBOL_GPL(dm_pg_init_complete);
1334
1335 module_init(dm_multipath_init);
1336 module_exit(dm_multipath_exit);
1337
1338 MODULE_DESCRIPTION(DM_NAME " multipath target");
1339 MODULE_AUTHOR("Sistina Software <dm-devel@redhat.com>");
1340 MODULE_LICENSE("GPL");