sys/vfs/hammer2/hammer2.h

   1 /*
   2  * Copyright (c) 2011-2018 The DragonFly Project.  All rights reserved.
   3  *
   4  * This code is derived from software contributed to The DragonFly Project
   5  * by Matthew Dillon <dillon@dragonflybsd.org>
   6  * by Venkatesh Srinivas <vsrinivas@dragonflybsd.org>
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  *
  12  * 1. Redistributions of source code must retain the above copyright
  13  *    notice, this list of conditions and the following disclaimer.
  14  * 2. Redistributions in binary form must reproduce the above copyright
  15  *    notice, this list of conditions and the following disclaimer in
  16  *    the documentation and/or other materials provided with the
  17  *    distribution.
  18  * 3. Neither the name of The DragonFly Project nor the names of its
  19  *    contributors may be used to endorse or promote products derived
  20  *    from this software without specific, prior written permission.
  21  *
  22  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  23  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  24  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  25  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
  26  * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  27  * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
  28  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  29  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
  30  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  31  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  32  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  33  * SUCH DAMAGE.
  34  */
  35
  36 /*
  37  * HAMMER2 IN-MEMORY CACHE OF MEDIA STRUCTURES
  38  *
  39  * This header file contains structures used internally by the HAMMER2
  40  * implementation.  See hammer2_disk.h for on-disk structures.
  41  *
  42  * There is an in-memory representation of all on-media data structure.
  43  * Almost everything is represented by a hammer2_chain structure in-memory.
  44  * Other higher-level structures typically map to chains.
  45  *
  46  * A great deal of data is accessed simply via its buffer cache buffer,
  47  * which is mapped for the duration of the chain's lock.  Hammer2 must
  48  * implement its own buffer cache layer on top of the system layer to
  49  * allow for different threads to lock different sub-block-sized buffers.
  50  *
  51  * When modifications are made to a chain a new filesystem block must be
  52  * allocated.  Multiple modifications do not typically allocate new blocks
  53  * until the current block has been flushed.  Flushes do not block the
  54  * front-end unless the front-end operation crosses the current inode being
  55  * flushed.
  56  *
  57  * The in-memory representation may remain cached (for example in order to
  58  * placemark clustering locks) even after the related data has been
  59  * detached.
  60  */
  61
  62 #ifndef _VFS_HAMMER2_HAMMER2_H_
  63 #define _VFS_HAMMER2_HAMMER2_H_
  64
  65 #ifdef _KERNEL
  66 #include <sys/param.h>
  67 #endif
  68 #include <sys/types.h>
  69 #ifdef _KERNEL
  70 #include <sys/kernel.h>
  71 #endif
  72 #include <sys/conf.h>
  73 #ifdef _KERNEL
  74 #include <sys/systm.h>
  75 #endif
  76 #include <sys/tree.h>
  77 #include <sys/malloc.h>
  78 #include <sys/mount.h>
  79 #include <sys/vnode.h>
  80 #include <sys/proc.h>
  81 #include <sys/mountctl.h>
  82 #include <sys/priv.h>
  83 #include <sys/stat.h>
  84 #include <sys/thread.h>
  85 #include <sys/globaldata.h>
  86 #include <sys/lockf.h>
  87 #include <sys/buf.h>
  88 #include <sys/queue.h>
  89 #include <sys/limits.h>
  90 #include <sys/dmsg.h>
  91 #include <sys/mutex.h>
  92 #ifdef _KERNEL
  93 #include <sys/kern_syscall.h>
  94 #endif
  95
  96 #ifdef _KERNEL
  97 #include <sys/signal2.h>
  98 #include <sys/buf2.h>
  99 #include <sys/mutex2.h>
 100 #include <sys/thread2.h>
 101 #endif
 102
 103 #include "hammer2_xxhash.h"
 104 #include "hammer2_disk.h"
 105 #include "hammer2_mount.h"
 106 #include "hammer2_ioctl.h"
 107
 108 struct hammer2_io;
 109 struct hammer2_chain;
 110 struct hammer2_cluster;
 111 struct hammer2_inode;
 112 struct hammer2_depend;
 113 struct hammer2_dev;
 114 struct hammer2_pfs;
 115 struct hammer2_span;
 116 struct hammer2_msg;
 117 struct hammer2_thread;
 118 union hammer2_xop;
 119
 120 /*
 121  * Mutex and lock shims.  Hammer2 requires support for asynchronous and
 122  * abortable locks, and both exclusive and shared spinlocks.  Normal
 123  * synchronous non-abortable locks can be substituted for spinlocks.
 124  */
 125 typedef mtx_t                           hammer2_mtx_t;
 126 typedef mtx_link_t                      hammer2_mtx_link_t;
 127 typedef mtx_state_t                     hammer2_mtx_state_t;
 128
 129 typedef struct spinlock                 hammer2_spin_t;
 130
 131 #define hammer2_mtx_ex                  mtx_lock_ex_quick
 132 #define hammer2_mtx_ex_try              mtx_lock_ex_try
 133 #define hammer2_mtx_sh                  mtx_lock_sh_quick
 134 #define hammer2_mtx_sh_again            mtx_lock_sh_again
 135 #define hammer2_mtx_sh_try              mtx_lock_sh_try
 136 #define hammer2_mtx_unlock              mtx_unlock
 137 #define hammer2_mtx_downgrade           mtx_downgrade
 138 #define hammer2_mtx_owned               mtx_owned
 139 #define hammer2_mtx_init                mtx_init
 140 #define hammer2_mtx_temp_release        mtx_lock_temp_release
 141 #define hammer2_mtx_temp_restore        mtx_lock_temp_restore
 142 #define hammer2_mtx_refs                mtx_lockrefs
 143
 144 #define hammer2_spin_init               spin_init
 145 #define hammer2_spin_sh                 spin_lock_shared
 146 #define hammer2_spin_ex                 spin_lock
 147 #define hammer2_spin_unsh               spin_unlock_shared
 148 #define hammer2_spin_unex               spin_unlock
 149
 150 TAILQ_HEAD(hammer2_xop_list, hammer2_xop_head);
 151 TAILQ_HEAD(hammer2_chain_list, hammer2_chain);
 152
 153 typedef struct hammer2_xop_list hammer2_xop_list_t;
 154
 155 #ifdef _KERNEL
 156 /*
 157  * General lock support
 158  */
 159 static __inline
 160 int
 161 hammer2_mtx_upgrade_try(hammer2_mtx_t *mtx)
 162 {
 163         return mtx_upgrade_try(mtx);
 164 }
 165
 166 #endif
 167
 168 /*
 169  * The xid tracks internal transactional updates.
 170  *
 171  * XXX fix-me, really needs to be 64-bits
 172  */
 173 typedef uint32_t hammer2_xid_t;
 174
 175 #define HAMMER2_XID_MIN                 0x00000000U
 176 #define HAMMER2_XID_MAX                 0x7FFFFFFFU
 177
 178 #define HAMMER2_LIMIT_DIRTY_CHAINS      (65536)
 179 #define HAMMER2_LIMIT_DIRTY_INODES      (16384)
 180
 181 /*
 182  * The chain structure tracks a portion of the media topology from the
 183  * root (volume) down.  Chains represent volumes, inodes, indirect blocks,
 184  * data blocks, and freemap nodes and leafs.
 185  *
 186  * The chain structure utilizes a simple singly-homed topology and the
 187  * chain's in-memory topology will move around as the chains do, due mainly
 188  * to renames and indirect block creation.
 189  *
 190  * Block Table Updates
 191  *
 192  *      Block table updates for insertions and updates are delayed until the
 193  *      flush.  This allows us to avoid having to modify the parent chain
 194  *      all the way to the root.
 195  *
 196  *      Block table deletions are performed immediately (modifying the parent
 197  *      in the process) because the flush code uses the chain structure to
 198  *      track delayed updates and the chain will be (likely) gone or moved to
 199  *      another location in the topology after a deletion.
 200  *
 201  *      A prior iteration of the code tried to keep the relationship intact
 202  *      on deletes by doing a delete-duplicate operation on the chain, but
 203  *      it added way too much complexity to the codebase.
 204  *
 205  * Flush Synchronization
 206  *
 207  *      The flush code must flush modified chains bottom-up.  Because chain
 208  *      structures can shift around and are NOT topologically stable,
 209  *      modified chains are independently indexed for the flush.  As the flush
 210  *      runs it modifies (or further modifies) and updates the parents,
 211  *      propagating the flush all the way to the volume root.
 212  *
 213  *      Modifying front-end operations can occur during a flush but will block
 214  *      in two cases: (1) when the front-end tries to operate on the inode
 215  *      currently in the midst of being flushed and (2) if the front-end
 216  *      crosses an inode currently being flushed (such as during a rename).
 217  *      So, for example, if you rename directory "x" to "a/b/c/d/e/f/g/x" and
 218  *      the flusher is currently working on "a/b/c", the rename will block
 219  *      temporarily in order to ensure that "x" exists in one place or the
 220  *      other.
 221  *
 222  *      Meta-data statistics are updated by the flusher.  The front-end will
 223  *      make estimates but meta-data must be fully synchronized only during a
 224  *      flush in order to ensure that it remains correct across a crash.
 225  *
 226  *      Multiple flush synchronizations can theoretically be in-flight at the
 227  *      same time but the implementation is not coded to handle the case and
 228  *      currently serializes them.
 229  *
 230  * Snapshots:
 231  *
 232  *      Snapshots currently require the subdirectory tree being snapshotted
 233  *      to be flushed.  The snapshot then creates a new super-root inode which
 234  *      copies the flushed blockdata of the directory or file that was
 235  *      snapshotted.
 236  *
 237  * RBTREE NOTES:
 238  *
 239  *      - Note that the radix tree runs in powers of 2 only so sub-trees
 240  *        cannot straddle edges.
 241  */
 242 RB_HEAD(hammer2_chain_tree, hammer2_chain);
 243 TAILQ_HEAD(h2_flush_list, hammer2_chain);
 244 TAILQ_HEAD(h2_core_list, hammer2_chain);
 245
 246 #define CHAIN_CORE_DELETE_BMAP_ENTRIES  \
 247         (HAMMER2_PBUFSIZE / sizeof(hammer2_blockref_t) / sizeof(uint32_t))
 248
 249 struct hammer2_reptrack {
 250         hammer2_spin_t  spin;
 251         struct hammer2_reptrack *next;
 252         struct hammer2_chain    *chain;
 253 };
 254
 255 /*
 256  * Core topology for chain (embedded in chain).  Protected by a spinlock.
 257  */
 258 struct hammer2_chain_core {
 259         hammer2_spin_t  spin;
 260         struct hammer2_reptrack *reptrack;
 261         struct hammer2_chain_tree rbtree; /* sub-chains */
 262         int             live_zero;      /* blockref array opt */
 263         u_int           live_count;     /* live (not deleted) chains in tree */
 264         u_int           chain_count;    /* live + deleted chains under core */
 265         int             generation;     /* generation number (inserts only) */
 266 };
 267
 268 typedef struct hammer2_chain_core hammer2_chain_core_t;
 269
 270 RB_HEAD(hammer2_io_tree, hammer2_io);
 271
 272 /*
 273  * DIO - Management structure wrapping system buffer cache.
 274  *
 275  * HAMMER2 uses an I/O abstraction that allows it to cache and manipulate
 276  * fixed-sized filesystem buffers frontend by variable-sized hammer2_chain
 277  * structures.
 278  */
 279 struct hammer2_io {
 280         RB_ENTRY(hammer2_io) rbnode;    /* indexed by device offset */
 281         struct hammer2_dev *hmp;
 282         struct buf      *bp;
 283         off_t           pbase;
 284         uint64_t        refs;
 285         int             psize;
 286         int             act;            /* activity */
 287         int             btype;          /* approximate BREF_TYPE_* */
 288         int             ticks;
 289         int             error;
 290         int             unused01;
 291         uint64_t        dedup_valid;    /* valid for dedup operation */
 292         uint64_t        dedup_alloc;    /* allocated / de-dupable */
 293 };
 294
 295 typedef struct hammer2_io hammer2_io_t;
 296
 297 #define HAMMER2_DIO_INPROG      0x8000000000000000LLU   /* bio in progress */
 298 #define HAMMER2_DIO_GOOD        0x4000000000000000LLU   /* dio->bp is stable */
 299 #define HAMMER2_DIO_WAITING     0x2000000000000000LLU   /* wait on INPROG */
 300 #define HAMMER2_DIO_DIRTY       0x1000000000000000LLU   /* flush last drop */
 301
 302 #define HAMMER2_DIO_MASK        0x00FFFFFFFFFFFFFFLLU
 303
 304 /*
 305  * Primary chain structure keeps track of the topology in-memory.
 306  */
 307 struct hammer2_chain {
 308         hammer2_mtx_t           lock;
 309         hammer2_chain_core_t    core;
 310         RB_ENTRY(hammer2_chain) rbnode;         /* live chain(s) */
 311         hammer2_blockref_t      bref;
 312         struct hammer2_chain    *parent;
 313         struct hammer2_dev      *hmp;
 314         struct hammer2_pfs      *pmp;           /* A PFS or super-root (spmp) */
 315
 316         struct lock     diolk;                  /* xop focus interlock */
 317         hammer2_io_t    *dio;                   /* physical data buffer */
 318         hammer2_media_data_t *data;             /* data pointer shortcut */
 319         u_int           bytes;                  /* physical data size */
 320         u_int           flags;
 321         u_int           refs;
 322         u_int           lockcnt;
 323         int             error;                  /* on-lock data error state */
 324         int             cache_index;            /* heur speeds up lookup */
 325
 326         TAILQ_ENTRY(hammer2_chain) flush_node;  /* flush list */
 327         TAILQ_ENTRY(hammer2_chain) lru_node;    /* 0-refs LRU */
 328 };
 329
 330 typedef struct hammer2_chain hammer2_chain_t;
 331
 332 int hammer2_chain_cmp(hammer2_chain_t *chain1, hammer2_chain_t *chain2);
 333 RB_PROTOTYPE(hammer2_chain_tree, hammer2_chain, rbnode, hammer2_chain_cmp);
 334
 335 /*
 336  * Special notes on flags:
 337  *
 338  * INITIAL      - This flag allows a chain to be created and for storage to
 339  *                be allocated without having to immediately instantiate the
 340  *                related buffer.  The data is assumed to be all-zeros.  It
 341  *                is primarily used for indirect blocks.
 342  *
 343  * MODIFIED     - The chain's media data has been modified.  Prevents chain
 344  *                free on lastdrop if still in the topology.
 345  *
 346  * UPDATE       - Chain might not be modified but parent blocktable needs
 347  *                an update.  Prevents chain free on lastdrop if still in
 348  *                the topology.
 349  *
 350  * FICTITIOUS   - Faked chain as a placeholder for an error condition.  This
 351  *                chain is unsuitable for I/O.
 352  *
 353  * BMAPPED      - Indicates that the chain is present in the parent blockmap.
 354  *
 355  * BMAPUPD      - Indicates that the chain is present but needs to be updated
 356  *                in the parent blockmap.
 357  */
 358 #define HAMMER2_CHAIN_MODIFIED          0x00000001      /* dirty chain data */
 359 #define HAMMER2_CHAIN_ALLOCATED         0x00000002      /* kmalloc'd chain */
 360 #define HAMMER2_CHAIN_DESTROY           0x00000004
 361 #define HAMMER2_CHAIN_DEDUPABLE         0x00000008      /* registered w/dedup */
 362 #define HAMMER2_CHAIN_DELETED           0x00000010      /* deleted chain */
 363 #define HAMMER2_CHAIN_INITIAL           0x00000020      /* initial create */
 364 #define HAMMER2_CHAIN_UPDATE            0x00000040      /* need parent update */
 365 #define HAMMER2_CHAIN_UNUSED0080        0x00000080
 366 #define HAMMER2_CHAIN_TESTEDGOOD        0x00000100      /* crc tested good */
 367 #define HAMMER2_CHAIN_ONFLUSH           0x00000200      /* on a flush list */
 368 #define HAMMER2_CHAIN_FICTITIOUS        0x00000400      /* unsuitable for I/O */
 369 #define HAMMER2_CHAIN_VOLUMESYNC        0x00000800      /* needs volume sync */
 370 #define HAMMER2_CHAIN_UNUSED1000        0x00001000
 371 #define HAMMER2_CHAIN_COUNTEDBREFS      0x00002000      /* block table stats */
 372 #define HAMMER2_CHAIN_ONRBTREE          0x00004000      /* on parent RB tree */
 373 #define HAMMER2_CHAIN_ONLRU             0x00008000      /* on LRU list */
 374 #define HAMMER2_CHAIN_EMBEDDED          0x00010000      /* embedded data */
 375 #define HAMMER2_CHAIN_RELEASE           0x00020000      /* don't keep around */
 376 #define HAMMER2_CHAIN_BMAPPED           0x00040000      /* present in blkmap */
 377 #define HAMMER2_CHAIN_BMAPUPD           0x00080000      /* +needs updating */
 378 #define HAMMER2_CHAIN_IOINPROG          0x00100000      /* I/O interlock */
 379 #define HAMMER2_CHAIN_IOSIGNAL          0x00200000      /* I/O interlock */
 380 #define HAMMER2_CHAIN_PFSBOUNDARY       0x00400000      /* super->pfs inode */
 381 #define HAMMER2_CHAIN_HINT_LEAF_COUNT   0x00800000      /* redo leaf count */
 382 #define HAMMER2_CHAIN_LRUHINT           0x01000000      /* was reused */
 383
 384 #define HAMMER2_CHAIN_FLUSH_MASK        (HAMMER2_CHAIN_MODIFIED |       \
 385                                          HAMMER2_CHAIN_UPDATE |         \
 386                                          HAMMER2_CHAIN_ONFLUSH |        \
 387                                          HAMMER2_CHAIN_DESTROY)
 388
 389 /*
 390  * Hammer2 error codes, used by chain->error and cluster->error.  The error
 391  * code is typically set on-lock unless no I/O was requested, and set on
 392  * I/O otherwise.  If set for a cluster it generally means that the cluster
 393  * code could not find a valid copy to present.
 394  *
 395  * All H2 error codes are flags and can be accumulated by ORing them
 396  * together.
 397  *
 398  * IO           - An I/O error occurred
 399  * CHECK        - I/O succeeded but did not match the check code
 400  * INCOMPLETE   - A cluster is not complete enough to use, or
 401  *                a chain cannot be loaded because its parent has an error.
 402  *
 403  * NOTE: API allows callers to check zero/non-zero to determine if an error
 404  *       condition exists.
 405  *
 406  * NOTE: Chain's data field is usually NULL on an IO error but not necessarily
 407  *       NULL on other errors.  Check chain->error, not chain->data.
 408  */
 409 #define HAMMER2_ERROR_NONE              0       /* no error (must be 0) */
 410 #define HAMMER2_ERROR_EIO               0x00000001      /* device I/O error */
 411 #define HAMMER2_ERROR_CHECK             0x00000002      /* check code error */
 412 #define HAMMER2_ERROR_INCOMPLETE        0x00000004      /* incomplete cluster */
 413 #define HAMMER2_ERROR_DEPTH             0x00000008      /* tmp depth limit */
 414 #define HAMMER2_ERROR_BADBREF           0x00000010      /* illegal bref */
 415 #define HAMMER2_ERROR_ENOSPC            0x00000020      /* allocation failure */
 416 #define HAMMER2_ERROR_ENOENT            0x00000040      /* entry not found */
 417 #define HAMMER2_ERROR_ENOTEMPTY         0x00000080      /* dir not empty */
 418 #define HAMMER2_ERROR_EAGAIN            0x00000100      /* retry */
 419 #define HAMMER2_ERROR_ENOTDIR           0x00000200      /* not directory */
 420 #define HAMMER2_ERROR_EISDIR            0x00000400      /* is directory */
 421 #define HAMMER2_ERROR_EINPROGRESS       0x00000800      /* already running */
 422 #define HAMMER2_ERROR_ABORTED           0x00001000      /* aborted operation */
 423 #define HAMMER2_ERROR_EOF               0x00002000      /* end of scan */
 424 #define HAMMER2_ERROR_EINVAL            0x00004000      /* catch-all */
 425 #define HAMMER2_ERROR_EEXIST            0x00008000      /* entry exists */
 426 #define HAMMER2_ERROR_EDEADLK           0x00010000
 427 #define HAMMER2_ERROR_ESRCH             0x00020000
 428 #define HAMMER2_ERROR_ETIMEDOUT         0x00040000
 429
 430 /*
 431  * Flags passed to hammer2_chain_lookup() and hammer2_chain_next()
 432  *
 433  * NOTES:
 434  *      NODATA      - Asks that the chain->data not be resolved in order
 435  *                    to avoid I/O.
 436  *
 437  *      NODIRECT    - Prevents a lookup of offset 0 in an inode from returning
 438  *                    the inode itself if the inode is in DIRECTDATA mode
 439  *                    (i.e. file is <= 512 bytes).  Used by the synchronization
 440  *                    code to prevent confusion.
 441  *
 442  *      SHARED      - The input chain is expected to be locked shared,
 443  *                    and the output chain is locked shared.
 444  *
 445  *      MATCHIND    - Allows an indirect block / freemap node to be returned
 446  *                    when the passed key range matches the radix.  Remember
 447  *                    that key_end is inclusive (e.g. {0x000,0xFFF},
 448  *                    not {0x000,0x1000}).
 449  *
 450  *                    (Cannot be used for remote or cluster ops).
 451  *
 452  *      ALLNODES    - Allows NULL focus.
 453  *
 454  *      ALWAYS      - Always resolve the data.  If ALWAYS and NODATA are both
 455  *                    missing, bulk file data is not resolved but inodes and
 456  *                    other meta-data will.
 457  */
 458 #define HAMMER2_LOOKUP_UNUSED0001       0x00000001
 459 #define HAMMER2_LOOKUP_NODATA           0x00000002      /* data left NULL */
 460 #define HAMMER2_LOOKUP_NODIRECT         0x00000004      /* no offset=0 DD */
 461 #define HAMMER2_LOOKUP_SHARED           0x00000100
 462 #define HAMMER2_LOOKUP_MATCHIND         0x00000200      /* return all chains */
 463 #define HAMMER2_LOOKUP_ALLNODES         0x00000400      /* allow NULL focus */
 464 #define HAMMER2_LOOKUP_ALWAYS           0x00000800      /* resolve data */
 465 #define HAMMER2_LOOKUP_UNUSED1000       0x00001000
 466
 467 /*
 468  * Flags passed to hammer2_chain_modify() and hammer2_chain_resize()
 469  *
 470  * NOTE: OPTDATA allows us to avoid instantiating buffers for INDIRECT
 471  *       blocks in the INITIAL-create state.
 472  */
 473 #define HAMMER2_MODIFY_OPTDATA          0x00000002      /* data can be NULL */
 474 #define HAMMER2_MODIFY_NO_MODIFY_TID    0x00000004
 475 #define HAMMER2_MODIFY_UNUSED0008       0x00000008
 476
 477 /*
 478  * Flags passed to hammer2_chain_lock()
 479  *
 480  * NOTE: RDONLY is set to optimize cluster operations when *no* modifications
 481  *       will be made to either the cluster being locked or any underlying
 482  *       cluster.  It allows the cluster to lock and access data for a subset
 483  *       of available nodes instead of all available nodes.
 484  *
 485  * NOTE: NONBLOCK is only used for hammer2_chain_repparent() and getparent(),
 486  *       other functions (e.g. hammer2_chain_lookup(), etc) can't handle its
 487  *       operation.
 488  */
 489 #define HAMMER2_RESOLVE_NEVER           1
 490 #define HAMMER2_RESOLVE_MAYBE           2
 491 #define HAMMER2_RESOLVE_ALWAYS          3
 492 #define HAMMER2_RESOLVE_MASK            0x0F
 493
 494 #define HAMMER2_RESOLVE_SHARED          0x10    /* request shared lock */
 495 #define HAMMER2_RESOLVE_LOCKAGAIN       0x20    /* another shared lock */
 496 #define HAMMER2_RESOLVE_RDONLY          0x40    /* higher level op flag */
 497 #define HAMMER2_RESOLVE_NONBLOCK        0x80    /* non-blocking */
 498
 499 /*
 500  * Flags passed to hammer2_chain_delete()
 501  */
 502 #define HAMMER2_DELETE_PERMANENT        0x0001
 503
 504 /*
 505  * Flags passed to hammer2_chain_insert() or hammer2_chain_rename()
 506  * or hammer2_chain_create().
 507  */
 508 #define HAMMER2_INSERT_PFSROOT          0x0004
 509 #define HAMMER2_INSERT_SAMEPARENT       0x0008
 510
 511 /*
 512  * Flags passed to hammer2_chain_delete_duplicate()
 513  */
 514 #define HAMMER2_DELDUP_RECORE           0x0001
 515
 516 /*
 517  * Cluster different types of storage together for allocations
 518  */
 519 #define HAMMER2_FREECACHE_INODE         0
 520 #define HAMMER2_FREECACHE_INDIR         1
 521 #define HAMMER2_FREECACHE_DATA          2
 522 #define HAMMER2_FREECACHE_UNUSED3       3
 523 #define HAMMER2_FREECACHE_TYPES         4
 524
 525 /*
 526  * hammer2_freemap_alloc() block preference
 527  */
 528 #define HAMMER2_OFF_NOPREF              ((hammer2_off_t)-1)
 529
 530 /*
 531  * BMAP read-ahead maximum parameters
 532  */
 533 #define HAMMER2_BMAP_COUNT              16      /* max bmap read-ahead */
 534 #define HAMMER2_BMAP_BYTES              (HAMMER2_PBUFSIZE * HAMMER2_BMAP_COUNT)
 535
 536 /*
 537  * hammer2_freemap_adjust()
 538  */
 539 #define HAMMER2_FREEMAP_DORECOVER       1
 540 #define HAMMER2_FREEMAP_DOMAYFREE       2
 541 #define HAMMER2_FREEMAP_DOREALFREE      3
 542
 543 /*
 544  * HAMMER2 cluster - A set of chains representing the same entity.
 545  *
 546  * hammer2_cluster typically represents a temporary set of representitive
 547  * chains.  The one exception is that a hammer2_cluster is embedded in
 548  * hammer2_inode.  This embedded cluster is ONLY used to track the
 549  * representitive chains and cannot be directly locked.
 550  *
 551  * A cluster is usually temporary (and thus per-thread) for locking purposes,
 552  * allowing us to embed the asynchronous storage required for cluster
 553  * operations in the cluster itself and adjust the state and status without
 554  * having to worry too much about SMP issues.
 555  *
 556  * The exception is the cluster embedded in the hammer2_inode structure.
 557  * This is used to cache the cluster state on an inode-by-inode basis.
 558  * Individual hammer2_chain structures not incorporated into clusters might
 559  * also stick around to cache miscellanious elements.
 560  *
 561  * Because the cluster is a 'working copy' and is usually subject to cluster
 562  * quorum rules, it is quite possible for us to end up with an insufficient
 563  * number of live chains to execute an operation.  If an insufficient number
 564  * of chains remain in a working copy, the operation may have to be
 565  * downgraded, retried, stall until the requisit number of chains are
 566  * available, or possibly even error out depending on the mount type.
 567  *
 568  * A cluster's focus is set when it is locked.  The focus can only be set
 569  * to a chain still part of the synchronized set.
 570  */
 571 #define HAMMER2_XOPFIFO         16
 572 #define HAMMER2_XOPFIFO_MASK    (HAMMER2_XOPFIFO - 1)
 573 #define HAMMER2_XOPGROUPS       32
 574 #define HAMMER2_XOPGROUPS_MASK  (HAMMER2_XOPGROUPS - 1)
 575
 576 #define HAMMER2_MAXCLUSTER      8
 577 #define HAMMER2_XOPMASK_CLUSTER (uint64_t)((1LLU << HAMMER2_MAXCLUSTER) - 1)
 578 #define HAMMER2_XOPMASK_VOP     (uint64_t)0x0000000080000000LLU
 579 #define HAMMER2_XOPMASK_FIFOW   (uint64_t)0x0000000040000000LLU
 580 #define HAMMER2_XOPMASK_WAIT    (uint64_t)0x0000000020000000LLU
 581 #define HAMMER2_XOPMASK_FEED    (uint64_t)0x0000000100000000LLU
 582
 583 #define HAMMER2_XOPMASK_ALLDONE (HAMMER2_XOPMASK_VOP | HAMMER2_XOPMASK_CLUSTER)
 584
 585 #define HAMMER2_SPECTHREADS     1       /* sync */
 586
 587 struct hammer2_cluster_item {
 588         hammer2_chain_t         *chain;
 589         int                     error;
 590         uint32_t                flags;
 591 };
 592
 593 typedef struct hammer2_cluster_item hammer2_cluster_item_t;
 594
 595 /*
 596  * INVALID      - Invalid for focus, i.e. not part of synchronized set.
 597  *                Once set, this bit is sticky across operations.
 598  *
 599  * FEMOD        - Indicates that front-end modifying operations can
 600  *                mess with this entry and MODSYNC will copy also
 601  *                effect it.
 602  */
 603 #define HAMMER2_CITEM_INVALID   0x00000001
 604 #define HAMMER2_CITEM_FEMOD     0x00000002
 605 #define HAMMER2_CITEM_NULL      0x00000004
 606
 607 struct hammer2_cluster {
 608         int                     refs;           /* track for deallocation */
 609         int                     ddflag;
 610         struct hammer2_pfs      *pmp;
 611         uint32_t                flags;
 612         int                     nchains;
 613         int                     error;          /* error code valid on lock */
 614         int                     focus_index;
 615         hammer2_chain_t         *focus;         /* current focus (or mod) */
 616         hammer2_cluster_item_t  array[HAMMER2_MAXCLUSTER];
 617 };
 618
 619 typedef struct hammer2_cluster  hammer2_cluster_t;
 620
 621 /*
 622  * WRHARD       - Hard mounts can write fully synchronized
 623  * RDHARD       - Hard mounts can read fully synchronized
 624  * UNHARD       - Unsynchronized masters present
 625  * NOHARD       - No masters visible
 626  * WRSOFT       - Soft mounts can write to at least the SOFT_MASTER
 627  * RDSOFT       - Soft mounts can read from at least a SOFT_SLAVE
 628  * UNSOFT       - Unsynchronized slaves present
 629  * NOSOFT       - No slaves visible
 630  * RDSLAVE      - slaves are accessible (possibly unsynchronized or remote).
 631  * MSYNCED      - All masters are fully synchronized
 632  * SSYNCED      - All known local slaves are fully synchronized to masters
 633  *
 634  * All available masters are always incorporated.  All PFSs belonging to a
 635  * cluster (master, slave, copy, whatever) always try to synchronize the
 636  * total number of known masters in the PFSs root inode.
 637  *
 638  * A cluster might have access to many slaves, copies, or caches, but we
 639  * have a limited number of cluster slots.  Any such elements which are
 640  * directly mounted from block device(s) will always be incorporated.   Note
 641  * that SSYNCED only applies to such elements which are directly mounted,
 642  * not to any remote slaves, copies, or caches that could be available.  These
 643  * bits are used to monitor and drive our synchronization threads.
 644  *
 645  * When asking the question 'is any data accessible at all', then a simple
 646  * test against (RDHARD|RDSOFT|RDSLAVE) gives you the answer.  If any of
 647  * these bits are set the object can be read with certain caveats:
 648  * RDHARD - no caveats.  RDSOFT - authoritative but might not be synchronized.
 649  * and RDSLAVE - not authoritative, has some data but it could be old or
 650  * incomplete.
 651  *
 652  * When both soft and hard mounts are available, data will be read and written
 653  * via the soft mount only.  But all might be in the cluster because
 654  * background synchronization threads still need to do their work.
 655  */
 656 #define HAMMER2_CLUSTER_INODE   0x00000001      /* embedded in inode struct */
 657 #define HAMMER2_CLUSTER_UNUSED2 0x00000002
 658 #define HAMMER2_CLUSTER_LOCKED  0x00000004      /* cluster lks not recursive */
 659 #define HAMMER2_CLUSTER_WRHARD  0x00000100      /* hard-mount can write */
 660 #define HAMMER2_CLUSTER_RDHARD  0x00000200      /* hard-mount can read */
 661 #define HAMMER2_CLUSTER_UNHARD  0x00000400      /* unsynchronized masters */
 662 #define HAMMER2_CLUSTER_NOHARD  0x00000800      /* no masters visible */
 663 #define HAMMER2_CLUSTER_WRSOFT  0x00001000      /* soft-mount can write */
 664 #define HAMMER2_CLUSTER_RDSOFT  0x00002000      /* soft-mount can read */
 665 #define HAMMER2_CLUSTER_UNSOFT  0x00004000      /* unsynchronized slaves */
 666 #define HAMMER2_CLUSTER_NOSOFT  0x00008000      /* no slaves visible */
 667 #define HAMMER2_CLUSTER_MSYNCED 0x00010000      /* all masters synchronized */
 668 #define HAMMER2_CLUSTER_SSYNCED 0x00020000      /* known slaves synchronized */
 669
 670 #define HAMMER2_CLUSTER_ANYDATA ( HAMMER2_CLUSTER_RDHARD |      \
 671                                   HAMMER2_CLUSTER_RDSOFT |      \
 672                                   HAMMER2_CLUSTER_RDSLAVE)
 673
 674 #define HAMMER2_CLUSTER_RDOK    ( HAMMER2_CLUSTER_RDHARD |      \
 675                                   HAMMER2_CLUSTER_RDSOFT)
 676
 677 #define HAMMER2_CLUSTER_WROK    ( HAMMER2_CLUSTER_WRHARD |      \
 678                                   HAMMER2_CLUSTER_WRSOFT)
 679
 680 #define HAMMER2_CLUSTER_ZFLAGS  ( HAMMER2_CLUSTER_WRHARD |      \
 681                                   HAMMER2_CLUSTER_RDHARD |      \
 682                                   HAMMER2_CLUSTER_WRSOFT |      \
 683                                   HAMMER2_CLUSTER_RDSOFT |      \
 684                                   HAMMER2_CLUSTER_MSYNCED |     \
 685                                   HAMMER2_CLUSTER_SSYNCED)
 686
 687 /*
 688  * Helper functions (cluster must be locked for flags to be valid).
 689  */
 690 static __inline
 691 int
 692 hammer2_cluster_rdok(hammer2_cluster_t *cluster)
 693 {
 694         return (cluster->flags & HAMMER2_CLUSTER_RDOK);
 695 }
 696
 697 static __inline
 698 int
 699 hammer2_cluster_wrok(hammer2_cluster_t *cluster)
 700 {
 701         return (cluster->flags & HAMMER2_CLUSTER_WROK);
 702 }
 703
 704 RB_HEAD(hammer2_inode_tree, hammer2_inode);     /* ip->rbnode */
 705 TAILQ_HEAD(inoq_head, hammer2_inode);           /* ip->entry */
 706 TAILQ_HEAD(depq_head, hammer2_depend);          /* depend->entry */
 707
 708 struct hammer2_depend {
 709         TAILQ_ENTRY(hammer2_depend) entry;
 710         struct inoq_head        sideq;
 711         long                    count;
 712         int                     pass2;
 713         int                     unused01;
 714 };
 715
 716 typedef struct hammer2_depend hammer2_depend_t;
 717
 718 /*
 719  * A hammer2 inode.
 720  *
 721  * NOTE: The inode-embedded cluster is never used directly for I/O (since
 722  *       it may be shared).  Instead it will be replicated-in and synchronized
 723  *       back out if changed.
 724  */
 725 struct hammer2_inode {
 726         RB_ENTRY(hammer2_inode) rbnode;         /* inumber lookup (HL) */
 727         TAILQ_ENTRY(hammer2_inode) entry;       /* SYNCQ/SIDEQ */
 728         hammer2_depend_t        *depend;        /* non-NULL if SIDEQ */
 729         hammer2_depend_t        depend_static;  /* (in-place allocation) */
 730         hammer2_mtx_t           lock;           /* inode lock */
 731         hammer2_mtx_t           truncate_lock;  /* prevent truncates */
 732         struct hammer2_pfs      *pmp;           /* PFS mount */
 733         struct vnode            *vp;
 734         struct spinlock         cluster_spin;   /* update cluster */
 735         hammer2_cluster_t       cluster;
 736         struct lockf            advlock;
 737         u_int                   flags;
 738         u_int                   refs;           /* +vpref, +flushref */
 739         uint8_t                 comp_heuristic;
 740         hammer2_inode_meta_t    meta;           /* copy of meta-data */
 741         hammer2_off_t           osize;
 742 };
 743
 744 typedef struct hammer2_inode hammer2_inode_t;
 745
 746 /*
 747  * MODIFIED     - Inode is in a modified state, ip->meta may have changes.
 748  * RESIZED      - Inode truncated (any) or inode extended beyond
 749  *                EMBEDDED_BYTES.
 750  *
 751  * SYNCQ        - Inode is included in the current filesystem sync.  The
 752  *                DELETING and CREATING flags will be acted upon.
 753  *
 754  * SIDEQ        - Inode has likely been disconnected from the vnode topology
 755  *                and so is not visible to the vnode-based filesystem syncer
 756  *                code, but is dirty and must be included in the next
 757  *                filesystem sync.  These inodes are moved to the SYNCQ at
 758  *                the time the sync occurs.
 759  *
 760  *                Inodes are not placed on this queue simply because they have
 761  *                become dirty, if a vnode is attached.
 762  *
 763  * DELETING     - Inode is flagged for deletion during the next filesystem
 764  *                sync.  That is, the inode's chain is currently connected
 765  *                and must be deleting during the current or next fs sync.
 766  *
 767  * CREATING     - Inode is flagged for creation during the next filesystem
 768  *                sync.  That is, the inode's chain topology exists (so
 769  *                kernel buffer flushes can occur), but is currently
 770  *                disconnected and must be inserted during the current or
 771  *                next fs sync.  If the DELETING flag is also set, the
 772  *                topology can be thrown away instead.
 773  *
 774  * If an inode that is already part of the current filesystem sync is
 775  * modified by the frontend, including by buffer flushes, the inode lock
 776  * code detects the SYNCQ flag and moves the inode to the head of the
 777  * flush-in-progress, then blocks until the flush has gotten past it.
 778  */
 779 #define HAMMER2_INODE_MODIFIED          0x0001
 780 #define HAMMER2_INODE_SROOT             0x0002  /* kmalloc special case */
 781 #define HAMMER2_INODE_RENAME_INPROG     0x0004
 782 #define HAMMER2_INODE_ONRBTREE          0x0008
 783 #define HAMMER2_INODE_RESIZED           0x0010  /* requires inode_fsync */
 784 #define HAMMER2_INODE_UNUSED0020        0x0020
 785 #define HAMMER2_INODE_ISUNLINKED        0x0040
 786 #define HAMMER2_INODE_METAGOOD          0x0080  /* inode meta-data good */
 787 #define HAMMER2_INODE_SIDEQ             0x0100  /* on side processing queue */
 788 #define HAMMER2_INODE_NOSIDEQ           0x0200  /* disable sideq operation */
 789 #define HAMMER2_INODE_DIRTYDATA         0x0400  /* interlocks inode flush */
 790 #define HAMMER2_INODE_SYNCQ             0x0800  /* sync interlock, sequenced */
 791 #define HAMMER2_INODE_DELETING          0x1000  /* sync interlock, chain topo */
 792 #define HAMMER2_INODE_CREATING          0x2000  /* sync interlock, chain topo */
 793 #define HAMMER2_INODE_SYNCQ_WAKEUP      0x4000  /* sync interlock wakeup */
 794 #define HAMMER2_INODE_SYNCQ_PASS2       0x8000  /* force retry delay */
 795
 796 #define HAMMER2_INODE_DIRTY             (HAMMER2_INODE_MODIFIED |       \
 797                                          HAMMER2_INODE_DIRTYDATA |      \
 798                                          HAMMER2_INODE_DELETING |       \
 799                                          HAMMER2_INODE_CREATING)
 800
 801 int hammer2_inode_cmp(hammer2_inode_t *ip1, hammer2_inode_t *ip2);
 802 RB_PROTOTYPE2(hammer2_inode_tree, hammer2_inode, rbnode, hammer2_inode_cmp,
 803                 hammer2_tid_t);
 804
 805 /*
 806  * Transaction management sub-structure under hammer2_pfs
 807  */
 808 struct hammer2_trans {
 809         uint32_t                flags;
 810         uint32_t                sync_wait;
 811 };
 812
 813 typedef struct hammer2_trans hammer2_trans_t;
 814
 815 #define HAMMER2_TRANS_ISFLUSH           0x80000000      /* flush code */
 816 #define HAMMER2_TRANS_BUFCACHE          0x40000000      /* bio strategy */
 817 #define HAMMER2_TRANS_SIDEQ             0x20000000      /* run sideq */
 818 #define HAMMER2_TRANS_UNUSED10          0x10000000
 819 #define HAMMER2_TRANS_WAITING           0x08000000      /* someone waiting */
 820 #define HAMMER2_TRANS_RESCAN            0x04000000      /* rescan sideq */
 821 #define HAMMER2_TRANS_MASK              0x00FFFFFF      /* count mask */
 822
 823 #define HAMMER2_FREEMAP_HEUR_NRADIX     4       /* pwr 2 PBUFRADIX-MINIORADIX */
 824 #define HAMMER2_FREEMAP_HEUR_TYPES      8
 825 #define HAMMER2_FREEMAP_HEUR_SIZE       (HAMMER2_FREEMAP_HEUR_NRADIX * \
 826                                          HAMMER2_FREEMAP_HEUR_TYPES)
 827
 828 #define HAMMER2_DEDUP_HEUR_SIZE         (65536 * 4)
 829 #define HAMMER2_DEDUP_HEUR_MASK         (HAMMER2_DEDUP_HEUR_SIZE - 1)
 830
 831 #define HAMMER2_FLUSH_TOP               0x0001
 832 #define HAMMER2_FLUSH_ALL               0x0002
 833 #define HAMMER2_FLUSH_INODE_STOP        0x0004  /* stop at sub-inode */
 834 #define HAMMER2_FLUSH_FSSYNC            0x0008  /* part of filesystem sync */
 835
 836
 837 /*
 838  * Hammer2 support thread element.
 839  *
 840  * Potentially many support threads can hang off of hammer2, primarily
 841  * off the hammer2_pfs structure.  Typically:
 842  *
 843  * td x Nodes                   A synchronization thread for each node.
 844  * td x Nodes x workers         Worker threads for frontend operations.
 845  * td x 1                       Bioq thread for logical buffer writes.
 846  *
 847  * In addition, the synchronization thread(s) associated with the
 848  * super-root PFS (spmp) for a node is responsible for automatic bulkfree
 849  * and dedup scans.
 850  */
 851 struct hammer2_thread {
 852         struct hammer2_pfs *pmp;
 853         struct hammer2_dev *hmp;
 854         hammer2_xop_list_t xopq;
 855         thread_t        td;
 856         uint32_t        flags;
 857         int             depth;
 858         int             clindex;        /* cluster element index */
 859         int             repidx;
 860         char            *scratch;       /* MAXPHYS */
 861 };
 862
 863 typedef struct hammer2_thread hammer2_thread_t;
 864
 865 #define HAMMER2_THREAD_UNMOUNTING       0x0001  /* unmount request */
 866 #define HAMMER2_THREAD_DEV              0x0002  /* related to dev, not pfs */
 867 #define HAMMER2_THREAD_WAITING          0x0004  /* thread in idle tsleep */
 868 #define HAMMER2_THREAD_REMASTER         0x0008  /* remaster request */
 869 #define HAMMER2_THREAD_STOP             0x0010  /* exit request */
 870 #define HAMMER2_THREAD_FREEZE           0x0020  /* force idle */
 871 #define HAMMER2_THREAD_FROZEN           0x0040  /* thread is frozen */
 872 #define HAMMER2_THREAD_XOPQ             0x0080  /* work pending */
 873 #define HAMMER2_THREAD_STOPPED          0x0100  /* thread has stopped */
 874 #define HAMMER2_THREAD_UNFREEZE         0x0200
 875
 876 #define HAMMER2_THREAD_WAKEUP_MASK      (HAMMER2_THREAD_UNMOUNTING |    \
 877                                          HAMMER2_THREAD_REMASTER |      \
 878                                          HAMMER2_THREAD_STOP |          \
 879                                          HAMMER2_THREAD_FREEZE |        \
 880                                          HAMMER2_THREAD_XOPQ)
 881
 882 /*
 883  * Support structure for dedup heuristic.
 884  */
 885 struct hammer2_dedup {
 886         hammer2_off_t   data_off;
 887         uint64_t        data_crc;
 888         uint32_t        ticks;
 889         uint32_t        unused03;
 890 };
 891
 892 typedef struct hammer2_dedup hammer2_dedup_t;
 893
 894 /*
 895  * hammer2_xop - container for VOP/XOP operation (allocated, not on stack).
 896  *
 897  * This structure is used to distribute a VOP operation across multiple
 898  * nodes.  It provides a rendezvous for concurrent node execution and
 899  * can be detached from the frontend operation to allow the frontend to
 900  * return early.
 901  *
 902  * This structure also sequences operations on up to three inodes.
 903  */
 904 typedef void (*hammer2_xop_func_t)(union hammer2_xop *xop, void *scratch,
 905                                    int clindex);
 906
 907 struct hammer2_xop_desc {
 908         hammer2_xop_func_t      storage_func;   /* local storage function */
 909         hammer2_xop_func_t      dmsg_dispatch;  /* dmsg dispatch function */
 910         hammer2_xop_func_t      dmsg_process;   /* dmsg processing function */
 911         const char              *id;
 912 };
 913
 914 typedef struct hammer2_xop_desc hammer2_xop_desc_t;
 915
 916 struct hammer2_xop_fifo {
 917         TAILQ_ENTRY(hammer2_xop_head) entry;
 918         hammer2_chain_t         *array[HAMMER2_XOPFIFO];
 919         int                     errors[HAMMER2_XOPFIFO];
 920         int                     ri;
 921         int                     wi;
 922         int                     flags;
 923         hammer2_thread_t        *thr;
 924 };
 925
 926 typedef struct hammer2_xop_fifo hammer2_xop_fifo_t;
 927
 928 #define HAMMER2_XOP_FIFO_RUN    0x0001
 929 #define HAMMER2_XOP_FIFO_STALL  0x0002
 930
 931 struct hammer2_xop_head {
 932         hammer2_xop_desc_t      *desc;
 933         hammer2_tid_t           mtid;
 934         struct hammer2_inode    *ip1;
 935         struct hammer2_inode    *ip2;
 936         struct hammer2_inode    *ip3;
 937         uint64_t                run_mask;
 938         uint64_t                chk_mask;
 939         int                     flags;
 940         int                     state;
 941         int                     error;
 942         hammer2_key_t           collect_key;
 943         char                    *name1;
 944         size_t                  name1_len;
 945         char                    *name2;
 946         size_t                  name2_len;
 947         hammer2_xop_fifo_t      collect[HAMMER2_MAXCLUSTER];
 948         hammer2_cluster_t       cluster;        /* help collections */
 949         hammer2_io_t            *focus_dio;
 950 };
 951
 952 typedef struct hammer2_xop_head hammer2_xop_head_t;
 953
 954 struct hammer2_xop_ipcluster {
 955         hammer2_xop_head_t      head;
 956 };
 957
 958 struct hammer2_xop_strategy {
 959         hammer2_xop_head_t      head;
 960         hammer2_key_t           lbase;
 961         int                     finished;
 962         hammer2_mtx_t           lock;
 963         struct bio              *bio;
 964 };
 965
 966 struct hammer2_xop_readdir {
 967         hammer2_xop_head_t      head;
 968         hammer2_key_t           lkey;
 969 };
 970
 971 struct hammer2_xop_nresolve {
 972         hammer2_xop_head_t      head;
 973         hammer2_key_t           lhc;    /* if name is NULL used lhc */
 974 };
 975
 976 struct hammer2_xop_unlink {
 977         hammer2_xop_head_t      head;
 978         int                     isdir;
 979         int                     dopermanent;
 980 };
 981
 982 #define H2DOPERM_PERMANENT      0x01
 983 #define H2DOPERM_FORCE          0x02
 984 #define H2DOPERM_IGNINO         0x04
 985
 986 struct hammer2_xop_nrename {
 987         hammer2_xop_head_t      head;
 988         hammer2_tid_t           lhc;
 989         int                     ip_key;
 990 };
 991
 992 struct hammer2_xop_scanlhc {
 993         hammer2_xop_head_t      head;
 994         hammer2_key_t           lhc;
 995 };
 996
 997 struct hammer2_xop_scanall {
 998         hammer2_xop_head_t      head;
 999         hammer2_key_t           key_beg;        /* inclusive */
1000         hammer2_key_t           key_end;        /* inclusive */
1001         int                     resolve_flags;
1002         int                     lookup_flags;
1003 };
1004
1005 struct hammer2_xop_lookup {
1006         hammer2_xop_head_t      head;
1007         hammer2_key_t           lhc;
1008 };
1009
1010 struct hammer2_xop_mkdirent {
1011         hammer2_xop_head_t      head;
1012         hammer2_dirent_head_t   dirent;
1013         hammer2_key_t           lhc;
1014 };
1015
1016 struct hammer2_xop_create {
1017         hammer2_xop_head_t      head;
1018         hammer2_inode_meta_t    meta;           /* initial metadata */
1019         hammer2_key_t           lhc;
1020         int                     flags;
1021 };
1022
1023 struct hammer2_xop_destroy {
1024         hammer2_xop_head_t      head;
1025 };
1026
1027 struct hammer2_xop_fsync {
1028         hammer2_xop_head_t      head;
1029         hammer2_inode_meta_t    meta;
1030         hammer2_off_t           osize;
1031         u_int                   ipflags;
1032         int                     clear_directdata;
1033 };
1034
1035 struct hammer2_xop_unlinkall {
1036         hammer2_xop_head_t      head;
1037         hammer2_key_t           key_beg;
1038         hammer2_key_t           key_end;
1039 };
1040
1041 struct hammer2_xop_connect {
1042         hammer2_xop_head_t      head;
1043         hammer2_key_t           lhc;
1044 };
1045
1046 struct hammer2_xop_flush {
1047         hammer2_xop_head_t      head;
1048 };
1049
1050 typedef struct hammer2_xop_readdir hammer2_xop_readdir_t;
1051 typedef struct hammer2_xop_nresolve hammer2_xop_nresolve_t;
1052 typedef struct hammer2_xop_unlink hammer2_xop_unlink_t;
1053 typedef struct hammer2_xop_nrename hammer2_xop_nrename_t;
1054 typedef struct hammer2_xop_ipcluster hammer2_xop_ipcluster_t;
1055 typedef struct hammer2_xop_strategy hammer2_xop_strategy_t;
1056 typedef struct hammer2_xop_mkdirent hammer2_xop_mkdirent_t;
1057 typedef struct hammer2_xop_create hammer2_xop_create_t;
1058 typedef struct hammer2_xop_destroy hammer2_xop_destroy_t;
1059 typedef struct hammer2_xop_fsync hammer2_xop_fsync_t;
1060 typedef struct hammer2_xop_unlinkall hammer2_xop_unlinkall_t;
1061 typedef struct hammer2_xop_scanlhc hammer2_xop_scanlhc_t;
1062 typedef struct hammer2_xop_scanall hammer2_xop_scanall_t;
1063 typedef struct hammer2_xop_lookup hammer2_xop_lookup_t;
1064 typedef struct hammer2_xop_connect hammer2_xop_connect_t;
1065 typedef struct hammer2_xop_flush hammer2_xop_flush_t;
1066
1067 union hammer2_xop {
1068         hammer2_xop_head_t      head;
1069         hammer2_xop_ipcluster_t xop_ipcluster;
1070         hammer2_xop_readdir_t   xop_readdir;
1071         hammer2_xop_nresolve_t  xop_nresolve;
1072         hammer2_xop_unlink_t    xop_unlink;
1073         hammer2_xop_nrename_t   xop_nrename;
1074         hammer2_xop_strategy_t  xop_strategy;
1075         hammer2_xop_mkdirent_t  xop_mkdirent;
1076         hammer2_xop_create_t    xop_create;
1077         hammer2_xop_destroy_t   xop_destroy;
1078         hammer2_xop_fsync_t     xop_fsync;
1079         hammer2_xop_unlinkall_t xop_unlinkall;
1080         hammer2_xop_scanlhc_t   xop_scanlhc;
1081         hammer2_xop_scanall_t   xop_scanall;
1082         hammer2_xop_lookup_t    xop_lookup;
1083         hammer2_xop_flush_t     xop_flush;
1084         hammer2_xop_connect_t   xop_connect;
1085 };
1086
1087 typedef union hammer2_xop hammer2_xop_t;
1088
1089 /*
1090  * hammer2_xop_group - Manage XOP support threads.
1091  */
1092 struct hammer2_xop_group {
1093         hammer2_thread_t        thrs[HAMMER2_MAXCLUSTER];
1094 };
1095
1096 typedef struct hammer2_xop_group hammer2_xop_group_t;
1097
1098 /*
1099  * flags to hammer2_xop_collect()
1100  */
1101 #define HAMMER2_XOP_COLLECT_NOWAIT      0x00000001
1102 #define HAMMER2_XOP_COLLECT_WAITALL     0x00000002
1103
1104 /*
1105  * flags to hammer2_xop_alloc()
1106  *
1107  * MODIFYING    - This is a modifying transaction, allocate a mtid.
1108  * RECURSE      - Recurse top-level inode (for root flushes)
1109  */
1110 #define HAMMER2_XOP_MODIFYING           0x00000001
1111 #define HAMMER2_XOP_STRATEGY            0x00000002
1112 #define HAMMER2_XOP_INODE_STOP          0x00000004
1113 #define HAMMER2_XOP_VOLHDR              0x00000008
1114 #define HAMMER2_XOP_FSSYNC              0x00000010
1115 #define HAMMER2_XOP_IROOT               0x00000020
1116
1117 /*
1118  * Global (per partition) management structure, represents a hard block
1119  * device.  Typically referenced by hammer2_chain structures when applicable.
1120  * Typically not used for network-managed elements.
1121  *
1122  * Note that a single hammer2_dev can be indirectly tied to multiple system
1123  * mount points.  There is no direct relationship.  System mounts are
1124  * per-cluster-id, not per-block-device, and a single hard mount might contain
1125  * many PFSs and those PFSs might combine together in various ways to form
1126  * the set of available clusters.
1127  */
1128 struct hammer2_dev {
1129         struct vnode    *devvp;         /* device vnode */
1130         int             ronly;          /* read-only mount */
1131         int             mount_count;    /* number of actively mounted PFSs */
1132         TAILQ_ENTRY(hammer2_dev) mntentry; /* hammer2_mntlist */
1133
1134         struct malloc_type *mchain;
1135         int             nipstacks;
1136         int             maxipstacks;
1137         kdmsg_iocom_t   iocom;          /* volume-level dmsg interface */
1138         struct spinlock io_spin;        /* iotree, iolruq access */
1139         struct hammer2_io_tree iotree;
1140         int             iofree_count;
1141         int             freemap_relaxed;
1142         hammer2_chain_t vchain;         /* anchor chain (topology) */
1143         hammer2_chain_t fchain;         /* anchor chain (freemap) */
1144         struct spinlock list_spin;
1145         struct hammer2_pfs *spmp;       /* super-root pmp for transactions */
1146         struct lock     vollk;          /* lockmgr lock */
1147         struct lock     bulklk;         /* bulkfree operation lock */
1148         struct lock     bflock;         /* bulk-free manual function lock */
1149         hammer2_off_t   heur_freemap[HAMMER2_FREEMAP_HEUR_SIZE];
1150         hammer2_dedup_t heur_dedup[HAMMER2_DEDUP_HEUR_SIZE];
1151         int             volhdrno;       /* last volhdrno written */
1152         uint32_t        hflags;         /* HMNT2 flags applicable to device */
1153         hammer2_off_t   free_reserved;  /* nominal free reserved */
1154         hammer2_thread_t bfthr;         /* bulk-free thread */
1155         char            devrepname[64]; /* for kprintf */
1156         hammer2_ioc_bulkfree_t bflast;  /* stats for last bulkfree run */
1157         hammer2_volume_data_t voldata;
1158         hammer2_volume_data_t volsync;  /* synchronized voldata */
1159 };
1160
1161 typedef struct hammer2_dev hammer2_dev_t;
1162
1163 /*
1164  * Helper functions (cluster must be locked for flags to be valid).
1165  */
1166 static __inline
1167 int
1168 hammer2_chain_rdok(hammer2_chain_t *chain)
1169 {
1170         return (chain->error == 0);
1171 }
1172
1173 static __inline
1174 int
1175 hammer2_chain_wrok(hammer2_chain_t *chain)
1176 {
1177         return (chain->error == 0 && chain->hmp->ronly == 0);
1178 }
1179
1180 /*
1181  * Per-cluster management structure.  This structure will be tied to a
1182  * system mount point if the system is mounting the PFS, but is also used
1183  * to manage clusters encountered during the super-root scan or received
1184  * via LNK_SPANs that might not be mounted.
1185  *
1186  * This structure is also used to represent the super-root that hangs off
1187  * of a hard mount point.  The super-root is not really a cluster element.
1188  * In this case the spmp_hmp field will be non-NULL.  It's just easier to do
1189  * this than to special case super-root manipulation in the hammer2_chain*
1190  * code as being only hammer2_dev-related.
1191  *
1192  * pfs_mode and pfs_nmasters are rollup fields which critically describes
1193  * how elements of the cluster act on the cluster.  pfs_mode is only applicable
1194  * when a PFS is mounted by the system.  pfs_nmasters is our best guess as to
1195  * how many masters have been configured for a cluster and is always
1196  * applicable.  pfs_types[] is an array with 1:1 correspondance to the
1197  * iroot cluster and describes the PFS types of the nodes making up the
1198  * cluster.
1199  *
1200  * WARNING! Portions of this structure have deferred initialization.  In
1201  *          particular, if not mounted there will be no wthread.
1202  *          umounted network PFSs will also be missing iroot and numerous
1203  *          other fields will not be initialized prior to mount.
1204  *
1205  *          Synchronization threads are chain-specific and only applicable
1206  *          to local hard PFS entries.  A hammer2_pfs structure may contain
1207  *          more than one when multiple hard PFSs are present on the local
1208  *          machine which require synchronization monitoring.  Most PFSs
1209  *          (such as snapshots) are 1xMASTER PFSs which do not need a
1210  *          synchronization thread.
1211  *
1212  * WARNING! The chains making up pfs->iroot's cluster are accounted for in
1213  *          hammer2_dev->mount_count when the pfs is associated with a mount
1214  *          point.
1215  */
1216 struct hammer2_pfs {
1217         struct mount            *mp;
1218         TAILQ_ENTRY(hammer2_pfs) mntentry;      /* hammer2_pfslist */
1219         uuid_t                  pfs_clid;
1220         hammer2_dev_t           *spmp_hmp;      /* only if super-root pmp */
1221         hammer2_dev_t           *force_local;   /* only if 'local' mount */
1222         hammer2_inode_t         *iroot;         /* PFS root inode */
1223         uint8_t                 pfs_types[HAMMER2_MAXCLUSTER];
1224         char                    *pfs_names[HAMMER2_MAXCLUSTER];
1225         hammer2_dev_t           *pfs_hmps[HAMMER2_MAXCLUSTER];
1226         hammer2_blockset_t      pfs_iroot_blocksets[HAMMER2_MAXCLUSTER];
1227         hammer2_trans_t         trans;
1228         struct lock             lock;           /* PFS lock for certain ops */
1229         struct lock             lock_nlink;     /* rename and nlink lock */
1230         struct netexport        export;         /* nfs export */
1231         int                     speedup_ticks;  /* speedup_syncer() helper */
1232         int                     ronly;          /* read-only mount */
1233         int                     hflags;         /* pfs-specific mount flags */
1234         struct malloc_type      *minode;
1235         struct malloc_type      *mmsg;
1236         struct spinlock         inum_spin;      /* inumber lookup */
1237         struct hammer2_inode_tree inum_tree;    /* (not applicable to spmp) */
1238         long                    inum_count;     /* #of inodes in inum_tree */
1239         struct spinlock         lru_spin;       /* inumber lookup */
1240         struct hammer2_chain_list lru_list;     /* basis for LRU tests */
1241         int                     lru_count;      /* #of chains on LRU */
1242         int                     flags;
1243         hammer2_tid_t           modify_tid;     /* modify transaction id */
1244         hammer2_tid_t           inode_tid;      /* inode allocator */
1245         uint8_t                 pfs_nmasters;   /* total masters */
1246         uint8_t                 pfs_mode;       /* operating mode PFSMODE */
1247         uint8_t                 unused01;
1248         uint8_t                 unused02;
1249         int                     free_ticks;     /* free_* calculations */
1250         long                    inmem_inodes;
1251         hammer2_off_t           free_reserved;
1252         hammer2_off_t           free_nominal;
1253         uint32_t                inmem_dirty_chains;
1254         int                     count_lwinprog; /* logical write in prog */
1255         struct spinlock         list_spin;
1256         struct inoq_head        syncq;          /* SYNCQ flagged inodes */
1257         struct depq_head        depq;           /* SIDEQ flagged inodes */
1258         long                    sideq_count;    /* total inodes on depq */
1259         hammer2_thread_t        sync_thrs[HAMMER2_MAXCLUSTER];
1260         uint32_t                cluster_flags;  /* cached cluster flags */
1261         int                     has_xop_threads;
1262         struct spinlock         xop_spin;       /* xop sequencer */
1263         hammer2_xop_group_t     xop_groups[HAMMER2_XOPGROUPS];
1264 };
1265
1266 typedef struct hammer2_pfs hammer2_pfs_t;
1267
1268 TAILQ_HEAD(hammer2_pfslist, hammer2_pfs);
1269
1270 #define HAMMER2_PMPF_SPMP       0x00000001
1271
1272 /*
1273  * NOTE: The LRU list contains at least all the chains with refs == 0
1274  *       that can be recycled, and may contain additional chains which
1275  *       cannot.
1276  */
1277 #define HAMMER2_LRU_LIMIT               4096
1278
1279 #define HAMMER2_DIRTYCHAIN_WAITING      0x80000000
1280 #define HAMMER2_DIRTYCHAIN_MASK         0x7FFFFFFF
1281
1282 #define HAMMER2_LWINPROG_WAITING        0x80000000
1283 #define HAMMER2_LWINPROG_WAITING0       0x40000000
1284 #define HAMMER2_LWINPROG_MASK           0x3FFFFFFF
1285
1286 /*
1287  * hammer2_cluster_check
1288  */
1289 #define HAMMER2_CHECK_NULL      0x00000001
1290
1291 /*
1292  * Misc
1293  */
1294 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
1295 #define VTOI(vp)        ((hammer2_inode_t *)(vp)->v_data)
1296 #endif
1297
1298 #if defined(_KERNEL)
1299
1300 MALLOC_DECLARE(M_HAMMER2);
1301
1302 #define ITOV(ip)        ((ip)->vp)
1303
1304 /*
1305  * Currently locked chains retain the locked buffer cache buffer for
1306  * indirect blocks, and indirect blocks can be one of two sizes.  The
1307  * device buffer has to match the case to avoid deadlocking recursive
1308  * chains that might otherwise try to access different offsets within
1309  * the same device buffer.
1310  */
1311 static __inline
1312 int
1313 hammer2_devblkradix(int radix)
1314 {
1315 #if 0
1316         if (radix <= HAMMER2_LBUFRADIX) {
1317                 return (HAMMER2_LBUFRADIX);
1318         } else {
1319                 return (HAMMER2_PBUFRADIX);
1320         }
1321 #endif
1322         return (HAMMER2_PBUFRADIX);
1323 }
1324
1325 /*
1326  * XXX almost time to remove this.  DIO uses PBUFSIZE exclusively now.
1327  */
1328 static __inline
1329 size_t
1330 hammer2_devblksize(size_t bytes)
1331 {
1332 #if 0
1333         if (bytes <= HAMMER2_LBUFSIZE) {
1334                 return(HAMMER2_LBUFSIZE);
1335         } else {
1336                 KKASSERT(bytes <= HAMMER2_PBUFSIZE &&
1337                          (bytes ^ (bytes - 1)) == ((bytes << 1) - 1));
1338                 return (HAMMER2_PBUFSIZE);
1339         }
1340 #endif
1341         return (HAMMER2_PBUFSIZE);
1342 }
1343
1344
1345 static __inline
1346 hammer2_pfs_t *
1347 MPTOPMP(struct mount *mp)
1348 {
1349         return ((hammer2_pfs_t *)mp->mnt_data);
1350 }
1351
1352 #define HAMMER2_DEDUP_FRAG      (HAMMER2_PBUFSIZE / 64)
1353 #define HAMMER2_DEDUP_FRAGRADIX (HAMMER2_PBUFRADIX - 6)
1354
1355 static __inline
1356 uint64_t
1357 hammer2_dedup_mask(hammer2_io_t *dio, hammer2_off_t data_off, u_int bytes)
1358 {
1359         int bbeg;
1360         int bits;
1361         uint64_t mask;
1362
1363         bbeg = (int)((data_off & ~HAMMER2_OFF_MASK_RADIX) - dio->pbase) >>
1364                HAMMER2_DEDUP_FRAGRADIX;
1365         bits = (int)((bytes + (HAMMER2_DEDUP_FRAG - 1)) >>
1366                HAMMER2_DEDUP_FRAGRADIX);
1367         mask = ((uint64_t)1 << bbeg) - 1;
1368         if (bbeg + bits == 64)
1369                 mask = (uint64_t)-1;
1370         else
1371                 mask = ((uint64_t)1 << (bbeg + bits)) - 1;
1372
1373         mask &= ~(((uint64_t)1 << bbeg) - 1);
1374
1375         return mask;
1376 }
1377
1378 static __inline
1379 int
1380 hammer2_error_to_errno(int error)
1381 {
1382         if (error) {
1383                 if (error & HAMMER2_ERROR_EIO)
1384                         error = EIO;
1385                 else if (error & HAMMER2_ERROR_CHECK)
1386                         error = EDOM;
1387                 else if (error & HAMMER2_ERROR_ABORTED)
1388                         error = EINTR;
1389                 else if (error & HAMMER2_ERROR_BADBREF)
1390                         error = EIO;
1391                 else if (error & HAMMER2_ERROR_ENOSPC)
1392                         error = ENOSPC;
1393                 else if (error & HAMMER2_ERROR_ENOENT)
1394                         error = ENOENT;
1395                 else if (error & HAMMER2_ERROR_ENOTEMPTY)
1396                         error = ENOTEMPTY;
1397                 else if (error & HAMMER2_ERROR_EAGAIN)
1398                         error = EAGAIN;
1399                 else if (error & HAMMER2_ERROR_ENOTDIR)
1400                         error = ENOTDIR;
1401                 else if (error & HAMMER2_ERROR_EISDIR)
1402                         error = EISDIR;
1403                 else if (error & HAMMER2_ERROR_EINPROGRESS)
1404                         error = EINPROGRESS;
1405                 else if (error & HAMMER2_ERROR_EEXIST)
1406                         error = EEXIST;
1407                 else
1408                         error = EDOM;
1409         }
1410         return error;
1411 }
1412
1413 static __inline
1414 int
1415 hammer2_errno_to_error(int error)
1416 {
1417         switch(error) {
1418         case 0:
1419                 return 0;
1420         case EIO:
1421                 return HAMMER2_ERROR_EIO;
1422         case EINVAL:
1423         default:
1424                 return HAMMER2_ERROR_EINVAL;
1425         }
1426 }
1427
1428
1429 extern struct vop_ops hammer2_vnode_vops;
1430 extern struct vop_ops hammer2_spec_vops;
1431 extern struct vop_ops hammer2_fifo_vops;
1432 extern struct hammer2_pfslist hammer2_pfslist;
1433 extern struct lock hammer2_mntlk;
1434
1435
1436 extern int hammer2_debug;
1437 extern int hammer2_cluster_meta_read;
1438 extern int hammer2_cluster_data_read;
1439 extern int hammer2_cluster_write;
1440 extern int hammer2_dedup_enable;
1441 extern int hammer2_always_compress;
1442 extern int hammer2_inval_enable;
1443 extern int hammer2_flush_pipe;
1444 extern int hammer2_dio_count;
1445 extern int hammer2_dio_limit;
1446 extern int hammer2_bulkfree_tps;
1447 extern long hammer2_chain_allocs;
1448 extern long hammer2_chain_frees;
1449 extern long hammer2_limit_dirty_chains;
1450 extern long hammer2_limit_dirty_inodes;
1451 extern long hammer2_count_modified_chains;
1452 extern long hammer2_iod_invals;
1453 extern long hammer2_iod_file_read;
1454 extern long hammer2_iod_meta_read;
1455 extern long hammer2_iod_indr_read;
1456 extern long hammer2_iod_fmap_read;
1457 extern long hammer2_iod_volu_read;
1458 extern long hammer2_iod_file_write;
1459 extern long hammer2_iod_file_wembed;
1460 extern long hammer2_iod_file_wzero;
1461 extern long hammer2_iod_file_wdedup;
1462 extern long hammer2_iod_meta_write;
1463 extern long hammer2_iod_indr_write;
1464 extern long hammer2_iod_fmap_write;
1465 extern long hammer2_iod_volu_write;
1466
1467 extern long hammer2_process_xxhash64;
1468 extern long hammer2_process_icrc32;
1469
1470 extern struct objcache *cache_buffer_read;
1471 extern struct objcache *cache_buffer_write;
1472 extern struct objcache *cache_xops;
1473
1474 /*
1475  * hammer2_subr.c
1476  */
1477 #define hammer2_icrc32(buf, size)       iscsi_crc32((buf), (size))
1478 #define hammer2_icrc32c(buf, size, crc) iscsi_crc32_ext((buf), (size), (crc))
1479
1480 int hammer2_signal_check(time_t *timep);
1481 const char *hammer2_error_str(int error);
1482
1483 void hammer2_inode_delayed_sideq(hammer2_inode_t *ip);
1484 void hammer2_inode_lock(hammer2_inode_t *ip, int how);
1485 void hammer2_inode_lock4(hammer2_inode_t *ip1, hammer2_inode_t *ip2,
1486                         hammer2_inode_t *ip3, hammer2_inode_t *ip4);
1487 void hammer2_inode_unlock(hammer2_inode_t *ip);
1488 void hammer2_inode_depend(hammer2_inode_t *ip1, hammer2_inode_t *ip2);
1489 hammer2_chain_t *hammer2_inode_chain(hammer2_inode_t *ip, int clindex, int how);
1490 hammer2_chain_t *hammer2_inode_chain_and_parent(hammer2_inode_t *ip,
1491                         int clindex, hammer2_chain_t **parentp, int how);
1492 hammer2_mtx_state_t hammer2_inode_lock_temp_release(hammer2_inode_t *ip);
1493 void hammer2_inode_lock_temp_restore(hammer2_inode_t *ip,
1494                         hammer2_mtx_state_t ostate);
1495 int hammer2_inode_lock_upgrade(hammer2_inode_t *ip);
1496 void hammer2_inode_lock_downgrade(hammer2_inode_t *ip, int);
1497
1498 void hammer2_dev_exlock(hammer2_dev_t *hmp);
1499 void hammer2_dev_shlock(hammer2_dev_t *hmp);
1500 void hammer2_dev_unlock(hammer2_dev_t *hmp);
1501
1502 int hammer2_get_dtype(uint8_t type);
1503 int hammer2_get_vtype(uint8_t type);
1504 uint8_t hammer2_get_obj_type(enum vtype vtype);
1505 void hammer2_time_to_timespec(uint64_t xtime, struct timespec *ts);
1506 uint64_t hammer2_timespec_to_time(const struct timespec *ts);
1507 uint32_t hammer2_to_unix_xid(const uuid_t *uuid);
1508 void hammer2_guid_to_uuid(uuid_t *uuid, uint32_t guid);
1509 void hammer2_trans_manage_init(hammer2_pfs_t *pmp);
1510
1511 hammer2_key_t hammer2_dirhash(const unsigned char *name, size_t len);
1512 int hammer2_getradix(size_t bytes);
1513
1514 int hammer2_calc_logical(hammer2_inode_t *ip, hammer2_off_t uoff,
1515                         hammer2_key_t *lbasep, hammer2_key_t *leofp);
1516 int hammer2_calc_physical(hammer2_inode_t *ip, hammer2_key_t lbase);
1517 void hammer2_update_time(uint64_t *timep);
1518 void hammer2_adjreadcounter(hammer2_blockref_t *bref, size_t bytes);
1519
1520 /*
1521  * hammer2_inode.c
1522  */
1523 struct vnode *hammer2_igetv(hammer2_inode_t *ip, int *errorp);
1524 hammer2_inode_t *hammer2_inode_lookup(hammer2_pfs_t *pmp,
1525                         hammer2_tid_t inum);
1526 hammer2_inode_t *hammer2_inode_get(hammer2_pfs_t *pmp,
1527                         hammer2_xop_head_t *xop, hammer2_tid_t inum, int idx);
1528 void hammer2_inode_free(hammer2_inode_t *ip);
1529 void hammer2_inode_ref(hammer2_inode_t *ip);
1530 void hammer2_inode_drop(hammer2_inode_t *ip);
1531 void hammer2_inode_repoint(hammer2_inode_t *ip, hammer2_inode_t *pip,
1532                         hammer2_cluster_t *cluster);
1533 void hammer2_inode_repoint_one(hammer2_inode_t *ip, hammer2_cluster_t *cluster,
1534                         int idx);
1535 void hammer2_inode_modify(hammer2_inode_t *ip);
1536 void hammer2_inode_run_sideq(hammer2_pfs_t *pmp, int doall);
1537
1538 hammer2_inode_t *hammer2_inode_create_normal(hammer2_inode_t *pip,
1539                         struct vattr *vap, struct ucred *cred,
1540                         hammer2_key_t inum, int *errorp);
1541 hammer2_inode_t *hammer2_inode_create_pfs(hammer2_pfs_t *spmp,
1542                         const uint8_t *name, size_t name_len,
1543                         int *errorp);
1544 int hammer2_inode_chain_ins(hammer2_inode_t *ip);
1545 int hammer2_inode_chain_des(hammer2_inode_t *ip);
1546 int hammer2_inode_chain_sync(hammer2_inode_t *ip);
1547 int hammer2_inode_chain_flush(hammer2_inode_t *ip, int flags);
1548 int hammer2_inode_unlink_finisher(hammer2_inode_t *ip, int isopen);
1549 int hammer2_dirent_create(hammer2_inode_t *dip, const char *name,
1550                         size_t name_len, hammer2_key_t inum, uint8_t type);
1551
1552 /*
1553  * hammer2_chain.c
1554  */
1555 void hammer2_voldata_lock(hammer2_dev_t *hmp);
1556 void hammer2_voldata_unlock(hammer2_dev_t *hmp);
1557 void hammer2_voldata_modify(hammer2_dev_t *hmp);
1558 hammer2_chain_t *hammer2_chain_alloc(hammer2_dev_t *hmp,
1559                                 hammer2_pfs_t *pmp,
1560                                 hammer2_blockref_t *bref);
1561 void hammer2_chain_core_init(hammer2_chain_t *chain);
1562 void hammer2_chain_ref(hammer2_chain_t *chain);
1563 void hammer2_chain_ref_hold(hammer2_chain_t *chain);
1564 void hammer2_chain_drop(hammer2_chain_t *chain);
1565 void hammer2_chain_drop_unhold(hammer2_chain_t *chain);
1566 int hammer2_chain_lock(hammer2_chain_t *chain, int how);
1567 void hammer2_chain_lock_unhold(hammer2_chain_t *chain, int how);
1568 void hammer2_chain_load_data(hammer2_chain_t *chain);
1569 const hammer2_media_data_t *hammer2_chain_rdata(hammer2_chain_t *chain);
1570 hammer2_media_data_t *hammer2_chain_wdata(hammer2_chain_t *chain);
1571
1572 int hammer2_chain_inode_find(hammer2_pfs_t *pmp, hammer2_key_t inum,
1573                                 int clindex, int flags,
1574                                 hammer2_chain_t **parentp,
1575                                 hammer2_chain_t **chainp);
1576 int hammer2_chain_modify(hammer2_chain_t *chain, hammer2_tid_t mtid,
1577                                 hammer2_off_t dedup_off, int flags);
1578 int hammer2_chain_modify_ip(hammer2_inode_t *ip, hammer2_chain_t *chain,
1579                                 hammer2_tid_t mtid, int flags);
1580 int hammer2_chain_resize(hammer2_chain_t *chain,
1581                                 hammer2_tid_t mtid, hammer2_off_t dedup_off,
1582                                 int nradix, int flags);
1583 void hammer2_chain_unlock(hammer2_chain_t *chain);
1584 void hammer2_chain_unlock_hold(hammer2_chain_t *chain);
1585 void hammer2_chain_wait(hammer2_chain_t *chain);
1586 hammer2_chain_t *hammer2_chain_get(hammer2_chain_t *parent, int generation,
1587                                 hammer2_blockref_t *bref, int how);
1588 hammer2_chain_t *hammer2_chain_lookup_init(hammer2_chain_t *parent, int flags);
1589 void hammer2_chain_lookup_done(hammer2_chain_t *parent);
1590 hammer2_chain_t *hammer2_chain_getparent(hammer2_chain_t *chain, int flags);
1591 hammer2_chain_t *hammer2_chain_repparent(hammer2_chain_t **chainp, int flags);
1592 hammer2_chain_t *hammer2_chain_lookup(hammer2_chain_t **parentp,
1593                                 hammer2_key_t *key_nextp,
1594                                 hammer2_key_t key_beg, hammer2_key_t key_end,
1595                                 int *errorp, int flags);
1596 hammer2_chain_t *hammer2_chain_next(hammer2_chain_t **parentp,
1597                                 hammer2_chain_t *chain,
1598                                 hammer2_key_t *key_nextp,
1599                                 hammer2_key_t key_beg, hammer2_key_t key_end,
1600                                 int *errorp, int flags);
1601 int hammer2_chain_scan(hammer2_chain_t *parent,
1602                                 hammer2_chain_t **chainp,
1603                                 hammer2_blockref_t *bref,
1604                                 int *firstp, int flags);
1605
1606 int hammer2_chain_create(hammer2_chain_t **parentp, hammer2_chain_t **chainp,
1607                                 hammer2_dev_t *hmp, hammer2_pfs_t *pmp,
1608                                 int methods, hammer2_key_t key, int keybits,
1609                                 int type, size_t bytes, hammer2_tid_t mtid,
1610                                 hammer2_off_t dedup_off, int flags);
1611 void hammer2_chain_rename(hammer2_chain_t **parentp,
1612                                 hammer2_chain_t *chain,
1613                                 hammer2_tid_t mtid, int flags);
1614 int hammer2_chain_delete(hammer2_chain_t *parent, hammer2_chain_t *chain,
1615                                 hammer2_tid_t mtid, int flags);
1616 int hammer2_chain_indirect_maintenance(hammer2_chain_t *parent,
1617                                 hammer2_chain_t *chain);
1618 void hammer2_chain_setflush(hammer2_chain_t *chain);
1619 void hammer2_chain_countbrefs(hammer2_chain_t *chain,
1620                                 hammer2_blockref_t *base, int count);
1621 hammer2_chain_t *hammer2_chain_bulksnap(hammer2_dev_t *hmp);
1622 void hammer2_chain_bulkdrop(hammer2_chain_t *copy);
1623
1624 void hammer2_chain_setcheck(hammer2_chain_t *chain, void *bdata);
1625 int hammer2_chain_testcheck(hammer2_chain_t *chain, void *bdata);
1626 int hammer2_chain_dirent_test(hammer2_chain_t *chain, const char *name,
1627                                 size_t name_len);
1628
1629 void hammer2_pfs_memory_wait(hammer2_inode_t *ip, int always_moderate);
1630 void hammer2_pfs_memory_inc(hammer2_pfs_t *pmp);
1631 void hammer2_pfs_memory_wakeup(hammer2_pfs_t *pmp);
1632
1633 void hammer2_base_delete(hammer2_chain_t *parent,
1634                                 hammer2_blockref_t *base, int count,
1635                                 hammer2_chain_t *chain,
1636                                 hammer2_blockref_t *obref);
1637 void hammer2_base_insert(hammer2_chain_t *parent,
1638                                 hammer2_blockref_t *base, int count,
1639                                 hammer2_chain_t *chain,
1640                                 hammer2_blockref_t *elm);
1641
1642 /*
1643  * hammer2_flush.c
1644  */
1645 int hammer2_flush(hammer2_chain_t *chain, int istop);
1646 void hammer2_delayed_flush(hammer2_chain_t *chain);
1647
1648 /*
1649  * hammer2_trans.c
1650  */
1651 void hammer2_trans_init(hammer2_pfs_t *pmp, uint32_t flags);
1652 void hammer2_trans_setflags(hammer2_pfs_t *pmp, uint32_t flags);
1653 void hammer2_trans_clearflags(hammer2_pfs_t *pmp, uint32_t flags);
1654 hammer2_tid_t hammer2_trans_sub(hammer2_pfs_t *pmp);
1655 void hammer2_trans_done(hammer2_pfs_t *pmp, uint32_t flags);
1656 hammer2_tid_t hammer2_trans_newinum(hammer2_pfs_t *pmp);
1657 void hammer2_trans_assert_strategy(hammer2_pfs_t *pmp);
1658 void hammer2_dedup_record(hammer2_chain_t *chain, hammer2_io_t *dio,
1659                                 const char *data);
1660
1661 /*
1662  * hammer2_ioctl.c
1663  */
1664 int hammer2_ioctl(hammer2_inode_t *ip, u_long com, void *data,
1665                                 int fflag, struct ucred *cred);
1666
1667 /*
1668  * hammer2_io.c
1669  */
1670 void hammer2_io_putblk(hammer2_io_t **diop);
1671 void hammer2_io_inval(hammer2_io_t *dio, hammer2_off_t data_off, u_int bytes);
1672 void hammer2_io_cleanup(hammer2_dev_t *hmp, struct hammer2_io_tree *tree);
1673 char *hammer2_io_data(hammer2_io_t *dio, off_t lbase);
1674 void hammer2_io_bkvasync(hammer2_io_t *dio);
1675 hammer2_io_t *hammer2_io_getblk(hammer2_dev_t *hmp, int btype, off_t lbase,
1676                                 int lsize, int op);
1677 void hammer2_io_dedup_set(hammer2_dev_t *hmp, hammer2_blockref_t *bref);
1678 void hammer2_io_dedup_delete(hammer2_dev_t *hmp, uint8_t btype,
1679                                 hammer2_off_t data_off, u_int bytes);
1680 void hammer2_io_dedup_assert(hammer2_dev_t *hmp, hammer2_off_t data_off,
1681                                 u_int bytes);
1682 void hammer2_io_callback(struct bio *bio);
1683 int hammer2_io_new(hammer2_dev_t *hmp, int btype, off_t lbase, int lsize,
1684                                 hammer2_io_t **diop);
1685 int hammer2_io_newnz(hammer2_dev_t *hmp, int btype, off_t lbase, int lsize,
1686                                 hammer2_io_t **diop);
1687 int hammer2_io_bread(hammer2_dev_t *hmp, int btype, off_t lbase, int lsize,
1688                                 hammer2_io_t **diop);
1689 hammer2_io_t *hammer2_io_getquick(hammer2_dev_t *hmp, off_t lbase, int lsize);
1690 void hammer2_io_bawrite(hammer2_io_t **diop);
1691 void hammer2_io_bdwrite(hammer2_io_t **diop);
1692 int hammer2_io_bwrite(hammer2_io_t **diop);
1693 void hammer2_io_setdirty(hammer2_io_t *dio);
1694 void hammer2_io_brelse(hammer2_io_t **diop);
1695 void hammer2_io_bqrelse(hammer2_io_t **diop);
1696 void hammer2_io_ref(hammer2_io_t *dio);
1697
1698 /*
1699  * hammer2_thread.c
1700  */
1701 void hammer2_thr_signal(hammer2_thread_t *thr, uint32_t flags);
1702 void hammer2_thr_signal2(hammer2_thread_t *thr,
1703                         uint32_t pflags, uint32_t nflags);
1704 void hammer2_thr_wait(hammer2_thread_t *thr, uint32_t flags);
1705 void hammer2_thr_wait_neg(hammer2_thread_t *thr, uint32_t flags);
1706 int hammer2_thr_wait_any(hammer2_thread_t *thr, uint32_t flags, int timo);
1707 void hammer2_thr_create(hammer2_thread_t *thr,
1708                         hammer2_pfs_t *pmp, hammer2_dev_t *hmp,
1709                         const char *id, int clindex, int repidx,
1710                         void (*func)(void *arg));
1711 void hammer2_thr_delete(hammer2_thread_t *thr);
1712 void hammer2_thr_remaster(hammer2_thread_t *thr);
1713 void hammer2_thr_freeze_async(hammer2_thread_t *thr);
1714 void hammer2_thr_freeze(hammer2_thread_t *thr);
1715 void hammer2_thr_unfreeze(hammer2_thread_t *thr);
1716 int hammer2_thr_break(hammer2_thread_t *thr);
1717 void hammer2_primary_xops_thread(void *arg);
1718
1719 /*
1720  * hammer2_thread.c (XOP API)
1721  */
1722 void hammer2_xop_group_init(hammer2_pfs_t *pmp, hammer2_xop_group_t *xgrp);
1723 void *hammer2_xop_alloc(hammer2_inode_t *ip, int flags);
1724 void hammer2_xop_setname(hammer2_xop_head_t *xop,
1725                                 const char *name, size_t name_len);
1726 void hammer2_xop_setname2(hammer2_xop_head_t *xop,
1727                                 const char *name, size_t name_len);
1728 size_t hammer2_xop_setname_inum(hammer2_xop_head_t *xop, hammer2_key_t inum);
1729 void hammer2_xop_setip2(hammer2_xop_head_t *xop, hammer2_inode_t *ip2);
1730 void hammer2_xop_setip3(hammer2_xop_head_t *xop, hammer2_inode_t *ip3);
1731 void hammer2_xop_reinit(hammer2_xop_head_t *xop);
1732 void hammer2_xop_helper_create(hammer2_pfs_t *pmp);
1733 void hammer2_xop_helper_cleanup(hammer2_pfs_t *pmp);
1734 void hammer2_xop_start(hammer2_xop_head_t *xop, hammer2_xop_desc_t *desc);
1735 void hammer2_xop_start_except(hammer2_xop_head_t *xop, hammer2_xop_desc_t *desc,
1736                                 int notidx);
1737 int hammer2_xop_collect(hammer2_xop_head_t *xop, int flags);
1738 void hammer2_xop_retire(hammer2_xop_head_t *xop, uint64_t mask);
1739 int hammer2_xop_active(hammer2_xop_head_t *xop);
1740 int hammer2_xop_feed(hammer2_xop_head_t *xop, hammer2_chain_t *chain,
1741                                 int clindex, int error);
1742
1743 /*
1744  * hammer2_synchro.c
1745  */
1746 void hammer2_primary_sync_thread(void *arg);
1747
1748 /*
1749  * XOP backends in hammer2_xops.c, primarily for VNOPS.  Other XOP backends
1750  * may be integrated into other source files.
1751  */
1752 void hammer2_xop_ipcluster(hammer2_xop_t *xop, void *scratch, int clindex);
1753 void hammer2_xop_readdir(hammer2_xop_t *xop, void *scratch, int clindex);
1754 void hammer2_xop_nresolve(hammer2_xop_t *xop, void *scratch, int clindex);
1755 void hammer2_xop_unlink(hammer2_xop_t *xop, void *scratch, int clindex);
1756 void hammer2_xop_nrename(hammer2_xop_t *xop, void *scratch, int clindex);
1757 void hammer2_xop_scanlhc(hammer2_xop_t *xop, void *scratch, int clindex);
1758 void hammer2_xop_scanall(hammer2_xop_t *xop, void *scratch, int clindex);
1759 void hammer2_xop_lookup(hammer2_xop_t *xop, void *scratch, int clindex);
1760 void hammer2_xop_delete(hammer2_xop_t *xop, void *scratch, int clindex);
1761 void hammer2_xop_inode_mkdirent(hammer2_xop_t *xop, void *scratch, int clindex);
1762 void hammer2_xop_inode_create(hammer2_xop_t *xop, void *scratch, int clindex);
1763 void hammer2_xop_inode_create_det(hammer2_xop_t *xop,
1764                                 void *scratch, int clindex);
1765 void hammer2_xop_inode_create_ins(hammer2_xop_t *xop,
1766                                 void *scratch, int clindex);
1767 void hammer2_xop_inode_destroy(hammer2_xop_t *xop, void *scratch, int clindex);
1768 void hammer2_xop_inode_chain_sync(hammer2_xop_t *xop, void *scratch,
1769                                 int clindex);
1770 void hammer2_xop_inode_unlinkall(hammer2_xop_t *xop, void *scratch,
1771                                 int clindex);
1772 void hammer2_xop_inode_connect(hammer2_xop_t *xop, void *scratch, int clindex);
1773 void hammer2_xop_inode_flush(hammer2_xop_t *xop, void *scratch, int clindex);
1774 void hammer2_xop_strategy_read(hammer2_xop_t *xop, void *scratch, int clindex);
1775 void hammer2_xop_strategy_write(hammer2_xop_t *xop, void *scratch, int clindex);
1776
1777 void hammer2_dmsg_ipcluster(hammer2_xop_t *xop, void *scratch, int clindex);
1778 void hammer2_dmsg_readdir(hammer2_xop_t *xop, void *scratch, int clindex);
1779 void hammer2_dmsg_nresolve(hammer2_xop_t *xop, void *scratch, int clindex);
1780 void hammer2_dmsg_unlink(hammer2_xop_t *xop, void *scratch, int clindex);
1781 void hammer2_dmsg_nrename(hammer2_xop_t *xop, void *scratch, int clindex);
1782 void hammer2_dmsg_scanlhc(hammer2_xop_t *xop, void *scratch, int clindex);
1783 void hammer2_dmsg_scanall(hammer2_xop_t *xop, void *scratch, int clindex);
1784 void hammer2_dmsg_lookup(hammer2_xop_t *xop, void *scratch, int clindex);
1785 void hammer2_dmsg_inode_mkdirent(hammer2_xop_t *xop, void *scratch,
1786                                 int clindex);
1787 void hammer2_dmsg_inode_create(hammer2_xop_t *xop, void *scratch, int clindex);
1788 void hammer2_dmsg_inode_destroy(hammer2_xop_t *xop, void *scratch, int clindex);
1789 void hammer2_dmsg_inode_chain_sync(hammer2_xop_t *xop, void *scratch,
1790                                 int clindex);
1791 void hammer2_dmsg_inode_unlinkall(hammer2_xop_t *xop, void *scratch,
1792                                 int clindex);
1793 void hammer2_dmsg_inode_connect(hammer2_xop_t *xop, void *scratch, int clindex);
1794 void hammer2_dmsg_inode_flush(hammer2_xop_t *xop, void *scratch, int clindex);
1795 void hammer2_dmsg_strategy_read(hammer2_xop_t *xop, void *scratch, int clindex);
1796 void hammer2_dmsg_strategy_write(hammer2_xop_t *xop, void *scratch,
1797                                 int clindex);
1798
1799 void hammer2_rmsg_ipcluster(hammer2_xop_t *xop, void *scratch, int clindex);
1800 void hammer2_rmsg_readdir(hammer2_xop_t *xop, void *scratch, int clindex);
1801 void hammer2_rmsg_nresolve(hammer2_xop_t *xop, void *scratch, int clindex);
1802 void hammer2_rmsg_unlink(hammer2_xop_t *xop, void *scratch, int clindex);
1803 void hammer2_rmsg_nrename(hammer2_xop_t *xop, void *scratch, int clindex);
1804 void hammer2_rmsg_scanlhc(hammer2_xop_t *xop, void *scratch, int clindex);
1805 void hammer2_rmsg_scanall(hammer2_xop_t *xop, void *scratch, int clindex);
1806 void hammer2_rmsg_lookup(hammer2_xop_t *xop, void *scratch, int clindex);
1807 void hammer2_rmsg_inode_mkdirent(hammer2_xop_t *xop, void *scratch,
1808                                 int clindex);
1809 void hammer2_rmsg_inode_create(hammer2_xop_t *xop, void *scratch, int clindex);
1810 void hammer2_rmsg_inode_destroy(hammer2_xop_t *xop, void *scratch, int clindex);
1811 void hammer2_rmsg_inode_chain_sync(hammer2_xop_t *xop, void *scratch,
1812                                 int clindex);
1813 void hammer2_rmsg_inode_unlinkall(hammer2_xop_t *xop, void *scratch,
1814                                 int clindex);
1815 void hammer2_rmsg_inode_connect(hammer2_xop_t *xop, void *scratch, int clindex);
1816 void hammer2_rmsg_inode_flush(hammer2_xop_t *xop, void *scratch, int clindex);
1817 void hammer2_rmsg_strategy_read(hammer2_xop_t *xop, void *scratch, int clindex);
1818 void hammer2_rmsg_strategy_write(hammer2_xop_t *xop, void *scratch,
1819                                 int clindex);
1820
1821 extern hammer2_xop_desc_t hammer2_ipcluster_desc;
1822 extern hammer2_xop_desc_t hammer2_readdir_desc;
1823 extern hammer2_xop_desc_t hammer2_nresolve_desc;
1824 extern hammer2_xop_desc_t hammer2_unlink_desc;
1825 extern hammer2_xop_desc_t hammer2_nrename_desc;
1826 extern hammer2_xop_desc_t hammer2_scanlhc_desc;
1827 extern hammer2_xop_desc_t hammer2_scanall_desc;
1828 extern hammer2_xop_desc_t hammer2_lookup_desc;
1829 extern hammer2_xop_desc_t hammer2_delete_desc;
1830 extern hammer2_xop_desc_t hammer2_inode_mkdirent_desc;
1831 extern hammer2_xop_desc_t hammer2_inode_create_desc;
1832 extern hammer2_xop_desc_t hammer2_inode_create_det_desc;
1833 extern hammer2_xop_desc_t hammer2_inode_create_ins_desc;
1834 extern hammer2_xop_desc_t hammer2_inode_destroy_desc;
1835 extern hammer2_xop_desc_t hammer2_inode_chain_sync_desc;
1836 extern hammer2_xop_desc_t hammer2_inode_unlinkall_desc;
1837 extern hammer2_xop_desc_t hammer2_inode_connect_desc;
1838 extern hammer2_xop_desc_t hammer2_inode_flush_desc;
1839 extern hammer2_xop_desc_t hammer2_strategy_read_desc;
1840 extern hammer2_xop_desc_t hammer2_strategy_write_desc;
1841
1842 /*
1843  * hammer2_msgops.c
1844  */
1845 int hammer2_msg_dbg_rcvmsg(kdmsg_msg_t *msg);
1846 int hammer2_msg_adhoc_input(kdmsg_msg_t *msg);
1847
1848 /*
1849  * hammer2_vfsops.c
1850  */
1851 void hammer2_volconf_update(hammer2_dev_t *hmp, int index);
1852 void hammer2_dump_chain(hammer2_chain_t *chain, int tab, int *countp, char pfx,
1853                                 u_int flags);
1854 int hammer2_vfs_sync(struct mount *mp, int waitflags);
1855 int hammer2_vfs_sync_pmp(hammer2_pfs_t *pmp, int waitfor);
1856 int hammer2_vfs_enospace(hammer2_inode_t *ip, off_t bytes, struct ucred *cred);
1857
1858 hammer2_pfs_t *hammer2_pfsalloc(hammer2_chain_t *chain,
1859                                 const hammer2_inode_data_t *ripdata,
1860                                 hammer2_tid_t modify_tid,
1861                                 hammer2_dev_t *force_local);
1862 void hammer2_pfsdealloc(hammer2_pfs_t *pmp, int clindex, int destroying);
1863 int hammer2_vfs_vget(struct mount *mp, struct vnode *dvp,
1864                                 ino_t ino, struct vnode **vpp);
1865
1866 void hammer2_lwinprog_ref(hammer2_pfs_t *pmp);
1867 void hammer2_lwinprog_drop(hammer2_pfs_t *pmp);
1868 void hammer2_lwinprog_wait(hammer2_pfs_t *pmp, int pipe);
1869
1870 /*
1871  * hammer2_freemap.c
1872  */
1873 int hammer2_freemap_alloc(hammer2_chain_t *chain, size_t bytes);
1874 void hammer2_freemap_adjust(hammer2_dev_t *hmp,
1875                                 hammer2_blockref_t *bref, int how);
1876
1877 /*
1878  * hammer2_cluster.c
1879  */
1880 uint8_t hammer2_cluster_type(hammer2_cluster_t *cluster);
1881 void hammer2_cluster_bref(hammer2_cluster_t *cluster, hammer2_blockref_t *bref);
1882 hammer2_cluster_t *hammer2_cluster_alloc(hammer2_pfs_t *pmp,
1883                                 hammer2_blockref_t *bref);
1884 void hammer2_cluster_ref(hammer2_cluster_t *cluster);
1885 void hammer2_cluster_drop(hammer2_cluster_t *cluster);
1886 void hammer2_cluster_lock(hammer2_cluster_t *cluster, int how);
1887 int hammer2_cluster_check(hammer2_cluster_t *cluster, hammer2_key_t lokey,
1888                         int flags);
1889 void hammer2_cluster_resolve(hammer2_cluster_t *cluster);
1890 void hammer2_cluster_forcegood(hammer2_cluster_t *cluster);
1891 void hammer2_cluster_unlock(hammer2_cluster_t *cluster);
1892
1893 void hammer2_bulkfree_init(hammer2_dev_t *hmp);
1894 void hammer2_bulkfree_uninit(hammer2_dev_t *hmp);
1895 int hammer2_bulkfree_pass(hammer2_dev_t *hmp, hammer2_chain_t *vchain,
1896                         struct hammer2_ioc_bulkfree *bfi);
1897 void hammer2_dummy_xop_from_chain(hammer2_xop_head_t *xop,
1898                         hammer2_chain_t *chain);
1899
1900 /*
1901  * hammer2_iocom.c
1902  */
1903 void hammer2_iocom_init(hammer2_dev_t *hmp);
1904 void hammer2_iocom_uninit(hammer2_dev_t *hmp);
1905 void hammer2_cluster_reconnect(hammer2_dev_t *hmp, struct file *fp);
1906
1907 /*
1908  * hammer2_strategy.c
1909  */
1910 int hammer2_vop_strategy(struct vop_strategy_args *ap);
1911 int hammer2_vop_bmap(struct vop_bmap_args *ap);
1912 void hammer2_write_thread(void *arg);
1913 void hammer2_bioq_sync(hammer2_pfs_t *pmp);
1914 void hammer2_dedup_clear(hammer2_dev_t *hmp);
1915
1916 /*
1917  * More complex inlines
1918  */
1919 static __inline
1920 const hammer2_media_data_t *
1921 hammer2_xop_gdata(hammer2_xop_head_t *xop)
1922 {
1923         hammer2_chain_t *focus;
1924         const void *data;
1925
1926         focus = xop->cluster.focus;
1927         if (focus->dio) {
1928                 lockmgr(&focus->diolk, LK_SHARED);
1929                 if ((xop->focus_dio = focus->dio) != NULL) {
1930                         hammer2_io_ref(xop->focus_dio);
1931                         hammer2_io_bkvasync(xop->focus_dio);
1932                 }
1933                 data = focus->data;
1934                 lockmgr(&focus->diolk, LK_RELEASE);
1935         } else {
1936                 data = focus->data;
1937         }
1938
1939         return data;
1940 }
1941
1942 static __inline
1943 void
1944 hammer2_xop_pdata(hammer2_xop_head_t *xop)
1945 {
1946         if (xop->focus_dio)
1947                 hammer2_io_putblk(&xop->focus_dio);
1948 }
1949
1950 #endif /* !_KERNEL */
1951 #endif /* !_VFS_HAMMER2_HAMMER2_H_ */