2 * Copyright (C) 2003 Sistina Software
3 * Copyright (C) 2004-2008 Red Hat, Inc. All rights reserved.
5 * This file is released under the LGPL.
8 #include <linux/init.h>
9 #include <linux/slab.h>
10 #include <linux/module.h>
11 #include <linux/vmalloc.h>
12 #include <linux/dm-io.h>
13 #include <linux/dm-dirty-log.h>
15 #include <linux/device-mapper.h>
17 #define DM_MSG_PREFIX "dirty region log"
19 static LIST_HEAD(_log_types
);
20 static DEFINE_SPINLOCK(_lock
);
22 static struct dm_dirty_log_type
*__find_dirty_log_type(const char *name
)
24 struct dm_dirty_log_type
*log_type
;
26 list_for_each_entry(log_type
, &_log_types
, list
)
27 if (!strcmp(name
, log_type
->name
))
33 static struct dm_dirty_log_type
*_get_dirty_log_type(const char *name
)
35 struct dm_dirty_log_type
*log_type
;
39 log_type
= __find_dirty_log_type(name
);
40 if (log_type
&& !try_module_get(log_type
->module
))
52 * Attempt to retrieve the dm_dirty_log_type by name. If not already
53 * available, attempt to load the appropriate module.
55 * Log modules are named "dm-log-" followed by the 'type_name'.
56 * Modules may contain multiple types.
57 * This function will first try the module "dm-log-<type_name>",
58 * then truncate 'type_name' on the last '-' and try again.
60 * For example, if type_name was "clustered-disk", it would search
61 * 'dm-log-clustered-disk' then 'dm-log-clustered'.
63 * Returns: dirty_log_type* on success, NULL on failure
65 static struct dm_dirty_log_type
*get_type(const char *type_name
)
67 char *p
, *type_name_dup
;
68 struct dm_dirty_log_type
*log_type
;
73 log_type
= _get_dirty_log_type(type_name
);
77 type_name_dup
= kstrdup(type_name
, GFP_KERNEL
);
79 DMWARN("No memory left to attempt log module load for \"%s\"",
84 while (request_module("dm-log-%s", type_name_dup
) ||
85 !(log_type
= _get_dirty_log_type(type_name
))) {
86 p
= strrchr(type_name_dup
, '-');
93 DMWARN("Module for logging type \"%s\" not found.", type_name
);
100 static void put_type(struct dm_dirty_log_type
*type
)
106 if (!__find_dirty_log_type(type
->name
))
109 module_put(type
->module
);
115 int dm_dirty_log_type_register(struct dm_dirty_log_type
*type
)
120 if (!__find_dirty_log_type(type
->name
))
121 list_add(&type
->list
, &_log_types
);
128 EXPORT_SYMBOL(dm_dirty_log_type_register
);
130 int dm_dirty_log_type_unregister(struct dm_dirty_log_type
*type
)
134 if (!__find_dirty_log_type(type
->name
)) {
139 list_del(&type
->list
);
145 EXPORT_SYMBOL(dm_dirty_log_type_unregister
);
147 struct dm_dirty_log
*dm_dirty_log_create(const char *type_name
,
148 struct dm_target
*ti
,
149 int (*flush_callback_fn
)(struct dm_target
*ti
),
150 unsigned int argc
, char **argv
)
152 struct dm_dirty_log_type
*type
;
153 struct dm_dirty_log
*log
;
155 log
= kmalloc(sizeof(*log
), GFP_KERNEL
);
159 type
= get_type(type_name
);
165 log
->flush_callback_fn
= flush_callback_fn
;
167 if (type
->ctr(log
, ti
, argc
, argv
)) {
175 EXPORT_SYMBOL(dm_dirty_log_create
);
177 void dm_dirty_log_destroy(struct dm_dirty_log
*log
)
183 EXPORT_SYMBOL(dm_dirty_log_destroy
);
186 * Magic for persistent mirrors: "MiRr"
188 #define MIRROR_MAGIC 0x4D695272
191 * The on-disk version of the metadata.
193 #define MIRROR_DISK_VERSION 2
200 * Simple, incrementing version. no backward
208 struct dm_target
*ti
;
212 uint32_t region_size
;
213 unsigned int region_count
;
216 unsigned bitset_uint32_count
;
217 uint32_t *clean_bits
;
219 uint32_t *recovering_bits
;
225 DEFAULTSYNC
, /* Synchronize if necessary */
226 NOSYNC
, /* Devices known to be already in sync */
227 FORCESYNC
, /* Force a sync to happen */
230 struct dm_io_request io_req
;
236 int log_dev_flush_failed
;
237 struct dm_dev
*log_dev
;
238 struct log_header header
;
240 struct dm_io_region header_location
;
241 struct log_header
*disk_header
;
245 * The touched member needs to be updated every time we access
246 * one of the bitsets.
248 static inline int log_test_bit(uint32_t *bs
, unsigned bit
)
250 return ext2_test_bit(bit
, (unsigned long *) bs
) ? 1 : 0;
253 static inline void log_set_bit(struct log_c
*l
,
254 uint32_t *bs
, unsigned bit
)
256 ext2_set_bit(bit
, (unsigned long *) bs
);
257 l
->touched_cleaned
= 1;
260 static inline void log_clear_bit(struct log_c
*l
,
261 uint32_t *bs
, unsigned bit
)
263 ext2_clear_bit(bit
, (unsigned long *) bs
);
264 l
->touched_dirtied
= 1;
267 /*----------------------------------------------------------------
269 *--------------------------------------------------------------*/
270 static void header_to_disk(struct log_header
*core
, struct log_header
*disk
)
272 disk
->magic
= cpu_to_le32(core
->magic
);
273 disk
->version
= cpu_to_le32(core
->version
);
274 disk
->nr_regions
= cpu_to_le64(core
->nr_regions
);
277 static void header_from_disk(struct log_header
*core
, struct log_header
*disk
)
279 core
->magic
= le32_to_cpu(disk
->magic
);
280 core
->version
= le32_to_cpu(disk
->version
);
281 core
->nr_regions
= le64_to_cpu(disk
->nr_regions
);
284 static int rw_header(struct log_c
*lc
, int rw
)
286 lc
->io_req
.bi_rw
= rw
;
288 return dm_io(&lc
->io_req
, 1, &lc
->header_location
, NULL
);
291 static int flush_header(struct log_c
*lc
)
293 struct dm_io_region null_location
= {
294 .bdev
= lc
->header_location
.bdev
,
299 lc
->io_req
.bi_rw
= WRITE_BARRIER
;
301 return dm_io(&lc
->io_req
, 1, &null_location
, NULL
);
304 static int read_header(struct log_c
*log
)
308 r
= rw_header(log
, READ
);
312 header_from_disk(&log
->header
, log
->disk_header
);
314 /* New log required? */
315 if (log
->sync
!= DEFAULTSYNC
|| log
->header
.magic
!= MIRROR_MAGIC
) {
316 log
->header
.magic
= MIRROR_MAGIC
;
317 log
->header
.version
= MIRROR_DISK_VERSION
;
318 log
->header
.nr_regions
= 0;
321 #ifdef __LITTLE_ENDIAN
322 if (log
->header
.version
== 1)
323 log
->header
.version
= 2;
326 if (log
->header
.version
!= MIRROR_DISK_VERSION
) {
327 DMWARN("incompatible disk log version");
334 static int _check_region_size(struct dm_target
*ti
, uint32_t region_size
)
336 if (region_size
< 2 || region_size
> ti
->len
)
339 if (!is_power_of_2(region_size
))
345 /*----------------------------------------------------------------
346 * core log constructor/destructor
348 * argv contains region_size followed optionally by [no]sync
349 *--------------------------------------------------------------*/
351 static int create_log_context(struct dm_dirty_log
*log
, struct dm_target
*ti
,
352 unsigned int argc
, char **argv
,
355 enum sync sync
= DEFAULTSYNC
;
358 uint32_t region_size
;
359 unsigned int region_count
;
360 size_t bitset_size
, buf_size
;
363 if (argc
< 1 || argc
> 2) {
364 DMWARN("wrong number of arguments to dirty region log");
369 if (!strcmp(argv
[1], "sync"))
371 else if (!strcmp(argv
[1], "nosync"))
374 DMWARN("unrecognised sync argument to "
375 "dirty region log: %s", argv
[1]);
380 if (sscanf(argv
[0], "%u", ®ion_size
) != 1 ||
381 !_check_region_size(ti
, region_size
)) {
382 DMWARN("invalid region size %s", argv
[0]);
386 region_count
= dm_sector_div_up(ti
->len
, region_size
);
388 lc
= kmalloc(sizeof(*lc
), GFP_KERNEL
);
390 DMWARN("couldn't allocate core log");
395 lc
->touched_dirtied
= 0;
396 lc
->touched_cleaned
= 0;
397 lc
->flush_failed
= 0;
398 lc
->region_size
= region_size
;
399 lc
->region_count
= region_count
;
403 * Work out how many "unsigned long"s we need to hold the bitset.
405 bitset_size
= dm_round_up(region_count
,
406 sizeof(*lc
->clean_bits
) << BYTE_SHIFT
);
407 bitset_size
>>= BYTE_SHIFT
;
409 lc
->bitset_uint32_count
= bitset_size
/ sizeof(*lc
->clean_bits
);
415 lc
->clean_bits
= vmalloc(bitset_size
);
416 if (!lc
->clean_bits
) {
417 DMWARN("couldn't allocate clean bitset");
421 lc
->disk_header
= NULL
;
424 lc
->log_dev_failed
= 0;
425 lc
->log_dev_flush_failed
= 0;
426 lc
->header_location
.bdev
= lc
->log_dev
->bdev
;
427 lc
->header_location
.sector
= 0;
430 * Buffer holds both header and bitset.
433 dm_round_up((LOG_OFFSET
<< SECTOR_SHIFT
) + bitset_size
,
434 bdev_logical_block_size(lc
->header_location
.
437 if (buf_size
> i_size_read(dev
->bdev
->bd_inode
)) {
438 DMWARN("log device %s too small: need %llu bytes",
439 dev
->name
, (unsigned long long)buf_size
);
444 lc
->header_location
.count
= buf_size
>> SECTOR_SHIFT
;
446 lc
->io_req
.mem
.type
= DM_IO_VMA
;
447 lc
->io_req
.notify
.fn
= NULL
;
448 lc
->io_req
.client
= dm_io_client_create(dm_div_up(buf_size
,
450 if (IS_ERR(lc
->io_req
.client
)) {
451 r
= PTR_ERR(lc
->io_req
.client
);
452 DMWARN("couldn't allocate disk io client");
457 lc
->disk_header
= vmalloc(buf_size
);
458 if (!lc
->disk_header
) {
459 DMWARN("couldn't allocate disk log buffer");
460 dm_io_client_destroy(lc
->io_req
.client
);
465 lc
->io_req
.mem
.ptr
.vma
= lc
->disk_header
;
466 lc
->clean_bits
= (void *)lc
->disk_header
+
467 (LOG_OFFSET
<< SECTOR_SHIFT
);
470 memset(lc
->clean_bits
, -1, bitset_size
);
472 lc
->sync_bits
= vmalloc(bitset_size
);
473 if (!lc
->sync_bits
) {
474 DMWARN("couldn't allocate sync bitset");
476 vfree(lc
->clean_bits
);
478 dm_io_client_destroy(lc
->io_req
.client
);
479 vfree(lc
->disk_header
);
483 memset(lc
->sync_bits
, (sync
== NOSYNC
) ? -1 : 0, bitset_size
);
484 lc
->sync_count
= (sync
== NOSYNC
) ? region_count
: 0;
486 lc
->recovering_bits
= vmalloc(bitset_size
);
487 if (!lc
->recovering_bits
) {
488 DMWARN("couldn't allocate sync bitset");
489 vfree(lc
->sync_bits
);
491 vfree(lc
->clean_bits
);
493 dm_io_client_destroy(lc
->io_req
.client
);
494 vfree(lc
->disk_header
);
498 memset(lc
->recovering_bits
, 0, bitset_size
);
505 static int core_ctr(struct dm_dirty_log
*log
, struct dm_target
*ti
,
506 unsigned int argc
, char **argv
)
508 return create_log_context(log
, ti
, argc
, argv
, NULL
);
511 static void destroy_log_context(struct log_c
*lc
)
513 vfree(lc
->sync_bits
);
514 vfree(lc
->recovering_bits
);
518 static void core_dtr(struct dm_dirty_log
*log
)
520 struct log_c
*lc
= (struct log_c
*) log
->context
;
522 vfree(lc
->clean_bits
);
523 destroy_log_context(lc
);
526 /*----------------------------------------------------------------
527 * disk log constructor/destructor
529 * argv contains log_device region_size followed optionally by [no]sync
530 *--------------------------------------------------------------*/
531 static int disk_ctr(struct dm_dirty_log
*log
, struct dm_target
*ti
,
532 unsigned int argc
, char **argv
)
537 if (argc
< 2 || argc
> 3) {
538 DMWARN("wrong number of arguments to disk dirty region log");
542 r
= dm_get_device(ti
, argv
[0], FMODE_READ
| FMODE_WRITE
, &dev
);
546 r
= create_log_context(log
, ti
, argc
- 1, argv
+ 1, dev
);
548 dm_put_device(ti
, dev
);
555 static void disk_dtr(struct dm_dirty_log
*log
)
557 struct log_c
*lc
= (struct log_c
*) log
->context
;
559 dm_put_device(lc
->ti
, lc
->log_dev
);
560 vfree(lc
->disk_header
);
561 dm_io_client_destroy(lc
->io_req
.client
);
562 destroy_log_context(lc
);
565 static int count_bits32(uint32_t *addr
, unsigned size
)
569 for (i
= 0; i
< size
; i
++) {
570 count
+= hweight32(*(addr
+i
));
575 static void fail_log_device(struct log_c
*lc
)
577 if (lc
->log_dev_failed
)
580 lc
->log_dev_failed
= 1;
581 dm_table_event(lc
->ti
->table
);
584 static int disk_resume(struct dm_dirty_log
*log
)
588 struct log_c
*lc
= (struct log_c
*) log
->context
;
589 size_t size
= lc
->bitset_uint32_count
* sizeof(uint32_t);
591 /* read the disk header */
594 DMWARN("%s: Failed to read header on dirty region log device",
598 * If the log device cannot be read, we must assume
599 * all regions are out-of-sync. If we simply return
600 * here, the state will be uninitialized and could
601 * lead us to return 'in-sync' status for regions
602 * that are actually 'out-of-sync'.
604 lc
->header
.nr_regions
= 0;
607 /* set or clear any new bits -- device has grown */
608 if (lc
->sync
== NOSYNC
)
609 for (i
= lc
->header
.nr_regions
; i
< lc
->region_count
; i
++)
610 log_set_bit(lc
, lc
->clean_bits
, i
);
612 for (i
= lc
->header
.nr_regions
; i
< lc
->region_count
; i
++)
613 log_clear_bit(lc
, lc
->clean_bits
, i
);
615 /* clear any old bits -- device has shrunk */
616 for (i
= lc
->region_count
; i
% (sizeof(*lc
->clean_bits
) << BYTE_SHIFT
); i
++)
617 log_clear_bit(lc
, lc
->clean_bits
, i
);
619 /* copy clean across to sync */
620 memcpy(lc
->sync_bits
, lc
->clean_bits
, size
);
621 lc
->sync_count
= count_bits32(lc
->clean_bits
, lc
->bitset_uint32_count
);
624 /* set the correct number of regions in the header */
625 lc
->header
.nr_regions
= lc
->region_count
;
627 header_to_disk(&lc
->header
, lc
->disk_header
);
629 /* write the new header */
630 r
= rw_header(lc
, WRITE
);
632 r
= flush_header(lc
);
634 lc
->log_dev_flush_failed
= 1;
637 DMWARN("%s: Failed to write header on dirty region log device",
645 static uint32_t core_get_region_size(struct dm_dirty_log
*log
)
647 struct log_c
*lc
= (struct log_c
*) log
->context
;
648 return lc
->region_size
;
651 static int core_resume(struct dm_dirty_log
*log
)
653 struct log_c
*lc
= (struct log_c
*) log
->context
;
658 static int core_is_clean(struct dm_dirty_log
*log
, region_t region
)
660 struct log_c
*lc
= (struct log_c
*) log
->context
;
661 return log_test_bit(lc
->clean_bits
, region
);
664 static int core_in_sync(struct dm_dirty_log
*log
, region_t region
, int block
)
666 struct log_c
*lc
= (struct log_c
*) log
->context
;
667 return log_test_bit(lc
->sync_bits
, region
);
670 static int core_flush(struct dm_dirty_log
*log
)
676 static int disk_flush(struct dm_dirty_log
*log
)
679 struct log_c
*lc
= log
->context
;
681 /* only write if the log has changed */
682 if (!lc
->touched_cleaned
&& !lc
->touched_dirtied
)
685 if (lc
->touched_cleaned
&& log
->flush_callback_fn
&&
686 log
->flush_callback_fn(lc
->ti
)) {
688 * At this point it is impossible to determine which
689 * regions are clean and which are dirty (without
690 * re-reading the log off disk). So mark all of them
693 lc
->flush_failed
= 1;
694 for (i
= 0; i
< lc
->region_count
; i
++)
695 log_clear_bit(lc
, lc
->clean_bits
, i
);
698 r
= rw_header(lc
, WRITE
);
702 if (lc
->touched_dirtied
) {
703 r
= flush_header(lc
);
705 lc
->log_dev_flush_failed
= 1;
708 lc
->touched_dirtied
= 0;
710 lc
->touched_cleaned
= 0;
716 static void core_mark_region(struct dm_dirty_log
*log
, region_t region
)
718 struct log_c
*lc
= (struct log_c
*) log
->context
;
719 log_clear_bit(lc
, lc
->clean_bits
, region
);
722 static void core_clear_region(struct dm_dirty_log
*log
, region_t region
)
724 struct log_c
*lc
= (struct log_c
*) log
->context
;
725 if (likely(!lc
->flush_failed
))
726 log_set_bit(lc
, lc
->clean_bits
, region
);
729 static int core_get_resync_work(struct dm_dirty_log
*log
, region_t
*region
)
731 struct log_c
*lc
= (struct log_c
*) log
->context
;
733 if (lc
->sync_search
>= lc
->region_count
)
737 *region
= ext2_find_next_zero_bit(
738 (unsigned long *) lc
->sync_bits
,
741 lc
->sync_search
= *region
+ 1;
743 if (*region
>= lc
->region_count
)
746 } while (log_test_bit(lc
->recovering_bits
, *region
));
748 log_set_bit(lc
, lc
->recovering_bits
, *region
);
752 static void core_set_region_sync(struct dm_dirty_log
*log
, region_t region
,
755 struct log_c
*lc
= (struct log_c
*) log
->context
;
757 log_clear_bit(lc
, lc
->recovering_bits
, region
);
759 log_set_bit(lc
, lc
->sync_bits
, region
);
761 } else if (log_test_bit(lc
->sync_bits
, region
)) {
763 log_clear_bit(lc
, lc
->sync_bits
, region
);
767 static region_t
core_get_sync_count(struct dm_dirty_log
*log
)
769 struct log_c
*lc
= (struct log_c
*) log
->context
;
771 return lc
->sync_count
;
774 #define DMEMIT_SYNC \
775 if (lc->sync != DEFAULTSYNC) \
776 DMEMIT("%ssync ", lc->sync == NOSYNC ? "no" : "")
778 static int core_status(struct dm_dirty_log
*log
, status_type_t status
,
779 char *result
, unsigned int maxlen
)
782 struct log_c
*lc
= log
->context
;
785 case STATUSTYPE_INFO
:
786 DMEMIT("1 %s", log
->type
->name
);
789 case STATUSTYPE_TABLE
:
790 DMEMIT("%s %u %u ", log
->type
->name
,
791 lc
->sync
== DEFAULTSYNC
? 1 : 2, lc
->region_size
);
798 static int disk_status(struct dm_dirty_log
*log
, status_type_t status
,
799 char *result
, unsigned int maxlen
)
802 struct log_c
*lc
= log
->context
;
805 case STATUSTYPE_INFO
:
806 DMEMIT("3 %s %s %c", log
->type
->name
, lc
->log_dev
->name
,
807 lc
->log_dev_flush_failed
? 'F' :
808 lc
->log_dev_failed
? 'D' :
812 case STATUSTYPE_TABLE
:
813 DMEMIT("%s %u %s %u ", log
->type
->name
,
814 lc
->sync
== DEFAULTSYNC
? 2 : 3, lc
->log_dev
->name
,
822 static struct dm_dirty_log_type _core_type
= {
824 .module
= THIS_MODULE
,
827 .resume
= core_resume
,
828 .get_region_size
= core_get_region_size
,
829 .is_clean
= core_is_clean
,
830 .in_sync
= core_in_sync
,
832 .mark_region
= core_mark_region
,
833 .clear_region
= core_clear_region
,
834 .get_resync_work
= core_get_resync_work
,
835 .set_region_sync
= core_set_region_sync
,
836 .get_sync_count
= core_get_sync_count
,
837 .status
= core_status
,
840 static struct dm_dirty_log_type _disk_type
= {
842 .module
= THIS_MODULE
,
845 .postsuspend
= disk_flush
,
846 .resume
= disk_resume
,
847 .get_region_size
= core_get_region_size
,
848 .is_clean
= core_is_clean
,
849 .in_sync
= core_in_sync
,
851 .mark_region
= core_mark_region
,
852 .clear_region
= core_clear_region
,
853 .get_resync_work
= core_get_resync_work
,
854 .set_region_sync
= core_set_region_sync
,
855 .get_sync_count
= core_get_sync_count
,
856 .status
= disk_status
,
859 static int __init
dm_dirty_log_init(void)
863 r
= dm_dirty_log_type_register(&_core_type
);
865 DMWARN("couldn't register core log");
867 r
= dm_dirty_log_type_register(&_disk_type
);
869 DMWARN("couldn't register disk type");
870 dm_dirty_log_type_unregister(&_core_type
);
876 static void __exit
dm_dirty_log_exit(void)
878 dm_dirty_log_type_unregister(&_disk_type
);
879 dm_dirty_log_type_unregister(&_core_type
);
882 module_init(dm_dirty_log_init
);
883 module_exit(dm_dirty_log_exit
);
885 MODULE_DESCRIPTION(DM_NAME
" dirty region log");
886 MODULE_AUTHOR("Joe Thornber, Heinz Mauelshagen <dm-devel@redhat.com>");
887 MODULE_LICENSE("GPL");