sys/vfs/hammer/hammer_ondisk.c

   1 /*
   2  * Copyright (c) 2007-2008 The DragonFly Project.  All rights reserved.
   3  *
   4  * This code is derived from software contributed to The DragonFly Project
   5  * by Matthew Dillon <dillon@backplane.com>
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  *
  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
  16  *    distribution.
  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.
  20  *
  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
  32  * SUCH DAMAGE.
  33  *
  34  * $DragonFly: src/sys/vfs/hammer/hammer_ondisk.c,v 1.76 2008/08/29 20:19:08 dillon Exp $
  35  */
  36 /*
  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.
  40  */
  41
  42 #include "hammer.h"
  43 #include <sys/fcntl.h>
  44 #include <sys/nlookup.h>
  45 #include <sys/buf.h>
  46 #include <sys/buf2.h>
  47
  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_transaction_t trans,
  52                                 hammer_node_t node, int isnew);
  53 static void _hammer_rel_node(hammer_node_t node, int locked);
  54
  55 static int
  56 hammer_vol_rb_compare(hammer_volume_t vol1, hammer_volume_t vol2)
  57 {
  58         if (vol1->vol_no < vol2->vol_no)
  59                 return(-1);
  60         if (vol1->vol_no > vol2->vol_no)
  61                 return(1);
  62         return(0);
  63 }
  64
  65 /*
  66  * hammer_buffer structures are indexed via their zoneX_offset, not
  67  * their zone2_offset.
  68  */
  69 static int
  70 hammer_buf_rb_compare(hammer_buffer_t buf1, hammer_buffer_t buf2)
  71 {
  72         if (buf1->zoneX_offset < buf2->zoneX_offset)
  73                 return(-1);
  74         if (buf1->zoneX_offset > buf2->zoneX_offset)
  75                 return(1);
  76         return(0);
  77 }
  78
  79 static int
  80 hammer_nod_rb_compare(hammer_node_t node1, hammer_node_t node2)
  81 {
  82         if (node1->node_offset < node2->node_offset)
  83                 return(-1);
  84         if (node1->node_offset > node2->node_offset)
  85                 return(1);
  86         return(0);
  87 }
  88
  89 RB_GENERATE2(hammer_vol_rb_tree, hammer_volume, rb_node,
  90              hammer_vol_rb_compare, int32_t, vol_no);
  91 RB_GENERATE2(hammer_buf_rb_tree, hammer_buffer, rb_node,
  92              hammer_buf_rb_compare, hammer_off_t, zoneX_offset);
  93 RB_GENERATE2(hammer_nod_rb_tree, hammer_node, rb_node,
  94              hammer_nod_rb_compare, hammer_off_t, node_offset);
  95
  96 /************************************************************************
  97  *                              VOLUMES                                 *
  98  ************************************************************************
  99  *
 100  * Load a HAMMER volume by name.  Returns 0 on success or a positive error
 101  * code on failure.  Volumes must be loaded at mount time, get_volume() will
 102  * not load a new volume.
 103  *
 104  * Calls made to hammer_load_volume() or single-threaded
 105  */
 106 int
 107 hammer_install_volume(struct hammer_mount *hmp, const char *volname,
 108                       struct vnode *devvp)
 109 {
 110         struct mount *mp;
 111         hammer_volume_t volume;
 112         struct hammer_volume_ondisk *ondisk;
 113         struct nlookupdata nd;
 114         struct buf *bp = NULL;
 115         int error;
 116         int ronly;
 117         int setmp = 0;
 118
 119         mp = hmp->mp;
 120         ronly = ((mp->mnt_flag & MNT_RDONLY) ? 1 : 0);
 121
 122         /*
 123          * Allocate a volume structure
 124          */
 125         ++hammer_count_volumes;
 126         volume = kmalloc(sizeof(*volume), hmp->m_misc, M_WAITOK|M_ZERO);
 127         volume->vol_name = kstrdup(volname, hmp->m_misc);
 128         volume->io.hmp = hmp;   /* bootstrap */
 129         hammer_io_init(&volume->io, volume, HAMMER_STRUCTURE_VOLUME);
 130         volume->io.offset = 0LL;
 131         volume->io.bytes = HAMMER_BUFSIZE;
 132
 133         /*
 134          * Get the device vnode
 135          */
 136         if (devvp == NULL) {
 137                 error = nlookup_init(&nd, volume->vol_name, UIO_SYSSPACE, NLC_FOLLOW);
 138                 if (error == 0)
 139                         error = nlookup(&nd);
 140                 if (error == 0)
 141                         error = cache_vref(&nd.nl_nch, nd.nl_cred, &volume->devvp);
 142                 nlookup_done(&nd);
 143         } else {
 144                 error = 0;
 145                 volume->devvp = devvp;
 146         }
 147
 148         if (error == 0) {
 149                 if (vn_isdisk(volume->devvp, &error)) {
 150                         error = vfs_mountedon(volume->devvp);
 151                 }
 152         }
 153         if (error == 0 && vcount(volume->devvp) > 0)
 154                 error = EBUSY;
 155         if (error == 0) {
 156                 vn_lock(volume->devvp, LK_EXCLUSIVE | LK_RETRY);
 157                 error = vinvalbuf(volume->devvp, V_SAVE, 0, 0);
 158                 if (error == 0) {
 159                         error = VOP_OPEN(volume->devvp,
 160                                          (ronly ? FREAD : FREAD|FWRITE),
 161                                          FSCRED, NULL);
 162                 }
 163                 vn_unlock(volume->devvp);
 164         }
 165         if (error) {
 166                 hammer_free_volume(volume);
 167                 return(error);
 168         }
 169         volume->devvp->v_rdev->si_mountpoint = mp;
 170         setmp = 1;
 171
 172         /*
 173          * Extract the volume number from the volume header and do various
 174          * sanity checks.
 175          */
 176         error = bread(volume->devvp, 0LL, HAMMER_BUFSIZE, &bp);
 177         if (error)
 178                 goto late_failure;
 179         ondisk = (void *)bp->b_data;
 180         if (ondisk->vol_signature != HAMMER_FSBUF_VOLUME) {
 181                 kprintf("hammer_mount: volume %s has an invalid header\n",
 182                         volume->vol_name);
 183                 error = EFTYPE;
 184                 goto late_failure;
 185         }
 186         volume->vol_no = ondisk->vol_no;
 187         volume->buffer_base = ondisk->vol_buf_beg;
 188         volume->vol_flags = ondisk->vol_flags;
 189         volume->nblocks = ondisk->vol_nblocks;
 190         volume->maxbuf_off = HAMMER_ENCODE_RAW_BUFFER(volume->vol_no,
 191                                     ondisk->vol_buf_end - ondisk->vol_buf_beg);
 192         volume->maxraw_off = ondisk->vol_buf_end;
 193
 194         if (RB_EMPTY(&hmp->rb_vols_root)) {
 195                 hmp->fsid = ondisk->vol_fsid;
 196         } else if (bcmp(&hmp->fsid, &ondisk->vol_fsid, sizeof(uuid_t))) {
 197                 kprintf("hammer_mount: volume %s's fsid does not match "
 198                         "other volumes\n", volume->vol_name);
 199                 error = EFTYPE;
 200                 goto late_failure;
 201         }
 202
 203         /*
 204          * Insert the volume structure into the red-black tree.
 205          */
 206         if (RB_INSERT(hammer_vol_rb_tree, &hmp->rb_vols_root, volume)) {
 207                 kprintf("hammer_mount: volume %s has a duplicate vol_no %d\n",
 208                         volume->vol_name, volume->vol_no);
 209                 error = EEXIST;
 210         }
 211
 212         /*
 213          * Set the root volume .  HAMMER special cases rootvol the structure.
 214          * We do not hold a ref because this would prevent related I/O
 215          * from being flushed.
 216          */
 217         if (error == 0 && ondisk->vol_rootvol == ondisk->vol_no) {
 218                 hmp->rootvol = volume;
 219                 hmp->nvolumes = ondisk->vol_count;
 220                 if (bp) {
 221                         brelse(bp);
 222                         bp = NULL;
 223                 }
 224                 hmp->mp->mnt_stat.f_blocks += ondisk->vol0_stat_bigblocks *
 225                         (HAMMER_LARGEBLOCK_SIZE / HAMMER_BUFSIZE);
 226                 hmp->mp->mnt_vstat.f_blocks += ondisk->vol0_stat_bigblocks *
 227                         (HAMMER_LARGEBLOCK_SIZE / HAMMER_BUFSIZE);
 228         }
 229 late_failure:
 230         if (bp)
 231                 brelse(bp);
 232         if (error) {
 233                 /*vinvalbuf(volume->devvp, V_SAVE, 0, 0);*/
 234                 if (setmp)
 235                         volume->devvp->v_rdev->si_mountpoint = NULL;
 236                 VOP_CLOSE(volume->devvp, ronly ? FREAD : FREAD|FWRITE);
 237                 hammer_free_volume(volume);
 238         }
 239         return (error);
 240 }
 241
 242 /*
 243  * This is called for each volume when updating the mount point from
 244  * read-write to read-only or vise-versa.
 245  */
 246 int
 247 hammer_adjust_volume_mode(hammer_volume_t volume, void *data __unused)
 248 {
 249         if (volume->devvp) {
 250                 vn_lock(volume->devvp, LK_EXCLUSIVE | LK_RETRY);
 251                 if (volume->io.hmp->ronly) {
 252                         /* do not call vinvalbuf */
 253                         VOP_OPEN(volume->devvp, FREAD, FSCRED, NULL);
 254                         VOP_CLOSE(volume->devvp, FREAD|FWRITE);
 255                 } else {
 256                         /* do not call vinvalbuf */
 257                         VOP_OPEN(volume->devvp, FREAD|FWRITE, FSCRED, NULL);
 258                         VOP_CLOSE(volume->devvp, FREAD);
 259                 }
 260                 vn_unlock(volume->devvp);
 261         }
 262         return(0);
 263 }
 264
 265 /*
 266  * Unload and free a HAMMER volume.  Must return >= 0 to continue scan
 267  * so returns -1 on failure.
 268  */
 269 int
 270 hammer_unload_volume(hammer_volume_t volume, void *data __unused)
 271 {
 272         hammer_mount_t hmp = volume->io.hmp;
 273         int ronly = ((hmp->mp->mnt_flag & MNT_RDONLY) ? 1 : 0);
 274
 275         /*
 276          * Clean up the root volume pointer, which is held unlocked in hmp.
 277          */
 278         if (hmp->rootvol == volume)
 279                 hmp->rootvol = NULL;
 280
 281         /*
 282          * We must not flush a dirty buffer to disk on umount.  It should
 283          * have already been dealt with by the flusher, or we may be in
 284          * catastrophic failure.
 285          */
 286         hammer_io_clear_modify(&volume->io, 1);
 287         volume->io.waitdep = 1;
 288
 289         /*
 290          * Clean up the persistent ref ioerror might have on the volume
 291          */
 292         if (volume->io.ioerror) {
 293                 volume->io.ioerror = 0;
 294                 hammer_rel(&volume->io.lock);
 295         }
 296
 297         /*
 298          * This should release the bp.  Releasing the volume with flush set
 299          * implies the interlock is set.
 300          */
 301         hammer_ref_interlock_true(&volume->io.lock);
 302         hammer_rel_volume(volume, 1);
 303         KKASSERT(volume->io.bp == NULL);
 304
 305         /*
 306          * There should be no references on the volume, no clusters, and
 307          * no super-clusters.
 308          */
 309         KKASSERT(hammer_norefs(&volume->io.lock));
 310
 311         volume->ondisk = NULL;
 312         if (volume->devvp) {
 313                 if (volume->devvp->v_rdev &&
 314                     volume->devvp->v_rdev->si_mountpoint == hmp->mp
 315                 ) {
 316                         volume->devvp->v_rdev->si_mountpoint = NULL;
 317                 }
 318                 if (ronly) {
 319                         /*
 320                          * Make sure we don't sync anything to disk if we
 321                          * are in read-only mode (1) or critically-errored
 322                          * (2).  Note that there may be dirty buffers in
 323                          * normal read-only mode from crash recovery.
 324                          */
 325                         vinvalbuf(volume->devvp, 0, 0, 0);
 326                         VOP_CLOSE(volume->devvp, FREAD);
 327                 } else {
 328                         /*
 329                          * Normal termination, save any dirty buffers
 330                          * (XXX there really shouldn't be any).
 331                          */
 332                         vinvalbuf(volume->devvp, V_SAVE, 0, 0);
 333                         VOP_CLOSE(volume->devvp, FREAD|FWRITE);
 334                 }
 335         }
 336
 337         /*
 338          * Destroy the structure
 339          */
 340         RB_REMOVE(hammer_vol_rb_tree, &hmp->rb_vols_root, volume);
 341         hammer_free_volume(volume);
 342         return(0);
 343 }
 344
 345 static
 346 void
 347 hammer_free_volume(hammer_volume_t volume)
 348 {
 349         hammer_mount_t hmp = volume->io.hmp;
 350
 351         if (volume->vol_name) {
 352                 kfree(volume->vol_name, hmp->m_misc);
 353                 volume->vol_name = NULL;
 354         }
 355         if (volume->devvp) {
 356                 vrele(volume->devvp);
 357                 volume->devvp = NULL;
 358         }
 359         --hammer_count_volumes;
 360         kfree(volume, hmp->m_misc);
 361 }
 362
 363 /*
 364  * Get a HAMMER volume.  The volume must already exist.
 365  */
 366 hammer_volume_t
 367 hammer_get_volume(struct hammer_mount *hmp, int32_t vol_no, int *errorp)
 368 {
 369         struct hammer_volume *volume;
 370
 371         /*
 372          * Locate the volume structure
 373          */
 374         volume = RB_LOOKUP(hammer_vol_rb_tree, &hmp->rb_vols_root, vol_no);
 375         if (volume == NULL) {
 376                 *errorp = ENOENT;
 377                 return(NULL);
 378         }
 379
 380         /*
 381          * Reference the volume, load/check the data on the 0->1 transition.
 382          * hammer_load_volume() will dispose of the interlock on return,
 383          * and also clean up the ref count on error.
 384          */
 385         if (hammer_ref_interlock(&volume->io.lock)) {
 386                 *errorp = hammer_load_volume(volume);
 387                 if (*errorp)
 388                         volume = NULL;
 389         } else {
 390                 KKASSERT(volume->ondisk);
 391                 *errorp = 0;
 392         }
 393         return(volume);
 394 }
 395
 396 int
 397 hammer_ref_volume(hammer_volume_t volume)
 398 {
 399         int error;
 400
 401         /*
 402          * Reference the volume and deal with the check condition used to
 403          * load its ondisk info.
 404          */
 405         if (hammer_ref_interlock(&volume->io.lock)) {
 406                 error = hammer_load_volume(volume);
 407         } else {
 408                 KKASSERT(volume->ondisk);
 409                 error = 0;
 410         }
 411         return (error);
 412 }
 413
 414 hammer_volume_t
 415 hammer_get_root_volume(struct hammer_mount *hmp, int *errorp)
 416 {
 417         hammer_volume_t volume;
 418
 419         volume = hmp->rootvol;
 420         KKASSERT(volume != NULL);
 421
 422         /*
 423          * Reference the volume and deal with the check condition used to
 424          * load its ondisk info.
 425          */
 426         if (hammer_ref_interlock(&volume->io.lock)) {
 427                 *errorp = hammer_load_volume(volume);
 428                 if (*errorp)
 429                         volume = NULL;
 430         } else {
 431                 KKASSERT(volume->ondisk);
 432                 *errorp = 0;
 433         }
 434         return (volume);
 435 }
 436
 437 /*
 438  * Load a volume's on-disk information.  The volume must be referenced and
 439  * the interlock is held on call.  The interlock will be released on return.
 440  * The reference will also be released on return if an error occurs.
 441  */
 442 static int
 443 hammer_load_volume(hammer_volume_t volume)
 444 {
 445         int error;
 446
 447         if (volume->ondisk == NULL) {
 448                 error = hammer_io_read(volume->devvp, &volume->io,
 449                                        HAMMER_BUFSIZE);
 450                 if (error == 0) {
 451                         volume->ondisk = (void *)volume->io.bp->b_data;
 452                         hammer_ref_interlock_done(&volume->io.lock);
 453                 } else {
 454                         hammer_rel_volume(volume, 1);
 455                 }
 456         } else {
 457                 error = 0;
 458         }
 459         return(error);
 460 }
 461
 462 /*
 463  * Release a previously acquired reference on the volume.
 464  *
 465  * Volumes are not unloaded from memory during normal operation.
 466  */
 467 void
 468 hammer_rel_volume(hammer_volume_t volume, int locked)
 469 {
 470         struct buf *bp;
 471
 472         if (hammer_rel_interlock(&volume->io.lock, locked)) {
 473                 volume->ondisk = NULL;
 474                 bp = hammer_io_release(&volume->io, locked);
 475                 hammer_rel_interlock_done(&volume->io.lock, locked);
 476                 if (bp)
 477                         brelse(bp);
 478         }
 479 }
 480
 481 int
 482 hammer_mountcheck_volumes(struct hammer_mount *hmp)
 483 {
 484         hammer_volume_t vol;
 485         int i;
 486
 487         for (i = 0; i < hmp->nvolumes; ++i) {
 488                 vol = RB_LOOKUP(hammer_vol_rb_tree, &hmp->rb_vols_root, i);
 489                 if (vol == NULL)
 490                         return(EINVAL);
 491         }
 492         return(0);
 493 }
 494
 495 /************************************************************************
 496  *                              BUFFERS                                 *
 497  ************************************************************************
 498  *
 499  * Manage buffers.  Currently most blockmap-backed zones are direct-mapped
 500  * to zone-2 buffer offsets, without a translation stage.  However, the
 501  * hammer_buffer structure is indexed by its zoneX_offset, not its
 502  * zone2_offset.
 503  *
 504  * The proper zone must be maintained throughout the code-base all the way
 505  * through to the big-block allocator, or routines like hammer_del_buffers()
 506  * will not be able to locate all potentially conflicting buffers.
 507  */
 508 hammer_buffer_t
 509 hammer_get_buffer(hammer_mount_t hmp, hammer_off_t buf_offset,
 510                   int bytes, int isnew, int *errorp)
 511 {
 512         hammer_buffer_t buffer;
 513         hammer_volume_t volume;
 514         hammer_off_t    zone2_offset;
 515         hammer_io_type_t iotype;
 516         int vol_no;
 517         int zone;
 518
 519         buf_offset &= ~HAMMER_BUFMASK64;
 520 again:
 521         /*
 522          * Shortcut if the buffer is already cached
 523          */
 524         buffer = RB_LOOKUP(hammer_buf_rb_tree, &hmp->rb_bufs_root, buf_offset);
 525         if (buffer) {
 526                 /*
 527                  * Once refed the ondisk field will not be cleared by
 528                  * any other action.  Shortcut the operation if the
 529                  * ondisk structure is valid.
 530                  */
 531                 if (hammer_ref_interlock(&buffer->io.lock) == 0) {
 532                         hammer_io_advance(&buffer->io);
 533                         KKASSERT(buffer->ondisk);
 534                         *errorp = 0;
 535                         return(buffer);
 536                 }
 537
 538                 /*
 539                  * 0->1 transition or defered 0->1 transition (CHECK),
 540                  * interlock now held.  Shortcut if ondisk is already
 541                  * assigned.
 542                  */
 543                 ++hammer_count_refedbufs;
 544                 if (buffer->ondisk) {
 545                         hammer_io_advance(&buffer->io);
 546                         hammer_ref_interlock_done(&buffer->io.lock);
 547                         *errorp = 0;
 548                         return(buffer);
 549                 }
 550
 551                 /*
 552                  * The buffer is no longer loose if it has a ref, and
 553                  * cannot become loose once it gains a ref.  Loose
 554                  * buffers will never be in a modified state.  This should
 555                  * only occur on the 0->1 transition of refs.
 556                  *
 557                  * lose_list can be modified via a biodone() interrupt
 558                  * so the io_token must be held.
 559                  */
 560                 if (buffer->io.mod_list == &hmp->lose_list) {
 561                         lwkt_gettoken(&hmp->io_token);
 562                         if (buffer->io.mod_list == &hmp->lose_list) {
 563                                 TAILQ_REMOVE(buffer->io.mod_list, &buffer->io,
 564                                              mod_entry);
 565                                 buffer->io.mod_list = NULL;
 566                                 KKASSERT(buffer->io.modified == 0);
 567                         }
 568                         lwkt_reltoken(&hmp->io_token);
 569                 }
 570                 goto found;
 571         }
 572
 573         /*
 574          * What is the buffer class?
 575          */
 576         zone = HAMMER_ZONE_DECODE(buf_offset);
 577
 578         switch(zone) {
 579         case HAMMER_ZONE_LARGE_DATA_INDEX:
 580         case HAMMER_ZONE_SMALL_DATA_INDEX:
 581                 iotype = HAMMER_STRUCTURE_DATA_BUFFER;
 582                 break;
 583         case HAMMER_ZONE_UNDO_INDEX:
 584                 iotype = HAMMER_STRUCTURE_UNDO_BUFFER;
 585                 break;
 586         case HAMMER_ZONE_META_INDEX:
 587         default:
 588                 /*
 589                  * NOTE: inode data and directory entries are placed in this
 590                  * zone.  inode atime/mtime is updated in-place and thus
 591                  * buffers containing inodes must be synchronized as
 592                  * meta-buffers, same as buffers containing B-Tree info.
 593                  */
 594                 iotype = HAMMER_STRUCTURE_META_BUFFER;
 595                 break;
 596         }
 597
 598         /*
 599          * Handle blockmap offset translations
 600          */
 601         if (zone >= HAMMER_ZONE_BTREE_INDEX) {
 602                 zone2_offset = hammer_blockmap_lookup(hmp, buf_offset, errorp);
 603         } else if (zone == HAMMER_ZONE_UNDO_INDEX) {
 604                 zone2_offset = hammer_undo_lookup(hmp, buf_offset, errorp);
 605         } else {
 606                 KKASSERT(zone == HAMMER_ZONE_RAW_BUFFER_INDEX);
 607                 zone2_offset = buf_offset;
 608                 *errorp = 0;
 609         }
 610         if (*errorp)
 611                 return(NULL);
 612
 613         /*
 614          * NOTE: zone2_offset and maxbuf_off are both full zone-2 offset
 615          * specifications.
 616          */
 617         KKASSERT((zone2_offset & HAMMER_OFF_ZONE_MASK) ==
 618                  HAMMER_ZONE_RAW_BUFFER);
 619         vol_no = HAMMER_VOL_DECODE(zone2_offset);
 620         volume = hammer_get_volume(hmp, vol_no, errorp);
 621         if (volume == NULL)
 622                 return(NULL);
 623
 624         KKASSERT(zone2_offset < volume->maxbuf_off);
 625
 626         /*
 627          * Allocate a new buffer structure.  We will check for races later.
 628          */
 629         ++hammer_count_buffers;
 630         buffer = kmalloc(sizeof(*buffer), hmp->m_misc,
 631                          M_WAITOK|M_ZERO|M_USE_RESERVE);
 632         buffer->zone2_offset = zone2_offset;
 633         buffer->zoneX_offset = buf_offset;
 634
 635         hammer_io_init(&buffer->io, volume, iotype);
 636         buffer->io.offset = volume->ondisk->vol_buf_beg +
 637                             (zone2_offset & HAMMER_OFF_SHORT_MASK);
 638         buffer->io.bytes = bytes;
 639         TAILQ_INIT(&buffer->clist);
 640         hammer_ref_interlock_true(&buffer->io.lock);
 641
 642         /*
 643          * Insert the buffer into the RB tree and handle late collisions.
 644          */
 645         if (RB_INSERT(hammer_buf_rb_tree, &hmp->rb_bufs_root, buffer)) {
 646                 hammer_rel_volume(volume, 0);
 647                 buffer->io.volume = NULL;                       /* safety */
 648                 if (hammer_rel_interlock(&buffer->io.lock, 1))  /* safety */
 649                         hammer_rel_interlock_done(&buffer->io.lock, 1);
 650                 --hammer_count_buffers;
 651                 kfree(buffer, hmp->m_misc);
 652                 goto again;
 653         }
 654         ++hammer_count_refedbufs;
 655 found:
 656
 657         /*
 658          * The buffer is referenced and interlocked.  Load the buffer
 659          * if necessary.  hammer_load_buffer() deals with the interlock
 660          * and, if an error is returned, also deals with the ref.
 661          */
 662         if (buffer->ondisk == NULL) {
 663                 *errorp = hammer_load_buffer(buffer, isnew);
 664                 if (*errorp)
 665                         buffer = NULL;
 666         } else {
 667                 hammer_io_advance(&buffer->io);
 668                 hammer_ref_interlock_done(&buffer->io.lock);
 669                 *errorp = 0;
 670         }
 671         return(buffer);
 672 }
 673
 674 /*
 675  * This is used by the direct-read code to deal with large-data buffers
 676  * created by the reblocker and mirror-write code.  The direct-read code
 677  * bypasses the HAMMER buffer subsystem and so any aliased dirty or write-
 678  * running hammer buffers must be fully synced to disk before we can issue
 679  * the direct-read.
 680  *
 681  * This code path is not considered critical as only the rebocker and
 682  * mirror-write code will create large-data buffers via the HAMMER buffer
 683  * subsystem.  They do that because they operate at the B-Tree level and
 684  * do not access the vnode/inode structures.
 685  */
 686 void
 687 hammer_sync_buffers(hammer_mount_t hmp, hammer_off_t base_offset, int bytes)
 688 {
 689         hammer_buffer_t buffer;
 690         int error;
 691
 692         KKASSERT((base_offset & HAMMER_OFF_ZONE_MASK) ==
 693                  HAMMER_ZONE_LARGE_DATA);
 694
 695         while (bytes > 0) {
 696                 buffer = RB_LOOKUP(hammer_buf_rb_tree, &hmp->rb_bufs_root,
 697                                    base_offset);
 698                 if (buffer && (buffer->io.modified || buffer->io.running)) {
 699                         error = hammer_ref_buffer(buffer);
 700                         if (error == 0) {
 701                                 hammer_io_wait(&buffer->io);
 702                                 if (buffer->io.modified) {
 703                                         hammer_io_write_interlock(&buffer->io);
 704                                         hammer_io_flush(&buffer->io, 0);
 705                                         hammer_io_done_interlock(&buffer->io);
 706                                         hammer_io_wait(&buffer->io);
 707                                 }
 708                                 hammer_rel_buffer(buffer, 0);
 709                         }
 710                 }
 711                 base_offset += HAMMER_BUFSIZE;
 712                 bytes -= HAMMER_BUFSIZE;
 713         }
 714 }
 715
 716 /*
 717  * Destroy all buffers covering the specified zoneX offset range.  This
 718  * is called when the related blockmap layer2 entry is freed or when
 719  * a direct write bypasses our buffer/buffer-cache subsystem.
 720  *
 721  * The buffers may be referenced by the caller itself.  Setting reclaim
 722  * will cause the buffer to be destroyed when it's ref count reaches zero.
 723  *
 724  * Return 0 on success, EAGAIN if some buffers could not be destroyed due
 725  * to additional references held by other threads, or some other (typically
 726  * fatal) error.
 727  */
 728 int
 729 hammer_del_buffers(hammer_mount_t hmp, hammer_off_t base_offset,
 730                    hammer_off_t zone2_offset, int bytes,
 731                    int report_conflicts)
 732 {
 733         hammer_buffer_t buffer;
 734         hammer_volume_t volume;
 735         int vol_no;
 736         int error;
 737         int ret_error;
 738
 739         vol_no = HAMMER_VOL_DECODE(zone2_offset);
 740         volume = hammer_get_volume(hmp, vol_no, &ret_error);
 741         KKASSERT(ret_error == 0);
 742
 743         while (bytes > 0) {
 744                 buffer = RB_LOOKUP(hammer_buf_rb_tree, &hmp->rb_bufs_root,
 745                                    base_offset);
 746                 if (buffer) {
 747                         error = hammer_ref_buffer(buffer);
 748                         if (hammer_debug_general & 0x20000) {
 749                                 kprintf("hammer: delbufr %016jx "
 750                                         "rerr=%d 1ref=%d\n",
 751                                         (intmax_t)buffer->zoneX_offset,
 752                                         error,
 753                                         hammer_oneref(&buffer->io.lock));
 754                         }
 755                         if (error == 0 && !hammer_oneref(&buffer->io.lock)) {
 756                                 error = EAGAIN;
 757                                 hammer_rel_buffer(buffer, 0);
 758                         }
 759                         if (error == 0) {
 760                                 KKASSERT(buffer->zone2_offset == zone2_offset);
 761                                 hammer_io_clear_modify(&buffer->io, 1);
 762                                 buffer->io.reclaim = 1;
 763                                 buffer->io.waitdep = 1;
 764                                 KKASSERT(buffer->io.volume == volume);
 765                                 hammer_rel_buffer(buffer, 0);
 766                         }
 767                 } else {
 768                         error = hammer_io_inval(volume, zone2_offset);
 769                 }
 770                 if (error) {
 771                         ret_error = error;
 772                         if (report_conflicts ||
 773                             (hammer_debug_general & 0x8000)) {
 774                                 kprintf("hammer_del_buffers: unable to "
 775                                         "invalidate %016llx buffer=%p rep=%d\n",
 776                                         (long long)base_offset,
 777                                         buffer, report_conflicts);
 778                         }
 779                 }
 780                 base_offset += HAMMER_BUFSIZE;
 781                 zone2_offset += HAMMER_BUFSIZE;
 782                 bytes -= HAMMER_BUFSIZE;
 783         }
 784         hammer_rel_volume(volume, 0);
 785         return (ret_error);
 786 }
 787
 788 /*
 789  * Given a referenced and interlocked buffer load/validate the data.
 790  *
 791  * The buffer interlock will be released on return.  If an error is
 792  * returned the buffer reference will also be released (and the buffer
 793  * pointer will thus be stale).
 794  */
 795 static int
 796 hammer_load_buffer(hammer_buffer_t buffer, int isnew)
 797 {
 798         hammer_volume_t volume;
 799         int error;
 800
 801         /*
 802          * Load the buffer's on-disk info
 803          */
 804         volume = buffer->io.volume;
 805
 806         if (hammer_debug_io & 0x0004) {
 807                 kprintf("load_buffer %016llx %016llx isnew=%d od=%p\n",
 808                         (long long)buffer->zoneX_offset,
 809                         (long long)buffer->zone2_offset,
 810                         isnew, buffer->ondisk);
 811         }
 812
 813         if (buffer->ondisk == NULL) {
 814                 /*
 815                  * Issue the read or generate a new buffer.  When reading
 816                  * the limit argument controls any read-ahead clustering
 817                  * hammer_io_read() is allowed to do.
 818                  *
 819                  * We cannot read-ahead in the large-data zone and we cannot
 820                  * cross a largeblock boundary as the next largeblock might
 821                  * use a different buffer size.
 822                  */
 823                 if (isnew) {
 824                         error = hammer_io_new(volume->devvp, &buffer->io);
 825                 } else if ((buffer->zoneX_offset & HAMMER_OFF_ZONE_MASK) ==
 826                            HAMMER_ZONE_LARGE_DATA) {
 827                         error = hammer_io_read(volume->devvp, &buffer->io,
 828                                                buffer->io.bytes);
 829                 } else {
 830                         hammer_off_t limit;
 831
 832                         limit = (buffer->zone2_offset +
 833                                  HAMMER_LARGEBLOCK_MASK64) &
 834                                 ~HAMMER_LARGEBLOCK_MASK64;
 835                         limit -= buffer->zone2_offset;
 836                         error = hammer_io_read(volume->devvp, &buffer->io,
 837                                                limit);
 838                 }
 839                 if (error == 0)
 840                         buffer->ondisk = (void *)buffer->io.bp->b_data;
 841         } else if (isnew) {
 842                 error = hammer_io_new(volume->devvp, &buffer->io);
 843         } else {
 844                 error = 0;
 845         }
 846         if (error == 0) {
 847                 hammer_io_advance(&buffer->io);
 848                 hammer_ref_interlock_done(&buffer->io.lock);
 849         } else {
 850                 hammer_rel_buffer(buffer, 1);
 851         }
 852         return (error);
 853 }
 854
 855 /*
 856  * NOTE: Called from RB_SCAN, must return >= 0 for scan to continue.
 857  * This routine is only called during unmount or when a volume is
 858  * removed.
 859  *
 860  * If data != NULL, it specifies a volume whoose buffers should
 861  * be unloaded.
 862  */
 863 int
 864 hammer_unload_buffer(hammer_buffer_t buffer, void *data)
 865 {
 866         struct hammer_volume *volume = (struct hammer_volume *) data;
 867
 868         /*
 869          * If volume != NULL we are only interested in unloading buffers
 870          * associated with a particular volume.
 871          */
 872         if (volume != NULL && volume != buffer->io.volume)
 873                 return 0;
 874
 875         /*
 876          * Clean up the persistent ref ioerror might have on the buffer
 877          * and acquire a ref.  Expect a 0->1 transition.
 878          */
 879         if (buffer->io.ioerror) {
 880                 buffer->io.ioerror = 0;
 881                 hammer_rel(&buffer->io.lock);
 882                 --hammer_count_refedbufs;
 883         }
 884         hammer_ref_interlock_true(&buffer->io.lock);
 885         ++hammer_count_refedbufs;
 886
 887         /*
 888          * We must not flush a dirty buffer to disk on umount.  It should
 889          * have already been dealt with by the flusher, or we may be in
 890          * catastrophic failure.
 891          *
 892          * We must set waitdep to ensure that a running buffer is waited
 893          * on and released prior to us trying to unload the volume.
 894          */
 895         hammer_io_clear_modify(&buffer->io, 1);
 896         hammer_flush_buffer_nodes(buffer);
 897         buffer->io.waitdep = 1;
 898         hammer_rel_buffer(buffer, 1);
 899         return(0);
 900 }
 901
 902 /*
 903  * Reference a buffer that is either already referenced or via a specially
 904  * handled pointer (aka cursor->buffer).
 905  */
 906 int
 907 hammer_ref_buffer(hammer_buffer_t buffer)
 908 {
 909         hammer_mount_t hmp;
 910         int error;
 911         int locked;
 912
 913         /*
 914          * Acquire a ref, plus the buffer will be interlocked on the
 915          * 0->1 transition.
 916          */
 917         locked = hammer_ref_interlock(&buffer->io.lock);
 918         hmp = buffer->io.hmp;
 919
 920         /*
 921          * At this point a biodone() will not touch the buffer other then
 922          * incidental bits.  However, lose_list can be modified via
 923          * a biodone() interrupt.
 924          *
 925          * No longer loose.  lose_list requires the io_token.
 926          */
 927         if (buffer->io.mod_list == &hmp->lose_list) {
 928                 lwkt_gettoken(&hmp->io_token);
 929                 if (buffer->io.mod_list == &hmp->lose_list) {
 930                         TAILQ_REMOVE(buffer->io.mod_list, &buffer->io,
 931                                      mod_entry);
 932                         buffer->io.mod_list = NULL;
 933                 }
 934                 lwkt_reltoken(&hmp->io_token);
 935         }
 936
 937         if (locked) {
 938                 ++hammer_count_refedbufs;
 939                 error = hammer_load_buffer(buffer, 0);
 940                 /* NOTE: on error the buffer pointer is stale */
 941         } else {
 942                 error = 0;
 943         }
 944         return(error);
 945 }
 946
 947 /*
 948  * Release a reference on the buffer.  On the 1->0 transition the
 949  * underlying IO will be released but the data reference is left
 950  * cached.
 951  *
 952  * Only destroy the structure itself if the related buffer cache buffer
 953  * was disassociated from it.  This ties the management of the structure
 954  * to the buffer cache subsystem.  buffer->ondisk determines whether the
 955  * embedded io is referenced or not.
 956  */
 957 void
 958 hammer_rel_buffer(hammer_buffer_t buffer, int locked)
 959 {
 960         hammer_volume_t volume;
 961         hammer_mount_t hmp;
 962         struct buf *bp = NULL;
 963         int freeme = 0;
 964
 965         hmp = buffer->io.hmp;
 966
 967         if (hammer_rel_interlock(&buffer->io.lock, locked) == 0)
 968                 return;
 969
 970         /*
 971          * hammer_count_refedbufs accounting.  Decrement if we are in
 972          * the error path or if CHECK is clear.
 973          *
 974          * If we are not in the error path and CHECK is set the caller
 975          * probably just did a hammer_ref() and didn't account for it,
 976          * so we don't account for the loss here.
 977          */
 978         if (locked || (buffer->io.lock.refs & HAMMER_REFS_CHECK) == 0)
 979                 --hammer_count_refedbufs;
 980
 981         /*
 982          * If the caller locked us or the normal released transitions
 983          * from 1->0 (and acquired the lock) attempt to release the
 984          * io.  If the called locked us we tell hammer_io_release()
 985          * to flush (which would be the unload or failure path).
 986          */
 987         bp = hammer_io_release(&buffer->io, locked);
 988
 989         /*
 990          * If the buffer has no bp association and no refs we can destroy
 991          * it.
 992          *
 993          * NOTE: It is impossible for any associated B-Tree nodes to have
 994          * refs if the buffer has no additional refs.
 995          */
 996         if (buffer->io.bp == NULL && hammer_norefs(&buffer->io.lock)) {
 997                 RB_REMOVE(hammer_buf_rb_tree,
 998                           &buffer->io.hmp->rb_bufs_root,
 999                           buffer);
1000                 volume = buffer->io.volume;
1001                 buffer->io.volume = NULL; /* sanity */
1002                 hammer_rel_volume(volume, 0);
1003                 hammer_io_clear_modlist(&buffer->io);
1004                 hammer_flush_buffer_nodes(buffer);
1005                 KKASSERT(TAILQ_EMPTY(&buffer->clist));
1006                 freeme = 1;
1007         }
1008
1009         /*
1010          * Cleanup
1011          */
1012         hammer_rel_interlock_done(&buffer->io.lock, locked);
1013         if (bp)
1014                 brelse(bp);
1015         if (freeme) {
1016                 --hammer_count_buffers;
1017                 kfree(buffer, hmp->m_misc);
1018         }
1019 }
1020
1021 /*
1022  * Access the filesystem buffer containing the specified hammer offset.
1023  * buf_offset is a conglomeration of the volume number and vol_buf_beg
1024  * relative buffer offset.  It must also have bit 55 set to be valid.
1025  * (see hammer_off_t in hammer_disk.h).
1026  *
1027  * Any prior buffer in *bufferp will be released and replaced by the
1028  * requested buffer.
1029  *
1030  * NOTE: The buffer is indexed via its zoneX_offset but we allow the
1031  * passed cached *bufferp to match against either zoneX or zone2.
1032  */
1033 static __inline
1034 void *
1035 _hammer_bread(hammer_mount_t hmp, hammer_off_t buf_offset, int bytes,
1036              int *errorp, struct hammer_buffer **bufferp)
1037 {
1038         hammer_buffer_t buffer;
1039         int32_t xoff = (int32_t)buf_offset & HAMMER_BUFMASK;
1040
1041         buf_offset &= ~HAMMER_BUFMASK64;
1042         KKASSERT((buf_offset & HAMMER_OFF_ZONE_MASK) != 0);
1043
1044         buffer = *bufferp;
1045         if (buffer == NULL || (buffer->zone2_offset != buf_offset &&
1046                                buffer->zoneX_offset != buf_offset)) {
1047                 if (buffer)
1048                         hammer_rel_buffer(buffer, 0);
1049                 buffer = hammer_get_buffer(hmp, buf_offset, bytes, 0, errorp);
1050                 *bufferp = buffer;
1051         } else {
1052                 *errorp = 0;
1053         }
1054
1055         /*
1056          * Return a pointer to the buffer data.
1057          */
1058         if (buffer == NULL)
1059                 return(NULL);
1060         else
1061                 return((char *)buffer->ondisk + xoff);
1062 }
1063
1064 void *
1065 hammer_bread(hammer_mount_t hmp, hammer_off_t buf_offset,
1066              int *errorp, struct hammer_buffer **bufferp)
1067 {
1068         return(_hammer_bread(hmp, buf_offset, HAMMER_BUFSIZE, errorp, bufferp));
1069 }
1070
1071 void *
1072 hammer_bread_ext(hammer_mount_t hmp, hammer_off_t buf_offset, int bytes,
1073                  int *errorp, struct hammer_buffer **bufferp)
1074 {
1075         bytes = (bytes + HAMMER_BUFMASK) & ~HAMMER_BUFMASK;
1076         return(_hammer_bread(hmp, buf_offset, bytes, errorp, bufferp));
1077 }
1078
1079 /*
1080  * Access the filesystem buffer containing the specified hammer offset.
1081  * No disk read operation occurs.  The result buffer may contain garbage.
1082  *
1083  * Any prior buffer in *bufferp will be released and replaced by the
1084  * requested buffer.
1085  *
1086  * This function marks the buffer dirty but does not increment its
1087  * modify_refs count.
1088  */
1089 static __inline
1090 void *
1091 _hammer_bnew(hammer_mount_t hmp, hammer_off_t buf_offset, int bytes,
1092              int *errorp, struct hammer_buffer **bufferp)
1093 {
1094         hammer_buffer_t buffer;
1095         int32_t xoff = (int32_t)buf_offset & HAMMER_BUFMASK;
1096
1097         buf_offset &= ~HAMMER_BUFMASK64;
1098
1099         buffer = *bufferp;
1100         if (buffer == NULL || (buffer->zone2_offset != buf_offset &&
1101                                buffer->zoneX_offset != buf_offset)) {
1102                 if (buffer)
1103                         hammer_rel_buffer(buffer, 0);
1104                 buffer = hammer_get_buffer(hmp, buf_offset, bytes, 1, errorp);
1105                 *bufferp = buffer;
1106         } else {
1107                 *errorp = 0;
1108         }
1109
1110         /*
1111          * Return a pointer to the buffer data.
1112          */
1113         if (buffer == NULL)
1114                 return(NULL);
1115         else
1116                 return((char *)buffer->ondisk + xoff);
1117 }
1118
1119 void *
1120 hammer_bnew(hammer_mount_t hmp, hammer_off_t buf_offset,
1121              int *errorp, struct hammer_buffer **bufferp)
1122 {
1123         return(_hammer_bnew(hmp, buf_offset, HAMMER_BUFSIZE, errorp, bufferp));
1124 }
1125
1126 void *
1127 hammer_bnew_ext(hammer_mount_t hmp, hammer_off_t buf_offset, int bytes,
1128                 int *errorp, struct hammer_buffer **bufferp)
1129 {
1130         bytes = (bytes + HAMMER_BUFMASK) & ~HAMMER_BUFMASK;
1131         return(_hammer_bnew(hmp, buf_offset, bytes, errorp, bufferp));
1132 }
1133
1134 /************************************************************************
1135  *                              NODES                                   *
1136  ************************************************************************
1137  *
1138  * Manage B-Tree nodes.  B-Tree nodes represent the primary indexing
1139  * method used by the HAMMER filesystem.
1140  *
1141  * Unlike other HAMMER structures, a hammer_node can be PASSIVELY
1142  * associated with its buffer, and will only referenced the buffer while
1143  * the node itself is referenced.
1144  *
1145  * A hammer_node can also be passively associated with other HAMMER
1146  * structures, such as inodes, while retaining 0 references.  These
1147  * associations can be cleared backwards using a pointer-to-pointer in
1148  * the hammer_node.
1149  *
1150  * This allows the HAMMER implementation to cache hammer_nodes long-term
1151  * and short-cut a great deal of the infrastructure's complexity.  In
1152  * most cases a cached node can be reacquired without having to dip into
1153  * either the buffer or cluster management code.
1154  *
1155  * The caller must pass a referenced cluster on call and will retain
1156  * ownership of the reference on return.  The node will acquire its own
1157  * additional references, if necessary.
1158  */
1159 hammer_node_t
1160 hammer_get_node(hammer_transaction_t trans, hammer_off_t node_offset,
1161                 int isnew, int *errorp)
1162 {
1163         hammer_mount_t hmp = trans->hmp;
1164         hammer_node_t node;
1165         int doload;
1166
1167         KKASSERT((node_offset & HAMMER_OFF_ZONE_MASK) == HAMMER_ZONE_BTREE);
1168
1169         /*
1170          * Locate the structure, allocating one if necessary.
1171          */
1172 again:
1173         node = RB_LOOKUP(hammer_nod_rb_tree, &hmp->rb_nods_root, node_offset);
1174         if (node == NULL) {
1175                 ++hammer_count_nodes;
1176                 node = kmalloc(sizeof(*node), hmp->m_misc, M_WAITOK|M_ZERO|M_USE_RESERVE);
1177                 node->node_offset = node_offset;
1178                 node->hmp = hmp;
1179                 TAILQ_INIT(&node->cursor_list);
1180                 TAILQ_INIT(&node->cache_list);
1181                 if (RB_INSERT(hammer_nod_rb_tree, &hmp->rb_nods_root, node)) {
1182                         --hammer_count_nodes;
1183                         kfree(node, hmp->m_misc);
1184                         goto again;
1185                 }
1186                 doload = hammer_ref_interlock_true(&node->lock);
1187         } else {
1188                 doload = hammer_ref_interlock(&node->lock);
1189         }
1190         if (doload) {
1191                 *errorp = hammer_load_node(trans, node, isnew);
1192                 trans->flags |= HAMMER_TRANSF_DIDIO;
1193                 if (*errorp)
1194                         node = NULL;
1195         } else {
1196                 KKASSERT(node->ondisk);
1197                 *errorp = 0;
1198                 hammer_io_advance(&node->buffer->io);
1199         }
1200         return(node);
1201 }
1202
1203 /*
1204  * Reference an already-referenced node.  0->1 transitions should assert
1205  * so we do not have to deal with hammer_ref() setting CHECK.
1206  */
1207 void
1208 hammer_ref_node(hammer_node_t node)
1209 {
1210         KKASSERT(hammer_isactive(&node->lock) && node->ondisk != NULL);
1211         hammer_ref(&node->lock);
1212 }
1213
1214 /*
1215  * Load a node's on-disk data reference.  Called with the node referenced
1216  * and interlocked.
1217  *
1218  * On return the node interlock will be unlocked.  If a non-zero error code
1219  * is returned the node will also be dereferenced (and the caller's pointer
1220  * will be stale).
1221  */
1222 static int
1223 hammer_load_node(hammer_transaction_t trans, hammer_node_t node, int isnew)
1224 {
1225         hammer_buffer_t buffer;
1226         hammer_off_t buf_offset;
1227         int error;
1228
1229         error = 0;
1230         if (node->ondisk == NULL) {
1231                 /*
1232                  * This is a little confusing but the jist is that
1233                  * node->buffer determines whether the node is on
1234                  * the buffer's clist and node->ondisk determines
1235                  * whether the buffer is referenced.
1236                  *
1237                  * We could be racing a buffer release, in which case
1238                  * node->buffer may become NULL while we are blocked
1239                  * referencing the buffer.
1240                  */
1241                 if ((buffer = node->buffer) != NULL) {
1242                         error = hammer_ref_buffer(buffer);
1243                         if (error == 0 && node->buffer == NULL) {
1244                                 TAILQ_INSERT_TAIL(&buffer->clist,
1245                                                   node, entry);
1246                                 node->buffer = buffer;
1247                         }
1248                 } else {
1249                         buf_offset = node->node_offset & ~HAMMER_BUFMASK64;
1250                         buffer = hammer_get_buffer(node->hmp, buf_offset,
1251                                                    HAMMER_BUFSIZE, 0, &error);
1252                         if (buffer) {
1253                                 KKASSERT(error == 0);
1254                                 TAILQ_INSERT_TAIL(&buffer->clist,
1255                                                   node, entry);
1256                                 node->buffer = buffer;
1257                         }
1258                 }
1259                 if (error)
1260                         goto failed;
1261                 node->ondisk = (void *)((char *)buffer->ondisk +
1262                                         (node->node_offset & HAMMER_BUFMASK));
1263
1264                 /*
1265                  * Check CRC.  NOTE: Neither flag is set and the CRC is not
1266                  * generated on new B-Tree nodes.
1267                  */
1268                 if (isnew == 0 &&
1269                     (node->flags & HAMMER_NODE_CRCANY) == 0) {
1270                         if (hammer_crc_test_btree(node->ondisk) == 0) {
1271                                 if (hammer_debug_critical)
1272                                         Debugger("CRC FAILED: B-TREE NODE");
1273                                 node->flags |= HAMMER_NODE_CRCBAD;
1274                         } else {
1275                                 node->flags |= HAMMER_NODE_CRCGOOD;
1276                         }
1277                 }
1278         }
1279         if (node->flags & HAMMER_NODE_CRCBAD) {
1280                 if (trans->flags & HAMMER_TRANSF_CRCDOM)
1281                         error = EDOM;
1282                 else
1283                         error = EIO;
1284         }
1285 failed:
1286         if (error) {
1287                 _hammer_rel_node(node, 1);
1288         } else {
1289                 hammer_ref_interlock_done(&node->lock);
1290         }
1291         return (error);
1292 }
1293
1294 /*
1295  * Safely reference a node, interlock against flushes via the IO subsystem.
1296  */
1297 hammer_node_t
1298 hammer_ref_node_safe(hammer_transaction_t trans, hammer_node_cache_t cache,
1299                      int *errorp)
1300 {
1301         hammer_node_t node;
1302         int doload;
1303
1304         node = cache->node;
1305         if (node != NULL) {
1306                 doload = hammer_ref_interlock(&node->lock);
1307                 if (doload) {
1308                         *errorp = hammer_load_node(trans, node, 0);
1309                         if (*errorp)
1310                                 node = NULL;
1311                 } else {
1312                         KKASSERT(node->ondisk);
1313                         if (node->flags & HAMMER_NODE_CRCBAD) {
1314                                 if (trans->flags & HAMMER_TRANSF_CRCDOM)
1315                                         *errorp = EDOM;
1316                                 else
1317                                         *errorp = EIO;
1318                                 _hammer_rel_node(node, 0);
1319                                 node = NULL;
1320                         } else {
1321                                 *errorp = 0;
1322                         }
1323                 }
1324         } else {
1325                 *errorp = ENOENT;
1326         }
1327         return(node);
1328 }
1329
1330 /*
1331  * Release a hammer_node.  On the last release the node dereferences
1332  * its underlying buffer and may or may not be destroyed.
1333  *
1334  * If locked is non-zero the passed node has been interlocked by the
1335  * caller and we are in the failure/unload path, otherwise it has not and
1336  * we are doing a normal release.
1337  *
1338  * This function will dispose of the interlock and the reference.
1339  * On return the node pointer is stale.
1340  */
1341 void
1342 _hammer_rel_node(hammer_node_t node, int locked)
1343 {
1344         hammer_buffer_t buffer;
1345
1346         /*
1347          * Deref the node.  If this isn't the 1->0 transition we're basically
1348          * done.  If locked is non-zero this function will just deref the
1349          * locked node and return TRUE, otherwise it will deref the locked
1350          * node and either lock and return TRUE on the 1->0 transition or
1351          * not lock and return FALSE.
1352          */
1353         if (hammer_rel_interlock(&node->lock, locked) == 0)
1354                 return;
1355
1356         /*
1357          * Either locked was non-zero and we are interlocked, or the
1358          * hammer_rel_interlock() call returned non-zero and we are
1359          * interlocked.
1360          *
1361          * The ref-count must still be decremented if locked != 0 so
1362          * the cleanup required still varies a bit.
1363          *
1364          * hammer_flush_node() when called with 1 or 2 will dispose of
1365          * the lock and possible ref-count.
1366          */
1367         if (node->ondisk == NULL) {
1368                 hammer_flush_node(node, locked + 1);
1369                 /* node is stale now */
1370                 return;
1371         }
1372
1373         /*
1374          * Do not disassociate the node from the buffer if it represents
1375          * a modified B-Tree node that still needs its crc to be generated.
1376          */
1377         if (node->flags & HAMMER_NODE_NEEDSCRC) {
1378                 hammer_rel_interlock_done(&node->lock, locked);
1379                 return;
1380         }
1381
1382         /*
1383          * Do final cleanups and then either destroy the node and leave it
1384          * passively cached.  The buffer reference is removed regardless.
1385          */
1386         buffer = node->buffer;
1387         node->ondisk = NULL;
1388
1389         if ((node->flags & HAMMER_NODE_FLUSH) == 0) {
1390                 /*
1391                  * Normal release.
1392                  */
1393                 hammer_rel_interlock_done(&node->lock, locked);
1394         } else {
1395                 /*
1396                  * Destroy the node.
1397                  */
1398                 hammer_flush_node(node, locked + 1);
1399                 /* node is stale */
1400
1401         }
1402         hammer_rel_buffer(buffer, 0);
1403 }
1404
1405 void
1406 hammer_rel_node(hammer_node_t node)
1407 {
1408         _hammer_rel_node(node, 0);
1409 }
1410
1411 /*
1412  * Free space on-media associated with a B-Tree node.
1413  */
1414 void
1415 hammer_delete_node(hammer_transaction_t trans, hammer_node_t node)
1416 {
1417         KKASSERT((node->flags & HAMMER_NODE_DELETED) == 0);
1418         node->flags |= HAMMER_NODE_DELETED;
1419         hammer_blockmap_free(trans, node->node_offset, sizeof(*node->ondisk));
1420 }
1421
1422 /*
1423  * Passively cache a referenced hammer_node.  The caller may release
1424  * the node on return.
1425  */
1426 void
1427 hammer_cache_node(hammer_node_cache_t cache, hammer_node_t node)
1428 {
1429         /*
1430          * If the node doesn't exist, or is being deleted, don't cache it!
1431          *
1432          * The node can only ever be NULL in the I/O failure path.
1433          */
1434         if (node == NULL || (node->flags & HAMMER_NODE_DELETED))
1435                 return;
1436         if (cache->node == node)
1437                 return;
1438         while (cache->node)
1439                 hammer_uncache_node(cache);
1440         if (node->flags & HAMMER_NODE_DELETED)
1441                 return;
1442         cache->node = node;
1443         TAILQ_INSERT_TAIL(&node->cache_list, cache, entry);
1444 }
1445
1446 void
1447 hammer_uncache_node(hammer_node_cache_t cache)
1448 {
1449         hammer_node_t node;
1450
1451         if ((node = cache->node) != NULL) {
1452                 TAILQ_REMOVE(&node->cache_list, cache, entry);
1453                 cache->node = NULL;
1454                 if (TAILQ_EMPTY(&node->cache_list))
1455                         hammer_flush_node(node, 0);
1456         }
1457 }
1458
1459 /*
1460  * Remove a node's cache references and destroy the node if it has no
1461  * other references or backing store.
1462  *
1463  * locked == 0  Normal unlocked operation
1464  * locked == 1  Call hammer_rel_interlock_done(..., 0);
1465  * locked == 2  Call hammer_rel_interlock_done(..., 1);
1466  *
1467  * XXX for now this isn't even close to being MPSAFE so the refs check
1468  *     is sufficient.
1469  */
1470 void
1471 hammer_flush_node(hammer_node_t node, int locked)
1472 {
1473         hammer_node_cache_t cache;
1474         hammer_buffer_t buffer;
1475         hammer_mount_t hmp = node->hmp;
1476         int dofree;
1477
1478         while ((cache = TAILQ_FIRST(&node->cache_list)) != NULL) {
1479                 TAILQ_REMOVE(&node->cache_list, cache, entry);
1480                 cache->node = NULL;
1481         }
1482
1483         /*
1484          * NOTE: refs is predisposed if another thread is blocking and
1485          *       will be larger than 0 in that case.  We aren't MPSAFE
1486          *       here.
1487          */
1488         if (node->ondisk == NULL && hammer_norefs(&node->lock)) {
1489                 KKASSERT((node->flags & HAMMER_NODE_NEEDSCRC) == 0);
1490                 RB_REMOVE(hammer_nod_rb_tree, &node->hmp->rb_nods_root, node);
1491                 if ((buffer = node->buffer) != NULL) {
1492                         node->buffer = NULL;
1493                         TAILQ_REMOVE(&buffer->clist, node, entry);
1494                         /* buffer is unreferenced because ondisk is NULL */
1495                 }
1496                 dofree = 1;
1497         } else {
1498                 dofree = 0;
1499         }
1500
1501         /*
1502          * Deal with the interlock if locked == 1 or locked == 2.
1503          */
1504         if (locked)
1505                 hammer_rel_interlock_done(&node->lock, locked - 1);
1506
1507         /*
1508          * Destroy if requested
1509          */
1510         if (dofree) {
1511                 --hammer_count_nodes;
1512                 kfree(node, hmp->m_misc);
1513         }
1514 }
1515
1516 /*
1517  * Flush passively cached B-Tree nodes associated with this buffer.
1518  * This is only called when the buffer is about to be destroyed, so
1519  * none of the nodes should have any references.  The buffer is locked.
1520  *
1521  * We may be interlocked with the buffer.
1522  */
1523 void
1524 hammer_flush_buffer_nodes(hammer_buffer_t buffer)
1525 {
1526         hammer_node_t node;
1527
1528         while ((node = TAILQ_FIRST(&buffer->clist)) != NULL) {
1529                 KKASSERT(node->ondisk == NULL);
1530                 KKASSERT((node->flags & HAMMER_NODE_NEEDSCRC) == 0);
1531
1532                 if (hammer_try_interlock_norefs(&node->lock)) {
1533                         hammer_ref(&node->lock);
1534                         node->flags |= HAMMER_NODE_FLUSH;
1535                         _hammer_rel_node(node, 1);
1536                 } else {
1537                         KKASSERT(node->buffer != NULL);
1538                         buffer = node->buffer;
1539                         node->buffer = NULL;
1540                         TAILQ_REMOVE(&buffer->clist, node, entry);
1541                         /* buffer is unreferenced because ondisk is NULL */
1542                 }
1543         }
1544 }
1545
1546
1547 /************************************************************************
1548  *                              ALLOCATORS                              *
1549  ************************************************************************/
1550
1551 /*
1552  * Allocate a B-Tree node.
1553  */
1554 hammer_node_t
1555 hammer_alloc_btree(hammer_transaction_t trans, hammer_off_t hint, int *errorp)
1556 {
1557         hammer_buffer_t buffer = NULL;
1558         hammer_node_t node = NULL;
1559         hammer_off_t node_offset;
1560
1561         node_offset = hammer_blockmap_alloc(trans, HAMMER_ZONE_BTREE_INDEX,
1562                                             sizeof(struct hammer_node_ondisk),
1563                                             hint, errorp);
1564         if (*errorp == 0) {
1565                 node = hammer_get_node(trans, node_offset, 1, errorp);
1566                 hammer_modify_node_noundo(trans, node);
1567                 bzero(node->ondisk, sizeof(*node->ondisk));
1568                 hammer_modify_node_done(node);
1569         }
1570         if (buffer)
1571                 hammer_rel_buffer(buffer, 0);
1572         return(node);
1573 }
1574
1575 /*
1576  * Allocate data.  If the address of a data buffer is supplied then
1577  * any prior non-NULL *data_bufferp will be released and *data_bufferp
1578  * will be set to the related buffer.  The caller must release it when
1579  * finally done.  The initial *data_bufferp should be set to NULL by
1580  * the caller.
1581  *
1582  * The caller is responsible for making hammer_modify*() calls on the
1583  * *data_bufferp.
1584  */
1585 void *
1586 hammer_alloc_data(hammer_transaction_t trans, int32_t data_len,
1587                   u_int16_t rec_type, hammer_off_t *data_offsetp,
1588                   struct hammer_buffer **data_bufferp,
1589                   hammer_off_t hint, int *errorp)
1590 {
1591         void *data;
1592         int zone;
1593
1594         /*
1595          * Allocate data
1596          */
1597         if (data_len) {
1598                 switch(rec_type) {
1599                 case HAMMER_RECTYPE_INODE:
1600                 case HAMMER_RECTYPE_DIRENTRY:
1601                 case HAMMER_RECTYPE_EXT:
1602                 case HAMMER_RECTYPE_FIX:
1603                 case HAMMER_RECTYPE_PFS:
1604                 case HAMMER_RECTYPE_SNAPSHOT:
1605                 case HAMMER_RECTYPE_CONFIG:
1606                         zone = HAMMER_ZONE_META_INDEX;
1607                         break;
1608                 case HAMMER_RECTYPE_DATA:
1609                 case HAMMER_RECTYPE_DB:
1610                         if (data_len <= HAMMER_BUFSIZE / 2) {
1611                                 zone = HAMMER_ZONE_SMALL_DATA_INDEX;
1612                         } else {
1613                                 data_len = (data_len + HAMMER_BUFMASK) &
1614                                            ~HAMMER_BUFMASK;
1615                                 zone = HAMMER_ZONE_LARGE_DATA_INDEX;
1616                         }
1617                         break;
1618                 default:
1619                         panic("hammer_alloc_data: rec_type %04x unknown",
1620                               rec_type);
1621                         zone = 0;       /* NOT REACHED */
1622                         break;
1623                 }
1624                 *data_offsetp = hammer_blockmap_alloc(trans, zone, data_len,
1625                                                       hint, errorp);
1626         } else {
1627                 *data_offsetp = 0;
1628         }
1629         if (*errorp == 0 && data_bufferp) {
1630                 if (data_len) {
1631                         data = hammer_bread_ext(trans->hmp, *data_offsetp,
1632                                                 data_len, errorp, data_bufferp);
1633                 } else {
1634                         data = NULL;
1635                 }
1636         } else {
1637                 data = NULL;
1638         }
1639         return(data);
1640 }
1641
1642 /*
1643  * Sync dirty buffers to the media and clean-up any loose ends.
1644  *
1645  * These functions do not start the flusher going, they simply
1646  * queue everything up to the flusher.
1647  */
1648 static int hammer_sync_scan1(struct mount *mp, struct vnode *vp, void *data);
1649 static int hammer_sync_scan2(struct mount *mp, struct vnode *vp, void *data);
1650
1651 int
1652 hammer_queue_inodes_flusher(hammer_mount_t hmp, int waitfor)
1653 {
1654         struct hammer_sync_info info;
1655
1656         info.error = 0;
1657         info.waitfor = waitfor;
1658         if (waitfor == MNT_WAIT) {
1659                 vmntvnodescan(hmp->mp, VMSC_GETVP|VMSC_ONEPASS,
1660                               hammer_sync_scan1, hammer_sync_scan2, &info);
1661         } else {
1662                 vmntvnodescan(hmp->mp, VMSC_GETVP|VMSC_ONEPASS|VMSC_NOWAIT,
1663                               hammer_sync_scan1, hammer_sync_scan2, &info);
1664         }
1665         return(info.error);
1666 }
1667
1668 /*
1669  * Filesystem sync.  If doing a synchronous sync make a second pass on
1670  * the vnodes in case any were already flushing during the first pass,
1671  * and activate the flusher twice (the second time brings the UNDO FIFO's
1672  * start position up to the end position after the first call).
1673  */
1674 int
1675 hammer_sync_hmp(hammer_mount_t hmp, int waitfor)
1676 {
1677         struct hammer_sync_info info;
1678
1679         info.error = 0;
1680         info.waitfor = MNT_NOWAIT;
1681         vmntvnodescan(hmp->mp, VMSC_GETVP|VMSC_NOWAIT,
1682                       hammer_sync_scan1, hammer_sync_scan2, &info);
1683         if (info.error == 0 && waitfor == MNT_WAIT) {
1684                 info.waitfor = waitfor;
1685                 vmntvnodescan(hmp->mp, VMSC_GETVP,
1686                               hammer_sync_scan1, hammer_sync_scan2, &info);
1687         }
1688         if (waitfor == MNT_WAIT) {
1689                 hammer_flusher_sync(hmp);
1690                 hammer_flusher_sync(hmp);
1691         } else {
1692                 hammer_flusher_async(hmp, NULL);
1693                 hammer_flusher_async(hmp, NULL);
1694         }
1695         return(info.error);
1696 }
1697
1698 static int
1699 hammer_sync_scan1(struct mount *mp, struct vnode *vp, void *data)
1700 {
1701         struct hammer_inode *ip;
1702
1703         ip = VTOI(vp);
1704         if (vp->v_type == VNON || ip == NULL ||
1705             ((ip->flags & HAMMER_INODE_MODMASK) == 0 &&
1706              RB_EMPTY(&vp->v_rbdirty_tree))) {
1707                 return(-1);
1708         }
1709         return(0);
1710 }
1711
1712 static int
1713 hammer_sync_scan2(struct mount *mp, struct vnode *vp, void *data)
1714 {
1715         struct hammer_sync_info *info = data;
1716         struct hammer_inode *ip;
1717         int error;
1718
1719         ip = VTOI(vp);
1720         if (vp->v_type == VNON || vp->v_type == VBAD ||
1721             ((ip->flags & HAMMER_INODE_MODMASK) == 0 &&
1722              RB_EMPTY(&vp->v_rbdirty_tree))) {
1723                 return(0);
1724         }
1725         error = VOP_FSYNC(vp, MNT_NOWAIT, 0);
1726         if (error)
1727                 info->error = error;
1728         return(0);
1729 }
1730