Merge tag 'block-5.11-2021-01-10' of git://git.kernel.dk/linux-block
[linux/fpc-iii.git] / drivers / block / drbd / drbd_bitmap.c
blobdf53dca5d02c7e76fb4551587ea19dcce8a6200c
1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /*
3 drbd_bitmap.c
5 This file is part of DRBD by Philipp Reisner and Lars Ellenberg.
7 Copyright (C) 2004-2008, LINBIT Information Technologies GmbH.
8 Copyright (C) 2004-2008, Philipp Reisner <philipp.reisner@linbit.com>.
9 Copyright (C) 2004-2008, Lars Ellenberg <lars.ellenberg@linbit.com>.
13 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
15 #include <linux/bitmap.h>
16 #include <linux/vmalloc.h>
17 #include <linux/string.h>
18 #include <linux/drbd.h>
19 #include <linux/slab.h>
20 #include <linux/highmem.h>
22 #include "drbd_int.h"
25 /* OPAQUE outside this file!
26 * interface defined in drbd_int.h
28 * convention:
29 * function name drbd_bm_... => used elsewhere, "public".
30 * function name bm_... => internal to implementation, "private".
35 * LIMITATIONS:
36 * We want to support >= peta byte of backend storage, while for now still using
37 * a granularity of one bit per 4KiB of storage.
38 * 1 << 50 bytes backend storage (1 PiB)
39 * 1 << (50 - 12) bits needed
40 * 38 --> we need u64 to index and count bits
41 * 1 << (38 - 3) bitmap bytes needed
42 * 35 --> we still need u64 to index and count bytes
43 * (that's 32 GiB of bitmap for 1 PiB storage)
44 * 1 << (35 - 2) 32bit longs needed
45 * 33 --> we'd even need u64 to index and count 32bit long words.
46 * 1 << (35 - 3) 64bit longs needed
47 * 32 --> we could get away with a 32bit unsigned int to index and count
48 * 64bit long words, but I rather stay with unsigned long for now.
49 * We probably should neither count nor point to bytes or long words
50 * directly, but either by bitnumber, or by page index and offset.
51 * 1 << (35 - 12)
52 * 22 --> we need that much 4KiB pages of bitmap.
53 * 1 << (22 + 3) --> on a 64bit arch,
54 * we need 32 MiB to store the array of page pointers.
56 * Because I'm lazy, and because the resulting patch was too large, too ugly
57 * and still incomplete, on 32bit we still "only" support 16 TiB (minus some),
58 * (1 << 32) bits * 4k storage.
61 * bitmap storage and IO:
62 * Bitmap is stored little endian on disk, and is kept little endian in
63 * core memory. Currently we still hold the full bitmap in core as long
64 * as we are "attached" to a local disk, which at 32 GiB for 1PiB storage
65 * seems excessive.
67 * We plan to reduce the amount of in-core bitmap pages by paging them in
68 * and out against their on-disk location as necessary, but need to make
69 * sure we don't cause too much meta data IO, and must not deadlock in
70 * tight memory situations. This needs some more work.
74 * NOTE
75 * Access to the *bm_pages is protected by bm_lock.
76 * It is safe to read the other members within the lock.
78 * drbd_bm_set_bits is called from bio_endio callbacks,
79 * We may be called with irq already disabled,
80 * so we need spin_lock_irqsave().
81 * And we need the kmap_atomic.
83 struct drbd_bitmap {
84 struct page **bm_pages;
85 spinlock_t bm_lock;
87 /* exclusively to be used by __al_write_transaction(),
88 * drbd_bm_mark_for_writeout() and
89 * and drbd_bm_write_hinted() -> bm_rw() called from there.
91 unsigned int n_bitmap_hints;
92 unsigned int al_bitmap_hints[AL_UPDATES_PER_TRANSACTION];
94 /* see LIMITATIONS: above */
96 unsigned long bm_set; /* nr of set bits; THINK maybe atomic_t? */
97 unsigned long bm_bits;
98 size_t bm_words;
99 size_t bm_number_of_pages;
100 sector_t bm_dev_capacity;
101 struct mutex bm_change; /* serializes resize operations */
103 wait_queue_head_t bm_io_wait; /* used to serialize IO of single pages */
105 enum bm_flag bm_flags;
107 /* debugging aid, in case we are still racy somewhere */
108 char *bm_why;
109 struct task_struct *bm_task;
112 #define bm_print_lock_info(m) __bm_print_lock_info(m, __func__)
113 static void __bm_print_lock_info(struct drbd_device *device, const char *func)
115 struct drbd_bitmap *b = device->bitmap;
116 if (!__ratelimit(&drbd_ratelimit_state))
117 return;
118 drbd_err(device, "FIXME %s[%d] in %s, bitmap locked for '%s' by %s[%d]\n",
119 current->comm, task_pid_nr(current),
120 func, b->bm_why ?: "?",
121 b->bm_task->comm, task_pid_nr(b->bm_task));
124 void drbd_bm_lock(struct drbd_device *device, char *why, enum bm_flag flags)
126 struct drbd_bitmap *b = device->bitmap;
127 int trylock_failed;
129 if (!b) {
130 drbd_err(device, "FIXME no bitmap in drbd_bm_lock!?\n");
131 return;
134 trylock_failed = !mutex_trylock(&b->bm_change);
136 if (trylock_failed) {
137 drbd_warn(device, "%s[%d] going to '%s' but bitmap already locked for '%s' by %s[%d]\n",
138 current->comm, task_pid_nr(current),
139 why, b->bm_why ?: "?",
140 b->bm_task->comm, task_pid_nr(b->bm_task));
141 mutex_lock(&b->bm_change);
143 if (BM_LOCKED_MASK & b->bm_flags)
144 drbd_err(device, "FIXME bitmap already locked in bm_lock\n");
145 b->bm_flags |= flags & BM_LOCKED_MASK;
147 b->bm_why = why;
148 b->bm_task = current;
151 void drbd_bm_unlock(struct drbd_device *device)
153 struct drbd_bitmap *b = device->bitmap;
154 if (!b) {
155 drbd_err(device, "FIXME no bitmap in drbd_bm_unlock!?\n");
156 return;
159 if (!(BM_LOCKED_MASK & device->bitmap->bm_flags))
160 drbd_err(device, "FIXME bitmap not locked in bm_unlock\n");
162 b->bm_flags &= ~BM_LOCKED_MASK;
163 b->bm_why = NULL;
164 b->bm_task = NULL;
165 mutex_unlock(&b->bm_change);
168 /* we store some "meta" info about our pages in page->private */
169 /* at a granularity of 4k storage per bitmap bit:
170 * one peta byte storage: 1<<50 byte, 1<<38 * 4k storage blocks
171 * 1<<38 bits,
172 * 1<<23 4k bitmap pages.
173 * Use 24 bits as page index, covers 2 peta byte storage
174 * at a granularity of 4k per bit.
175 * Used to report the failed page idx on io error from the endio handlers.
177 #define BM_PAGE_IDX_MASK ((1UL<<24)-1)
178 /* this page is currently read in, or written back */
179 #define BM_PAGE_IO_LOCK 31
180 /* if there has been an IO error for this page */
181 #define BM_PAGE_IO_ERROR 30
182 /* this is to be able to intelligently skip disk IO,
183 * set if bits have been set since last IO. */
184 #define BM_PAGE_NEED_WRITEOUT 29
185 /* to mark for lazy writeout once syncer cleared all clearable bits,
186 * we if bits have been cleared since last IO. */
187 #define BM_PAGE_LAZY_WRITEOUT 28
188 /* pages marked with this "HINT" will be considered for writeout
189 * on activity log transactions */
190 #define BM_PAGE_HINT_WRITEOUT 27
192 /* store_page_idx uses non-atomic assignment. It is only used directly after
193 * allocating the page. All other bm_set_page_* and bm_clear_page_* need to
194 * use atomic bit manipulation, as set_out_of_sync (and therefore bitmap
195 * changes) may happen from various contexts, and wait_on_bit/wake_up_bit
196 * requires it all to be atomic as well. */
197 static void bm_store_page_idx(struct page *page, unsigned long idx)
199 BUG_ON(0 != (idx & ~BM_PAGE_IDX_MASK));
200 set_page_private(page, idx);
203 static unsigned long bm_page_to_idx(struct page *page)
205 return page_private(page) & BM_PAGE_IDX_MASK;
208 /* As is very unlikely that the same page is under IO from more than one
209 * context, we can get away with a bit per page and one wait queue per bitmap.
211 static void bm_page_lock_io(struct drbd_device *device, int page_nr)
213 struct drbd_bitmap *b = device->bitmap;
214 void *addr = &page_private(b->bm_pages[page_nr]);
215 wait_event(b->bm_io_wait, !test_and_set_bit(BM_PAGE_IO_LOCK, addr));
218 static void bm_page_unlock_io(struct drbd_device *device, int page_nr)
220 struct drbd_bitmap *b = device->bitmap;
221 void *addr = &page_private(b->bm_pages[page_nr]);
222 clear_bit_unlock(BM_PAGE_IO_LOCK, addr);
223 wake_up(&device->bitmap->bm_io_wait);
226 /* set _before_ submit_io, so it may be reset due to being changed
227 * while this page is in flight... will get submitted later again */
228 static void bm_set_page_unchanged(struct page *page)
230 /* use cmpxchg? */
231 clear_bit(BM_PAGE_NEED_WRITEOUT, &page_private(page));
232 clear_bit(BM_PAGE_LAZY_WRITEOUT, &page_private(page));
235 static void bm_set_page_need_writeout(struct page *page)
237 set_bit(BM_PAGE_NEED_WRITEOUT, &page_private(page));
240 void drbd_bm_reset_al_hints(struct drbd_device *device)
242 device->bitmap->n_bitmap_hints = 0;
246 * drbd_bm_mark_for_writeout() - mark a page with a "hint" to be considered for writeout
247 * @device: DRBD device.
248 * @page_nr: the bitmap page to mark with the "hint" flag
250 * From within an activity log transaction, we mark a few pages with these
251 * hints, then call drbd_bm_write_hinted(), which will only write out changed
252 * pages which are flagged with this mark.
254 void drbd_bm_mark_for_writeout(struct drbd_device *device, int page_nr)
256 struct drbd_bitmap *b = device->bitmap;
257 struct page *page;
258 if (page_nr >= device->bitmap->bm_number_of_pages) {
259 drbd_warn(device, "BAD: page_nr: %u, number_of_pages: %u\n",
260 page_nr, (int)device->bitmap->bm_number_of_pages);
261 return;
263 page = device->bitmap->bm_pages[page_nr];
264 BUG_ON(b->n_bitmap_hints >= ARRAY_SIZE(b->al_bitmap_hints));
265 if (!test_and_set_bit(BM_PAGE_HINT_WRITEOUT, &page_private(page)))
266 b->al_bitmap_hints[b->n_bitmap_hints++] = page_nr;
269 static int bm_test_page_unchanged(struct page *page)
271 volatile const unsigned long *addr = &page_private(page);
272 return (*addr & ((1UL<<BM_PAGE_NEED_WRITEOUT)|(1UL<<BM_PAGE_LAZY_WRITEOUT))) == 0;
275 static void bm_set_page_io_err(struct page *page)
277 set_bit(BM_PAGE_IO_ERROR, &page_private(page));
280 static void bm_clear_page_io_err(struct page *page)
282 clear_bit(BM_PAGE_IO_ERROR, &page_private(page));
285 static void bm_set_page_lazy_writeout(struct page *page)
287 set_bit(BM_PAGE_LAZY_WRITEOUT, &page_private(page));
290 static int bm_test_page_lazy_writeout(struct page *page)
292 return test_bit(BM_PAGE_LAZY_WRITEOUT, &page_private(page));
295 /* on a 32bit box, this would allow for exactly (2<<38) bits. */
296 static unsigned int bm_word_to_page_idx(struct drbd_bitmap *b, unsigned long long_nr)
298 /* page_nr = (word*sizeof(long)) >> PAGE_SHIFT; */
299 unsigned int page_nr = long_nr >> (PAGE_SHIFT - LN2_BPL + 3);
300 BUG_ON(page_nr >= b->bm_number_of_pages);
301 return page_nr;
304 static unsigned int bm_bit_to_page_idx(struct drbd_bitmap *b, u64 bitnr)
306 /* page_nr = (bitnr/8) >> PAGE_SHIFT; */
307 unsigned int page_nr = bitnr >> (PAGE_SHIFT + 3);
308 BUG_ON(page_nr >= b->bm_number_of_pages);
309 return page_nr;
312 static unsigned long *__bm_map_pidx(struct drbd_bitmap *b, unsigned int idx)
314 struct page *page = b->bm_pages[idx];
315 return (unsigned long *) kmap_atomic(page);
318 static unsigned long *bm_map_pidx(struct drbd_bitmap *b, unsigned int idx)
320 return __bm_map_pidx(b, idx);
323 static void __bm_unmap(unsigned long *p_addr)
325 kunmap_atomic(p_addr);
328 static void bm_unmap(unsigned long *p_addr)
330 return __bm_unmap(p_addr);
333 /* long word offset of _bitmap_ sector */
334 #define S2W(s) ((s)<<(BM_EXT_SHIFT-BM_BLOCK_SHIFT-LN2_BPL))
335 /* word offset from start of bitmap to word number _in_page_
336 * modulo longs per page
337 #define MLPP(X) ((X) % (PAGE_SIZE/sizeof(long))
338 hm, well, Philipp thinks gcc might not optimize the % into & (... - 1)
339 so do it explicitly:
341 #define MLPP(X) ((X) & ((PAGE_SIZE/sizeof(long))-1))
343 /* Long words per page */
344 #define LWPP (PAGE_SIZE/sizeof(long))
347 * actually most functions herein should take a struct drbd_bitmap*, not a
348 * struct drbd_device*, but for the debug macros I like to have the device around
349 * to be able to report device specific.
353 static void bm_free_pages(struct page **pages, unsigned long number)
355 unsigned long i;
356 if (!pages)
357 return;
359 for (i = 0; i < number; i++) {
360 if (!pages[i]) {
361 pr_alert("bm_free_pages tried to free a NULL pointer; i=%lu n=%lu\n",
362 i, number);
363 continue;
365 __free_page(pages[i]);
366 pages[i] = NULL;
370 static inline void bm_vk_free(void *ptr)
372 kvfree(ptr);
376 * "have" and "want" are NUMBER OF PAGES.
378 static struct page **bm_realloc_pages(struct drbd_bitmap *b, unsigned long want)
380 struct page **old_pages = b->bm_pages;
381 struct page **new_pages, *page;
382 unsigned int i, bytes;
383 unsigned long have = b->bm_number_of_pages;
385 BUG_ON(have == 0 && old_pages != NULL);
386 BUG_ON(have != 0 && old_pages == NULL);
388 if (have == want)
389 return old_pages;
391 /* Trying kmalloc first, falling back to vmalloc.
392 * GFP_NOIO, as this is called while drbd IO is "suspended",
393 * and during resize or attach on diskless Primary,
394 * we must not block on IO to ourselves.
395 * Context is receiver thread or dmsetup. */
396 bytes = sizeof(struct page *)*want;
397 new_pages = kzalloc(bytes, GFP_NOIO | __GFP_NOWARN);
398 if (!new_pages) {
399 new_pages = __vmalloc(bytes, GFP_NOIO | __GFP_ZERO);
400 if (!new_pages)
401 return NULL;
404 if (want >= have) {
405 for (i = 0; i < have; i++)
406 new_pages[i] = old_pages[i];
407 for (; i < want; i++) {
408 page = alloc_page(GFP_NOIO | __GFP_HIGHMEM);
409 if (!page) {
410 bm_free_pages(new_pages + have, i - have);
411 bm_vk_free(new_pages);
412 return NULL;
414 /* we want to know which page it is
415 * from the endio handlers */
416 bm_store_page_idx(page, i);
417 new_pages[i] = page;
419 } else {
420 for (i = 0; i < want; i++)
421 new_pages[i] = old_pages[i];
422 /* NOT HERE, we are outside the spinlock!
423 bm_free_pages(old_pages + want, have - want);
427 return new_pages;
431 * allocates the drbd_bitmap and stores it in device->bitmap.
433 int drbd_bm_init(struct drbd_device *device)
435 struct drbd_bitmap *b = device->bitmap;
436 WARN_ON(b != NULL);
437 b = kzalloc(sizeof(struct drbd_bitmap), GFP_KERNEL);
438 if (!b)
439 return -ENOMEM;
440 spin_lock_init(&b->bm_lock);
441 mutex_init(&b->bm_change);
442 init_waitqueue_head(&b->bm_io_wait);
444 device->bitmap = b;
446 return 0;
449 sector_t drbd_bm_capacity(struct drbd_device *device)
451 if (!expect(device->bitmap))
452 return 0;
453 return device->bitmap->bm_dev_capacity;
456 /* called on driver unload. TODO: call when a device is destroyed.
458 void drbd_bm_cleanup(struct drbd_device *device)
460 if (!expect(device->bitmap))
461 return;
462 bm_free_pages(device->bitmap->bm_pages, device->bitmap->bm_number_of_pages);
463 bm_vk_free(device->bitmap->bm_pages);
464 kfree(device->bitmap);
465 device->bitmap = NULL;
469 * since (b->bm_bits % BITS_PER_LONG) != 0,
470 * this masks out the remaining bits.
471 * Returns the number of bits cleared.
473 #ifndef BITS_PER_PAGE
474 #define BITS_PER_PAGE (1UL << (PAGE_SHIFT + 3))
475 #define BITS_PER_PAGE_MASK (BITS_PER_PAGE - 1)
476 #else
477 # if BITS_PER_PAGE != (1UL << (PAGE_SHIFT + 3))
478 # error "ambiguous BITS_PER_PAGE"
479 # endif
480 #endif
481 #define BITS_PER_LONG_MASK (BITS_PER_LONG - 1)
482 static int bm_clear_surplus(struct drbd_bitmap *b)
484 unsigned long mask;
485 unsigned long *p_addr, *bm;
486 int tmp;
487 int cleared = 0;
489 /* number of bits modulo bits per page */
490 tmp = (b->bm_bits & BITS_PER_PAGE_MASK);
491 /* mask the used bits of the word containing the last bit */
492 mask = (1UL << (tmp & BITS_PER_LONG_MASK)) -1;
493 /* bitmap is always stored little endian,
494 * on disk and in core memory alike */
495 mask = cpu_to_lel(mask);
497 p_addr = bm_map_pidx(b, b->bm_number_of_pages - 1);
498 bm = p_addr + (tmp/BITS_PER_LONG);
499 if (mask) {
500 /* If mask != 0, we are not exactly aligned, so bm now points
501 * to the long containing the last bit.
502 * If mask == 0, bm already points to the word immediately
503 * after the last (long word aligned) bit. */
504 cleared = hweight_long(*bm & ~mask);
505 *bm &= mask;
506 bm++;
509 if (BITS_PER_LONG == 32 && ((bm - p_addr) & 1) == 1) {
510 /* on a 32bit arch, we may need to zero out
511 * a padding long to align with a 64bit remote */
512 cleared += hweight_long(*bm);
513 *bm = 0;
515 bm_unmap(p_addr);
516 return cleared;
519 static void bm_set_surplus(struct drbd_bitmap *b)
521 unsigned long mask;
522 unsigned long *p_addr, *bm;
523 int tmp;
525 /* number of bits modulo bits per page */
526 tmp = (b->bm_bits & BITS_PER_PAGE_MASK);
527 /* mask the used bits of the word containing the last bit */
528 mask = (1UL << (tmp & BITS_PER_LONG_MASK)) -1;
529 /* bitmap is always stored little endian,
530 * on disk and in core memory alike */
531 mask = cpu_to_lel(mask);
533 p_addr = bm_map_pidx(b, b->bm_number_of_pages - 1);
534 bm = p_addr + (tmp/BITS_PER_LONG);
535 if (mask) {
536 /* If mask != 0, we are not exactly aligned, so bm now points
537 * to the long containing the last bit.
538 * If mask == 0, bm already points to the word immediately
539 * after the last (long word aligned) bit. */
540 *bm |= ~mask;
541 bm++;
544 if (BITS_PER_LONG == 32 && ((bm - p_addr) & 1) == 1) {
545 /* on a 32bit arch, we may need to zero out
546 * a padding long to align with a 64bit remote */
547 *bm = ~0UL;
549 bm_unmap(p_addr);
552 /* you better not modify the bitmap while this is running,
553 * or its results will be stale */
554 static unsigned long bm_count_bits(struct drbd_bitmap *b)
556 unsigned long *p_addr;
557 unsigned long bits = 0;
558 unsigned long mask = (1UL << (b->bm_bits & BITS_PER_LONG_MASK)) -1;
559 int idx, last_word;
561 /* all but last page */
562 for (idx = 0; idx < b->bm_number_of_pages - 1; idx++) {
563 p_addr = __bm_map_pidx(b, idx);
564 bits += bitmap_weight(p_addr, BITS_PER_PAGE);
565 __bm_unmap(p_addr);
566 cond_resched();
568 /* last (or only) page */
569 last_word = ((b->bm_bits - 1) & BITS_PER_PAGE_MASK) >> LN2_BPL;
570 p_addr = __bm_map_pidx(b, idx);
571 bits += bitmap_weight(p_addr, last_word * BITS_PER_LONG);
572 p_addr[last_word] &= cpu_to_lel(mask);
573 bits += hweight_long(p_addr[last_word]);
574 /* 32bit arch, may have an unused padding long */
575 if (BITS_PER_LONG == 32 && (last_word & 1) == 0)
576 p_addr[last_word+1] = 0;
577 __bm_unmap(p_addr);
578 return bits;
581 /* offset and len in long words.*/
582 static void bm_memset(struct drbd_bitmap *b, size_t offset, int c, size_t len)
584 unsigned long *p_addr, *bm;
585 unsigned int idx;
586 size_t do_now, end;
588 end = offset + len;
590 if (end > b->bm_words) {
591 pr_alert("bm_memset end > bm_words\n");
592 return;
595 while (offset < end) {
596 do_now = min_t(size_t, ALIGN(offset + 1, LWPP), end) - offset;
597 idx = bm_word_to_page_idx(b, offset);
598 p_addr = bm_map_pidx(b, idx);
599 bm = p_addr + MLPP(offset);
600 if (bm+do_now > p_addr + LWPP) {
601 pr_alert("BUG BUG BUG! p_addr:%p bm:%p do_now:%d\n",
602 p_addr, bm, (int)do_now);
603 } else
604 memset(bm, c, do_now * sizeof(long));
605 bm_unmap(p_addr);
606 bm_set_page_need_writeout(b->bm_pages[idx]);
607 offset += do_now;
611 /* For the layout, see comment above drbd_md_set_sector_offsets(). */
612 static u64 drbd_md_on_disk_bits(struct drbd_backing_dev *ldev)
614 u64 bitmap_sectors;
615 if (ldev->md.al_offset == 8)
616 bitmap_sectors = ldev->md.md_size_sect - ldev->md.bm_offset;
617 else
618 bitmap_sectors = ldev->md.al_offset - ldev->md.bm_offset;
619 return bitmap_sectors << (9 + 3);
623 * make sure the bitmap has enough room for the attached storage,
624 * if necessary, resize.
625 * called whenever we may have changed the device size.
626 * returns -ENOMEM if we could not allocate enough memory, 0 on success.
627 * In case this is actually a resize, we copy the old bitmap into the new one.
628 * Otherwise, the bitmap is initialized to all bits set.
630 int drbd_bm_resize(struct drbd_device *device, sector_t capacity, int set_new_bits)
632 struct drbd_bitmap *b = device->bitmap;
633 unsigned long bits, words, owords, obits;
634 unsigned long want, have, onpages; /* number of pages */
635 struct page **npages, **opages = NULL;
636 int err = 0;
637 bool growing;
639 if (!expect(b))
640 return -ENOMEM;
642 drbd_bm_lock(device, "resize", BM_LOCKED_MASK);
644 drbd_info(device, "drbd_bm_resize called with capacity == %llu\n",
645 (unsigned long long)capacity);
647 if (capacity == b->bm_dev_capacity)
648 goto out;
650 if (capacity == 0) {
651 spin_lock_irq(&b->bm_lock);
652 opages = b->bm_pages;
653 onpages = b->bm_number_of_pages;
654 owords = b->bm_words;
655 b->bm_pages = NULL;
656 b->bm_number_of_pages =
657 b->bm_set =
658 b->bm_bits =
659 b->bm_words =
660 b->bm_dev_capacity = 0;
661 spin_unlock_irq(&b->bm_lock);
662 bm_free_pages(opages, onpages);
663 bm_vk_free(opages);
664 goto out;
666 bits = BM_SECT_TO_BIT(ALIGN(capacity, BM_SECT_PER_BIT));
668 /* if we would use
669 words = ALIGN(bits,BITS_PER_LONG) >> LN2_BPL;
670 a 32bit host could present the wrong number of words
671 to a 64bit host.
673 words = ALIGN(bits, 64) >> LN2_BPL;
675 if (get_ldev(device)) {
676 u64 bits_on_disk = drbd_md_on_disk_bits(device->ldev);
677 put_ldev(device);
678 if (bits > bits_on_disk) {
679 drbd_info(device, "bits = %lu\n", bits);
680 drbd_info(device, "bits_on_disk = %llu\n", bits_on_disk);
681 err = -ENOSPC;
682 goto out;
686 want = ALIGN(words*sizeof(long), PAGE_SIZE) >> PAGE_SHIFT;
687 have = b->bm_number_of_pages;
688 if (want == have) {
689 D_ASSERT(device, b->bm_pages != NULL);
690 npages = b->bm_pages;
691 } else {
692 if (drbd_insert_fault(device, DRBD_FAULT_BM_ALLOC))
693 npages = NULL;
694 else
695 npages = bm_realloc_pages(b, want);
698 if (!npages) {
699 err = -ENOMEM;
700 goto out;
703 spin_lock_irq(&b->bm_lock);
704 opages = b->bm_pages;
705 owords = b->bm_words;
706 obits = b->bm_bits;
708 growing = bits > obits;
709 if (opages && growing && set_new_bits)
710 bm_set_surplus(b);
712 b->bm_pages = npages;
713 b->bm_number_of_pages = want;
714 b->bm_bits = bits;
715 b->bm_words = words;
716 b->bm_dev_capacity = capacity;
718 if (growing) {
719 if (set_new_bits) {
720 bm_memset(b, owords, 0xff, words-owords);
721 b->bm_set += bits - obits;
722 } else
723 bm_memset(b, owords, 0x00, words-owords);
727 if (want < have) {
728 /* implicit: (opages != NULL) && (opages != npages) */
729 bm_free_pages(opages + want, have - want);
732 (void)bm_clear_surplus(b);
734 spin_unlock_irq(&b->bm_lock);
735 if (opages != npages)
736 bm_vk_free(opages);
737 if (!growing)
738 b->bm_set = bm_count_bits(b);
739 drbd_info(device, "resync bitmap: bits=%lu words=%lu pages=%lu\n", bits, words, want);
741 out:
742 drbd_bm_unlock(device);
743 return err;
746 /* inherently racy:
747 * if not protected by other means, return value may be out of date when
748 * leaving this function...
749 * we still need to lock it, since it is important that this returns
750 * bm_set == 0 precisely.
752 * maybe bm_set should be atomic_t ?
754 unsigned long _drbd_bm_total_weight(struct drbd_device *device)
756 struct drbd_bitmap *b = device->bitmap;
757 unsigned long s;
758 unsigned long flags;
760 if (!expect(b))
761 return 0;
762 if (!expect(b->bm_pages))
763 return 0;
765 spin_lock_irqsave(&b->bm_lock, flags);
766 s = b->bm_set;
767 spin_unlock_irqrestore(&b->bm_lock, flags);
769 return s;
772 unsigned long drbd_bm_total_weight(struct drbd_device *device)
774 unsigned long s;
775 /* if I don't have a disk, I don't know about out-of-sync status */
776 if (!get_ldev_if_state(device, D_NEGOTIATING))
777 return 0;
778 s = _drbd_bm_total_weight(device);
779 put_ldev(device);
780 return s;
783 size_t drbd_bm_words(struct drbd_device *device)
785 struct drbd_bitmap *b = device->bitmap;
786 if (!expect(b))
787 return 0;
788 if (!expect(b->bm_pages))
789 return 0;
791 return b->bm_words;
794 unsigned long drbd_bm_bits(struct drbd_device *device)
796 struct drbd_bitmap *b = device->bitmap;
797 if (!expect(b))
798 return 0;
800 return b->bm_bits;
803 /* merge number words from buffer into the bitmap starting at offset.
804 * buffer[i] is expected to be little endian unsigned long.
805 * bitmap must be locked by drbd_bm_lock.
806 * currently only used from receive_bitmap.
808 void drbd_bm_merge_lel(struct drbd_device *device, size_t offset, size_t number,
809 unsigned long *buffer)
811 struct drbd_bitmap *b = device->bitmap;
812 unsigned long *p_addr, *bm;
813 unsigned long word, bits;
814 unsigned int idx;
815 size_t end, do_now;
817 end = offset + number;
819 if (!expect(b))
820 return;
821 if (!expect(b->bm_pages))
822 return;
823 if (number == 0)
824 return;
825 WARN_ON(offset >= b->bm_words);
826 WARN_ON(end > b->bm_words);
828 spin_lock_irq(&b->bm_lock);
829 while (offset < end) {
830 do_now = min_t(size_t, ALIGN(offset+1, LWPP), end) - offset;
831 idx = bm_word_to_page_idx(b, offset);
832 p_addr = bm_map_pidx(b, idx);
833 bm = p_addr + MLPP(offset);
834 offset += do_now;
835 while (do_now--) {
836 bits = hweight_long(*bm);
837 word = *bm | *buffer++;
838 *bm++ = word;
839 b->bm_set += hweight_long(word) - bits;
841 bm_unmap(p_addr);
842 bm_set_page_need_writeout(b->bm_pages[idx]);
844 /* with 32bit <-> 64bit cross-platform connect
845 * this is only correct for current usage,
846 * where we _know_ that we are 64 bit aligned,
847 * and know that this function is used in this way, too...
849 if (end == b->bm_words)
850 b->bm_set -= bm_clear_surplus(b);
851 spin_unlock_irq(&b->bm_lock);
854 /* copy number words from the bitmap starting at offset into the buffer.
855 * buffer[i] will be little endian unsigned long.
857 void drbd_bm_get_lel(struct drbd_device *device, size_t offset, size_t number,
858 unsigned long *buffer)
860 struct drbd_bitmap *b = device->bitmap;
861 unsigned long *p_addr, *bm;
862 size_t end, do_now;
864 end = offset + number;
866 if (!expect(b))
867 return;
868 if (!expect(b->bm_pages))
869 return;
871 spin_lock_irq(&b->bm_lock);
872 if ((offset >= b->bm_words) ||
873 (end > b->bm_words) ||
874 (number <= 0))
875 drbd_err(device, "offset=%lu number=%lu bm_words=%lu\n",
876 (unsigned long) offset,
877 (unsigned long) number,
878 (unsigned long) b->bm_words);
879 else {
880 while (offset < end) {
881 do_now = min_t(size_t, ALIGN(offset+1, LWPP), end) - offset;
882 p_addr = bm_map_pidx(b, bm_word_to_page_idx(b, offset));
883 bm = p_addr + MLPP(offset);
884 offset += do_now;
885 while (do_now--)
886 *buffer++ = *bm++;
887 bm_unmap(p_addr);
890 spin_unlock_irq(&b->bm_lock);
893 /* set all bits in the bitmap */
894 void drbd_bm_set_all(struct drbd_device *device)
896 struct drbd_bitmap *b = device->bitmap;
897 if (!expect(b))
898 return;
899 if (!expect(b->bm_pages))
900 return;
902 spin_lock_irq(&b->bm_lock);
903 bm_memset(b, 0, 0xff, b->bm_words);
904 (void)bm_clear_surplus(b);
905 b->bm_set = b->bm_bits;
906 spin_unlock_irq(&b->bm_lock);
909 /* clear all bits in the bitmap */
910 void drbd_bm_clear_all(struct drbd_device *device)
912 struct drbd_bitmap *b = device->bitmap;
913 if (!expect(b))
914 return;
915 if (!expect(b->bm_pages))
916 return;
918 spin_lock_irq(&b->bm_lock);
919 bm_memset(b, 0, 0, b->bm_words);
920 b->bm_set = 0;
921 spin_unlock_irq(&b->bm_lock);
924 static void drbd_bm_aio_ctx_destroy(struct kref *kref)
926 struct drbd_bm_aio_ctx *ctx = container_of(kref, struct drbd_bm_aio_ctx, kref);
927 unsigned long flags;
929 spin_lock_irqsave(&ctx->device->resource->req_lock, flags);
930 list_del(&ctx->list);
931 spin_unlock_irqrestore(&ctx->device->resource->req_lock, flags);
932 put_ldev(ctx->device);
933 kfree(ctx);
936 /* bv_page may be a copy, or may be the original */
937 static void drbd_bm_endio(struct bio *bio)
939 struct drbd_bm_aio_ctx *ctx = bio->bi_private;
940 struct drbd_device *device = ctx->device;
941 struct drbd_bitmap *b = device->bitmap;
942 unsigned int idx = bm_page_to_idx(bio_first_page_all(bio));
944 if ((ctx->flags & BM_AIO_COPY_PAGES) == 0 &&
945 !bm_test_page_unchanged(b->bm_pages[idx]))
946 drbd_warn(device, "bitmap page idx %u changed during IO!\n", idx);
948 if (bio->bi_status) {
949 /* ctx error will hold the completed-last non-zero error code,
950 * in case error codes differ. */
951 ctx->error = blk_status_to_errno(bio->bi_status);
952 bm_set_page_io_err(b->bm_pages[idx]);
953 /* Not identical to on disk version of it.
954 * Is BM_PAGE_IO_ERROR enough? */
955 if (__ratelimit(&drbd_ratelimit_state))
956 drbd_err(device, "IO ERROR %d on bitmap page idx %u\n",
957 bio->bi_status, idx);
958 } else {
959 bm_clear_page_io_err(b->bm_pages[idx]);
960 dynamic_drbd_dbg(device, "bitmap page idx %u completed\n", idx);
963 bm_page_unlock_io(device, idx);
965 if (ctx->flags & BM_AIO_COPY_PAGES)
966 mempool_free(bio->bi_io_vec[0].bv_page, &drbd_md_io_page_pool);
968 bio_put(bio);
970 if (atomic_dec_and_test(&ctx->in_flight)) {
971 ctx->done = 1;
972 wake_up(&device->misc_wait);
973 kref_put(&ctx->kref, &drbd_bm_aio_ctx_destroy);
977 static void bm_page_io_async(struct drbd_bm_aio_ctx *ctx, int page_nr) __must_hold(local)
979 struct bio *bio = bio_alloc_drbd(GFP_NOIO);
980 struct drbd_device *device = ctx->device;
981 struct drbd_bitmap *b = device->bitmap;
982 struct page *page;
983 unsigned int len;
984 unsigned int op = (ctx->flags & BM_AIO_READ) ? REQ_OP_READ : REQ_OP_WRITE;
986 sector_t on_disk_sector =
987 device->ldev->md.md_offset + device->ldev->md.bm_offset;
988 on_disk_sector += ((sector_t)page_nr) << (PAGE_SHIFT-9);
990 /* this might happen with very small
991 * flexible external meta data device,
992 * or with PAGE_SIZE > 4k */
993 len = min_t(unsigned int, PAGE_SIZE,
994 (drbd_md_last_sector(device->ldev) - on_disk_sector + 1)<<9);
996 /* serialize IO on this page */
997 bm_page_lock_io(device, page_nr);
998 /* before memcpy and submit,
999 * so it can be redirtied any time */
1000 bm_set_page_unchanged(b->bm_pages[page_nr]);
1002 if (ctx->flags & BM_AIO_COPY_PAGES) {
1003 page = mempool_alloc(&drbd_md_io_page_pool,
1004 GFP_NOIO | __GFP_HIGHMEM);
1005 copy_highpage(page, b->bm_pages[page_nr]);
1006 bm_store_page_idx(page, page_nr);
1007 } else
1008 page = b->bm_pages[page_nr];
1009 bio_set_dev(bio, device->ldev->md_bdev);
1010 bio->bi_iter.bi_sector = on_disk_sector;
1011 /* bio_add_page of a single page to an empty bio will always succeed,
1012 * according to api. Do we want to assert that? */
1013 bio_add_page(bio, page, len, 0);
1014 bio->bi_private = ctx;
1015 bio->bi_end_io = drbd_bm_endio;
1016 bio_set_op_attrs(bio, op, 0);
1018 if (drbd_insert_fault(device, (op == REQ_OP_WRITE) ? DRBD_FAULT_MD_WR : DRBD_FAULT_MD_RD)) {
1019 bio_io_error(bio);
1020 } else {
1021 submit_bio(bio);
1022 /* this should not count as user activity and cause the
1023 * resync to throttle -- see drbd_rs_should_slow_down(). */
1024 atomic_add(len >> 9, &device->rs_sect_ev);
1029 * bm_rw: read/write the whole bitmap from/to its on disk location.
1031 static int bm_rw(struct drbd_device *device, const unsigned int flags, unsigned lazy_writeout_upper_idx) __must_hold(local)
1033 struct drbd_bm_aio_ctx *ctx;
1034 struct drbd_bitmap *b = device->bitmap;
1035 unsigned int num_pages, i, count = 0;
1036 unsigned long now;
1037 char ppb[10];
1038 int err = 0;
1041 * We are protected against bitmap disappearing/resizing by holding an
1042 * ldev reference (caller must have called get_ldev()).
1043 * For read/write, we are protected against changes to the bitmap by
1044 * the bitmap lock (see drbd_bitmap_io).
1045 * For lazy writeout, we don't care for ongoing changes to the bitmap,
1046 * as we submit copies of pages anyways.
1049 ctx = kmalloc(sizeof(struct drbd_bm_aio_ctx), GFP_NOIO);
1050 if (!ctx)
1051 return -ENOMEM;
1053 *ctx = (struct drbd_bm_aio_ctx) {
1054 .device = device,
1055 .start_jif = jiffies,
1056 .in_flight = ATOMIC_INIT(1),
1057 .done = 0,
1058 .flags = flags,
1059 .error = 0,
1060 .kref = KREF_INIT(2),
1063 if (!get_ldev_if_state(device, D_ATTACHING)) { /* put is in drbd_bm_aio_ctx_destroy() */
1064 drbd_err(device, "ASSERT FAILED: get_ldev_if_state() == 1 in bm_rw()\n");
1065 kfree(ctx);
1066 return -ENODEV;
1068 /* Here D_ATTACHING is sufficient since drbd_bm_read() is called only from
1069 drbd_adm_attach(), after device->ldev was assigned. */
1071 if (0 == (ctx->flags & ~BM_AIO_READ))
1072 WARN_ON(!(BM_LOCKED_MASK & b->bm_flags));
1074 spin_lock_irq(&device->resource->req_lock);
1075 list_add_tail(&ctx->list, &device->pending_bitmap_io);
1076 spin_unlock_irq(&device->resource->req_lock);
1078 num_pages = b->bm_number_of_pages;
1080 now = jiffies;
1082 /* let the layers below us try to merge these bios... */
1084 if (flags & BM_AIO_READ) {
1085 for (i = 0; i < num_pages; i++) {
1086 atomic_inc(&ctx->in_flight);
1087 bm_page_io_async(ctx, i);
1088 ++count;
1089 cond_resched();
1091 } else if (flags & BM_AIO_WRITE_HINTED) {
1092 /* ASSERT: BM_AIO_WRITE_ALL_PAGES is not set. */
1093 unsigned int hint;
1094 for (hint = 0; hint < b->n_bitmap_hints; hint++) {
1095 i = b->al_bitmap_hints[hint];
1096 if (i >= num_pages) /* == -1U: no hint here. */
1097 continue;
1098 /* Several AL-extents may point to the same page. */
1099 if (!test_and_clear_bit(BM_PAGE_HINT_WRITEOUT,
1100 &page_private(b->bm_pages[i])))
1101 continue;
1102 /* Has it even changed? */
1103 if (bm_test_page_unchanged(b->bm_pages[i]))
1104 continue;
1105 atomic_inc(&ctx->in_flight);
1106 bm_page_io_async(ctx, i);
1107 ++count;
1109 } else {
1110 for (i = 0; i < num_pages; i++) {
1111 /* ignore completely unchanged pages */
1112 if (lazy_writeout_upper_idx && i == lazy_writeout_upper_idx)
1113 break;
1114 if (!(flags & BM_AIO_WRITE_ALL_PAGES) &&
1115 bm_test_page_unchanged(b->bm_pages[i])) {
1116 dynamic_drbd_dbg(device, "skipped bm write for idx %u\n", i);
1117 continue;
1119 /* during lazy writeout,
1120 * ignore those pages not marked for lazy writeout. */
1121 if (lazy_writeout_upper_idx &&
1122 !bm_test_page_lazy_writeout(b->bm_pages[i])) {
1123 dynamic_drbd_dbg(device, "skipped bm lazy write for idx %u\n", i);
1124 continue;
1126 atomic_inc(&ctx->in_flight);
1127 bm_page_io_async(ctx, i);
1128 ++count;
1129 cond_resched();
1134 * We initialize ctx->in_flight to one to make sure drbd_bm_endio
1135 * will not set ctx->done early, and decrement / test it here. If there
1136 * are still some bios in flight, we need to wait for them here.
1137 * If all IO is done already (or nothing had been submitted), there is
1138 * no need to wait. Still, we need to put the kref associated with the
1139 * "in_flight reached zero, all done" event.
1141 if (!atomic_dec_and_test(&ctx->in_flight))
1142 wait_until_done_or_force_detached(device, device->ldev, &ctx->done);
1143 else
1144 kref_put(&ctx->kref, &drbd_bm_aio_ctx_destroy);
1146 /* summary for global bitmap IO */
1147 if (flags == 0) {
1148 unsigned int ms = jiffies_to_msecs(jiffies - now);
1149 if (ms > 5) {
1150 drbd_info(device, "bitmap %s of %u pages took %u ms\n",
1151 (flags & BM_AIO_READ) ? "READ" : "WRITE",
1152 count, ms);
1156 if (ctx->error) {
1157 drbd_alert(device, "we had at least one MD IO ERROR during bitmap IO\n");
1158 drbd_chk_io_error(device, 1, DRBD_META_IO_ERROR);
1159 err = -EIO; /* ctx->error ? */
1162 if (atomic_read(&ctx->in_flight))
1163 err = -EIO; /* Disk timeout/force-detach during IO... */
1165 now = jiffies;
1166 if (flags & BM_AIO_READ) {
1167 b->bm_set = bm_count_bits(b);
1168 drbd_info(device, "recounting of set bits took additional %lu jiffies\n",
1169 jiffies - now);
1171 now = b->bm_set;
1173 if ((flags & ~BM_AIO_READ) == 0)
1174 drbd_info(device, "%s (%lu bits) marked out-of-sync by on disk bit-map.\n",
1175 ppsize(ppb, now << (BM_BLOCK_SHIFT-10)), now);
1177 kref_put(&ctx->kref, &drbd_bm_aio_ctx_destroy);
1178 return err;
1182 * drbd_bm_read() - Read the whole bitmap from its on disk location.
1183 * @device: DRBD device.
1185 int drbd_bm_read(struct drbd_device *device) __must_hold(local)
1187 return bm_rw(device, BM_AIO_READ, 0);
1191 * drbd_bm_write() - Write the whole bitmap to its on disk location.
1192 * @device: DRBD device.
1194 * Will only write pages that have changed since last IO.
1196 int drbd_bm_write(struct drbd_device *device) __must_hold(local)
1198 return bm_rw(device, 0, 0);
1202 * drbd_bm_write_all() - Write the whole bitmap to its on disk location.
1203 * @device: DRBD device.
1205 * Will write all pages.
1207 int drbd_bm_write_all(struct drbd_device *device) __must_hold(local)
1209 return bm_rw(device, BM_AIO_WRITE_ALL_PAGES, 0);
1213 * drbd_bm_write_lazy() - Write bitmap pages 0 to @upper_idx-1, if they have changed.
1214 * @device: DRBD device.
1215 * @upper_idx: 0: write all changed pages; +ve: page index to stop scanning for changed pages
1217 int drbd_bm_write_lazy(struct drbd_device *device, unsigned upper_idx) __must_hold(local)
1219 return bm_rw(device, BM_AIO_COPY_PAGES, upper_idx);
1223 * drbd_bm_write_copy_pages() - Write the whole bitmap to its on disk location.
1224 * @device: DRBD device.
1226 * Will only write pages that have changed since last IO.
1227 * In contrast to drbd_bm_write(), this will copy the bitmap pages
1228 * to temporary writeout pages. It is intended to trigger a full write-out
1229 * while still allowing the bitmap to change, for example if a resync or online
1230 * verify is aborted due to a failed peer disk, while local IO continues, or
1231 * pending resync acks are still being processed.
1233 int drbd_bm_write_copy_pages(struct drbd_device *device) __must_hold(local)
1235 return bm_rw(device, BM_AIO_COPY_PAGES, 0);
1239 * drbd_bm_write_hinted() - Write bitmap pages with "hint" marks, if they have changed.
1240 * @device: DRBD device.
1242 int drbd_bm_write_hinted(struct drbd_device *device) __must_hold(local)
1244 return bm_rw(device, BM_AIO_WRITE_HINTED | BM_AIO_COPY_PAGES, 0);
1247 /* NOTE
1248 * find_first_bit returns int, we return unsigned long.
1249 * For this to work on 32bit arch with bitnumbers > (1<<32),
1250 * we'd need to return u64, and get a whole lot of other places
1251 * fixed where we still use unsigned long.
1253 * this returns a bit number, NOT a sector!
1255 static unsigned long __bm_find_next(struct drbd_device *device, unsigned long bm_fo,
1256 const int find_zero_bit)
1258 struct drbd_bitmap *b = device->bitmap;
1259 unsigned long *p_addr;
1260 unsigned long bit_offset;
1261 unsigned i;
1264 if (bm_fo > b->bm_bits) {
1265 drbd_err(device, "bm_fo=%lu bm_bits=%lu\n", bm_fo, b->bm_bits);
1266 bm_fo = DRBD_END_OF_BITMAP;
1267 } else {
1268 while (bm_fo < b->bm_bits) {
1269 /* bit offset of the first bit in the page */
1270 bit_offset = bm_fo & ~BITS_PER_PAGE_MASK;
1271 p_addr = __bm_map_pidx(b, bm_bit_to_page_idx(b, bm_fo));
1273 if (find_zero_bit)
1274 i = find_next_zero_bit_le(p_addr,
1275 PAGE_SIZE*8, bm_fo & BITS_PER_PAGE_MASK);
1276 else
1277 i = find_next_bit_le(p_addr,
1278 PAGE_SIZE*8, bm_fo & BITS_PER_PAGE_MASK);
1280 __bm_unmap(p_addr);
1281 if (i < PAGE_SIZE*8) {
1282 bm_fo = bit_offset + i;
1283 if (bm_fo >= b->bm_bits)
1284 break;
1285 goto found;
1287 bm_fo = bit_offset + PAGE_SIZE*8;
1289 bm_fo = DRBD_END_OF_BITMAP;
1291 found:
1292 return bm_fo;
1295 static unsigned long bm_find_next(struct drbd_device *device,
1296 unsigned long bm_fo, const int find_zero_bit)
1298 struct drbd_bitmap *b = device->bitmap;
1299 unsigned long i = DRBD_END_OF_BITMAP;
1301 if (!expect(b))
1302 return i;
1303 if (!expect(b->bm_pages))
1304 return i;
1306 spin_lock_irq(&b->bm_lock);
1307 if (BM_DONT_TEST & b->bm_flags)
1308 bm_print_lock_info(device);
1310 i = __bm_find_next(device, bm_fo, find_zero_bit);
1312 spin_unlock_irq(&b->bm_lock);
1313 return i;
1316 unsigned long drbd_bm_find_next(struct drbd_device *device, unsigned long bm_fo)
1318 return bm_find_next(device, bm_fo, 0);
1321 #if 0
1322 /* not yet needed for anything. */
1323 unsigned long drbd_bm_find_next_zero(struct drbd_device *device, unsigned long bm_fo)
1325 return bm_find_next(device, bm_fo, 1);
1327 #endif
1329 /* does not spin_lock_irqsave.
1330 * you must take drbd_bm_lock() first */
1331 unsigned long _drbd_bm_find_next(struct drbd_device *device, unsigned long bm_fo)
1333 /* WARN_ON(!(BM_DONT_SET & device->b->bm_flags)); */
1334 return __bm_find_next(device, bm_fo, 0);
1337 unsigned long _drbd_bm_find_next_zero(struct drbd_device *device, unsigned long bm_fo)
1339 /* WARN_ON(!(BM_DONT_SET & device->b->bm_flags)); */
1340 return __bm_find_next(device, bm_fo, 1);
1343 /* returns number of bits actually changed.
1344 * for val != 0, we change 0 -> 1, return code positive
1345 * for val == 0, we change 1 -> 0, return code negative
1346 * wants bitnr, not sector.
1347 * expected to be called for only a few bits (e - s about BITS_PER_LONG).
1348 * Must hold bitmap lock already. */
1349 static int __bm_change_bits_to(struct drbd_device *device, const unsigned long s,
1350 unsigned long e, int val)
1352 struct drbd_bitmap *b = device->bitmap;
1353 unsigned long *p_addr = NULL;
1354 unsigned long bitnr;
1355 unsigned int last_page_nr = -1U;
1356 int c = 0;
1357 int changed_total = 0;
1359 if (e >= b->bm_bits) {
1360 drbd_err(device, "ASSERT FAILED: bit_s=%lu bit_e=%lu bm_bits=%lu\n",
1361 s, e, b->bm_bits);
1362 e = b->bm_bits ? b->bm_bits -1 : 0;
1364 for (bitnr = s; bitnr <= e; bitnr++) {
1365 unsigned int page_nr = bm_bit_to_page_idx(b, bitnr);
1366 if (page_nr != last_page_nr) {
1367 if (p_addr)
1368 __bm_unmap(p_addr);
1369 if (c < 0)
1370 bm_set_page_lazy_writeout(b->bm_pages[last_page_nr]);
1371 else if (c > 0)
1372 bm_set_page_need_writeout(b->bm_pages[last_page_nr]);
1373 changed_total += c;
1374 c = 0;
1375 p_addr = __bm_map_pidx(b, page_nr);
1376 last_page_nr = page_nr;
1378 if (val)
1379 c += (0 == __test_and_set_bit_le(bitnr & BITS_PER_PAGE_MASK, p_addr));
1380 else
1381 c -= (0 != __test_and_clear_bit_le(bitnr & BITS_PER_PAGE_MASK, p_addr));
1383 if (p_addr)
1384 __bm_unmap(p_addr);
1385 if (c < 0)
1386 bm_set_page_lazy_writeout(b->bm_pages[last_page_nr]);
1387 else if (c > 0)
1388 bm_set_page_need_writeout(b->bm_pages[last_page_nr]);
1389 changed_total += c;
1390 b->bm_set += changed_total;
1391 return changed_total;
1394 /* returns number of bits actually changed.
1395 * for val != 0, we change 0 -> 1, return code positive
1396 * for val == 0, we change 1 -> 0, return code negative
1397 * wants bitnr, not sector */
1398 static int bm_change_bits_to(struct drbd_device *device, const unsigned long s,
1399 const unsigned long e, int val)
1401 unsigned long flags;
1402 struct drbd_bitmap *b = device->bitmap;
1403 int c = 0;
1405 if (!expect(b))
1406 return 1;
1407 if (!expect(b->bm_pages))
1408 return 0;
1410 spin_lock_irqsave(&b->bm_lock, flags);
1411 if ((val ? BM_DONT_SET : BM_DONT_CLEAR) & b->bm_flags)
1412 bm_print_lock_info(device);
1414 c = __bm_change_bits_to(device, s, e, val);
1416 spin_unlock_irqrestore(&b->bm_lock, flags);
1417 return c;
1420 /* returns number of bits changed 0 -> 1 */
1421 int drbd_bm_set_bits(struct drbd_device *device, const unsigned long s, const unsigned long e)
1423 return bm_change_bits_to(device, s, e, 1);
1426 /* returns number of bits changed 1 -> 0 */
1427 int drbd_bm_clear_bits(struct drbd_device *device, const unsigned long s, const unsigned long e)
1429 return -bm_change_bits_to(device, s, e, 0);
1432 /* sets all bits in full words,
1433 * from first_word up to, but not including, last_word */
1434 static inline void bm_set_full_words_within_one_page(struct drbd_bitmap *b,
1435 int page_nr, int first_word, int last_word)
1437 int i;
1438 int bits;
1439 int changed = 0;
1440 unsigned long *paddr = kmap_atomic(b->bm_pages[page_nr]);
1442 /* I think it is more cache line friendly to hweight_long then set to ~0UL,
1443 * than to first bitmap_weight() all words, then bitmap_fill() all words */
1444 for (i = first_word; i < last_word; i++) {
1445 bits = hweight_long(paddr[i]);
1446 paddr[i] = ~0UL;
1447 changed += BITS_PER_LONG - bits;
1449 kunmap_atomic(paddr);
1450 if (changed) {
1451 /* We only need lazy writeout, the information is still in the
1452 * remote bitmap as well, and is reconstructed during the next
1453 * bitmap exchange, if lost locally due to a crash. */
1454 bm_set_page_lazy_writeout(b->bm_pages[page_nr]);
1455 b->bm_set += changed;
1459 /* Same thing as drbd_bm_set_bits,
1460 * but more efficient for a large bit range.
1461 * You must first drbd_bm_lock().
1462 * Can be called to set the whole bitmap in one go.
1463 * Sets bits from s to e _inclusive_. */
1464 void _drbd_bm_set_bits(struct drbd_device *device, const unsigned long s, const unsigned long e)
1466 /* First set_bit from the first bit (s)
1467 * up to the next long boundary (sl),
1468 * then assign full words up to the last long boundary (el),
1469 * then set_bit up to and including the last bit (e).
1471 * Do not use memset, because we must account for changes,
1472 * so we need to loop over the words with hweight() anyways.
1474 struct drbd_bitmap *b = device->bitmap;
1475 unsigned long sl = ALIGN(s,BITS_PER_LONG);
1476 unsigned long el = (e+1) & ~((unsigned long)BITS_PER_LONG-1);
1477 int first_page;
1478 int last_page;
1479 int page_nr;
1480 int first_word;
1481 int last_word;
1483 if (e - s <= 3*BITS_PER_LONG) {
1484 /* don't bother; el and sl may even be wrong. */
1485 spin_lock_irq(&b->bm_lock);
1486 __bm_change_bits_to(device, s, e, 1);
1487 spin_unlock_irq(&b->bm_lock);
1488 return;
1491 /* difference is large enough that we can trust sl and el */
1493 spin_lock_irq(&b->bm_lock);
1495 /* bits filling the current long */
1496 if (sl)
1497 __bm_change_bits_to(device, s, sl-1, 1);
1499 first_page = sl >> (3 + PAGE_SHIFT);
1500 last_page = el >> (3 + PAGE_SHIFT);
1502 /* MLPP: modulo longs per page */
1503 /* LWPP: long words per page */
1504 first_word = MLPP(sl >> LN2_BPL);
1505 last_word = LWPP;
1507 /* first and full pages, unless first page == last page */
1508 for (page_nr = first_page; page_nr < last_page; page_nr++) {
1509 bm_set_full_words_within_one_page(device->bitmap, page_nr, first_word, last_word);
1510 spin_unlock_irq(&b->bm_lock);
1511 cond_resched();
1512 first_word = 0;
1513 spin_lock_irq(&b->bm_lock);
1515 /* last page (respectively only page, for first page == last page) */
1516 last_word = MLPP(el >> LN2_BPL);
1518 /* consider bitmap->bm_bits = 32768, bitmap->bm_number_of_pages = 1. (or multiples).
1519 * ==> e = 32767, el = 32768, last_page = 2,
1520 * and now last_word = 0.
1521 * We do not want to touch last_page in this case,
1522 * as we did not allocate it, it is not present in bitmap->bm_pages.
1524 if (last_word)
1525 bm_set_full_words_within_one_page(device->bitmap, last_page, first_word, last_word);
1527 /* possibly trailing bits.
1528 * example: (e & 63) == 63, el will be e+1.
1529 * if that even was the very last bit,
1530 * it would trigger an assert in __bm_change_bits_to()
1532 if (el <= e)
1533 __bm_change_bits_to(device, el, e, 1);
1534 spin_unlock_irq(&b->bm_lock);
1537 /* returns bit state
1538 * wants bitnr, NOT sector.
1539 * inherently racy... area needs to be locked by means of {al,rs}_lru
1540 * 1 ... bit set
1541 * 0 ... bit not set
1542 * -1 ... first out of bounds access, stop testing for bits!
1544 int drbd_bm_test_bit(struct drbd_device *device, const unsigned long bitnr)
1546 unsigned long flags;
1547 struct drbd_bitmap *b = device->bitmap;
1548 unsigned long *p_addr;
1549 int i;
1551 if (!expect(b))
1552 return 0;
1553 if (!expect(b->bm_pages))
1554 return 0;
1556 spin_lock_irqsave(&b->bm_lock, flags);
1557 if (BM_DONT_TEST & b->bm_flags)
1558 bm_print_lock_info(device);
1559 if (bitnr < b->bm_bits) {
1560 p_addr = bm_map_pidx(b, bm_bit_to_page_idx(b, bitnr));
1561 i = test_bit_le(bitnr & BITS_PER_PAGE_MASK, p_addr) ? 1 : 0;
1562 bm_unmap(p_addr);
1563 } else if (bitnr == b->bm_bits) {
1564 i = -1;
1565 } else { /* (bitnr > b->bm_bits) */
1566 drbd_err(device, "bitnr=%lu > bm_bits=%lu\n", bitnr, b->bm_bits);
1567 i = 0;
1570 spin_unlock_irqrestore(&b->bm_lock, flags);
1571 return i;
1574 /* returns number of bits set in the range [s, e] */
1575 int drbd_bm_count_bits(struct drbd_device *device, const unsigned long s, const unsigned long e)
1577 unsigned long flags;
1578 struct drbd_bitmap *b = device->bitmap;
1579 unsigned long *p_addr = NULL;
1580 unsigned long bitnr;
1581 unsigned int page_nr = -1U;
1582 int c = 0;
1584 /* If this is called without a bitmap, that is a bug. But just to be
1585 * robust in case we screwed up elsewhere, in that case pretend there
1586 * was one dirty bit in the requested area, so we won't try to do a
1587 * local read there (no bitmap probably implies no disk) */
1588 if (!expect(b))
1589 return 1;
1590 if (!expect(b->bm_pages))
1591 return 1;
1593 spin_lock_irqsave(&b->bm_lock, flags);
1594 if (BM_DONT_TEST & b->bm_flags)
1595 bm_print_lock_info(device);
1596 for (bitnr = s; bitnr <= e; bitnr++) {
1597 unsigned int idx = bm_bit_to_page_idx(b, bitnr);
1598 if (page_nr != idx) {
1599 page_nr = idx;
1600 if (p_addr)
1601 bm_unmap(p_addr);
1602 p_addr = bm_map_pidx(b, idx);
1604 if (expect(bitnr < b->bm_bits))
1605 c += (0 != test_bit_le(bitnr - (page_nr << (PAGE_SHIFT+3)), p_addr));
1606 else
1607 drbd_err(device, "bitnr=%lu bm_bits=%lu\n", bitnr, b->bm_bits);
1609 if (p_addr)
1610 bm_unmap(p_addr);
1611 spin_unlock_irqrestore(&b->bm_lock, flags);
1612 return c;
1616 /* inherently racy...
1617 * return value may be already out-of-date when this function returns.
1618 * but the general usage is that this is only use during a cstate when bits are
1619 * only cleared, not set, and typically only care for the case when the return
1620 * value is zero, or we already "locked" this "bitmap extent" by other means.
1622 * enr is bm-extent number, since we chose to name one sector (512 bytes)
1623 * worth of the bitmap a "bitmap extent".
1625 * TODO
1626 * I think since we use it like a reference count, we should use the real
1627 * reference count of some bitmap extent element from some lru instead...
1630 int drbd_bm_e_weight(struct drbd_device *device, unsigned long enr)
1632 struct drbd_bitmap *b = device->bitmap;
1633 int count, s, e;
1634 unsigned long flags;
1635 unsigned long *p_addr, *bm;
1637 if (!expect(b))
1638 return 0;
1639 if (!expect(b->bm_pages))
1640 return 0;
1642 spin_lock_irqsave(&b->bm_lock, flags);
1643 if (BM_DONT_TEST & b->bm_flags)
1644 bm_print_lock_info(device);
1646 s = S2W(enr);
1647 e = min((size_t)S2W(enr+1), b->bm_words);
1648 count = 0;
1649 if (s < b->bm_words) {
1650 int n = e-s;
1651 p_addr = bm_map_pidx(b, bm_word_to_page_idx(b, s));
1652 bm = p_addr + MLPP(s);
1653 count += bitmap_weight(bm, n * BITS_PER_LONG);
1654 bm_unmap(p_addr);
1655 } else {
1656 drbd_err(device, "start offset (%d) too large in drbd_bm_e_weight\n", s);
1658 spin_unlock_irqrestore(&b->bm_lock, flags);
1659 return count;