2 * bitmap.c two-level bitmap (C) Peter T. Breuer (ptb@ot.uc3m.es) 2003
4 * bitmap_create - sets up the bitmap structure
5 * bitmap_destroy - destroys the bitmap structure
7 * additions, Copyright (C) 2003-2004, Paul Clements, SteelEye Technology, Inc.:
8 * - added disk storage for bitmap
9 * - changes to allow various bitmap chunk sizes
15 * flush after percent set rather than just time based. (maybe both).
16 * wait if count gets too high, wake when it drops to half.
19 #include <linux/module.h>
20 #include <linux/errno.h>
21 #include <linux/slab.h>
22 #include <linux/init.h>
23 #include <linux/timer.h>
24 #include <linux/sched.h>
25 #include <linux/list.h>
26 #include <linux/file.h>
27 #include <linux/mount.h>
28 #include <linux/buffer_head.h>
29 #include <linux/raid/md.h>
30 #include <linux/raid/bitmap.h>
37 /* these are for debugging purposes only! */
39 /* define one and only one of these */
40 #define INJECT_FAULTS_1 0 /* cause bitmap_alloc_page to fail always */
41 #define INJECT_FAULTS_2 0 /* cause bitmap file to be kicked when first bit set*/
42 #define INJECT_FAULTS_3 0 /* treat bitmap file as kicked at init time */
43 #define INJECT_FAULTS_4 0 /* undef */
44 #define INJECT_FAULTS_5 0 /* undef */
45 #define INJECT_FAULTS_6 0
47 /* if these are defined, the driver will fail! debug only */
48 #define INJECT_FATAL_FAULT_1 0 /* fail kmalloc, causing bitmap_create to fail */
49 #define INJECT_FATAL_FAULT_2 0 /* undef */
50 #define INJECT_FATAL_FAULT_3 0 /* undef */
53 //#define DPRINTK PRINTK /* set this NULL to avoid verbose debug output */
54 #define DPRINTK(x...) do { } while(0)
58 # define PRINTK(x...) printk(KERN_DEBUG x)
64 static inline char * bmname(struct bitmap *bitmap)
66 return bitmap->mddev ? mdname(bitmap->mddev) : "mdX";
71 * just a placeholder - calls kmalloc for bitmap pages
73 static unsigned char *bitmap_alloc_page(struct bitmap *bitmap)
77 #ifdef INJECT_FAULTS_1
80 page = kmalloc(PAGE_SIZE, GFP_NOIO);
83 printk("%s: bitmap_alloc_page FAILED\n", bmname(bitmap));
85 PRINTK("%s: bitmap_alloc_page: allocated page at %p\n",
86 bmname(bitmap), page);
91 * for now just a placeholder -- just calls kfree for bitmap pages
93 static void bitmap_free_page(struct bitmap *bitmap, unsigned char *page)
95 PRINTK("%s: bitmap_free_page: free page %p\n", bmname(bitmap), page);
100 * check a page and, if necessary, allocate it (or hijack it if the alloc fails)
102 * 1) check to see if this page is allocated, if it's not then try to alloc
103 * 2) if the alloc fails, set the page's hijacked flag so we'll use the
104 * page pointer directly as a counter
106 * if we find our page, we increment the page's refcount so that it stays
107 * allocated while we're using it
109 static int bitmap_checkpage(struct bitmap *bitmap, unsigned long page, int create)
111 unsigned char *mappage;
113 if (page >= bitmap->pages) {
115 "%s: invalid bitmap page request: %lu (> %lu)\n",
116 bmname(bitmap), page, bitmap->pages-1);
121 if (bitmap->bp[page].hijacked) /* it's hijacked, don't try to alloc */
124 if (bitmap->bp[page].map) /* page is already allocated, just return */
130 spin_unlock_irq(&bitmap->lock);
132 /* this page has not been allocated yet */
134 if ((mappage = bitmap_alloc_page(bitmap)) == NULL) {
135 PRINTK("%s: bitmap map page allocation failed, hijacking\n",
137 /* failed - set the hijacked flag so that we can use the
138 * pointer as a counter */
139 spin_lock_irq(&bitmap->lock);
140 if (!bitmap->bp[page].map)
141 bitmap->bp[page].hijacked = 1;
147 spin_lock_irq(&bitmap->lock);
149 /* recheck the page */
151 if (bitmap->bp[page].map || bitmap->bp[page].hijacked) {
152 /* somebody beat us to getting the page */
153 bitmap_free_page(bitmap, mappage);
157 /* no page was in place and we have one, so install it */
159 memset(mappage, 0, PAGE_SIZE);
160 bitmap->bp[page].map = mappage;
161 bitmap->missing_pages--;
167 /* if page is completely empty, put it back on the free list, or dealloc it */
168 /* if page was hijacked, unmark the flag so it might get alloced next time */
169 /* Note: lock should be held when calling this */
170 static void bitmap_checkfree(struct bitmap *bitmap, unsigned long page)
174 if (bitmap->bp[page].count) /* page is still busy */
177 /* page is no longer in use, it can be released */
179 if (bitmap->bp[page].hijacked) { /* page was hijacked, undo this now */
180 bitmap->bp[page].hijacked = 0;
181 bitmap->bp[page].map = NULL;
185 /* normal case, free the page */
188 /* actually ... let's not. We will probably need the page again exactly when
189 * memory is tight and we are flusing to disk
193 ptr = bitmap->bp[page].map;
194 bitmap->bp[page].map = NULL;
195 bitmap->missing_pages++;
196 bitmap_free_page(bitmap, ptr);
203 * bitmap file handling - read and write the bitmap file and its superblock
206 /* copy the pathname of a file to a buffer */
207 char *file_path(struct file *file, char *buf, int count)
215 d = file->f_path.dentry;
216 v = file->f_path.mnt;
218 buf = d_path(d, v, buf, count);
220 return IS_ERR(buf) ? NULL : buf;
224 * basic page I/O operations
227 /* IO operations when bitmap is stored near all superblocks */
228 static struct page *read_sb_page(mddev_t *mddev, long offset, unsigned long index)
230 /* choose a good rdev and read the page from there */
233 struct list_head *tmp;
234 struct page *page = alloc_page(GFP_KERNEL);
238 return ERR_PTR(-ENOMEM);
240 ITERATE_RDEV(mddev, rdev, tmp) {
241 if (! test_bit(In_sync, &rdev->flags)
242 || test_bit(Faulty, &rdev->flags))
245 target = (rdev->sb_offset << 1) + offset + index * (PAGE_SIZE/512);
247 if (sync_page_io(rdev->bdev, target, PAGE_SIZE, page, READ)) {
249 attach_page_buffers(page, NULL); /* so that free_buffer will
254 return ERR_PTR(-EIO);
258 static int write_sb_page(mddev_t *mddev, long offset, struct page *page, int wait)
261 struct list_head *tmp;
263 ITERATE_RDEV(mddev, rdev, tmp)
264 if (test_bit(In_sync, &rdev->flags)
265 && !test_bit(Faulty, &rdev->flags))
266 md_super_write(mddev, rdev,
267 (rdev->sb_offset<<1) + offset
268 + page->index * (PAGE_SIZE/512),
273 md_super_wait(mddev);
278 * write out a page to a file
280 static int write_page(struct bitmap *bitmap, struct page *page, int wait)
282 struct buffer_head *bh;
284 if (bitmap->file == NULL)
285 return write_sb_page(bitmap->mddev, bitmap->offset, page, wait);
287 bh = page_buffers(page);
289 while (bh && bh->b_blocknr) {
290 atomic_inc(&bitmap->pending_writes);
291 set_buffer_locked(bh);
292 set_buffer_mapped(bh);
293 submit_bh(WRITE, bh);
294 bh = bh->b_this_page;
298 wait_event(bitmap->write_wait,
299 atomic_read(&bitmap->pending_writes)==0);
300 return (bitmap->flags & BITMAP_WRITE_ERROR) ? -EIO : 0;
305 static void end_bitmap_write(struct buffer_head *bh, int uptodate)
307 struct bitmap *bitmap = bh->b_private;
311 spin_lock_irqsave(&bitmap->lock, flags);
312 bitmap->flags |= BITMAP_WRITE_ERROR;
313 spin_unlock_irqrestore(&bitmap->lock, flags);
315 if (atomic_dec_and_test(&bitmap->pending_writes))
316 wake_up(&bitmap->write_wait);
319 /* copied from buffer.c */
321 __clear_page_buffers(struct page *page)
323 ClearPagePrivate(page);
324 set_page_private(page, 0);
325 page_cache_release(page);
327 static void free_buffers(struct page *page)
329 struct buffer_head *bh = page_buffers(page);
332 struct buffer_head *next = bh->b_this_page;
333 free_buffer_head(bh);
336 __clear_page_buffers(page);
340 /* read a page from a file.
341 * We both read the page, and attach buffers to the page to record the
342 * address of each block (using bmap). These addresses will be used
343 * to write the block later, completely bypassing the filesystem.
344 * This usage is similar to how swap files are handled, and allows us
345 * to write to a file with no concerns of memory allocation failing.
347 static struct page *read_page(struct file *file, unsigned long index,
348 struct bitmap *bitmap,
351 struct page *page = NULL;
352 struct inode *inode = file->f_path.dentry->d_inode;
353 struct buffer_head *bh;
356 PRINTK("read bitmap file (%dB @ %Lu)\n", (int)PAGE_SIZE,
357 (unsigned long long)index << PAGE_SHIFT);
359 page = alloc_page(GFP_KERNEL);
361 page = ERR_PTR(-ENOMEM);
365 bh = alloc_page_buffers(page, 1<<inode->i_blkbits, 0);
368 page = ERR_PTR(-ENOMEM);
371 attach_page_buffers(page, bh);
372 block = index << (PAGE_SHIFT - inode->i_blkbits);
377 bh->b_blocknr = bmap(inode, block);
378 if (bh->b_blocknr == 0) {
379 /* Cannot use this file! */
381 page = ERR_PTR(-EINVAL);
384 bh->b_bdev = inode->i_sb->s_bdev;
385 if (count < (1<<inode->i_blkbits))
388 count -= (1<<inode->i_blkbits);
390 bh->b_end_io = end_bitmap_write;
391 bh->b_private = bitmap;
392 atomic_inc(&bitmap->pending_writes);
393 set_buffer_locked(bh);
394 set_buffer_mapped(bh);
398 bh = bh->b_this_page;
402 wait_event(bitmap->write_wait,
403 atomic_read(&bitmap->pending_writes)==0);
404 if (bitmap->flags & BITMAP_WRITE_ERROR) {
406 page = ERR_PTR(-EIO);
410 printk(KERN_ALERT "md: bitmap read error: (%dB @ %Lu): %ld\n",
412 (unsigned long long)index << PAGE_SHIFT,
418 * bitmap file superblock operations
421 /* update the event counter and sync the superblock to disk */
422 int bitmap_update_sb(struct bitmap *bitmap)
427 if (!bitmap || !bitmap->mddev) /* no bitmap for this array */
429 spin_lock_irqsave(&bitmap->lock, flags);
430 if (!bitmap->sb_page) { /* no superblock */
431 spin_unlock_irqrestore(&bitmap->lock, flags);
434 spin_unlock_irqrestore(&bitmap->lock, flags);
435 sb = (bitmap_super_t *)kmap_atomic(bitmap->sb_page, KM_USER0);
436 sb->events = cpu_to_le64(bitmap->mddev->events);
437 if (!bitmap->mddev->degraded)
438 sb->events_cleared = cpu_to_le64(bitmap->mddev->events);
439 kunmap_atomic(sb, KM_USER0);
440 return write_page(bitmap, bitmap->sb_page, 1);
443 /* print out the bitmap file superblock */
444 void bitmap_print_sb(struct bitmap *bitmap)
448 if (!bitmap || !bitmap->sb_page)
450 sb = (bitmap_super_t *)kmap_atomic(bitmap->sb_page, KM_USER0);
451 printk(KERN_DEBUG "%s: bitmap file superblock:\n", bmname(bitmap));
452 printk(KERN_DEBUG " magic: %08x\n", le32_to_cpu(sb->magic));
453 printk(KERN_DEBUG " version: %d\n", le32_to_cpu(sb->version));
454 printk(KERN_DEBUG " uuid: %08x.%08x.%08x.%08x\n",
455 *(__u32 *)(sb->uuid+0),
456 *(__u32 *)(sb->uuid+4),
457 *(__u32 *)(sb->uuid+8),
458 *(__u32 *)(sb->uuid+12));
459 printk(KERN_DEBUG " events: %llu\n",
460 (unsigned long long) le64_to_cpu(sb->events));
461 printk(KERN_DEBUG "events cleared: %llu\n",
462 (unsigned long long) le64_to_cpu(sb->events_cleared));
463 printk(KERN_DEBUG " state: %08x\n", le32_to_cpu(sb->state));
464 printk(KERN_DEBUG " chunksize: %d B\n", le32_to_cpu(sb->chunksize));
465 printk(KERN_DEBUG " daemon sleep: %ds\n", le32_to_cpu(sb->daemon_sleep));
466 printk(KERN_DEBUG " sync size: %llu KB\n",
467 (unsigned long long)le64_to_cpu(sb->sync_size)/2);
468 printk(KERN_DEBUG "max write behind: %d\n", le32_to_cpu(sb->write_behind));
469 kunmap_atomic(sb, KM_USER0);
472 /* read the superblock from the bitmap file and initialize some bitmap fields */
473 static int bitmap_read_sb(struct bitmap *bitmap)
477 unsigned long chunksize, daemon_sleep, write_behind;
478 unsigned long long events;
481 /* page 0 is the superblock, read it... */
483 bitmap->sb_page = read_page(bitmap->file, 0, bitmap, PAGE_SIZE);
485 bitmap->sb_page = read_sb_page(bitmap->mddev, bitmap->offset, 0);
487 if (IS_ERR(bitmap->sb_page)) {
488 err = PTR_ERR(bitmap->sb_page);
489 bitmap->sb_page = NULL;
493 sb = (bitmap_super_t *)kmap_atomic(bitmap->sb_page, KM_USER0);
495 chunksize = le32_to_cpu(sb->chunksize);
496 daemon_sleep = le32_to_cpu(sb->daemon_sleep);
497 write_behind = le32_to_cpu(sb->write_behind);
499 /* verify that the bitmap-specific fields are valid */
500 if (sb->magic != cpu_to_le32(BITMAP_MAGIC))
501 reason = "bad magic";
502 else if (le32_to_cpu(sb->version) < BITMAP_MAJOR_LO ||
503 le32_to_cpu(sb->version) > BITMAP_MAJOR_HI)
504 reason = "unrecognized superblock version";
505 else if (chunksize < PAGE_SIZE)
506 reason = "bitmap chunksize too small";
507 else if ((1 << ffz(~chunksize)) != chunksize)
508 reason = "bitmap chunksize not a power of 2";
509 else if (daemon_sleep < 1 || daemon_sleep > MAX_SCHEDULE_TIMEOUT / HZ)
510 reason = "daemon sleep period out of range";
511 else if (write_behind > COUNTER_MAX)
512 reason = "write-behind limit out of range (0 - 16383)";
514 printk(KERN_INFO "%s: invalid bitmap file superblock: %s\n",
515 bmname(bitmap), reason);
519 /* keep the array size field of the bitmap superblock up to date */
520 sb->sync_size = cpu_to_le64(bitmap->mddev->resync_max_sectors);
522 if (!bitmap->mddev->persistent)
526 * if we have a persistent array superblock, compare the
527 * bitmap's UUID and event counter to the mddev's
529 if (memcmp(sb->uuid, bitmap->mddev->uuid, 16)) {
530 printk(KERN_INFO "%s: bitmap superblock UUID mismatch\n",
534 events = le64_to_cpu(sb->events);
535 if (events < bitmap->mddev->events) {
536 printk(KERN_INFO "%s: bitmap file is out of date (%llu < %llu) "
537 "-- forcing full recovery\n", bmname(bitmap), events,
538 (unsigned long long) bitmap->mddev->events);
539 sb->state |= cpu_to_le32(BITMAP_STALE);
542 /* assign fields using values from superblock */
543 bitmap->chunksize = chunksize;
544 bitmap->daemon_sleep = daemon_sleep;
545 bitmap->daemon_lastrun = jiffies;
546 bitmap->max_write_behind = write_behind;
547 bitmap->flags |= le32_to_cpu(sb->state);
548 if (le32_to_cpu(sb->version) == BITMAP_MAJOR_HOSTENDIAN)
549 bitmap->flags |= BITMAP_HOSTENDIAN;
550 bitmap->events_cleared = le64_to_cpu(sb->events_cleared);
551 if (sb->state & cpu_to_le32(BITMAP_STALE))
552 bitmap->events_cleared = bitmap->mddev->events;
555 kunmap_atomic(sb, KM_USER0);
557 bitmap_print_sb(bitmap);
561 enum bitmap_mask_op {
566 /* record the state of the bitmap in the superblock */
567 static void bitmap_mask_state(struct bitmap *bitmap, enum bitmap_state bits,
568 enum bitmap_mask_op op)
573 spin_lock_irqsave(&bitmap->lock, flags);
574 if (!bitmap->sb_page) { /* can't set the state */
575 spin_unlock_irqrestore(&bitmap->lock, flags);
578 spin_unlock_irqrestore(&bitmap->lock, flags);
579 sb = (bitmap_super_t *)kmap_atomic(bitmap->sb_page, KM_USER0);
581 case MASK_SET: sb->state |= cpu_to_le32(bits);
583 case MASK_UNSET: sb->state &= cpu_to_le32(~bits);
587 kunmap_atomic(sb, KM_USER0);
591 * general bitmap file operations
594 /* calculate the index of the page that contains this bit */
595 static inline unsigned long file_page_index(unsigned long chunk)
597 return CHUNK_BIT_OFFSET(chunk) >> PAGE_BIT_SHIFT;
600 /* calculate the (bit) offset of this bit within a page */
601 static inline unsigned long file_page_offset(unsigned long chunk)
603 return CHUNK_BIT_OFFSET(chunk) & (PAGE_BITS - 1);
607 * return a pointer to the page in the filemap that contains the given bit
609 * this lookup is complicated by the fact that the bitmap sb might be exactly
610 * 1 page (e.g., x86) or less than 1 page -- so the bitmap might start on page
613 static inline struct page *filemap_get_page(struct bitmap *bitmap,
616 if (file_page_index(chunk) >= bitmap->file_pages) return NULL;
617 return bitmap->filemap[file_page_index(chunk) - file_page_index(0)];
621 static void bitmap_file_unmap(struct bitmap *bitmap)
623 struct page **map, *sb_page;
628 spin_lock_irqsave(&bitmap->lock, flags);
629 map = bitmap->filemap;
630 bitmap->filemap = NULL;
631 attr = bitmap->filemap_attr;
632 bitmap->filemap_attr = NULL;
633 pages = bitmap->file_pages;
634 bitmap->file_pages = 0;
635 sb_page = bitmap->sb_page;
636 bitmap->sb_page = NULL;
637 spin_unlock_irqrestore(&bitmap->lock, flags);
640 if (map[pages]->index != 0) /* 0 is sb_page, release it below */
641 free_buffers(map[pages]);
646 free_buffers(sb_page);
649 static void bitmap_file_put(struct bitmap *bitmap)
654 spin_lock_irqsave(&bitmap->lock, flags);
657 spin_unlock_irqrestore(&bitmap->lock, flags);
660 wait_event(bitmap->write_wait,
661 atomic_read(&bitmap->pending_writes)==0);
662 bitmap_file_unmap(bitmap);
665 struct inode *inode = file->f_path.dentry->d_inode;
666 invalidate_inode_pages(inode->i_mapping);
673 * bitmap_file_kick - if an error occurs while manipulating the bitmap file
674 * then it is no longer reliable, so we stop using it and we mark the file
675 * as failed in the superblock
677 static void bitmap_file_kick(struct bitmap *bitmap)
679 char *path, *ptr = NULL;
681 bitmap_mask_state(bitmap, BITMAP_STALE, MASK_SET);
682 bitmap_update_sb(bitmap);
685 path = kmalloc(PAGE_SIZE, GFP_KERNEL);
687 ptr = file_path(bitmap->file, path, PAGE_SIZE);
689 printk(KERN_ALERT "%s: kicking failed bitmap file %s from array!\n",
690 bmname(bitmap), ptr ? ptr : "");
695 bitmap_file_put(bitmap);
700 enum bitmap_page_attr {
701 BITMAP_PAGE_DIRTY = 0, // there are set bits that need to be synced
702 BITMAP_PAGE_CLEAN = 1, // there are bits that might need to be cleared
703 BITMAP_PAGE_NEEDWRITE=2, // there are cleared bits that need to be synced
706 static inline void set_page_attr(struct bitmap *bitmap, struct page *page,
707 enum bitmap_page_attr attr)
709 __set_bit((page->index<<2) + attr, bitmap->filemap_attr);
712 static inline void clear_page_attr(struct bitmap *bitmap, struct page *page,
713 enum bitmap_page_attr attr)
715 __clear_bit((page->index<<2) + attr, bitmap->filemap_attr);
718 static inline unsigned long test_page_attr(struct bitmap *bitmap, struct page *page,
719 enum bitmap_page_attr attr)
721 return test_bit((page->index<<2) + attr, bitmap->filemap_attr);
725 * bitmap_file_set_bit -- called before performing a write to the md device
726 * to set (and eventually sync) a particular bit in the bitmap file
728 * we set the bit immediately, then we record the page number so that
729 * when an unplug occurs, we can flush the dirty pages out to disk
731 static void bitmap_file_set_bit(struct bitmap *bitmap, sector_t block)
736 unsigned long chunk = block >> CHUNK_BLOCK_SHIFT(bitmap);
738 if (!bitmap->filemap) {
742 page = filemap_get_page(bitmap, chunk);
744 bit = file_page_offset(chunk);
747 kaddr = kmap_atomic(page, KM_USER0);
748 if (bitmap->flags & BITMAP_HOSTENDIAN)
751 ext2_set_bit(bit, kaddr);
752 kunmap_atomic(kaddr, KM_USER0);
753 PRINTK("set file bit %lu page %lu\n", bit, page->index);
755 /* record page number so it gets flushed to disk when unplug occurs */
756 set_page_attr(bitmap, page, BITMAP_PAGE_DIRTY);
760 /* this gets called when the md device is ready to unplug its underlying
761 * (slave) device queues -- before we let any writes go down, we need to
762 * sync the dirty pages of the bitmap file to disk */
763 int bitmap_unplug(struct bitmap *bitmap)
765 unsigned long i, flags;
766 int dirty, need_write;
774 /* look at each page to see if there are any set bits that need to be
775 * flushed out to disk */
776 for (i = 0; i < bitmap->file_pages; i++) {
777 spin_lock_irqsave(&bitmap->lock, flags);
778 if (!bitmap->filemap) {
779 spin_unlock_irqrestore(&bitmap->lock, flags);
782 page = bitmap->filemap[i];
783 dirty = test_page_attr(bitmap, page, BITMAP_PAGE_DIRTY);
784 need_write = test_page_attr(bitmap, page, BITMAP_PAGE_NEEDWRITE);
785 clear_page_attr(bitmap, page, BITMAP_PAGE_DIRTY);
786 clear_page_attr(bitmap, page, BITMAP_PAGE_NEEDWRITE);
789 spin_unlock_irqrestore(&bitmap->lock, flags);
791 if (dirty | need_write)
792 err = write_page(bitmap, page, 0);
794 if (wait) { /* if any writes were performed, we need to wait on them */
796 wait_event(bitmap->write_wait,
797 atomic_read(&bitmap->pending_writes)==0);
799 md_super_wait(bitmap->mddev);
801 if (bitmap->flags & BITMAP_WRITE_ERROR)
802 bitmap_file_kick(bitmap);
806 static void bitmap_set_memory_bits(struct bitmap *bitmap, sector_t offset, int needed);
807 /* * bitmap_init_from_disk -- called at bitmap_create time to initialize
808 * the in-memory bitmap from the on-disk bitmap -- also, sets up the
809 * memory mapping of the bitmap file
811 * if there's no bitmap file, or if the bitmap file had been
812 * previously kicked from the array, we mark all the bits as
813 * 1's in order to cause a full resync.
815 * We ignore all bits for sectors that end earlier than 'start'.
816 * This is used when reading an out-of-date bitmap...
818 static int bitmap_init_from_disk(struct bitmap *bitmap, sector_t start)
820 unsigned long i, chunks, index, oldindex, bit;
821 struct page *page = NULL, *oldpage = NULL;
822 unsigned long num_pages, bit_cnt = 0;
824 unsigned long bytes, offset;
829 chunks = bitmap->chunks;
832 BUG_ON(!file && !bitmap->offset);
834 #ifdef INJECT_FAULTS_3
837 outofdate = bitmap->flags & BITMAP_STALE;
840 printk(KERN_INFO "%s: bitmap file is out of date, doing full "
841 "recovery\n", bmname(bitmap));
843 bytes = (chunks + 7) / 8;
845 num_pages = (bytes + sizeof(bitmap_super_t) + PAGE_SIZE - 1) / PAGE_SIZE;
847 if (file && i_size_read(file->f_mapping->host) < bytes + sizeof(bitmap_super_t)) {
848 printk(KERN_INFO "%s: bitmap file too short %lu < %lu\n",
850 (unsigned long) i_size_read(file->f_mapping->host),
851 bytes + sizeof(bitmap_super_t));
857 bitmap->filemap = kmalloc(sizeof(struct page *) * num_pages, GFP_KERNEL);
858 if (!bitmap->filemap)
861 /* We need 4 bits per page, rounded up to a multiple of sizeof(unsigned long) */
862 bitmap->filemap_attr = kzalloc(
863 (((num_pages*4/8)+sizeof(unsigned long)-1)
864 /sizeof(unsigned long))
865 *sizeof(unsigned long),
867 if (!bitmap->filemap_attr)
872 for (i = 0; i < chunks; i++) {
874 index = file_page_index(i);
875 bit = file_page_offset(i);
876 if (index != oldindex) { /* this is a new page, read it in */
878 /* unmap the old page, we're done with it */
879 if (index == num_pages-1)
880 count = bytes - index * PAGE_SIZE;
885 * if we're here then the superblock page
886 * contains some bits (PAGE_SIZE != sizeof sb)
887 * we've already read it in, so just use it
889 page = bitmap->sb_page;
890 offset = sizeof(bitmap_super_t);
892 page = read_page(file, index, bitmap, count);
895 page = read_sb_page(bitmap->mddev, bitmap->offset, index);
898 if (IS_ERR(page)) { /* read error */
908 * if bitmap is out of date, dirty the
909 * whole page and write it out
911 paddr = kmap_atomic(page, KM_USER0);
912 memset(paddr + offset, 0xff,
914 kunmap_atomic(paddr, KM_USER0);
915 ret = write_page(bitmap, page, 1);
917 /* release, page not in filemap yet */
923 bitmap->filemap[bitmap->file_pages++] = page;
925 paddr = kmap_atomic(page, KM_USER0);
926 if (bitmap->flags & BITMAP_HOSTENDIAN)
927 b = test_bit(bit, paddr);
929 b = ext2_test_bit(bit, paddr);
930 kunmap_atomic(paddr, KM_USER0);
932 /* if the disk bit is set, set the memory bit */
933 bitmap_set_memory_bits(bitmap, i << CHUNK_BLOCK_SHIFT(bitmap),
934 ((i+1) << (CHUNK_BLOCK_SHIFT(bitmap)) >= start)
937 set_page_attr(bitmap, page, BITMAP_PAGE_CLEAN);
941 /* everything went OK */
943 bitmap_mask_state(bitmap, BITMAP_STALE, MASK_UNSET);
945 if (bit_cnt) { /* Kick recovery if any bits were set */
946 set_bit(MD_RECOVERY_NEEDED, &bitmap->mddev->recovery);
947 md_wakeup_thread(bitmap->mddev->thread);
951 printk(KERN_INFO "%s: bitmap initialized from disk: "
952 "read %lu/%lu pages, set %lu bits, status: %d\n",
953 bmname(bitmap), bitmap->file_pages, num_pages, bit_cnt, ret);
958 void bitmap_write_all(struct bitmap *bitmap)
960 /* We don't actually write all bitmap blocks here,
961 * just flag them as needing to be written
965 for (i=0; i < bitmap->file_pages; i++)
966 set_page_attr(bitmap, bitmap->filemap[i],
967 BITMAP_PAGE_NEEDWRITE);
971 static void bitmap_count_page(struct bitmap *bitmap, sector_t offset, int inc)
973 sector_t chunk = offset >> CHUNK_BLOCK_SHIFT(bitmap);
974 unsigned long page = chunk >> PAGE_COUNTER_SHIFT;
975 bitmap->bp[page].count += inc;
977 if (page == 0) printk("count page 0, offset %llu: %d gives %d\n",
978 (unsigned long long)offset, inc, bitmap->bp[page].count);
980 bitmap_checkfree(bitmap, page);
982 static bitmap_counter_t *bitmap_get_counter(struct bitmap *bitmap,
983 sector_t offset, int *blocks,
987 * bitmap daemon -- periodically wakes up to clean bits and flush pages
991 int bitmap_daemon_work(struct bitmap *bitmap)
995 struct page *page = NULL, *lastpage = NULL;
1002 if (time_before(jiffies, bitmap->daemon_lastrun + bitmap->daemon_sleep*HZ))
1004 bitmap->daemon_lastrun = jiffies;
1006 for (j = 0; j < bitmap->chunks; j++) {
1007 bitmap_counter_t *bmc;
1008 spin_lock_irqsave(&bitmap->lock, flags);
1009 if (!bitmap->filemap) {
1010 /* error or shutdown */
1011 spin_unlock_irqrestore(&bitmap->lock, flags);
1015 page = filemap_get_page(bitmap, j);
1017 if (page != lastpage) {
1018 /* skip this page unless it's marked as needing cleaning */
1019 if (!test_page_attr(bitmap, page, BITMAP_PAGE_CLEAN)) {
1020 int need_write = test_page_attr(bitmap, page,
1021 BITMAP_PAGE_NEEDWRITE);
1023 clear_page_attr(bitmap, page, BITMAP_PAGE_NEEDWRITE);
1025 spin_unlock_irqrestore(&bitmap->lock, flags);
1027 switch (write_page(bitmap, page, 0)) {
1031 bitmap_file_kick(bitmap);
1037 /* grab the new page, sync and release the old */
1038 if (lastpage != NULL) {
1039 if (test_page_attr(bitmap, lastpage, BITMAP_PAGE_NEEDWRITE)) {
1040 clear_page_attr(bitmap, lastpage, BITMAP_PAGE_NEEDWRITE);
1041 spin_unlock_irqrestore(&bitmap->lock, flags);
1042 err = write_page(bitmap, lastpage, 0);
1044 set_page_attr(bitmap, lastpage, BITMAP_PAGE_NEEDWRITE);
1045 spin_unlock_irqrestore(&bitmap->lock, flags);
1048 bitmap_file_kick(bitmap);
1050 spin_unlock_irqrestore(&bitmap->lock, flags);
1053 printk("bitmap clean at page %lu\n", j);
1055 spin_lock_irqsave(&bitmap->lock, flags);
1056 clear_page_attr(bitmap, page, BITMAP_PAGE_CLEAN);
1058 bmc = bitmap_get_counter(bitmap, j << CHUNK_BLOCK_SHIFT(bitmap),
1062 if (j < 100) printk("bitmap: j=%lu, *bmc = 0x%x\n", j, *bmc);
1065 *bmc=1; /* maybe clear the bit next time */
1066 set_page_attr(bitmap, page, BITMAP_PAGE_CLEAN);
1067 } else if (*bmc == 1) {
1068 /* we can clear the bit */
1070 bitmap_count_page(bitmap, j << CHUNK_BLOCK_SHIFT(bitmap),
1074 paddr = kmap_atomic(page, KM_USER0);
1075 if (bitmap->flags & BITMAP_HOSTENDIAN)
1076 clear_bit(file_page_offset(j), paddr);
1078 ext2_clear_bit(file_page_offset(j), paddr);
1079 kunmap_atomic(paddr, KM_USER0);
1082 spin_unlock_irqrestore(&bitmap->lock, flags);
1085 /* now sync the final page */
1086 if (lastpage != NULL) {
1087 spin_lock_irqsave(&bitmap->lock, flags);
1088 if (test_page_attr(bitmap, lastpage, BITMAP_PAGE_NEEDWRITE)) {
1089 clear_page_attr(bitmap, lastpage, BITMAP_PAGE_NEEDWRITE);
1090 spin_unlock_irqrestore(&bitmap->lock, flags);
1091 err = write_page(bitmap, lastpage, 0);
1093 set_page_attr(bitmap, lastpage, BITMAP_PAGE_NEEDWRITE);
1094 spin_unlock_irqrestore(&bitmap->lock, flags);
1101 static bitmap_counter_t *bitmap_get_counter(struct bitmap *bitmap,
1102 sector_t offset, int *blocks,
1105 /* If 'create', we might release the lock and reclaim it.
1106 * The lock must have been taken with interrupts enabled.
1107 * If !create, we don't release the lock.
1109 sector_t chunk = offset >> CHUNK_BLOCK_SHIFT(bitmap);
1110 unsigned long page = chunk >> PAGE_COUNTER_SHIFT;
1111 unsigned long pageoff = (chunk & PAGE_COUNTER_MASK) << COUNTER_BYTE_SHIFT;
1114 if (bitmap_checkpage(bitmap, page, create) < 0) {
1115 csize = ((sector_t)1) << (CHUNK_BLOCK_SHIFT(bitmap));
1116 *blocks = csize - (offset & (csize- 1));
1119 /* now locked ... */
1121 if (bitmap->bp[page].hijacked) { /* hijacked pointer */
1122 /* should we use the first or second counter field
1123 * of the hijacked pointer? */
1124 int hi = (pageoff > PAGE_COUNTER_MASK);
1125 csize = ((sector_t)1) << (CHUNK_BLOCK_SHIFT(bitmap) +
1126 PAGE_COUNTER_SHIFT - 1);
1127 *blocks = csize - (offset & (csize- 1));
1128 return &((bitmap_counter_t *)
1129 &bitmap->bp[page].map)[hi];
1130 } else { /* page is allocated */
1131 csize = ((sector_t)1) << (CHUNK_BLOCK_SHIFT(bitmap));
1132 *blocks = csize - (offset & (csize- 1));
1133 return (bitmap_counter_t *)
1134 &(bitmap->bp[page].map[pageoff]);
1138 int bitmap_startwrite(struct bitmap *bitmap, sector_t offset, unsigned long sectors, int behind)
1140 if (!bitmap) return 0;
1143 atomic_inc(&bitmap->behind_writes);
1144 PRINTK(KERN_DEBUG "inc write-behind count %d/%d\n",
1145 atomic_read(&bitmap->behind_writes), bitmap->max_write_behind);
1150 bitmap_counter_t *bmc;
1152 spin_lock_irq(&bitmap->lock);
1153 bmc = bitmap_get_counter(bitmap, offset, &blocks, 1);
1155 spin_unlock_irq(&bitmap->lock);
1161 bitmap_file_set_bit(bitmap, offset);
1162 bitmap_count_page(bitmap,offset, 1);
1163 blk_plug_device(bitmap->mddev->queue);
1168 BUG_ON((*bmc & COUNTER_MAX) == COUNTER_MAX);
1171 spin_unlock_irq(&bitmap->lock);
1174 if (sectors > blocks)
1181 void bitmap_endwrite(struct bitmap *bitmap, sector_t offset, unsigned long sectors,
1182 int success, int behind)
1184 if (!bitmap) return;
1186 atomic_dec(&bitmap->behind_writes);
1187 PRINTK(KERN_DEBUG "dec write-behind count %d/%d\n",
1188 atomic_read(&bitmap->behind_writes), bitmap->max_write_behind);
1193 unsigned long flags;
1194 bitmap_counter_t *bmc;
1196 spin_lock_irqsave(&bitmap->lock, flags);
1197 bmc = bitmap_get_counter(bitmap, offset, &blocks, 0);
1199 spin_unlock_irqrestore(&bitmap->lock, flags);
1203 if (!success && ! (*bmc & NEEDED_MASK))
1204 *bmc |= NEEDED_MASK;
1208 set_page_attr(bitmap,
1209 filemap_get_page(bitmap, offset >> CHUNK_BLOCK_SHIFT(bitmap)),
1212 spin_unlock_irqrestore(&bitmap->lock, flags);
1214 if (sectors > blocks)
1220 int bitmap_start_sync(struct bitmap *bitmap, sector_t offset, int *blocks,
1223 bitmap_counter_t *bmc;
1225 if (bitmap == NULL) {/* FIXME or bitmap set as 'failed' */
1227 return 1; /* always resync if no bitmap */
1229 spin_lock_irq(&bitmap->lock);
1230 bmc = bitmap_get_counter(bitmap, offset, blocks, 0);
1236 else if (NEEDED(*bmc)) {
1238 if (!degraded) { /* don't set/clear bits if degraded */
1239 *bmc |= RESYNC_MASK;
1240 *bmc &= ~NEEDED_MASK;
1244 spin_unlock_irq(&bitmap->lock);
1248 void bitmap_end_sync(struct bitmap *bitmap, sector_t offset, int *blocks, int aborted)
1250 bitmap_counter_t *bmc;
1251 unsigned long flags;
1253 if (offset == 0) printk("bitmap_end_sync 0 (%d)\n", aborted);
1254 */ if (bitmap == NULL) {
1258 spin_lock_irqsave(&bitmap->lock, flags);
1259 bmc = bitmap_get_counter(bitmap, offset, blocks, 0);
1264 if (offset == 0) printk("bitmap_end sync found 0x%x, blocks %d\n", *bmc, *blocks);
1267 *bmc &= ~RESYNC_MASK;
1269 if (!NEEDED(*bmc) && aborted)
1270 *bmc |= NEEDED_MASK;
1273 set_page_attr(bitmap,
1274 filemap_get_page(bitmap, offset >> CHUNK_BLOCK_SHIFT(bitmap)),
1280 spin_unlock_irqrestore(&bitmap->lock, flags);
1283 void bitmap_close_sync(struct bitmap *bitmap)
1285 /* Sync has finished, and any bitmap chunks that weren't synced
1286 * properly have been aborted. It remains to us to clear the
1287 * RESYNC bit wherever it is still on
1289 sector_t sector = 0;
1291 if (!bitmap) return;
1292 while (sector < bitmap->mddev->resync_max_sectors) {
1293 bitmap_end_sync(bitmap, sector, &blocks, 0);
1295 if (sector < 500) printk("bitmap_close_sync: sec %llu blks %d\n",
1296 (unsigned long long)sector, blocks);
1297 */ sector += blocks;
1301 static void bitmap_set_memory_bits(struct bitmap *bitmap, sector_t offset, int needed)
1303 /* For each chunk covered by any of these sectors, set the
1304 * counter to 1 and set resync_needed. They should all
1305 * be 0 at this point
1309 bitmap_counter_t *bmc;
1310 spin_lock_irq(&bitmap->lock);
1311 bmc = bitmap_get_counter(bitmap, offset, &secs, 1);
1313 spin_unlock_irq(&bitmap->lock);
1318 *bmc = 1 | (needed?NEEDED_MASK:0);
1319 bitmap_count_page(bitmap, offset, 1);
1320 page = filemap_get_page(bitmap, offset >> CHUNK_BLOCK_SHIFT(bitmap));
1321 set_page_attr(bitmap, page, BITMAP_PAGE_CLEAN);
1323 spin_unlock_irq(&bitmap->lock);
1327 /* dirty the memory and file bits for bitmap chunks "s" to "e" */
1328 void bitmap_dirty_bits(struct bitmap *bitmap, unsigned long s, unsigned long e)
1330 unsigned long chunk;
1332 for (chunk = s; chunk <= e; chunk++) {
1333 sector_t sec = chunk << CHUNK_BLOCK_SHIFT(bitmap);
1334 bitmap_set_memory_bits(bitmap, sec, 1);
1335 bitmap_file_set_bit(bitmap, sec);
1340 * flush out any pending updates
1342 void bitmap_flush(mddev_t *mddev)
1344 struct bitmap *bitmap = mddev->bitmap;
1347 if (!bitmap) /* there was no bitmap */
1350 /* run the daemon_work three time to ensure everything is flushed
1353 sleep = bitmap->daemon_sleep;
1354 bitmap->daemon_sleep = 0;
1355 bitmap_daemon_work(bitmap);
1356 bitmap_daemon_work(bitmap);
1357 bitmap_daemon_work(bitmap);
1358 bitmap->daemon_sleep = sleep;
1359 bitmap_update_sb(bitmap);
1363 * free memory that was allocated
1365 static void bitmap_free(struct bitmap *bitmap)
1367 unsigned long k, pages;
1368 struct bitmap_page *bp;
1370 if (!bitmap) /* there was no bitmap */
1373 /* release the bitmap file and kill the daemon */
1374 bitmap_file_put(bitmap);
1377 pages = bitmap->pages;
1379 /* free all allocated memory */
1381 if (bp) /* deallocate the page memory */
1382 for (k = 0; k < pages; k++)
1383 if (bp[k].map && !bp[k].hijacked)
1388 void bitmap_destroy(mddev_t *mddev)
1390 struct bitmap *bitmap = mddev->bitmap;
1392 if (!bitmap) /* there was no bitmap */
1395 mddev->bitmap = NULL; /* disconnect from the md device */
1397 mddev->thread->timeout = MAX_SCHEDULE_TIMEOUT;
1399 bitmap_free(bitmap);
1403 * initialize the bitmap structure
1404 * if this returns an error, bitmap_destroy must be called to do clean up
1406 int bitmap_create(mddev_t *mddev)
1408 struct bitmap *bitmap;
1409 unsigned long blocks = mddev->resync_max_sectors;
1410 unsigned long chunks;
1411 unsigned long pages;
1412 struct file *file = mddev->bitmap_file;
1416 BUILD_BUG_ON(sizeof(bitmap_super_t) != 256);
1418 if (!file && !mddev->bitmap_offset) /* bitmap disabled, nothing to do */
1421 BUG_ON(file && mddev->bitmap_offset);
1423 bitmap = kzalloc(sizeof(*bitmap), GFP_KERNEL);
1427 spin_lock_init(&bitmap->lock);
1428 atomic_set(&bitmap->pending_writes, 0);
1429 init_waitqueue_head(&bitmap->write_wait);
1431 bitmap->mddev = mddev;
1433 bitmap->file = file;
1434 bitmap->offset = mddev->bitmap_offset;
1437 do_sync_file_range(file, 0, LLONG_MAX,
1438 SYNC_FILE_RANGE_WAIT_BEFORE |
1439 SYNC_FILE_RANGE_WRITE |
1440 SYNC_FILE_RANGE_WAIT_AFTER);
1442 /* read superblock from bitmap file (this sets bitmap->chunksize) */
1443 err = bitmap_read_sb(bitmap);
1447 bitmap->chunkshift = ffz(~bitmap->chunksize);
1449 /* now that chunksize and chunkshift are set, we can use these macros */
1450 chunks = (blocks + CHUNK_BLOCK_RATIO(bitmap) - 1) /
1451 CHUNK_BLOCK_RATIO(bitmap);
1452 pages = (chunks + PAGE_COUNTER_RATIO - 1) / PAGE_COUNTER_RATIO;
1456 bitmap->chunks = chunks;
1457 bitmap->pages = pages;
1458 bitmap->missing_pages = pages;
1459 bitmap->counter_bits = COUNTER_BITS;
1461 bitmap->syncchunk = ~0UL;
1463 #ifdef INJECT_FATAL_FAULT_1
1466 bitmap->bp = kzalloc(pages * sizeof(*bitmap->bp), GFP_KERNEL);
1472 /* now that we have some pages available, initialize the in-memory
1473 * bitmap from the on-disk bitmap */
1475 if (mddev->degraded == 0
1476 || bitmap->events_cleared == mddev->events)
1477 /* no need to keep dirty bits to optimise a re-add of a missing device */
1478 start = mddev->recovery_cp;
1479 err = bitmap_init_from_disk(bitmap, start);
1484 printk(KERN_INFO "created bitmap (%lu pages) for device %s\n",
1485 pages, bmname(bitmap));
1487 mddev->bitmap = bitmap;
1489 mddev->thread->timeout = bitmap->daemon_sleep * HZ;
1491 return bitmap_update_sb(bitmap);
1494 bitmap_free(bitmap);
1498 /* the bitmap API -- for raid personalities */
1499 EXPORT_SYMBOL(bitmap_startwrite);
1500 EXPORT_SYMBOL(bitmap_endwrite);
1501 EXPORT_SYMBOL(bitmap_start_sync);
1502 EXPORT_SYMBOL(bitmap_end_sync);
1503 EXPORT_SYMBOL(bitmap_unplug);
1504 EXPORT_SYMBOL(bitmap_close_sync);