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