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