2 * Copyright (C) 2003 Sistina Software Limited.
4 * This file is released under the GPL.
8 #include "dm-bio-list.h"
9 #include "dm-bio-record.h"
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/vmalloc.h>
22 #include <linux/workqueue.h>
23 #include <linux/log2.h>
24 #include <linux/hardirq.h>
26 #define DM_MSG_PREFIX "raid1"
27 #define DM_IO_PAGES 64
29 #define DM_RAID1_HANDLE_ERRORS 0x01
30 #define errors_handled(p) ((p)->features & DM_RAID1_HANDLE_ERRORS)
32 static DECLARE_WAIT_QUEUE_HEAD(_kmirrord_recovery_stopped);
34 /*-----------------------------------------------------------------
37 * The mirror splits itself up into discrete regions. Each
38 * region can be in one of three states: clean, dirty,
39 * nosync. There is no need to put clean regions in the hash.
41 * In addition to being present in the hash table a region _may_
42 * be present on one of three lists.
44 * clean_regions: Regions on this list have no io pending to
45 * them, they are in sync, we are no longer interested in them,
46 * they are dull. rh_update_states() will remove them from the
49 * quiesced_regions: These regions have been spun down, ready
50 * for recovery. rh_recovery_start() will remove regions from
51 * this list and hand them to kmirrord, which will schedule the
52 * recovery io with kcopyd.
54 * recovered_regions: Regions that kcopyd has successfully
55 * recovered. rh_update_states() will now schedule any delayed
56 * io, up the recovery_count, and remove the region from the
60 * A rw spin lock 'hash_lock' protects just the hash table,
61 * this is never held in write mode from interrupt context,
62 * which I believe means that we only have to disable irqs when
65 * An ordinary spin lock 'region_lock' that protects the three
66 * lists in the region_hash, with the 'state', 'list' and
67 * 'bhs_delayed' fields of the regions. This is used from irq
68 * context, so all other uses will have to suspend local irqs.
69 *---------------------------------------------------------------*/
72 struct mirror_set *ms;
74 unsigned region_shift;
76 /* holds persistent region state */
77 struct dirty_log *log;
81 mempool_t *region_pool;
83 unsigned int nr_buckets;
84 struct list_head *buckets;
86 spinlock_t region_lock;
87 atomic_t recovery_in_flight;
88 struct semaphore recovery_count;
89 struct list_head clean_regions;
90 struct list_head quiesced_regions;
91 struct list_head recovered_regions;
92 struct list_head failed_recovered_regions;
103 struct region_hash *rh; /* FIXME: can we get rid of this ? */
107 struct list_head hash_list;
108 struct list_head list;
111 struct bio_list delayed_bios;
115 /*-----------------------------------------------------------------
116 * Mirror set structures.
117 *---------------------------------------------------------------*/
118 enum dm_raid1_error {
119 DM_RAID1_WRITE_ERROR,
125 struct mirror_set *ms;
126 atomic_t error_count;
127 unsigned long error_type;
133 struct dm_target *ti;
134 struct list_head list;
135 struct region_hash rh;
136 struct kcopyd_client *kcopyd_client;
139 spinlock_t lock; /* protects the lists */
140 struct bio_list reads;
141 struct bio_list writes;
142 struct bio_list failures;
144 struct dm_io_client *io_client;
145 mempool_t *read_record_pool;
153 atomic_t default_mirror; /* Default mirror */
155 struct workqueue_struct *kmirrord_wq;
156 struct work_struct kmirrord_work;
157 struct work_struct trigger_event;
159 unsigned int nr_mirrors;
160 struct mirror mirror[0];
166 static inline region_t bio_to_region(struct region_hash *rh, struct bio *bio)
168 return (bio->bi_sector - rh->ms->ti->begin) >> rh->region_shift;
171 static inline sector_t region_to_sector(struct region_hash *rh, region_t region)
173 return region << rh->region_shift;
176 static void wake(struct mirror_set *ms)
178 queue_work(ms->kmirrord_wq, &ms->kmirrord_work);
181 /* FIXME move this */
182 static void queue_bio(struct mirror_set *ms, struct bio *bio, int rw);
184 #define MIN_REGIONS 64
185 #define MAX_RECOVERY 1
186 static int rh_init(struct region_hash *rh, struct mirror_set *ms,
187 struct dirty_log *log, uint32_t region_size,
190 unsigned int nr_buckets, max_buckets;
194 * Calculate a suitable number of buckets for our hash
197 max_buckets = nr_regions >> 6;
198 for (nr_buckets = 128u; nr_buckets < max_buckets; nr_buckets <<= 1)
204 rh->region_size = region_size;
205 rh->region_shift = ffs(region_size) - 1;
206 rwlock_init(&rh->hash_lock);
207 rh->mask = nr_buckets - 1;
208 rh->nr_buckets = nr_buckets;
210 rh->buckets = vmalloc(nr_buckets * sizeof(*rh->buckets));
212 DMERR("unable to allocate region hash memory");
216 for (i = 0; i < nr_buckets; i++)
217 INIT_LIST_HEAD(rh->buckets + i);
219 spin_lock_init(&rh->region_lock);
220 sema_init(&rh->recovery_count, 0);
221 atomic_set(&rh->recovery_in_flight, 0);
222 INIT_LIST_HEAD(&rh->clean_regions);
223 INIT_LIST_HEAD(&rh->quiesced_regions);
224 INIT_LIST_HEAD(&rh->recovered_regions);
225 INIT_LIST_HEAD(&rh->failed_recovered_regions);
227 rh->region_pool = mempool_create_kmalloc_pool(MIN_REGIONS,
228 sizeof(struct region));
229 if (!rh->region_pool) {
238 static void rh_exit(struct region_hash *rh)
241 struct region *reg, *nreg;
243 BUG_ON(!list_empty(&rh->quiesced_regions));
244 for (h = 0; h < rh->nr_buckets; h++) {
245 list_for_each_entry_safe(reg, nreg, rh->buckets + h, hash_list) {
246 BUG_ON(atomic_read(®->pending));
247 mempool_free(reg, rh->region_pool);
252 dm_destroy_dirty_log(rh->log);
254 mempool_destroy(rh->region_pool);
258 #define RH_HASH_MULT 2654435387U
260 static inline unsigned int rh_hash(struct region_hash *rh, region_t region)
262 return (unsigned int) ((region * RH_HASH_MULT) >> 12) & rh->mask;
265 static struct region *__rh_lookup(struct region_hash *rh, region_t region)
269 list_for_each_entry (reg, rh->buckets + rh_hash(rh, region), hash_list)
270 if (reg->key == region)
276 static void __rh_insert(struct region_hash *rh, struct region *reg)
278 unsigned int h = rh_hash(rh, reg->key);
279 list_add(®->hash_list, rh->buckets + h);
282 static struct region *__rh_alloc(struct region_hash *rh, region_t region)
284 struct region *reg, *nreg;
286 read_unlock(&rh->hash_lock);
287 nreg = mempool_alloc(rh->region_pool, GFP_ATOMIC);
289 nreg = kmalloc(sizeof(struct region), GFP_NOIO);
290 nreg->state = rh->log->type->in_sync(rh->log, region, 1) ?
291 RH_CLEAN : RH_NOSYNC;
295 INIT_LIST_HEAD(&nreg->list);
297 atomic_set(&nreg->pending, 0);
298 bio_list_init(&nreg->delayed_bios);
299 write_lock_irq(&rh->hash_lock);
301 reg = __rh_lookup(rh, region);
303 /* we lost the race */
304 mempool_free(nreg, rh->region_pool);
307 __rh_insert(rh, nreg);
308 if (nreg->state == RH_CLEAN) {
309 spin_lock(&rh->region_lock);
310 list_add(&nreg->list, &rh->clean_regions);
311 spin_unlock(&rh->region_lock);
315 write_unlock_irq(&rh->hash_lock);
316 read_lock(&rh->hash_lock);
321 static inline struct region *__rh_find(struct region_hash *rh, region_t region)
325 reg = __rh_lookup(rh, region);
327 reg = __rh_alloc(rh, region);
332 static int rh_state(struct region_hash *rh, region_t region, int may_block)
337 read_lock(&rh->hash_lock);
338 reg = __rh_lookup(rh, region);
339 read_unlock(&rh->hash_lock);
345 * The region wasn't in the hash, so we fall back to the
348 r = rh->log->type->in_sync(rh->log, region, may_block);
351 * Any error from the dirty log (eg. -EWOULDBLOCK) gets
352 * taken as a RH_NOSYNC
354 return r == 1 ? RH_CLEAN : RH_NOSYNC;
357 static inline int rh_in_sync(struct region_hash *rh,
358 region_t region, int may_block)
360 int state = rh_state(rh, region, may_block);
361 return state == RH_CLEAN || state == RH_DIRTY;
364 static void dispatch_bios(struct mirror_set *ms, struct bio_list *bio_list)
368 while ((bio = bio_list_pop(bio_list))) {
369 queue_bio(ms, bio, WRITE);
373 static void complete_resync_work(struct region *reg, int success)
375 struct region_hash *rh = reg->rh;
377 rh->log->type->set_region_sync(rh->log, reg->key, success);
380 * Dispatch the bios before we call 'wake_up_all'.
381 * This is important because if we are suspending,
382 * we want to know that recovery is complete and
383 * the work queue is flushed. If we wake_up_all
384 * before we dispatch_bios (queue bios and call wake()),
385 * then we risk suspending before the work queue
386 * has been properly flushed.
388 dispatch_bios(rh->ms, ®->delayed_bios);
389 if (atomic_dec_and_test(&rh->recovery_in_flight))
390 wake_up_all(&_kmirrord_recovery_stopped);
391 up(&rh->recovery_count);
394 static void rh_update_states(struct region_hash *rh)
396 struct region *reg, *next;
399 LIST_HEAD(recovered);
400 LIST_HEAD(failed_recovered);
403 * Quickly grab the lists.
405 write_lock_irq(&rh->hash_lock);
406 spin_lock(&rh->region_lock);
407 if (!list_empty(&rh->clean_regions)) {
408 list_splice(&rh->clean_regions, &clean);
409 INIT_LIST_HEAD(&rh->clean_regions);
411 list_for_each_entry(reg, &clean, list)
412 list_del(®->hash_list);
415 if (!list_empty(&rh->recovered_regions)) {
416 list_splice(&rh->recovered_regions, &recovered);
417 INIT_LIST_HEAD(&rh->recovered_regions);
419 list_for_each_entry (reg, &recovered, list)
420 list_del(®->hash_list);
423 if (!list_empty(&rh->failed_recovered_regions)) {
424 list_splice(&rh->failed_recovered_regions, &failed_recovered);
425 INIT_LIST_HEAD(&rh->failed_recovered_regions);
427 list_for_each_entry(reg, &failed_recovered, list)
428 list_del(®->hash_list);
431 spin_unlock(&rh->region_lock);
432 write_unlock_irq(&rh->hash_lock);
435 * All the regions on the recovered and clean lists have
436 * now been pulled out of the system, so no need to do
439 list_for_each_entry_safe (reg, next, &recovered, list) {
440 rh->log->type->clear_region(rh->log, reg->key);
441 complete_resync_work(reg, 1);
442 mempool_free(reg, rh->region_pool);
445 list_for_each_entry_safe(reg, next, &failed_recovered, list) {
446 complete_resync_work(reg, errors_handled(rh->ms) ? 0 : 1);
447 mempool_free(reg, rh->region_pool);
450 list_for_each_entry_safe(reg, next, &clean, list) {
451 rh->log->type->clear_region(rh->log, reg->key);
452 mempool_free(reg, rh->region_pool);
455 rh->log->type->flush(rh->log);
458 static void rh_inc(struct region_hash *rh, region_t region)
462 read_lock(&rh->hash_lock);
463 reg = __rh_find(rh, region);
465 spin_lock_irq(&rh->region_lock);
466 atomic_inc(®->pending);
468 if (reg->state == RH_CLEAN) {
469 reg->state = RH_DIRTY;
470 list_del_init(®->list); /* take off the clean list */
471 spin_unlock_irq(&rh->region_lock);
473 rh->log->type->mark_region(rh->log, reg->key);
475 spin_unlock_irq(&rh->region_lock);
478 read_unlock(&rh->hash_lock);
481 static void rh_inc_pending(struct region_hash *rh, struct bio_list *bios)
485 for (bio = bios->head; bio; bio = bio->bi_next)
486 rh_inc(rh, bio_to_region(rh, bio));
489 static void rh_dec(struct region_hash *rh, region_t region)
495 read_lock(&rh->hash_lock);
496 reg = __rh_lookup(rh, region);
497 read_unlock(&rh->hash_lock);
499 spin_lock_irqsave(&rh->region_lock, flags);
500 if (atomic_dec_and_test(®->pending)) {
502 * There is no pending I/O for this region.
503 * We can move the region to corresponding list for next action.
504 * At this point, the region is not yet connected to any list.
506 * If the state is RH_NOSYNC, the region should be kept off
508 * The hash entry for RH_NOSYNC will remain in memory
509 * until the region is recovered or the map is reloaded.
512 /* do nothing for RH_NOSYNC */
513 if (reg->state == RH_RECOVERING) {
514 list_add_tail(®->list, &rh->quiesced_regions);
515 } else if (reg->state == RH_DIRTY) {
516 reg->state = RH_CLEAN;
517 list_add(®->list, &rh->clean_regions);
521 spin_unlock_irqrestore(&rh->region_lock, flags);
528 * Starts quiescing a region in preparation for recovery.
530 static int __rh_recovery_prepare(struct region_hash *rh)
537 * Ask the dirty log what's next.
539 r = rh->log->type->get_resync_work(rh->log, ®ion);
544 * Get this region, and start it quiescing by setting the
547 read_lock(&rh->hash_lock);
548 reg = __rh_find(rh, region);
549 read_unlock(&rh->hash_lock);
551 spin_lock_irq(&rh->region_lock);
552 reg->state = RH_RECOVERING;
554 /* Already quiesced ? */
555 if (atomic_read(®->pending))
556 list_del_init(®->list);
558 list_move(®->list, &rh->quiesced_regions);
560 spin_unlock_irq(&rh->region_lock);
565 static void rh_recovery_prepare(struct region_hash *rh)
567 /* Extra reference to avoid race with rh_stop_recovery */
568 atomic_inc(&rh->recovery_in_flight);
570 while (!down_trylock(&rh->recovery_count)) {
571 atomic_inc(&rh->recovery_in_flight);
572 if (__rh_recovery_prepare(rh) <= 0) {
573 atomic_dec(&rh->recovery_in_flight);
574 up(&rh->recovery_count);
579 /* Drop the extra reference */
580 if (atomic_dec_and_test(&rh->recovery_in_flight))
581 wake_up_all(&_kmirrord_recovery_stopped);
585 * Returns any quiesced regions.
587 static struct region *rh_recovery_start(struct region_hash *rh)
589 struct region *reg = NULL;
591 spin_lock_irq(&rh->region_lock);
592 if (!list_empty(&rh->quiesced_regions)) {
593 reg = list_entry(rh->quiesced_regions.next,
594 struct region, list);
595 list_del_init(®->list); /* remove from the quiesced list */
597 spin_unlock_irq(&rh->region_lock);
602 static void rh_recovery_end(struct region *reg, int success)
604 struct region_hash *rh = reg->rh;
606 spin_lock_irq(&rh->region_lock);
608 list_add(®->list, ®->rh->recovered_regions);
610 reg->state = RH_NOSYNC;
611 list_add(®->list, ®->rh->failed_recovered_regions);
613 spin_unlock_irq(&rh->region_lock);
618 static int rh_flush(struct region_hash *rh)
620 return rh->log->type->flush(rh->log);
623 static void rh_delay(struct region_hash *rh, struct bio *bio)
627 read_lock(&rh->hash_lock);
628 reg = __rh_find(rh, bio_to_region(rh, bio));
629 bio_list_add(®->delayed_bios, bio);
630 read_unlock(&rh->hash_lock);
633 static void rh_stop_recovery(struct region_hash *rh)
637 /* wait for any recovering regions */
638 for (i = 0; i < MAX_RECOVERY; i++)
639 down(&rh->recovery_count);
642 static void rh_start_recovery(struct region_hash *rh)
646 for (i = 0; i < MAX_RECOVERY; i++)
647 up(&rh->recovery_count);
652 #define MIN_READ_RECORDS 20
653 struct dm_raid1_read_record {
655 struct dm_bio_details details;
659 * Every mirror should look like this one.
661 #define DEFAULT_MIRROR 0
664 * This is yucky. We squirrel the mirror struct away inside
665 * bi_next for read/write buffers. This is safe since the bh
666 * doesn't get submitted to the lower levels of block layer.
668 static struct mirror *bio_get_m(struct bio *bio)
670 return (struct mirror *) bio->bi_next;
673 static void bio_set_m(struct bio *bio, struct mirror *m)
675 bio->bi_next = (struct bio *) m;
678 static struct mirror *get_default_mirror(struct mirror_set *ms)
680 return &ms->mirror[atomic_read(&ms->default_mirror)];
683 static void set_default_mirror(struct mirror *m)
685 struct mirror_set *ms = m->ms;
686 struct mirror *m0 = &(ms->mirror[0]);
688 atomic_set(&ms->default_mirror, m - m0);
692 * @m: mirror device to fail
693 * @error_type: one of the enum's, DM_RAID1_*_ERROR
695 * If errors are being handled, record the type of
696 * error encountered for this device. If this type
697 * of error has already been recorded, we can return;
698 * otherwise, we must signal userspace by triggering
699 * an event. Additionally, if the device is the
700 * primary device, we must choose a new primary, but
701 * only if the mirror is in-sync.
703 * This function must not block.
705 static void fail_mirror(struct mirror *m, enum dm_raid1_error error_type)
707 struct mirror_set *ms = m->ms;
710 if (!errors_handled(ms))
714 * error_count is used for nothing more than a
715 * simple way to tell if a device has encountered
718 atomic_inc(&m->error_count);
720 if (test_and_set_bit(error_type, &m->error_type))
723 if (m != get_default_mirror(ms))
728 * Better to issue requests to same failing device
729 * than to risk returning corrupt data.
731 DMERR("Primary mirror (%s) failed while out-of-sync: "
732 "Reads may fail.", m->dev->name);
736 for (new = ms->mirror; new < ms->mirror + ms->nr_mirrors; new++)
737 if (!atomic_read(&new->error_count)) {
738 set_default_mirror(new);
742 if (unlikely(new == ms->mirror + ms->nr_mirrors))
743 DMWARN("All sides of mirror have failed.");
746 schedule_work(&ms->trigger_event);
749 /*-----------------------------------------------------------------
752 * When a mirror is first activated we may find that some regions
753 * are in the no-sync state. We have to recover these by
754 * recopying from the default mirror to all the others.
755 *---------------------------------------------------------------*/
756 static void recovery_complete(int read_err, unsigned int write_err,
759 struct region *reg = (struct region *)context;
760 struct mirror_set *ms = reg->rh->ms;
764 /* Read error means the failure of default mirror. */
765 DMERR_LIMIT("Unable to read primary mirror during recovery");
766 fail_mirror(get_default_mirror(ms), DM_RAID1_SYNC_ERROR);
770 DMERR_LIMIT("Write error during recovery (error = 0x%x)",
773 * Bits correspond to devices (excluding default mirror).
774 * The default mirror cannot change during recovery.
776 for (m = 0; m < ms->nr_mirrors; m++) {
777 if (&ms->mirror[m] == get_default_mirror(ms))
779 if (test_bit(bit, &write_err))
780 fail_mirror(ms->mirror + m,
781 DM_RAID1_SYNC_ERROR);
786 rh_recovery_end(reg, !(read_err || write_err));
789 static int recover(struct mirror_set *ms, struct region *reg)
793 struct io_region from, to[KCOPYD_MAX_REGIONS], *dest;
795 unsigned long flags = 0;
797 /* fill in the source */
798 m = get_default_mirror(ms);
799 from.bdev = m->dev->bdev;
800 from.sector = m->offset + region_to_sector(reg->rh, reg->key);
801 if (reg->key == (ms->nr_regions - 1)) {
803 * The final region may be smaller than
806 from.count = ms->ti->len & (reg->rh->region_size - 1);
808 from.count = reg->rh->region_size;
810 from.count = reg->rh->region_size;
812 /* fill in the destinations */
813 for (i = 0, dest = to; i < ms->nr_mirrors; i++) {
814 if (&ms->mirror[i] == get_default_mirror(ms))
818 dest->bdev = m->dev->bdev;
819 dest->sector = m->offset + region_to_sector(reg->rh, reg->key);
820 dest->count = from.count;
825 set_bit(KCOPYD_IGNORE_ERROR, &flags);
826 r = kcopyd_copy(ms->kcopyd_client, &from, ms->nr_mirrors - 1, to, flags,
827 recovery_complete, reg);
832 static void do_recovery(struct mirror_set *ms)
836 struct dirty_log *log = ms->rh.log;
839 * Start quiescing some regions.
841 rh_recovery_prepare(&ms->rh);
844 * Copy any already quiesced regions.
846 while ((reg = rh_recovery_start(&ms->rh))) {
847 r = recover(ms, reg);
849 rh_recovery_end(reg, 0);
853 * Update the in sync flag.
856 (log->type->get_sync_count(log) == ms->nr_regions)) {
857 /* the sync is complete */
858 dm_table_event(ms->ti->table);
863 /*-----------------------------------------------------------------
865 *---------------------------------------------------------------*/
866 static struct mirror *choose_mirror(struct mirror_set *ms, sector_t sector)
868 struct mirror *m = get_default_mirror(ms);
871 if (likely(!atomic_read(&m->error_count)))
874 if (m-- == ms->mirror)
876 } while (m != get_default_mirror(ms));
881 static int default_ok(struct mirror *m)
883 struct mirror *default_mirror = get_default_mirror(m->ms);
885 return !atomic_read(&default_mirror->error_count);
888 static int mirror_available(struct mirror_set *ms, struct bio *bio)
890 region_t region = bio_to_region(&ms->rh, bio);
892 if (ms->rh.log->type->in_sync(ms->rh.log, region, 0))
893 return choose_mirror(ms, bio->bi_sector) ? 1 : 0;
899 * remap a buffer to a particular mirror.
901 static sector_t map_sector(struct mirror *m, struct bio *bio)
903 return m->offset + (bio->bi_sector - m->ms->ti->begin);
906 static void map_bio(struct mirror *m, struct bio *bio)
908 bio->bi_bdev = m->dev->bdev;
909 bio->bi_sector = map_sector(m, bio);
912 static void map_region(struct io_region *io, struct mirror *m,
915 io->bdev = m->dev->bdev;
916 io->sector = map_sector(m, bio);
917 io->count = bio->bi_size >> 9;
920 /*-----------------------------------------------------------------
922 *---------------------------------------------------------------*/
923 static void read_callback(unsigned long error, void *context)
925 struct bio *bio = context;
929 bio_set_m(bio, NULL);
931 if (likely(!error)) {
936 fail_mirror(m, DM_RAID1_READ_ERROR);
938 if (likely(default_ok(m)) || mirror_available(m->ms, bio)) {
939 DMWARN_LIMIT("Read failure on mirror device %s. "
940 "Trying alternative device.",
942 queue_bio(m->ms, bio, bio_rw(bio));
946 DMERR_LIMIT("Read failure on mirror device %s. Failing I/O.",
948 bio_endio(bio, -EIO);
951 /* Asynchronous read. */
952 static void read_async_bio(struct mirror *m, struct bio *bio)
955 struct dm_io_request io_req = {
957 .mem.type = DM_IO_BVEC,
958 .mem.ptr.bvec = bio->bi_io_vec + bio->bi_idx,
959 .notify.fn = read_callback,
960 .notify.context = bio,
961 .client = m->ms->io_client,
964 map_region(&io, m, bio);
966 (void) dm_io(&io_req, 1, &io, NULL);
969 static void do_reads(struct mirror_set *ms, struct bio_list *reads)
975 while ((bio = bio_list_pop(reads))) {
976 region = bio_to_region(&ms->rh, bio);
977 m = get_default_mirror(ms);
980 * We can only read balance if the region is in sync.
982 if (likely(rh_in_sync(&ms->rh, region, 1)))
983 m = choose_mirror(ms, bio->bi_sector);
984 else if (m && atomic_read(&m->error_count))
988 read_async_bio(m, bio);
990 bio_endio(bio, -EIO);
994 /*-----------------------------------------------------------------
997 * We do different things with the write io depending on the
998 * state of the region that it's in:
1000 * SYNC: increment pending, use kcopyd to write to *all* mirrors
1001 * RECOVERING: delay the io until recovery completes
1002 * NOSYNC: increment pending, just write to the default mirror
1003 *---------------------------------------------------------------*/
1005 /* __bio_mark_nosync
1011 * The bio was written on some mirror(s) but failed on other mirror(s).
1012 * We can successfully endio the bio but should avoid the region being
1013 * marked clean by setting the state RH_NOSYNC.
1015 * This function is _not_ safe in interrupt context!
1017 static void __bio_mark_nosync(struct mirror_set *ms,
1018 struct bio *bio, unsigned done, int error)
1020 unsigned long flags;
1021 struct region_hash *rh = &ms->rh;
1022 struct dirty_log *log = ms->rh.log;
1024 region_t region = bio_to_region(rh, bio);
1027 /* We must inform the log that the sync count has changed. */
1028 log->type->set_region_sync(log, region, 0);
1031 read_lock(&rh->hash_lock);
1032 reg = __rh_find(rh, region);
1033 read_unlock(&rh->hash_lock);
1035 /* region hash entry should exist because write was in-flight */
1037 BUG_ON(!list_empty(®->list));
1039 spin_lock_irqsave(&rh->region_lock, flags);
1043 * 2) RH_NOSYNC: was dirty, other preceeding writes failed
1044 * 3) RH_RECOVERING: flushing pending writes
1045 * Either case, the region should have not been connected to list.
1047 recovering = (reg->state == RH_RECOVERING);
1048 reg->state = RH_NOSYNC;
1049 BUG_ON(!list_empty(®->list));
1050 spin_unlock_irqrestore(&rh->region_lock, flags);
1052 bio_endio(bio, error);
1054 complete_resync_work(reg, 0);
1057 static void write_callback(unsigned long error, void *context)
1059 unsigned i, ret = 0;
1060 struct bio *bio = (struct bio *) context;
1061 struct mirror_set *ms;
1063 int should_wake = 0;
1064 unsigned long flags;
1066 ms = bio_get_m(bio)->ms;
1067 bio_set_m(bio, NULL);
1070 * NOTE: We don't decrement the pending count here,
1071 * instead it is done by the targets endio function.
1072 * This way we handle both writes to SYNC and NOSYNC
1073 * regions with the same code.
1078 for (i = 0; i < ms->nr_mirrors; i++)
1079 if (test_bit(i, &error))
1080 fail_mirror(ms->mirror + i, DM_RAID1_WRITE_ERROR);
1084 if (unlikely(!uptodate)) {
1085 DMERR("All replicated volumes dead, failing I/O");
1086 /* None of the writes succeeded, fail the I/O. */
1088 } else if (errors_handled(ms)) {
1090 * Need to raise event. Since raising
1091 * events can block, we need to do it in
1094 spin_lock_irqsave(&ms->lock, flags);
1095 if (!ms->failures.head)
1097 bio_list_add(&ms->failures, bio);
1098 spin_unlock_irqrestore(&ms->lock, flags);
1104 bio_endio(bio, ret);
1107 static void do_write(struct mirror_set *ms, struct bio *bio)
1110 struct io_region io[ms->nr_mirrors], *dest = io;
1112 struct dm_io_request io_req = {
1114 .mem.type = DM_IO_BVEC,
1115 .mem.ptr.bvec = bio->bi_io_vec + bio->bi_idx,
1116 .notify.fn = write_callback,
1117 .notify.context = bio,
1118 .client = ms->io_client,
1121 for (i = 0, m = ms->mirror; i < ms->nr_mirrors; i++, m++)
1122 map_region(dest++, m, bio);
1125 * Use default mirror because we only need it to retrieve the reference
1126 * to the mirror set in write_callback().
1128 bio_set_m(bio, get_default_mirror(ms));
1130 (void) dm_io(&io_req, ms->nr_mirrors, io, NULL);
1133 static void do_writes(struct mirror_set *ms, struct bio_list *writes)
1137 struct bio_list sync, nosync, recover, *this_list = NULL;
1143 * Classify each write.
1145 bio_list_init(&sync);
1146 bio_list_init(&nosync);
1147 bio_list_init(&recover);
1149 while ((bio = bio_list_pop(writes))) {
1150 state = rh_state(&ms->rh, bio_to_region(&ms->rh, bio), 1);
1158 this_list = &nosync;
1162 this_list = &recover;
1166 bio_list_add(this_list, bio);
1170 * Increment the pending counts for any regions that will
1171 * be written to (writes to recover regions are going to
1174 rh_inc_pending(&ms->rh, &sync);
1175 rh_inc_pending(&ms->rh, &nosync);
1176 ms->log_failure = rh_flush(&ms->rh) ? 1 : 0;
1181 if (unlikely(ms->log_failure)) {
1182 spin_lock_irq(&ms->lock);
1183 bio_list_merge(&ms->failures, &sync);
1184 spin_unlock_irq(&ms->lock);
1186 while ((bio = bio_list_pop(&sync)))
1189 while ((bio = bio_list_pop(&recover)))
1190 rh_delay(&ms->rh, bio);
1192 while ((bio = bio_list_pop(&nosync))) {
1193 map_bio(get_default_mirror(ms), bio);
1194 generic_make_request(bio);
1198 static void do_failures(struct mirror_set *ms, struct bio_list *failures)
1202 if (!failures->head)
1205 if (!ms->log_failure) {
1206 while ((bio = bio_list_pop(failures)))
1207 __bio_mark_nosync(ms, bio, bio->bi_size, 0);
1212 * If the log has failed, unattempted writes are being
1213 * put on the failures list. We can't issue those writes
1214 * until a log has been marked, so we must store them.
1216 * If a 'noflush' suspend is in progress, we can requeue
1217 * the I/O's to the core. This give userspace a chance
1218 * to reconfigure the mirror, at which point the core
1219 * will reissue the writes. If the 'noflush' flag is
1220 * not set, we have no choice but to return errors.
1222 * Some writes on the failures list may have been
1223 * submitted before the log failure and represent a
1224 * failure to write to one of the devices. It is ok
1225 * for us to treat them the same and requeue them
1228 if (dm_noflush_suspending(ms->ti)) {
1229 while ((bio = bio_list_pop(failures)))
1230 bio_endio(bio, DM_ENDIO_REQUEUE);
1234 if (atomic_read(&ms->suspend)) {
1235 while ((bio = bio_list_pop(failures)))
1236 bio_endio(bio, -EIO);
1240 spin_lock_irq(&ms->lock);
1241 bio_list_merge(&ms->failures, failures);
1242 spin_unlock_irq(&ms->lock);
1247 static void trigger_event(struct work_struct *work)
1249 struct mirror_set *ms =
1250 container_of(work, struct mirror_set, trigger_event);
1252 dm_table_event(ms->ti->table);
1255 /*-----------------------------------------------------------------
1257 *---------------------------------------------------------------*/
1258 static int _do_mirror(struct work_struct *work)
1260 struct mirror_set *ms =container_of(work, struct mirror_set,
1262 struct bio_list reads, writes, failures;
1263 unsigned long flags;
1265 spin_lock_irqsave(&ms->lock, flags);
1267 writes = ms->writes;
1268 failures = ms->failures;
1269 bio_list_init(&ms->reads);
1270 bio_list_init(&ms->writes);
1271 bio_list_init(&ms->failures);
1272 spin_unlock_irqrestore(&ms->lock, flags);
1274 rh_update_states(&ms->rh);
1276 do_reads(ms, &reads);
1277 do_writes(ms, &writes);
1278 do_failures(ms, &failures);
1280 return (ms->failures.head) ? 1 : 0;
1283 static void do_mirror(struct work_struct *work)
1286 * If _do_mirror returns 1, we give it
1287 * another shot. This helps for cases like
1288 * 'suspend' where we call flush_workqueue
1289 * and expect all work to be finished. If
1290 * a failure happens during a suspend, we
1291 * couldn't issue a 'wake' because it would
1292 * not be honored. Therefore, we return '1'
1293 * from _do_mirror, and retry here.
1295 while (_do_mirror(work))
1300 /*-----------------------------------------------------------------
1302 *---------------------------------------------------------------*/
1303 static struct mirror_set *alloc_context(unsigned int nr_mirrors,
1304 uint32_t region_size,
1305 struct dm_target *ti,
1306 struct dirty_log *dl)
1309 struct mirror_set *ms = NULL;
1311 if (array_too_big(sizeof(*ms), sizeof(ms->mirror[0]), nr_mirrors))
1314 len = sizeof(*ms) + (sizeof(ms->mirror[0]) * nr_mirrors);
1316 ms = kzalloc(len, GFP_KERNEL);
1318 ti->error = "Cannot allocate mirror context";
1322 spin_lock_init(&ms->lock);
1325 ms->nr_mirrors = nr_mirrors;
1326 ms->nr_regions = dm_sector_div_up(ti->len, region_size);
1328 ms->log_failure = 0;
1329 atomic_set(&ms->suspend, 0);
1330 atomic_set(&ms->default_mirror, DEFAULT_MIRROR);
1332 len = sizeof(struct dm_raid1_read_record);
1333 ms->read_record_pool = mempool_create_kmalloc_pool(MIN_READ_RECORDS,
1335 if (!ms->read_record_pool) {
1336 ti->error = "Error creating mirror read_record_pool";
1341 ms->io_client = dm_io_client_create(DM_IO_PAGES);
1342 if (IS_ERR(ms->io_client)) {
1343 ti->error = "Error creating dm_io client";
1344 mempool_destroy(ms->read_record_pool);
1349 if (rh_init(&ms->rh, ms, dl, region_size, ms->nr_regions)) {
1350 ti->error = "Error creating dirty region hash";
1351 dm_io_client_destroy(ms->io_client);
1352 mempool_destroy(ms->read_record_pool);
1360 static void free_context(struct mirror_set *ms, struct dm_target *ti,
1364 dm_put_device(ti, ms->mirror[m].dev);
1366 dm_io_client_destroy(ms->io_client);
1368 mempool_destroy(ms->read_record_pool);
1372 static inline int _check_region_size(struct dm_target *ti, uint32_t size)
1374 return !(size % (PAGE_SIZE >> 9) || !is_power_of_2(size) ||
1378 static int get_mirror(struct mirror_set *ms, struct dm_target *ti,
1379 unsigned int mirror, char **argv)
1381 unsigned long long offset;
1383 if (sscanf(argv[1], "%llu", &offset) != 1) {
1384 ti->error = "Invalid offset";
1388 if (dm_get_device(ti, argv[0], offset, ti->len,
1389 dm_table_get_mode(ti->table),
1390 &ms->mirror[mirror].dev)) {
1391 ti->error = "Device lookup failure";
1395 ms->mirror[mirror].ms = ms;
1396 atomic_set(&(ms->mirror[mirror].error_count), 0);
1397 ms->mirror[mirror].error_type = 0;
1398 ms->mirror[mirror].offset = offset;
1404 * Create dirty log: log_type #log_params <log_params>
1406 static struct dirty_log *create_dirty_log(struct dm_target *ti,
1407 unsigned int argc, char **argv,
1408 unsigned int *args_used)
1410 unsigned int param_count;
1411 struct dirty_log *dl;
1414 ti->error = "Insufficient mirror log arguments";
1418 if (sscanf(argv[1], "%u", ¶m_count) != 1) {
1419 ti->error = "Invalid mirror log argument count";
1423 *args_used = 2 + param_count;
1425 if (argc < *args_used) {
1426 ti->error = "Insufficient mirror log arguments";
1430 dl = dm_create_dirty_log(argv[0], ti, param_count, argv + 2);
1432 ti->error = "Error creating mirror dirty log";
1436 if (!_check_region_size(ti, dl->type->get_region_size(dl))) {
1437 ti->error = "Invalid region size";
1438 dm_destroy_dirty_log(dl);
1445 static int parse_features(struct mirror_set *ms, unsigned argc, char **argv,
1446 unsigned *args_used)
1448 unsigned num_features;
1449 struct dm_target *ti = ms->ti;
1456 if (sscanf(argv[0], "%u", &num_features) != 1) {
1457 ti->error = "Invalid number of features";
1465 if (num_features > argc) {
1466 ti->error = "Not enough arguments to support feature count";
1470 if (!strcmp("handle_errors", argv[0]))
1471 ms->features |= DM_RAID1_HANDLE_ERRORS;
1473 ti->error = "Unrecognised feature requested";
1483 * Construct a mirror mapping:
1485 * log_type #log_params <log_params>
1486 * #mirrors [mirror_path offset]{2,}
1487 * [#features <features>]
1489 * log_type is "core" or "disk"
1490 * #log_params is between 1 and 3
1492 * If present, features must be "handle_errors".
1494 static int mirror_ctr(struct dm_target *ti, unsigned int argc, char **argv)
1497 unsigned int nr_mirrors, m, args_used;
1498 struct mirror_set *ms;
1499 struct dirty_log *dl;
1501 dl = create_dirty_log(ti, argc, argv, &args_used);
1508 if (!argc || sscanf(argv[0], "%u", &nr_mirrors) != 1 ||
1509 nr_mirrors < 2 || nr_mirrors > KCOPYD_MAX_REGIONS + 1) {
1510 ti->error = "Invalid number of mirrors";
1511 dm_destroy_dirty_log(dl);
1517 if (argc < nr_mirrors * 2) {
1518 ti->error = "Too few mirror arguments";
1519 dm_destroy_dirty_log(dl);
1523 ms = alloc_context(nr_mirrors, dl->type->get_region_size(dl), ti, dl);
1525 dm_destroy_dirty_log(dl);
1529 /* Get the mirror parameter sets */
1530 for (m = 0; m < nr_mirrors; m++) {
1531 r = get_mirror(ms, ti, m, argv);
1533 free_context(ms, ti, m);
1541 ti->split_io = ms->rh.region_size;
1543 ms->kmirrord_wq = create_singlethread_workqueue("kmirrord");
1544 if (!ms->kmirrord_wq) {
1545 DMERR("couldn't start kmirrord");
1547 goto err_free_context;
1549 INIT_WORK(&ms->kmirrord_work, do_mirror);
1550 INIT_WORK(&ms->trigger_event, trigger_event);
1552 r = parse_features(ms, argc, argv, &args_used);
1554 goto err_destroy_wq;
1560 * Any read-balancing addition depends on the
1561 * DM_RAID1_HANDLE_ERRORS flag being present.
1562 * This is because the decision to balance depends
1563 * on the sync state of a region. If the above
1564 * flag is not present, we ignore errors; and
1565 * the sync state may be inaccurate.
1569 ti->error = "Too many mirror arguments";
1571 goto err_destroy_wq;
1574 r = kcopyd_client_create(DM_IO_PAGES, &ms->kcopyd_client);
1576 goto err_destroy_wq;
1582 destroy_workqueue(ms->kmirrord_wq);
1584 free_context(ms, ti, ms->nr_mirrors);
1588 static void mirror_dtr(struct dm_target *ti)
1590 struct mirror_set *ms = (struct mirror_set *) ti->private;
1592 flush_workqueue(ms->kmirrord_wq);
1593 kcopyd_client_destroy(ms->kcopyd_client);
1594 destroy_workqueue(ms->kmirrord_wq);
1595 free_context(ms, ti, ms->nr_mirrors);
1598 static void queue_bio(struct mirror_set *ms, struct bio *bio, int rw)
1600 unsigned long flags;
1601 int should_wake = 0;
1602 struct bio_list *bl;
1604 bl = (rw == WRITE) ? &ms->writes : &ms->reads;
1605 spin_lock_irqsave(&ms->lock, flags);
1606 should_wake = !(bl->head);
1607 bio_list_add(bl, bio);
1608 spin_unlock_irqrestore(&ms->lock, flags);
1615 * Mirror mapping function
1617 static int mirror_map(struct dm_target *ti, struct bio *bio,
1618 union map_info *map_context)
1620 int r, rw = bio_rw(bio);
1622 struct mirror_set *ms = ti->private;
1623 struct dm_raid1_read_record *read_record = NULL;
1626 /* Save region for mirror_end_io() handler */
1627 map_context->ll = bio_to_region(&ms->rh, bio);
1628 queue_bio(ms, bio, rw);
1629 return DM_MAPIO_SUBMITTED;
1632 r = ms->rh.log->type->in_sync(ms->rh.log,
1633 bio_to_region(&ms->rh, bio), 0);
1634 if (r < 0 && r != -EWOULDBLOCK)
1638 * If region is not in-sync queue the bio.
1640 if (!r || (r == -EWOULDBLOCK)) {
1642 return -EWOULDBLOCK;
1644 queue_bio(ms, bio, rw);
1645 return DM_MAPIO_SUBMITTED;
1649 * The region is in-sync and we can perform reads directly.
1650 * Store enough information so we can retry if it fails.
1652 m = choose_mirror(ms, bio->bi_sector);
1656 read_record = mempool_alloc(ms->read_record_pool, GFP_NOIO);
1657 if (likely(read_record)) {
1658 dm_bio_record(&read_record->details, bio);
1659 map_context->ptr = read_record;
1665 return DM_MAPIO_REMAPPED;
1668 static int mirror_end_io(struct dm_target *ti, struct bio *bio,
1669 int error, union map_info *map_context)
1671 int rw = bio_rw(bio);
1672 struct mirror_set *ms = (struct mirror_set *) ti->private;
1673 struct mirror *m = NULL;
1674 struct dm_bio_details *bd = NULL;
1675 struct dm_raid1_read_record *read_record = map_context->ptr;
1678 * We need to dec pending if this was a write.
1681 rh_dec(&ms->rh, map_context->ll);
1685 if (error == -EOPNOTSUPP)
1688 if ((error == -EWOULDBLOCK) && bio_rw_ahead(bio))
1691 if (unlikely(error)) {
1694 * There wasn't enough memory to record necessary
1695 * information for a retry or there was no other
1698 DMERR_LIMIT("Mirror read failed.");
1704 DMERR("Mirror read failed from %s. Trying alternative device.",
1707 fail_mirror(m, DM_RAID1_READ_ERROR);
1710 * A failed read is requeued for another attempt using an intact
1713 if (default_ok(m) || mirror_available(ms, bio)) {
1714 bd = &read_record->details;
1716 dm_bio_restore(bd, bio);
1717 mempool_free(read_record, ms->read_record_pool);
1718 map_context->ptr = NULL;
1719 queue_bio(ms, bio, rw);
1722 DMERR("All replicated volumes dead, failing I/O");
1727 mempool_free(read_record, ms->read_record_pool);
1728 map_context->ptr = NULL;
1734 static void mirror_presuspend(struct dm_target *ti)
1736 struct mirror_set *ms = (struct mirror_set *) ti->private;
1737 struct dirty_log *log = ms->rh.log;
1739 atomic_set(&ms->suspend, 1);
1742 * We must finish up all the work that we've
1743 * generated (i.e. recovery work).
1745 rh_stop_recovery(&ms->rh);
1747 wait_event(_kmirrord_recovery_stopped,
1748 !atomic_read(&ms->rh.recovery_in_flight));
1750 if (log->type->presuspend && log->type->presuspend(log))
1751 /* FIXME: need better error handling */
1752 DMWARN("log presuspend failed");
1755 * Now that recovery is complete/stopped and the
1756 * delayed bios are queued, we need to wait for
1757 * the worker thread to complete. This way,
1758 * we know that all of our I/O has been pushed.
1760 flush_workqueue(ms->kmirrord_wq);
1763 static void mirror_postsuspend(struct dm_target *ti)
1765 struct mirror_set *ms = ti->private;
1766 struct dirty_log *log = ms->rh.log;
1768 if (log->type->postsuspend && log->type->postsuspend(log))
1769 /* FIXME: need better error handling */
1770 DMWARN("log postsuspend failed");
1773 static void mirror_resume(struct dm_target *ti)
1775 struct mirror_set *ms = ti->private;
1776 struct dirty_log *log = ms->rh.log;
1778 atomic_set(&ms->suspend, 0);
1779 if (log->type->resume && log->type->resume(log))
1780 /* FIXME: need better error handling */
1781 DMWARN("log resume failed");
1782 rh_start_recovery(&ms->rh);
1786 * device_status_char
1787 * @m: mirror device/leg we want the status of
1789 * We return one character representing the most severe error
1790 * we have encountered.
1791 * A => Alive - No failures
1792 * D => Dead - A write failure occurred leaving mirror out-of-sync
1793 * S => Sync - A sychronization failure occurred, mirror out-of-sync
1794 * R => Read - A read failure occurred, mirror data unaffected
1798 static char device_status_char(struct mirror *m)
1800 if (!atomic_read(&(m->error_count)))
1803 return (test_bit(DM_RAID1_WRITE_ERROR, &(m->error_type))) ? 'D' :
1804 (test_bit(DM_RAID1_SYNC_ERROR, &(m->error_type))) ? 'S' :
1805 (test_bit(DM_RAID1_READ_ERROR, &(m->error_type))) ? 'R' : 'U';
1809 static int mirror_status(struct dm_target *ti, status_type_t type,
1810 char *result, unsigned int maxlen)
1812 unsigned int m, sz = 0;
1813 struct mirror_set *ms = (struct mirror_set *) ti->private;
1814 struct dirty_log *log = ms->rh.log;
1815 char buffer[ms->nr_mirrors + 1];
1818 case STATUSTYPE_INFO:
1819 DMEMIT("%d ", ms->nr_mirrors);
1820 for (m = 0; m < ms->nr_mirrors; m++) {
1821 DMEMIT("%s ", ms->mirror[m].dev->name);
1822 buffer[m] = device_status_char(&(ms->mirror[m]));
1826 DMEMIT("%llu/%llu 1 %s ",
1827 (unsigned long long)log->type->get_sync_count(ms->rh.log),
1828 (unsigned long long)ms->nr_regions, buffer);
1830 sz += log->type->status(ms->rh.log, type, result+sz, maxlen-sz);
1834 case STATUSTYPE_TABLE:
1835 sz = log->type->status(ms->rh.log, type, result, maxlen);
1837 DMEMIT("%d", ms->nr_mirrors);
1838 for (m = 0; m < ms->nr_mirrors; m++)
1839 DMEMIT(" %s %llu", ms->mirror[m].dev->name,
1840 (unsigned long long)ms->mirror[m].offset);
1842 if (ms->features & DM_RAID1_HANDLE_ERRORS)
1843 DMEMIT(" 1 handle_errors");
1849 static struct target_type mirror_target = {
1851 .version = {1, 0, 20},
1852 .module = THIS_MODULE,
1856 .end_io = mirror_end_io,
1857 .presuspend = mirror_presuspend,
1858 .postsuspend = mirror_postsuspend,
1859 .resume = mirror_resume,
1860 .status = mirror_status,
1863 static int __init dm_mirror_init(void)
1867 r = dm_dirty_log_init();
1871 r = dm_register_target(&mirror_target);
1873 DMERR("Failed to register mirror target");
1874 dm_dirty_log_exit();
1880 static void __exit dm_mirror_exit(void)
1884 r = dm_unregister_target(&mirror_target);
1886 DMERR("unregister failed %d", r);
1888 dm_dirty_log_exit();
1892 module_init(dm_mirror_init);
1893 module_exit(dm_mirror_exit);
1895 MODULE_DESCRIPTION(DM_NAME " mirror target");
1896 MODULE_AUTHOR("Joe Thornber");
1897 MODULE_LICENSE("GPL");