2 * Copyright (c) 2007-2008 The DragonFly Project. All rights reserved.
4 * This code is derived from software contributed to The DragonFly Project
5 * by Matthew Dillon <dillon@backplane.com>
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in
15 * the documentation and/or other materials provided with the
17 * 3. Neither the name of The DragonFly Project nor the names of its
18 * contributors may be used to endorse or promote products derived
19 * from this software without specific, prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
25 * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26 * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
27 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
29 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
30 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
31 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34 * $DragonFly: src/sys/vfs/hammer/hammer_ondisk.c,v 1.46 2008/05/18 01:48:50 dillon Exp $
37 * Manage HAMMER's on-disk structures. These routines are primarily
38 * responsible for interfacing with the kernel's I/O subsystem and for
39 * managing in-memory structures.
43 #include <sys/fcntl.h>
44 #include <sys/nlookup.h>
48 static void hammer_free_volume(hammer_volume_t volume);
49 static int hammer_load_volume(hammer_volume_t volume);
50 static int hammer_load_buffer(hammer_buffer_t buffer, int isnew);
51 static int hammer_load_node(hammer_node_t node, int isnew);
54 * Red-Black tree support for various structures
57 hammer_ino_rb_compare(hammer_inode_t ip1, hammer_inode_t ip2)
59 if (ip1->obj_id < ip2->obj_id)
61 if (ip1->obj_id > ip2->obj_id)
63 if (ip1->obj_asof < ip2->obj_asof)
65 if (ip1->obj_asof > ip2->obj_asof)
71 hammer_inode_info_cmp(hammer_inode_info_t info, hammer_inode_t ip)
73 if (info->obj_id < ip->obj_id)
75 if (info->obj_id > ip->obj_id)
77 if (info->obj_asof < ip->obj_asof)
79 if (info->obj_asof > ip->obj_asof)
85 hammer_vol_rb_compare(hammer_volume_t vol1, hammer_volume_t vol2)
87 if (vol1->vol_no < vol2->vol_no)
89 if (vol1->vol_no > vol2->vol_no)
95 hammer_buf_rb_compare(hammer_buffer_t buf1, hammer_buffer_t buf2)
97 if (buf1->zone2_offset < buf2->zone2_offset)
99 if (buf1->zone2_offset > buf2->zone2_offset)
105 hammer_nod_rb_compare(hammer_node_t node1, hammer_node_t node2)
107 if (node1->node_offset < node2->node_offset)
109 if (node1->node_offset > node2->node_offset)
115 * Note: The lookup function for hammer_ino_rb_tree winds up being named
116 * hammer_ino_rb_tree_RB_LOOKUP_INFO(root, info). The other lookup
117 * functions are normal, e.g. hammer_buf_rb_tree_RB_LOOKUP(root, zone2_offset).
119 RB_GENERATE(hammer_ino_rb_tree, hammer_inode, rb_node, hammer_ino_rb_compare);
120 RB_GENERATE_XLOOKUP(hammer_ino_rb_tree, INFO, hammer_inode, rb_node,
121 hammer_inode_info_cmp, hammer_inode_info_t);
122 RB_GENERATE2(hammer_vol_rb_tree, hammer_volume, rb_node,
123 hammer_vol_rb_compare, int32_t, vol_no);
124 RB_GENERATE2(hammer_buf_rb_tree, hammer_buffer, rb_node,
125 hammer_buf_rb_compare, hammer_off_t, zone2_offset);
126 RB_GENERATE2(hammer_nod_rb_tree, hammer_node, rb_node,
127 hammer_nod_rb_compare, hammer_off_t, node_offset);
129 /************************************************************************
131 ************************************************************************
133 * Load a HAMMER volume by name. Returns 0 on success or a positive error
134 * code on failure. Volumes must be loaded at mount time, get_volume() will
135 * not load a new volume.
137 * Calls made to hammer_load_volume() or single-threaded
140 hammer_install_volume(struct hammer_mount *hmp, const char *volname)
143 hammer_volume_t volume;
144 struct hammer_volume_ondisk *ondisk;
145 struct nlookupdata nd;
146 struct buf *bp = NULL;
152 ronly = ((mp->mnt_flag & MNT_RDONLY) ? 1 : 0);
155 * Allocate a volume structure
157 ++hammer_count_volumes;
158 volume = kmalloc(sizeof(*volume), M_HAMMER, M_WAITOK|M_ZERO);
159 volume->vol_name = kstrdup(volname, M_HAMMER);
160 hammer_io_init(&volume->io, hmp, HAMMER_STRUCTURE_VOLUME);
161 volume->io.offset = 0LL;
164 * Get the device vnode
166 error = nlookup_init(&nd, volume->vol_name, UIO_SYSSPACE, NLC_FOLLOW);
168 error = nlookup(&nd);
170 error = cache_vref(&nd.nl_nch, nd.nl_cred, &volume->devvp);
173 if (vn_isdisk(volume->devvp, &error)) {
174 error = vfs_mountedon(volume->devvp);
178 count_udev(volume->devvp->v_umajor, volume->devvp->v_uminor) > 0) {
182 vn_lock(volume->devvp, LK_EXCLUSIVE | LK_RETRY);
183 error = vinvalbuf(volume->devvp, V_SAVE, 0, 0);
185 error = VOP_OPEN(volume->devvp,
186 (ronly ? FREAD : FREAD|FWRITE),
189 vn_unlock(volume->devvp);
192 hammer_free_volume(volume);
195 volume->devvp->v_rdev->si_mountpoint = mp;
199 * Extract the volume number from the volume header and do various
202 error = bread(volume->devvp, 0LL, HAMMER_BUFSIZE, &bp);
205 ondisk = (void *)bp->b_data;
206 if (ondisk->vol_signature != HAMMER_FSBUF_VOLUME) {
207 kprintf("hammer_mount: volume %s has an invalid header\n",
212 volume->vol_no = ondisk->vol_no;
213 volume->buffer_base = ondisk->vol_buf_beg;
214 volume->vol_flags = ondisk->vol_flags;
215 volume->nblocks = ondisk->vol_nblocks;
216 volume->maxbuf_off = HAMMER_ENCODE_RAW_BUFFER(volume->vol_no,
217 ondisk->vol_buf_end - ondisk->vol_buf_beg);
218 volume->maxraw_off = ondisk->vol_buf_end;
219 RB_INIT(&volume->rb_bufs_root);
221 if (RB_EMPTY(&hmp->rb_vols_root)) {
222 hmp->fsid = ondisk->vol_fsid;
223 } else if (bcmp(&hmp->fsid, &ondisk->vol_fsid, sizeof(uuid_t))) {
224 kprintf("hammer_mount: volume %s's fsid does not match "
225 "other volumes\n", volume->vol_name);
231 * Insert the volume structure into the red-black tree.
233 if (RB_INSERT(hammer_vol_rb_tree, &hmp->rb_vols_root, volume)) {
234 kprintf("hammer_mount: volume %s has a duplicate vol_no %d\n",
235 volume->vol_name, volume->vol_no);
240 * Set the root volume . HAMMER special cases rootvol the structure.
241 * We do not hold a ref because this would prevent related I/O
242 * from being flushed.
244 if (error == 0 && ondisk->vol_rootvol == ondisk->vol_no) {
245 hmp->rootvol = volume;
250 hmp->fsid_udev = dev2udev(vn_todev(volume->devvp));
251 hmp->mp->mnt_stat.f_blocks += ondisk->vol0_stat_bigblocks *
252 (HAMMER_LARGEBLOCK_SIZE / HAMMER_BUFSIZE);
258 /*vinvalbuf(volume->devvp, V_SAVE, 0, 0);*/
260 volume->devvp->v_rdev->si_mountpoint = NULL;
261 VOP_CLOSE(volume->devvp, ronly ? FREAD : FREAD|FWRITE);
262 hammer_free_volume(volume);
268 * Unload and free a HAMMER volume. Must return >= 0 to continue scan
269 * so returns -1 on failure.
272 hammer_unload_volume(hammer_volume_t volume, void *data __unused)
274 struct hammer_mount *hmp = volume->io.hmp;
275 int ronly = ((hmp->mp->mnt_flag & MNT_RDONLY) ? 1 : 0);
278 * Clean up the root volume pointer, which is held unlocked in hmp.
280 if (hmp->rootvol == volume)
286 RB_SCAN(hammer_buf_rb_tree, &volume->rb_bufs_root, NULL,
287 hammer_unload_buffer, NULL);
290 * Release our buffer and flush anything left in the buffer cache.
292 volume->io.waitdep = 1;
293 hammer_io_release(&volume->io, 1);
296 * There should be no references on the volume, no clusters, and
299 KKASSERT(volume->io.lock.refs == 0);
300 KKASSERT(RB_EMPTY(&volume->rb_bufs_root));
302 volume->ondisk = NULL;
304 if (volume->devvp->v_rdev &&
305 volume->devvp->v_rdev->si_mountpoint == hmp->mp
307 volume->devvp->v_rdev->si_mountpoint = NULL;
310 vinvalbuf(volume->devvp, 0, 0, 0);
311 VOP_CLOSE(volume->devvp, FREAD);
313 vinvalbuf(volume->devvp, V_SAVE, 0, 0);
314 VOP_CLOSE(volume->devvp, FREAD|FWRITE);
319 * Destroy the structure
321 RB_REMOVE(hammer_vol_rb_tree, &hmp->rb_vols_root, volume);
322 hammer_free_volume(volume);
328 hammer_free_volume(hammer_volume_t volume)
330 if (volume->vol_name) {
331 kfree(volume->vol_name, M_HAMMER);
332 volume->vol_name = NULL;
335 vrele(volume->devvp);
336 volume->devvp = NULL;
338 --hammer_count_volumes;
339 kfree(volume, M_HAMMER);
343 * Get a HAMMER volume. The volume must already exist.
346 hammer_get_volume(struct hammer_mount *hmp, int32_t vol_no, int *errorp)
348 struct hammer_volume *volume;
351 * Locate the volume structure
353 volume = RB_LOOKUP(hammer_vol_rb_tree, &hmp->rb_vols_root, vol_no);
354 if (volume == NULL) {
358 hammer_ref(&volume->io.lock);
361 * Deal with on-disk info
363 if (volume->ondisk == NULL || volume->io.loading) {
364 *errorp = hammer_load_volume(volume);
366 hammer_rel_volume(volume, 1);
376 hammer_ref_volume(hammer_volume_t volume)
380 hammer_ref(&volume->io.lock);
383 * Deal with on-disk info
385 if (volume->ondisk == NULL || volume->io.loading) {
386 error = hammer_load_volume(volume);
388 hammer_rel_volume(volume, 1);
396 hammer_get_root_volume(struct hammer_mount *hmp, int *errorp)
398 hammer_volume_t volume;
400 volume = hmp->rootvol;
401 KKASSERT(volume != NULL);
402 hammer_ref(&volume->io.lock);
405 * Deal with on-disk info
407 if (volume->ondisk == NULL || volume->io.loading) {
408 *errorp = hammer_load_volume(volume);
410 hammer_rel_volume(volume, 1);
420 * Load a volume's on-disk information. The volume must be referenced and
421 * not locked. We temporarily acquire an exclusive lock to interlock
422 * against releases or multiple get's.
425 hammer_load_volume(hammer_volume_t volume)
429 ++volume->io.loading;
430 hammer_lock_ex(&volume->io.lock);
432 if (volume->ondisk == NULL) {
433 error = hammer_io_read(volume->devvp, &volume->io,
436 volume->ondisk = (void *)volume->io.bp->b_data;
440 --volume->io.loading;
441 hammer_unlock(&volume->io.lock);
446 * Release a volume. Call hammer_io_release on the last reference. We have
447 * to acquire an exclusive lock to interlock against volume->ondisk tests
448 * in hammer_load_volume(), and hammer_io_release() also expects an exclusive
451 * Volumes are not unloaded from memory during normal operation.
454 hammer_rel_volume(hammer_volume_t volume, int flush)
457 if (volume->io.lock.refs == 1) {
458 ++volume->io.loading;
459 hammer_lock_ex(&volume->io.lock);
460 if (volume->io.lock.refs == 1) {
461 volume->ondisk = NULL;
462 hammer_io_release(&volume->io, flush);
464 --volume->io.loading;
465 hammer_unlock(&volume->io.lock);
467 hammer_unref(&volume->io.lock);
471 /************************************************************************
473 ************************************************************************
475 * Manage buffers. Currently all blockmap-backed zones are translated
476 * to zone-2 buffer offsets.
479 hammer_get_buffer(hammer_mount_t hmp, hammer_off_t buf_offset,
480 int isnew, int *errorp)
482 hammer_buffer_t buffer;
483 hammer_volume_t volume;
484 hammer_off_t zoneX_offset;
485 hammer_io_type_t iotype;
489 zoneX_offset = buf_offset;
490 zone = HAMMER_ZONE_DECODE(buf_offset);
493 * What is the buffer class?
496 case HAMMER_ZONE_LARGE_DATA_INDEX:
497 case HAMMER_ZONE_SMALL_DATA_INDEX:
498 iotype = HAMMER_STRUCTURE_DATA_BUFFER;
500 case HAMMER_ZONE_UNDO_INDEX:
501 iotype = HAMMER_STRUCTURE_UNDO_BUFFER;
504 iotype = HAMMER_STRUCTURE_META_BUFFER;
509 * Handle blockmap offset translations
511 if (zone >= HAMMER_ZONE_BTREE_INDEX) {
512 buf_offset = hammer_blockmap_lookup(hmp, buf_offset, errorp);
513 KKASSERT(*errorp == 0);
514 } else if (zone == HAMMER_ZONE_UNDO_INDEX) {
515 buf_offset = hammer_undo_lookup(hmp, buf_offset, errorp);
516 KKASSERT(*errorp == 0);
520 * Locate the buffer given its zone-2 offset.
522 buf_offset &= ~HAMMER_BUFMASK64;
523 KKASSERT((buf_offset & HAMMER_OFF_ZONE_MASK) == HAMMER_ZONE_RAW_BUFFER);
524 vol_no = HAMMER_VOL_DECODE(buf_offset);
525 volume = hammer_get_volume(hmp, vol_no, errorp);
530 * NOTE: buf_offset and maxbuf_off are both full zone-2 offset
533 KKASSERT(buf_offset < volume->maxbuf_off);
536 * Locate and lock the buffer structure, creating one if necessary.
539 buffer = RB_LOOKUP(hammer_buf_rb_tree, &volume->rb_bufs_root,
541 if (buffer == NULL) {
542 ++hammer_count_buffers;
543 buffer = kmalloc(sizeof(*buffer), M_HAMMER, M_WAITOK|M_ZERO);
544 buffer->zone2_offset = buf_offset;
545 buffer->volume = volume;
547 hammer_io_init(&buffer->io, hmp, iotype);
548 buffer->io.offset = volume->ondisk->vol_buf_beg +
549 (buf_offset & HAMMER_OFF_SHORT_MASK);
550 TAILQ_INIT(&buffer->clist);
551 hammer_ref(&buffer->io.lock);
554 * Insert the buffer into the RB tree and handle late
557 if (RB_INSERT(hammer_buf_rb_tree, &volume->rb_bufs_root, buffer)) {
558 hammer_unref(&buffer->io.lock);
559 --hammer_count_buffers;
560 kfree(buffer, M_HAMMER);
563 hammer_ref(&volume->io.lock);
565 hammer_ref(&buffer->io.lock);
568 * The buffer is no longer loose if it has a ref.
570 if (buffer->io.mod_list == &hmp->lose_list) {
571 TAILQ_REMOVE(buffer->io.mod_list, &buffer->io,
573 buffer->io.mod_list = NULL;
575 if (buffer->io.lock.refs == 1)
576 hammer_io_reinit(&buffer->io, iotype);
578 KKASSERT(buffer->io.type == iotype);
582 * Cache the blockmap translation
584 if ((zoneX_offset & HAMMER_OFF_ZONE_MASK) != HAMMER_ZONE_RAW_BUFFER)
585 buffer->zoneX_offset = zoneX_offset;
588 * Deal with on-disk info
590 if (buffer->ondisk == NULL || buffer->io.loading) {
591 *errorp = hammer_load_buffer(buffer, isnew);
593 hammer_rel_buffer(buffer, 1);
599 hammer_rel_volume(volume, 0);
604 * Clear the cached zone-X translation for a buffer.
607 hammer_clrxlate_buffer(hammer_mount_t hmp, hammer_off_t buf_offset)
609 hammer_buffer_t buffer;
610 hammer_volume_t volume;
614 buf_offset &= ~HAMMER_BUFMASK64;
615 KKASSERT((buf_offset & HAMMER_OFF_ZONE_MASK) == HAMMER_ZONE_RAW_BUFFER);
616 vol_no = HAMMER_VOL_DECODE(buf_offset);
617 volume = hammer_get_volume(hmp, vol_no, &error);
620 buffer = RB_LOOKUP(hammer_buf_rb_tree, &volume->rb_bufs_root,
623 buffer->zoneX_offset = 0;
624 hammer_rel_volume(volume, 0);
628 hammer_load_buffer(hammer_buffer_t buffer, int isnew)
630 hammer_volume_t volume;
634 * Load the buffer's on-disk info
636 volume = buffer->volume;
637 ++buffer->io.loading;
638 hammer_lock_ex(&buffer->io.lock);
640 if (hammer_debug_io & 0x0001) {
641 kprintf("load_buffer %016llx %016llx\n",
642 buffer->zoneX_offset, buffer->zone2_offset);
645 if (buffer->ondisk == NULL) {
647 error = hammer_io_new(volume->devvp, &buffer->io);
649 error = hammer_io_read(volume->devvp, &buffer->io,
653 buffer->ondisk = (void *)buffer->io.bp->b_data;
655 error = hammer_io_new(volume->devvp, &buffer->io);
659 --buffer->io.loading;
660 hammer_unlock(&buffer->io.lock);
665 * NOTE: Called from RB_SCAN, must return >= 0 for scan to continue.
668 hammer_unload_buffer(hammer_buffer_t buffer, void *data __unused)
670 hammer_ref(&buffer->io.lock);
671 hammer_flush_buffer_nodes(buffer);
672 KKASSERT(buffer->io.lock.refs == 1);
673 hammer_rel_buffer(buffer, 2);
678 * Reference a buffer that is either already referenced or via a specially
679 * handled pointer (aka cursor->buffer).
682 hammer_ref_buffer(hammer_buffer_t buffer)
686 hammer_ref(&buffer->io.lock);
691 if (buffer->io.mod_list == &buffer->io.hmp->lose_list) {
692 TAILQ_REMOVE(buffer->io.mod_list, &buffer->io, mod_entry);
693 buffer->io.mod_list = NULL;
696 if (buffer->ondisk == NULL || buffer->io.loading) {
697 error = hammer_load_buffer(buffer, 0);
699 hammer_rel_buffer(buffer, 1);
701 * NOTE: buffer pointer can become stale after
712 * Release a buffer. We have to deal with several places where
713 * another thread can ref the buffer.
715 * Only destroy the structure itself if the related buffer cache buffer
716 * was disassociated from it. This ties the management of the structure
717 * to the buffer cache subsystem. buffer->ondisk determines whether the
718 * embedded io is referenced or not.
721 hammer_rel_buffer(hammer_buffer_t buffer, int flush)
723 hammer_volume_t volume;
727 if (buffer->io.lock.refs == 1) {
728 ++buffer->io.loading; /* force interlock check */
729 hammer_lock_ex(&buffer->io.lock);
730 if (buffer->io.lock.refs == 1) {
731 hammer_io_release(&buffer->io, flush);
732 hammer_flush_buffer_nodes(buffer);
733 KKASSERT(TAILQ_EMPTY(&buffer->clist));
735 if (buffer->io.bp == NULL &&
736 buffer->io.lock.refs == 1) {
740 volume = buffer->volume;
741 RB_REMOVE(hammer_buf_rb_tree,
742 &volume->rb_bufs_root, buffer);
743 buffer->volume = NULL; /* sanity */
744 hammer_rel_volume(volume, 0);
748 --buffer->io.loading;
749 hammer_unlock(&buffer->io.lock);
751 hammer_unref(&buffer->io.lock);
754 KKASSERT(buffer->io.mod_list == NULL);
755 --hammer_count_buffers;
756 kfree(buffer, M_HAMMER);
761 * Remove the zoneX translation cache for a buffer given its zone-2 offset.
764 hammer_uncache_buffer(hammer_mount_t hmp, hammer_off_t buf_offset)
766 hammer_volume_t volume;
767 hammer_buffer_t buffer;
771 buf_offset &= ~HAMMER_BUFMASK64;
772 KKASSERT((buf_offset & HAMMER_OFF_ZONE_MASK) == HAMMER_ZONE_RAW_BUFFER);
773 vol_no = HAMMER_VOL_DECODE(buf_offset);
774 volume = hammer_get_volume(hmp, vol_no, &error);
775 KKASSERT(volume != 0);
776 KKASSERT(buf_offset < volume->maxbuf_off);
778 buffer = RB_LOOKUP(hammer_buf_rb_tree, &volume->rb_bufs_root,
781 buffer->zoneX_offset = 0;
782 hammer_rel_volume(volume, 0);
786 * Access the filesystem buffer containing the specified hammer offset.
787 * buf_offset is a conglomeration of the volume number and vol_buf_beg
788 * relative buffer offset. It must also have bit 55 set to be valid.
789 * (see hammer_off_t in hammer_disk.h).
791 * Any prior buffer in *bufferp will be released and replaced by the
795 hammer_bread(hammer_mount_t hmp, hammer_off_t buf_offset, int *errorp,
796 struct hammer_buffer **bufferp)
798 hammer_buffer_t buffer;
799 int32_t xoff = (int32_t)buf_offset & HAMMER_BUFMASK;
801 buf_offset &= ~HAMMER_BUFMASK64;
802 KKASSERT((buf_offset & HAMMER_OFF_ZONE_MASK) != 0);
805 if (buffer == NULL || (buffer->zone2_offset != buf_offset &&
806 buffer->zoneX_offset != buf_offset)) {
808 hammer_rel_buffer(buffer, 0);
809 buffer = hammer_get_buffer(hmp, buf_offset, 0, errorp);
816 * Return a pointer to the buffer data.
821 return((char *)buffer->ondisk + xoff);
825 * Access the filesystem buffer containing the specified hammer offset.
826 * No disk read operation occurs. The result buffer may contain garbage.
828 * Any prior buffer in *bufferp will be released and replaced by the
831 * This function marks the buffer dirty but does not increment its
835 hammer_bnew(hammer_mount_t hmp, hammer_off_t buf_offset, int *errorp,
836 struct hammer_buffer **bufferp)
838 hammer_buffer_t buffer;
839 int32_t xoff = (int32_t)buf_offset & HAMMER_BUFMASK;
841 buf_offset &= ~HAMMER_BUFMASK64;
844 if (buffer == NULL || (buffer->zone2_offset != buf_offset &&
845 buffer->zoneX_offset != buf_offset)) {
847 hammer_rel_buffer(buffer, 0);
848 buffer = hammer_get_buffer(hmp, buf_offset, 1, errorp);
855 * Return a pointer to the buffer data.
860 return((char *)buffer->ondisk + xoff);
863 /************************************************************************
865 ************************************************************************
867 * Manage B-Tree nodes. B-Tree nodes represent the primary indexing
868 * method used by the HAMMER filesystem.
870 * Unlike other HAMMER structures, a hammer_node can be PASSIVELY
871 * associated with its buffer, and will only referenced the buffer while
872 * the node itself is referenced.
874 * A hammer_node can also be passively associated with other HAMMER
875 * structures, such as inodes, while retaining 0 references. These
876 * associations can be cleared backwards using a pointer-to-pointer in
879 * This allows the HAMMER implementation to cache hammer_nodes long-term
880 * and short-cut a great deal of the infrastructure's complexity. In
881 * most cases a cached node can be reacquired without having to dip into
882 * either the buffer or cluster management code.
884 * The caller must pass a referenced cluster on call and will retain
885 * ownership of the reference on return. The node will acquire its own
886 * additional references, if necessary.
889 hammer_get_node(hammer_mount_t hmp, hammer_off_t node_offset,
890 int isnew, int *errorp)
894 KKASSERT((node_offset & HAMMER_OFF_ZONE_MASK) == HAMMER_ZONE_BTREE);
897 * Locate the structure, allocating one if necessary.
900 node = RB_LOOKUP(hammer_nod_rb_tree, &hmp->rb_nods_root, node_offset);
902 ++hammer_count_nodes;
903 node = kmalloc(sizeof(*node), M_HAMMER, M_WAITOK|M_ZERO);
904 node->node_offset = node_offset;
906 if (RB_INSERT(hammer_nod_rb_tree, &hmp->rb_nods_root, node)) {
907 --hammer_count_nodes;
908 kfree(node, M_HAMMER);
912 hammer_ref(&node->lock);
916 *errorp = hammer_load_node(node, isnew);
918 hammer_rel_node(node);
925 * Reference an already-referenced node.
928 hammer_ref_node(hammer_node_t node)
930 KKASSERT(node->lock.refs > 0 && node->ondisk != NULL);
931 hammer_ref(&node->lock);
935 * Load a node's on-disk data reference.
938 hammer_load_node(hammer_node_t node, int isnew)
940 hammer_buffer_t buffer;
941 hammer_off_t buf_offset;
946 hammer_lock_ex(&node->lock);
947 if (node->ondisk == NULL) {
949 * This is a little confusing but the jist is that
950 * node->buffer determines whether the node is on
951 * the buffer's clist and node->ondisk determines
952 * whether the buffer is referenced.
954 * We could be racing a buffer release, in which case
955 * node->buffer may become NULL while we are blocked
956 * referencing the buffer.
958 if ((buffer = node->buffer) != NULL) {
959 error = hammer_ref_buffer(buffer);
960 if (error == 0 && node->buffer == NULL) {
961 TAILQ_INSERT_TAIL(&buffer->clist,
963 node->buffer = buffer;
966 buf_offset = node->node_offset & ~HAMMER_BUFMASK64;
967 buffer = hammer_get_buffer(node->hmp, buf_offset,
970 KKASSERT(error == 0);
971 TAILQ_INSERT_TAIL(&buffer->clist,
973 node->buffer = buffer;
977 node->ondisk = (void *)((char *)buffer->ondisk +
978 (node->node_offset & HAMMER_BUFMASK));
980 hammer_crc_test_btree(node->ondisk) == 0) {
981 Debugger("CRC FAILED: B-TREE NODE");
986 hammer_unlock(&node->lock);
991 * Safely reference a node, interlock against flushes via the IO subsystem.
994 hammer_ref_node_safe(struct hammer_mount *hmp, struct hammer_node **cache,
1001 hammer_ref(&node->lock);
1005 *errorp = hammer_load_node(node, 0);
1007 hammer_rel_node(node);
1017 * Release a hammer_node. On the last release the node dereferences
1018 * its underlying buffer and may or may not be destroyed.
1021 hammer_rel_node(hammer_node_t node)
1023 hammer_buffer_t buffer;
1026 * If this isn't the last ref just decrement the ref count and
1029 if (node->lock.refs > 1) {
1030 hammer_unref(&node->lock);
1035 * If there is no ondisk info or no buffer the node failed to load,
1036 * remove the last reference and destroy the node.
1038 if (node->ondisk == NULL) {
1039 hammer_unref(&node->lock);
1040 hammer_flush_node(node);
1041 /* node is stale now */
1046 * Do final cleanups and then either destroy the node and leave it
1047 * passively cached. The buffer reference is removed regardless.
1049 buffer = node->buffer;
1050 node->ondisk = NULL;
1052 if ((node->flags & HAMMER_NODE_FLUSH) == 0) {
1053 hammer_unref(&node->lock);
1054 hammer_rel_buffer(buffer, 0);
1061 hammer_unref(&node->lock);
1062 hammer_flush_node(node);
1064 hammer_rel_buffer(buffer, 0);
1068 * Free space on-media associated with a B-Tree node.
1071 hammer_delete_node(hammer_transaction_t trans, hammer_node_t node)
1073 KKASSERT((node->flags & HAMMER_NODE_DELETED) == 0);
1074 node->flags |= HAMMER_NODE_DELETED;
1075 hammer_blockmap_free(trans, node->node_offset, sizeof(*node->ondisk));
1079 * Passively cache a referenced hammer_node in *cache. The caller may
1080 * release the node on return.
1083 hammer_cache_node(hammer_node_t node, struct hammer_node **cache)
1088 * If the node is being deleted, don't cache it!
1090 if (node->flags & HAMMER_NODE_DELETED)
1094 * Cache the node. If we previously cached a different node we
1095 * have to give HAMMER a chance to destroy it.
1098 if (node->cache1 != cache) {
1099 if (node->cache2 != cache) {
1100 if ((old = *cache) != NULL) {
1101 KKASSERT(node->lock.refs != 0);
1102 hammer_uncache_node(cache);
1106 *node->cache2 = NULL;
1107 node->cache2 = node->cache1;
1108 node->cache1 = cache;
1111 struct hammer_node **tmp;
1113 node->cache1 = node->cache2;
1120 hammer_uncache_node(struct hammer_node **cache)
1124 if ((node = *cache) != NULL) {
1126 if (node->cache1 == cache) {
1127 node->cache1 = node->cache2;
1128 node->cache2 = NULL;
1129 } else if (node->cache2 == cache) {
1130 node->cache2 = NULL;
1132 panic("hammer_uncache_node: missing cache linkage");
1134 if (node->cache1 == NULL && node->cache2 == NULL)
1135 hammer_flush_node(node);
1140 * Remove a node's cache references and destroy the node if it has no
1141 * other references or backing store.
1144 hammer_flush_node(hammer_node_t node)
1146 hammer_buffer_t buffer;
1149 *node->cache1 = NULL;
1151 *node->cache2 = NULL;
1152 if (node->lock.refs == 0 && node->ondisk == NULL) {
1153 RB_REMOVE(hammer_nod_rb_tree, &node->hmp->rb_nods_root, node);
1154 if ((buffer = node->buffer) != NULL) {
1155 node->buffer = NULL;
1156 TAILQ_REMOVE(&buffer->clist, node, entry);
1157 /* buffer is unreferenced because ondisk is NULL */
1159 --hammer_count_nodes;
1160 kfree(node, M_HAMMER);
1165 * Flush passively cached B-Tree nodes associated with this buffer.
1166 * This is only called when the buffer is about to be destroyed, so
1167 * none of the nodes should have any references. The buffer is locked.
1169 * We may be interlocked with the buffer.
1172 hammer_flush_buffer_nodes(hammer_buffer_t buffer)
1176 while ((node = TAILQ_FIRST(&buffer->clist)) != NULL) {
1177 KKASSERT(node->ondisk == NULL);
1179 if (node->lock.refs == 0) {
1180 hammer_ref(&node->lock);
1181 node->flags |= HAMMER_NODE_FLUSH;
1182 hammer_rel_node(node);
1184 KKASSERT(node->loading != 0);
1185 KKASSERT(node->buffer != NULL);
1186 buffer = node->buffer;
1187 node->buffer = NULL;
1188 TAILQ_REMOVE(&buffer->clist, node, entry);
1189 /* buffer is unreferenced because ondisk is NULL */
1195 /************************************************************************
1197 ************************************************************************/
1200 * Allocate a B-Tree node.
1203 hammer_alloc_btree(hammer_transaction_t trans, int *errorp)
1205 hammer_buffer_t buffer = NULL;
1206 hammer_node_t node = NULL;
1207 hammer_off_t node_offset;
1209 node_offset = hammer_blockmap_alloc(trans, HAMMER_ZONE_BTREE_INDEX,
1210 sizeof(struct hammer_node_ondisk),
1213 node = hammer_get_node(trans->hmp, node_offset, 1, errorp);
1214 hammer_modify_node_noundo(trans, node);
1215 bzero(node->ondisk, sizeof(*node->ondisk));
1216 hammer_modify_node_done(node);
1219 hammer_rel_buffer(buffer, 0);
1226 * The returned buffers are already appropriately marked as being modified.
1227 * If the caller marks them again unnecessary undo records may be generated.
1229 * In-band data is indicated by data_bufferp == NULL. Pass a data_len of 0
1230 * for zero-fill (caller modifies data_len afterwords).
1232 * If the caller is responsible for calling hammer_modify_*() prior to making
1233 * any additional modifications to either the returned record buffer or the
1234 * returned data buffer.
1237 hammer_alloc_record(hammer_transaction_t trans,
1238 hammer_off_t *rec_offp, u_int16_t rec_type,
1239 struct hammer_buffer **rec_bufferp,
1240 int32_t data_len, void **datap,
1241 hammer_off_t *data_offp,
1242 struct hammer_buffer **data_bufferp, int *errorp)
1244 hammer_record_ondisk_t rec;
1245 hammer_off_t rec_offset;
1246 hammer_off_t data_offset;
1253 * Allocate the record
1255 rec_offset = hammer_blockmap_alloc(trans, HAMMER_ZONE_RECORD_INDEX,
1256 HAMMER_RECORD_SIZE, errorp);
1266 if (data_bufferp == NULL) {
1268 case HAMMER_RECTYPE_DATA:
1269 reclen = offsetof(struct hammer_data_record,
1272 case HAMMER_RECTYPE_DIRENTRY:
1273 reclen = offsetof(struct hammer_entry_record,
1277 panic("hammer_alloc_record: illegal "
1283 KKASSERT(reclen + data_len <= HAMMER_RECORD_SIZE);
1284 data_offset = rec_offset + reclen;
1285 } else if (data_len < HAMMER_BUFSIZE) {
1286 data_offset = hammer_blockmap_alloc(trans,
1287 HAMMER_ZONE_SMALL_DATA_INDEX,
1289 *data_offp = data_offset;
1291 data_offset = hammer_blockmap_alloc(trans,
1292 HAMMER_ZONE_LARGE_DATA_INDEX,
1294 *data_offp = data_offset;
1300 hammer_blockmap_free(trans, rec_offset, HAMMER_RECORD_SIZE);
1305 * Basic return values.
1307 * Note that because this is a 'new' buffer, there is no need to
1308 * generate UNDO records for it.
1310 *rec_offp = rec_offset;
1311 rec = hammer_bread(trans->hmp, rec_offset, errorp, rec_bufferp);
1312 hammer_modify_buffer(trans, *rec_bufferp, NULL, 0);
1313 bzero(rec, sizeof(*rec));
1314 KKASSERT(*errorp == 0);
1315 rec->base.data_off = data_offset;
1316 rec->base.data_len = data_len;
1317 hammer_modify_buffer_done(*rec_bufferp);
1321 *datap = hammer_bread(trans->hmp, data_offset, errorp,
1323 KKASSERT(*errorp == 0);
1327 } else if (data_len) {
1328 KKASSERT(data_offset + data_len - rec_offset <=
1329 HAMMER_RECORD_SIZE);
1331 *datap = (void *)((char *)rec +
1332 (int32_t)(data_offset - rec_offset));
1335 KKASSERT(datap == NULL);
1337 KKASSERT(*errorp == 0);
1344 * Allocate data. If the address of a data buffer is supplied then
1345 * any prior non-NULL *data_bufferp will be released and *data_bufferp
1346 * will be set to the related buffer. The caller must release it when
1347 * finally done. The initial *data_bufferp should be set to NULL by
1350 * The caller is responsible for making hammer_modify*() calls on the
1354 hammer_alloc_data(hammer_transaction_t trans, int32_t data_len,
1355 hammer_off_t *data_offsetp,
1356 struct hammer_buffer **data_bufferp, int *errorp)
1364 if (data_len < HAMMER_BUFSIZE) {
1365 *data_offsetp = hammer_blockmap_alloc(trans,
1366 HAMMER_ZONE_SMALL_DATA_INDEX,
1369 *data_offsetp = hammer_blockmap_alloc(trans,
1370 HAMMER_ZONE_LARGE_DATA_INDEX,
1376 if (*errorp == 0 && data_bufferp) {
1378 data = hammer_bread(trans->hmp, *data_offsetp, errorp,
1380 KKASSERT(*errorp == 0);
1387 KKASSERT(*errorp == 0);
1392 * Sync dirty buffers to the media and clean-up any loose ends.
1394 static int hammer_sync_scan1(struct mount *mp, struct vnode *vp, void *data);
1395 static int hammer_sync_scan2(struct mount *mp, struct vnode *vp, void *data);
1398 hammer_queue_inodes_flusher(hammer_mount_t hmp, int waitfor)
1400 struct hammer_sync_info info;
1403 info.waitfor = waitfor;
1404 if (waitfor == MNT_WAIT) {
1405 vmntvnodescan(hmp->mp, VMSC_GETVP,
1406 hammer_sync_scan1, hammer_sync_scan2, &info);
1408 vmntvnodescan(hmp->mp, VMSC_GETVP|VMSC_NOWAIT,
1409 hammer_sync_scan1, hammer_sync_scan2, &info);
1415 hammer_sync_hmp(hammer_mount_t hmp, int waitfor)
1417 struct hammer_sync_info info;
1420 info.waitfor = waitfor;
1422 vmntvnodescan(hmp->mp, VMSC_GETVP|VMSC_NOWAIT,
1423 hammer_sync_scan1, hammer_sync_scan2, &info);
1424 if (waitfor == MNT_WAIT)
1425 hammer_flusher_sync(hmp);
1427 hammer_flusher_async(hmp);
1433 hammer_sync_scan1(struct mount *mp, struct vnode *vp, void *data)
1435 struct hammer_inode *ip;
1438 if (vp->v_type == VNON || ip == NULL ||
1439 ((ip->flags & HAMMER_INODE_MODMASK) == 0 &&
1440 RB_EMPTY(&vp->v_rbdirty_tree))) {
1447 hammer_sync_scan2(struct mount *mp, struct vnode *vp, void *data)
1449 struct hammer_sync_info *info = data;
1450 struct hammer_inode *ip;
1454 if (vp->v_type == VNON || vp->v_type == VBAD ||
1455 ((ip->flags & HAMMER_INODE_MODMASK) == 0 &&
1456 RB_EMPTY(&vp->v_rbdirty_tree))) {
1459 error = VOP_FSYNC(vp, info->waitfor);
1461 info->error = error;