2 * Copyright (c) 2011-2014 The DragonFly Project. All rights reserved.
4 * This code is derived from software contributed to The DragonFly Project
5 * by Matthew Dillon <dillon@dragonflybsd.org>
6 * by Venkatesh Srinivas <vsrinivas@dragonflybsd.org>
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in
16 * the documentation and/or other materials provided with the
18 * 3. Neither the name of The DragonFly Project nor the names of its
19 * contributors may be used to endorse or promote products derived
20 * from this software without specific, prior written permission.
22 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
25 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
26 * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
27 * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
28 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
29 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
30 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
31 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
32 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
35 #include <sys/param.h>
36 #include <sys/systm.h>
37 #include <sys/kernel.h>
38 #include <sys/fcntl.h>
41 #include <sys/namei.h>
42 #include <sys/mount.h>
43 #include <sys/vnode.h>
44 #include <sys/mountctl.h>
48 #define FREEMAP_DEBUG 0
50 struct hammer2_fiterate {
56 typedef struct hammer2_fiterate hammer2_fiterate_t;
58 static int hammer2_freemap_try_alloc(hammer2_trans_t *trans,
59 hammer2_chain_t **parentp, hammer2_blockref_t *bref,
60 int radix, hammer2_fiterate_t *iter);
61 static void hammer2_freemap_init(hammer2_trans_t *trans, hammer2_dev_t *hmp,
62 hammer2_key_t key, hammer2_chain_t *chain);
63 static int hammer2_bmap_alloc(hammer2_trans_t *trans, hammer2_dev_t *hmp,
64 hammer2_bmap_data_t *bmap, uint16_t class,
65 int n, int radix, hammer2_key_t *basep);
66 static int hammer2_freemap_iterate(hammer2_trans_t *trans,
67 hammer2_chain_t **parentp, hammer2_chain_t **chainp,
68 hammer2_fiterate_t *iter);
72 hammer2_freemapradix(int radix)
78 * Calculate the device offset for the specified FREEMAP_NODE or FREEMAP_LEAF
79 * bref. Return a combined media offset and physical size radix. Freemap
80 * chains use fixed storage offsets in the 4MB reserved area at the
81 * beginning of each 2GB zone
83 * Rotate between four possibilities. Theoretically this means we have three
84 * good freemaps in case of a crash which we can use as a base for the fixup
87 #define H2FMBASE(key, radix) ((key) & ~(((hammer2_off_t)1 << (radix)) - 1))
88 #define H2FMSHIFT(radix) ((hammer2_off_t)1 << (radix))
92 hammer2_freemap_reserve(hammer2_trans_t *trans, hammer2_chain_t *chain,
95 hammer2_blockref_t *bref = &chain->bref;
101 * Physical allocation size -> radix. Typically either 256 for
102 * a level 0 freemap leaf or 65536 for a level N freemap node.
104 * NOTE: A 256 byte bitmap represents 256 x 8 x 1024 = 2MB of storage.
105 * Do not use hammer2_allocsize() here as it has a min cap.
110 * Calculate block selection index 0..7 of current block. If this
111 * is the first allocation of the block (verses a modification of an
112 * existing block), we use index 0, otherwise we use the next rotating
115 if ((bref->data_off & ~HAMMER2_OFF_MASK_RADIX) == 0) {
118 off = bref->data_off & ~HAMMER2_OFF_MASK_RADIX &
119 (((hammer2_off_t)1 <<
120 HAMMER2_FREEMAP_LEVEL1_RADIX) - 1);
121 off = off / HAMMER2_PBUFSIZE;
122 KKASSERT(off >= HAMMER2_ZONE_FREEMAP_00 &&
123 off < HAMMER2_ZONE_FREEMAP_END);
124 index = (int)(off - HAMMER2_ZONE_FREEMAP_00) / 4;
125 KKASSERT(index >= 0 && index < HAMMER2_NFREEMAPS);
126 if (++index == HAMMER2_NFREEMAPS)
131 * Calculate the block offset of the reserved block. This will
132 * point into the 4MB reserved area at the base of the appropriate
133 * 2GB zone, once added to the FREEMAP_x selection above.
135 switch(bref->keybits) {
136 /* case HAMMER2_FREEMAP_LEVEL5_RADIX: not applicable */
137 case HAMMER2_FREEMAP_LEVEL4_RADIX: /* 2EB */
138 KKASSERT(bref->type == HAMMER2_BREF_TYPE_FREEMAP_NODE);
139 KKASSERT(bytes == HAMMER2_FREEMAP_LEVELN_PSIZE);
140 off = H2FMBASE(bref->key, HAMMER2_FREEMAP_LEVEL4_RADIX) +
141 (index * 4 + HAMMER2_ZONE_FREEMAP_00 +
142 HAMMER2_ZONEFM_LEVEL4) * HAMMER2_PBUFSIZE;
144 case HAMMER2_FREEMAP_LEVEL3_RADIX: /* 2PB */
145 KKASSERT(bref->type == HAMMER2_BREF_TYPE_FREEMAP_NODE);
146 KKASSERT(bytes == HAMMER2_FREEMAP_LEVELN_PSIZE);
147 off = H2FMBASE(bref->key, HAMMER2_FREEMAP_LEVEL3_RADIX) +
148 (index * 4 + HAMMER2_ZONE_FREEMAP_00 +
149 HAMMER2_ZONEFM_LEVEL3) * HAMMER2_PBUFSIZE;
151 case HAMMER2_FREEMAP_LEVEL2_RADIX: /* 2TB */
152 KKASSERT(bref->type == HAMMER2_BREF_TYPE_FREEMAP_NODE);
153 KKASSERT(bytes == HAMMER2_FREEMAP_LEVELN_PSIZE);
154 off = H2FMBASE(bref->key, HAMMER2_FREEMAP_LEVEL2_RADIX) +
155 (index * 4 + HAMMER2_ZONE_FREEMAP_00 +
156 HAMMER2_ZONEFM_LEVEL2) * HAMMER2_PBUFSIZE;
158 case HAMMER2_FREEMAP_LEVEL1_RADIX: /* 2GB */
159 KKASSERT(bref->type == HAMMER2_BREF_TYPE_FREEMAP_LEAF);
160 KKASSERT(bytes == HAMMER2_FREEMAP_LEVELN_PSIZE);
161 off = H2FMBASE(bref->key, HAMMER2_FREEMAP_LEVEL1_RADIX) +
162 (index * 4 + HAMMER2_ZONE_FREEMAP_00 +
163 HAMMER2_ZONEFM_LEVEL1) * HAMMER2_PBUFSIZE;
166 panic("freemap: bad radix(2) %p %d\n", bref, bref->keybits);
168 off = (hammer2_off_t)-1;
171 bref->data_off = off | radix;
173 kprintf("FREEMAP BLOCK TYPE %d %016jx/%d DATA_OFF=%016jx\n",
174 bref->type, bref->key, bref->keybits, bref->data_off);
180 * Normal freemap allocator
182 * Use available hints to allocate space using the freemap. Create missing
183 * freemap infrastructure on-the-fly as needed (including marking initial
184 * allocations using the iterator as allocated, instantiating new 2GB zones,
185 * and dealing with the end-of-media edge case).
187 * ip and bpref are only used as a heuristic to determine locality of
188 * reference. bref->key may also be used heuristically.
191 hammer2_freemap_alloc(hammer2_trans_t *trans, hammer2_chain_t *chain,
194 hammer2_dev_t *hmp = chain->hmp;
195 hammer2_blockref_t *bref = &chain->bref;
196 hammer2_chain_t *parent;
200 hammer2_fiterate_t iter;
203 * Validate the allocation size. It must be a power of 2.
205 * For now require that the caller be aware of the minimum
208 radix = hammer2_getradix(bytes);
209 KKASSERT((size_t)1 << radix == bytes);
211 if (bref->type == HAMMER2_BREF_TYPE_FREEMAP_NODE ||
212 bref->type == HAMMER2_BREF_TYPE_FREEMAP_LEAF) {
214 * Freemap blocks themselves are assigned from the reserve
215 * area, not allocated from the freemap.
217 error = hammer2_freemap_reserve(trans, chain, radix);
221 KKASSERT(bytes >= HAMMER2_ALLOC_MIN && bytes <= HAMMER2_ALLOC_MAX);
223 if (trans->flags & (HAMMER2_TRANS_ISFLUSH | HAMMER2_TRANS_PREFLUSH))
227 * Calculate the starting point for our allocation search.
229 * Each freemap leaf is dedicated to a specific freemap_radix.
230 * The freemap_radix can be more fine-grained than the device buffer
231 * radix which results in inodes being grouped together in their
232 * own segment, terminal-data (16K or less) and initial indirect
233 * block being grouped together, and then full-indirect and full-data
234 * blocks (64K) being grouped together.
236 * The single most important aspect of this is the inode grouping
237 * because that is what allows 'find' and 'ls' and other filesystem
238 * topology operations to run fast.
241 if (bref->data_off & ~HAMMER2_OFF_MASK_RADIX)
242 bpref = bref->data_off & ~HAMMER2_OFF_MASK_RADIX;
243 else if (trans->tmp_bpref)
244 bpref = trans->tmp_bpref;
245 else if (trans->tmp_ip)
246 bpref = trans->tmp_ip->chain->bref.data_off;
250 * Heuristic tracking index. We would like one for each distinct
251 * bref type if possible. heur_freemap[] has room for two classes
252 * for each type. At a minimum we have to break-up our heuristic
253 * by device block sizes.
255 hindex = hammer2_devblkradix(radix) - HAMMER2_MINIORADIX;
256 KKASSERT(hindex < HAMMER2_FREEMAP_HEUR_NRADIX);
257 hindex += bref->type * HAMMER2_FREEMAP_HEUR_NRADIX;
258 hindex &= HAMMER2_FREEMAP_HEUR_TYPES * HAMMER2_FREEMAP_HEUR_NRADIX - 1;
259 KKASSERT(hindex < HAMMER2_FREEMAP_HEUR);
261 iter.bpref = hmp->heur_freemap[hindex];
264 * Make sure bpref is in-bounds. It's ok if bpref covers a zone's
265 * reserved area, the try code will iterate past it.
267 if (iter.bpref > hmp->voldata.volu_size)
268 iter.bpref = hmp->voldata.volu_size - 1;
271 * Iterate the freemap looking for free space before and after.
273 parent = &hmp->fchain;
274 hammer2_chain_lock(parent, HAMMER2_RESOLVE_ALWAYS);
276 iter.bnext = iter.bpref;
279 while (error == EAGAIN) {
280 error = hammer2_freemap_try_alloc(trans, &parent, bref,
283 hmp->heur_freemap[hindex] = iter.bnext;
284 hammer2_chain_unlock(parent);
286 if (trans->flags & (HAMMER2_TRANS_ISFLUSH | HAMMER2_TRANS_PREFLUSH))
293 hammer2_freemap_try_alloc(hammer2_trans_t *trans, hammer2_chain_t **parentp,
294 hammer2_blockref_t *bref, int radix,
295 hammer2_fiterate_t *iter)
297 hammer2_dev_t *hmp = (*parentp)->hmp;
298 hammer2_off_t l0size;
299 hammer2_off_t l1size;
300 hammer2_off_t l1mask;
301 hammer2_key_t key_dummy;
302 hammer2_chain_t *chain;
307 int cache_index = -1;
310 * Calculate the number of bytes being allocated, the number
311 * of contiguous bits of bitmap being allocated, and the bitmap
314 * WARNING! cpu hardware may mask bits == 64 -> 0 and blow up the
317 bytes = (size_t)1 << radix;
318 class = (bref->type << 8) | hammer2_devblkradix(radix);
321 * Lookup the level1 freemap chain, creating and initializing one
322 * if necessary. Intermediate levels will be created automatically
323 * when necessary by hammer2_chain_create().
325 key = H2FMBASE(iter->bnext, HAMMER2_FREEMAP_LEVEL1_RADIX);
326 l0size = H2FMSHIFT(HAMMER2_FREEMAP_LEVEL0_RADIX);
327 l1size = H2FMSHIFT(HAMMER2_FREEMAP_LEVEL1_RADIX);
330 chain = hammer2_chain_lookup(parentp, &key_dummy, key, key + l1mask,
332 HAMMER2_LOOKUP_ALWAYS |
333 HAMMER2_LOOKUP_MATCHIND);
337 * Create the missing leaf, be sure to initialize
338 * the auxillary freemap tracking information in
339 * the bref.check.freemap structure.
342 kprintf("freemap create L1 @ %016jx bpref %016jx\n",
345 error = hammer2_chain_create(trans, parentp, &chain, hmp->spmp,
346 key, HAMMER2_FREEMAP_LEVEL1_RADIX,
347 HAMMER2_BREF_TYPE_FREEMAP_LEAF,
348 HAMMER2_FREEMAP_LEVELN_PSIZE,
350 KKASSERT(error == 0);
352 hammer2_chain_modify(trans, chain, 0);
353 bzero(&chain->data->bmdata[0],
354 HAMMER2_FREEMAP_LEVELN_PSIZE);
355 chain->bref.check.freemap.bigmask = (uint32_t)-1;
356 chain->bref.check.freemap.avail = l1size;
357 /* bref.methods should already be inherited */
359 hammer2_freemap_init(trans, hmp, key, chain);
361 } else if (chain->error) {
363 * Error during lookup.
365 kprintf("hammer2_freemap_try_alloc: %016jx: error %s\n",
366 (intmax_t)bref->data_off,
367 hammer2_error_str(chain->error));
369 } else if ((chain->bref.check.freemap.bigmask & (1 << radix)) == 0) {
371 * Already flagged as not having enough space
376 * Modify existing chain to setup for adjustment.
378 hammer2_chain_modify(trans, chain, 0);
385 hammer2_bmap_data_t *bmap;
386 hammer2_key_t base_key;
391 KKASSERT(chain->bref.type == HAMMER2_BREF_TYPE_FREEMAP_LEAF);
392 start = (int)((iter->bnext - key) >>
393 HAMMER2_FREEMAP_LEVEL0_RADIX);
394 KKASSERT(start >= 0 && start < HAMMER2_FREEMAP_COUNT);
395 hammer2_chain_modify(trans, chain, 0);
398 for (count = 0; count < HAMMER2_FREEMAP_COUNT; ++count) {
401 if (start + count >= HAMMER2_FREEMAP_COUNT &&
407 * Calculate bmap pointer
409 * NOTE: bmap pointer is invalid if n >= FREEMAP_COUNT.
412 bmap = &chain->data->bmdata[n];
414 if (n >= HAMMER2_FREEMAP_COUNT) {
416 } else if (bmap->avail) {
418 } else if (radix < HAMMER2_FREEMAP_BLOCK_RADIX &&
419 (bmap->linear & HAMMER2_FREEMAP_BLOCK_MASK)) {
426 (bmap->class == 0 || bmap->class == class)) {
427 base_key = key + n * l0size;
428 error = hammer2_bmap_alloc(trans, hmp, bmap,
431 if (error != ENOSPC) {
438 * Must recalculate after potentially having called
439 * hammer2_bmap_alloc() above in case chain was
442 * NOTE: bmap pointer is invalid if n < 0.
445 bmap = &chain->data->bmdata[n];
448 } else if (bmap->avail) {
450 } else if (radix < HAMMER2_FREEMAP_BLOCK_RADIX &&
451 (bmap->linear & HAMMER2_FREEMAP_BLOCK_MASK)) {
458 (bmap->class == 0 || bmap->class == class)) {
459 base_key = key + n * l0size;
460 error = hammer2_bmap_alloc(trans, hmp, bmap,
463 if (error != ENOSPC) {
470 chain->bref.check.freemap.bigmask &= ~(1 << radix);
471 /* XXX also scan down from original count */
476 * Assert validity. Must be beyond the static allocator used
477 * by newfs_hammer2 (and thus also beyond the aux area),
478 * not go past the volume size, and must not be in the
479 * reserved segment area for a zone.
481 KKASSERT(key >= hmp->voldata.allocator_beg &&
482 key + bytes <= hmp->voldata.volu_size);
483 KKASSERT((key & HAMMER2_ZONE_MASK64) >= HAMMER2_ZONE_SEG);
484 bref->data_off = key | radix;
487 kprintf("alloc cp=%p %016jx %016jx using %016jx\n",
489 bref->key, bref->data_off, chain->bref.data_off);
491 } else if (error == ENOSPC) {
493 * Return EAGAIN with next iteration in iter->bnext, or
494 * return ENOSPC if the allocation map has been exhausted.
496 error = hammer2_freemap_iterate(trans, parentp, &chain, iter);
503 hammer2_chain_unlock(chain);
508 * Allocate (1<<radix) bytes from the bmap whos base data offset is (*basep).
510 * If the linear iterator is mid-block we use it directly (the bitmap should
511 * already be marked allocated), otherwise we search for a block in the bitmap
512 * that fits the allocation request.
514 * A partial bitmap allocation sets the minimum bitmap granularity (16KB)
515 * to fully allocated and adjusts the linear allocator to allow the
516 * remaining space to be allocated.
520 hammer2_bmap_alloc(hammer2_trans_t *trans, hammer2_dev_t *hmp,
521 hammer2_bmap_data_t *bmap,
522 uint16_t class, int n, int radix, hammer2_key_t *basep)
535 * Take into account 2-bits per block when calculating bmradix.
537 size = (size_t)1 << radix;
539 if (radix <= HAMMER2_FREEMAP_BLOCK_RADIX) {
541 /* (16K) 2 bits per allocation block */
543 bmradix = 2 << (radix - HAMMER2_FREEMAP_BLOCK_RADIX);
544 /* (32K-256K) 4, 8, 16, 32 bits per allocation block */
548 * Use the linear iterator to pack small allocations, otherwise
549 * fall-back to finding a free 16KB chunk. The linear iterator
550 * is only valid when *NOT* on a freemap chunking boundary (16KB).
551 * If it is the bitmap must be scanned. It can become invalid
552 * once we pack to the boundary. We adjust it after a bitmap
553 * allocation only for sub-16KB allocations (so the perfectly good
554 * previous value can still be used for fragments when 16KB+
555 * allocations are made).
557 * Beware of hardware artifacts when bmradix == 32 (intermediate
558 * result can wind up being '1' instead of '0' if hardware masks
561 * NOTE: j needs to be even in the j= calculation. As an artifact
562 * of the /2 division, our bitmask has to clear bit 0.
564 * NOTE: TODO this can leave little unallocatable fragments lying
567 if (((uint32_t)bmap->linear & HAMMER2_FREEMAP_BLOCK_MASK) + size <=
568 HAMMER2_FREEMAP_BLOCK_SIZE &&
569 (bmap->linear & HAMMER2_FREEMAP_BLOCK_MASK) &&
570 bmap->linear < HAMMER2_SEGSIZE) {
571 KKASSERT(bmap->linear >= 0 &&
572 bmap->linear + size <= HAMMER2_SEGSIZE &&
573 (bmap->linear & (HAMMER2_ALLOC_MIN - 1)) == 0);
574 offset = bmap->linear;
575 i = offset / (HAMMER2_SEGSIZE / 8);
576 j = (offset / (HAMMER2_FREEMAP_BLOCK_SIZE / 2)) & 30;
577 bmmask = (bmradix == 32) ?
578 0xFFFFFFFFU : (1 << bmradix) - 1;
580 bmap->linear = offset + size;
582 for (i = 0; i < 8; ++i) {
583 bmmask = (bmradix == 32) ?
584 0xFFFFFFFFU : (1 << bmradix) - 1;
585 for (j = 0; j < 32; j += bmradix) {
586 if ((bmap->bitmap[i] & bmmask) == 0)
591 /*fragments might remain*/
592 /*KKASSERT(bmap->avail == 0);*/
595 offset = i * (HAMMER2_SEGSIZE / 8) +
596 (j * (HAMMER2_FREEMAP_BLOCK_SIZE / 2));
597 if (size & HAMMER2_FREEMAP_BLOCK_MASK)
598 bmap->linear = offset + size;
601 KKASSERT(i >= 0 && i < 8); /* 8 x 16 -> 128 x 16K -> 2MB */
604 * Optimize the buffer cache to avoid unnecessary read-before-write
607 * The device block size could be larger than the allocation size
608 * so the actual bitmap test is somewhat more involved. We have
609 * to use a compatible buffer size for this operation.
611 if ((bmap->bitmap[i] & bmmask) == 0 &&
612 hammer2_devblksize(size) != size) {
613 size_t psize = hammer2_devblksize(size);
614 hammer2_off_t pmask = (hammer2_off_t)psize - 1;
615 int pbmradix = 2 << (hammer2_devblkradix(radix) -
616 HAMMER2_FREEMAP_BLOCK_RADIX);
618 int pradix = hammer2_getradix(psize);
620 pbmmask = (pbmradix == 32) ? 0xFFFFFFFFU : (1 << pbmradix) - 1;
621 while ((pbmmask & bmmask) == 0)
622 pbmmask <<= pbmradix;
625 kprintf("%016jx mask %08x %08x %08x (%zd/%zd)\n",
626 *basep + offset, bmap->bitmap[i],
627 pbmmask, bmmask, size, psize);
630 if ((bmap->bitmap[i] & pbmmask) == 0) {
631 error = hammer2_io_newq(hmp,
632 (*basep + (offset & ~pmask)) |
635 hammer2_io_bqrelse(&dio);
641 * When initializing a new inode segment also attempt to initialize
642 * an adjacent segment. Be careful not to index beyond the array
645 * We do this to try to localize inode accesses to improve
646 * directory scan rates. XXX doesn't improve scan rates.
648 if (size == HAMMER2_INODE_BYTES) {
650 if (bmap[-1].radix == 0 && bmap[-1].avail)
651 bmap[-1].radix = radix;
653 if (bmap[1].radix == 0 && bmap[1].avail)
654 bmap[1].radix = radix;
659 * Calculate the bitmap-granular change in bgsize for the volume
660 * header. We cannot use the fine-grained change here because
661 * the bulkfree code can't undo it. If the bitmap element is already
662 * marked allocated it has already been accounted for.
664 if (radix < HAMMER2_FREEMAP_BLOCK_RADIX) {
665 if (bmap->bitmap[i] & bmmask)
668 bgsize = HAMMER2_FREEMAP_BLOCK_SIZE;
674 * Adjust the bitmap, set the class (it might have been 0),
675 * and available bytes, update the allocation offset (*basep)
676 * from the L0 base to the actual offset.
678 * avail must reflect the bitmap-granular availability. The allocator
679 * tests will also check the linear iterator.
681 bmap->bitmap[i] |= bmmask;
683 bmap->avail -= bgsize;
687 * Adjust the volume header's allocator_free parameter. This
688 * parameter has to be fixed up by bulkfree which has no way to
689 * figure out sub-16K chunking, so it must be adjusted by the
690 * bitmap-granular size.
693 hammer2_voldata_lock(hmp);
694 hammer2_voldata_modify(hmp);
695 hmp->voldata.allocator_free -= bgsize;
696 hammer2_voldata_unlock(hmp);
704 hammer2_freemap_init(hammer2_trans_t *trans, hammer2_dev_t *hmp,
705 hammer2_key_t key, hammer2_chain_t *chain)
707 hammer2_off_t l1size;
710 hammer2_bmap_data_t *bmap;
713 l1size = H2FMSHIFT(HAMMER2_FREEMAP_LEVEL1_RADIX);
716 * Calculate the portion of the 2GB map that should be initialized
717 * as free. Portions below or after will be initialized as allocated.
718 * SEGMASK-align the areas so we don't have to worry about sub-scans
719 * or endianess when using memset.
721 * (1) Ensure that all statically allocated space from newfs_hammer2
722 * is marked allocated.
724 * (2) Ensure that the reserved area is marked allocated (typically
725 * the first 4MB of the 2GB area being represented).
727 * (3) Ensure that any trailing space at the end-of-volume is marked
730 * WARNING! It is possible for lokey to be larger than hikey if the
731 * entire 2GB segment is within the static allocation.
733 lokey = (hmp->voldata.allocator_beg + HAMMER2_SEGMASK64) &
736 if (lokey < H2FMBASE(key, HAMMER2_FREEMAP_LEVEL1_RADIX) +
737 HAMMER2_ZONE_SEG64) {
738 lokey = H2FMBASE(key, HAMMER2_FREEMAP_LEVEL1_RADIX) +
742 hikey = key + H2FMSHIFT(HAMMER2_FREEMAP_LEVEL1_RADIX);
743 if (hikey > hmp->voldata.volu_size) {
744 hikey = hmp->voldata.volu_size & ~HAMMER2_SEGMASK64;
747 chain->bref.check.freemap.avail =
748 H2FMSHIFT(HAMMER2_FREEMAP_LEVEL1_RADIX);
749 bmap = &chain->data->bmdata[0];
751 for (count = 0; count < HAMMER2_FREEMAP_COUNT; ++count) {
752 if (key < lokey || key >= hikey) {
753 memset(bmap->bitmap, -1,
754 sizeof(bmap->bitmap));
756 bmap->linear = HAMMER2_SEGSIZE;
757 chain->bref.check.freemap.avail -=
758 H2FMSHIFT(HAMMER2_FREEMAP_LEVEL0_RADIX);
760 bmap->avail = H2FMSHIFT(HAMMER2_FREEMAP_LEVEL0_RADIX);
762 key += H2FMSHIFT(HAMMER2_FREEMAP_LEVEL0_RADIX);
768 * The current Level 1 freemap has been exhausted, iterate to the next
769 * one, return ENOSPC if no freemaps remain.
771 * XXX this should rotate back to the beginning to handle freed-up space
772 * XXX or use intermediate entries to locate free space. TODO
775 hammer2_freemap_iterate(hammer2_trans_t *trans, hammer2_chain_t **parentp,
776 hammer2_chain_t **chainp, hammer2_fiterate_t *iter)
778 hammer2_dev_t *hmp = (*parentp)->hmp;
780 iter->bnext &= ~(H2FMSHIFT(HAMMER2_FREEMAP_LEVEL1_RADIX) - 1);
781 iter->bnext += H2FMSHIFT(HAMMER2_FREEMAP_LEVEL1_RADIX);
782 if (iter->bnext >= hmp->voldata.volu_size) {
784 if (++iter->loops == 2)
791 * Adjust the bit-pattern for data in the freemap bitmap according to
792 * (how). This code is called from on-mount recovery to fixup (mark
793 * as allocated) blocks whos freemap upates might not have been committed
794 * in the last crash and is used by the bulk freemap scan to stage frees.
796 * XXX currently disabled when how == 0 (the normal real-time case). At
797 * the moment we depend on the bulk freescan to actually free blocks. It
798 * will still call this routine with a non-zero how to stage possible frees
799 * and to do the actual free.
802 hammer2_freemap_adjust(hammer2_trans_t *trans, hammer2_dev_t *hmp,
803 hammer2_blockref_t *bref, int how)
805 hammer2_off_t data_off = bref->data_off;
806 hammer2_chain_t *chain;
807 hammer2_chain_t *parent;
808 hammer2_bmap_data_t *bmap;
810 hammer2_key_t key_dummy;
811 hammer2_off_t l0size;
812 hammer2_off_t l1size;
813 hammer2_off_t l1mask;
815 const uint32_t bmmask00 = 0;
825 int cache_index = -1;
828 KKASSERT(how == HAMMER2_FREEMAP_DORECOVER);
830 radix = (int)data_off & HAMMER2_OFF_MASK_RADIX;
831 data_off &= ~HAMMER2_OFF_MASK_RADIX;
832 KKASSERT(radix <= HAMMER2_RADIX_MAX);
834 bytes = (size_t)1 << radix;
835 class = (bref->type << 8) | hammer2_devblkradix(radix);
838 * We can't adjust thre freemap for data allocations made by
841 if (data_off < hmp->voldata.allocator_beg)
844 KKASSERT((data_off & HAMMER2_ZONE_MASK64) >= HAMMER2_ZONE_SEG);
847 * Lookup the level1 freemap chain. The chain must exist.
849 key = H2FMBASE(data_off, HAMMER2_FREEMAP_LEVEL1_RADIX);
850 l0size = H2FMSHIFT(HAMMER2_FREEMAP_LEVEL0_RADIX);
851 l1size = H2FMSHIFT(HAMMER2_FREEMAP_LEVEL1_RADIX);
854 parent = &hmp->fchain;
855 hammer2_chain_lock(parent, HAMMER2_RESOLVE_ALWAYS);
857 chain = hammer2_chain_lookup(&parent, &key_dummy, key, key + l1mask,
859 HAMMER2_LOOKUP_ALWAYS |
860 HAMMER2_LOOKUP_MATCHIND);
863 * Stop early if we are trying to free something but no leaf exists.
865 if (chain == NULL && how != HAMMER2_FREEMAP_DORECOVER) {
866 kprintf("hammer2_freemap_adjust: %016jx: no chain\n",
867 (intmax_t)bref->data_off);
871 kprintf("hammer2_freemap_adjust: %016jx: error %s\n",
872 (intmax_t)bref->data_off,
873 hammer2_error_str(chain->error));
874 hammer2_chain_unlock(chain);
880 * Create any missing leaf(s) if we are doing a recovery (marking
881 * the block(s) as being allocated instead of being freed). Be sure
882 * to initialize the auxillary freemap tracking info in the
883 * bref.check.freemap structure.
885 if (chain == NULL && how == HAMMER2_FREEMAP_DORECOVER) {
886 error = hammer2_chain_create(trans, &parent, &chain, hmp->spmp,
887 key, HAMMER2_FREEMAP_LEVEL1_RADIX,
888 HAMMER2_BREF_TYPE_FREEMAP_LEAF,
889 HAMMER2_FREEMAP_LEVELN_PSIZE,
892 if (hammer2_debug & 0x0040) {
893 kprintf("fixup create chain %p %016jx:%d\n",
894 chain, chain->bref.key, chain->bref.keybits);
898 hammer2_chain_modify(trans, chain, 0);
899 bzero(&chain->data->bmdata[0],
900 HAMMER2_FREEMAP_LEVELN_PSIZE);
901 chain->bref.check.freemap.bigmask = (uint32_t)-1;
902 chain->bref.check.freemap.avail = l1size;
903 /* bref.methods should already be inherited */
905 hammer2_freemap_init(trans, hmp, key, chain);
907 /* XXX handle error */
911 kprintf("FREEMAP ADJUST TYPE %d %016jx/%d DATA_OFF=%016jx\n",
912 chain->bref.type, chain->bref.key,
913 chain->bref.keybits, chain->bref.data_off);
917 * Calculate the bitmask (runs in 2-bit pairs).
919 start = ((int)(data_off >> HAMMER2_FREEMAP_BLOCK_RADIX) & 15) * 2;
920 bmmask01 = 1 << start;
921 bmmask10 = 2 << start;
922 bmmask11 = 3 << start;
925 * Fixup the bitmap. Partial blocks cannot be fully freed unless
926 * a bulk scan is able to roll them up.
928 if (radix < HAMMER2_FREEMAP_BLOCK_RADIX) {
930 if (how == HAMMER2_FREEMAP_DOREALFREE)
931 how = HAMMER2_FREEMAP_DOMAYFREE;
933 count = 1 << (radix - HAMMER2_FREEMAP_BLOCK_RADIX);
937 * [re]load the bmap and bitmap pointers. Each bmap entry covers
938 * a 2MB swath. The bmap itself (LEVEL1) covers 2GB.
940 * Be sure to reset the linear iterator to ensure that the adjustment
944 bmap = &chain->data->bmdata[(int)(data_off >> HAMMER2_SEGRADIX) &
945 (HAMMER2_FREEMAP_COUNT - 1)];
946 bitmap = &bmap->bitmap[(int)(data_off >> (HAMMER2_SEGRADIX - 3)) & 7];
953 if (how == HAMMER2_FREEMAP_DORECOVER) {
955 * Recovery request, mark as allocated.
957 if ((*bitmap & bmmask11) != bmmask11) {
959 hammer2_chain_modify(trans, chain, 0);
963 if ((*bitmap & bmmask11) == bmmask00) {
965 HAMMER2_FREEMAP_BLOCK_SIZE;
967 if (bmap->class == 0)
970 if (hammer2_debug & 0x0040) {
971 kprintf("hammer2_freemap_recover: "
973 "block=%016jx/%zd\n",
974 bref->type, data_off, bytes);
978 kprintf("hammer2_freemap_recover: good "
979 "type=%02x block=%016jx/%zd\n",
980 bref->type, data_off, bytes);
986 * XXX this stuff doesn't work, avail is miscalculated and
987 * code 10 means something else now.
989 else if ((*bitmap & bmmask11) == bmmask11) {
991 * Mayfree/Realfree request and bitmap is currently
992 * marked as being fully allocated.
995 hammer2_chain_modify(trans, chain, 0);
999 if (how == HAMMER2_FREEMAP_DOREALFREE)
1000 *bitmap &= ~bmmask11;
1002 *bitmap = (*bitmap & ~bmmask11) | bmmask10;
1003 } else if ((*bitmap & bmmask11) == bmmask10) {
1005 * Mayfree/Realfree request and bitmap is currently
1006 * marked as being possibly freeable.
1008 if (how == HAMMER2_FREEMAP_DOREALFREE) {
1010 hammer2_chain_modify(trans, chain, 0);
1014 *bitmap &= ~bmmask11;
1018 * 01 - Not implemented, currently illegal state
1019 * 00 - Not allocated at all, illegal free.
1021 panic("hammer2_freemap_adjust: "
1022 "Illegal state %08x(%08x)",
1023 *bitmap, *bitmap & bmmask11);
1031 if (how == HAMMER2_FREEMAP_DOREALFREE && modified) {
1032 bmap->avail += 1 << radix;
1033 KKASSERT(bmap->avail <= HAMMER2_SEGSIZE);
1034 if (bmap->avail == HAMMER2_SEGSIZE &&
1035 bmap->bitmap[0] == 0 &&
1036 bmap->bitmap[1] == 0 &&
1037 bmap->bitmap[2] == 0 &&
1038 bmap->bitmap[3] == 0 &&
1039 bmap->bitmap[4] == 0 &&
1040 bmap->bitmap[5] == 0 &&
1041 bmap->bitmap[6] == 0 &&
1042 bmap->bitmap[7] == 0) {
1043 key = H2FMBASE(data_off, HAMMER2_FREEMAP_LEVEL0_RADIX);
1044 kprintf("Freeseg %016jx\n", (intmax_t)key);
1050 * chain->bref.check.freemap.bigmask (XXX)
1052 * Setting bigmask is a hint to the allocation code that there might
1053 * be something allocatable. We also set this in recovery... it
1054 * doesn't hurt and we might want to use the hint for other validation
1055 * operations later on.
1058 chain->bref.check.freemap.bigmask |= 1 << radix;
1060 hammer2_chain_unlock(chain);
1062 hammer2_chain_unlock(parent);
1066 * Validate the freemap, in three stages.
1068 * stage-1 ALLOCATED -> POSSIBLY FREE
1069 * POSSIBLY FREE -> POSSIBLY FREE (type corrected)
1071 * This transitions bitmap entries from ALLOCATED to POSSIBLY FREE.
1072 * The POSSIBLY FREE state does not mean that a block is actually free
1073 * and may be transitioned back to ALLOCATED in stage-2.
1075 * This is typically done during normal filesystem operations when
1076 * something is deleted or a block is replaced.
1078 * This is done by bulkfree in-bulk after a memory-bounded meta-data
1079 * scan to try to determine what might be freeable.
1081 * This can be done unconditionally through a freemap scan when the
1082 * intention is to brute-force recover the proper state of the freemap.
1084 * stage-2 POSSIBLY FREE -> ALLOCATED (scan metadata topology)
1086 * This is done by bulkfree during a meta-data scan to ensure that
1087 * all blocks still actually allocated by the filesystem are marked
1090 * NOTE! Live filesystem transitions to POSSIBLY FREE can occur while
1091 * the bulkfree stage-2 and stage-3 is running. The live filesystem
1092 * will use the alternative POSSIBLY FREE type (2) to prevent
1093 * stage-3 from improperly transitioning unvetted possibly-free
1096 * stage-3 POSSIBLY FREE (type 1) -> FREE (scan freemap)
1098 * This is done by bulkfree to finalize POSSIBLY FREE states.