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(struct bitmap *bitmap, struct page *page, int wait)
261 struct list_head *tmp;
262 mddev_t *mddev = bitmap->mddev;
264 ITERATE_RDEV(mddev, rdev, tmp)
265 if (test_bit(In_sync, &rdev->flags)
266 && !test_bit(Faulty, &rdev->flags)) {
267 int size = PAGE_SIZE;
268 if (page->index == bitmap->file_pages-1)
269 size = roundup(bitmap->last_page_size,
270 bdev_hardsect_size(rdev->bdev));
271 md_super_write(mddev, rdev,
272 (rdev->sb_offset<<1) + bitmap->offset
273 + page->index * (PAGE_SIZE/512),
279 md_super_wait(mddev);
284 * write out a page to a file
286 static int write_page(struct bitmap *bitmap, struct page *page, int wait)
288 struct buffer_head *bh;
290 if (bitmap->file == NULL)
291 return write_sb_page(bitmap, page, wait);
293 bh = page_buffers(page);
295 while (bh && bh->b_blocknr) {
296 atomic_inc(&bitmap->pending_writes);
297 set_buffer_locked(bh);
298 set_buffer_mapped(bh);
299 submit_bh(WRITE, bh);
300 bh = bh->b_this_page;
304 wait_event(bitmap->write_wait,
305 atomic_read(&bitmap->pending_writes)==0);
306 return (bitmap->flags & BITMAP_WRITE_ERROR) ? -EIO : 0;
311 static void end_bitmap_write(struct buffer_head *bh, int uptodate)
313 struct bitmap *bitmap = bh->b_private;
317 spin_lock_irqsave(&bitmap->lock, flags);
318 bitmap->flags |= BITMAP_WRITE_ERROR;
319 spin_unlock_irqrestore(&bitmap->lock, flags);
321 if (atomic_dec_and_test(&bitmap->pending_writes))
322 wake_up(&bitmap->write_wait);
325 /* copied from buffer.c */
327 __clear_page_buffers(struct page *page)
329 ClearPagePrivate(page);
330 set_page_private(page, 0);
331 page_cache_release(page);
333 static void free_buffers(struct page *page)
335 struct buffer_head *bh = page_buffers(page);
338 struct buffer_head *next = bh->b_this_page;
339 free_buffer_head(bh);
342 __clear_page_buffers(page);
346 /* read a page from a file.
347 * We both read the page, and attach buffers to the page to record the
348 * address of each block (using bmap). These addresses will be used
349 * to write the block later, completely bypassing the filesystem.
350 * This usage is similar to how swap files are handled, and allows us
351 * to write to a file with no concerns of memory allocation failing.
353 static struct page *read_page(struct file *file, unsigned long index,
354 struct bitmap *bitmap,
357 struct page *page = NULL;
358 struct inode *inode = file->f_path.dentry->d_inode;
359 struct buffer_head *bh;
362 PRINTK("read bitmap file (%dB @ %Lu)\n", (int)PAGE_SIZE,
363 (unsigned long long)index << PAGE_SHIFT);
365 page = alloc_page(GFP_KERNEL);
367 page = ERR_PTR(-ENOMEM);
371 bh = alloc_page_buffers(page, 1<<inode->i_blkbits, 0);
374 page = ERR_PTR(-ENOMEM);
377 attach_page_buffers(page, bh);
378 block = index << (PAGE_SHIFT - inode->i_blkbits);
383 bh->b_blocknr = bmap(inode, block);
384 if (bh->b_blocknr == 0) {
385 /* Cannot use this file! */
387 page = ERR_PTR(-EINVAL);
390 bh->b_bdev = inode->i_sb->s_bdev;
391 if (count < (1<<inode->i_blkbits))
394 count -= (1<<inode->i_blkbits);
396 bh->b_end_io = end_bitmap_write;
397 bh->b_private = bitmap;
398 atomic_inc(&bitmap->pending_writes);
399 set_buffer_locked(bh);
400 set_buffer_mapped(bh);
404 bh = bh->b_this_page;
408 wait_event(bitmap->write_wait,
409 atomic_read(&bitmap->pending_writes)==0);
410 if (bitmap->flags & BITMAP_WRITE_ERROR) {
412 page = ERR_PTR(-EIO);
416 printk(KERN_ALERT "md: bitmap read error: (%dB @ %Lu): %ld\n",
418 (unsigned long long)index << PAGE_SHIFT,
424 * bitmap file superblock operations
427 /* update the event counter and sync the superblock to disk */
428 int bitmap_update_sb(struct bitmap *bitmap)
433 if (!bitmap || !bitmap->mddev) /* no bitmap for this array */
435 spin_lock_irqsave(&bitmap->lock, flags);
436 if (!bitmap->sb_page) { /* no superblock */
437 spin_unlock_irqrestore(&bitmap->lock, flags);
440 spin_unlock_irqrestore(&bitmap->lock, flags);
441 sb = (bitmap_super_t *)kmap_atomic(bitmap->sb_page, KM_USER0);
442 sb->events = cpu_to_le64(bitmap->mddev->events);
443 if (!bitmap->mddev->degraded)
444 sb->events_cleared = cpu_to_le64(bitmap->mddev->events);
445 kunmap_atomic(sb, KM_USER0);
446 return write_page(bitmap, bitmap->sb_page, 1);
449 /* print out the bitmap file superblock */
450 void bitmap_print_sb(struct bitmap *bitmap)
454 if (!bitmap || !bitmap->sb_page)
456 sb = (bitmap_super_t *)kmap_atomic(bitmap->sb_page, KM_USER0);
457 printk(KERN_DEBUG "%s: bitmap file superblock:\n", bmname(bitmap));
458 printk(KERN_DEBUG " magic: %08x\n", le32_to_cpu(sb->magic));
459 printk(KERN_DEBUG " version: %d\n", le32_to_cpu(sb->version));
460 printk(KERN_DEBUG " uuid: %08x.%08x.%08x.%08x\n",
461 *(__u32 *)(sb->uuid+0),
462 *(__u32 *)(sb->uuid+4),
463 *(__u32 *)(sb->uuid+8),
464 *(__u32 *)(sb->uuid+12));
465 printk(KERN_DEBUG " events: %llu\n",
466 (unsigned long long) le64_to_cpu(sb->events));
467 printk(KERN_DEBUG "events cleared: %llu\n",
468 (unsigned long long) le64_to_cpu(sb->events_cleared));
469 printk(KERN_DEBUG " state: %08x\n", le32_to_cpu(sb->state));
470 printk(KERN_DEBUG " chunksize: %d B\n", le32_to_cpu(sb->chunksize));
471 printk(KERN_DEBUG " daemon sleep: %ds\n", le32_to_cpu(sb->daemon_sleep));
472 printk(KERN_DEBUG " sync size: %llu KB\n",
473 (unsigned long long)le64_to_cpu(sb->sync_size)/2);
474 printk(KERN_DEBUG "max write behind: %d\n", le32_to_cpu(sb->write_behind));
475 kunmap_atomic(sb, KM_USER0);
478 /* read the superblock from the bitmap file and initialize some bitmap fields */
479 static int bitmap_read_sb(struct bitmap *bitmap)
483 unsigned long chunksize, daemon_sleep, write_behind;
484 unsigned long long events;
487 /* page 0 is the superblock, read it... */
489 loff_t isize = i_size_read(bitmap->file->f_mapping->host);
490 int bytes = isize > PAGE_SIZE ? PAGE_SIZE : isize;
492 bitmap->sb_page = read_page(bitmap->file, 0, bitmap, bytes);
494 bitmap->sb_page = read_sb_page(bitmap->mddev, bitmap->offset, 0);
496 if (IS_ERR(bitmap->sb_page)) {
497 err = PTR_ERR(bitmap->sb_page);
498 bitmap->sb_page = NULL;
502 sb = (bitmap_super_t *)kmap_atomic(bitmap->sb_page, KM_USER0);
504 chunksize = le32_to_cpu(sb->chunksize);
505 daemon_sleep = le32_to_cpu(sb->daemon_sleep);
506 write_behind = le32_to_cpu(sb->write_behind);
508 /* verify that the bitmap-specific fields are valid */
509 if (sb->magic != cpu_to_le32(BITMAP_MAGIC))
510 reason = "bad magic";
511 else if (le32_to_cpu(sb->version) < BITMAP_MAJOR_LO ||
512 le32_to_cpu(sb->version) > BITMAP_MAJOR_HI)
513 reason = "unrecognized superblock version";
514 else if (chunksize < PAGE_SIZE)
515 reason = "bitmap chunksize too small";
516 else if ((1 << ffz(~chunksize)) != chunksize)
517 reason = "bitmap chunksize not a power of 2";
518 else if (daemon_sleep < 1 || daemon_sleep > MAX_SCHEDULE_TIMEOUT / HZ)
519 reason = "daemon sleep period out of range";
520 else if (write_behind > COUNTER_MAX)
521 reason = "write-behind limit out of range (0 - 16383)";
523 printk(KERN_INFO "%s: invalid bitmap file superblock: %s\n",
524 bmname(bitmap), reason);
528 /* keep the array size field of the bitmap superblock up to date */
529 sb->sync_size = cpu_to_le64(bitmap->mddev->resync_max_sectors);
531 if (!bitmap->mddev->persistent)
535 * if we have a persistent array superblock, compare the
536 * bitmap's UUID and event counter to the mddev's
538 if (memcmp(sb->uuid, bitmap->mddev->uuid, 16)) {
539 printk(KERN_INFO "%s: bitmap superblock UUID mismatch\n",
543 events = le64_to_cpu(sb->events);
544 if (events < bitmap->mddev->events) {
545 printk(KERN_INFO "%s: bitmap file is out of date (%llu < %llu) "
546 "-- forcing full recovery\n", bmname(bitmap), events,
547 (unsigned long long) bitmap->mddev->events);
548 sb->state |= cpu_to_le32(BITMAP_STALE);
551 /* assign fields using values from superblock */
552 bitmap->chunksize = chunksize;
553 bitmap->daemon_sleep = daemon_sleep;
554 bitmap->daemon_lastrun = jiffies;
555 bitmap->max_write_behind = write_behind;
556 bitmap->flags |= le32_to_cpu(sb->state);
557 if (le32_to_cpu(sb->version) == BITMAP_MAJOR_HOSTENDIAN)
558 bitmap->flags |= BITMAP_HOSTENDIAN;
559 bitmap->events_cleared = le64_to_cpu(sb->events_cleared);
560 if (sb->state & cpu_to_le32(BITMAP_STALE))
561 bitmap->events_cleared = bitmap->mddev->events;
564 kunmap_atomic(sb, KM_USER0);
566 bitmap_print_sb(bitmap);
570 enum bitmap_mask_op {
575 /* record the state of the bitmap in the superblock */
576 static void bitmap_mask_state(struct bitmap *bitmap, enum bitmap_state bits,
577 enum bitmap_mask_op op)
582 spin_lock_irqsave(&bitmap->lock, flags);
583 if (!bitmap->sb_page) { /* can't set the state */
584 spin_unlock_irqrestore(&bitmap->lock, flags);
587 spin_unlock_irqrestore(&bitmap->lock, flags);
588 sb = (bitmap_super_t *)kmap_atomic(bitmap->sb_page, KM_USER0);
590 case MASK_SET: sb->state |= cpu_to_le32(bits);
592 case MASK_UNSET: sb->state &= cpu_to_le32(~bits);
596 kunmap_atomic(sb, KM_USER0);
600 * general bitmap file operations
603 /* calculate the index of the page that contains this bit */
604 static inline unsigned long file_page_index(unsigned long chunk)
606 return CHUNK_BIT_OFFSET(chunk) >> PAGE_BIT_SHIFT;
609 /* calculate the (bit) offset of this bit within a page */
610 static inline unsigned long file_page_offset(unsigned long chunk)
612 return CHUNK_BIT_OFFSET(chunk) & (PAGE_BITS - 1);
616 * return a pointer to the page in the filemap that contains the given bit
618 * this lookup is complicated by the fact that the bitmap sb might be exactly
619 * 1 page (e.g., x86) or less than 1 page -- so the bitmap might start on page
622 static inline struct page *filemap_get_page(struct bitmap *bitmap,
625 if (file_page_index(chunk) >= bitmap->file_pages) return NULL;
626 return bitmap->filemap[file_page_index(chunk) - file_page_index(0)];
630 static void bitmap_file_unmap(struct bitmap *bitmap)
632 struct page **map, *sb_page;
637 spin_lock_irqsave(&bitmap->lock, flags);
638 map = bitmap->filemap;
639 bitmap->filemap = NULL;
640 attr = bitmap->filemap_attr;
641 bitmap->filemap_attr = NULL;
642 pages = bitmap->file_pages;
643 bitmap->file_pages = 0;
644 sb_page = bitmap->sb_page;
645 bitmap->sb_page = NULL;
646 spin_unlock_irqrestore(&bitmap->lock, flags);
649 if (map[pages]->index != 0) /* 0 is sb_page, release it below */
650 free_buffers(map[pages]);
655 free_buffers(sb_page);
658 static void bitmap_file_put(struct bitmap *bitmap)
663 spin_lock_irqsave(&bitmap->lock, flags);
666 spin_unlock_irqrestore(&bitmap->lock, flags);
669 wait_event(bitmap->write_wait,
670 atomic_read(&bitmap->pending_writes)==0);
671 bitmap_file_unmap(bitmap);
674 struct inode *inode = file->f_path.dentry->d_inode;
675 invalidate_mapping_pages(inode->i_mapping, 0, -1);
682 * bitmap_file_kick - if an error occurs while manipulating the bitmap file
683 * then it is no longer reliable, so we stop using it and we mark the file
684 * as failed in the superblock
686 static void bitmap_file_kick(struct bitmap *bitmap)
688 char *path, *ptr = NULL;
690 bitmap_mask_state(bitmap, BITMAP_STALE, MASK_SET);
691 bitmap_update_sb(bitmap);
694 path = kmalloc(PAGE_SIZE, GFP_KERNEL);
696 ptr = file_path(bitmap->file, path, PAGE_SIZE);
698 printk(KERN_ALERT "%s: kicking failed bitmap file %s from array!\n",
699 bmname(bitmap), ptr ? ptr : "");
704 bitmap_file_put(bitmap);
709 enum bitmap_page_attr {
710 BITMAP_PAGE_DIRTY = 0, // there are set bits that need to be synced
711 BITMAP_PAGE_CLEAN = 1, // there are bits that might need to be cleared
712 BITMAP_PAGE_NEEDWRITE=2, // there are cleared bits that need to be synced
715 static inline void set_page_attr(struct bitmap *bitmap, struct page *page,
716 enum bitmap_page_attr attr)
718 __set_bit((page->index<<2) + attr, bitmap->filemap_attr);
721 static inline void clear_page_attr(struct bitmap *bitmap, struct page *page,
722 enum bitmap_page_attr attr)
724 __clear_bit((page->index<<2) + attr, bitmap->filemap_attr);
727 static inline unsigned long test_page_attr(struct bitmap *bitmap, struct page *page,
728 enum bitmap_page_attr attr)
730 return test_bit((page->index<<2) + attr, bitmap->filemap_attr);
734 * bitmap_file_set_bit -- called before performing a write to the md device
735 * to set (and eventually sync) a particular bit in the bitmap file
737 * we set the bit immediately, then we record the page number so that
738 * when an unplug occurs, we can flush the dirty pages out to disk
740 static void bitmap_file_set_bit(struct bitmap *bitmap, sector_t block)
745 unsigned long chunk = block >> CHUNK_BLOCK_SHIFT(bitmap);
747 if (!bitmap->filemap) {
751 page = filemap_get_page(bitmap, chunk);
753 bit = file_page_offset(chunk);
756 kaddr = kmap_atomic(page, KM_USER0);
757 if (bitmap->flags & BITMAP_HOSTENDIAN)
760 ext2_set_bit(bit, kaddr);
761 kunmap_atomic(kaddr, KM_USER0);
762 PRINTK("set file bit %lu page %lu\n", bit, page->index);
764 /* record page number so it gets flushed to disk when unplug occurs */
765 set_page_attr(bitmap, page, BITMAP_PAGE_DIRTY);
769 /* this gets called when the md device is ready to unplug its underlying
770 * (slave) device queues -- before we let any writes go down, we need to
771 * sync the dirty pages of the bitmap file to disk */
772 int bitmap_unplug(struct bitmap *bitmap)
774 unsigned long i, flags;
775 int dirty, need_write;
783 /* look at each page to see if there are any set bits that need to be
784 * flushed out to disk */
785 for (i = 0; i < bitmap->file_pages; i++) {
786 spin_lock_irqsave(&bitmap->lock, flags);
787 if (!bitmap->filemap) {
788 spin_unlock_irqrestore(&bitmap->lock, flags);
791 page = bitmap->filemap[i];
792 dirty = test_page_attr(bitmap, page, BITMAP_PAGE_DIRTY);
793 need_write = test_page_attr(bitmap, page, BITMAP_PAGE_NEEDWRITE);
794 clear_page_attr(bitmap, page, BITMAP_PAGE_DIRTY);
795 clear_page_attr(bitmap, page, BITMAP_PAGE_NEEDWRITE);
798 spin_unlock_irqrestore(&bitmap->lock, flags);
800 if (dirty | need_write)
801 err = write_page(bitmap, page, 0);
803 if (wait) { /* if any writes were performed, we need to wait on them */
805 wait_event(bitmap->write_wait,
806 atomic_read(&bitmap->pending_writes)==0);
808 md_super_wait(bitmap->mddev);
810 if (bitmap->flags & BITMAP_WRITE_ERROR)
811 bitmap_file_kick(bitmap);
815 static void bitmap_set_memory_bits(struct bitmap *bitmap, sector_t offset, int needed);
816 /* * bitmap_init_from_disk -- called at bitmap_create time to initialize
817 * the in-memory bitmap from the on-disk bitmap -- also, sets up the
818 * memory mapping of the bitmap file
820 * if there's no bitmap file, or if the bitmap file had been
821 * previously kicked from the array, we mark all the bits as
822 * 1's in order to cause a full resync.
824 * We ignore all bits for sectors that end earlier than 'start'.
825 * This is used when reading an out-of-date bitmap...
827 static int bitmap_init_from_disk(struct bitmap *bitmap, sector_t start)
829 unsigned long i, chunks, index, oldindex, bit;
830 struct page *page = NULL, *oldpage = NULL;
831 unsigned long num_pages, bit_cnt = 0;
833 unsigned long bytes, offset;
838 chunks = bitmap->chunks;
841 BUG_ON(!file && !bitmap->offset);
843 #ifdef INJECT_FAULTS_3
846 outofdate = bitmap->flags & BITMAP_STALE;
849 printk(KERN_INFO "%s: bitmap file is out of date, doing full "
850 "recovery\n", bmname(bitmap));
852 bytes = (chunks + 7) / 8;
854 num_pages = (bytes + sizeof(bitmap_super_t) + PAGE_SIZE - 1) / PAGE_SIZE;
856 if (file && i_size_read(file->f_mapping->host) < bytes + sizeof(bitmap_super_t)) {
857 printk(KERN_INFO "%s: bitmap file too short %lu < %lu\n",
859 (unsigned long) i_size_read(file->f_mapping->host),
860 bytes + sizeof(bitmap_super_t));
866 bitmap->filemap = kmalloc(sizeof(struct page *) * num_pages, GFP_KERNEL);
867 if (!bitmap->filemap)
870 /* We need 4 bits per page, rounded up to a multiple of sizeof(unsigned long) */
871 bitmap->filemap_attr = kzalloc(
872 roundup( DIV_ROUND_UP(num_pages*4, 8), sizeof(unsigned long)),
874 if (!bitmap->filemap_attr)
879 for (i = 0; i < chunks; i++) {
881 index = file_page_index(i);
882 bit = file_page_offset(i);
883 if (index != oldindex) { /* this is a new page, read it in */
885 /* unmap the old page, we're done with it */
886 if (index == num_pages-1)
887 count = bytes + sizeof(bitmap_super_t)
893 * if we're here then the superblock page
894 * contains some bits (PAGE_SIZE != sizeof sb)
895 * we've already read it in, so just use it
897 page = bitmap->sb_page;
898 offset = sizeof(bitmap_super_t);
900 page = read_page(file, index, bitmap, count);
903 page = read_sb_page(bitmap->mddev, bitmap->offset, index);
906 if (IS_ERR(page)) { /* read error */
916 * if bitmap is out of date, dirty the
917 * whole page and write it out
919 paddr = kmap_atomic(page, KM_USER0);
920 memset(paddr + offset, 0xff,
922 kunmap_atomic(paddr, KM_USER0);
923 ret = write_page(bitmap, page, 1);
925 /* release, page not in filemap yet */
931 bitmap->filemap[bitmap->file_pages++] = page;
932 bitmap->last_page_size = count;
934 paddr = kmap_atomic(page, KM_USER0);
935 if (bitmap->flags & BITMAP_HOSTENDIAN)
936 b = test_bit(bit, paddr);
938 b = ext2_test_bit(bit, paddr);
939 kunmap_atomic(paddr, KM_USER0);
941 /* if the disk bit is set, set the memory bit */
942 bitmap_set_memory_bits(bitmap, i << CHUNK_BLOCK_SHIFT(bitmap),
943 ((i+1) << (CHUNK_BLOCK_SHIFT(bitmap)) >= start)
946 set_page_attr(bitmap, page, BITMAP_PAGE_CLEAN);
950 /* everything went OK */
952 bitmap_mask_state(bitmap, BITMAP_STALE, MASK_UNSET);
954 if (bit_cnt) { /* Kick recovery if any bits were set */
955 set_bit(MD_RECOVERY_NEEDED, &bitmap->mddev->recovery);
956 md_wakeup_thread(bitmap->mddev->thread);
960 printk(KERN_INFO "%s: bitmap initialized from disk: "
961 "read %lu/%lu pages, set %lu bits, status: %d\n",
962 bmname(bitmap), bitmap->file_pages, num_pages, bit_cnt, ret);
967 void bitmap_write_all(struct bitmap *bitmap)
969 /* We don't actually write all bitmap blocks here,
970 * just flag them as needing to be written
974 for (i=0; i < bitmap->file_pages; i++)
975 set_page_attr(bitmap, bitmap->filemap[i],
976 BITMAP_PAGE_NEEDWRITE);
980 static void bitmap_count_page(struct bitmap *bitmap, sector_t offset, int inc)
982 sector_t chunk = offset >> CHUNK_BLOCK_SHIFT(bitmap);
983 unsigned long page = chunk >> PAGE_COUNTER_SHIFT;
984 bitmap->bp[page].count += inc;
986 if (page == 0) printk("count page 0, offset %llu: %d gives %d\n",
987 (unsigned long long)offset, inc, bitmap->bp[page].count);
989 bitmap_checkfree(bitmap, page);
991 static bitmap_counter_t *bitmap_get_counter(struct bitmap *bitmap,
992 sector_t offset, int *blocks,
996 * bitmap daemon -- periodically wakes up to clean bits and flush pages
1000 int bitmap_daemon_work(struct bitmap *bitmap)
1003 unsigned long flags;
1004 struct page *page = NULL, *lastpage = NULL;
1011 if (time_before(jiffies, bitmap->daemon_lastrun + bitmap->daemon_sleep*HZ))
1013 bitmap->daemon_lastrun = jiffies;
1015 for (j = 0; j < bitmap->chunks; j++) {
1016 bitmap_counter_t *bmc;
1017 spin_lock_irqsave(&bitmap->lock, flags);
1018 if (!bitmap->filemap) {
1019 /* error or shutdown */
1020 spin_unlock_irqrestore(&bitmap->lock, flags);
1024 page = filemap_get_page(bitmap, j);
1026 if (page != lastpage) {
1027 /* skip this page unless it's marked as needing cleaning */
1028 if (!test_page_attr(bitmap, page, BITMAP_PAGE_CLEAN)) {
1029 int need_write = test_page_attr(bitmap, page,
1030 BITMAP_PAGE_NEEDWRITE);
1032 clear_page_attr(bitmap, page, BITMAP_PAGE_NEEDWRITE);
1034 spin_unlock_irqrestore(&bitmap->lock, flags);
1036 switch (write_page(bitmap, page, 0)) {
1040 bitmap_file_kick(bitmap);
1046 /* grab the new page, sync and release the old */
1047 if (lastpage != NULL) {
1048 if (test_page_attr(bitmap, lastpage, BITMAP_PAGE_NEEDWRITE)) {
1049 clear_page_attr(bitmap, lastpage, BITMAP_PAGE_NEEDWRITE);
1050 spin_unlock_irqrestore(&bitmap->lock, flags);
1051 err = write_page(bitmap, lastpage, 0);
1053 set_page_attr(bitmap, lastpage, BITMAP_PAGE_NEEDWRITE);
1054 spin_unlock_irqrestore(&bitmap->lock, flags);
1057 bitmap_file_kick(bitmap);
1059 spin_unlock_irqrestore(&bitmap->lock, flags);
1062 printk("bitmap clean at page %lu\n", j);
1064 spin_lock_irqsave(&bitmap->lock, flags);
1065 clear_page_attr(bitmap, page, BITMAP_PAGE_CLEAN);
1067 bmc = bitmap_get_counter(bitmap, j << CHUNK_BLOCK_SHIFT(bitmap),
1071 if (j < 100) printk("bitmap: j=%lu, *bmc = 0x%x\n", j, *bmc);
1074 *bmc=1; /* maybe clear the bit next time */
1075 set_page_attr(bitmap, page, BITMAP_PAGE_CLEAN);
1076 } else if (*bmc == 1) {
1077 /* we can clear the bit */
1079 bitmap_count_page(bitmap, j << CHUNK_BLOCK_SHIFT(bitmap),
1083 paddr = kmap_atomic(page, KM_USER0);
1084 if (bitmap->flags & BITMAP_HOSTENDIAN)
1085 clear_bit(file_page_offset(j), paddr);
1087 ext2_clear_bit(file_page_offset(j), paddr);
1088 kunmap_atomic(paddr, KM_USER0);
1091 spin_unlock_irqrestore(&bitmap->lock, flags);
1094 /* now sync the final page */
1095 if (lastpage != NULL) {
1096 spin_lock_irqsave(&bitmap->lock, flags);
1097 if (test_page_attr(bitmap, lastpage, BITMAP_PAGE_NEEDWRITE)) {
1098 clear_page_attr(bitmap, lastpage, BITMAP_PAGE_NEEDWRITE);
1099 spin_unlock_irqrestore(&bitmap->lock, flags);
1100 err = write_page(bitmap, lastpage, 0);
1102 set_page_attr(bitmap, lastpage, BITMAP_PAGE_NEEDWRITE);
1103 spin_unlock_irqrestore(&bitmap->lock, flags);
1110 static bitmap_counter_t *bitmap_get_counter(struct bitmap *bitmap,
1111 sector_t offset, int *blocks,
1114 /* If 'create', we might release the lock and reclaim it.
1115 * The lock must have been taken with interrupts enabled.
1116 * If !create, we don't release the lock.
1118 sector_t chunk = offset >> CHUNK_BLOCK_SHIFT(bitmap);
1119 unsigned long page = chunk >> PAGE_COUNTER_SHIFT;
1120 unsigned long pageoff = (chunk & PAGE_COUNTER_MASK) << COUNTER_BYTE_SHIFT;
1123 if (bitmap_checkpage(bitmap, page, create) < 0) {
1124 csize = ((sector_t)1) << (CHUNK_BLOCK_SHIFT(bitmap));
1125 *blocks = csize - (offset & (csize- 1));
1128 /* now locked ... */
1130 if (bitmap->bp[page].hijacked) { /* hijacked pointer */
1131 /* should we use the first or second counter field
1132 * of the hijacked pointer? */
1133 int hi = (pageoff > PAGE_COUNTER_MASK);
1134 csize = ((sector_t)1) << (CHUNK_BLOCK_SHIFT(bitmap) +
1135 PAGE_COUNTER_SHIFT - 1);
1136 *blocks = csize - (offset & (csize- 1));
1137 return &((bitmap_counter_t *)
1138 &bitmap->bp[page].map)[hi];
1139 } else { /* page is allocated */
1140 csize = ((sector_t)1) << (CHUNK_BLOCK_SHIFT(bitmap));
1141 *blocks = csize - (offset & (csize- 1));
1142 return (bitmap_counter_t *)
1143 &(bitmap->bp[page].map[pageoff]);
1147 int bitmap_startwrite(struct bitmap *bitmap, sector_t offset, unsigned long sectors, int behind)
1149 if (!bitmap) return 0;
1152 atomic_inc(&bitmap->behind_writes);
1153 PRINTK(KERN_DEBUG "inc write-behind count %d/%d\n",
1154 atomic_read(&bitmap->behind_writes), bitmap->max_write_behind);
1159 bitmap_counter_t *bmc;
1161 spin_lock_irq(&bitmap->lock);
1162 bmc = bitmap_get_counter(bitmap, offset, &blocks, 1);
1164 spin_unlock_irq(&bitmap->lock);
1168 if (unlikely((*bmc & COUNTER_MAX) == COUNTER_MAX)) {
1169 DEFINE_WAIT(__wait);
1170 /* note that it is safe to do the prepare_to_wait
1171 * after the test as long as we do it before dropping
1174 prepare_to_wait(&bitmap->overflow_wait, &__wait,
1175 TASK_UNINTERRUPTIBLE);
1176 spin_unlock_irq(&bitmap->lock);
1177 bitmap->mddev->queue
1178 ->unplug_fn(bitmap->mddev->queue);
1180 finish_wait(&bitmap->overflow_wait, &__wait);
1186 bitmap_file_set_bit(bitmap, offset);
1187 bitmap_count_page(bitmap,offset, 1);
1188 blk_plug_device(bitmap->mddev->queue);
1196 spin_unlock_irq(&bitmap->lock);
1199 if (sectors > blocks)
1206 void bitmap_endwrite(struct bitmap *bitmap, sector_t offset, unsigned long sectors,
1207 int success, int behind)
1209 if (!bitmap) return;
1211 atomic_dec(&bitmap->behind_writes);
1212 PRINTK(KERN_DEBUG "dec write-behind count %d/%d\n",
1213 atomic_read(&bitmap->behind_writes), bitmap->max_write_behind);
1218 unsigned long flags;
1219 bitmap_counter_t *bmc;
1221 spin_lock_irqsave(&bitmap->lock, flags);
1222 bmc = bitmap_get_counter(bitmap, offset, &blocks, 0);
1224 spin_unlock_irqrestore(&bitmap->lock, flags);
1228 if (!success && ! (*bmc & NEEDED_MASK))
1229 *bmc |= NEEDED_MASK;
1231 if ((*bmc & COUNTER_MAX) == COUNTER_MAX)
1232 wake_up(&bitmap->overflow_wait);
1236 set_page_attr(bitmap,
1237 filemap_get_page(bitmap, offset >> CHUNK_BLOCK_SHIFT(bitmap)),
1240 spin_unlock_irqrestore(&bitmap->lock, flags);
1242 if (sectors > blocks)
1248 int bitmap_start_sync(struct bitmap *bitmap, sector_t offset, int *blocks,
1251 bitmap_counter_t *bmc;
1253 if (bitmap == NULL) {/* FIXME or bitmap set as 'failed' */
1255 return 1; /* always resync if no bitmap */
1257 spin_lock_irq(&bitmap->lock);
1258 bmc = bitmap_get_counter(bitmap, offset, blocks, 0);
1264 else if (NEEDED(*bmc)) {
1266 if (!degraded) { /* don't set/clear bits if degraded */
1267 *bmc |= RESYNC_MASK;
1268 *bmc &= ~NEEDED_MASK;
1272 spin_unlock_irq(&bitmap->lock);
1276 void bitmap_end_sync(struct bitmap *bitmap, sector_t offset, int *blocks, int aborted)
1278 bitmap_counter_t *bmc;
1279 unsigned long flags;
1281 if (offset == 0) printk("bitmap_end_sync 0 (%d)\n", aborted);
1282 */ if (bitmap == NULL) {
1286 spin_lock_irqsave(&bitmap->lock, flags);
1287 bmc = bitmap_get_counter(bitmap, offset, blocks, 0);
1292 if (offset == 0) printk("bitmap_end sync found 0x%x, blocks %d\n", *bmc, *blocks);
1295 *bmc &= ~RESYNC_MASK;
1297 if (!NEEDED(*bmc) && aborted)
1298 *bmc |= NEEDED_MASK;
1301 set_page_attr(bitmap,
1302 filemap_get_page(bitmap, offset >> CHUNK_BLOCK_SHIFT(bitmap)),
1308 spin_unlock_irqrestore(&bitmap->lock, flags);
1311 void bitmap_close_sync(struct bitmap *bitmap)
1313 /* Sync has finished, and any bitmap chunks that weren't synced
1314 * properly have been aborted. It remains to us to clear the
1315 * RESYNC bit wherever it is still on
1317 sector_t sector = 0;
1319 if (!bitmap) return;
1320 while (sector < bitmap->mddev->resync_max_sectors) {
1321 bitmap_end_sync(bitmap, sector, &blocks, 0);
1323 if (sector < 500) printk("bitmap_close_sync: sec %llu blks %d\n",
1324 (unsigned long long)sector, blocks);
1325 */ sector += blocks;
1329 static void bitmap_set_memory_bits(struct bitmap *bitmap, sector_t offset, int needed)
1331 /* For each chunk covered by any of these sectors, set the
1332 * counter to 1 and set resync_needed. They should all
1333 * be 0 at this point
1337 bitmap_counter_t *bmc;
1338 spin_lock_irq(&bitmap->lock);
1339 bmc = bitmap_get_counter(bitmap, offset, &secs, 1);
1341 spin_unlock_irq(&bitmap->lock);
1346 *bmc = 1 | (needed?NEEDED_MASK:0);
1347 bitmap_count_page(bitmap, offset, 1);
1348 page = filemap_get_page(bitmap, offset >> CHUNK_BLOCK_SHIFT(bitmap));
1349 set_page_attr(bitmap, page, BITMAP_PAGE_CLEAN);
1351 spin_unlock_irq(&bitmap->lock);
1355 /* dirty the memory and file bits for bitmap chunks "s" to "e" */
1356 void bitmap_dirty_bits(struct bitmap *bitmap, unsigned long s, unsigned long e)
1358 unsigned long chunk;
1360 for (chunk = s; chunk <= e; chunk++) {
1361 sector_t sec = chunk << CHUNK_BLOCK_SHIFT(bitmap);
1362 bitmap_set_memory_bits(bitmap, sec, 1);
1363 bitmap_file_set_bit(bitmap, sec);
1368 * flush out any pending updates
1370 void bitmap_flush(mddev_t *mddev)
1372 struct bitmap *bitmap = mddev->bitmap;
1375 if (!bitmap) /* there was no bitmap */
1378 /* run the daemon_work three time to ensure everything is flushed
1381 sleep = bitmap->daemon_sleep;
1382 bitmap->daemon_sleep = 0;
1383 bitmap_daemon_work(bitmap);
1384 bitmap_daemon_work(bitmap);
1385 bitmap_daemon_work(bitmap);
1386 bitmap->daemon_sleep = sleep;
1387 bitmap_update_sb(bitmap);
1391 * free memory that was allocated
1393 static void bitmap_free(struct bitmap *bitmap)
1395 unsigned long k, pages;
1396 struct bitmap_page *bp;
1398 if (!bitmap) /* there was no bitmap */
1401 /* release the bitmap file and kill the daemon */
1402 bitmap_file_put(bitmap);
1405 pages = bitmap->pages;
1407 /* free all allocated memory */
1409 if (bp) /* deallocate the page memory */
1410 for (k = 0; k < pages; k++)
1411 if (bp[k].map && !bp[k].hijacked)
1416 void bitmap_destroy(mddev_t *mddev)
1418 struct bitmap *bitmap = mddev->bitmap;
1420 if (!bitmap) /* there was no bitmap */
1423 mddev->bitmap = NULL; /* disconnect from the md device */
1425 mddev->thread->timeout = MAX_SCHEDULE_TIMEOUT;
1427 bitmap_free(bitmap);
1431 * initialize the bitmap structure
1432 * if this returns an error, bitmap_destroy must be called to do clean up
1434 int bitmap_create(mddev_t *mddev)
1436 struct bitmap *bitmap;
1437 unsigned long blocks = mddev->resync_max_sectors;
1438 unsigned long chunks;
1439 unsigned long pages;
1440 struct file *file = mddev->bitmap_file;
1444 BUILD_BUG_ON(sizeof(bitmap_super_t) != 256);
1446 if (!file && !mddev->bitmap_offset) /* bitmap disabled, nothing to do */
1449 BUG_ON(file && mddev->bitmap_offset);
1451 bitmap = kzalloc(sizeof(*bitmap), GFP_KERNEL);
1455 spin_lock_init(&bitmap->lock);
1456 atomic_set(&bitmap->pending_writes, 0);
1457 init_waitqueue_head(&bitmap->write_wait);
1458 init_waitqueue_head(&bitmap->overflow_wait);
1460 bitmap->mddev = mddev;
1462 bitmap->file = file;
1463 bitmap->offset = mddev->bitmap_offset;
1466 do_sync_mapping_range(file->f_mapping, 0, LLONG_MAX,
1467 SYNC_FILE_RANGE_WAIT_BEFORE |
1468 SYNC_FILE_RANGE_WRITE |
1469 SYNC_FILE_RANGE_WAIT_AFTER);
1471 /* read superblock from bitmap file (this sets bitmap->chunksize) */
1472 err = bitmap_read_sb(bitmap);
1476 bitmap->chunkshift = ffz(~bitmap->chunksize);
1478 /* now that chunksize and chunkshift are set, we can use these macros */
1479 chunks = (blocks + CHUNK_BLOCK_RATIO(bitmap) - 1) /
1480 CHUNK_BLOCK_RATIO(bitmap);
1481 pages = (chunks + PAGE_COUNTER_RATIO - 1) / PAGE_COUNTER_RATIO;
1485 bitmap->chunks = chunks;
1486 bitmap->pages = pages;
1487 bitmap->missing_pages = pages;
1488 bitmap->counter_bits = COUNTER_BITS;
1490 bitmap->syncchunk = ~0UL;
1492 #ifdef INJECT_FATAL_FAULT_1
1495 bitmap->bp = kzalloc(pages * sizeof(*bitmap->bp), GFP_KERNEL);
1501 /* now that we have some pages available, initialize the in-memory
1502 * bitmap from the on-disk bitmap */
1504 if (mddev->degraded == 0
1505 || bitmap->events_cleared == mddev->events)
1506 /* no need to keep dirty bits to optimise a re-add of a missing device */
1507 start = mddev->recovery_cp;
1508 err = bitmap_init_from_disk(bitmap, start);
1513 printk(KERN_INFO "created bitmap (%lu pages) for device %s\n",
1514 pages, bmname(bitmap));
1516 mddev->bitmap = bitmap;
1518 mddev->thread->timeout = bitmap->daemon_sleep * HZ;
1520 return bitmap_update_sb(bitmap);
1523 bitmap_free(bitmap);
1527 /* the bitmap API -- for raid personalities */
1528 EXPORT_SYMBOL(bitmap_startwrite);
1529 EXPORT_SYMBOL(bitmap_endwrite);
1530 EXPORT_SYMBOL(bitmap_start_sync);
1531 EXPORT_SYMBOL(bitmap_end_sync);
1532 EXPORT_SYMBOL(bitmap_unplug);
1533 EXPORT_SYMBOL(bitmap_close_sync);