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