sys/vfs/hammer2/hammer2.h

   1 /*
   2  * Copyright (c) 2011-2015 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 #include <sys/param.h>
  66 #include <sys/types.h>
  67 #include <sys/kernel.h>
  68 #include <sys/conf.h>
  69 #include <sys/systm.h>
  70 #include <sys/tree.h>
  71 #include <sys/malloc.h>
  72 #include <sys/mount.h>
  73 #include <sys/vnode.h>
  74 #include <sys/proc.h>
  75 #include <sys/mountctl.h>
  76 #include <sys/priv.h>
  77 #include <sys/stat.h>
  78 #include <sys/thread.h>
  79 #include <sys/globaldata.h>
  80 #include <sys/lockf.h>
  81 #include <sys/buf.h>
  82 #include <sys/queue.h>
  83 #include <sys/limits.h>
  84 #include <sys/dmsg.h>
  85 #include <sys/mutex.h>
  86 #include <sys/kern_syscall.h>
  87
  88 #include <sys/signal2.h>
  89 #include <sys/buf2.h>
  90 #include <sys/mutex2.h>
  91 #include <sys/thread2.h>
  92
  93 #include "hammer2_disk.h"
  94 #include "hammer2_mount.h"
  95 #include "hammer2_ioctl.h"
  96
  97 struct hammer2_io;
  98 struct hammer2_iocb;
  99 struct hammer2_chain;
 100 struct hammer2_cluster;
 101 struct hammer2_inode;
 102 struct hammer2_dev;
 103 struct hammer2_pfs;
 104 struct hammer2_span;
 105 struct hammer2_state;
 106 struct hammer2_msg;
 107
 108 /*
 109  * Mutex and lock shims.  Hammer2 requires support for asynchronous and
 110  * abortable locks, and both exclusive and shared spinlocks.  Normal
 111  * synchronous non-abortable locks can be substituted for spinlocks.
 112  */
 113 typedef mtx_t                           hammer2_mtx_t;
 114 typedef mtx_link_t                      hammer2_mtx_link_t;
 115 typedef mtx_state_t                     hammer2_mtx_state_t;
 116
 117 typedef struct spinlock                 hammer2_spin_t;
 118
 119 #define hammer2_mtx_ex                  mtx_lock_ex_quick
 120 #define hammer2_mtx_sh                  mtx_lock_sh_quick
 121 #define hammer2_mtx_unlock              mtx_unlock
 122 #define hammer2_mtx_owned               mtx_owned
 123 #define hammer2_mtx_init                mtx_init
 124 #define hammer2_mtx_temp_release        mtx_lock_temp_release
 125 #define hammer2_mtx_temp_restore        mtx_lock_temp_restore
 126 #define hammer2_mtx_refs                mtx_lockrefs
 127
 128 #define hammer2_spin_init               spin_init
 129 #define hammer2_spin_sh                 spin_lock_shared
 130 #define hammer2_spin_ex                 spin_lock
 131 #define hammer2_spin_unsh               spin_unlock_shared
 132 #define hammer2_spin_unex               spin_unlock
 133
 134 /*
 135  * General lock support
 136  */
 137 static __inline
 138 int
 139 hammer2_mtx_upgrade(hammer2_mtx_t *mtx)
 140 {
 141         int wasexclusive;
 142
 143         if (mtx_islocked_ex(mtx)) {
 144                 wasexclusive = 1;
 145         } else {
 146                 mtx_unlock(mtx);
 147                 mtx_lock_ex_quick(mtx);
 148                 wasexclusive = 0;
 149         }
 150         return wasexclusive;
 151 }
 152
 153 /*
 154  * Downgrade an inode lock from exclusive to shared only if the inode
 155  * lock was previously shared.  If the inode lock was previously exclusive,
 156  * this is a NOP.
 157  */
 158 static __inline
 159 void
 160 hammer2_mtx_downgrade(hammer2_mtx_t *mtx, int wasexclusive)
 161 {
 162         if (wasexclusive == 0)
 163                 mtx_downgrade(mtx);
 164 }
 165
 166 /*
 167  * The xid tracks internal transactional updates.
 168  *
 169  * XXX fix-me, really needs to be 64-bits
 170  */
 171 typedef uint32_t hammer2_xid_t;
 172
 173 #define HAMMER2_XID_MIN 0x00000000U
 174 #define HAMMER2_XID_MAX 0x7FFFFFFFU
 175
 176 /*
 177  * The chain structure tracks a portion of the media topology from the
 178  * root (volume) down.  Chains represent volumes, inodes, indirect blocks,
 179  * data blocks, and freemap nodes and leafs.
 180  *
 181  * The chain structure utilizes a simple singly-homed topology and the
 182  * chain's in-memory topology will move around as the chains do, due mainly
 183  * to renames and indirect block creation.
 184  *
 185  * Block Table Updates
 186  *
 187  *      Block table updates for insertions and updates are delayed until the
 188  *      flush.  This allows us to avoid having to modify the parent chain
 189  *      all the way to the root.
 190  *
 191  *      Block table deletions are performed immediately (modifying the parent
 192  *      in the process) because the flush code uses the chain structure to
 193  *      track delayed updates and the chain will be (likely) gone or moved to
 194  *      another location in the topology after a deletion.
 195  *
 196  *      A prior iteration of the code tried to keep the relationship intact
 197  *      on deletes by doing a delete-duplicate operation on the chain, but
 198  *      it added way too much complexity to the codebase.
 199  *
 200  * Flush Synchronization
 201  *
 202  *      The flush code must flush modified chains bottom-up.  Because chain
 203  *      structures can shift around and are NOT topologically stable,
 204  *      modified chains are independently indexed for the flush.  As the flush
 205  *      runs it modifies (or further modifies) and updates the parents,
 206  *      propagating the flush all the way to the volume root.
 207  *
 208  *      Modifying front-end operations can occur during a flush but will block
 209  *      in two cases: (1) when the front-end tries to operate on the inode
 210  *      currently in the midst of being flushed and (2) if the front-end
 211  *      crosses an inode currently being flushed (such as during a rename).
 212  *      So, for example, if you rename directory "x" to "a/b/c/d/e/f/g/x" and
 213  *      the flusher is currently working on "a/b/c", the rename will block
 214  *      temporarily in order to ensure that "x" exists in one place or the
 215  *      other.
 216  *
 217  *      Meta-data statistics are updated by the flusher.  The front-end will
 218  *      make estimates but meta-data must be fully synchronized only during a
 219  *      flush in order to ensure that it remains correct across a crash.
 220  *
 221  *      Multiple flush synchronizations can theoretically be in-flight at the
 222  *      same time but the implementation is not coded to handle the case and
 223  *      currently serializes them.
 224  *
 225  * Snapshots:
 226  *
 227  *      Snapshots currently require the subdirectory tree being snapshotted
 228  *      to be flushed.  The snapshot then creates a new super-root inode which
 229  *      copies the flushed blockdata of the directory or file that was
 230  *      snapshotted.
 231  *
 232  * RBTREE NOTES:
 233  *
 234  *      - Note that the radix tree runs in powers of 2 only so sub-trees
 235  *        cannot straddle edges.
 236  */
 237 RB_HEAD(hammer2_chain_tree, hammer2_chain);
 238 TAILQ_HEAD(h2_flush_list, hammer2_chain);
 239 TAILQ_HEAD(h2_core_list, hammer2_chain);
 240 TAILQ_HEAD(h2_iocb_list, hammer2_iocb);
 241
 242 #define CHAIN_CORE_DELETE_BMAP_ENTRIES  \
 243         (HAMMER2_PBUFSIZE / sizeof(hammer2_blockref_t) / sizeof(uint32_t))
 244
 245 struct hammer2_chain_core {
 246         hammer2_mtx_t   lock;
 247         hammer2_spin_t  spin;
 248         struct hammer2_chain_tree rbtree; /* sub-chains */
 249         int             live_zero;      /* blockref array opt */
 250         u_int           flags;
 251         u_int           live_count;     /* live (not deleted) chains in tree */
 252         u_int           chain_count;    /* live + deleted chains under core */
 253         int             generation;     /* generation number (inserts only) */
 254 };
 255
 256 typedef struct hammer2_chain_core hammer2_chain_core_t;
 257
 258 #define HAMMER2_CORE_UNUSED0001         0x0001
 259 #define HAMMER2_CORE_COUNTEDBREFS       0x0002
 260
 261 RB_HEAD(hammer2_io_tree, hammer2_io);
 262
 263 /*
 264  * IOCB - IO callback (into chain, cluster, or manual request)
 265  */
 266 struct hammer2_iocb {
 267         TAILQ_ENTRY(hammer2_iocb) entry;
 268         void (*callback)(struct hammer2_iocb *iocb);
 269         struct hammer2_io       *dio;
 270         struct hammer2_cluster  *cluster;
 271         struct hammer2_chain    *chain;
 272         void                    *ptr;
 273         off_t                   lbase;
 274         int                     lsize;
 275         uint32_t                flags;
 276         int                     error;
 277 };
 278
 279 typedef struct hammer2_iocb hammer2_iocb_t;
 280
 281 #define HAMMER2_IOCB_INTERLOCK  0x00000001
 282 #define HAMMER2_IOCB_ONQ        0x00000002
 283 #define HAMMER2_IOCB_DONE       0x00000004
 284 #define HAMMER2_IOCB_INPROG     0x00000008
 285 #define HAMMER2_IOCB_UNUSED10   0x00000010
 286 #define HAMMER2_IOCB_QUICK      0x00010000
 287 #define HAMMER2_IOCB_ZERO       0x00020000
 288 #define HAMMER2_IOCB_READ       0x00040000
 289 #define HAMMER2_IOCB_WAKEUP     0x00080000
 290
 291 /*
 292  * DIO - Management structure wrapping system buffer cache.
 293  *
 294  *       Used for multiple purposes including concurrent management
 295  *       if small requests by chains into larger DIOs.
 296  */
 297 struct hammer2_io {
 298         RB_ENTRY(hammer2_io) rbnode;    /* indexed by device offset */
 299         struct h2_iocb_list iocbq;
 300         struct spinlock spin;
 301         struct hammer2_dev *hmp;
 302         struct buf      *bp;
 303         off_t           pbase;
 304         int             psize;
 305         int             refs;
 306         int             act;                    /* activity */
 307 };
 308
 309 typedef struct hammer2_io hammer2_io_t;
 310
 311 #define HAMMER2_DIO_INPROG      0x80000000      /* bio in progress */
 312 #define HAMMER2_DIO_GOOD        0x40000000      /* dio->bp is stable */
 313 #define HAMMER2_DIO_WAITING     0x20000000      /* (old) */
 314 #define HAMMER2_DIO_DIRTY       0x10000000      /* flush on last drop */
 315
 316 #define HAMMER2_DIO_MASK        0x0FFFFFFF
 317
 318 /*
 319  * Primary chain structure keeps track of the topology in-memory.
 320  */
 321 struct hammer2_chain {
 322         hammer2_chain_core_t    core;
 323         RB_ENTRY(hammer2_chain) rbnode;         /* live chain(s) */
 324         hammer2_blockref_t      bref;
 325         struct hammer2_chain    *parent;
 326         struct hammer2_state    *state;         /* if active cache msg */
 327         struct hammer2_dev      *hmp;
 328         struct hammer2_pfs      *pmp;           /* A PFS or super-root (spmp) */
 329
 330         hammer2_xid_t   flush_xid;              /* flush sequencing */
 331         hammer2_key_t   data_count;             /* delta's to apply */
 332         hammer2_key_t   inode_count;            /* delta's to apply */
 333         hammer2_key_t   data_count_up;          /* delta's to apply */
 334         hammer2_key_t   inode_count_up;         /* delta's to apply */
 335         hammer2_io_t    *dio;                   /* physical data buffer */
 336         u_int           bytes;                  /* physical data size */
 337         u_int           flags;
 338         u_int           refs;
 339         u_int           lockcnt;
 340         int             error;                  /* on-lock data error state */
 341
 342         hammer2_media_data_t *data;             /* data pointer shortcut */
 343         TAILQ_ENTRY(hammer2_chain) flush_node;  /* flush list */
 344 };
 345
 346 typedef struct hammer2_chain hammer2_chain_t;
 347
 348 int hammer2_chain_cmp(hammer2_chain_t *chain1, hammer2_chain_t *chain2);
 349 RB_PROTOTYPE(hammer2_chain_tree, hammer2_chain, rbnode, hammer2_chain_cmp);
 350
 351 /*
 352  * Special notes on flags:
 353  *
 354  * INITIAL      - This flag allows a chain to be created and for storage to
 355  *                be allocated without having to immediately instantiate the
 356  *                related buffer.  The data is assumed to be all-zeros.  It
 357  *                is primarily used for indirect blocks.
 358  *
 359  * MODIFIED     - The chain's media data has been modified.
 360  *
 361  * UPDATE       - Chain might not be modified but parent blocktable needs update
 362  *
 363  * FICTITIOUS   - Faked chain as a placeholder for an error condition.  This
 364  *                chain is unsuitable for I/O.
 365  *
 366  * BMAPPED      - Indicates that the chain is present in the parent blockmap.
 367  *
 368  * BMAPUPD      - Indicates that the chain is present but needs to be updated
 369  *                in the parent blockmap.
 370  */
 371 #define HAMMER2_CHAIN_MODIFIED          0x00000001      /* dirty chain data */
 372 #define HAMMER2_CHAIN_ALLOCATED         0x00000002      /* kmalloc'd chain */
 373 #define HAMMER2_CHAIN_DESTROY           0x00000004
 374 #define HAMMER2_CHAIN_UNLINKED          0x00000008      /* unlinked file */
 375 #define HAMMER2_CHAIN_DELETED           0x00000010      /* deleted chain */
 376 #define HAMMER2_CHAIN_INITIAL           0x00000020      /* initial create */
 377 #define HAMMER2_CHAIN_UPDATE            0x00000040      /* need parent update */
 378 #define HAMMER2_CHAIN_DEFERRED          0x00000080      /* flush depth defer */
 379 #define HAMMER2_CHAIN_IOFLUSH           0x00000100      /* bawrite on put */
 380 #define HAMMER2_CHAIN_ONFLUSH           0x00000200      /* on a flush list */
 381 #define HAMMER2_CHAIN_FICTITIOUS        0x00000400      /* unsuitable for I/O */
 382 #define HAMMER2_CHAIN_VOLUMESYNC        0x00000800      /* needs volume sync */
 383 #define HAMMER2_CHAIN_UNUSED00001000    0x00001000
 384 #define HAMMER2_CHAIN_UNUSED00002000    0x00002000
 385 #define HAMMER2_CHAIN_ONRBTREE          0x00004000      /* on parent RB tree */
 386 #define HAMMER2_CHAIN_UNUSED00008000    0x00008000
 387 #define HAMMER2_CHAIN_EMBEDDED          0x00010000      /* embedded data */
 388 #define HAMMER2_CHAIN_RELEASE           0x00020000      /* don't keep around */
 389 #define HAMMER2_CHAIN_BMAPPED           0x00040000      /* present in blkmap */
 390 #define HAMMER2_CHAIN_BMAPUPD           0x00080000      /* +needs updating */
 391 #define HAMMER2_CHAIN_UNUSED00100000    0x00100000
 392 #define HAMMER2_CHAIN_UNUSED00200000    0x00200000
 393 #define HAMMER2_CHAIN_PFSBOUNDARY       0x00400000      /* super->pfs inode */
 394
 395 #define HAMMER2_CHAIN_FLUSH_MASK        (HAMMER2_CHAIN_MODIFIED |       \
 396                                          HAMMER2_CHAIN_UPDATE |         \
 397                                          HAMMER2_CHAIN_ONFLUSH)
 398
 399 /*
 400  * Hammer2 error codes, used by chain->error and cluster->error.  The error
 401  * code is typically set on-lock unless no I/O was requested, and set on
 402  * I/O otherwise.  If set for a cluster it generally means that the cluster
 403  * code could not find a valid copy to present.
 404  *
 405  * IO           - An I/O error occurred
 406  * CHECK        - I/O succeeded but did not match the check code
 407  * INCOMPLETE   - A cluster is not complete enough to use, or
 408  *                a chain cannot be loaded because its parent has an error.
 409  *
 410  * NOTE: API allows callers to check zero/non-zero to determine if an error
 411  *       condition exists.
 412  *
 413  * NOTE: Chain's data field is usually NULL on an IO error but not necessarily
 414  *       NULL on other errors.  Check chain->error, not chain->data.
 415  */
 416 #define HAMMER2_ERROR_NONE              0
 417 #define HAMMER2_ERROR_IO                1       /* device I/O error */
 418 #define HAMMER2_ERROR_CHECK             2       /* check code mismatch */
 419 #define HAMMER2_ERROR_INCOMPLETE        3       /* incomplete cluster */
 420
 421 /*
 422  * Flags passed to hammer2_chain_lookup() and hammer2_chain_next()
 423  *
 424  * NOTE: MATCHIND allows an indirect block / freemap node to be returned
 425  *       when the passed key range matches the radix.  Remember that key_end
 426  *       is inclusive (e.g. {0x000,0xFFF}, not {0x000,0x1000}).
 427  */
 428 #define HAMMER2_LOOKUP_NOLOCK           0x00000001      /* ref only */
 429 #define HAMMER2_LOOKUP_NODATA           0x00000002      /* data left NULL */
 430 #define HAMMER2_LOOKUP_SHARED           0x00000100
 431 #define HAMMER2_LOOKUP_MATCHIND         0x00000200      /* return all chains */
 432 #define HAMMER2_LOOKUP_UNUSED0400       0x00000400
 433 #define HAMMER2_LOOKUP_ALWAYS           0x00000800      /* resolve data */
 434
 435 /*
 436  * Flags passed to hammer2_chain_modify() and hammer2_chain_resize()
 437  *
 438  * NOTE: OPTDATA allows us to avoid instantiating buffers for INDIRECT
 439  *       blocks in the INITIAL-create state.
 440  */
 441 #define HAMMER2_MODIFY_OPTDATA          0x00000002      /* data can be NULL */
 442 #define HAMMER2_MODIFY_NO_MODIFY_TID    0x00000004
 443 #define HAMMER2_MODIFY_UNUSED0008       0x00000008
 444 #define HAMMER2_MODIFY_NOREALLOC        0x00000010
 445
 446 /*
 447  * Flags passed to hammer2_chain_lock()
 448  *
 449  * NOTE: RDONLY is set to optimize cluster operations when *no* modifications
 450  *       will be made to either the cluster being locked or any underlying
 451  *       cluster.  It allows the cluster to lock and access data for a subset
 452  *       of available nodes instead of all available nodes.
 453  */
 454 #define HAMMER2_RESOLVE_NEVER           1
 455 #define HAMMER2_RESOLVE_MAYBE           2
 456 #define HAMMER2_RESOLVE_ALWAYS          3
 457 #define HAMMER2_RESOLVE_MASK            0x0F
 458
 459 #define HAMMER2_RESOLVE_SHARED          0x10    /* request shared lock */
 460 #define HAMMER2_RESOLVE_UNUSED20        0x20
 461 #define HAMMER2_RESOLVE_RDONLY          0x40    /* higher level op flag */
 462
 463 /*
 464  * Flags passed to hammer2_chain_delete()
 465  */
 466 #define HAMMER2_DELETE_PERMANENT        0x0001
 467 #define HAMMER2_DELETE_NOSTATS          0x0002
 468
 469 #define HAMMER2_INSERT_NOSTATS          0x0002
 470 #define HAMMER2_INSERT_PFSROOT          0x0004
 471
 472 /*
 473  * Flags passed to hammer2_chain_delete_duplicate()
 474  */
 475 #define HAMMER2_DELDUP_RECORE           0x0001
 476
 477 /*
 478  * Cluster different types of storage together for allocations
 479  */
 480 #define HAMMER2_FREECACHE_INODE         0
 481 #define HAMMER2_FREECACHE_INDIR         1
 482 #define HAMMER2_FREECACHE_DATA          2
 483 #define HAMMER2_FREECACHE_UNUSED3       3
 484 #define HAMMER2_FREECACHE_TYPES         4
 485
 486 /*
 487  * hammer2_freemap_alloc() block preference
 488  */
 489 #define HAMMER2_OFF_NOPREF              ((hammer2_off_t)-1)
 490
 491 /*
 492  * BMAP read-ahead maximum parameters
 493  */
 494 #define HAMMER2_BMAP_COUNT              16      /* max bmap read-ahead */
 495 #define HAMMER2_BMAP_BYTES              (HAMMER2_PBUFSIZE * HAMMER2_BMAP_COUNT)
 496
 497 /*
 498  * hammer2_freemap_adjust()
 499  */
 500 #define HAMMER2_FREEMAP_DORECOVER       1
 501 #define HAMMER2_FREEMAP_DOMAYFREE       2
 502 #define HAMMER2_FREEMAP_DOREALFREE      3
 503
 504 /*
 505  * HAMMER2 cluster - A set of chains representing the same entity.
 506  *
 507  * hammer2_cluster typically represents a temporary set of representitive
 508  * chains.  The one exception is that a hammer2_cluster is embedded in
 509  * hammer2_inode.  This embedded cluster is ONLY used to track the
 510  * representitive chains and cannot be directly locked.
 511  *
 512  * A cluster is usually temporary (and thus per-thread) for locking purposes,
 513  * allowing us to embed the asynchronous storage required for cluster
 514  * operations in the cluster itself and adjust the state and status without
 515  * having to worry too much about SMP issues.
 516  *
 517  * The exception is the cluster embedded in the hammer2_inode structure.
 518  * This is used to cache the cluster state on an inode-by-inode basis.
 519  * Individual hammer2_chain structures not incorporated into clusters might
 520  * also stick around to cache miscellanious elements.
 521  *
 522  * Because the cluster is a 'working copy' and is usually subject to cluster
 523  * quorum rules, it is quite possible for us to end up with an insufficient
 524  * number of live chains to execute an operation.  If an insufficient number
 525  * of chains remain in a working copy, the operation may have to be
 526  * downgraded, retried, stall until the requisit number of chains are
 527  * available, or possibly even error out depending on the mount type.
 528  *
 529  * A cluster's focus is set when it is locked.  The focus can only be set
 530  * to a chain still part of the synchronized set.
 531  */
 532 #define HAMMER2_MAXCLUSTER      8
 533
 534 struct hammer2_cluster_item {
 535         hammer2_mtx_link_t      async_link;
 536         hammer2_chain_t         *chain;
 537         struct hammer2_cluster  *cluster;       /* link back to cluster */
 538         int                     cache_index;
 539         uint32_t                flags;
 540 };
 541
 542 typedef struct hammer2_cluster_item hammer2_cluster_item_t;
 543
 544 /*
 545  * INVALID      - Invalid for focus, i.e. not part of synchronized set.
 546  *                Once set, this bit is sticky across operations.
 547  *
 548  * FEMOD        - Indicates that front-end modifying operations can
 549  *                mess with this entry and MODSYNC will copy also
 550  *                effect it.
 551  */
 552 #define HAMMER2_CITEM_INVALID   0x00000001
 553 #define HAMMER2_CITEM_FEMOD     0x00000002
 554
 555 struct hammer2_cluster {
 556         int                     refs;           /* track for deallocation */
 557         int                     ddflag;
 558         struct hammer2_pfs      *pmp;
 559         uint32_t                flags;
 560         int                     nchains;
 561         int                     error;          /* error code valid on lock */
 562         int                     focus_index;
 563         hammer2_iocb_t          iocb;
 564         hammer2_chain_t         *focus;         /* current focus (or mod) */
 565         hammer2_cluster_item_t  array[HAMMER2_MAXCLUSTER];
 566 };
 567
 568 typedef struct hammer2_cluster  hammer2_cluster_t;
 569
 570 /*
 571  * WRHARD       - Hard mounts can write fully synchronized
 572  * RDHARD       - Hard mounts can read fully synchronized
 573  * UNHARD       - Unsynchronized masters present
 574  * NOHARD       - No masters visible
 575  * WRSOFT       - Soft mounts can write to at least the SOFT_MASTER
 576  * RDSOFT       - Soft mounts can read from at least a SOFT_SLAVE
 577  * UNSOFT       - Unsynchronized slaves present
 578  * NOSOFT       - No slaves visible
 579  * RDSLAVE      - slaves are accessible (possibly unsynchronized or remote).
 580  * MSYNCED      - All masters are fully synchronized
 581  * SSYNCED      - All known local slaves are fully synchronized to masters
 582  *
 583  * All available masters are always incorporated.  All PFSs belonging to a
 584  * cluster (master, slave, copy, whatever) always try to synchronize the
 585  * total number of known masters in the PFSs root inode.
 586  *
 587  * A cluster might have access to many slaves, copies, or caches, but we
 588  * have a limited number of cluster slots.  Any such elements which are
 589  * directly mounted from block device(s) will always be incorporated.   Note
 590  * that SSYNCED only applies to such elements which are directly mounted,
 591  * not to any remote slaves, copies, or caches that could be available.  These
 592  * bits are used to monitor and drive our synchronization threads.
 593  *
 594  * When asking the question 'is any data accessible at all', then a simple
 595  * test against (RDHARD|RDSOFT|RDSLAVE) gives you the answer.  If any of
 596  * these bits are set the object can be read with certain caveats:
 597  * RDHARD - no caveats.  RDSOFT - authoritative but might not be synchronized.
 598  * and RDSLAVE - not authoritative, has some data but it could be old or
 599  * incomplete.
 600  *
 601  * When both soft and hard mounts are available, data will be read and written
 602  * via the soft mount only.  But all might be in the cluster because
 603  * background synchronization threads still need to do their work.
 604  */
 605 #define HAMMER2_CLUSTER_INODE   0x00000001      /* embedded in inode */
 606 #define HAMMER2_CLUSTER_NOSYNC  0x00000002      /* not in sync (cumulative) */
 607 #define HAMMER2_CLUSTER_LOCKED  0x00000004      /* cluster lks not recursive */
 608 #define HAMMER2_CLUSTER_WRHARD  0x00000100      /* hard-mount can write */
 609 #define HAMMER2_CLUSTER_RDHARD  0x00000200      /* hard-mount can read */
 610 #define HAMMER2_CLUSTER_UNHARD  0x00000400      /* unsynchronized masters */
 611 #define HAMMER2_CLUSTER_NOHARD  0x00000800      /* no masters visible */
 612 #define HAMMER2_CLUSTER_WRSOFT  0x00001000      /* soft-mount can write */
 613 #define HAMMER2_CLUSTER_RDSOFT  0x00002000      /* soft-mount can read */
 614 #define HAMMER2_CLUSTER_UNSOFT  0x00004000      /* unsynchronized slaves */
 615 #define HAMMER2_CLUSTER_NOSOFT  0x00008000      /* no slaves visible */
 616 #define HAMMER2_CLUSTER_MSYNCED 0x00010000      /* all masters synchronized */
 617 #define HAMMER2_CLUSTER_SSYNCED 0x00020000      /* known slaves synchronized */
 618
 619 #define HAMMER2_CLUSTER_ANYDATA ( HAMMER2_CLUSTER_RDHARD |      \
 620                                   HAMMER2_CLUSTER_RDSOFT |      \
 621                                   HAMMER2_CLUSTER_RDSLAVE)
 622
 623 #define HAMMER2_CLUSTER_RDOK    ( HAMMER2_CLUSTER_RDHARD |      \
 624                                   HAMMER2_CLUSTER_RDSOFT)
 625
 626 #define HAMMER2_CLUSTER_WROK    ( HAMMER2_CLUSTER_WRHARD |      \
 627                                   HAMMER2_CLUSTER_WRSOFT)
 628
 629 #define HAMMER2_CLUSTER_ZFLAGS  ( HAMMER2_CLUSTER_WRHARD |      \
 630                                   HAMMER2_CLUSTER_RDHARD |      \
 631                                   HAMMER2_CLUSTER_WRSOFT |      \
 632                                   HAMMER2_CLUSTER_RDSOFT |      \
 633                                   HAMMER2_CLUSTER_MSYNCED |     \
 634                                   HAMMER2_CLUSTER_SSYNCED)
 635
 636 /*
 637  * Helper functions (cluster must be locked for flags to be valid).
 638  */
 639 static __inline
 640 int
 641 hammer2_cluster_rdok(hammer2_cluster_t *cluster)
 642 {
 643         return (cluster->flags & HAMMER2_CLUSTER_RDOK);
 644 }
 645
 646 static __inline
 647 int
 648 hammer2_cluster_wrok(hammer2_cluster_t *cluster)
 649 {
 650         return (cluster->flags & HAMMER2_CLUSTER_WROK);
 651 }
 652
 653 RB_HEAD(hammer2_inode_tree, hammer2_inode);
 654
 655 /*
 656  * A hammer2 inode.
 657  *
 658  * NOTE: The inode-embedded cluster is never used directly for I/O (since
 659  *       it may be shared).  Instead it will be replicated-in and synchronized
 660  *       back out if changed.
 661  */
 662 struct hammer2_inode {
 663         RB_ENTRY(hammer2_inode) rbnode;         /* inumber lookup (HL) */
 664         hammer2_mtx_t           lock;           /* inode lock */
 665         struct hammer2_pfs      *pmp;           /* PFS mount */
 666         struct hammer2_inode    *pip;           /* parent inode */
 667         struct vnode            *vp;
 668         hammer2_cluster_t       cluster;
 669         struct lockf            advlock;
 670         hammer2_tid_t           inum;
 671         u_int                   flags;
 672         u_int                   refs;           /* +vpref, +flushref */
 673         uint8_t                 comp_heuristic;
 674         hammer2_off_t           size;
 675         uint64_t                mtime;
 676 };
 677
 678 typedef struct hammer2_inode hammer2_inode_t;
 679
 680 #define HAMMER2_INODE_MODIFIED          0x0001
 681 #define HAMMER2_INODE_SROOT             0x0002  /* kmalloc special case */
 682 #define HAMMER2_INODE_RENAME_INPROG     0x0004
 683 #define HAMMER2_INODE_ONRBTREE          0x0008
 684 #define HAMMER2_INODE_RESIZED           0x0010
 685 #define HAMMER2_INODE_MTIME             0x0020
 686
 687 int hammer2_inode_cmp(hammer2_inode_t *ip1, hammer2_inode_t *ip2);
 688 RB_PROTOTYPE2(hammer2_inode_tree, hammer2_inode, rbnode, hammer2_inode_cmp,
 689                 hammer2_tid_t);
 690
 691 /*
 692  * inode-unlink side-structure
 693  */
 694 struct hammer2_inode_unlink {
 695         TAILQ_ENTRY(hammer2_inode_unlink) entry;
 696         hammer2_inode_t *ip;
 697 };
 698 TAILQ_HEAD(h2_unlk_list, hammer2_inode_unlink);
 699
 700 typedef struct hammer2_inode_unlink hammer2_inode_unlink_t;
 701
 702 /*
 703  * A hammer2 transaction and flush sequencing structure.
 704  *
 705  * This global structure is tied into hammer2_dev and is used
 706  * to sequence modifying operations and flushes.  These operations
 707  * run on whole cluster PFSs, not individual nodes (at this level),
 708  * so we do not record mirror_tid here.
 709  */
 710 struct hammer2_trans {
 711         TAILQ_ENTRY(hammer2_trans) entry;
 712         struct hammer2_pfs      *pmp;
 713         hammer2_xid_t           sync_xid;       /* transaction sequencer */
 714         hammer2_tid_t           inode_tid;      /* inode number assignment */
 715         hammer2_tid_t           modify_tid;     /* modify transaction id */
 716         thread_t                td;             /* pointer */
 717         int                     flags;
 718         int                     blocked;
 719         uint8_t                 inodes_created;
 720         uint8_t                 dummy[7];
 721 };
 722
 723 typedef struct hammer2_trans hammer2_trans_t;
 724
 725 #define HAMMER2_TRANS_ISFLUSH           0x0001  /* formal flush */
 726 #define HAMMER2_TRANS_CONCURRENT        0x0002  /* concurrent w/flush */
 727 #define HAMMER2_TRANS_BUFCACHE          0x0004  /* from bioq strategy write */
 728 #define HAMMER2_TRANS_NEWINODE          0x0008  /* caller allocating inode */
 729 #define HAMMER2_TRANS_KEEPMODIFY        0x0010  /* do not change bref.modify */
 730 #define HAMMER2_TRANS_PREFLUSH          0x0020  /* preflush state */
 731
 732 #define HAMMER2_FREEMAP_HEUR_NRADIX     4       /* pwr 2 PBUFRADIX-MINIORADIX */
 733 #define HAMMER2_FREEMAP_HEUR_TYPES      8
 734 #define HAMMER2_FREEMAP_HEUR            (HAMMER2_FREEMAP_HEUR_NRADIX * \
 735                                          HAMMER2_FREEMAP_HEUR_TYPES)
 736
 737 /*
 738  * Transaction Rendezvous
 739  */
 740 TAILQ_HEAD(hammer2_trans_queue, hammer2_trans);
 741
 742 struct hammer2_trans_manage {
 743         hammer2_xid_t           flush_xid;      /* last flush transaction */
 744         hammer2_xid_t           alloc_xid;
 745         struct lock             translk;        /* lockmgr lock */
 746         struct hammer2_trans_queue transq;      /* modifying transactions */
 747         int                     flushcnt;       /* track flush trans */
 748 };
 749
 750 typedef struct hammer2_trans_manage hammer2_trans_manage_t;
 751
 752 /*
 753  * Cluster node synchronization thread element.
 754  *
 755  * Multiple syncthr's can hang off of a hammer2_pfs structure, typically one
 756  * for each block device that is part of the PFS.  Synchronization threads
 757  * for PFSs accessed over the network are handled by their respective hosts.
 758  *
 759  * Synchronization threads are responsible for keeping a local node
 760  * synchronized to the greater cluster.
 761  *
 762  * A syncthr can also hang off each hammer2_dev's super-root PFS (spmp).
 763  * This thread is responsible for automatic bulkfree and dedup scans.
 764  */
 765 struct hammer2_syncthr {
 766         struct hammer2_pfs *pmp;
 767         kdmsg_state_t   *span;
 768         thread_t        td;
 769         uint32_t        flags;
 770         uint32_t        unused01;
 771         hammer2_trans_t trans;
 772         struct lock     lk;
 773 };
 774
 775 typedef struct hammer2_syncthr hammer2_syncthr_t;
 776
 777 #define HAMMER2_SYNCTHR_UNMOUNTING      0x0001  /* unmount request */
 778 #define HAMMER2_SYNCTHR_DEV             0x0002  /* related to dev, not pfs */
 779 #define HAMMER2_SYNCTHR_SPANNED         0x0004  /* LNK_SPAN active */
 780 #define HAMMER2_SYNCTHR_REMASTER        0x0008  /* remaster request */
 781 #define HAMMER2_SYNCTHR_STOP            0x0010  /* exit request */
 782 #define HAMMER2_SYNCTHR_FREEZE          0x0020  /* force idle */
 783 #define HAMMER2_SYNCTHR_FROZEN          0x0040  /* restart */
 784
 785
 786 /*
 787  * Global (per partition) management structure, represents a hard block
 788  * device.  Typically referenced by hammer2_chain structures when applicable.
 789  * Typically not used for network-managed elements.
 790  *
 791  * Note that a single hammer2_dev can be indirectly tied to multiple system
 792  * mount points.  There is no direct relationship.  System mounts are
 793  * per-cluster-id, not per-block-device, and a single hard mount might contain
 794  * many PFSs and those PFSs might combine together in various ways to form
 795  * the set of available clusters.
 796  */
 797 struct hammer2_dev {
 798         struct vnode    *devvp;         /* device vnode */
 799         int             ronly;          /* read-only mount */
 800         int             pmp_count;      /* number of actively mounted PFSs */
 801         TAILQ_ENTRY(hammer2_dev) mntentry; /* hammer2_mntlist */
 802
 803         struct malloc_type *mchain;
 804         int             nipstacks;
 805         int             maxipstacks;
 806         kdmsg_iocom_t   iocom;          /* volume-level dmsg interface */
 807         struct spinlock io_spin;        /* iotree access */
 808         struct hammer2_io_tree iotree;
 809         int             iofree_count;
 810         hammer2_chain_t vchain;         /* anchor chain (topology) */
 811         hammer2_chain_t fchain;         /* anchor chain (freemap) */
 812         struct spinlock list_spin;
 813         struct h2_flush_list    flushq; /* flush seeds */
 814         struct hammer2_pfs *spmp;       /* super-root pmp for transactions */
 815         struct lock     vollk;          /* lockmgr lock */
 816         hammer2_off_t   heur_freemap[HAMMER2_FREEMAP_HEUR];
 817         int             volhdrno;       /* last volhdrno written */
 818         char            devrepname[64]; /* for kprintf */
 819         hammer2_volume_data_t voldata;
 820         hammer2_volume_data_t volsync;  /* synchronized voldata */
 821 };
 822
 823 typedef struct hammer2_dev hammer2_dev_t;
 824
 825 /*
 826  * Helper functions (cluster must be locked for flags to be valid).
 827  */
 828 static __inline
 829 int
 830 hammer2_chain_rdok(hammer2_chain_t *chain)
 831 {
 832         return (chain->error == 0);
 833 }
 834
 835 static __inline
 836 int
 837 hammer2_chain_wrok(hammer2_chain_t *chain)
 838 {
 839         return (chain->error == 0 && chain->hmp->ronly == 0);
 840 }
 841
 842 /*
 843  * Per-cluster management structure.  This structure will be tied to a
 844  * system mount point if the system is mounting the PFS, but is also used
 845  * to manage clusters encountered during the super-root scan or received
 846  * via LNK_SPANs that might not be mounted.
 847  *
 848  * This structure is also used to represent the super-root that hangs off
 849  * of a hard mount point.  The super-root is not really a cluster element.
 850  * In this case the spmp_hmp field will be non-NULL.  It's just easier to do
 851  * this than to special case super-root manipulation in the hammer2_chain*
 852  * code as being only hammer2_dev-related.
 853  *
 854  * pfs_mode and pfs_nmasters are rollup fields which critically describes
 855  * how elements of the cluster act on the cluster.  pfs_mode is only applicable
 856  * when a PFS is mounted by the system.  pfs_nmasters is our best guess as to
 857  * how many masters have been configured for a cluster and is always
 858  * applicable.  pfs_types[] is an array with 1:1 correspondance to the
 859  * iroot cluster and describes the PFS types of the nodes making up the
 860  * cluster.
 861  *
 862  * WARNING! Portions of this structure have deferred initialization.  In
 863  *          particular, if not mounted there will be no ihidden or wthread.
 864  *          umounted network PFSs will also be missing iroot and numerous
 865  *          other fields will not be initialized prior to mount.
 866  *
 867  *          Synchronization threads are chain-specific and only applicable
 868  *          to local hard PFS entries.  A hammer2_pfs structure may contain
 869  *          more than one when multiple hard PFSs are present on the local
 870  *          machine which require synchronization monitoring.  Most PFSs
 871  *          (such as snapshots) are 1xMASTER PFSs which do not need a
 872  *          synchronization thread.
 873  *
 874  * WARNING! The chains making up pfs->iroot's cluster are accounted for in
 875  *          hammer2_dev->pmp_count when the pfs is associated with a mount
 876  *          point.
 877  */
 878 struct hammer2_pfs {
 879         struct mount            *mp;
 880         TAILQ_ENTRY(hammer2_pfs) mntentry;      /* hammer2_pfslist */
 881         uuid_t                  pfs_clid;
 882         hammer2_dev_t           *spmp_hmp;      /* only if super-root pmp */
 883         hammer2_inode_t         *iroot;         /* PFS root inode */
 884         hammer2_inode_t         *ihidden;       /* PFS hidden directory */
 885         uint8_t                 pfs_types[HAMMER2_MAXCLUSTER];
 886         struct lock             lock;           /* PFS lock for certain ops */
 887         hammer2_off_t           inode_count;    /* copy of inode_count */
 888         struct netexport        export;         /* nfs export */
 889         int                     ronly;          /* read-only mount */
 890         struct malloc_type      *minode;
 891         struct malloc_type      *mmsg;
 892         struct spinlock         inum_spin;      /* inumber lookup */
 893         struct hammer2_inode_tree inum_tree;    /* (not applicable to spmp) */
 894         hammer2_tid_t           modify_tid;     /* modify transaction id */
 895         hammer2_tid_t           inode_tid;      /* inode allocator */
 896         uint8_t                 pfs_nmasters;   /* total masters */
 897         uint8_t                 pfs_mode;       /* operating mode PFSMODE */
 898         uint8_t                 unused01;
 899         uint8_t                 unused02;
 900         uint32_t                unused03;
 901         long                    inmem_inodes;
 902         uint32_t                inmem_dirty_chains;
 903         int                     count_lwinprog; /* logical write in prog */
 904         struct spinlock         list_spin;
 905         struct h2_unlk_list     unlinkq;        /* last-close unlink */
 906         hammer2_syncthr_t       primary_thr;
 907         thread_t                wthread_td;     /* write thread td */
 908         struct bio_queue_head   wthread_bioq;   /* logical buffer bioq */
 909         hammer2_mtx_t           wthread_mtx;    /* interlock */
 910         int                     wthread_destroy;/* termination sequencing */
 911         uint32_t                flags;          /* cached cluster flags */
 912 };
 913
 914 typedef struct hammer2_pfs hammer2_pfs_t;
 915
 916 #define HAMMER2_DIRTYCHAIN_WAITING      0x80000000
 917 #define HAMMER2_DIRTYCHAIN_MASK         0x7FFFFFFF
 918
 919 #define HAMMER2_LWINPROG_WAITING        0x80000000
 920 #define HAMMER2_LWINPROG_MASK           0x7FFFFFFF
 921
 922 /*
 923  * Bulkscan
 924  */
 925 #define HAMMER2_BULK_ABORT      0x00000001
 926
 927 /*
 928  * Misc
 929  */
 930 #if defined(_KERNEL)
 931
 932 MALLOC_DECLARE(M_HAMMER2);
 933
 934 #define VTOI(vp)        ((hammer2_inode_t *)(vp)->v_data)
 935 #define ITOV(ip)        ((ip)->vp)
 936
 937 /*
 938  * Currently locked chains retain the locked buffer cache buffer for
 939  * indirect blocks, and indirect blocks can be one of two sizes.  The
 940  * device buffer has to match the case to avoid deadlocking recursive
 941  * chains that might otherwise try to access different offsets within
 942  * the same device buffer.
 943  */
 944 static __inline
 945 int
 946 hammer2_devblkradix(int radix)
 947 {
 948 #if 0
 949         if (radix <= HAMMER2_LBUFRADIX) {
 950                 return (HAMMER2_LBUFRADIX);
 951         } else {
 952                 return (HAMMER2_PBUFRADIX);
 953         }
 954 #endif
 955         return (HAMMER2_PBUFRADIX);
 956 }
 957
 958 /*
 959  * XXX almost time to remove this.  DIO uses PBUFSIZE exclusively now.
 960  */
 961 static __inline
 962 size_t
 963 hammer2_devblksize(size_t bytes)
 964 {
 965 #if 0
 966         if (bytes <= HAMMER2_LBUFSIZE) {
 967                 return(HAMMER2_LBUFSIZE);
 968         } else {
 969                 KKASSERT(bytes <= HAMMER2_PBUFSIZE &&
 970                          (bytes ^ (bytes - 1)) == ((bytes << 1) - 1));
 971                 return (HAMMER2_PBUFSIZE);
 972         }
 973 #endif
 974         return (HAMMER2_PBUFSIZE);
 975 }
 976
 977
 978 static __inline
 979 hammer2_pfs_t *
 980 MPTOPMP(struct mount *mp)
 981 {
 982         return ((hammer2_pfs_t *)mp->mnt_data);
 983 }
 984
 985 #define LOCKSTART       int __nlocks = curthread->td_locks
 986 #define LOCKENTER       (++curthread->td_locks)
 987 #define LOCKEXIT        (--curthread->td_locks)
 988 #define LOCKSTOP        KKASSERT(curthread->td_locks == __nlocks)
 989
 990 extern struct vop_ops hammer2_vnode_vops;
 991 extern struct vop_ops hammer2_spec_vops;
 992 extern struct vop_ops hammer2_fifo_vops;
 993
 994 extern int hammer2_debug;
 995 extern int hammer2_cluster_enable;
 996 extern int hammer2_hardlink_enable;
 997 extern int hammer2_flush_pipe;
 998 extern int hammer2_synchronous_flush;
 999 extern int hammer2_dio_count;
1000 extern long hammer2_limit_dirty_chains;
1001 extern long hammer2_iod_file_read;
1002 extern long hammer2_iod_meta_read;
1003 extern long hammer2_iod_indr_read;
1004 extern long hammer2_iod_fmap_read;
1005 extern long hammer2_iod_volu_read;
1006 extern long hammer2_iod_file_write;
1007 extern long hammer2_iod_meta_write;
1008 extern long hammer2_iod_indr_write;
1009 extern long hammer2_iod_fmap_write;
1010 extern long hammer2_iod_volu_write;
1011 extern long hammer2_ioa_file_read;
1012 extern long hammer2_ioa_meta_read;
1013 extern long hammer2_ioa_indr_read;
1014 extern long hammer2_ioa_fmap_read;
1015 extern long hammer2_ioa_volu_read;
1016 extern long hammer2_ioa_file_write;
1017 extern long hammer2_ioa_meta_write;
1018 extern long hammer2_ioa_indr_write;
1019 extern long hammer2_ioa_fmap_write;
1020 extern long hammer2_ioa_volu_write;
1021
1022 extern struct objcache *cache_buffer_read;
1023 extern struct objcache *cache_buffer_write;
1024
1025 extern int destroy;
1026 extern int write_thread_wakeup;
1027
1028 /*
1029  * hammer2_subr.c
1030  */
1031 #define hammer2_icrc32(buf, size)       iscsi_crc32((buf), (size))
1032 #define hammer2_icrc32c(buf, size, crc) iscsi_crc32_ext((buf), (size), (crc))
1033
1034 int hammer2_signal_check(time_t *timep);
1035 const char *hammer2_error_str(int error);
1036
1037 hammer2_cluster_t *hammer2_inode_lock(hammer2_inode_t *ip, int how);
1038 void hammer2_inode_unlock(hammer2_inode_t *ip, hammer2_cluster_t *cluster);
1039 hammer2_mtx_state_t hammer2_inode_lock_temp_release(hammer2_inode_t *ip);
1040 void hammer2_inode_lock_temp_restore(hammer2_inode_t *ip,
1041                         hammer2_mtx_state_t ostate);
1042 int hammer2_inode_lock_upgrade(hammer2_inode_t *ip);
1043 void hammer2_inode_lock_downgrade(hammer2_inode_t *ip, int);
1044
1045 void hammer2_dev_exlock(hammer2_dev_t *hmp);
1046 void hammer2_dev_shlock(hammer2_dev_t *hmp);
1047 void hammer2_dev_unlock(hammer2_dev_t *hmp);
1048
1049 int hammer2_get_dtype(const hammer2_inode_data_t *ipdata);
1050 int hammer2_get_vtype(const hammer2_inode_data_t *ipdata);
1051 u_int8_t hammer2_get_obj_type(enum vtype vtype);
1052 void hammer2_time_to_timespec(u_int64_t xtime, struct timespec *ts);
1053 u_int64_t hammer2_timespec_to_time(const struct timespec *ts);
1054 u_int32_t hammer2_to_unix_xid(const uuid_t *uuid);
1055 void hammer2_guid_to_uuid(uuid_t *uuid, u_int32_t guid);
1056 hammer2_xid_t hammer2_trans_newxid(hammer2_pfs_t *pmp);
1057 void hammer2_trans_manage_init(void);
1058
1059 hammer2_key_t hammer2_dirhash(const unsigned char *name, size_t len);
1060 int hammer2_getradix(size_t bytes);
1061
1062 int hammer2_calc_logical(hammer2_inode_t *ip, hammer2_off_t uoff,
1063                         hammer2_key_t *lbasep, hammer2_key_t *leofp);
1064 int hammer2_calc_physical(hammer2_inode_t *ip,
1065                         const hammer2_inode_data_t *ipdata,
1066                         hammer2_key_t lbase);
1067 void hammer2_update_time(uint64_t *timep);
1068 void hammer2_adjreadcounter(hammer2_blockref_t *bref, size_t bytes);
1069
1070 /*
1071  * hammer2_inode.c
1072  */
1073 struct vnode *hammer2_igetv(hammer2_inode_t *ip, hammer2_cluster_t *cparent,
1074                         int *errorp);
1075 hammer2_inode_t *hammer2_inode_lookup(hammer2_pfs_t *pmp,
1076                         hammer2_tid_t inum);
1077 hammer2_inode_t *hammer2_inode_get(hammer2_pfs_t *pmp,
1078                         hammer2_inode_t *dip, hammer2_cluster_t *cluster);
1079 void hammer2_inode_free(hammer2_inode_t *ip);
1080 void hammer2_inode_ref(hammer2_inode_t *ip);
1081 void hammer2_inode_drop(hammer2_inode_t *ip);
1082 void hammer2_inode_repoint(hammer2_inode_t *ip, hammer2_inode_t *pip,
1083                         hammer2_cluster_t *cluster);
1084 void hammer2_run_unlinkq(hammer2_trans_t *trans, hammer2_pfs_t *pmp);
1085
1086 hammer2_inode_t *hammer2_inode_create(hammer2_trans_t *trans,
1087                         hammer2_inode_t *dip,
1088                         struct vattr *vap, struct ucred *cred,
1089                         const uint8_t *name, size_t name_len,
1090                         hammer2_cluster_t **clusterp,
1091                         int flags, int *errorp);
1092 int hammer2_inode_connect(hammer2_trans_t *trans,
1093                         hammer2_cluster_t **clusterp, int hlink,
1094                         hammer2_inode_t *dip, hammer2_cluster_t *dcluster,
1095                         const uint8_t *name, size_t name_len,
1096                         hammer2_key_t key);
1097 hammer2_inode_t *hammer2_inode_common_parent(hammer2_inode_t *fdip,
1098                         hammer2_inode_t *tdip);
1099 void hammer2_inode_fsync(hammer2_trans_t *trans, hammer2_inode_t *ip,
1100                         hammer2_cluster_t *cparent);
1101 int hammer2_unlink_file(hammer2_trans_t *trans, hammer2_inode_t *dip,
1102                         const uint8_t *name, size_t name_len, int isdir,
1103                         int *hlinkp, struct nchandle *nch, int nlinks);
1104 int hammer2_hardlink_consolidate(hammer2_trans_t *trans,
1105                         hammer2_inode_t *ip, hammer2_cluster_t **clusterp,
1106                         hammer2_inode_t *cdip, hammer2_cluster_t *cdcluster,
1107                         int nlinks);
1108 int hammer2_hardlink_deconsolidate(hammer2_trans_t *trans, hammer2_inode_t *dip,
1109                         hammer2_chain_t **chainp, hammer2_chain_t **ochainp);
1110 int hammer2_hardlink_find(hammer2_inode_t *dip, hammer2_cluster_t **cparentp,
1111                         hammer2_cluster_t **clusterp);
1112 int hammer2_parent_find(hammer2_cluster_t **cparentp,
1113                         hammer2_cluster_t *cluster);
1114 void hammer2_inode_install_hidden(hammer2_pfs_t *pmp);
1115
1116 /*
1117  * hammer2_chain.c
1118  */
1119 void hammer2_voldata_lock(hammer2_dev_t *hmp);
1120 void hammer2_voldata_unlock(hammer2_dev_t *hmp);
1121 void hammer2_voldata_modify(hammer2_dev_t *hmp);
1122 hammer2_chain_t *hammer2_chain_alloc(hammer2_dev_t *hmp,
1123                                 hammer2_pfs_t *pmp,
1124                                 hammer2_trans_t *trans,
1125                                 hammer2_blockref_t *bref);
1126 void hammer2_chain_core_init(hammer2_chain_t *chain);
1127 void hammer2_chain_ref(hammer2_chain_t *chain);
1128 void hammer2_chain_drop(hammer2_chain_t *chain);
1129 void hammer2_chain_lock(hammer2_chain_t *chain, int how);
1130 const hammer2_media_data_t *hammer2_chain_rdata(hammer2_chain_t *chain);
1131 hammer2_media_data_t *hammer2_chain_wdata(hammer2_chain_t *chain);
1132
1133 /*
1134  * hammer2_cluster.c
1135  */
1136 int hammer2_cluster_isunlinked(hammer2_cluster_t *cluster);
1137 void hammer2_cluster_load_async(hammer2_cluster_t *cluster,
1138                                 void (*callback)(hammer2_iocb_t *iocb),
1139                                 void *ptr);
1140 void hammer2_chain_moved(hammer2_chain_t *chain);
1141 void hammer2_chain_modify(hammer2_trans_t *trans,
1142                                 hammer2_chain_t *chain, int flags);
1143 void hammer2_chain_resize(hammer2_trans_t *trans, hammer2_inode_t *ip,
1144                                 hammer2_chain_t *parent,
1145                                 hammer2_chain_t *chain,
1146                                 int nradix, int flags);
1147 void hammer2_chain_unlock(hammer2_chain_t *chain);
1148 void hammer2_chain_wait(hammer2_chain_t *chain);
1149 hammer2_chain_t *hammer2_chain_get(hammer2_chain_t *parent, int generation,
1150                                 hammer2_blockref_t *bref);
1151 hammer2_chain_t *hammer2_chain_lookup_init(hammer2_chain_t *parent, int flags);
1152 void hammer2_chain_lookup_done(hammer2_chain_t *parent);
1153 hammer2_chain_t *hammer2_chain_lookup(hammer2_chain_t **parentp,
1154                                 hammer2_key_t *key_nextp,
1155                                 hammer2_key_t key_beg, hammer2_key_t key_end,
1156                                 int *cache_indexp, int flags);
1157 hammer2_chain_t *hammer2_chain_next(hammer2_chain_t **parentp,
1158                                 hammer2_chain_t *chain,
1159                                 hammer2_key_t *key_nextp,
1160                                 hammer2_key_t key_beg, hammer2_key_t key_end,
1161                                 int *cache_indexp, int flags);
1162 hammer2_chain_t *hammer2_chain_scan(hammer2_chain_t *parent,
1163                                 hammer2_chain_t *chain,
1164                                 int *cache_indexp, int flags);
1165
1166 int hammer2_chain_create(hammer2_trans_t *trans, hammer2_chain_t **parentp,
1167                                 hammer2_chain_t **chainp,
1168                                 hammer2_pfs_t *pmp,
1169                                 hammer2_key_t key, int keybits,
1170                                 int type, size_t bytes, int flags);
1171 void hammer2_chain_rename(hammer2_trans_t *trans, hammer2_blockref_t *bref,
1172                                 hammer2_chain_t **parentp,
1173                                 hammer2_chain_t *chain, int flags);
1174 int hammer2_chain_snapshot(hammer2_trans_t *trans, hammer2_chain_t **chainp,
1175                                 hammer2_ioc_pfs_t *pfs);
1176 void hammer2_chain_delete(hammer2_trans_t *trans, hammer2_chain_t *parent,
1177                                 hammer2_chain_t *chain, int flags);
1178 void hammer2_chain_delete_duplicate(hammer2_trans_t *trans,
1179                                 hammer2_chain_t **chainp, int flags);
1180 void hammer2_flush(hammer2_trans_t *trans, hammer2_chain_t *chain);
1181 void hammer2_chain_commit(hammer2_trans_t *trans, hammer2_chain_t *chain);
1182 void hammer2_chain_setflush(hammer2_trans_t *trans, hammer2_chain_t *chain);
1183 void hammer2_chain_countbrefs(hammer2_chain_t *chain,
1184                                 hammer2_blockref_t *base, int count);
1185
1186 void hammer2_chain_setcheck(hammer2_chain_t *chain, void *bdata);
1187 int hammer2_chain_testcheck(hammer2_chain_t *chain, void *bdata);
1188
1189
1190 void hammer2_pfs_memory_wait(hammer2_pfs_t *pmp);
1191 void hammer2_pfs_memory_inc(hammer2_pfs_t *pmp);
1192 void hammer2_pfs_memory_wakeup(hammer2_pfs_t *pmp);
1193
1194 void hammer2_base_delete(hammer2_trans_t *trans, hammer2_chain_t *chain,
1195                                 hammer2_blockref_t *base, int count,
1196                                 int *cache_indexp, hammer2_chain_t *child);
1197 void hammer2_base_insert(hammer2_trans_t *trans, hammer2_chain_t *chain,
1198                                 hammer2_blockref_t *base, int count,
1199                                 int *cache_indexp, hammer2_chain_t *child);
1200
1201 /*
1202  * hammer2_trans.c
1203  */
1204 void hammer2_trans_init(hammer2_trans_t *trans, hammer2_pfs_t *pmp,
1205                                 int flags);
1206 void hammer2_trans_done(hammer2_trans_t *trans);
1207
1208 /*
1209  * hammer2_ioctl.c
1210  */
1211 int hammer2_ioctl(hammer2_inode_t *ip, u_long com, void *data,
1212                                 int fflag, struct ucred *cred);
1213
1214 /*
1215  * hammer2_io.c
1216  */
1217 void hammer2_io_putblk(hammer2_io_t **diop);
1218 void hammer2_io_cleanup(hammer2_dev_t *hmp, struct hammer2_io_tree *tree);
1219 char *hammer2_io_data(hammer2_io_t *dio, off_t lbase);
1220 void hammer2_io_getblk(hammer2_dev_t *hmp, off_t lbase, int lsize,
1221                                 hammer2_iocb_t *iocb);
1222 void hammer2_io_complete(hammer2_iocb_t *iocb);
1223 void hammer2_io_callback(struct bio *bio);
1224 void hammer2_iocb_wait(hammer2_iocb_t *iocb);
1225 int hammer2_io_new(hammer2_dev_t *hmp, off_t lbase, int lsize,
1226                                 hammer2_io_t **diop);
1227 int hammer2_io_newnz(hammer2_dev_t *hmp, off_t lbase, int lsize,
1228                                 hammer2_io_t **diop);
1229 int hammer2_io_newq(hammer2_dev_t *hmp, off_t lbase, int lsize,
1230                                 hammer2_io_t **diop);
1231 int hammer2_io_bread(hammer2_dev_t *hmp, off_t lbase, int lsize,
1232                                 hammer2_io_t **diop);
1233 void hammer2_io_bawrite(hammer2_io_t **diop);
1234 void hammer2_io_bdwrite(hammer2_io_t **diop);
1235 int hammer2_io_bwrite(hammer2_io_t **diop);
1236 int hammer2_io_isdirty(hammer2_io_t *dio);
1237 void hammer2_io_setdirty(hammer2_io_t *dio);
1238 void hammer2_io_setinval(hammer2_io_t *dio, u_int bytes);
1239 void hammer2_io_brelse(hammer2_io_t **diop);
1240 void hammer2_io_bqrelse(hammer2_io_t **diop);
1241
1242 /*
1243  * hammer2_msgops.c
1244  */
1245 int hammer2_msg_dbg_rcvmsg(kdmsg_msg_t *msg);
1246 int hammer2_msg_adhoc_input(kdmsg_msg_t *msg);
1247
1248 /*
1249  * hammer2_vfsops.c
1250  */
1251 void hammer2_clusterctl_wakeup(kdmsg_iocom_t *iocom);
1252 void hammer2_volconf_update(hammer2_dev_t *hmp, int index);
1253 void hammer2_dump_chain(hammer2_chain_t *chain, int tab, int *countp, char pfx);
1254 void hammer2_bioq_sync(hammer2_pfs_t *pmp);
1255 int hammer2_vfs_sync(struct mount *mp, int waitflags);
1256 hammer2_pfs_t *hammer2_pfsalloc(hammer2_cluster_t *cluster,
1257                                 const hammer2_inode_data_t *ripdata,
1258                                 hammer2_tid_t modify_tid);
1259
1260 void hammer2_lwinprog_ref(hammer2_pfs_t *pmp);
1261 void hammer2_lwinprog_drop(hammer2_pfs_t *pmp);
1262 void hammer2_lwinprog_wait(hammer2_pfs_t *pmp);
1263
1264 /*
1265  * hammer2_freemap.c
1266  */
1267 int hammer2_freemap_alloc(hammer2_trans_t *trans, hammer2_chain_t *chain,
1268                                 size_t bytes);
1269 void hammer2_freemap_adjust(hammer2_trans_t *trans, hammer2_dev_t *hmp,
1270                                 hammer2_blockref_t *bref, int how);
1271
1272 /*
1273  * hammer2_cluster.c
1274  */
1275 int hammer2_cluster_need_resize(hammer2_cluster_t *cluster, int bytes);
1276 uint8_t hammer2_cluster_type(hammer2_cluster_t *cluster);
1277 const hammer2_media_data_t *hammer2_cluster_rdata(hammer2_cluster_t *cluster);
1278 hammer2_media_data_t *hammer2_cluster_wdata(hammer2_cluster_t *cluster);
1279 hammer2_cluster_t *hammer2_cluster_from_chain(hammer2_chain_t *chain);
1280 int hammer2_cluster_modified(hammer2_cluster_t *cluster);
1281 int hammer2_cluster_duplicated(hammer2_cluster_t *cluster);
1282 void hammer2_cluster_set_chainflags(hammer2_cluster_t *cluster, uint32_t flags);
1283 void hammer2_cluster_clr_chainflags(hammer2_cluster_t *cluster, uint32_t flags);
1284 void hammer2_cluster_bref(hammer2_cluster_t *cluster, hammer2_blockref_t *bref);
1285 void hammer2_cluster_setflush(hammer2_trans_t *trans,
1286                         hammer2_cluster_t *cluster);
1287 void hammer2_cluster_setmethod_check(hammer2_trans_t *trans,
1288                         hammer2_cluster_t *cluster, int check_algo);
1289 hammer2_cluster_t *hammer2_cluster_alloc(hammer2_pfs_t *pmp,
1290                         hammer2_trans_t *trans,
1291                         hammer2_blockref_t *bref);
1292 void hammer2_cluster_ref(hammer2_cluster_t *cluster);
1293 void hammer2_cluster_drop(hammer2_cluster_t *cluster);
1294 void hammer2_cluster_wait(hammer2_cluster_t *cluster);
1295 void hammer2_cluster_lock(hammer2_cluster_t *cluster, int how);
1296 void hammer2_cluster_resolve(hammer2_cluster_t *cluster);
1297 hammer2_cluster_t *hammer2_cluster_copy(hammer2_cluster_t *ocluster);
1298 void hammer2_cluster_unlock(hammer2_cluster_t *cluster);
1299 void hammer2_cluster_resize(hammer2_trans_t *trans, hammer2_inode_t *ip,
1300                         hammer2_cluster_t *cparent, hammer2_cluster_t *cluster,
1301                         int nradix, int flags);
1302 hammer2_inode_data_t *hammer2_cluster_modify_ip(hammer2_trans_t *trans,
1303                         hammer2_inode_t *ip, hammer2_cluster_t *cluster,
1304                         int flags);
1305 void hammer2_cluster_modify(hammer2_trans_t *trans, hammer2_cluster_t *cluster,
1306                         int flags);
1307 void hammer2_cluster_modsync(hammer2_cluster_t *cluster);
1308 hammer2_cluster_t *hammer2_cluster_lookup_init(hammer2_cluster_t *cparent,
1309                         int flags);
1310 void hammer2_cluster_lookup_done(hammer2_cluster_t *cparent);
1311 hammer2_cluster_t *hammer2_cluster_lookup(hammer2_cluster_t *cparent,
1312                         hammer2_key_t *key_nextp,
1313                         hammer2_key_t key_beg, hammer2_key_t key_end,
1314                         int flags);
1315 hammer2_cluster_t *hammer2_cluster_next(hammer2_cluster_t *cparent,
1316                         hammer2_cluster_t *cluster,
1317                         hammer2_key_t *key_nextp,
1318                         hammer2_key_t key_beg, hammer2_key_t key_end,
1319                         int flags);
1320 void hammer2_cluster_next_single_chain(hammer2_cluster_t *cparent,
1321                         hammer2_cluster_t *cluster,
1322                         hammer2_key_t *key_nextp,
1323                         hammer2_key_t key_beg,
1324                         hammer2_key_t key_end,
1325                         int i, int flags);
1326 hammer2_cluster_t *hammer2_cluster_scan(hammer2_cluster_t *cparent,
1327                         hammer2_cluster_t *cluster, int flags);
1328 int hammer2_cluster_create(hammer2_trans_t *trans, hammer2_cluster_t *cparent,
1329                         hammer2_cluster_t **clusterp,
1330                         hammer2_key_t key, int keybits,
1331                         int type, size_t bytes, int flags);
1332 void hammer2_cluster_rename(hammer2_trans_t *trans, hammer2_blockref_t *bref,
1333                         hammer2_cluster_t *cparent, hammer2_cluster_t *cluster,
1334                         int flags);
1335 void hammer2_cluster_delete(hammer2_trans_t *trans, hammer2_cluster_t *pcluster,
1336                         hammer2_cluster_t *cluster, int flags);
1337 int hammer2_cluster_snapshot(hammer2_trans_t *trans,
1338                         hammer2_cluster_t *ocluster, hammer2_ioc_pfs_t *pfs);
1339 hammer2_cluster_t *hammer2_cluster_parent(hammer2_cluster_t *cluster);
1340
1341 int hammer2_bulk_scan(hammer2_trans_t *trans, hammer2_chain_t *parent,
1342                         int (*func)(hammer2_chain_t *chain, void *info),
1343                         void *info);
1344 int hammer2_bulkfree_pass(hammer2_dev_t *hmp,
1345                         struct hammer2_ioc_bulkfree *bfi);
1346
1347 /*
1348  * hammer2_iocom.c
1349  */
1350 void hammer2_iocom_init(hammer2_dev_t *hmp);
1351 void hammer2_iocom_uninit(hammer2_dev_t *hmp);
1352 void hammer2_cluster_reconnect(hammer2_dev_t *hmp, struct file *fp);
1353
1354 /*
1355  * hammer2_syncthr.c
1356  */
1357 void hammer2_syncthr_create(hammer2_syncthr_t *thr, hammer2_pfs_t *pmp,
1358                         void (*func)(void *arg));
1359 void hammer2_syncthr_delete(hammer2_syncthr_t *thr);
1360 void hammer2_syncthr_remaster(hammer2_syncthr_t *thr);
1361 void hammer2_syncthr_freeze(hammer2_syncthr_t *thr);
1362 void hammer2_syncthr_unfreeze(hammer2_syncthr_t *thr);
1363 void hammer2_syncthr_primary(void *arg);
1364
1365 #endif /* !_KERNEL */
1366 #endif /* !_VFS_HAMMER2_HAMMER2_H_ */