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