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>
17 #define DM_MSG_PREFIX "dirty region log"
19 struct dm_dirty_log_internal
{
20 struct dm_dirty_log_type
*type
;
22 struct list_head list
;
26 static LIST_HEAD(_log_types
);
27 static DEFINE_SPINLOCK(_lock
);
29 static struct dm_dirty_log_internal
*__find_dirty_log_type(const char *name
)
31 struct dm_dirty_log_internal
*log_type
;
33 list_for_each_entry(log_type
, &_log_types
, list
)
34 if (!strcmp(name
, log_type
->type
->name
))
40 static struct dm_dirty_log_internal
*_get_dirty_log_type(const char *name
)
42 struct dm_dirty_log_internal
*log_type
;
46 log_type
= __find_dirty_log_type(name
);
48 if (!log_type
->use
&& !try_module_get(log_type
->type
->module
))
63 * Attempt to retrieve the dm_dirty_log_type by name. If not already
64 * available, attempt to load the appropriate module.
66 * Log modules are named "dm-log-" followed by the 'type_name'.
67 * Modules may contain multiple types.
68 * This function will first try the module "dm-log-<type_name>",
69 * then truncate 'type_name' on the last '-' and try again.
71 * For example, if type_name was "clustered-disk", it would search
72 * 'dm-log-clustered-disk' then 'dm-log-clustered'.
74 * Returns: dirty_log_type* on success, NULL on failure
76 static struct dm_dirty_log_type
*get_type(const char *type_name
)
78 char *p
, *type_name_dup
;
79 struct dm_dirty_log_internal
*log_type
;
84 log_type
= _get_dirty_log_type(type_name
);
86 return log_type
->type
;
88 type_name_dup
= kstrdup(type_name
, GFP_KERNEL
);
90 DMWARN("No memory left to attempt log module load for \"%s\"",
95 while (request_module("dm-log-%s", type_name_dup
) ||
96 !(log_type
= _get_dirty_log_type(type_name
))) {
97 p
= strrchr(type_name_dup
, '-');
104 DMWARN("Module for logging type \"%s\" not found.", type_name
);
106 kfree(type_name_dup
);
108 return log_type
? log_type
->type
: NULL
;
111 static void put_type(struct dm_dirty_log_type
*type
)
113 struct dm_dirty_log_internal
*log_type
;
119 log_type
= __find_dirty_log_type(type
->name
);
123 if (!--log_type
->use
)
124 module_put(type
->module
);
126 BUG_ON(log_type
->use
< 0);
132 static struct dm_dirty_log_internal
*_alloc_dirty_log_type(struct dm_dirty_log_type
*type
)
134 struct dm_dirty_log_internal
*log_type
= kzalloc(sizeof(*log_type
),
138 log_type
->type
= type
;
143 int dm_dirty_log_type_register(struct dm_dirty_log_type
*type
)
145 struct dm_dirty_log_internal
*log_type
= _alloc_dirty_log_type(type
);
152 if (!__find_dirty_log_type(type
->name
))
153 list_add(&log_type
->list
, &_log_types
);
162 EXPORT_SYMBOL(dm_dirty_log_type_register
);
164 int dm_dirty_log_type_unregister(struct dm_dirty_log_type
*type
)
166 struct dm_dirty_log_internal
*log_type
;
170 log_type
= __find_dirty_log_type(type
->name
);
181 list_del(&log_type
->list
);
188 EXPORT_SYMBOL(dm_dirty_log_type_unregister
);
190 struct dm_dirty_log
*dm_dirty_log_create(const char *type_name
,
191 struct dm_target
*ti
,
192 unsigned int argc
, char **argv
)
194 struct dm_dirty_log_type
*type
;
195 struct dm_dirty_log
*log
;
197 log
= kmalloc(sizeof(*log
), GFP_KERNEL
);
201 type
= get_type(type_name
);
208 if (type
->ctr(log
, ti
, argc
, argv
)) {
216 EXPORT_SYMBOL(dm_dirty_log_create
);
218 void dm_dirty_log_destroy(struct dm_dirty_log
*log
)
224 EXPORT_SYMBOL(dm_dirty_log_destroy
);
226 /*-----------------------------------------------------------------
227 * Persistent and core logs share a lot of their implementation.
228 * FIXME: need a reload method to be called from a resume
229 *---------------------------------------------------------------*/
231 * Magic for persistent mirrors: "MiRr"
233 #define MIRROR_MAGIC 0x4D695272
236 * The on-disk version of the metadata.
238 #define MIRROR_DISK_VERSION 2
245 * Simple, incrementing version. no backward
253 struct dm_target
*ti
;
255 uint32_t region_size
;
256 unsigned int region_count
;
259 unsigned bitset_uint32_count
;
260 uint32_t *clean_bits
;
262 uint32_t *recovering_bits
; /* FIXME: this seems excessive */
268 DEFAULTSYNC
, /* Synchronize if necessary */
269 NOSYNC
, /* Devices known to be already in sync */
270 FORCESYNC
, /* Force a sync to happen */
273 struct dm_io_request io_req
;
279 struct dm_dev
*log_dev
;
280 struct log_header header
;
282 struct dm_io_region header_location
;
283 struct log_header
*disk_header
;
287 * The touched member needs to be updated every time we access
288 * one of the bitsets.
290 static inline int log_test_bit(uint32_t *bs
, unsigned bit
)
292 return ext2_test_bit(bit
, (unsigned long *) bs
) ? 1 : 0;
295 static inline void log_set_bit(struct log_c
*l
,
296 uint32_t *bs
, unsigned bit
)
298 ext2_set_bit(bit
, (unsigned long *) bs
);
302 static inline void log_clear_bit(struct log_c
*l
,
303 uint32_t *bs
, unsigned bit
)
305 ext2_clear_bit(bit
, (unsigned long *) bs
);
309 /*----------------------------------------------------------------
311 *--------------------------------------------------------------*/
312 static void header_to_disk(struct log_header
*core
, struct log_header
*disk
)
314 disk
->magic
= cpu_to_le32(core
->magic
);
315 disk
->version
= cpu_to_le32(core
->version
);
316 disk
->nr_regions
= cpu_to_le64(core
->nr_regions
);
319 static void header_from_disk(struct log_header
*core
, struct log_header
*disk
)
321 core
->magic
= le32_to_cpu(disk
->magic
);
322 core
->version
= le32_to_cpu(disk
->version
);
323 core
->nr_regions
= le64_to_cpu(disk
->nr_regions
);
326 static int rw_header(struct log_c
*lc
, int rw
)
328 lc
->io_req
.bi_rw
= rw
;
329 lc
->io_req
.mem
.ptr
.vma
= lc
->disk_header
;
330 lc
->io_req
.notify
.fn
= NULL
;
332 return dm_io(&lc
->io_req
, 1, &lc
->header_location
, NULL
);
335 static int read_header(struct log_c
*log
)
339 r
= rw_header(log
, READ
);
343 header_from_disk(&log
->header
, log
->disk_header
);
345 /* New log required? */
346 if (log
->sync
!= DEFAULTSYNC
|| log
->header
.magic
!= MIRROR_MAGIC
) {
347 log
->header
.magic
= MIRROR_MAGIC
;
348 log
->header
.version
= MIRROR_DISK_VERSION
;
349 log
->header
.nr_regions
= 0;
352 #ifdef __LITTLE_ENDIAN
353 if (log
->header
.version
== 1)
354 log
->header
.version
= 2;
357 if (log
->header
.version
!= MIRROR_DISK_VERSION
) {
358 DMWARN("incompatible disk log version");
365 static inline int write_header(struct log_c
*log
)
367 header_to_disk(&log
->header
, log
->disk_header
);
368 return rw_header(log
, WRITE
);
371 /*----------------------------------------------------------------
372 * core log constructor/destructor
374 * argv contains region_size followed optionally by [no]sync
375 *--------------------------------------------------------------*/
377 static int create_log_context(struct dm_dirty_log
*log
, struct dm_target
*ti
,
378 unsigned int argc
, char **argv
,
381 enum sync sync
= DEFAULTSYNC
;
384 uint32_t region_size
;
385 unsigned int region_count
;
386 size_t bitset_size
, buf_size
;
389 if (argc
< 1 || argc
> 2) {
390 DMWARN("wrong number of arguments to dirty region log");
395 if (!strcmp(argv
[1], "sync"))
397 else if (!strcmp(argv
[1], "nosync"))
400 DMWARN("unrecognised sync argument to "
401 "dirty region log: %s", argv
[1]);
406 if (sscanf(argv
[0], "%u", ®ion_size
) != 1) {
407 DMWARN("invalid region size string");
411 region_count
= dm_sector_div_up(ti
->len
, region_size
);
413 lc
= kmalloc(sizeof(*lc
), GFP_KERNEL
);
415 DMWARN("couldn't allocate core log");
421 lc
->region_size
= region_size
;
422 lc
->region_count
= region_count
;
426 * Work out how many "unsigned long"s we need to hold the bitset.
428 bitset_size
= dm_round_up(region_count
,
429 sizeof(*lc
->clean_bits
) << BYTE_SHIFT
);
430 bitset_size
>>= BYTE_SHIFT
;
432 lc
->bitset_uint32_count
= bitset_size
/ sizeof(*lc
->clean_bits
);
438 lc
->clean_bits
= vmalloc(bitset_size
);
439 if (!lc
->clean_bits
) {
440 DMWARN("couldn't allocate clean bitset");
444 lc
->disk_header
= NULL
;
447 lc
->log_dev_failed
= 0;
448 lc
->header_location
.bdev
= lc
->log_dev
->bdev
;
449 lc
->header_location
.sector
= 0;
452 * Buffer holds both header and bitset.
454 buf_size
= dm_round_up((LOG_OFFSET
<< SECTOR_SHIFT
) +
455 bitset_size
, ti
->limits
.hardsect_size
);
456 lc
->header_location
.count
= buf_size
>> SECTOR_SHIFT
;
457 lc
->io_req
.mem
.type
= DM_IO_VMA
;
458 lc
->io_req
.client
= dm_io_client_create(dm_div_up(buf_size
,
460 if (IS_ERR(lc
->io_req
.client
)) {
461 r
= PTR_ERR(lc
->io_req
.client
);
462 DMWARN("couldn't allocate disk io client");
467 lc
->disk_header
= vmalloc(buf_size
);
468 if (!lc
->disk_header
) {
469 DMWARN("couldn't allocate disk log buffer");
470 dm_io_client_destroy(lc
->io_req
.client
);
475 lc
->clean_bits
= (void *)lc
->disk_header
+
476 (LOG_OFFSET
<< SECTOR_SHIFT
);
479 memset(lc
->clean_bits
, -1, bitset_size
);
481 lc
->sync_bits
= vmalloc(bitset_size
);
482 if (!lc
->sync_bits
) {
483 DMWARN("couldn't allocate sync bitset");
485 vfree(lc
->clean_bits
);
487 dm_io_client_destroy(lc
->io_req
.client
);
488 vfree(lc
->disk_header
);
492 memset(lc
->sync_bits
, (sync
== NOSYNC
) ? -1 : 0, bitset_size
);
493 lc
->sync_count
= (sync
== NOSYNC
) ? region_count
: 0;
495 lc
->recovering_bits
= vmalloc(bitset_size
);
496 if (!lc
->recovering_bits
) {
497 DMWARN("couldn't allocate sync bitset");
498 vfree(lc
->sync_bits
);
500 vfree(lc
->clean_bits
);
502 dm_io_client_destroy(lc
->io_req
.client
);
503 vfree(lc
->disk_header
);
507 memset(lc
->recovering_bits
, 0, bitset_size
);
514 static int core_ctr(struct dm_dirty_log
*log
, struct dm_target
*ti
,
515 unsigned int argc
, char **argv
)
517 return create_log_context(log
, ti
, argc
, argv
, NULL
);
520 static void destroy_log_context(struct log_c
*lc
)
522 vfree(lc
->sync_bits
);
523 vfree(lc
->recovering_bits
);
527 static void core_dtr(struct dm_dirty_log
*log
)
529 struct log_c
*lc
= (struct log_c
*) log
->context
;
531 vfree(lc
->clean_bits
);
532 destroy_log_context(lc
);
535 /*----------------------------------------------------------------
536 * disk log constructor/destructor
538 * argv contains log_device region_size followed optionally by [no]sync
539 *--------------------------------------------------------------*/
540 static int disk_ctr(struct dm_dirty_log
*log
, struct dm_target
*ti
,
541 unsigned int argc
, char **argv
)
546 if (argc
< 2 || argc
> 3) {
547 DMWARN("wrong number of arguments to disk dirty region log");
551 r
= dm_get_device(ti
, argv
[0], 0, 0 /* FIXME */,
552 FMODE_READ
| FMODE_WRITE
, &dev
);
556 r
= create_log_context(log
, ti
, argc
- 1, argv
+ 1, dev
);
558 dm_put_device(ti
, dev
);
565 static void disk_dtr(struct dm_dirty_log
*log
)
567 struct log_c
*lc
= (struct log_c
*) log
->context
;
569 dm_put_device(lc
->ti
, lc
->log_dev
);
570 vfree(lc
->disk_header
);
571 dm_io_client_destroy(lc
->io_req
.client
);
572 destroy_log_context(lc
);
575 static int count_bits32(uint32_t *addr
, unsigned size
)
579 for (i
= 0; i
< size
; i
++) {
580 count
+= hweight32(*(addr
+i
));
585 static void fail_log_device(struct log_c
*lc
)
587 if (lc
->log_dev_failed
)
590 lc
->log_dev_failed
= 1;
591 dm_table_event(lc
->ti
->table
);
594 static int disk_resume(struct dm_dirty_log
*log
)
598 struct log_c
*lc
= (struct log_c
*) log
->context
;
599 size_t size
= lc
->bitset_uint32_count
* sizeof(uint32_t);
601 /* read the disk header */
604 DMWARN("%s: Failed to read header on dirty region log device",
608 * If the log device cannot be read, we must assume
609 * all regions are out-of-sync. If we simply return
610 * here, the state will be uninitialized and could
611 * lead us to return 'in-sync' status for regions
612 * that are actually 'out-of-sync'.
614 lc
->header
.nr_regions
= 0;
617 /* set or clear any new bits -- device has grown */
618 if (lc
->sync
== NOSYNC
)
619 for (i
= lc
->header
.nr_regions
; i
< lc
->region_count
; i
++)
620 /* FIXME: amazingly inefficient */
621 log_set_bit(lc
, lc
->clean_bits
, i
);
623 for (i
= lc
->header
.nr_regions
; i
< lc
->region_count
; i
++)
624 /* FIXME: amazingly inefficient */
625 log_clear_bit(lc
, lc
->clean_bits
, i
);
627 /* clear any old bits -- device has shrunk */
628 for (i
= lc
->region_count
; i
% (sizeof(*lc
->clean_bits
) << BYTE_SHIFT
); i
++)
629 log_clear_bit(lc
, lc
->clean_bits
, i
);
631 /* copy clean across to sync */
632 memcpy(lc
->sync_bits
, lc
->clean_bits
, size
);
633 lc
->sync_count
= count_bits32(lc
->clean_bits
, lc
->bitset_uint32_count
);
636 /* set the correct number of regions in the header */
637 lc
->header
.nr_regions
= lc
->region_count
;
639 /* write the new header */
640 r
= write_header(lc
);
642 DMWARN("%s: Failed to write header on dirty region log device",
650 static uint32_t core_get_region_size(struct dm_dirty_log
*log
)
652 struct log_c
*lc
= (struct log_c
*) log
->context
;
653 return lc
->region_size
;
656 static int core_resume(struct dm_dirty_log
*log
)
658 struct log_c
*lc
= (struct log_c
*) log
->context
;
663 static int core_is_clean(struct dm_dirty_log
*log
, region_t region
)
665 struct log_c
*lc
= (struct log_c
*) log
->context
;
666 return log_test_bit(lc
->clean_bits
, region
);
669 static int core_in_sync(struct dm_dirty_log
*log
, region_t region
, int block
)
671 struct log_c
*lc
= (struct log_c
*) log
->context
;
672 return log_test_bit(lc
->sync_bits
, region
);
675 static int core_flush(struct dm_dirty_log
*log
)
681 static int disk_flush(struct dm_dirty_log
*log
)
684 struct log_c
*lc
= (struct log_c
*) log
->context
;
686 /* only write if the log has changed */
690 r
= write_header(lc
);
699 static void core_mark_region(struct dm_dirty_log
*log
, region_t region
)
701 struct log_c
*lc
= (struct log_c
*) log
->context
;
702 log_clear_bit(lc
, lc
->clean_bits
, region
);
705 static void core_clear_region(struct dm_dirty_log
*log
, region_t region
)
707 struct log_c
*lc
= (struct log_c
*) log
->context
;
708 log_set_bit(lc
, lc
->clean_bits
, region
);
711 static int core_get_resync_work(struct dm_dirty_log
*log
, region_t
*region
)
713 struct log_c
*lc
= (struct log_c
*) log
->context
;
715 if (lc
->sync_search
>= lc
->region_count
)
719 *region
= ext2_find_next_zero_bit(
720 (unsigned long *) lc
->sync_bits
,
723 lc
->sync_search
= *region
+ 1;
725 if (*region
>= lc
->region_count
)
728 } while (log_test_bit(lc
->recovering_bits
, *region
));
730 log_set_bit(lc
, lc
->recovering_bits
, *region
);
734 static void core_set_region_sync(struct dm_dirty_log
*log
, region_t region
,
737 struct log_c
*lc
= (struct log_c
*) log
->context
;
739 log_clear_bit(lc
, lc
->recovering_bits
, region
);
741 log_set_bit(lc
, lc
->sync_bits
, region
);
743 } else if (log_test_bit(lc
->sync_bits
, region
)) {
745 log_clear_bit(lc
, lc
->sync_bits
, region
);
749 static region_t
core_get_sync_count(struct dm_dirty_log
*log
)
751 struct log_c
*lc
= (struct log_c
*) log
->context
;
753 return lc
->sync_count
;
756 #define DMEMIT_SYNC \
757 if (lc->sync != DEFAULTSYNC) \
758 DMEMIT("%ssync ", lc->sync == NOSYNC ? "no" : "")
760 static int core_status(struct dm_dirty_log
*log
, status_type_t status
,
761 char *result
, unsigned int maxlen
)
764 struct log_c
*lc
= log
->context
;
767 case STATUSTYPE_INFO
:
768 DMEMIT("1 %s", log
->type
->name
);
771 case STATUSTYPE_TABLE
:
772 DMEMIT("%s %u %u ", log
->type
->name
,
773 lc
->sync
== DEFAULTSYNC
? 1 : 2, lc
->region_size
);
780 static int disk_status(struct dm_dirty_log
*log
, status_type_t status
,
781 char *result
, unsigned int maxlen
)
784 struct log_c
*lc
= log
->context
;
787 case STATUSTYPE_INFO
:
788 DMEMIT("3 %s %s %c", log
->type
->name
, lc
->log_dev
->name
,
789 lc
->log_dev_failed
? 'D' : 'A');
792 case STATUSTYPE_TABLE
:
793 DMEMIT("%s %u %s %u ", log
->type
->name
,
794 lc
->sync
== DEFAULTSYNC
? 2 : 3, lc
->log_dev
->name
,
802 static struct dm_dirty_log_type _core_type
= {
804 .module
= THIS_MODULE
,
807 .resume
= core_resume
,
808 .get_region_size
= core_get_region_size
,
809 .is_clean
= core_is_clean
,
810 .in_sync
= core_in_sync
,
812 .mark_region
= core_mark_region
,
813 .clear_region
= core_clear_region
,
814 .get_resync_work
= core_get_resync_work
,
815 .set_region_sync
= core_set_region_sync
,
816 .get_sync_count
= core_get_sync_count
,
817 .status
= core_status
,
820 static struct dm_dirty_log_type _disk_type
= {
822 .module
= THIS_MODULE
,
825 .postsuspend
= disk_flush
,
826 .resume
= disk_resume
,
827 .get_region_size
= core_get_region_size
,
828 .is_clean
= core_is_clean
,
829 .in_sync
= core_in_sync
,
831 .mark_region
= core_mark_region
,
832 .clear_region
= core_clear_region
,
833 .get_resync_work
= core_get_resync_work
,
834 .set_region_sync
= core_set_region_sync
,
835 .get_sync_count
= core_get_sync_count
,
836 .status
= disk_status
,
839 static int __init
dm_dirty_log_init(void)
843 r
= dm_dirty_log_type_register(&_core_type
);
845 DMWARN("couldn't register core log");
847 r
= dm_dirty_log_type_register(&_disk_type
);
849 DMWARN("couldn't register disk type");
850 dm_dirty_log_type_unregister(&_core_type
);
856 static void __exit
dm_dirty_log_exit(void)
858 dm_dirty_log_type_unregister(&_disk_type
);
859 dm_dirty_log_type_unregister(&_core_type
);
862 module_init(dm_dirty_log_init
);
863 module_exit(dm_dirty_log_exit
);
865 MODULE_DESCRIPTION(DM_NAME
" dirty region log");
866 MODULE_AUTHOR("Joe Thornber, Heinz Mauelshagen <dm-devel@redhat.com>");
867 MODULE_LICENSE("GPL");