sys/vfs/hammer2/hammer2.h

   1 /*
   2  * Copyright (c) 2011-2013 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  * This header file contains structures used internally by the HAMMER2
  38  * implementation.  See hammer2_disk.h for on-disk structures.
  39  */
  40
  41 #ifndef _VFS_HAMMER2_HAMMER2_H_
  42 #define _VFS_HAMMER2_HAMMER2_H_
  43
  44 #include <sys/param.h>
  45 #include <sys/types.h>
  46 #include <sys/kernel.h>
  47 #include <sys/conf.h>
  48 #include <sys/systm.h>
  49 #include <sys/tree.h>
  50 #include <sys/malloc.h>
  51 #include <sys/mount.h>
  52 #include <sys/vnode.h>
  53 #include <sys/proc.h>
  54 #include <sys/mountctl.h>
  55 #include <sys/priv.h>
  56 #include <sys/stat.h>
  57 #include <sys/thread.h>
  58 #include <sys/globaldata.h>
  59 #include <sys/lockf.h>
  60 #include <sys/buf.h>
  61 #include <sys/queue.h>
  62 #include <sys/limits.h>
  63 #include <sys/buf2.h>
  64 #include <sys/signal2.h>
  65 #include <sys/dmsg.h>
  66 #include <sys/mutex.h>
  67 #include <sys/mutex2.h>
  68
  69 #include "hammer2_disk.h"
  70 #include "hammer2_mount.h"
  71 #include "hammer2_ioctl.h"
  72 #include "hammer2_ccms.h"
  73
  74 struct hammer2_chain;
  75 struct hammer2_inode;
  76 struct hammer2_mount;
  77 struct hammer2_pfsmount;
  78 struct hammer2_span;
  79 struct hammer2_state;
  80 struct hammer2_msg;
  81
  82 /*
  83  * The chain structure tracks a portion of the media topology from the
  84  * root (volume) down.  Chains represent volumes, inodes, indirect blocks,
  85  * data blocks, and freemap nodes and leafs.
  86  *
  87  * The chain structure can be multi-homed and its topological recursion
  88  * (chain->core) can be shared amongst several chains.  Chain structures
  89  * are topologically stable once placed in the in-memory topology (they
  90  * don't move around).  Modifications which cross flush synchronization
  91  * boundaries, renames, resizing, or any move of the chain to elsewhere
  92  * in the topology is accomplished via the DELETE-DUPLICATE mechanism.
  93  *
  94  * DELETE-DUPLICATE allows HAMMER2 to track work across flush synchronization
  95  * points without stalling the filesystem or corrupting the flush
  96  * sychronization point.  When necessary a chain will be marked DELETED
  97  * and a new, duplicate chain will be allocated.
  98  *
  99  * This mechanism necessarily requires that we be able to overload chains
 100  * at any given layer in the topology.  Overloading is accomplished via a
 101  * RBTREE recursion through chain->rbtree.
 102  *
 103  * Advantages:
 104  *
 105  *      (1) Fully coherent snapshots can be taken without requiring
 106  *          a pre-flush, resulting in extremely fast (sub-millisecond)
 107  *          snapshots.
 108  *
 109  *      (2) Multiple synchronization points can be in-flight at the same
 110  *          time, representing multiple snapshots or flushes.
 111  *
 112  *      (3) The algorithms needed to keep track of everything are actually
 113  *          not that complex.
 114  *
 115  * Special Considerations:
 116  *
 117  *      A chain is ref-counted on a per-chain basis, but the chain's lock
 118  *      is associated with the shared chain_core and is not per-chain.
 119  *
 120  *      The power-of-2 nature of the media radix tree ensures that there
 121  *      will be no overlaps which straddle edges.
 122  */
 123 RB_HEAD(hammer2_chain_tree, hammer2_chain);
 124 TAILQ_HEAD(h2_flush_deferral_list, hammer2_chain);
 125 TAILQ_HEAD(h2_core_list, hammer2_chain);
 126 TAILQ_HEAD(h2_layer_list, hammer2_chain_layer);
 127
 128 struct hammer2_chain_layer {
 129         int             good;
 130         TAILQ_ENTRY(hammer2_chain_layer) entry;
 131         struct hammer2_chain_tree rbtree;
 132         int             refs;           /* prevent destruction */
 133 };
 134
 135 typedef struct hammer2_chain_layer hammer2_chain_layer_t;
 136
 137 struct hammer2_chain_core {
 138         int             good;
 139         struct ccms_cst cst;
 140         struct h2_core_list ownerq;     /* all chains sharing this core */
 141         struct h2_layer_list layerq;
 142         int             live_zero;      /* blockref array opt */
 143         hammer2_tid_t   update_lo;      /* check update against parent */
 144         hammer2_tid_t   update_hi;      /* check update against parent */
 145         u_int           chain_count;    /* total chains in layers */
 146         u_int           sharecnt;
 147         u_int           flags;
 148         u_int           live_count;     /* live (not deleted) chains in tree */
 149         int             generation;     /* generation number (inserts only) */
 150 };
 151
 152 typedef struct hammer2_chain_core hammer2_chain_core_t;
 153
 154 #define HAMMER2_CORE_UNUSED0001         0x0001
 155 #define HAMMER2_CORE_COUNTEDBREFS       0x0002
 156
 157 /*
 158  * H2 is a copy-on-write filesystem.  In order to allow chains to allocate
 159  * smaller blocks (down to 64-bytes), but improve performance and make
 160  * clustered I/O possible using larger block sizes, the kernel buffer cache
 161  * is abstracted via the hammer2_io structure.
 162  */
 163 RB_HEAD(hammer2_io_tree, hammer2_io);
 164
 165 struct hammer2_io {
 166         RB_ENTRY(hammer2_io) rbnode;
 167         struct spinlock spin;
 168         struct hammer2_mount *hmp;
 169         struct buf      *bp;
 170         struct bio      *bio;
 171         off_t           pbase;
 172         int             psize;
 173         void            (*callback)(struct hammer2_io *dio,
 174                                     struct hammer2_chain *chain,
 175                                     void *arg1, off_t arg2);
 176         struct hammer2_chain *arg_c;            /* INPROG I/O only */
 177         void            *arg_p;                 /* INPROG I/O only */
 178         off_t           arg_o;                  /* INPROG I/O only */
 179         int             refs;
 180 };
 181
 182 typedef struct hammer2_io hammer2_io_t;
 183
 184 /*
 185  * Primary chain structure keeps track of the topology in-memory.
 186  */
 187 struct hammer2_chain {
 188         RB_ENTRY(hammer2_chain) rbnode;         /* node */
 189         TAILQ_ENTRY(hammer2_chain) core_entry;  /* contemporary chains */
 190         hammer2_chain_layer_t   *inlayer;
 191         hammer2_blockref_t      bref;
 192         hammer2_chain_core_t    *core;
 193         hammer2_chain_core_t    *above;
 194         struct hammer2_state    *state;         /* if active cache msg */
 195         struct hammer2_mount    *hmp;
 196         struct hammer2_pfsmount *pmp;           /* can be NULL */
 197
 198         hammer2_tid_t   modify_tid;             /* snapshot/flush filter */
 199         hammer2_tid_t   delete_tid;
 200         hammer2_key_t   data_count;             /* delta's to apply */
 201         hammer2_key_t   inode_count;            /* delta's to apply */
 202         hammer2_io_t    *dio;                   /* physical data buffer */
 203         u_int           bytes;                  /* physical data size */
 204         u_int           flags;
 205         u_int           refs;
 206         u_int           lockcnt;
 207         int             debug_reason;
 208         hammer2_media_data_t *data;             /* data pointer shortcut */
 209         TAILQ_ENTRY(hammer2_chain) flush_node;  /* flush deferral list */
 210 };
 211
 212 typedef struct hammer2_chain hammer2_chain_t;
 213
 214 int hammer2_chain_cmp(hammer2_chain_t *chain1, hammer2_chain_t *chain2);
 215 RB_PROTOTYPE(hammer2_chain_tree, hammer2_chain, rbnode, hammer2_chain_cmp);
 216
 217 /*
 218  * Special notes on flags:
 219  *
 220  * INITIAL - This flag allows a chain to be created and for storage to
 221  *           be allocated without having to immediately instantiate the
 222  *           related buffer.  The data is assumed to be all-zeros.  It
 223  *           is primarily used for indirect blocks.
 224  *
 225  * MOVED   - A modified chain becomes MOVED after it flushes.  A chain
 226  *           can also become MOVED if it is moved within the topology
 227  *           (even if not modified).
 228  */
 229 #define HAMMER2_CHAIN_MODIFIED          0x00000001      /* dirty chain data */
 230 #define HAMMER2_CHAIN_ALLOCATED         0x00000002      /* kmalloc'd chain */
 231 #define HAMMER2_CHAIN_UNUSED0004        0x00000004
 232 #define HAMMER2_CHAIN_FORCECOW          0x00000008      /* force copy-on-wr */
 233 #define HAMMER2_CHAIN_DELETED           0x00000010      /* deleted chain */
 234 #define HAMMER2_CHAIN_INITIAL           0x00000020      /* initial create */
 235 #define HAMMER2_CHAIN_FLUSHED           0x00000040      /* flush on unlock */
 236 #define HAMMER2_CHAIN_MOVED             0x00000080      /* bref changed */
 237 #define HAMMER2_CHAIN_IOFLUSH           0x00000100      /* bawrite on put */
 238 #define HAMMER2_CHAIN_DEFERRED          0x00000200      /* on a deferral list */
 239 #define HAMMER2_CHAIN_DESTROYED         0x00000400      /* destroying inode */
 240 #define HAMMER2_CHAIN_VOLUMESYNC        0x00000800      /* needs volume sync */
 241 #define HAMMER2_CHAIN_UNUSED01000       0x00001000
 242 #define HAMMER2_CHAIN_MOUNTED           0x00002000      /* PFS is mounted */
 243 #define HAMMER2_CHAIN_ONRBTREE          0x00004000      /* on parent RB tree */
 244 #define HAMMER2_CHAIN_SNAPSHOT          0x00008000      /* snapshot special */
 245 #define HAMMER2_CHAIN_EMBEDDED          0x00010000      /* embedded data */
 246 #define HAMMER2_CHAIN_UNUSED20000       0x00020000
 247 #define HAMMER2_CHAIN_UNUSED40000       0x00040000
 248 #define HAMMER2_CHAIN_UNUSED80000       0x00080000
 249 #define HAMMER2_CHAIN_DUPLICATED        0x00100000      /* fwd delete-dup */
 250 #define HAMMER2_CHAIN_PFSROOT           0x00200000      /* in pfs->cluster */
 251
 252 /*
 253  * Flags passed to hammer2_chain_lookup() and hammer2_chain_next()
 254  *
 255  * NOTE: MATCHIND allows an indirect block / freemap node to be returned
 256  *       when the passed key range matches the radix.  Remember that key_end
 257  *       is inclusive (e.g. {0x000,0xFFF}, not {0x000,0x1000}).
 258  */
 259 #define HAMMER2_LOOKUP_NOLOCK           0x00000001      /* ref only */
 260 #define HAMMER2_LOOKUP_NODATA           0x00000002      /* data left NULL */
 261 #define HAMMER2_LOOKUP_SHARED           0x00000100
 262 #define HAMMER2_LOOKUP_MATCHIND         0x00000200
 263 #define HAMMER2_LOOKUP_FREEMAP          0x00000400      /* freemap base */
 264 #define HAMMER2_LOOKUP_ALWAYS           0x00000800      /* resolve data */
 265
 266 /*
 267  * Flags passed to hammer2_chain_modify() and hammer2_chain_resize()
 268  *
 269  * NOTE: OPTDATA allows us to avoid instantiating buffers for INDIRECT
 270  *       blocks in the INITIAL-create state.
 271  */
 272 #define HAMMER2_MODIFY_OPTDATA          0x00000002      /* data can be NULL */
 273 #define HAMMER2_MODIFY_NO_MODIFY_TID    0x00000004
 274 #define HAMMER2_MODIFY_ASSERTNOCOPY     0x00000008      /* assert no del-dup */
 275 #define HAMMER2_MODIFY_NOREALLOC        0x00000010
 276 #define HAMMER2_MODIFY_INPLACE          0x00000020      /* don't del-dup */
 277
 278 /*
 279  * Flags passed to hammer2_chain_lock()
 280  */
 281 #define HAMMER2_RESOLVE_NEVER           1
 282 #define HAMMER2_RESOLVE_MAYBE           2
 283 #define HAMMER2_RESOLVE_ALWAYS          3
 284 #define HAMMER2_RESOLVE_MASK            0x0F
 285
 286 #define HAMMER2_RESOLVE_SHARED          0x10    /* request shared lock */
 287 #define HAMMER2_RESOLVE_NOREF           0x20    /* already ref'd on lock */
 288
 289 /*
 290  * Flags passed to hammer2_chain_delete()
 291  */
 292 #define HAMMER2_DELETE_WILLDUP          0x0001  /* no blk free, will be dup */
 293
 294 /*
 295  * Flags passed to hammer2_chain_delete_duplicate()
 296  */
 297 #define HAMMER2_DELDUP_RECORE           0x0001
 298
 299 /*
 300  * Cluster different types of storage together for allocations
 301  */
 302 #define HAMMER2_FREECACHE_INODE         0
 303 #define HAMMER2_FREECACHE_INDIR         1
 304 #define HAMMER2_FREECACHE_DATA          2
 305 #define HAMMER2_FREECACHE_UNUSED3       3
 306 #define HAMMER2_FREECACHE_TYPES         4
 307
 308 /*
 309  * hammer2_freemap_alloc() block preference
 310  */
 311 #define HAMMER2_OFF_NOPREF              ((hammer2_off_t)-1)
 312
 313 /*
 314  * BMAP read-ahead maximum parameters
 315  */
 316 #define HAMMER2_BMAP_COUNT              16      /* max bmap read-ahead */
 317 #define HAMMER2_BMAP_BYTES              (HAMMER2_PBUFSIZE * HAMMER2_BMAP_COUNT)
 318
 319 /*
 320  * Misc
 321  */
 322 #define HAMMER2_FLUSH_DEPTH_LIMIT       10      /* stack recursion limit */
 323
 324 /*
 325  * HAMMER2 IN-MEMORY CACHE OF MEDIA STRUCTURES
 326  *
 327  * There is an in-memory representation of all on-media data structure.
 328  * Basically everything is represented by a hammer2_chain structure
 329  * in-memory and other higher-level structures map to chains.
 330  *
 331  * A great deal of data is accessed simply via its buffer cache buffer,
 332  * which is mapped for the duration of the chain's lock.  However, because
 333  * chains may represent blocks smaller than the 16KB minimum we impose
 334  * on buffer cache buffers, we cannot hold related buffer cache buffers
 335  * locked for smaller blocks.  In these situations we kmalloc() a copy
 336  * of the block.
 337  *
 338  * When modifications are made to a chain a new filesystem block must be
 339  * allocated.  Multiple modifications do not necessarily allocate new
 340  * blocks.  However, when a flush occurs a flush synchronization point
 341  * is created and any new modifications made after this point will allocate
 342  * a new block even if the chain is already in a modified state.
 343  *
 344  * The in-memory representation may remain cached (for example in order to
 345  * placemark clustering locks) even after the related data has been
 346  * detached.
 347  *
 348  *                              CORE SHARING
 349  *
 350  * In order to support concurrent flushes a flush synchronization point
 351  * is created represented by a transaction id.  Among other things,
 352  * operations may move filesystem objects from one part of the topology
 353  * to another (for example, if you rename a file or when indirect blocks
 354  * are created or destroyed, and a few other things).  When this occurs
 355  * across a flush synchronization point the flusher needs to be able to
 356  * recurse down BOTH the 'before' version of the topology and the 'after'
 357  * version.
 358  *
 359  * To facilitate this modifications to chains do what is called a
 360  * DELETE-DUPLICATE operation.  Chains are not actually moved in-memory.
 361  * Instead the chain we wish to move is deleted and a new chain is created
 362  * at the target location in the topology.  ANY SUBCHAINS PLACED UNDER THE
 363  * CHAIN BEING MOVED HAVE TO EXIST IN BOTH PLACES.  To make this work
 364  * all sub-chains are managed by the hammer2_chain_core structure.  This
 365  * structure can be multi-homed, meaning that it can have more than one
 366  * chain as its parent.  When a chain is delete-duplicated the chain's core
 367  * becomes shared under both the old and new chain.
 368  *
 369  *                              STALE CHAINS
 370  *
 371  * When a chain is delete-duplicated the old chain typically becomes stale.
 372  * This is detected via the HAMMER2_CHAIN_DUPLICATED flag in chain->flags.
 373  * To avoid executing live filesystem operations on stale chains, the inode
 374  * locking code will follow stale chains via core->ownerq until it finds
 375  * the live chain.  The lock prevents ripups by other threads.  Lookups
 376  * must properly order locking operations to prevent other threads from
 377  * racing the lookup operation and will also follow stale chains when
 378  * required.
 379  */
 380
 381 RB_HEAD(hammer2_inode_tree, hammer2_inode);
 382
 383 /*
 384  * A hammer2 inode.
 385  *
 386  * NOTE: The inode's attribute CST which is also used to lock the inode
 387  *       is embedded in the chain (chain.cst) and aliased w/ attr_cst.
 388  */
 389 struct hammer2_inode {
 390         RB_ENTRY(hammer2_inode) rbnode;         /* inumber lookup (HL) */
 391         ccms_cst_t              topo_cst;       /* directory topology cst */
 392         struct hammer2_pfsmount *pmp;           /* PFS mount */
 393         struct hammer2_inode    *pip;           /* parent inode */
 394         struct vnode            *vp;
 395         hammer2_chain_t         *chain;         /* NOTE: rehomed on rename */
 396         struct lockf            advlock;
 397         hammer2_tid_t           inum;
 398         u_int                   flags;
 399         u_int                   refs;           /* +vpref, +flushref */
 400         uint8_t                 comp_heuristic;
 401         hammer2_off_t           size;
 402         uint64_t                mtime;
 403 };
 404
 405 typedef struct hammer2_inode hammer2_inode_t;
 406
 407 #define HAMMER2_INODE_MODIFIED          0x0001
 408 #define HAMMER2_INODE_SROOT             0x0002  /* kmalloc special case */
 409 #define HAMMER2_INODE_RENAME_INPROG     0x0004
 410 #define HAMMER2_INODE_ONRBTREE          0x0008
 411 #define HAMMER2_INODE_RESIZED           0x0010
 412 #define HAMMER2_INODE_MTIME             0x0020
 413
 414 int hammer2_inode_cmp(hammer2_inode_t *ip1, hammer2_inode_t *ip2);
 415 RB_PROTOTYPE2(hammer2_inode_tree, hammer2_inode, rbnode, hammer2_inode_cmp,
 416                 hammer2_tid_t);
 417
 418 /*
 419  * A hammer2 transaction and flush sequencing structure.
 420  *
 421  * This global structure is tied into hammer2_mount and is used
 422  * to sequence modifying operations and flushes.
 423  *
 424  * (a) Any modifying operations with sync_tid >= flush_tid will stall until
 425  *     all modifying operating with sync_tid < flush_tid complete.
 426  *
 427  *     The flush related to flush_tid stalls until all modifying operations
 428  *     with sync_tid < flush_tid complete.
 429  *
 430  * (b) Once unstalled, modifying operations with sync_tid > flush_tid are
 431  *     allowed to run.  All modifications cause modify/duplicate operations
 432  *     to occur on the related chains.  Note that most INDIRECT blocks will
 433  *     be unaffected because the modifications just overload the RBTREE
 434  *     structurally instead of actually modifying the indirect blocks.
 435  *
 436  * (c) The actual flush unstalls and RUNS CONCURRENTLY with (b), but only
 437  *     utilizes the chain structures with sync_tid <= flush_tid.  The
 438  *     flush will modify related indirect blocks and inodes in-place
 439  *     (rather than duplicate) since the adjustments are compatible with
 440  *     (b)'s RBTREE overloading
 441  *
 442  *     SPECIAL NOTE:  Inode modifications have to also propagate along any
 443  *                    modify/duplicate chains.  File writes detect the flush
 444  *                    and force out the conflicting buffer cache buffer(s)
 445  *                    before reusing them.
 446  *
 447  * (d) Snapshots can be made instantly but must be flushed and disconnected
 448  *     from their duplicative source before they can be mounted.  This is
 449  *     because while H2's on-media structure supports forks, its in-memory
 450  *     structure only supports very simple forking for background flushing
 451  *     purposes.
 452  *
 453  * TODO: Flush merging.  When fsync() is called on multiple discrete files
 454  *       concurrently there is no reason to stall the second fsync.
 455  *       The final flush that reaches to root can cover both fsync()s.
 456  *
 457  *     The chains typically terminate as they fly onto the disk.  The flush
 458  *     ultimately reaches the volume header.
 459  */
 460 struct hammer2_trans {
 461         TAILQ_ENTRY(hammer2_trans) entry;
 462         struct hammer2_pfsmount *pmp;
 463         hammer2_tid_t           real_tid;
 464         hammer2_tid_t           sync_tid;
 465         hammer2_tid_t           inode_tid;
 466         thread_t                td;             /* pointer */
 467         int                     flags;
 468         int                     blocked;
 469         uint8_t                 inodes_created;
 470         uint8_t                 dummy[7];
 471 };
 472
 473 typedef struct hammer2_trans hammer2_trans_t;
 474
 475 #define HAMMER2_TRANS_ISFLUSH           0x0001  /* formal flush */
 476 #define HAMMER2_TRANS_UNUSED0002        0x0002
 477 #define HAMMER2_TRANS_BUFCACHE          0x0004  /* from bioq strategy write */
 478 #define HAMMER2_TRANS_NEWINODE          0x0008  /* caller allocating inode */
 479 #define HAMMER2_TRANS_ISALLOCATING      0x0010  /* in allocator */
 480
 481 #define HAMMER2_FREEMAP_HEUR_NRADIX     4       /* pwr 2 PBUFRADIX-MINIORADIX */
 482 #define HAMMER2_FREEMAP_HEUR_TYPES      8
 483 #define HAMMER2_FREEMAP_HEUR            (HAMMER2_FREEMAP_HEUR_NRADIX * \
 484                                          HAMMER2_FREEMAP_HEUR_TYPES)
 485
 486 /*
 487  * Global (per device) mount structure for device (aka vp->v_mount->hmp)
 488  */
 489 TAILQ_HEAD(hammer2_trans_queue, hammer2_trans);
 490
 491 struct hammer2_mount {
 492         struct vnode    *devvp;         /* device vnode */
 493         int             ronly;          /* read-only mount */
 494         int             pmp_count;      /* PFS mounts backed by us */
 495         TAILQ_ENTRY(hammer2_mount) mntentry; /* hammer2_mntlist */
 496
 497         struct malloc_type *mchain;
 498         int             nipstacks;
 499         int             maxipstacks;
 500         struct spinlock io_spin;        /* iotree access */
 501         struct hammer2_io_tree iotree;
 502         int             iofree_count;
 503         hammer2_chain_t vchain;         /* anchor chain (topology) */
 504         hammer2_chain_t fchain;         /* anchor chain (freemap) */
 505         hammer2_inode_t *sroot;         /* super-root localized to media */
 506         struct lock     alloclk;        /* lockmgr lock */
 507         struct lock     voldatalk;      /* lockmgr lock */
 508         struct hammer2_trans_queue transq; /* all in-progress transactions */
 509         hammer2_off_t   heur_freemap[HAMMER2_FREEMAP_HEUR];
 510         int             flushcnt;       /* #of flush trans on the list */
 511
 512         int             volhdrno;       /* last volhdrno written */
 513         hammer2_volume_data_t voldata;
 514         hammer2_volume_data_t volsync;  /* synchronized voldata */
 515 };
 516
 517 typedef struct hammer2_mount hammer2_mount_t;
 518
 519 /*
 520  * HAMMER2 cluster - a device/root associated with a PFS.
 521  *
 522  * A PFS may have several hammer2_cluster's associated with it.
 523  */
 524 #define HAMMER2_MAXCLUSTER      8
 525
 526 struct hammer2_cluster {
 527         int                     nchains;
 528         int                     status;
 529         hammer2_chain_t         *chains[HAMMER2_MAXCLUSTER];
 530 };
 531
 532 typedef struct hammer2_cluster hammer2_cluster_t;
 533
 534 /*
 535  * HAMMER2 PFS mount point structure (aka vp->v_mount->mnt_data).
 536  * This has a 1:1 correspondence to struct mount (note that the
 537  * hammer2_mount structure has a N:1 correspondence).
 538  *
 539  * This structure represents a cluster mount and not necessarily a
 540  * PFS under a specific device mount (HMP).  The distinction is important
 541  * because the elements backing a cluster mount can change on the fly.
 542  *
 543  * Usually the first element under the cluster represents the original
 544  * user-requested mount that bootstraps the whole mess.  In significant
 545  * setups the original is usually just a read-only media image (or
 546  * representitive file) that simply contains a bootstrap volume header
 547  * listing the configuration.
 548  */
 549 struct hammer2_pfsmount {
 550         struct mount            *mp;
 551         hammer2_cluster_t       cluster;
 552         hammer2_inode_t         *iroot;         /* PFS root inode */
 553         hammer2_off_t           inode_count;    /* copy of inode_count */
 554         ccms_domain_t           ccms_dom;
 555         struct netexport        export;         /* nfs export */
 556         int                     ronly;          /* read-only mount */
 557         struct malloc_type      *minode;
 558         struct malloc_type      *mmsg;
 559         kdmsg_iocom_t           iocom;
 560         struct spinlock         inum_spin;      /* inumber lookup */
 561         struct hammer2_inode_tree inum_tree;
 562         long                    inmem_inodes;
 563         long                    inmem_chains;
 564         int                     inmem_waiting;
 565         thread_t                wthread_td;     /* write thread td */
 566         struct bio_queue_head   wthread_bioq;   /* logical buffer bioq */
 567         struct mtx              wthread_mtx;    /* interlock */
 568         int                     wthread_destroy;/* termination sequencing */
 569 };
 570
 571 typedef struct hammer2_pfsmount hammer2_pfsmount_t;
 572
 573 #if defined(_KERNEL)
 574
 575 MALLOC_DECLARE(M_HAMMER2);
 576
 577 #define VTOI(vp)        ((hammer2_inode_t *)(vp)->v_data)
 578 #define ITOV(ip)        ((ip)->vp)
 579
 580 /*
 581  * Currently locked chains retain the locked buffer cache buffer for
 582  * indirect blocks, and indirect blocks can be one of two sizes.  The
 583  * device buffer has to match the case to avoid deadlocking recursive
 584  * chains that might otherwise try to access different offsets within
 585  * the same device buffer.
 586  */
 587 static __inline
 588 int
 589 hammer2_devblkradix(int radix)
 590 {
 591         if (radix <= HAMMER2_LBUFRADIX) {
 592                 return (HAMMER2_LBUFRADIX);
 593         } else {
 594                 return (HAMMER2_PBUFRADIX);
 595         }
 596 }
 597
 598 static __inline
 599 size_t
 600 hammer2_devblksize(size_t bytes)
 601 {
 602         if (bytes <= HAMMER2_LBUFSIZE) {
 603                 return(HAMMER2_LBUFSIZE);
 604         } else {
 605                 KKASSERT(bytes <= HAMMER2_PBUFSIZE &&
 606                          (bytes ^ (bytes - 1)) == ((bytes << 1) - 1));
 607                 return (HAMMER2_PBUFSIZE);
 608         }
 609 }
 610
 611
 612 static __inline
 613 hammer2_pfsmount_t *
 614 MPTOPMP(struct mount *mp)
 615 {
 616         return ((hammer2_pfsmount_t *)mp->mnt_data);
 617 }
 618
 619 extern struct vop_ops hammer2_vnode_vops;
 620 extern struct vop_ops hammer2_spec_vops;
 621 extern struct vop_ops hammer2_fifo_vops;
 622
 623 extern int hammer2_debug;
 624 extern int hammer2_cluster_enable;
 625 extern int hammer2_hardlink_enable;
 626 extern long hammer2_iod_file_read;
 627 extern long hammer2_iod_meta_read;
 628 extern long hammer2_iod_indr_read;
 629 extern long hammer2_iod_fmap_read;
 630 extern long hammer2_iod_volu_read;
 631 extern long hammer2_iod_file_write;
 632 extern long hammer2_iod_meta_write;
 633 extern long hammer2_iod_indr_write;
 634 extern long hammer2_iod_fmap_write;
 635 extern long hammer2_iod_volu_write;
 636 extern long hammer2_ioa_file_read;
 637 extern long hammer2_ioa_meta_read;
 638 extern long hammer2_ioa_indr_read;
 639 extern long hammer2_ioa_fmap_read;
 640 extern long hammer2_ioa_volu_read;
 641 extern long hammer2_ioa_file_write;
 642 extern long hammer2_ioa_meta_write;
 643 extern long hammer2_ioa_indr_write;
 644 extern long hammer2_ioa_fmap_write;
 645 extern long hammer2_ioa_volu_write;
 646
 647 extern struct objcache *cache_buffer_read;
 648 extern struct objcache *cache_buffer_write;
 649
 650 extern int destroy;
 651 extern int write_thread_wakeup;
 652
 653 extern mtx_t thread_protect;
 654
 655 /*
 656  * hammer2_subr.c
 657  */
 658 #define hammer2_icrc32(buf, size)       iscsi_crc32((buf), (size))
 659 #define hammer2_icrc32c(buf, size, crc) iscsi_crc32_ext((buf), (size), (crc))
 660
 661 hammer2_chain_t *hammer2_inode_lock_ex(hammer2_inode_t *ip);
 662 hammer2_chain_t *hammer2_inode_lock_sh(hammer2_inode_t *ip);
 663 void hammer2_inode_unlock_ex(hammer2_inode_t *ip, hammer2_chain_t *chain);
 664 void hammer2_inode_unlock_sh(hammer2_inode_t *ip, hammer2_chain_t *chain);
 665 void hammer2_chain_refactor(hammer2_chain_t **chainp);
 666 void hammer2_voldata_lock(hammer2_mount_t *hmp);
 667 void hammer2_voldata_unlock(hammer2_mount_t *hmp, int modify);
 668 ccms_state_t hammer2_inode_lock_temp_release(hammer2_inode_t *ip);
 669 void hammer2_inode_lock_temp_restore(hammer2_inode_t *ip, ccms_state_t ostate);
 670 ccms_state_t hammer2_inode_lock_upgrade(hammer2_inode_t *ip);
 671 void hammer2_inode_lock_downgrade(hammer2_inode_t *ip, ccms_state_t ostate);
 672
 673 void hammer2_mount_exlock(hammer2_mount_t *hmp);
 674 void hammer2_mount_shlock(hammer2_mount_t *hmp);
 675 void hammer2_mount_unlock(hammer2_mount_t *hmp);
 676
 677 int hammer2_get_dtype(hammer2_chain_t *chain);
 678 int hammer2_get_vtype(hammer2_chain_t *chain);
 679 u_int8_t hammer2_get_obj_type(enum vtype vtype);
 680 void hammer2_time_to_timespec(u_int64_t xtime, struct timespec *ts);
 681 u_int64_t hammer2_timespec_to_time(struct timespec *ts);
 682 u_int32_t hammer2_to_unix_xid(uuid_t *uuid);
 683 void hammer2_guid_to_uuid(uuid_t *uuid, u_int32_t guid);
 684
 685 hammer2_key_t hammer2_dirhash(const unsigned char *name, size_t len);
 686 int hammer2_getradix(size_t bytes);
 687
 688 int hammer2_calc_logical(hammer2_inode_t *ip, hammer2_off_t uoff,
 689                         hammer2_key_t *lbasep, hammer2_key_t *leofp);
 690 int hammer2_calc_physical(hammer2_inode_t *ip, hammer2_key_t lbase);
 691 void hammer2_update_time(uint64_t *timep);
 692
 693 /*
 694  * hammer2_inode.c
 695  */
 696 struct vnode *hammer2_igetv(hammer2_inode_t *ip, int *errorp);
 697
 698 void hammer2_inode_lock_nlinks(hammer2_inode_t *ip);
 699 void hammer2_inode_unlock_nlinks(hammer2_inode_t *ip);
 700 hammer2_inode_t *hammer2_inode_lookup(hammer2_pfsmount_t *pmp,
 701                         hammer2_tid_t inum);
 702 hammer2_inode_t *hammer2_inode_get(hammer2_pfsmount_t *pmp,
 703                         hammer2_inode_t *dip, hammer2_chain_t *chain);
 704 void hammer2_inode_free(hammer2_inode_t *ip);
 705 void hammer2_inode_ref(hammer2_inode_t *ip);
 706 void hammer2_inode_drop(hammer2_inode_t *ip);
 707 void hammer2_inode_repoint(hammer2_inode_t *ip, hammer2_inode_t *pip,
 708                         hammer2_chain_t *chain);
 709
 710 hammer2_inode_t *hammer2_inode_create(hammer2_trans_t *trans,
 711                         hammer2_inode_t *dip,
 712                         struct vattr *vap, struct ucred *cred,
 713                         const uint8_t *name, size_t name_len,
 714                         hammer2_chain_t **chainp, int *errorp);
 715 int hammer2_inode_connect(hammer2_trans_t *trans, int hlink,
 716                         hammer2_inode_t *dip, hammer2_chain_t **chainp,
 717                         const uint8_t *name, size_t name_len);
 718 hammer2_inode_t *hammer2_inode_common_parent(hammer2_inode_t *fdip,
 719                         hammer2_inode_t *tdip);
 720 void hammer2_inode_fsync(hammer2_trans_t *trans, hammer2_inode_t *ip,
 721                         hammer2_chain_t **parentp);
 722 int hammer2_unlink_file(hammer2_trans_t *trans, hammer2_inode_t *dip,
 723                         const uint8_t *name, size_t name_len, int isdir,
 724                         int *hlinkp);
 725 int hammer2_hardlink_consolidate(hammer2_trans_t *trans, hammer2_inode_t *ip,
 726                         hammer2_chain_t **chainp,
 727                         hammer2_inode_t *tdip, int linkcnt);
 728 int hammer2_hardlink_deconsolidate(hammer2_trans_t *trans, hammer2_inode_t *dip,
 729                         hammer2_chain_t **chainp, hammer2_chain_t **ochainp);
 730 int hammer2_hardlink_find(hammer2_inode_t *dip,
 731                         hammer2_chain_t **chainp, hammer2_chain_t **ochainp);
 732
 733 /*
 734  * hammer2_chain.c
 735  */
 736 void hammer2_modify_volume(hammer2_mount_t *hmp);
 737 hammer2_chain_t *hammer2_chain_alloc(hammer2_mount_t *hmp,
 738                                 hammer2_pfsmount_t *pmp,
 739                                 hammer2_trans_t *trans,
 740                                 hammer2_blockref_t *bref);
 741 void hammer2_chain_core_alloc(hammer2_trans_t *trans, hammer2_chain_t *nchain,
 742                                 hammer2_chain_t *ochain);
 743 void hammer2_chain_ref(hammer2_chain_t *chain);
 744 void hammer2_chain_drop(hammer2_chain_t *chain);
 745 int hammer2_chain_lock(hammer2_chain_t *chain, int how);
 746 void hammer2_chain_load_async(hammer2_chain_t *chain,
 747                                 void (*func)(hammer2_io_t *dio,
 748                                              hammer2_chain_t *chain,
 749                                              void *arg_p, off_t arg_o),
 750                                 void *arg_p, off_t arg_o);
 751 void hammer2_chain_moved(hammer2_chain_t *chain);
 752 void hammer2_chain_modify(hammer2_trans_t *trans,
 753                                 hammer2_chain_t **chainp, int flags);
 754 hammer2_inode_data_t *hammer2_chain_modify_ip(hammer2_trans_t *trans,
 755                                 hammer2_inode_t *ip, hammer2_chain_t **chainp,
 756                                 int flags);
 757 void hammer2_chain_resize(hammer2_trans_t *trans, hammer2_inode_t *ip,
 758                                 hammer2_chain_t *parent,
 759                                 hammer2_chain_t **chainp,
 760                                 int nradix, int flags);
 761 void hammer2_chain_unlock(hammer2_chain_t *chain);
 762 void hammer2_chain_wait(hammer2_chain_t *chain);
 763 hammer2_chain_t *hammer2_chain_get(hammer2_chain_t *parent,
 764                                 hammer2_blockref_t *bref);
 765 hammer2_chain_t *hammer2_chain_lookup_init(hammer2_chain_t *parent, int flags);
 766 void hammer2_chain_lookup_done(hammer2_chain_t *parent);
 767 hammer2_chain_t *hammer2_chain_lookup(hammer2_chain_t **parentp,
 768                                 hammer2_key_t *key_nextp,
 769                                 hammer2_key_t key_beg, hammer2_key_t key_end,
 770                                 int *cache_indexp, int flags);
 771 hammer2_chain_t *hammer2_chain_next(hammer2_chain_t **parentp,
 772                                 hammer2_chain_t *chain,
 773                                 hammer2_key_t *key_nextp,
 774                                 hammer2_key_t key_beg, hammer2_key_t key_end,
 775                                 int *cache_indexp, int flags);
 776
 777 int hammer2_chain_create(hammer2_trans_t *trans,
 778                                 hammer2_chain_t **parentp,
 779                                 hammer2_chain_t **chainp,
 780                                 hammer2_key_t key, int keybits,
 781                                 int type, size_t bytes);
 782 void hammer2_chain_duplicate(hammer2_trans_t *trans, hammer2_chain_t **parentp,
 783                                 hammer2_chain_t **chainp,
 784                                 hammer2_blockref_t *bref, int snapshot);
 785 int hammer2_chain_snapshot(hammer2_trans_t *trans, hammer2_chain_t **chainp,
 786                                 hammer2_ioc_pfs_t *pfs);
 787 void hammer2_chain_delete(hammer2_trans_t *trans, hammer2_chain_t *chain,
 788                                 int flags);
 789 void hammer2_chain_delete_duplicate(hammer2_trans_t *trans,
 790                                 hammer2_chain_t **chainp, int flags);
 791 void hammer2_chain_flush(hammer2_trans_t *trans, hammer2_chain_t **chainp);
 792 void hammer2_chain_commit(hammer2_trans_t *trans, hammer2_chain_t *chain);
 793 void hammer2_chain_setsubmod(hammer2_trans_t *trans, hammer2_chain_t *chain);
 794
 795 void hammer2_chain_memory_wait(hammer2_pfsmount_t *pmp);
 796 void hammer2_chain_memory_wakeup(hammer2_pfsmount_t *pmp);
 797 void hammer2_chain_countbrefs(hammer2_chain_t *chain,
 798                                 hammer2_blockref_t *base, int count);
 799 void hammer2_chain_layer_check_locked(hammer2_mount_t *hmp,
 800                                 hammer2_chain_core_t *core);
 801
 802 int hammer2_base_find(hammer2_chain_t *chain,
 803                                 hammer2_blockref_t *base, int count,
 804                                 int *cache_indexp, hammer2_key_t *key_nextp,
 805                                 hammer2_key_t key_beg, hammer2_key_t key_end);
 806 void hammer2_base_delete(hammer2_chain_t *chain,
 807                                 hammer2_blockref_t *base, int count,
 808                                 int *cache_indexp, hammer2_chain_t *child);
 809 void hammer2_base_insert(hammer2_chain_t *chain,
 810                                 hammer2_blockref_t *base, int count,
 811                                 int *cache_indexp, hammer2_chain_t *child);
 812
 813 /*
 814  * hammer2_trans.c
 815  */
 816 void hammer2_trans_init(hammer2_trans_t *trans,
 817                         hammer2_pfsmount_t *pmp, int flags);
 818 void hammer2_trans_clear_invfsync(hammer2_trans_t *trans);
 819 void hammer2_trans_done(hammer2_trans_t *trans);
 820
 821 /*
 822  * hammer2_ioctl.c
 823  */
 824 int hammer2_ioctl(hammer2_inode_t *ip, u_long com, void *data,
 825                                 int fflag, struct ucred *cred);
 826
 827 /*
 828  * hammer2_io.c
 829  */
 830 hammer2_io_t *hammer2_io_getblk(hammer2_mount_t *hmp, off_t lbase,
 831                                 int lsize, int *ownerp);
 832 void hammer2_io_putblk(hammer2_io_t **diop);
 833 void hammer2_io_cleanup(hammer2_mount_t *hmp, struct hammer2_io_tree *tree);
 834 char *hammer2_io_data(hammer2_io_t *dio, off_t lbase);
 835 int hammer2_io_new(hammer2_mount_t *hmp, off_t lbase, int lsize,
 836                                 hammer2_io_t **diop);
 837 int hammer2_io_newnz(hammer2_mount_t *hmp, off_t lbase, int lsize,
 838                                 hammer2_io_t **diop);
 839 int hammer2_io_newq(hammer2_mount_t *hmp, off_t lbase, int lsize,
 840                                 hammer2_io_t **diop);
 841 int hammer2_io_bread(hammer2_mount_t *hmp, off_t lbase, int lsize,
 842                                 hammer2_io_t **diop);
 843 void hammer2_io_breadcb(hammer2_mount_t *hmp, off_t lbase, int lsize,
 844                                 void (*callback)(hammer2_io_t *dio,
 845                                                  hammer2_chain_t *arg_c,
 846                                                  void *arg_p, off_t arg_o),
 847                                 hammer2_chain_t *arg_c,
 848                                 void *arg_p, off_t arg_o);
 849 void hammer2_io_bawrite(hammer2_io_t **diop);
 850 void hammer2_io_bdwrite(hammer2_io_t **diop);
 851 int hammer2_io_bwrite(hammer2_io_t **diop);
 852 void hammer2_io_setdirty(hammer2_io_t *dio);
 853 void hammer2_io_setinval(hammer2_io_t *dio, u_int bytes);
 854 void hammer2_io_brelse(hammer2_io_t **diop);
 855 void hammer2_io_bqrelse(hammer2_io_t **diop);
 856 int hammer2_io_isdirty(hammer2_io_t *dio);
 857
 858 /*
 859  * hammer2_msgops.c
 860  */
 861 int hammer2_msg_dbg_rcvmsg(kdmsg_msg_t *msg);
 862 int hammer2_msg_adhoc_input(kdmsg_msg_t *msg);
 863
 864 /*
 865  * hammer2_vfsops.c
 866  */
 867 void hammer2_clusterctl_wakeup(kdmsg_iocom_t *iocom);
 868 void hammer2_volconf_update(hammer2_pfsmount_t *pmp, int index);
 869 void hammer2_cluster_reconnect(hammer2_pfsmount_t *pmp, struct file *fp);
 870 void hammer2_dump_chain(hammer2_chain_t *chain, int tab, int *countp);
 871 void hammer2_bioq_sync(hammer2_pfsmount_t *pmp);
 872 int hammer2_vfs_sync(struct mount *mp, int waitflags);
 873
 874 /*
 875  * hammer2_freemap.c
 876  */
 877 int hammer2_freemap_alloc(hammer2_trans_t *trans, hammer2_mount_t *hmp,
 878                                 hammer2_blockref_t *bref, size_t bytes);
 879 void hammer2_freemap_free(hammer2_trans_t *trans, hammer2_mount_t *hmp,
 880                                 hammer2_blockref_t *bref, int how);
 881
 882
 883 #endif /* !_KERNEL */
 884 #endif /* !_VFS_HAMMER2_HAMMER2_H_ */