]> git.karo-electronics.de Git - karo-tx-linux.git/blob - drivers/block/drbd/drbd_bitmap.c
drbd: get rid of unused debug code
[karo-tx-linux.git] / drivers / block / drbd / drbd_bitmap.c
1 /*
2    drbd_bitmap.c
3
4    This file is part of DRBD by Philipp Reisner and Lars Ellenberg.
5
6    Copyright (C) 2004-2008, LINBIT Information Technologies GmbH.
7    Copyright (C) 2004-2008, Philipp Reisner <philipp.reisner@linbit.com>.
8    Copyright (C) 2004-2008, Lars Ellenberg <lars.ellenberg@linbit.com>.
9
10    drbd is free software; you can redistribute it and/or modify
11    it under the terms of the GNU General Public License as published by
12    the Free Software Foundation; either version 2, or (at your option)
13    any later version.
14
15    drbd is distributed in the hope that it will be useful,
16    but WITHOUT ANY WARRANTY; without even the implied warranty of
17    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18    GNU General Public License for more details.
19
20    You should have received a copy of the GNU General Public License
21    along with drbd; see the file COPYING.  If not, write to
22    the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
23  */
24
25 #include <linux/bitops.h>
26 #include <linux/vmalloc.h>
27 #include <linux/string.h>
28 #include <linux/drbd.h>
29 #include <linux/slab.h>
30 #include <asm/kmap_types.h>
31 #include "drbd_int.h"
32
33
34 /* OPAQUE outside this file!
35  * interface defined in drbd_int.h
36
37  * convention:
38  * function name drbd_bm_... => used elsewhere, "public".
39  * function name      bm_... => internal to implementation, "private".
40  */
41
42
43 /*
44  * LIMITATIONS:
45  * We want to support >= peta byte of backend storage, while for now still using
46  * a granularity of one bit per 4KiB of storage.
47  * 1 << 50              bytes backend storage (1 PiB)
48  * 1 << (50 - 12)       bits needed
49  *      38 --> we need u64 to index and count bits
50  * 1 << (38 - 3)        bitmap bytes needed
51  *      35 --> we still need u64 to index and count bytes
52  *                      (that's 32 GiB of bitmap for 1 PiB storage)
53  * 1 << (35 - 2)        32bit longs needed
54  *      33 --> we'd even need u64 to index and count 32bit long words.
55  * 1 << (35 - 3)        64bit longs needed
56  *      32 --> we could get away with a 32bit unsigned int to index and count
57  *      64bit long words, but I rather stay with unsigned long for now.
58  *      We probably should neither count nor point to bytes or long words
59  *      directly, but either by bitnumber, or by page index and offset.
60  * 1 << (35 - 12)
61  *      22 --> we need that much 4KiB pages of bitmap.
62  *      1 << (22 + 3) --> on a 64bit arch,
63  *      we need 32 MiB to store the array of page pointers.
64  *
65  * Because I'm lazy, and because the resulting patch was too large, too ugly
66  * and still incomplete, on 32bit we still "only" support 16 TiB (minus some),
67  * (1 << 32) bits * 4k storage.
68  *
69
70  * bitmap storage and IO:
71  *      Bitmap is stored little endian on disk, and is kept little endian in
72  *      core memory. Currently we still hold the full bitmap in core as long
73  *      as we are "attached" to a local disk, which at 32 GiB for 1PiB storage
74  *      seems excessive.
75  *
76  *      We plan to reduce the amount of in-core bitmap pages by pageing them in
77  *      and out against their on-disk location as necessary, but need to make
78  *      sure we don't cause too much meta data IO, and must not deadlock in
79  *      tight memory situations. This needs some more work.
80  */
81
82 /*
83  * NOTE
84  *  Access to the *bm_pages is protected by bm_lock.
85  *  It is safe to read the other members within the lock.
86  *
87  *  drbd_bm_set_bits is called from bio_endio callbacks,
88  *  We may be called with irq already disabled,
89  *  so we need spin_lock_irqsave().
90  *  And we need the kmap_atomic.
91  */
92 struct drbd_bitmap {
93         struct page **bm_pages;
94         spinlock_t bm_lock;
95
96         /* see LIMITATIONS: above */
97
98         unsigned long bm_set;       /* nr of set bits; THINK maybe atomic_t? */
99         unsigned long bm_bits;
100         size_t   bm_words;
101         size_t   bm_number_of_pages;
102         sector_t bm_dev_capacity;
103         struct mutex bm_change; /* serializes resize operations */
104
105         wait_queue_head_t bm_io_wait; /* used to serialize IO of single pages */
106
107         unsigned long  bm_flags;
108
109         /* debugging aid, in case we are still racy somewhere */
110         char          *bm_why;
111         struct task_struct *bm_task;
112 };
113
114 /* definition of bits in bm_flags */
115 #define BM_LOCKED       0
116 // #define BM_MD_IO_ERROR  1 unused now.
117 #define BM_P_VMALLOCED  2
118
119 static int __bm_change_bits_to(struct drbd_conf *mdev, const unsigned long s,
120                                unsigned long e, int val, const enum km_type km);
121
122 static int bm_is_locked(struct drbd_bitmap *b)
123 {
124         return test_bit(BM_LOCKED, &b->bm_flags);
125 }
126
127 #define bm_print_lock_info(m) __bm_print_lock_info(m, __func__)
128 static void __bm_print_lock_info(struct drbd_conf *mdev, const char *func)
129 {
130         struct drbd_bitmap *b = mdev->bitmap;
131         if (!__ratelimit(&drbd_ratelimit_state))
132                 return;
133         dev_err(DEV, "FIXME %s in %s, bitmap locked for '%s' by %s\n",
134             current == mdev->receiver.task ? "receiver" :
135             current == mdev->asender.task  ? "asender"  :
136             current == mdev->worker.task   ? "worker"   : current->comm,
137             func, b->bm_why ?: "?",
138             b->bm_task == mdev->receiver.task ? "receiver" :
139             b->bm_task == mdev->asender.task  ? "asender"  :
140             b->bm_task == mdev->worker.task   ? "worker"   : "?");
141 }
142
143 void drbd_bm_lock(struct drbd_conf *mdev, char *why)
144 {
145         struct drbd_bitmap *b = mdev->bitmap;
146         int trylock_failed;
147
148         if (!b) {
149                 dev_err(DEV, "FIXME no bitmap in drbd_bm_lock!?\n");
150                 return;
151         }
152
153         trylock_failed = !mutex_trylock(&b->bm_change);
154
155         if (trylock_failed) {
156                 dev_warn(DEV, "%s going to '%s' but bitmap already locked for '%s' by %s\n",
157                     current == mdev->receiver.task ? "receiver" :
158                     current == mdev->asender.task  ? "asender"  :
159                     current == mdev->worker.task   ? "worker"   : current->comm,
160                     why, b->bm_why ?: "?",
161                     b->bm_task == mdev->receiver.task ? "receiver" :
162                     b->bm_task == mdev->asender.task  ? "asender"  :
163                     b->bm_task == mdev->worker.task   ? "worker"   : "?");
164                 mutex_lock(&b->bm_change);
165         }
166         if (__test_and_set_bit(BM_LOCKED, &b->bm_flags))
167                 dev_err(DEV, "FIXME bitmap already locked in bm_lock\n");
168
169         b->bm_why  = why;
170         b->bm_task = current;
171 }
172
173 void drbd_bm_unlock(struct drbd_conf *mdev)
174 {
175         struct drbd_bitmap *b = mdev->bitmap;
176         if (!b) {
177                 dev_err(DEV, "FIXME no bitmap in drbd_bm_unlock!?\n");
178                 return;
179         }
180
181         if (!__test_and_clear_bit(BM_LOCKED, &mdev->bitmap->bm_flags))
182                 dev_err(DEV, "FIXME bitmap not locked in bm_unlock\n");
183
184         b->bm_why  = NULL;
185         b->bm_task = NULL;
186         mutex_unlock(&b->bm_change);
187 }
188
189 /* we store some "meta" info about our pages in page->private */
190 /* at a granularity of 4k storage per bitmap bit:
191  * one peta byte storage: 1<<50 byte, 1<<38 * 4k storage blocks
192  *  1<<38 bits,
193  *  1<<23 4k bitmap pages.
194  * Use 24 bits as page index, covers 2 peta byte storage
195  * at a granularity of 4k per bit.
196  * Used to report the failed page idx on io error from the endio handlers.
197  */
198 #define BM_PAGE_IDX_MASK        ((1UL<<24)-1)
199 /* this page is currently read in, or written back */
200 #define BM_PAGE_IO_LOCK         31
201 /* if there has been an IO error for this page */
202 #define BM_PAGE_IO_ERROR        30
203 /* this is to be able to intelligently skip disk IO,
204  * set if bits have been set since last IO. */
205 #define BM_PAGE_NEED_WRITEOUT   29
206 /* to mark for lazy writeout once syncer cleared all clearable bits,
207  * we if bits have been cleared since last IO. */
208 #define BM_PAGE_LAZY_WRITEOUT   28
209
210 /* store_page_idx uses non-atomic assingment. It is only used directly after
211  * allocating the page.  All other bm_set_page_* and bm_clear_page_* need to
212  * use atomic bit manipulation, as set_out_of_sync (and therefore bitmap
213  * changes) may happen from various contexts, and wait_on_bit/wake_up_bit
214  * requires it all to be atomic as well. */
215 static void bm_store_page_idx(struct page *page, unsigned long idx)
216 {
217         BUG_ON(0 != (idx & ~BM_PAGE_IDX_MASK));
218         page_private(page) |= idx;
219 }
220
221 static unsigned long bm_page_to_idx(struct page *page)
222 {
223         return page_private(page) & BM_PAGE_IDX_MASK;
224 }
225
226 /* As is very unlikely that the same page is under IO from more than one
227  * context, we can get away with a bit per page and one wait queue per bitmap.
228  */
229 static void bm_page_lock_io(struct drbd_conf *mdev, int page_nr)
230 {
231         struct drbd_bitmap *b = mdev->bitmap;
232         void *addr = &page_private(b->bm_pages[page_nr]);
233         wait_event(b->bm_io_wait, !test_and_set_bit(BM_PAGE_IO_LOCK, addr));
234 }
235
236 static void bm_page_unlock_io(struct drbd_conf *mdev, int page_nr)
237 {
238         struct drbd_bitmap *b = mdev->bitmap;
239         void *addr = &page_private(b->bm_pages[page_nr]);
240         clear_bit(BM_PAGE_IO_LOCK, addr);
241         smp_mb__after_clear_bit();
242         wake_up(&mdev->bitmap->bm_io_wait);
243 }
244
245 /* set _before_ submit_io, so it may be reset due to being changed
246  * while this page is in flight... will get submitted later again */
247 static void bm_set_page_unchanged(struct page *page)
248 {
249         /* use cmpxchg? */
250         clear_bit(BM_PAGE_NEED_WRITEOUT, &page_private(page));
251         clear_bit(BM_PAGE_LAZY_WRITEOUT, &page_private(page));
252 }
253
254 static void bm_set_page_need_writeout(struct page *page)
255 {
256         set_bit(BM_PAGE_NEED_WRITEOUT, &page_private(page));
257 }
258
259 static int bm_test_page_unchanged(struct page *page)
260 {
261         volatile const unsigned long *addr = &page_private(page);
262         return (*addr & ((1UL<<BM_PAGE_NEED_WRITEOUT)|(1UL<<BM_PAGE_LAZY_WRITEOUT))) == 0;
263 }
264
265 static void bm_set_page_io_err(struct page *page)
266 {
267         set_bit(BM_PAGE_IO_ERROR, &page_private(page));
268 }
269
270 static void bm_clear_page_io_err(struct page *page)
271 {
272         clear_bit(BM_PAGE_IO_ERROR, &page_private(page));
273 }
274
275 static void bm_set_page_lazy_writeout(struct page *page)
276 {
277         set_bit(BM_PAGE_LAZY_WRITEOUT, &page_private(page));
278 }
279
280 static int bm_test_page_lazy_writeout(struct page *page)
281 {
282         return test_bit(BM_PAGE_LAZY_WRITEOUT, &page_private(page));
283 }
284
285 /* on a 32bit box, this would allow for exactly (2<<38) bits. */
286 static unsigned int bm_word_to_page_idx(struct drbd_bitmap *b, unsigned long long_nr)
287 {
288         /* page_nr = (word*sizeof(long)) >> PAGE_SHIFT; */
289         unsigned int page_nr = long_nr >> (PAGE_SHIFT - LN2_BPL + 3);
290         BUG_ON(page_nr >= b->bm_number_of_pages);
291         return page_nr;
292 }
293
294 static unsigned int bm_bit_to_page_idx(struct drbd_bitmap *b, u64 bitnr)
295 {
296         /* page_nr = (bitnr/8) >> PAGE_SHIFT; */
297         unsigned int page_nr = bitnr >> (PAGE_SHIFT + 3);
298         BUG_ON(page_nr >= b->bm_number_of_pages);
299         return page_nr;
300 }
301
302 static unsigned long *__bm_map_pidx(struct drbd_bitmap *b, unsigned int idx, const enum km_type km)
303 {
304         struct page *page = b->bm_pages[idx];
305         return (unsigned long *) kmap_atomic(page, km);
306 }
307
308 static unsigned long *bm_map_pidx(struct drbd_bitmap *b, unsigned int idx)
309 {
310         return __bm_map_pidx(b, idx, KM_IRQ1);
311 }
312
313 static void __bm_unmap(unsigned long *p_addr, const enum km_type km)
314 {
315         kunmap_atomic(p_addr, km);
316 };
317
318 static void bm_unmap(unsigned long *p_addr)
319 {
320         return __bm_unmap(p_addr, KM_IRQ1);
321 }
322
323 /* long word offset of _bitmap_ sector */
324 #define S2W(s)  ((s)<<(BM_EXT_SHIFT-BM_BLOCK_SHIFT-LN2_BPL))
325 /* word offset from start of bitmap to word number _in_page_
326  * modulo longs per page
327 #define MLPP(X) ((X) % (PAGE_SIZE/sizeof(long))
328  hm, well, Philipp thinks gcc might not optimze the % into & (... - 1)
329  so do it explicitly:
330  */
331 #define MLPP(X) ((X) & ((PAGE_SIZE/sizeof(long))-1))
332
333 /* Long words per page */
334 #define LWPP (PAGE_SIZE/sizeof(long))
335
336 /*
337  * actually most functions herein should take a struct drbd_bitmap*, not a
338  * struct drbd_conf*, but for the debug macros I like to have the mdev around
339  * to be able to report device specific.
340  */
341
342
343 static void bm_free_pages(struct page **pages, unsigned long number)
344 {
345         unsigned long i;
346         if (!pages)
347                 return;
348
349         for (i = 0; i < number; i++) {
350                 if (!pages[i]) {
351                         printk(KERN_ALERT "drbd: bm_free_pages tried to free "
352                                           "a NULL pointer; i=%lu n=%lu\n",
353                                           i, number);
354                         continue;
355                 }
356                 __free_page(pages[i]);
357                 pages[i] = NULL;
358         }
359 }
360
361 static void bm_vk_free(void *ptr, int v)
362 {
363         if (v)
364                 vfree(ptr);
365         else
366                 kfree(ptr);
367 }
368
369 /*
370  * "have" and "want" are NUMBER OF PAGES.
371  */
372 static struct page **bm_realloc_pages(struct drbd_bitmap *b, unsigned long want)
373 {
374         struct page **old_pages = b->bm_pages;
375         struct page **new_pages, *page;
376         unsigned int i, bytes, vmalloced = 0;
377         unsigned long have = b->bm_number_of_pages;
378
379         BUG_ON(have == 0 && old_pages != NULL);
380         BUG_ON(have != 0 && old_pages == NULL);
381
382         if (have == want)
383                 return old_pages;
384
385         /* Trying kmalloc first, falling back to vmalloc.
386          * GFP_KERNEL is ok, as this is done when a lower level disk is
387          * "attached" to the drbd.  Context is receiver thread or cqueue
388          * thread.  As we have no disk yet, we are not in the IO path,
389          * not even the IO path of the peer. */
390         bytes = sizeof(struct page *)*want;
391         new_pages = kmalloc(bytes, GFP_KERNEL);
392         if (!new_pages) {
393                 new_pages = vmalloc(bytes);
394                 if (!new_pages)
395                         return NULL;
396                 vmalloced = 1;
397         }
398
399         memset(new_pages, 0, bytes);
400         if (want >= have) {
401                 for (i = 0; i < have; i++)
402                         new_pages[i] = old_pages[i];
403                 for (; i < want; i++) {
404                         page = alloc_page(GFP_HIGHUSER);
405                         if (!page) {
406                                 bm_free_pages(new_pages + have, i - have);
407                                 bm_vk_free(new_pages, vmalloced);
408                                 return NULL;
409                         }
410                         /* we want to know which page it is
411                          * from the endio handlers */
412                         bm_store_page_idx(page, i);
413                         new_pages[i] = page;
414                 }
415         } else {
416                 for (i = 0; i < want; i++)
417                         new_pages[i] = old_pages[i];
418                 /* NOT HERE, we are outside the spinlock!
419                 bm_free_pages(old_pages + want, have - want);
420                 */
421         }
422
423         if (vmalloced)
424                 set_bit(BM_P_VMALLOCED, &b->bm_flags);
425         else
426                 clear_bit(BM_P_VMALLOCED, &b->bm_flags);
427
428         return new_pages;
429 }
430
431 /*
432  * called on driver init only. TODO call when a device is created.
433  * allocates the drbd_bitmap, and stores it in mdev->bitmap.
434  */
435 int drbd_bm_init(struct drbd_conf *mdev)
436 {
437         struct drbd_bitmap *b = mdev->bitmap;
438         WARN_ON(b != NULL);
439         b = kzalloc(sizeof(struct drbd_bitmap), GFP_KERNEL);
440         if (!b)
441                 return -ENOMEM;
442         spin_lock_init(&b->bm_lock);
443         mutex_init(&b->bm_change);
444         init_waitqueue_head(&b->bm_io_wait);
445
446         mdev->bitmap = b;
447
448         return 0;
449 }
450
451 sector_t drbd_bm_capacity(struct drbd_conf *mdev)
452 {
453         ERR_IF(!mdev->bitmap) return 0;
454         return mdev->bitmap->bm_dev_capacity;
455 }
456
457 /* called on driver unload. TODO: call when a device is destroyed.
458  */
459 void drbd_bm_cleanup(struct drbd_conf *mdev)
460 {
461         ERR_IF (!mdev->bitmap) return;
462         bm_free_pages(mdev->bitmap->bm_pages, mdev->bitmap->bm_number_of_pages);
463         bm_vk_free(mdev->bitmap->bm_pages, test_bit(BM_P_VMALLOCED, &mdev->bitmap->bm_flags));
464         kfree(mdev->bitmap);
465         mdev->bitmap = NULL;
466 }
467
468 /*
469  * since (b->bm_bits % BITS_PER_LONG) != 0,
470  * this masks out the remaining bits.
471  * Returns the number of bits cleared.
472  */
473 #define BITS_PER_PAGE           (1UL << (PAGE_SHIFT + 3))
474 #define BITS_PER_PAGE_MASK      (BITS_PER_PAGE - 1)
475 #define BITS_PER_LONG_MASK      (BITS_PER_LONG - 1)
476 static int bm_clear_surplus(struct drbd_bitmap *b)
477 {
478         unsigned long mask;
479         unsigned long *p_addr, *bm;
480         int tmp;
481         int cleared = 0;
482
483         /* number of bits modulo bits per page */
484         tmp = (b->bm_bits & BITS_PER_PAGE_MASK);
485         /* mask the used bits of the word containing the last bit */
486         mask = (1UL << (tmp & BITS_PER_LONG_MASK)) -1;
487         /* bitmap is always stored little endian,
488          * on disk and in core memory alike */
489         mask = cpu_to_lel(mask);
490
491         p_addr = bm_map_pidx(b, b->bm_number_of_pages - 1);
492         bm = p_addr + (tmp/BITS_PER_LONG);
493         if (mask) {
494                 /* If mask != 0, we are not exactly aligned, so bm now points
495                  * to the long containing the last bit.
496                  * If mask == 0, bm already points to the word immediately
497                  * after the last (long word aligned) bit. */
498                 cleared = hweight_long(*bm & ~mask);
499                 *bm &= mask;
500                 bm++;
501         }
502
503         if (BITS_PER_LONG == 32 && ((bm - p_addr) & 1) == 1) {
504                 /* on a 32bit arch, we may need to zero out
505                  * a padding long to align with a 64bit remote */
506                 cleared += hweight_long(*bm);
507                 *bm = 0;
508         }
509         bm_unmap(p_addr);
510         return cleared;
511 }
512
513 static void bm_set_surplus(struct drbd_bitmap *b)
514 {
515         unsigned long mask;
516         unsigned long *p_addr, *bm;
517         int tmp;
518
519         /* number of bits modulo bits per page */
520         tmp = (b->bm_bits & BITS_PER_PAGE_MASK);
521         /* mask the used bits of the word containing the last bit */
522         mask = (1UL << (tmp & BITS_PER_LONG_MASK)) -1;
523         /* bitmap is always stored little endian,
524          * on disk and in core memory alike */
525         mask = cpu_to_lel(mask);
526
527         p_addr = bm_map_pidx(b, b->bm_number_of_pages - 1);
528         bm = p_addr + (tmp/BITS_PER_LONG);
529         if (mask) {
530                 /* If mask != 0, we are not exactly aligned, so bm now points
531                  * to the long containing the last bit.
532                  * If mask == 0, bm already points to the word immediately
533                  * after the last (long word aligned) bit. */
534                 *bm |= ~mask;
535                 bm++;
536         }
537
538         if (BITS_PER_LONG == 32 && ((bm - p_addr) & 1) == 1) {
539                 /* on a 32bit arch, we may need to zero out
540                  * a padding long to align with a 64bit remote */
541                 *bm = ~0UL;
542         }
543         bm_unmap(p_addr);
544 }
545
546 /* you better not modify the bitmap while this is running,
547  * or its results will be stale */
548 static unsigned long bm_count_bits(struct drbd_bitmap *b)
549 {
550         unsigned long *p_addr;
551         unsigned long bits = 0;
552         unsigned long mask = (1UL << (b->bm_bits & BITS_PER_LONG_MASK)) -1;
553         int idx, i, last_word;
554
555         /* all but last page */
556         for (idx = 0; idx < b->bm_number_of_pages - 1; idx++) {
557                 p_addr = __bm_map_pidx(b, idx, KM_USER0);
558                 for (i = 0; i < LWPP; i++)
559                         bits += hweight_long(p_addr[i]);
560                 __bm_unmap(p_addr, KM_USER0);
561                 cond_resched();
562         }
563         /* last (or only) page */
564         last_word = ((b->bm_bits - 1) & BITS_PER_PAGE_MASK) >> LN2_BPL;
565         p_addr = __bm_map_pidx(b, idx, KM_USER0);
566         for (i = 0; i < last_word; i++)
567                 bits += hweight_long(p_addr[i]);
568         p_addr[last_word] &= cpu_to_lel(mask);
569         bits += hweight_long(p_addr[last_word]);
570         /* 32bit arch, may have an unused padding long */
571         if (BITS_PER_LONG == 32 && (last_word & 1) == 0)
572                 p_addr[last_word+1] = 0;
573         __bm_unmap(p_addr, KM_USER0);
574         return bits;
575 }
576
577 /* offset and len in long words.*/
578 static void bm_memset(struct drbd_bitmap *b, size_t offset, int c, size_t len)
579 {
580         unsigned long *p_addr, *bm;
581         unsigned int idx;
582         size_t do_now, end;
583
584         end = offset + len;
585
586         if (end > b->bm_words) {
587                 printk(KERN_ALERT "drbd: bm_memset end > bm_words\n");
588                 return;
589         }
590
591         while (offset < end) {
592                 do_now = min_t(size_t, ALIGN(offset + 1, LWPP), end) - offset;
593                 idx = bm_word_to_page_idx(b, offset);
594                 p_addr = bm_map_pidx(b, idx);
595                 bm = p_addr + MLPP(offset);
596                 if (bm+do_now > p_addr + LWPP) {
597                         printk(KERN_ALERT "drbd: BUG BUG BUG! p_addr:%p bm:%p do_now:%d\n",
598                                p_addr, bm, (int)do_now);
599                         break; /* breaks to after catch_oob_access_end() only! */
600                 }
601                 memset(bm, c, do_now * sizeof(long));
602                 bm_unmap(p_addr);
603                 bm_set_page_need_writeout(b->bm_pages[idx]);
604                 offset += do_now;
605         }
606 }
607
608 /*
609  * make sure the bitmap has enough room for the attached storage,
610  * if necessary, resize.
611  * called whenever we may have changed the device size.
612  * returns -ENOMEM if we could not allocate enough memory, 0 on success.
613  * In case this is actually a resize, we copy the old bitmap into the new one.
614  * Otherwise, the bitmap is initialized to all bits set.
615  */
616 int drbd_bm_resize(struct drbd_conf *mdev, sector_t capacity, int set_new_bits)
617 {
618         struct drbd_bitmap *b = mdev->bitmap;
619         unsigned long bits, words, owords, obits;
620         unsigned long want, have, onpages; /* number of pages */
621         struct page **npages, **opages = NULL;
622         int err = 0, growing;
623         int opages_vmalloced;
624
625         ERR_IF(!b) return -ENOMEM;
626
627         drbd_bm_lock(mdev, "resize");
628
629         dev_info(DEV, "drbd_bm_resize called with capacity == %llu\n",
630                         (unsigned long long)capacity);
631
632         if (capacity == b->bm_dev_capacity)
633                 goto out;
634
635         opages_vmalloced = test_bit(BM_P_VMALLOCED, &b->bm_flags);
636
637         if (capacity == 0) {
638                 spin_lock_irq(&b->bm_lock);
639                 opages = b->bm_pages;
640                 onpages = b->bm_number_of_pages;
641                 owords = b->bm_words;
642                 b->bm_pages = NULL;
643                 b->bm_number_of_pages =
644                 b->bm_set   =
645                 b->bm_bits  =
646                 b->bm_words =
647                 b->bm_dev_capacity = 0;
648                 spin_unlock_irq(&b->bm_lock);
649                 bm_free_pages(opages, onpages);
650                 bm_vk_free(opages, opages_vmalloced);
651                 goto out;
652         }
653         bits  = BM_SECT_TO_BIT(ALIGN(capacity, BM_SECT_PER_BIT));
654
655         /* if we would use
656            words = ALIGN(bits,BITS_PER_LONG) >> LN2_BPL;
657            a 32bit host could present the wrong number of words
658            to a 64bit host.
659         */
660         words = ALIGN(bits, 64) >> LN2_BPL;
661
662         if (get_ldev(mdev)) {
663                 u64 bits_on_disk = ((u64)mdev->ldev->md.md_size_sect-MD_BM_OFFSET) << 12;
664                 put_ldev(mdev);
665                 if (bits > bits_on_disk) {
666                         dev_info(DEV, "bits = %lu\n", bits);
667                         dev_info(DEV, "bits_on_disk = %llu\n", bits_on_disk);
668                         err = -ENOSPC;
669                         goto out;
670                 }
671         }
672
673         want = ALIGN(words*sizeof(long), PAGE_SIZE) >> PAGE_SHIFT;
674         have = b->bm_number_of_pages;
675         if (want == have) {
676                 D_ASSERT(b->bm_pages != NULL);
677                 npages = b->bm_pages;
678         } else {
679                 if (drbd_insert_fault(mdev, DRBD_FAULT_BM_ALLOC))
680                         npages = NULL;
681                 else
682                         npages = bm_realloc_pages(b, want);
683         }
684
685         if (!npages) {
686                 err = -ENOMEM;
687                 goto out;
688         }
689
690         spin_lock_irq(&b->bm_lock);
691         opages = b->bm_pages;
692         owords = b->bm_words;
693         obits  = b->bm_bits;
694
695         growing = bits > obits;
696         if (opages && growing && set_new_bits)
697                 bm_set_surplus(b);
698
699         b->bm_pages = npages;
700         b->bm_number_of_pages = want;
701         b->bm_bits  = bits;
702         b->bm_words = words;
703         b->bm_dev_capacity = capacity;
704
705         if (growing) {
706                 if (set_new_bits) {
707                         bm_memset(b, owords, 0xff, words-owords);
708                         b->bm_set += bits - obits;
709                 } else
710                         bm_memset(b, owords, 0x00, words-owords);
711
712         }
713
714         if (want < have) {
715                 /* implicit: (opages != NULL) && (opages != npages) */
716                 bm_free_pages(opages + want, have - want);
717         }
718
719         (void)bm_clear_surplus(b);
720
721         spin_unlock_irq(&b->bm_lock);
722         if (opages != npages)
723                 bm_vk_free(opages, opages_vmalloced);
724         if (!growing)
725                 b->bm_set = bm_count_bits(b);
726         dev_info(DEV, "resync bitmap: bits=%lu words=%lu pages=%lu\n", bits, words, want);
727
728  out:
729         drbd_bm_unlock(mdev);
730         return err;
731 }
732
733 /* inherently racy:
734  * if not protected by other means, return value may be out of date when
735  * leaving this function...
736  * we still need to lock it, since it is important that this returns
737  * bm_set == 0 precisely.
738  *
739  * maybe bm_set should be atomic_t ?
740  */
741 unsigned long _drbd_bm_total_weight(struct drbd_conf *mdev)
742 {
743         struct drbd_bitmap *b = mdev->bitmap;
744         unsigned long s;
745         unsigned long flags;
746
747         ERR_IF(!b) return 0;
748         ERR_IF(!b->bm_pages) return 0;
749
750         spin_lock_irqsave(&b->bm_lock, flags);
751         s = b->bm_set;
752         spin_unlock_irqrestore(&b->bm_lock, flags);
753
754         return s;
755 }
756
757 unsigned long drbd_bm_total_weight(struct drbd_conf *mdev)
758 {
759         unsigned long s;
760         /* if I don't have a disk, I don't know about out-of-sync status */
761         if (!get_ldev_if_state(mdev, D_NEGOTIATING))
762                 return 0;
763         s = _drbd_bm_total_weight(mdev);
764         put_ldev(mdev);
765         return s;
766 }
767
768 size_t drbd_bm_words(struct drbd_conf *mdev)
769 {
770         struct drbd_bitmap *b = mdev->bitmap;
771         ERR_IF(!b) return 0;
772         ERR_IF(!b->bm_pages) return 0;
773
774         return b->bm_words;
775 }
776
777 unsigned long drbd_bm_bits(struct drbd_conf *mdev)
778 {
779         struct drbd_bitmap *b = mdev->bitmap;
780         ERR_IF(!b) return 0;
781
782         return b->bm_bits;
783 }
784
785 /* merge number words from buffer into the bitmap starting at offset.
786  * buffer[i] is expected to be little endian unsigned long.
787  * bitmap must be locked by drbd_bm_lock.
788  * currently only used from receive_bitmap.
789  */
790 void drbd_bm_merge_lel(struct drbd_conf *mdev, size_t offset, size_t number,
791                         unsigned long *buffer)
792 {
793         struct drbd_bitmap *b = mdev->bitmap;
794         unsigned long *p_addr, *bm;
795         unsigned long word, bits;
796         unsigned int idx;
797         size_t end, do_now;
798
799         end = offset + number;
800
801         ERR_IF(!b) return;
802         ERR_IF(!b->bm_pages) return;
803         if (number == 0)
804                 return;
805         WARN_ON(offset >= b->bm_words);
806         WARN_ON(end    >  b->bm_words);
807
808         spin_lock_irq(&b->bm_lock);
809         while (offset < end) {
810                 do_now = min_t(size_t, ALIGN(offset+1, LWPP), end) - offset;
811                 idx = bm_word_to_page_idx(b, offset);
812                 p_addr = bm_map_pidx(b, idx);
813                 bm = p_addr + MLPP(offset);
814                 offset += do_now;
815                 while (do_now--) {
816                         bits = hweight_long(*bm);
817                         word = *bm | *buffer++;
818                         *bm++ = word;
819                         b->bm_set += hweight_long(word) - bits;
820                 }
821                 bm_unmap(p_addr);
822                 bm_set_page_need_writeout(b->bm_pages[idx]);
823         }
824         /* with 32bit <-> 64bit cross-platform connect
825          * this is only correct for current usage,
826          * where we _know_ that we are 64 bit aligned,
827          * and know that this function is used in this way, too...
828          */
829         if (end == b->bm_words)
830                 b->bm_set -= bm_clear_surplus(b);
831         spin_unlock_irq(&b->bm_lock);
832 }
833
834 /* copy number words from the bitmap starting at offset into the buffer.
835  * buffer[i] will be little endian unsigned long.
836  */
837 void drbd_bm_get_lel(struct drbd_conf *mdev, size_t offset, size_t number,
838                      unsigned long *buffer)
839 {
840         struct drbd_bitmap *b = mdev->bitmap;
841         unsigned long *p_addr, *bm;
842         size_t end, do_now;
843
844         end = offset + number;
845
846         ERR_IF(!b) return;
847         ERR_IF(!b->bm_pages) return;
848
849         spin_lock_irq(&b->bm_lock);
850         if ((offset >= b->bm_words) ||
851             (end    >  b->bm_words) ||
852             (number <= 0))
853                 dev_err(DEV, "offset=%lu number=%lu bm_words=%lu\n",
854                         (unsigned long) offset,
855                         (unsigned long) number,
856                         (unsigned long) b->bm_words);
857         else {
858                 while (offset < end) {
859                         do_now = min_t(size_t, ALIGN(offset+1, LWPP), end) - offset;
860                         p_addr = bm_map_pidx(b, bm_word_to_page_idx(b, offset));
861                         bm = p_addr + MLPP(offset);
862                         offset += do_now;
863                         while (do_now--)
864                                 *buffer++ = *bm++;
865                         bm_unmap(p_addr);
866                 }
867         }
868         spin_unlock_irq(&b->bm_lock);
869 }
870
871 /* set all bits in the bitmap */
872 void drbd_bm_set_all(struct drbd_conf *mdev)
873 {
874         struct drbd_bitmap *b = mdev->bitmap;
875         ERR_IF(!b) return;
876         ERR_IF(!b->bm_pages) return;
877
878         spin_lock_irq(&b->bm_lock);
879         bm_memset(b, 0, 0xff, b->bm_words);
880         (void)bm_clear_surplus(b);
881         b->bm_set = b->bm_bits;
882         spin_unlock_irq(&b->bm_lock);
883 }
884
885 /* clear all bits in the bitmap */
886 void drbd_bm_clear_all(struct drbd_conf *mdev)
887 {
888         struct drbd_bitmap *b = mdev->bitmap;
889         ERR_IF(!b) return;
890         ERR_IF(!b->bm_pages) return;
891
892         spin_lock_irq(&b->bm_lock);
893         bm_memset(b, 0, 0, b->bm_words);
894         b->bm_set = 0;
895         spin_unlock_irq(&b->bm_lock);
896 }
897
898 struct bm_aio_ctx {
899         struct drbd_conf *mdev;
900         atomic_t in_flight;
901         wait_queue_head_t io_wait;
902         unsigned flags;
903 #define BM_AIO_COPY_PAGES       1
904         int error;
905 };
906
907 /* bv_page may be a copy, or may be the original */
908 static void bm_async_io_complete(struct bio *bio, int error)
909 {
910         struct bm_aio_ctx *ctx = bio->bi_private;
911         struct drbd_conf *mdev = ctx->mdev;
912         struct drbd_bitmap *b = mdev->bitmap;
913         unsigned int idx = bm_page_to_idx(bio->bi_io_vec[0].bv_page);
914         int uptodate = bio_flagged(bio, BIO_UPTODATE);
915
916
917         /* strange behavior of some lower level drivers...
918          * fail the request by clearing the uptodate flag,
919          * but do not return any error?!
920          * do we want to WARN() on this? */
921         if (!error && !uptodate)
922                 error = -EIO;
923
924         if (!bm_test_page_unchanged(b->bm_pages[idx]))
925                 dev_info(DEV, "bitmap page idx %u changed during IO!\n", idx);
926
927         if (error) {
928                 /* ctx error will hold the completed-last non-zero error code,
929                  * in case error codes differ. */
930                 ctx->error = error;
931                 bm_set_page_io_err(b->bm_pages[idx]);
932                 /* Not identical to on disk version of it.
933                  * Is BM_PAGE_IO_ERROR enough? */
934                 if (__ratelimit(&drbd_ratelimit_state))
935                         dev_err(DEV, "IO ERROR %d on bitmap page idx %u\n",
936                                         error, idx);
937         } else {
938                 bm_clear_page_io_err(b->bm_pages[idx]);
939                 dynamic_dev_dbg(DEV, "bitmap page idx %u completed\n", idx);
940         }
941
942         bm_page_unlock_io(mdev, idx);
943
944         /* FIXME give back to page pool */
945         if (ctx->flags & BM_AIO_COPY_PAGES)
946                 put_page(bio->bi_io_vec[0].bv_page);
947
948         bio_put(bio);
949
950         if (atomic_dec_and_test(&ctx->in_flight))
951                 wake_up(&ctx->io_wait);
952 }
953
954 static void bm_page_io_async(struct bm_aio_ctx *ctx, int page_nr, int rw) __must_hold(local)
955 {
956         /* we are process context. we always get a bio */
957         struct bio *bio = bio_alloc(GFP_KERNEL, 1);
958         struct drbd_conf *mdev = ctx->mdev;
959         struct drbd_bitmap *b = mdev->bitmap;
960         struct page *page;
961         unsigned int len;
962
963         sector_t on_disk_sector =
964                 mdev->ldev->md.md_offset + mdev->ldev->md.bm_offset;
965         on_disk_sector += ((sector_t)page_nr) << (PAGE_SHIFT-9);
966
967         /* this might happen with very small
968          * flexible external meta data device,
969          * or with PAGE_SIZE > 4k */
970         len = min_t(unsigned int, PAGE_SIZE,
971                 (drbd_md_last_sector(mdev->ldev) - on_disk_sector + 1)<<9);
972
973         /* serialize IO on this page */
974         bm_page_lock_io(mdev, page_nr);
975         /* before memcpy and submit,
976          * so it can be redirtied any time */
977         bm_set_page_unchanged(b->bm_pages[page_nr]);
978
979         if (ctx->flags & BM_AIO_COPY_PAGES) {
980                 /* FIXME alloc_page is good enough for now, but actually needs
981                  * to use pre-allocated page pool */
982                 void *src, *dest;
983                 page = alloc_page(__GFP_HIGHMEM|__GFP_WAIT);
984                 dest = kmap_atomic(page, KM_USER0);
985                 src = kmap_atomic(b->bm_pages[page_nr], KM_USER1);
986                 memcpy(dest, src, PAGE_SIZE);
987                 kunmap_atomic(src, KM_USER1);
988                 kunmap_atomic(dest, KM_USER0);
989                 bm_store_page_idx(page, page_nr);
990         } else
991                 page = b->bm_pages[page_nr];
992
993         bio->bi_bdev = mdev->ldev->md_bdev;
994         bio->bi_sector = on_disk_sector;
995         bio_add_page(bio, page, len, 0);
996         bio->bi_private = ctx;
997         bio->bi_end_io = bm_async_io_complete;
998
999         if (drbd_insert_fault(mdev, (rw & WRITE) ? DRBD_FAULT_MD_WR : DRBD_FAULT_MD_RD)) {
1000                 bio->bi_rw |= rw;
1001                 bio_endio(bio, -EIO);
1002         } else {
1003                 submit_bio(rw, bio);
1004         }
1005 }
1006
1007 /*
1008  * bm_rw: read/write the whole bitmap from/to its on disk location.
1009  */
1010 static int bm_rw(struct drbd_conf *mdev, int rw, unsigned lazy_writeout_upper_idx) __must_hold(local)
1011 {
1012         struct bm_aio_ctx ctx =
1013                 { .flags = lazy_writeout_upper_idx ? BM_AIO_COPY_PAGES : 0 };
1014         struct drbd_bitmap *b = mdev->bitmap;
1015         int num_pages, i, count = 0;
1016         unsigned long now;
1017         char ppb[10];
1018         int err = 0;
1019
1020         /*
1021          * We are protected against bitmap disappearing/resizing by holding an
1022          * ldev reference (caller must have called get_ldev()).
1023          * For read/write, we are protected against changes to the bitmap by
1024          * the bitmap lock (see drbd_bitmap_io).
1025          * For lazy writeout, we don't care for ongoing changes to the bitmap,
1026          * as we submit copies of pages anyways.
1027          */
1028         if (!ctx.flags)
1029                 WARN_ON(!bm_is_locked(b));
1030
1031         num_pages = b->bm_number_of_pages;
1032
1033         now = jiffies;
1034         ctx.mdev = mdev;
1035         atomic_set(&ctx.in_flight, 1); /* one extra ref */
1036         init_waitqueue_head(&ctx.io_wait);
1037         ctx.error = 0;
1038
1039         /* let the layers below us try to merge these bios... */
1040         for (i = 0; i < num_pages; i++) {
1041                 /* ignore completely unchanged pages */
1042                 if (lazy_writeout_upper_idx && i == lazy_writeout_upper_idx)
1043                         break;
1044                 if (rw & WRITE) {
1045                         if (bm_test_page_unchanged(b->bm_pages[i])) {
1046                                 dynamic_dev_dbg(DEV, "skipped bm write for idx %u\n", i);
1047                                 continue;
1048                         }
1049                         /* during lazy writeout,
1050                          * ignore those pages not marked for lazy writeout. */
1051                         if (lazy_writeout_upper_idx &&
1052                             !bm_test_page_lazy_writeout(b->bm_pages[i])) {
1053                                 dynamic_dev_dbg(DEV, "skipped bm lazy write for idx %u\n", i);
1054                                 continue;
1055                         }
1056                 }
1057                 atomic_inc(&ctx.in_flight);
1058                 bm_page_io_async(&ctx, i, rw);
1059                 ++count;
1060                 cond_resched();
1061         }
1062
1063         atomic_dec(&ctx.in_flight); /* drop the extra ref */
1064         wait_event(ctx.io_wait, atomic_read(&ctx.in_flight) == 0);
1065         dev_info(DEV, "bitmap %s of %u pages took %lu jiffies\n",
1066                         rw == WRITE ? "WRITE" : "READ",
1067                         count, jiffies - now);
1068
1069         if (ctx.error) {
1070                 dev_alert(DEV, "we had at least one MD IO ERROR during bitmap IO\n");
1071                 drbd_chk_io_error(mdev, 1, true);
1072                 err = -EIO; /* ctx.error ? */
1073         }
1074
1075         now = jiffies;
1076         if (rw == WRITE) {
1077                 drbd_md_flush(mdev);
1078         } else /* rw == READ */ {
1079                 b->bm_set = bm_count_bits(b);
1080                 dev_info(DEV, "recounting of set bits took additional %lu jiffies\n",
1081                      jiffies - now);
1082         }
1083         now = b->bm_set;
1084
1085         dev_info(DEV, "%s (%lu bits) marked out-of-sync by on disk bit-map.\n",
1086              ppsize(ppb, now << (BM_BLOCK_SHIFT-10)), now);
1087
1088         return err;
1089 }
1090
1091 /**
1092  * drbd_bm_read() - Read the whole bitmap from its on disk location.
1093  * @mdev:       DRBD device.
1094  */
1095 int drbd_bm_read(struct drbd_conf *mdev) __must_hold(local)
1096 {
1097         return bm_rw(mdev, READ, 0);
1098 }
1099
1100 /**
1101  * drbd_bm_write() - Write the whole bitmap to its on disk location.
1102  * @mdev:       DRBD device.
1103  *
1104  * Will only write pages that have changed since last IO.
1105  */
1106 int drbd_bm_write(struct drbd_conf *mdev) __must_hold(local)
1107 {
1108         return bm_rw(mdev, WRITE, 0);
1109 }
1110
1111 /**
1112  * drbd_bm_lazy_write_out() - Write bitmap pages 0 to @upper_idx-1, if they have changed.
1113  * @mdev:       DRBD device.
1114  * @upper_idx:  0: write all changed pages; +ve: page index to stop scanning for changed pages
1115  */
1116 int drbd_bm_write_lazy(struct drbd_conf *mdev, unsigned upper_idx) __must_hold(local)
1117 {
1118         return bm_rw(mdev, WRITE, upper_idx);
1119 }
1120
1121
1122 /**
1123  * drbd_bm_write_page: Writes a PAGE_SIZE aligned piece of bitmap
1124  * @mdev:       DRBD device.
1125  * @idx:        bitmap page index
1126  *
1127  * We don't want to special case on logical_block_size of the backend device,
1128  * so we submit PAGE_SIZE aligned pieces.
1129  * Note that on "most" systems, PAGE_SIZE is 4k.
1130  *
1131  * In case this becomes an issue on systems with larger PAGE_SIZE,
1132  * we may want to change this again to write 4k aligned 4k pieces.
1133  */
1134 int drbd_bm_write_page(struct drbd_conf *mdev, unsigned int idx) __must_hold(local)
1135 {
1136         struct bm_aio_ctx ctx = { .flags = BM_AIO_COPY_PAGES, };
1137
1138         if (bm_test_page_unchanged(mdev->bitmap->bm_pages[idx])) {
1139                 dev_info(DEV, "skipped bm page write for idx %u\n", idx);
1140                 return 0;
1141         }
1142
1143         ctx.mdev = mdev;
1144         atomic_set(&ctx.in_flight, 1);
1145         init_waitqueue_head(&ctx.io_wait);
1146
1147         bm_page_io_async(&ctx, idx, WRITE_SYNC);
1148         wait_event(ctx.io_wait, atomic_read(&ctx.in_flight) == 0);
1149
1150         if (ctx.error)
1151                 drbd_chk_io_error(mdev, 1, true);
1152                 /* that should force detach, so the in memory bitmap will be
1153                  * gone in a moment as well. */
1154
1155         mdev->bm_writ_cnt++;
1156         return ctx.error;
1157 }
1158
1159 /* NOTE
1160  * find_first_bit returns int, we return unsigned long.
1161  * For this to work on 32bit arch with bitnumbers > (1<<32),
1162  * we'd need to return u64, and get a whole lot of other places
1163  * fixed where we still use unsigned long.
1164  *
1165  * this returns a bit number, NOT a sector!
1166  */
1167 static unsigned long __bm_find_next(struct drbd_conf *mdev, unsigned long bm_fo,
1168         const int find_zero_bit, const enum km_type km)
1169 {
1170         struct drbd_bitmap *b = mdev->bitmap;
1171         unsigned long *p_addr;
1172         unsigned long bit_offset;
1173         unsigned i;
1174
1175
1176         if (bm_fo > b->bm_bits) {
1177                 dev_err(DEV, "bm_fo=%lu bm_bits=%lu\n", bm_fo, b->bm_bits);
1178                 bm_fo = DRBD_END_OF_BITMAP;
1179         } else {
1180                 while (bm_fo < b->bm_bits) {
1181                         /* bit offset of the first bit in the page */
1182                         bit_offset = bm_fo & ~BITS_PER_PAGE_MASK;
1183                         p_addr = __bm_map_pidx(b, bm_bit_to_page_idx(b, bm_fo), km);
1184
1185                         if (find_zero_bit)
1186                                 i = generic_find_next_zero_le_bit(p_addr,
1187                                                 PAGE_SIZE*8, bm_fo & BITS_PER_PAGE_MASK);
1188                         else
1189                                 i = generic_find_next_le_bit(p_addr,
1190                                                 PAGE_SIZE*8, bm_fo & BITS_PER_PAGE_MASK);
1191
1192                         __bm_unmap(p_addr, km);
1193                         if (i < PAGE_SIZE*8) {
1194                                 bm_fo = bit_offset + i;
1195                                 if (bm_fo >= b->bm_bits)
1196                                         break;
1197                                 goto found;
1198                         }
1199                         bm_fo = bit_offset + PAGE_SIZE*8;
1200                 }
1201                 bm_fo = DRBD_END_OF_BITMAP;
1202         }
1203  found:
1204         return bm_fo;
1205 }
1206
1207 static unsigned long bm_find_next(struct drbd_conf *mdev,
1208         unsigned long bm_fo, const int find_zero_bit)
1209 {
1210         struct drbd_bitmap *b = mdev->bitmap;
1211         unsigned long i = DRBD_END_OF_BITMAP;
1212
1213         ERR_IF(!b) return i;
1214         ERR_IF(!b->bm_pages) return i;
1215
1216         spin_lock_irq(&b->bm_lock);
1217         if (bm_is_locked(b))
1218                 bm_print_lock_info(mdev);
1219
1220         i = __bm_find_next(mdev, bm_fo, find_zero_bit, KM_IRQ1);
1221
1222         spin_unlock_irq(&b->bm_lock);
1223         return i;
1224 }
1225
1226 unsigned long drbd_bm_find_next(struct drbd_conf *mdev, unsigned long bm_fo)
1227 {
1228         return bm_find_next(mdev, bm_fo, 0);
1229 }
1230
1231 #if 0
1232 /* not yet needed for anything. */
1233 unsigned long drbd_bm_find_next_zero(struct drbd_conf *mdev, unsigned long bm_fo)
1234 {
1235         return bm_find_next(mdev, bm_fo, 1);
1236 }
1237 #endif
1238
1239 /* does not spin_lock_irqsave.
1240  * you must take drbd_bm_lock() first */
1241 unsigned long _drbd_bm_find_next(struct drbd_conf *mdev, unsigned long bm_fo)
1242 {
1243         /* WARN_ON(!bm_is_locked(mdev)); */
1244         return __bm_find_next(mdev, bm_fo, 0, KM_USER1);
1245 }
1246
1247 unsigned long _drbd_bm_find_next_zero(struct drbd_conf *mdev, unsigned long bm_fo)
1248 {
1249         /* WARN_ON(!bm_is_locked(mdev)); */
1250         return __bm_find_next(mdev, bm_fo, 1, KM_USER1);
1251 }
1252
1253 /* returns number of bits actually changed.
1254  * for val != 0, we change 0 -> 1, return code positive
1255  * for val == 0, we change 1 -> 0, return code negative
1256  * wants bitnr, not sector.
1257  * expected to be called for only a few bits (e - s about BITS_PER_LONG).
1258  * Must hold bitmap lock already. */
1259 static int __bm_change_bits_to(struct drbd_conf *mdev, const unsigned long s,
1260         unsigned long e, int val, const enum km_type km)
1261 {
1262         struct drbd_bitmap *b = mdev->bitmap;
1263         unsigned long *p_addr = NULL;
1264         unsigned long bitnr;
1265         unsigned int last_page_nr = -1U;
1266         int c = 0;
1267         int changed_total = 0;
1268
1269         if (e >= b->bm_bits) {
1270                 dev_err(DEV, "ASSERT FAILED: bit_s=%lu bit_e=%lu bm_bits=%lu\n",
1271                                 s, e, b->bm_bits);
1272                 e = b->bm_bits ? b->bm_bits -1 : 0;
1273         }
1274         for (bitnr = s; bitnr <= e; bitnr++) {
1275                 unsigned int page_nr = bm_bit_to_page_idx(b, bitnr);
1276                 if (page_nr != last_page_nr) {
1277                         if (p_addr)
1278                                 __bm_unmap(p_addr, km);
1279                         if (c < 0)
1280                                 bm_set_page_lazy_writeout(b->bm_pages[last_page_nr]);
1281                         else if (c > 0)
1282                                 bm_set_page_need_writeout(b->bm_pages[last_page_nr]);
1283                         changed_total += c;
1284                         c = 0;
1285                         p_addr = __bm_map_pidx(b, page_nr, km);
1286                         last_page_nr = page_nr;
1287                 }
1288                 if (val)
1289                         c += (0 == generic___test_and_set_le_bit(bitnr & BITS_PER_PAGE_MASK, p_addr));
1290                 else
1291                         c -= (0 != generic___test_and_clear_le_bit(bitnr & BITS_PER_PAGE_MASK, p_addr));
1292         }
1293         if (p_addr)
1294                 __bm_unmap(p_addr, km);
1295         if (c < 0)
1296                 bm_set_page_lazy_writeout(b->bm_pages[last_page_nr]);
1297         else if (c > 0)
1298                 bm_set_page_need_writeout(b->bm_pages[last_page_nr]);
1299         changed_total += c;
1300         b->bm_set += changed_total;
1301         return changed_total;
1302 }
1303
1304 /* returns number of bits actually changed.
1305  * for val != 0, we change 0 -> 1, return code positive
1306  * for val == 0, we change 1 -> 0, return code negative
1307  * wants bitnr, not sector */
1308 static int bm_change_bits_to(struct drbd_conf *mdev, const unsigned long s,
1309         const unsigned long e, int val)
1310 {
1311         unsigned long flags;
1312         struct drbd_bitmap *b = mdev->bitmap;
1313         int c = 0;
1314
1315         ERR_IF(!b) return 1;
1316         ERR_IF(!b->bm_pages) return 0;
1317
1318         spin_lock_irqsave(&b->bm_lock, flags);
1319         if (bm_is_locked(b))
1320                 bm_print_lock_info(mdev);
1321
1322         c = __bm_change_bits_to(mdev, s, e, val, KM_IRQ1);
1323
1324         spin_unlock_irqrestore(&b->bm_lock, flags);
1325         return c;
1326 }
1327
1328 /* returns number of bits changed 0 -> 1 */
1329 int drbd_bm_set_bits(struct drbd_conf *mdev, const unsigned long s, const unsigned long e)
1330 {
1331         return bm_change_bits_to(mdev, s, e, 1);
1332 }
1333
1334 /* returns number of bits changed 1 -> 0 */
1335 int drbd_bm_clear_bits(struct drbd_conf *mdev, const unsigned long s, const unsigned long e)
1336 {
1337         return -bm_change_bits_to(mdev, s, e, 0);
1338 }
1339
1340 /* sets all bits in full words,
1341  * from first_word up to, but not including, last_word */
1342 static inline void bm_set_full_words_within_one_page(struct drbd_bitmap *b,
1343                 int page_nr, int first_word, int last_word)
1344 {
1345         int i;
1346         int bits;
1347         unsigned long *paddr = kmap_atomic(b->bm_pages[page_nr], KM_USER0);
1348         for (i = first_word; i < last_word; i++) {
1349                 bits = hweight_long(paddr[i]);
1350                 paddr[i] = ~0UL;
1351                 b->bm_set += BITS_PER_LONG - bits;
1352         }
1353         kunmap_atomic(paddr, KM_USER0);
1354 }
1355
1356 /* Same thing as drbd_bm_set_bits, but without taking the spin_lock_irqsave.
1357  * You must first drbd_bm_lock().
1358  * Can be called to set the whole bitmap in one go.
1359  * Sets bits from s to e _inclusive_. */
1360 void _drbd_bm_set_bits(struct drbd_conf *mdev, const unsigned long s, const unsigned long e)
1361 {
1362         /* First set_bit from the first bit (s)
1363          * up to the next long boundary (sl),
1364          * then assign full words up to the last long boundary (el),
1365          * then set_bit up to and including the last bit (e).
1366          *
1367          * Do not use memset, because we must account for changes,
1368          * so we need to loop over the words with hweight() anyways.
1369          */
1370         unsigned long sl = ALIGN(s,BITS_PER_LONG);
1371         unsigned long el = (e+1) & ~((unsigned long)BITS_PER_LONG-1);
1372         int first_page;
1373         int last_page;
1374         int page_nr;
1375         int first_word;
1376         int last_word;
1377
1378         if (e - s <= 3*BITS_PER_LONG) {
1379                 /* don't bother; el and sl may even be wrong. */
1380                 __bm_change_bits_to(mdev, s, e, 1, KM_USER0);
1381                 return;
1382         }
1383
1384         /* difference is large enough that we can trust sl and el */
1385
1386         /* bits filling the current long */
1387         if (sl)
1388                 __bm_change_bits_to(mdev, s, sl-1, 1, KM_USER0);
1389
1390         first_page = sl >> (3 + PAGE_SHIFT);
1391         last_page = el >> (3 + PAGE_SHIFT);
1392
1393         /* MLPP: modulo longs per page */
1394         /* LWPP: long words per page */
1395         first_word = MLPP(sl >> LN2_BPL);
1396         last_word = LWPP;
1397
1398         /* first and full pages, unless first page == last page */
1399         for (page_nr = first_page; page_nr < last_page; page_nr++) {
1400                 bm_set_full_words_within_one_page(mdev->bitmap, page_nr, first_word, last_word);
1401                 cond_resched();
1402                 first_word = 0;
1403         }
1404
1405         /* last page (respectively only page, for first page == last page) */
1406         last_word = MLPP(el >> LN2_BPL);
1407         bm_set_full_words_within_one_page(mdev->bitmap, last_page, first_word, last_word);
1408
1409         /* possibly trailing bits.
1410          * example: (e & 63) == 63, el will be e+1.
1411          * if that even was the very last bit,
1412          * it would trigger an assert in __bm_change_bits_to()
1413          */
1414         if (el <= e)
1415                 __bm_change_bits_to(mdev, el, e, 1, KM_USER0);
1416 }
1417
1418 /* returns bit state
1419  * wants bitnr, NOT sector.
1420  * inherently racy... area needs to be locked by means of {al,rs}_lru
1421  *  1 ... bit set
1422  *  0 ... bit not set
1423  * -1 ... first out of bounds access, stop testing for bits!
1424  */
1425 int drbd_bm_test_bit(struct drbd_conf *mdev, const unsigned long bitnr)
1426 {
1427         unsigned long flags;
1428         struct drbd_bitmap *b = mdev->bitmap;
1429         unsigned long *p_addr;
1430         int i;
1431
1432         ERR_IF(!b) return 0;
1433         ERR_IF(!b->bm_pages) return 0;
1434
1435         spin_lock_irqsave(&b->bm_lock, flags);
1436         if (bm_is_locked(b))
1437                 bm_print_lock_info(mdev);
1438         if (bitnr < b->bm_bits) {
1439                 p_addr = bm_map_pidx(b, bm_bit_to_page_idx(b, bitnr));
1440                 i = generic_test_le_bit(bitnr & BITS_PER_PAGE_MASK, p_addr) ? 1 : 0;
1441                 bm_unmap(p_addr);
1442         } else if (bitnr == b->bm_bits) {
1443                 i = -1;
1444         } else { /* (bitnr > b->bm_bits) */
1445                 dev_err(DEV, "bitnr=%lu > bm_bits=%lu\n", bitnr, b->bm_bits);
1446                 i = 0;
1447         }
1448
1449         spin_unlock_irqrestore(&b->bm_lock, flags);
1450         return i;
1451 }
1452
1453 /* returns number of bits set in the range [s, e] */
1454 int drbd_bm_count_bits(struct drbd_conf *mdev, const unsigned long s, const unsigned long e)
1455 {
1456         unsigned long flags;
1457         struct drbd_bitmap *b = mdev->bitmap;
1458         unsigned long *p_addr = NULL;
1459         unsigned long bitnr;
1460         unsigned int page_nr = -1U;
1461         int c = 0;
1462
1463         /* If this is called without a bitmap, that is a bug.  But just to be
1464          * robust in case we screwed up elsewhere, in that case pretend there
1465          * was one dirty bit in the requested area, so we won't try to do a
1466          * local read there (no bitmap probably implies no disk) */
1467         ERR_IF(!b) return 1;
1468         ERR_IF(!b->bm_pages) return 1;
1469
1470         spin_lock_irqsave(&b->bm_lock, flags);
1471         if (bm_is_locked(b))
1472                 bm_print_lock_info(mdev);
1473         for (bitnr = s; bitnr <= e; bitnr++) {
1474                 unsigned int idx = bm_bit_to_page_idx(b, bitnr);
1475                 if (page_nr != idx) {
1476                         page_nr = idx;
1477                         if (p_addr)
1478                                 bm_unmap(p_addr);
1479                         p_addr = bm_map_pidx(b, idx);
1480                 }
1481                 ERR_IF (bitnr >= b->bm_bits) {
1482                         dev_err(DEV, "bitnr=%lu bm_bits=%lu\n", bitnr, b->bm_bits);
1483                 } else {
1484                         c += (0 != generic_test_le_bit(bitnr - (page_nr << (PAGE_SHIFT+3)), p_addr));
1485                 }
1486         }
1487         if (p_addr)
1488                 bm_unmap(p_addr);
1489         spin_unlock_irqrestore(&b->bm_lock, flags);
1490         return c;
1491 }
1492
1493
1494 /* inherently racy...
1495  * return value may be already out-of-date when this function returns.
1496  * but the general usage is that this is only use during a cstate when bits are
1497  * only cleared, not set, and typically only care for the case when the return
1498  * value is zero, or we already "locked" this "bitmap extent" by other means.
1499  *
1500  * enr is bm-extent number, since we chose to name one sector (512 bytes)
1501  * worth of the bitmap a "bitmap extent".
1502  *
1503  * TODO
1504  * I think since we use it like a reference count, we should use the real
1505  * reference count of some bitmap extent element from some lru instead...
1506  *
1507  */
1508 int drbd_bm_e_weight(struct drbd_conf *mdev, unsigned long enr)
1509 {
1510         struct drbd_bitmap *b = mdev->bitmap;
1511         int count, s, e;
1512         unsigned long flags;
1513         unsigned long *p_addr, *bm;
1514
1515         ERR_IF(!b) return 0;
1516         ERR_IF(!b->bm_pages) return 0;
1517
1518         spin_lock_irqsave(&b->bm_lock, flags);
1519         if (bm_is_locked(b))
1520                 bm_print_lock_info(mdev);
1521
1522         s = S2W(enr);
1523         e = min((size_t)S2W(enr+1), b->bm_words);
1524         count = 0;
1525         if (s < b->bm_words) {
1526                 int n = e-s;
1527                 p_addr = bm_map_pidx(b, bm_word_to_page_idx(b, s));
1528                 bm = p_addr + MLPP(s);
1529                 while (n--)
1530                         count += hweight_long(*bm++);
1531                 bm_unmap(p_addr);
1532         } else {
1533                 dev_err(DEV, "start offset (%d) too large in drbd_bm_e_weight\n", s);
1534         }
1535         spin_unlock_irqrestore(&b->bm_lock, flags);
1536         return count;
1537 }
1538
1539 /* Set all bits covered by the AL-extent al_enr.
1540  * Returns number of bits changed. */
1541 unsigned long drbd_bm_ALe_set_all(struct drbd_conf *mdev, unsigned long al_enr)
1542 {
1543         struct drbd_bitmap *b = mdev->bitmap;
1544         unsigned long *p_addr, *bm;
1545         unsigned long weight;
1546         unsigned long s, e;
1547         int count, i, do_now;
1548         ERR_IF(!b) return 0;
1549         ERR_IF(!b->bm_pages) return 0;
1550
1551         spin_lock_irq(&b->bm_lock);
1552         if (bm_is_locked(b))
1553                 bm_print_lock_info(mdev);
1554         weight = b->bm_set;
1555
1556         s = al_enr * BM_WORDS_PER_AL_EXT;
1557         e = min_t(size_t, s + BM_WORDS_PER_AL_EXT, b->bm_words);
1558         /* assert that s and e are on the same page */
1559         D_ASSERT((e-1) >> (PAGE_SHIFT - LN2_BPL + 3)
1560               ==  s    >> (PAGE_SHIFT - LN2_BPL + 3));
1561         count = 0;
1562         if (s < b->bm_words) {
1563                 i = do_now = e-s;
1564                 p_addr = bm_map_pidx(b, bm_word_to_page_idx(b, s));
1565                 bm = p_addr + MLPP(s);
1566                 while (i--) {
1567                         count += hweight_long(*bm);
1568                         *bm = -1UL;
1569                         bm++;
1570                 }
1571                 bm_unmap(p_addr);
1572                 b->bm_set += do_now*BITS_PER_LONG - count;
1573                 if (e == b->bm_words)
1574                         b->bm_set -= bm_clear_surplus(b);
1575         } else {
1576                 dev_err(DEV, "start offset (%lu) too large in drbd_bm_ALe_set_all\n", s);
1577         }
1578         weight = b->bm_set - weight;
1579         spin_unlock_irq(&b->bm_lock);
1580         return weight;
1581 }