drivers/md/dm-raid1.c

   1 /*
   2  * Copyright (C) 2003 Sistina Software Limited.
   3  * Copyright (C) 2005-2008 Red Hat, Inc. All rights reserved.
   4  *
   5  * This file is released under the GPL.
   6  */
   7
   8 #include "dm-bio-list.h"
   9 #include "dm-bio-record.h"
  10
  11 #include <linux/init.h>
  12 #include <linux/mempool.h>
  13 #include <linux/module.h>
  14 #include <linux/pagemap.h>
  15 #include <linux/slab.h>
  16 #include <linux/workqueue.h>
  17 #include <linux/device-mapper.h>
  18 #include <linux/dm-io.h>
  19 #include <linux/dm-dirty-log.h>
  20 #include <linux/dm-kcopyd.h>
  21 #include <linux/dm-region-hash.h>
  22
  23 #define DM_MSG_PREFIX "raid1"
  24
  25 #define MAX_RECOVERY 1  /* Maximum number of regions recovered in parallel. */
  26 #define DM_IO_PAGES 64
  27 #define DM_KCOPYD_PAGES 64
  28
  29 #define DM_RAID1_HANDLE_ERRORS 0x01
  30 #define errors_handled(p)       ((p)->features & DM_RAID1_HANDLE_ERRORS)
  31
  32 static DECLARE_WAIT_QUEUE_HEAD(_kmirrord_recovery_stopped);
  33
  34 /*-----------------------------------------------------------------
  35  * Mirror set structures.
  36  *---------------------------------------------------------------*/
  37 enum dm_raid1_error {
  38         DM_RAID1_WRITE_ERROR,
  39         DM_RAID1_SYNC_ERROR,
  40         DM_RAID1_READ_ERROR
  41 };
  42
  43 struct mirror {
  44         struct mirror_set *ms;
  45         atomic_t error_count;
  46         unsigned long error_type;
  47         struct dm_dev *dev;
  48         sector_t offset;
  49 };
  50
  51 struct mirror_set {
  52         struct dm_target *ti;
  53         struct list_head list;
  54
  55         uint64_t features;
  56
  57         spinlock_t lock;        /* protects the lists */
  58         struct bio_list reads;
  59         struct bio_list writes;
  60         struct bio_list failures;
  61
  62         struct dm_region_hash *rh;
  63         struct dm_kcopyd_client *kcopyd_client;
  64         struct dm_io_client *io_client;
  65         mempool_t *read_record_pool;
  66
  67         /* recovery */
  68         region_t nr_regions;
  69         int in_sync;
  70         int log_failure;
  71         atomic_t suspend;
  72
  73         atomic_t default_mirror;        /* Default mirror */
  74
  75         struct workqueue_struct *kmirrord_wq;
  76         struct work_struct kmirrord_work;
  77         struct timer_list timer;
  78         unsigned long timer_pending;
  79
  80         struct work_struct trigger_event;
  81
  82         unsigned nr_mirrors;
  83         struct mirror mirror[0];
  84 };
  85
  86 static void wakeup_mirrord(void *context)
  87 {
  88         struct mirror_set *ms = context;
  89
  90         queue_work(ms->kmirrord_wq, &ms->kmirrord_work);
  91 }
  92
  93 static void delayed_wake_fn(unsigned long data)
  94 {
  95         struct mirror_set *ms = (struct mirror_set *) data;
  96
  97         clear_bit(0, &ms->timer_pending);
  98         wakeup_mirrord(ms);
  99 }
 100
 101 static void delayed_wake(struct mirror_set *ms)
 102 {
 103         if (test_and_set_bit(0, &ms->timer_pending))
 104                 return;
 105
 106         ms->timer.expires = jiffies + HZ / 5;
 107         ms->timer.data = (unsigned long) ms;
 108         ms->timer.function = delayed_wake_fn;
 109         add_timer(&ms->timer);
 110 }
 111
 112 static void wakeup_all_recovery_waiters(void *context)
 113 {
 114         wake_up_all(&_kmirrord_recovery_stopped);
 115 }
 116
 117 static void queue_bio(struct mirror_set *ms, struct bio *bio, int rw)
 118 {
 119         unsigned long flags;
 120         int should_wake = 0;
 121         struct bio_list *bl;
 122
 123         bl = (rw == WRITE) ? &ms->writes : &ms->reads;
 124         spin_lock_irqsave(&ms->lock, flags);
 125         should_wake = !(bl->head);
 126         bio_list_add(bl, bio);
 127         spin_unlock_irqrestore(&ms->lock, flags);
 128
 129         if (should_wake)
 130                 wakeup_mirrord(ms);
 131 }
 132
 133 static void dispatch_bios(void *context, struct bio_list *bio_list)
 134 {
 135         struct mirror_set *ms = context;
 136         struct bio *bio;
 137
 138         while ((bio = bio_list_pop(bio_list)))
 139                 queue_bio(ms, bio, WRITE);
 140 }
 141
 142 #define MIN_READ_RECORDS 20
 143 struct dm_raid1_read_record {
 144         struct mirror *m;
 145         struct dm_bio_details details;
 146 };
 147
 148 static struct kmem_cache *_dm_raid1_read_record_cache;
 149
 150 /*
 151  * Every mirror should look like this one.
 152  */
 153 #define DEFAULT_MIRROR 0
 154
 155 /*
 156  * This is yucky.  We squirrel the mirror struct away inside
 157  * bi_next for read/write buffers.  This is safe since the bh
 158  * doesn't get submitted to the lower levels of block layer.
 159  */
 160 static struct mirror *bio_get_m(struct bio *bio)
 161 {
 162         return (struct mirror *) bio->bi_next;
 163 }
 164
 165 static void bio_set_m(struct bio *bio, struct mirror *m)
 166 {
 167         bio->bi_next = (struct bio *) m;
 168 }
 169
 170 static struct mirror *get_default_mirror(struct mirror_set *ms)
 171 {
 172         return &ms->mirror[atomic_read(&ms->default_mirror)];
 173 }
 174
 175 static void set_default_mirror(struct mirror *m)
 176 {
 177         struct mirror_set *ms = m->ms;
 178         struct mirror *m0 = &(ms->mirror[0]);
 179
 180         atomic_set(&ms->default_mirror, m - m0);
 181 }
 182
 183 /* fail_mirror
 184  * @m: mirror device to fail
 185  * @error_type: one of the enum's, DM_RAID1_*_ERROR
 186  *
 187  * If errors are being handled, record the type of
 188  * error encountered for this device.  If this type
 189  * of error has already been recorded, we can return;
 190  * otherwise, we must signal userspace by triggering
 191  * an event.  Additionally, if the device is the
 192  * primary device, we must choose a new primary, but
 193  * only if the mirror is in-sync.
 194  *
 195  * This function must not block.
 196  */
 197 static void fail_mirror(struct mirror *m, enum dm_raid1_error error_type)
 198 {
 199         struct mirror_set *ms = m->ms;
 200         struct mirror *new;
 201
 202         /*
 203          * error_count is used for nothing more than a
 204          * simple way to tell if a device has encountered
 205          * errors.
 206          */
 207         atomic_inc(&m->error_count);
 208
 209         if (test_and_set_bit(error_type, &m->error_type))
 210                 return;
 211
 212         if (!errors_handled(ms))
 213                 return;
 214
 215         if (m != get_default_mirror(ms))
 216                 goto out;
 217
 218         if (!ms->in_sync) {
 219                 /*
 220                  * Better to issue requests to same failing device
 221                  * than to risk returning corrupt data.
 222                  */
 223                 DMERR("Primary mirror (%s) failed while out-of-sync: "
 224                       "Reads may fail.", m->dev->name);
 225                 goto out;
 226         }
 227
 228         for (new = ms->mirror; new < ms->mirror + ms->nr_mirrors; new++)
 229                 if (!atomic_read(&new->error_count)) {
 230                         set_default_mirror(new);
 231                         break;
 232                 }
 233
 234         if (unlikely(new == ms->mirror + ms->nr_mirrors))
 235                 DMWARN("All sides of mirror have failed.");
 236
 237 out:
 238         schedule_work(&ms->trigger_event);
 239 }
 240
 241 /*-----------------------------------------------------------------
 242  * Recovery.
 243  *
 244  * When a mirror is first activated we may find that some regions
 245  * are in the no-sync state.  We have to recover these by
 246  * recopying from the default mirror to all the others.
 247  *---------------------------------------------------------------*/
 248 static void recovery_complete(int read_err, unsigned long write_err,
 249                               void *context)
 250 {
 251         struct dm_region *reg = context;
 252         struct mirror_set *ms = dm_rh_region_context(reg);
 253         int m, bit = 0;
 254
 255         if (read_err) {
 256                 /* Read error means the failure of default mirror. */
 257                 DMERR_LIMIT("Unable to read primary mirror during recovery");
 258                 fail_mirror(get_default_mirror(ms), DM_RAID1_SYNC_ERROR);
 259         }
 260
 261         if (write_err) {
 262                 DMERR_LIMIT("Write error during recovery (error = 0x%lx)",
 263                             write_err);
 264                 /*
 265                  * Bits correspond to devices (excluding default mirror).
 266                  * The default mirror cannot change during recovery.
 267                  */
 268                 for (m = 0; m < ms->nr_mirrors; m++) {
 269                         if (&ms->mirror[m] == get_default_mirror(ms))
 270                                 continue;
 271                         if (test_bit(bit, &write_err))
 272                                 fail_mirror(ms->mirror + m,
 273                                             DM_RAID1_SYNC_ERROR);
 274                         bit++;
 275                 }
 276         }
 277
 278         dm_rh_recovery_end(reg, !(read_err || write_err));
 279 }
 280
 281 static int recover(struct mirror_set *ms, struct dm_region *reg)
 282 {
 283         int r;
 284         unsigned i;
 285         struct dm_io_region from, to[DM_KCOPYD_MAX_REGIONS], *dest;
 286         struct mirror *m;
 287         unsigned long flags = 0;
 288         region_t key = dm_rh_get_region_key(reg);
 289         sector_t region_size = dm_rh_get_region_size(ms->rh);
 290
 291         /* fill in the source */
 292         m = get_default_mirror(ms);
 293         from.bdev = m->dev->bdev;
 294         from.sector = m->offset + dm_rh_region_to_sector(ms->rh, key);
 295         if (key == (ms->nr_regions - 1)) {
 296                 /*
 297                  * The final region may be smaller than
 298                  * region_size.
 299                  */
 300                 from.count = ms->ti->len & (region_size - 1);
 301                 if (!from.count)
 302                         from.count = region_size;
 303         } else
 304                 from.count = region_size;
 305
 306         /* fill in the destinations */
 307         for (i = 0, dest = to; i < ms->nr_mirrors; i++) {
 308                 if (&ms->mirror[i] == get_default_mirror(ms))
 309                         continue;
 310
 311                 m = ms->mirror + i;
 312                 dest->bdev = m->dev->bdev;
 313                 dest->sector = m->offset + dm_rh_region_to_sector(ms->rh, key);
 314                 dest->count = from.count;
 315                 dest++;
 316         }
 317
 318         /* hand to kcopyd */
 319         if (!errors_handled(ms))
 320                 set_bit(DM_KCOPYD_IGNORE_ERROR, &flags);
 321
 322         r = dm_kcopyd_copy(ms->kcopyd_client, &from, ms->nr_mirrors - 1, to,
 323                            flags, recovery_complete, reg);
 324
 325         return r;
 326 }
 327
 328 static void do_recovery(struct mirror_set *ms)
 329 {
 330         struct dm_region *reg;
 331         struct dm_dirty_log *log = dm_rh_dirty_log(ms->rh);
 332         int r;
 333
 334         /*
 335          * Start quiescing some regions.
 336          */
 337         dm_rh_recovery_prepare(ms->rh);
 338
 339         /*
 340          * Copy any already quiesced regions.
 341          */
 342         while ((reg = dm_rh_recovery_start(ms->rh))) {
 343                 r = recover(ms, reg);
 344                 if (r)
 345                         dm_rh_recovery_end(reg, 0);
 346         }
 347
 348         /*
 349          * Update the in sync flag.
 350          */
 351         if (!ms->in_sync &&
 352             (log->type->get_sync_count(log) == ms->nr_regions)) {
 353                 /* the sync is complete */
 354                 dm_table_event(ms->ti->table);
 355                 ms->in_sync = 1;
 356         }
 357 }
 358
 359 /*-----------------------------------------------------------------
 360  * Reads
 361  *---------------------------------------------------------------*/
 362 static struct mirror *choose_mirror(struct mirror_set *ms, sector_t sector)
 363 {
 364         struct mirror *m = get_default_mirror(ms);
 365
 366         do {
 367                 if (likely(!atomic_read(&m->error_count)))
 368                         return m;
 369
 370                 if (m-- == ms->mirror)
 371                         m += ms->nr_mirrors;
 372         } while (m != get_default_mirror(ms));
 373
 374         return NULL;
 375 }
 376
 377 static int default_ok(struct mirror *m)
 378 {
 379         struct mirror *default_mirror = get_default_mirror(m->ms);
 380
 381         return !atomic_read(&default_mirror->error_count);
 382 }
 383
 384 static int mirror_available(struct mirror_set *ms, struct bio *bio)
 385 {
 386         struct dm_dirty_log *log = dm_rh_dirty_log(ms->rh);
 387         region_t region = dm_rh_bio_to_region(ms->rh, bio);
 388
 389         if (log->type->in_sync(log, region, 0))
 390                 return choose_mirror(ms,  bio->bi_sector) ? 1 : 0;
 391
 392         return 0;
 393 }
 394
 395 /*
 396  * remap a buffer to a particular mirror.
 397  */
 398 static sector_t map_sector(struct mirror *m, struct bio *bio)
 399 {
 400         return m->offset + (bio->bi_sector - m->ms->ti->begin);
 401 }
 402
 403 static void map_bio(struct mirror *m, struct bio *bio)
 404 {
 405         bio->bi_bdev = m->dev->bdev;
 406         bio->bi_sector = map_sector(m, bio);
 407 }
 408
 409 static void map_region(struct dm_io_region *io, struct mirror *m,
 410                        struct bio *bio)
 411 {
 412         io->bdev = m->dev->bdev;
 413         io->sector = map_sector(m, bio);
 414         io->count = bio->bi_size >> 9;
 415 }
 416
 417 /*-----------------------------------------------------------------
 418  * Reads
 419  *---------------------------------------------------------------*/
 420 static void read_callback(unsigned long error, void *context)
 421 {
 422         struct bio *bio = context;
 423         struct mirror *m;
 424
 425         m = bio_get_m(bio);
 426         bio_set_m(bio, NULL);
 427
 428         if (likely(!error)) {
 429                 bio_endio(bio, 0);
 430                 return;
 431         }
 432
 433         fail_mirror(m, DM_RAID1_READ_ERROR);
 434
 435         if (likely(default_ok(m)) || mirror_available(m->ms, bio)) {
 436                 DMWARN_LIMIT("Read failure on mirror device %s.  "
 437                              "Trying alternative device.",
 438                              m->dev->name);
 439                 queue_bio(m->ms, bio, bio_rw(bio));
 440                 return;
 441         }
 442
 443         DMERR_LIMIT("Read failure on mirror device %s.  Failing I/O.",
 444                     m->dev->name);
 445         bio_endio(bio, -EIO);
 446 }
 447
 448 /* Asynchronous read. */
 449 static void read_async_bio(struct mirror *m, struct bio *bio)
 450 {
 451         struct dm_io_region io;
 452         struct dm_io_request io_req = {
 453                 .bi_rw = READ,
 454                 .mem.type = DM_IO_BVEC,
 455                 .mem.ptr.bvec = bio->bi_io_vec + bio->bi_idx,
 456                 .notify.fn = read_callback,
 457                 .notify.context = bio,
 458                 .client = m->ms->io_client,
 459         };
 460
 461         map_region(&io, m, bio);
 462         bio_set_m(bio, m);
 463         BUG_ON(dm_io(&io_req, 1, &io, NULL));
 464 }
 465
 466 static inline int region_in_sync(struct mirror_set *ms, region_t region,
 467                                  int may_block)
 468 {
 469         int state = dm_rh_get_state(ms->rh, region, may_block);
 470         return state == DM_RH_CLEAN || state == DM_RH_DIRTY;
 471 }
 472
 473 static void do_reads(struct mirror_set *ms, struct bio_list *reads)
 474 {
 475         region_t region;
 476         struct bio *bio;
 477         struct mirror *m;
 478
 479         while ((bio = bio_list_pop(reads))) {
 480                 region = dm_rh_bio_to_region(ms->rh, bio);
 481                 m = get_default_mirror(ms);
 482
 483                 /*
 484                  * We can only read balance if the region is in sync.
 485                  */
 486                 if (likely(region_in_sync(ms, region, 1)))
 487                         m = choose_mirror(ms, bio->bi_sector);
 488                 else if (m && atomic_read(&m->error_count))
 489                         m = NULL;
 490
 491                 if (likely(m))
 492                         read_async_bio(m, bio);
 493                 else
 494                         bio_endio(bio, -EIO);
 495         }
 496 }
 497
 498 /*-----------------------------------------------------------------
 499  * Writes.
 500  *
 501  * We do different things with the write io depending on the
 502  * state of the region that it's in:
 503  *
 504  * SYNC:        increment pending, use kcopyd to write to *all* mirrors
 505  * RECOVERING:  delay the io until recovery completes
 506  * NOSYNC:      increment pending, just write to the default mirror
 507  *---------------------------------------------------------------*/
 508
 509
 510 static void write_callback(unsigned long error, void *context)
 511 {
 512         unsigned i, ret = 0;
 513         struct bio *bio = (struct bio *) context;
 514         struct mirror_set *ms;
 515         int uptodate = 0;
 516         int should_wake = 0;
 517         unsigned long flags;
 518
 519         ms = bio_get_m(bio)->ms;
 520         bio_set_m(bio, NULL);
 521
 522         /*
 523          * NOTE: We don't decrement the pending count here,
 524          * instead it is done by the targets endio function.
 525          * This way we handle both writes to SYNC and NOSYNC
 526          * regions with the same code.
 527          */
 528         if (likely(!error))
 529                 goto out;
 530
 531         for (i = 0; i < ms->nr_mirrors; i++)
 532                 if (test_bit(i, &error))
 533                         fail_mirror(ms->mirror + i, DM_RAID1_WRITE_ERROR);
 534                 else
 535                         uptodate = 1;
 536
 537         if (unlikely(!uptodate)) {
 538                 DMERR("All replicated volumes dead, failing I/O");
 539                 /* None of the writes succeeded, fail the I/O. */
 540                 ret = -EIO;
 541         } else if (errors_handled(ms)) {
 542                 /*
 543                  * Need to raise event.  Since raising
 544                  * events can block, we need to do it in
 545                  * the main thread.
 546                  */
 547                 spin_lock_irqsave(&ms->lock, flags);
 548                 if (!ms->failures.head)
 549                         should_wake = 1;
 550                 bio_list_add(&ms->failures, bio);
 551                 spin_unlock_irqrestore(&ms->lock, flags);
 552                 if (should_wake)
 553                         wakeup_mirrord(ms);
 554                 return;
 555         }
 556 out:
 557         bio_endio(bio, ret);
 558 }
 559
 560 static void do_write(struct mirror_set *ms, struct bio *bio)
 561 {
 562         unsigned int i;
 563         struct dm_io_region io[ms->nr_mirrors], *dest = io;
 564         struct mirror *m;
 565         struct dm_io_request io_req = {
 566                 .bi_rw = WRITE,
 567                 .mem.type = DM_IO_BVEC,
 568                 .mem.ptr.bvec = bio->bi_io_vec + bio->bi_idx,
 569                 .notify.fn = write_callback,
 570                 .notify.context = bio,
 571                 .client = ms->io_client,
 572         };
 573
 574         for (i = 0, m = ms->mirror; i < ms->nr_mirrors; i++, m++)
 575                 map_region(dest++, m, bio);
 576
 577         /*
 578          * Use default mirror because we only need it to retrieve the reference
 579          * to the mirror set in write_callback().
 580          */
 581         bio_set_m(bio, get_default_mirror(ms));
 582
 583         BUG_ON(dm_io(&io_req, ms->nr_mirrors, io, NULL));
 584 }
 585
 586 static void do_writes(struct mirror_set *ms, struct bio_list *writes)
 587 {
 588         int state;
 589         struct bio *bio;
 590         struct bio_list sync, nosync, recover, *this_list = NULL;
 591
 592         if (!writes->head)
 593                 return;
 594
 595         /*
 596          * Classify each write.
 597          */
 598         bio_list_init(&sync);
 599         bio_list_init(&nosync);
 600         bio_list_init(&recover);
 601
 602         while ((bio = bio_list_pop(writes))) {
 603                 state = dm_rh_get_state(ms->rh,
 604                                         dm_rh_bio_to_region(ms->rh, bio), 1);
 605                 switch (state) {
 606                 case DM_RH_CLEAN:
 607                 case DM_RH_DIRTY:
 608                         this_list = &sync;
 609                         break;
 610
 611                 case DM_RH_NOSYNC:
 612                         this_list = &nosync;
 613                         break;
 614
 615                 case DM_RH_RECOVERING:
 616                         this_list = &recover;
 617                         break;
 618                 }
 619
 620                 bio_list_add(this_list, bio);
 621         }
 622
 623         /*
 624          * Increment the pending counts for any regions that will
 625          * be written to (writes to recover regions are going to
 626          * be delayed).
 627          */
 628         dm_rh_inc_pending(ms->rh, &sync);
 629         dm_rh_inc_pending(ms->rh, &nosync);
 630         ms->log_failure = dm_rh_flush(ms->rh) ? 1 : 0;
 631
 632         /*
 633          * Dispatch io.
 634          */
 635         if (unlikely(ms->log_failure)) {
 636                 spin_lock_irq(&ms->lock);
 637                 bio_list_merge(&ms->failures, &sync);
 638                 spin_unlock_irq(&ms->lock);
 639                 wakeup_mirrord(ms);
 640         } else
 641                 while ((bio = bio_list_pop(&sync)))
 642                         do_write(ms, bio);
 643
 644         while ((bio = bio_list_pop(&recover)))
 645                 dm_rh_delay(ms->rh, bio);
 646
 647         while ((bio = bio_list_pop(&nosync))) {
 648                 map_bio(get_default_mirror(ms), bio);
 649                 generic_make_request(bio);
 650         }
 651 }
 652
 653 static void do_failures(struct mirror_set *ms, struct bio_list *failures)
 654 {
 655         struct bio *bio;
 656
 657         if (!failures->head)
 658                 return;
 659
 660         if (!ms->log_failure) {
 661                 while ((bio = bio_list_pop(failures))) {
 662                         ms->in_sync = 0;
 663                         dm_rh_mark_nosync(ms->rh, bio, bio->bi_size, 0);
 664                 }
 665                 return;
 666         }
 667
 668         /*
 669          * If the log has failed, unattempted writes are being
 670          * put on the failures list.  We can't issue those writes
 671          * until a log has been marked, so we must store them.
 672          *
 673          * If a 'noflush' suspend is in progress, we can requeue
 674          * the I/O's to the core.  This give userspace a chance
 675          * to reconfigure the mirror, at which point the core
 676          * will reissue the writes.  If the 'noflush' flag is
 677          * not set, we have no choice but to return errors.
 678          *
 679          * Some writes on the failures list may have been
 680          * submitted before the log failure and represent a
 681          * failure to write to one of the devices.  It is ok
 682          * for us to treat them the same and requeue them
 683          * as well.
 684          */
 685         if (dm_noflush_suspending(ms->ti)) {
 686                 while ((bio = bio_list_pop(failures)))
 687                         bio_endio(bio, DM_ENDIO_REQUEUE);
 688                 return;
 689         }
 690
 691         if (atomic_read(&ms->suspend)) {
 692                 while ((bio = bio_list_pop(failures)))
 693                         bio_endio(bio, -EIO);
 694                 return;
 695         }
 696
 697         spin_lock_irq(&ms->lock);
 698         bio_list_merge(&ms->failures, failures);
 699         spin_unlock_irq(&ms->lock);
 700
 701         delayed_wake(ms);
 702 }
 703
 704 static void trigger_event(struct work_struct *work)
 705 {
 706         struct mirror_set *ms =
 707                 container_of(work, struct mirror_set, trigger_event);
 708
 709         dm_table_event(ms->ti->table);
 710 }
 711
 712 /*-----------------------------------------------------------------
 713  * kmirrord
 714  *---------------------------------------------------------------*/
 715 static void do_mirror(struct work_struct *work)
 716 {
 717         struct mirror_set *ms = container_of(work, struct mirror_set,
 718                                              kmirrord_work);
 719         struct bio_list reads, writes, failures;
 720         unsigned long flags;
 721
 722         spin_lock_irqsave(&ms->lock, flags);
 723         reads = ms->reads;
 724         writes = ms->writes;
 725         failures = ms->failures;
 726         bio_list_init(&ms->reads);
 727         bio_list_init(&ms->writes);
 728         bio_list_init(&ms->failures);
 729         spin_unlock_irqrestore(&ms->lock, flags);
 730
 731         dm_rh_update_states(ms->rh, errors_handled(ms));
 732         do_recovery(ms);
 733         do_reads(ms, &reads);
 734         do_writes(ms, &writes);
 735         do_failures(ms, &failures);
 736
 737         dm_table_unplug_all(ms->ti->table);
 738 }
 739
 740 /*-----------------------------------------------------------------
 741  * Target functions
 742  *---------------------------------------------------------------*/
 743 static struct mirror_set *alloc_context(unsigned int nr_mirrors,
 744                                         uint32_t region_size,
 745                                         struct dm_target *ti,
 746                                         struct dm_dirty_log *dl)
 747 {
 748         size_t len;
 749         struct mirror_set *ms = NULL;
 750
 751         len = sizeof(*ms) + (sizeof(ms->mirror[0]) * nr_mirrors);
 752
 753         ms = kzalloc(len, GFP_KERNEL);
 754         if (!ms) {
 755                 ti->error = "Cannot allocate mirror context";
 756                 return NULL;
 757         }
 758
 759         spin_lock_init(&ms->lock);
 760
 761         ms->ti = ti;
 762         ms->nr_mirrors = nr_mirrors;
 763         ms->nr_regions = dm_sector_div_up(ti->len, region_size);
 764         ms->in_sync = 0;
 765         ms->log_failure = 0;
 766         atomic_set(&ms->suspend, 0);
 767         atomic_set(&ms->default_mirror, DEFAULT_MIRROR);
 768
 769         ms->read_record_pool = mempool_create_slab_pool(MIN_READ_RECORDS,
 770                                                 _dm_raid1_read_record_cache);
 771
 772         if (!ms->read_record_pool) {
 773                 ti->error = "Error creating mirror read_record_pool";
 774                 kfree(ms);
 775                 return NULL;
 776         }
 777
 778         ms->io_client = dm_io_client_create(DM_IO_PAGES);
 779         if (IS_ERR(ms->io_client)) {
 780                 ti->error = "Error creating dm_io client";
 781                 mempool_destroy(ms->read_record_pool);
 782                 kfree(ms);
 783                 return NULL;
 784         }
 785
 786         ms->rh = dm_region_hash_create(ms, dispatch_bios, wakeup_mirrord,
 787                                        wakeup_all_recovery_waiters,
 788                                        ms->ti->begin, MAX_RECOVERY,
 789                                        dl, region_size, ms->nr_regions);
 790         if (IS_ERR(ms->rh)) {
 791                 ti->error = "Error creating dirty region hash";
 792                 dm_io_client_destroy(ms->io_client);
 793                 mempool_destroy(ms->read_record_pool);
 794                 kfree(ms);
 795                 return NULL;
 796         }
 797
 798         return ms;
 799 }
 800
 801 static void free_context(struct mirror_set *ms, struct dm_target *ti,
 802                          unsigned int m)
 803 {
 804         while (m--)
 805                 dm_put_device(ti, ms->mirror[m].dev);
 806
 807         dm_io_client_destroy(ms->io_client);
 808         dm_region_hash_destroy(ms->rh);
 809         mempool_destroy(ms->read_record_pool);
 810         kfree(ms);
 811 }
 812
 813 static int get_mirror(struct mirror_set *ms, struct dm_target *ti,
 814                       unsigned int mirror, char **argv)
 815 {
 816         unsigned long long offset;
 817
 818         if (sscanf(argv[1], "%llu", &offset) != 1) {
 819                 ti->error = "Invalid offset";
 820                 return -EINVAL;
 821         }
 822
 823         if (dm_get_device(ti, argv[0], offset, ti->len,
 824                           dm_table_get_mode(ti->table),
 825                           &ms->mirror[mirror].dev)) {
 826                 ti->error = "Device lookup failure";
 827                 return -ENXIO;
 828         }
 829
 830         ms->mirror[mirror].ms = ms;
 831         atomic_set(&(ms->mirror[mirror].error_count), 0);
 832         ms->mirror[mirror].error_type = 0;
 833         ms->mirror[mirror].offset = offset;
 834
 835         return 0;
 836 }
 837
 838 /*
 839  * Create dirty log: log_type #log_params <log_params>
 840  */
 841 static struct dm_dirty_log *create_dirty_log(struct dm_target *ti,
 842                                              unsigned argc, char **argv,
 843                                              unsigned *args_used)
 844 {
 845         unsigned param_count;
 846         struct dm_dirty_log *dl;
 847
 848         if (argc < 2) {
 849                 ti->error = "Insufficient mirror log arguments";
 850                 return NULL;
 851         }
 852
 853         if (sscanf(argv[1], "%u", &param_count) != 1) {
 854                 ti->error = "Invalid mirror log argument count";
 855                 return NULL;
 856         }
 857
 858         *args_used = 2 + param_count;
 859
 860         if (argc < *args_used) {
 861                 ti->error = "Insufficient mirror log arguments";
 862                 return NULL;
 863         }
 864
 865         dl = dm_dirty_log_create(argv[0], ti, param_count, argv + 2);
 866         if (!dl) {
 867                 ti->error = "Error creating mirror dirty log";
 868                 return NULL;
 869         }
 870
 871         return dl;
 872 }
 873
 874 static int parse_features(struct mirror_set *ms, unsigned argc, char **argv,
 875                           unsigned *args_used)
 876 {
 877         unsigned num_features;
 878         struct dm_target *ti = ms->ti;
 879
 880         *args_used = 0;
 881
 882         if (!argc)
 883                 return 0;
 884
 885         if (sscanf(argv[0], "%u", &num_features) != 1) {
 886                 ti->error = "Invalid number of features";
 887                 return -EINVAL;
 888         }
 889
 890         argc--;
 891         argv++;
 892         (*args_used)++;
 893
 894         if (num_features > argc) {
 895                 ti->error = "Not enough arguments to support feature count";
 896                 return -EINVAL;
 897         }
 898
 899         if (!strcmp("handle_errors", argv[0]))
 900                 ms->features |= DM_RAID1_HANDLE_ERRORS;
 901         else {
 902                 ti->error = "Unrecognised feature requested";
 903                 return -EINVAL;
 904         }
 905
 906         (*args_used)++;
 907
 908         return 0;
 909 }
 910
 911 /*
 912  * Construct a mirror mapping:
 913  *
 914  * log_type #log_params <log_params>
 915  * #mirrors [mirror_path offset]{2,}
 916  * [#features <features>]
 917  *
 918  * log_type is "core" or "disk"
 919  * #log_params is between 1 and 3
 920  *
 921  * If present, features must be "handle_errors".
 922  */
 923 static int mirror_ctr(struct dm_target *ti, unsigned int argc, char **argv)
 924 {
 925         int r;
 926         unsigned int nr_mirrors, m, args_used;
 927         struct mirror_set *ms;
 928         struct dm_dirty_log *dl;
 929
 930         dl = create_dirty_log(ti, argc, argv, &args_used);
 931         if (!dl)
 932                 return -EINVAL;
 933
 934         argv += args_used;
 935         argc -= args_used;
 936
 937         if (!argc || sscanf(argv[0], "%u", &nr_mirrors) != 1 ||
 938             nr_mirrors < 2 || nr_mirrors > DM_KCOPYD_MAX_REGIONS + 1) {
 939                 ti->error = "Invalid number of mirrors";
 940                 dm_dirty_log_destroy(dl);
 941                 return -EINVAL;
 942         }
 943
 944         argv++, argc--;
 945
 946         if (argc < nr_mirrors * 2) {
 947                 ti->error = "Too few mirror arguments";
 948                 dm_dirty_log_destroy(dl);
 949                 return -EINVAL;
 950         }
 951
 952         ms = alloc_context(nr_mirrors, dl->type->get_region_size(dl), ti, dl);
 953         if (!ms) {
 954                 dm_dirty_log_destroy(dl);
 955                 return -ENOMEM;
 956         }
 957
 958         /* Get the mirror parameter sets */
 959         for (m = 0; m < nr_mirrors; m++) {
 960                 r = get_mirror(ms, ti, m, argv);
 961                 if (r) {
 962                         free_context(ms, ti, m);
 963                         return r;
 964                 }
 965                 argv += 2;
 966                 argc -= 2;
 967         }
 968
 969         ti->private = ms;
 970         ti->split_io = dm_rh_get_region_size(ms->rh);
 971
 972         ms->kmirrord_wq = create_singlethread_workqueue("kmirrord");
 973         if (!ms->kmirrord_wq) {
 974                 DMERR("couldn't start kmirrord");
 975                 r = -ENOMEM;
 976                 goto err_free_context;
 977         }
 978         INIT_WORK(&ms->kmirrord_work, do_mirror);
 979         init_timer(&ms->timer);
 980         ms->timer_pending = 0;
 981         INIT_WORK(&ms->trigger_event, trigger_event);
 982
 983         r = parse_features(ms, argc, argv, &args_used);
 984         if (r)
 985                 goto err_destroy_wq;
 986
 987         argv += args_used;
 988         argc -= args_used;
 989
 990         /*
 991          * Any read-balancing addition depends on the
 992          * DM_RAID1_HANDLE_ERRORS flag being present.
 993          * This is because the decision to balance depends
 994          * on the sync state of a region.  If the above
 995          * flag is not present, we ignore errors; and
 996          * the sync state may be inaccurate.
 997          */
 998
 999         if (argc) {
1000                 ti->error = "Too many mirror arguments";
1001                 r = -EINVAL;
1002                 goto err_destroy_wq;
1003         }
1004
1005         r = dm_kcopyd_client_create(DM_KCOPYD_PAGES, &ms->kcopyd_client);
1006         if (r)
1007                 goto err_destroy_wq;
1008
1009         wakeup_mirrord(ms);
1010         return 0;
1011
1012 err_destroy_wq:
1013         destroy_workqueue(ms->kmirrord_wq);
1014 err_free_context:
1015         free_context(ms, ti, ms->nr_mirrors);
1016         return r;
1017 }
1018
1019 static void mirror_dtr(struct dm_target *ti)
1020 {
1021         struct mirror_set *ms = (struct mirror_set *) ti->private;
1022
1023         del_timer_sync(&ms->timer);
1024         flush_workqueue(ms->kmirrord_wq);
1025         flush_scheduled_work();
1026         dm_kcopyd_client_destroy(ms->kcopyd_client);
1027         destroy_workqueue(ms->kmirrord_wq);
1028         free_context(ms, ti, ms->nr_mirrors);
1029 }
1030
1031 /*
1032  * Mirror mapping function
1033  */
1034 static int mirror_map(struct dm_target *ti, struct bio *bio,
1035                       union map_info *map_context)
1036 {
1037         int r, rw = bio_rw(bio);
1038         struct mirror *m;
1039         struct mirror_set *ms = ti->private;
1040         struct dm_raid1_read_record *read_record = NULL;
1041         struct dm_dirty_log *log = dm_rh_dirty_log(ms->rh);
1042
1043         if (rw == WRITE) {
1044                 /* Save region for mirror_end_io() handler */
1045                 map_context->ll = dm_rh_bio_to_region(ms->rh, bio);
1046                 queue_bio(ms, bio, rw);
1047                 return DM_MAPIO_SUBMITTED;
1048         }
1049
1050         r = log->type->in_sync(log, dm_rh_bio_to_region(ms->rh, bio), 0);
1051         if (r < 0 && r != -EWOULDBLOCK)
1052                 return r;
1053
1054         /*
1055          * If region is not in-sync queue the bio.
1056          */
1057         if (!r || (r == -EWOULDBLOCK)) {
1058                 if (rw == READA)
1059                         return -EWOULDBLOCK;
1060
1061                 queue_bio(ms, bio, rw);
1062                 return DM_MAPIO_SUBMITTED;
1063         }
1064
1065         /*
1066          * The region is in-sync and we can perform reads directly.
1067          * Store enough information so we can retry if it fails.
1068          */
1069         m = choose_mirror(ms, bio->bi_sector);
1070         if (unlikely(!m))
1071                 return -EIO;
1072
1073         read_record = mempool_alloc(ms->read_record_pool, GFP_NOIO);
1074         if (likely(read_record)) {
1075                 dm_bio_record(&read_record->details, bio);
1076                 map_context->ptr = read_record;
1077                 read_record->m = m;
1078         }
1079
1080         map_bio(m, bio);
1081
1082         return DM_MAPIO_REMAPPED;
1083 }
1084
1085 static int mirror_end_io(struct dm_target *ti, struct bio *bio,
1086                          int error, union map_info *map_context)
1087 {
1088         int rw = bio_rw(bio);
1089         struct mirror_set *ms = (struct mirror_set *) ti->private;
1090         struct mirror *m = NULL;
1091         struct dm_bio_details *bd = NULL;
1092         struct dm_raid1_read_record *read_record = map_context->ptr;
1093
1094         /*
1095          * We need to dec pending if this was a write.
1096          */
1097         if (rw == WRITE) {
1098                 dm_rh_dec(ms->rh, map_context->ll);
1099                 return error;
1100         }
1101
1102         if (error == -EOPNOTSUPP)
1103                 goto out;
1104
1105         if ((error == -EWOULDBLOCK) && bio_rw_ahead(bio))
1106                 goto out;
1107
1108         if (unlikely(error)) {
1109                 if (!read_record) {
1110                         /*
1111                          * There wasn't enough memory to record necessary
1112                          * information for a retry or there was no other
1113                          * mirror in-sync.
1114                          */
1115                         DMERR_LIMIT("Mirror read failed.");
1116                         return -EIO;
1117                 }
1118
1119                 m = read_record->m;
1120
1121                 DMERR("Mirror read failed from %s. Trying alternative device.",
1122                       m->dev->name);
1123
1124                 fail_mirror(m, DM_RAID1_READ_ERROR);
1125
1126                 /*
1127                  * A failed read is requeued for another attempt using an intact
1128                  * mirror.
1129                  */
1130                 if (default_ok(m) || mirror_available(ms, bio)) {
1131                         bd = &read_record->details;
1132
1133                         dm_bio_restore(bd, bio);
1134                         mempool_free(read_record, ms->read_record_pool);
1135                         map_context->ptr = NULL;
1136                         queue_bio(ms, bio, rw);
1137                         return 1;
1138                 }
1139                 DMERR("All replicated volumes dead, failing I/O");
1140         }
1141
1142 out:
1143         if (read_record) {
1144                 mempool_free(read_record, ms->read_record_pool);
1145                 map_context->ptr = NULL;
1146         }
1147
1148         return error;
1149 }
1150
1151 static void mirror_presuspend(struct dm_target *ti)
1152 {
1153         struct mirror_set *ms = (struct mirror_set *) ti->private;
1154         struct dm_dirty_log *log = dm_rh_dirty_log(ms->rh);
1155
1156         atomic_set(&ms->suspend, 1);
1157
1158         /*
1159          * We must finish up all the work that we've
1160          * generated (i.e. recovery work).
1161          */
1162         dm_rh_stop_recovery(ms->rh);
1163
1164         wait_event(_kmirrord_recovery_stopped,
1165                    !dm_rh_recovery_in_flight(ms->rh));
1166
1167         if (log->type->presuspend && log->type->presuspend(log))
1168                 /* FIXME: need better error handling */
1169                 DMWARN("log presuspend failed");
1170
1171         /*
1172          * Now that recovery is complete/stopped and the
1173          * delayed bios are queued, we need to wait for
1174          * the worker thread to complete.  This way,
1175          * we know that all of our I/O has been pushed.
1176          */
1177         flush_workqueue(ms->kmirrord_wq);
1178 }
1179
1180 static void mirror_postsuspend(struct dm_target *ti)
1181 {
1182         struct mirror_set *ms = ti->private;
1183         struct dm_dirty_log *log = dm_rh_dirty_log(ms->rh);
1184
1185         if (log->type->postsuspend && log->type->postsuspend(log))
1186                 /* FIXME: need better error handling */
1187                 DMWARN("log postsuspend failed");
1188 }
1189
1190 static void mirror_resume(struct dm_target *ti)
1191 {
1192         struct mirror_set *ms = ti->private;
1193         struct dm_dirty_log *log = dm_rh_dirty_log(ms->rh);
1194
1195         atomic_set(&ms->suspend, 0);
1196         if (log->type->resume && log->type->resume(log))
1197                 /* FIXME: need better error handling */
1198                 DMWARN("log resume failed");
1199         dm_rh_start_recovery(ms->rh);
1200 }
1201
1202 /*
1203  * device_status_char
1204  * @m: mirror device/leg we want the status of
1205  *
1206  * We return one character representing the most severe error
1207  * we have encountered.
1208  *    A => Alive - No failures
1209  *    D => Dead - A write failure occurred leaving mirror out-of-sync
1210  *    S => Sync - A sychronization failure occurred, mirror out-of-sync
1211  *    R => Read - A read failure occurred, mirror data unaffected
1212  *
1213  * Returns: <char>
1214  */
1215 static char device_status_char(struct mirror *m)
1216 {
1217         if (!atomic_read(&(m->error_count)))
1218                 return 'A';
1219
1220         return (test_bit(DM_RAID1_WRITE_ERROR, &(m->error_type))) ? 'D' :
1221                 (test_bit(DM_RAID1_SYNC_ERROR, &(m->error_type))) ? 'S' :
1222                 (test_bit(DM_RAID1_READ_ERROR, &(m->error_type))) ? 'R' : 'U';
1223 }
1224
1225
1226 static int mirror_status(struct dm_target *ti, status_type_t type,
1227                          char *result, unsigned int maxlen)
1228 {
1229         unsigned int m, sz = 0;
1230         struct mirror_set *ms = (struct mirror_set *) ti->private;
1231         struct dm_dirty_log *log = dm_rh_dirty_log(ms->rh);
1232         char buffer[ms->nr_mirrors + 1];
1233
1234         switch (type) {
1235         case STATUSTYPE_INFO:
1236                 DMEMIT("%d ", ms->nr_mirrors);
1237                 for (m = 0; m < ms->nr_mirrors; m++) {
1238                         DMEMIT("%s ", ms->mirror[m].dev->name);
1239                         buffer[m] = device_status_char(&(ms->mirror[m]));
1240                 }
1241                 buffer[m] = '\0';
1242
1243                 DMEMIT("%llu/%llu 1 %s ",
1244                       (unsigned long long)log->type->get_sync_count(log),
1245                       (unsigned long long)ms->nr_regions, buffer);
1246
1247                 sz += log->type->status(log, type, result+sz, maxlen-sz);
1248
1249                 break;
1250
1251         case STATUSTYPE_TABLE:
1252                 sz = log->type->status(log, type, result, maxlen);
1253
1254                 DMEMIT("%d", ms->nr_mirrors);
1255                 for (m = 0; m < ms->nr_mirrors; m++)
1256                         DMEMIT(" %s %llu", ms->mirror[m].dev->name,
1257                                (unsigned long long)ms->mirror[m].offset);
1258
1259                 if (ms->features & DM_RAID1_HANDLE_ERRORS)
1260                         DMEMIT(" 1 handle_errors");
1261         }
1262
1263         return 0;
1264 }
1265
1266 static struct target_type mirror_target = {
1267         .name    = "mirror",
1268         .version = {1, 0, 20},
1269         .module  = THIS_MODULE,
1270         .ctr     = mirror_ctr,
1271         .dtr     = mirror_dtr,
1272         .map     = mirror_map,
1273         .end_io  = mirror_end_io,
1274         .presuspend = mirror_presuspend,
1275         .postsuspend = mirror_postsuspend,
1276         .resume  = mirror_resume,
1277         .status  = mirror_status,
1278 };
1279
1280 static int __init dm_mirror_init(void)
1281 {
1282         int r;
1283
1284         _dm_raid1_read_record_cache = KMEM_CACHE(dm_raid1_read_record, 0);
1285         if (!_dm_raid1_read_record_cache) {
1286                 DMERR("Can't allocate dm_raid1_read_record cache");
1287                 r = -ENOMEM;
1288                 goto bad_cache;
1289         }
1290
1291         r = dm_register_target(&mirror_target);
1292         if (r < 0) {
1293                 DMERR("Failed to register mirror target");
1294                 goto bad_target;
1295         }
1296
1297         return 0;
1298
1299 bad_target:
1300         kmem_cache_destroy(_dm_raid1_read_record_cache);
1301 bad_cache:
1302         return r;
1303 }
1304
1305 static void __exit dm_mirror_exit(void)
1306 {
1307         dm_unregister_target(&mirror_target);
1308         kmem_cache_destroy(_dm_raid1_read_record_cache);
1309 }
1310
1311 /* Module hooks */
1312 module_init(dm_mirror_init);
1313 module_exit(dm_mirror_exit);
1314
1315 MODULE_DESCRIPTION(DM_NAME " mirror target");
1316 MODULE_AUTHOR("Joe Thornber");
1317 MODULE_LICENSE("GPL");