sys/vfs/hammer/hammer.h

   1 /*
   2  * Copyright (c) 2007-2008 The DragonFly Project.  All rights reserved.
   3  *
   4  * This code is derived from software contributed to The DragonFly Project
   5  * by Matthew Dillon <dillon@backplane.com>
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  *
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in
  15  *    the documentation and/or other materials provided with the
  16  *    distribution.
  17  * 3. Neither the name of The DragonFly Project nor the names of its
  18  *    contributors may be used to endorse or promote products derived
  19  *    from this software without specific, prior written permission.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  24  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
  25  * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  26  * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
  27  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  28  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
  29  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  30  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  31  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  32  * SUCH DAMAGE.
  33  *
  34  * $DragonFly: src/sys/vfs/hammer/hammer.h,v 1.90 2008/06/23 07:31:14 dillon Exp $
  35  */
  36 /*
  37  * This header file contains structures used internally by the HAMMERFS
  38  * implementation.  See hammer_disk.h for on-disk structures.
  39  */
  40
  41 #include <sys/param.h>
  42 #include <sys/types.h>
  43 #include <sys/kernel.h>
  44 #include <sys/conf.h>
  45 #include <sys/systm.h>
  46 #include <sys/tree.h>
  47 #include <sys/malloc.h>
  48 #include <sys/mount.h>
  49 #include <sys/mountctl.h>
  50 #include <sys/vnode.h>
  51 #include <sys/proc.h>
  52 #include <sys/stat.h>
  53 #include <sys/globaldata.h>
  54 #include <sys/lockf.h>
  55 #include <sys/buf.h>
  56 #include <sys/queue.h>
  57 #include <sys/ktr.h>
  58 #include <sys/globaldata.h>
  59
  60 #include <sys/buf2.h>
  61 #include <sys/signal2.h>
  62 #include "hammer_disk.h"
  63 #include "hammer_mount.h"
  64 #include "hammer_ioctl.h"
  65
  66 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
  67
  68 MALLOC_DECLARE(M_HAMMER);
  69
  70 /*
  71  * Kernel trace
  72  */
  73 #if !defined(KTR_HAMMER)
  74 #define KTR_HAMMER      KTR_ALL
  75 #endif
  76 KTR_INFO_MASTER_EXTERN(hammer);
  77
  78 /*
  79  * Misc structures
  80  */
  81 struct hammer_mount;
  82
  83 /*
  84  * Key structure used for custom RB tree inode lookups.  This prototypes
  85  * the function hammer_ino_rb_tree_RB_LOOKUP_INFO(root, info).
  86  */
  87 typedef struct hammer_inode_info {
  88         int64_t         obj_id;         /* (key) object identifier */
  89         hammer_tid_t    obj_asof;       /* (key) snapshot transid or 0 */
  90         u_int32_t       obj_localization; /* (key) pseudo-fs */
  91         union {
  92                 struct hammer_btree_leaf_elm *leaf;
  93         } u;
  94 } *hammer_inode_info_t;
  95
  96 typedef enum hammer_transaction_type {
  97         HAMMER_TRANS_RO,
  98         HAMMER_TRANS_STD,
  99         HAMMER_TRANS_FLS
 100 } hammer_transaction_type_t;
 101
 102 /*
 103  * HAMMER Transaction tracking
 104  */
 105 struct hammer_transaction {
 106         hammer_transaction_type_t type;
 107         struct hammer_mount *hmp;
 108         hammer_tid_t    tid;
 109         u_int64_t       time;
 110         int             sync_lock_refs;
 111         struct hammer_volume *rootvol;
 112 };
 113
 114 typedef struct hammer_transaction *hammer_transaction_t;
 115
 116 /*
 117  * HAMMER locks
 118  */
 119 struct hammer_lock {
 120         int     refs;           /* active references delay writes */
 121         int     lockcount;      /* lock count for exclusive/shared access */
 122         int     wanted;
 123         int     exwanted;       /* number of threads waiting for ex lock */
 124         struct thread *locktd;
 125 };
 126
 127 static __inline int
 128 hammer_islocked(struct hammer_lock *lock)
 129 {
 130         return(lock->lockcount != 0);
 131 }
 132
 133 static __inline int
 134 hammer_isactive(struct hammer_lock *lock)
 135 {
 136         return(lock->refs != 0);
 137 }
 138
 139 static __inline int
 140 hammer_islastref(struct hammer_lock *lock)
 141 {
 142         return(lock->refs == 1);
 143 }
 144
 145 /*
 146  * Return if we specifically own the lock exclusively.
 147  */
 148 static __inline int
 149 hammer_lock_excl_owned(struct hammer_lock *lock, thread_t td)
 150 {
 151         if (lock->lockcount > 0 && lock->locktd == td)
 152                 return(1);
 153         return(0);
 154 }
 155
 156 /*
 157  * Flush state, used by various structures
 158  */
 159 typedef enum hammer_inode_state {
 160         HAMMER_FST_IDLE,
 161         HAMMER_FST_SETUP,
 162         HAMMER_FST_FLUSH
 163 } hammer_inode_state_t;
 164
 165 TAILQ_HEAD(hammer_record_list, hammer_record);
 166
 167 /*
 168  * Cache object ids.  A fixed number of objid cache structures are
 169  * created to reserve object id's for newly created files in multiples
 170  * of 100,000, localized to a particular directory, and recycled as
 171  * needed.  This allows parallel create operations in different
 172  * directories to retain fairly localized object ids which in turn
 173  * improves reblocking performance and layout.
 174  */
 175 #define OBJID_CACHE_SIZE        1024
 176 #define OBJID_CACHE_BULK        100000
 177
 178 typedef struct hammer_objid_cache {
 179         TAILQ_ENTRY(hammer_objid_cache) entry;
 180         struct hammer_inode             *dip;
 181         hammer_tid_t                    next_tid;
 182         int                             count;
 183 } *hammer_objid_cache_t;
 184
 185 /*
 186  * Associate an inode with a B-Tree node to cache search start positions
 187  */
 188 typedef struct hammer_node_cache {
 189         TAILQ_ENTRY(hammer_node_cache) entry;
 190         struct hammer_node              *node;
 191         struct hammer_inode             *ip;
 192 } *hammer_node_cache_t;
 193
 194 TAILQ_HEAD(hammer_node_cache_list, hammer_node_cache);
 195
 196 /*
 197  * Structure used to represent an inode in-memory.
 198  *
 199  * The record and data associated with an inode may be out of sync with
 200  * the disk (xDIRTY flags), or not even on the disk at all (ONDISK flag
 201  * clear).
 202  *
 203  * An inode may also hold a cache of unsynchronized records, used for
 204  * database and directories only.  Unsynchronized regular file data is
 205  * stored in the buffer cache.
 206  *
 207  * NOTE: A file which is created and destroyed within the initial
 208  * synchronization period can wind up not doing any disk I/O at all.
 209  *
 210  * Finally, an inode may cache numerous disk-referencing B-Tree cursors.
 211  */
 212 struct hammer_ino_rb_tree;
 213 struct hammer_inode;
 214 RB_HEAD(hammer_ino_rb_tree, hammer_inode);
 215 RB_PROTOTYPEX(hammer_ino_rb_tree, INFO, hammer_inode, rb_node,
 216               hammer_ino_rb_compare, hammer_inode_info_t);
 217
 218 struct hammer_rec_rb_tree;
 219 struct hammer_record;
 220 RB_HEAD(hammer_rec_rb_tree, hammer_record);
 221 RB_PROTOTYPEX(hammer_rec_rb_tree, INFO, hammer_record, rb_node,
 222               hammer_rec_rb_compare, hammer_btree_leaf_elm_t);
 223
 224 TAILQ_HEAD(hammer_node_list, hammer_node);
 225
 226 struct hammer_inode {
 227         RB_ENTRY(hammer_inode)  rb_node;
 228         hammer_inode_state_t    flush_state;
 229         int                     flush_group;
 230         TAILQ_ENTRY(hammer_inode) flush_entry;
 231         struct hammer_record_list target_list;  /* target of dependant recs */
 232         u_int64_t               obj_id;         /* (key) object identifier */
 233         hammer_tid_t            obj_asof;       /* (key) snapshot or 0 */
 234         u_int32_t               obj_localization; /* (key) pseudo-fs */
 235         struct hammer_mount     *hmp;
 236         hammer_objid_cache_t    objid_cache;
 237         int                     flags;
 238         int                     error;          /* flush error */
 239         int                     cursor_ip_refs; /* sanity */
 240         int                     rsv_databufs;
 241         int                     rsv_recs;
 242         struct vnode            *vp;
 243         struct lockf            advlock;
 244         struct hammer_lock      lock;           /* sync copy interlock */
 245         off_t                   trunc_off;
 246         struct hammer_btree_leaf_elm ino_leaf;  /* in-memory cache */
 247         struct hammer_inode_data ino_data;      /* in-memory cache */
 248         struct hammer_rec_rb_tree rec_tree;     /* in-memory cache */
 249         struct hammer_node_cache cache[2];      /* search initiate cache */
 250
 251         /*
 252          * When a demark is created to synchronize an inode to
 253          * disk, certain fields are copied so the front-end VOPs
 254          * can continue to run in parallel with the synchronization
 255          * occuring in the background.
 256          */
 257         int             sync_flags;             /* to-sync flags cache */
 258         off_t           sync_trunc_off;         /* to-sync truncation */
 259         struct hammer_btree_leaf_elm sync_ino_leaf; /* to-sync cache */
 260         struct hammer_inode_data sync_ino_data; /* to-sync cache */
 261 };
 262
 263 typedef struct hammer_inode *hammer_inode_t;
 264
 265 #define VTOI(vp)        ((struct hammer_inode *)(vp)->v_data)
 266
 267 #define HAMMER_INODE_DDIRTY     0x0001  /* in-memory ino_data is dirty */
 268                                         /* (not including atime/mtime) */
 269 #define HAMMER_INODE_RSV_INODES 0x0002  /* hmp->rsv_inodes bumped */
 270 #define HAMMER_INODE_UNUSED0004 0x0004
 271 #define HAMMER_INODE_XDIRTY     0x0008  /* in-memory records */
 272 #define HAMMER_INODE_ONDISK     0x0010  /* inode is on-disk (else not yet) */
 273 #define HAMMER_INODE_FLUSH      0x0020  /* flush on last ref */
 274 #define HAMMER_INODE_DELETED    0x0080  /* inode delete (backend) */
 275 #define HAMMER_INODE_DELONDISK  0x0100  /* delete synchronized to disk */
 276 #define HAMMER_INODE_RO         0x0200  /* read-only (because of as-of) */
 277 #define HAMMER_INODE_VHELD      0x0400  /* vnode held on sync */
 278 #define HAMMER_INODE_DONDISK    0x0800  /* data records may be on disk */
 279 #define HAMMER_INODE_BUFS       0x1000  /* dirty high level bps present */
 280 #define HAMMER_INODE_REFLUSH    0x2000  /* pipelined flush during flush */
 281 #define HAMMER_INODE_RECLAIM    0x4000  /* trying to reclaim */
 282 #define HAMMER_INODE_FLUSHW     0x8000  /* Someone waiting for flush */
 283
 284 #define HAMMER_INODE_TRUNCATED  0x00010000
 285 #define HAMMER_INODE_DELETING   0x00020000 /* inode delete request (frontend)*/
 286 #define HAMMER_INODE_RESIGNAL   0x00040000 /* re-signal on re-flush */
 287 #define HAMMER_INODE_ATIME      0x00100000 /* in-memory atime modified */
 288 #define HAMMER_INODE_MTIME      0x00100000 /* in-memory mtime modified */
 289
 290 #define HAMMER_INODE_MODMASK    (HAMMER_INODE_DDIRTY|                       \
 291                                  HAMMER_INODE_XDIRTY|HAMMER_INODE_BUFS|     \
 292                                  HAMMER_INODE_ATIME|HAMMER_INODE_MTIME|     \
 293                                  HAMMER_INODE_TRUNCATED|HAMMER_INODE_DELETING)
 294
 295 #define HAMMER_INODE_MODMASK_NOXDIRTY \
 296                                 (HAMMER_INODE_MODMASK & ~HAMMER_INODE_XDIRTY)
 297
 298 #define HAMMER_FLUSH_GROUP_SIZE 64
 299
 300 #define HAMMER_FLUSH_SIGNAL     0x0001
 301 #define HAMMER_FLUSH_RECURSION  0x0002
 302
 303 /*
 304  * Used by the inode reclaim code to pipeline reclaims and avoid
 305  * blowing out kernel memory or letting the flusher get too far
 306  * behind.
 307  */
 308 struct hammer_reclaim {
 309         TAILQ_ENTRY(hammer_reclaim) entry;
 310         int     okydoky;
 311 };
 312
 313 #define HAMMER_RECLAIM_FLUSH    2000
 314 #define HAMMER_RECLAIM_WAIT     4000
 315
 316 /*
 317  * Structure used to represent an unsynchronized record in-memory.  These
 318  * records typically represent directory entries.  Only non-historical
 319  * records are kept in-memory.
 320  *
 321  * Records are organized as a per-inode RB-Tree.  If the inode is not
 322  * on disk then neither are any records and the in-memory record tree
 323  * represents the entire contents of the inode.  If the inode is on disk
 324  * then the on-disk B-Tree is scanned in parallel with the in-memory
 325  * RB-Tree to synthesize the current state of the file.
 326  *
 327  * Records are also used to enforce the ordering of directory create/delete
 328  * operations.  A new inode will not be flushed to disk unless its related
 329  * directory entry is also being flushed at the same time.  A directory entry
 330  * will not be removed unless its related inode is also being removed at the
 331  * same time.
 332  */
 333 typedef enum hammer_record_type {
 334         HAMMER_MEM_RECORD_GENERAL,      /* misc record */
 335         HAMMER_MEM_RECORD_INODE,        /* inode record */
 336         HAMMER_MEM_RECORD_ADD,          /* positive memory cache record */
 337         HAMMER_MEM_RECORD_DEL,          /* negative delete-on-disk record */
 338         HAMMER_MEM_RECORD_DATA          /* bulk-data record w/on-disk ref */
 339 } hammer_record_type_t;
 340
 341 struct hammer_record {
 342         RB_ENTRY(hammer_record)         rb_node;
 343         TAILQ_ENTRY(hammer_record)      target_entry;
 344         hammer_inode_state_t            flush_state;
 345         int                             flush_group;
 346         hammer_record_type_t            type;
 347         struct hammer_lock              lock;
 348         struct hammer_reserve           *resv;
 349         struct hammer_inode             *ip;
 350         struct hammer_inode             *target_ip;
 351         struct hammer_btree_leaf_elm    leaf;
 352         union hammer_data_ondisk        *data;
 353         int                             flags;
 354 };
 355
 356 typedef struct hammer_record *hammer_record_t;
 357
 358 /*
 359  * Record flags.  Note that FE can only be set by the frontend if the
 360  * record has not been interlocked by the backend w/ BE.
 361  */
 362 #define HAMMER_RECF_ALLOCDATA           0x0001
 363 #define HAMMER_RECF_ONRBTREE            0x0002
 364 #define HAMMER_RECF_DELETED_FE          0x0004  /* deleted (frontend) */
 365 #define HAMMER_RECF_DELETED_BE          0x0008  /* deleted (backend) */
 366 #define HAMMER_RECF_UNUSED0010          0x0010
 367 #define HAMMER_RECF_INTERLOCK_BE        0x0020  /* backend interlock */
 368 #define HAMMER_RECF_WANTED              0x0040  /* wanted by the frontend */
 369 #define HAMMER_RECF_CONVERT_DELETE      0x0100 /* special case */
 370
 371 /*
 372  * In-memory structures representing on-disk structures.
 373  */
 374 struct hammer_volume;
 375 struct hammer_buffer;
 376 struct hammer_node;
 377 struct hammer_undo;
 378 struct hammer_reserve;
 379
 380 RB_HEAD(hammer_vol_rb_tree, hammer_volume);
 381 RB_HEAD(hammer_buf_rb_tree, hammer_buffer);
 382 RB_HEAD(hammer_nod_rb_tree, hammer_node);
 383 RB_HEAD(hammer_und_rb_tree, hammer_undo);
 384 RB_HEAD(hammer_res_rb_tree, hammer_reserve);
 385
 386 RB_PROTOTYPE2(hammer_vol_rb_tree, hammer_volume, rb_node,
 387               hammer_vol_rb_compare, int32_t);
 388 RB_PROTOTYPE2(hammer_buf_rb_tree, hammer_buffer, rb_node,
 389               hammer_buf_rb_compare, hammer_off_t);
 390 RB_PROTOTYPE2(hammer_nod_rb_tree, hammer_node, rb_node,
 391               hammer_nod_rb_compare, hammer_off_t);
 392 RB_PROTOTYPE2(hammer_und_rb_tree, hammer_undo, rb_node,
 393               hammer_und_rb_compare, hammer_off_t);
 394 RB_PROTOTYPE2(hammer_res_rb_tree, hammer_reserve, rb_node,
 395               hammer_res_rb_compare, hammer_off_t);
 396
 397 /*
 398  * IO management - embedded at the head of various in-memory structures
 399  *
 400  * VOLUME       - hammer_volume containing meta-data
 401  * META_BUFFER  - hammer_buffer containing meta-data
 402  * DATA_BUFFER  - hammer_buffer containing pure-data
 403  *
 404  * Dirty volume headers and dirty meta-data buffers are locked until the
 405  * flusher can sequence them out.  Dirty pure-data buffers can be written.
 406  * Clean buffers can be passively released.
 407  */
 408 typedef enum hammer_io_type {
 409         HAMMER_STRUCTURE_VOLUME,
 410         HAMMER_STRUCTURE_META_BUFFER,
 411         HAMMER_STRUCTURE_UNDO_BUFFER,
 412         HAMMER_STRUCTURE_DATA_BUFFER
 413 } hammer_io_type_t;
 414
 415 union hammer_io_structure;
 416 struct hammer_io;
 417
 418 struct worklist {
 419         LIST_ENTRY(worklist) node;
 420 };
 421
 422 TAILQ_HEAD(hammer_io_list, hammer_io);
 423 typedef struct hammer_io_list *hammer_io_list_t;
 424
 425 struct hammer_io {
 426         struct worklist         worklist;
 427         struct hammer_lock      lock;
 428         enum hammer_io_type     type;
 429         struct hammer_mount     *hmp;
 430         TAILQ_ENTRY(hammer_io)  mod_entry; /* list entry if modified */
 431         hammer_io_list_t        mod_list;
 432         struct buf              *bp;
 433         int64_t                 offset;    /* zone-2 offset */
 434         int                     bytes;     /* buffer cache buffer size */
 435         int                     loading;   /* loading/unloading interlock */
 436         int                     modify_refs;
 437
 438         u_int           modified : 1;   /* bp's data was modified */
 439         u_int           released : 1;   /* bp released (w/ B_LOCKED set) */
 440         u_int           running : 1;    /* bp write IO in progress */
 441         u_int           waiting : 1;    /* someone is waiting on us */
 442         u_int           validated : 1;  /* ondisk has been validated */
 443         u_int           waitdep : 1;    /* flush waits for dependancies */
 444         u_int           recovered : 1;  /* has recovery ref */
 445         u_int           waitmod : 1;    /* waiting for modify_refs */
 446         u_int           reclaim : 1;    /* reclaim requested */
 447         u_int           gencrc : 1;     /* crc needs to be generated */
 448 };
 449
 450 typedef struct hammer_io *hammer_io_t;
 451
 452 #define HAMMER_CLUSTER_SIZE     (64 * 1024)
 453 #if HAMMER_CLUSTER_SIZE > MAXBSIZE
 454 #undef  HAMMER_CLUSTER_SIZE
 455 #define HAMMER_CLUSTER_SIZE     MAXBSIZE
 456 #endif
 457 #define HAMMER_CLUSTER_BUFS     (HAMMER_CLUSTER_SIZE / HAMMER_BUFSIZE)
 458
 459 /*
 460  * In-memory volume representing on-disk buffer
 461  */
 462 struct hammer_volume {
 463         struct hammer_io io;
 464         RB_ENTRY(hammer_volume) rb_node;
 465         struct hammer_volume_ondisk *ondisk;
 466         int32_t vol_no;
 467         int64_t nblocks;        /* note: special calculation for statfs */
 468         int64_t buffer_base;    /* base offset of buffer 0 */
 469         hammer_off_t maxbuf_off; /* Maximum buffer offset (zone-2) */
 470         hammer_off_t maxraw_off; /* Maximum raw offset for device */
 471         char    *vol_name;
 472         struct vnode *devvp;
 473         int     vol_flags;
 474 };
 475
 476 typedef struct hammer_volume *hammer_volume_t;
 477
 478 /*
 479  * In-memory buffer (other then volume, super-cluster, or cluster),
 480  * representing an on-disk buffer.
 481  */
 482 struct hammer_buffer {
 483         struct hammer_io io;
 484         RB_ENTRY(hammer_buffer) rb_node;
 485         void *ondisk;
 486         struct hammer_volume *volume;
 487         hammer_off_t zoneX_offset;
 488         hammer_off_t zone2_offset;
 489         struct hammer_reserve *resv;
 490         struct hammer_node_list clist;
 491 };
 492
 493 typedef struct hammer_buffer *hammer_buffer_t;
 494
 495 /*
 496  * In-memory B-Tree node, representing an on-disk B-Tree node.
 497  *
 498  * This is a hang-on structure which is backed by a hammer_buffer,
 499  * indexed by a hammer_cluster, and used for fine-grained locking of
 500  * B-Tree nodes in order to properly control lock ordering.  A hammer_buffer
 501  * can contain multiple nodes representing wildly disassociated portions
 502  * of the B-Tree so locking cannot be done on a buffer-by-buffer basis.
 503  *
 504  * This structure uses a cluster-relative index to reduce the number
 505  * of layers required to access it, and also because all on-disk B-Tree
 506  * references are cluster-relative offsets.
 507  */
 508 struct hammer_node {
 509         struct hammer_lock      lock;           /* node-by-node lock */
 510         TAILQ_ENTRY(hammer_node) entry;         /* per-buffer linkage */
 511         RB_ENTRY(hammer_node)   rb_node;        /* per-cluster linkage */
 512         hammer_off_t            node_offset;    /* full offset spec */
 513         struct hammer_mount     *hmp;
 514         struct hammer_buffer    *buffer;        /* backing buffer */
 515         hammer_node_ondisk_t    ondisk;         /* ptr to on-disk structure */
 516         struct hammer_node_cache_list cache_list; /* passive caches */
 517         int                     flags;
 518         int                     loading;        /* load interlock */
 519 };
 520
 521 #define HAMMER_NODE_DELETED     0x0001
 522 #define HAMMER_NODE_FLUSH       0x0002
 523 #define HAMMER_NODE_CRCGOOD     0x0004
 524 #define HAMMER_NODE_NEEDSCRC    0x0008
 525
 526 typedef struct hammer_node      *hammer_node_t;
 527
 528 /*
 529  * List of locked nodes.
 530  */
 531 struct hammer_node_locklist {
 532         struct hammer_node_locklist *next;
 533         hammer_node_t   node;
 534 };
 535
 536 typedef struct hammer_node_locklist *hammer_node_locklist_t;
 537
 538
 539 /*
 540  * Common I/O management structure - embedded in in-memory structures
 541  * which are backed by filesystem buffers.
 542  */
 543 union hammer_io_structure {
 544         struct hammer_io        io;
 545         struct hammer_volume    volume;
 546         struct hammer_buffer    buffer;
 547 };
 548
 549 typedef union hammer_io_structure *hammer_io_structure_t;
 550
 551 /*
 552  * The reserve structure prevents the blockmap from allocating
 553  * out of a reserved bigblock.  Such reservations are used by
 554  * the direct-write mechanism.
 555  *
 556  * The structure is also used to hold off on reallocations of
 557  * big blocks from the freemap until flush dependancies have
 558  * been dealt with.
 559  */
 560 struct hammer_reserve {
 561         RB_ENTRY(hammer_reserve) rb_node;
 562         TAILQ_ENTRY(hammer_reserve) delay_entry;
 563         int             flush_group;
 564         int             flags;
 565         int             refs;
 566         int             zone;
 567         hammer_off_t    zone_offset;
 568 };
 569
 570 typedef struct hammer_reserve *hammer_reserve_t;
 571
 572 #define HAMMER_RESF_ONDELAY     0x0001
 573
 574 #include "hammer_cursor.h"
 575
 576 /*
 577  * The undo structure tracks recent undos to avoid laying down duplicate
 578  * undos within a flush group, saving us a significant amount of overhead.
 579  *
 580  * This is strictly a heuristic.
 581  */
 582 #define HAMMER_MAX_UNDOS        1024
 583 #define HAMMER_MAX_FLUSHERS     4
 584
 585 struct hammer_undo {
 586         RB_ENTRY(hammer_undo)   rb_node;
 587         TAILQ_ENTRY(hammer_undo) lru_entry;
 588         hammer_off_t            offset;
 589         int                     bytes;
 590 };
 591
 592 typedef struct hammer_undo *hammer_undo_t;
 593
 594 struct hammer_flusher_info;
 595
 596 struct hammer_flusher {
 597         int             signal;         /* flusher thread sequencer */
 598         int             act;            /* currently active flush group */
 599         int             done;           /* set to act when complete */
 600         int             next;           /* next flush group */
 601         int             group_lock;     /* lock sequencing of the next flush */
 602         int             exiting;        /* request master exit */
 603         int             count;          /* number of slave flushers */
 604         int             running;        /* number of slave flushers running */
 605         thread_t        td;             /* master flusher thread */
 606         hammer_tid_t    tid;            /* last flushed transaction id */
 607         int             finalize_want;          /* serialize finalization */
 608         struct hammer_lock finalize_lock;       /* serialize finalization */
 609         struct hammer_transaction trans;        /* shared transaction */
 610         struct hammer_flusher_info *info[HAMMER_MAX_FLUSHERS];
 611 };
 612
 613 /*
 614  * Internal hammer mount data structure
 615  */
 616 struct hammer_mount {
 617         struct mount *mp;
 618         /*struct vnode *rootvp;*/
 619         struct hammer_ino_rb_tree rb_inos_root;
 620         struct hammer_vol_rb_tree rb_vols_root;
 621         struct hammer_nod_rb_tree rb_nods_root;
 622         struct hammer_und_rb_tree rb_undo_root;
 623         struct hammer_res_rb_tree rb_resv_root;
 624         struct hammer_buf_rb_tree rb_bufs_root;
 625         struct hammer_volume *rootvol;
 626         struct hammer_base_elm root_btree_beg;
 627         struct hammer_base_elm root_btree_end;
 628         int     flags;
 629         int     hflags;
 630         int     ronly;
 631         int     nvolumes;
 632         int     volume_iterator;
 633         int     rsv_inodes;     /* reserved space due to dirty inodes */
 634         int     rsv_databufs;   /* reserved space due to dirty buffers */
 635         int     rsv_databytes;  /* reserved space due to record data */
 636         int     rsv_recs;       /* reserved space due to dirty records */
 637         int     last_newrecords;
 638         int     count_newrecords;
 639
 640         int     inode_reclaims; /* inodes pending reclaim by flusher */
 641         int     count_inodes;   /* total number of inodes */
 642         int     count_iqueued;  /* inodes queued to flusher */
 643
 644         struct hammer_flusher flusher;
 645
 646         u_int   check_interrupt;
 647         uuid_t  fsid;
 648         udev_t  fsid_udev;
 649         struct hammer_io_list volu_list;        /* dirty undo buffers */
 650         struct hammer_io_list undo_list;        /* dirty undo buffers */
 651         struct hammer_io_list data_list;        /* dirty data buffers */
 652         struct hammer_io_list alt_data_list;    /* dirty data buffers */
 653         struct hammer_io_list meta_list;        /* dirty meta bufs    */
 654         struct hammer_io_list lose_list;        /* loose buffers      */
 655         int     locked_dirty_count;             /* meta/volu count    */
 656         int     io_running_count;
 657         int     objid_cache_count;
 658         hammer_tid_t    asof;                   /* snapshot mount */
 659         hammer_off_t    next_tid;
 660         int64_t copy_stat_freebigblocks;        /* number of free bigblocks */
 661
 662         u_int32_t namekey_iterator;
 663         struct netexport export;
 664         struct hammer_lock sync_lock;
 665         struct hammer_lock free_lock;
 666         struct hammer_lock undo_lock;
 667         struct hammer_lock blkmap_lock;
 668         struct hammer_blockmap  blockmap[HAMMER_MAX_ZONES];
 669         struct hammer_undo      undos[HAMMER_MAX_UNDOS];
 670         int                     undo_alloc;
 671         TAILQ_HEAD(, hammer_undo)  undo_lru_list;
 672         TAILQ_HEAD(, hammer_inode) flush_list;
 673         TAILQ_HEAD(, hammer_reserve) delay_list;
 674         TAILQ_HEAD(, hammer_objid_cache) objid_cache_list;
 675         TAILQ_HEAD(, hammer_reclaim) reclaim_list;
 676 };
 677
 678 typedef struct hammer_mount     *hammer_mount_t;
 679
 680 #define HAMMER_MOUNT_UNUSED0001 0x0001
 681
 682 struct hammer_sync_info {
 683         int error;
 684         int waitfor;
 685 };
 686
 687 #endif
 688
 689 #if defined(_KERNEL)
 690
 691 extern struct vop_ops hammer_vnode_vops;
 692 extern struct vop_ops hammer_spec_vops;
 693 extern struct vop_ops hammer_fifo_vops;
 694 extern struct bio_ops hammer_bioops;
 695
 696 extern int hammer_debug_io;
 697 extern int hammer_debug_general;
 698 extern int hammer_debug_debug;
 699 extern int hammer_debug_inode;
 700 extern int hammer_debug_locks;
 701 extern int hammer_debug_btree;
 702 extern int hammer_debug_tid;
 703 extern int hammer_debug_recover;
 704 extern int hammer_debug_recover_faults;
 705 extern int hammer_debug_cluster_enable;
 706 extern int hammer_count_inodes;
 707 extern int hammer_count_iqueued;
 708 extern int hammer_count_reclaiming;
 709 extern int hammer_count_records;
 710 extern int hammer_count_record_datas;
 711 extern int hammer_count_volumes;
 712 extern int hammer_count_buffers;
 713 extern int hammer_count_nodes;
 714 extern int64_t hammer_stats_btree_lookups;
 715 extern int64_t hammer_stats_btree_searches;
 716 extern int64_t hammer_stats_btree_inserts;
 717 extern int64_t hammer_stats_btree_deletes;
 718 extern int64_t hammer_stats_btree_elements;
 719 extern int64_t hammer_stats_btree_splits;
 720 extern int64_t hammer_stats_btree_iterations;
 721 extern int64_t hammer_stats_record_iterations;
 722 extern int hammer_count_dirtybufs;
 723 extern int hammer_count_refedbufs;
 724 extern int hammer_count_reservations;
 725 extern int hammer_count_io_running_read;
 726 extern int hammer_count_io_running_write;
 727 extern int hammer_count_io_locked;
 728 extern int hammer_limit_dirtybufs;
 729 extern int hammer_limit_iqueued;
 730 extern int hammer_limit_recs;
 731 extern int hammer_bio_count;
 732 extern int hammer_verify_zone;
 733 extern int hammer_write_mode;
 734 extern int64_t hammer_contention_count;
 735
 736 int     hammer_vop_inactive(struct vop_inactive_args *);
 737 int     hammer_vop_reclaim(struct vop_reclaim_args *);
 738 int     hammer_get_vnode(struct hammer_inode *ip, struct vnode **vpp);
 739 struct hammer_inode *hammer_get_inode(hammer_transaction_t trans,
 740                         hammer_inode_t dip, u_int64_t obj_id,
 741                         hammer_tid_t asof, u_int32_t localization,
 742                         int flags, int *errorp);
 743 void    hammer_scan_inode_snapshots(hammer_mount_t hmp,
 744                         hammer_inode_info_t iinfo,
 745                         int (*callback)(hammer_inode_t ip, void *data),
 746                         void *data);
 747 void    hammer_put_inode(struct hammer_inode *ip);
 748 void    hammer_put_inode_ref(struct hammer_inode *ip);
 749 void    hammer_inode_waitreclaims(hammer_mount_t hmp);
 750
 751 int     hammer_unload_volume(hammer_volume_t volume, void *data __unused);
 752 int     hammer_adjust_volume_mode(hammer_volume_t volume, void *data __unused);
 753
 754 int     hammer_unload_buffer(hammer_buffer_t buffer, void *data __unused);
 755 int     hammer_install_volume(hammer_mount_t hmp, const char *volname);
 756
 757 int     hammer_ip_lookup(hammer_cursor_t cursor);
 758 int     hammer_ip_first(hammer_cursor_t cursor);
 759 int     hammer_ip_next(hammer_cursor_t cursor);
 760 int     hammer_ip_resolve_data(hammer_cursor_t cursor);
 761 int     hammer_ip_delete_record(hammer_cursor_t cursor, hammer_inode_t ip,
 762                         hammer_tid_t tid);
 763 int     hammer_delete_at_cursor(hammer_cursor_t cursor, int64_t *stat_bytes);
 764 int     hammer_ip_check_directory_empty(hammer_transaction_t trans,
 765                         hammer_inode_t ip);
 766 int     hammer_sync_hmp(hammer_mount_t hmp, int waitfor);
 767 int     hammer_queue_inodes_flusher(hammer_mount_t hmp, int waitfor);
 768
 769
 770 hammer_record_t
 771         hammer_alloc_mem_record(hammer_inode_t ip, int data_len);
 772 void    hammer_flush_record_done(hammer_record_t record, int error);
 773 void    hammer_wait_mem_record_ident(hammer_record_t record, const char *ident);
 774 void    hammer_rel_mem_record(hammer_record_t record);
 775
 776 int     hammer_cursor_up(hammer_cursor_t cursor);
 777 int     hammer_cursor_up_locked(hammer_cursor_t cursor);
 778 int     hammer_cursor_down(hammer_cursor_t cursor);
 779 int     hammer_cursor_upgrade(hammer_cursor_t cursor);
 780 int     hammer_cursor_upgrade_node(hammer_cursor_t cursor);
 781 void    hammer_cursor_downgrade(hammer_cursor_t cursor);
 782 int     hammer_cursor_seek(hammer_cursor_t cursor, hammer_node_t node,
 783                         int index);
 784 void    hammer_lock_ex_ident(struct hammer_lock *lock, const char *ident);
 785 int     hammer_lock_ex_try(struct hammer_lock *lock);
 786 void    hammer_lock_sh(struct hammer_lock *lock);
 787 void    hammer_lock_sh_lowpri(struct hammer_lock *lock);
 788 int     hammer_lock_sh_try(struct hammer_lock *lock);
 789 int     hammer_lock_upgrade(struct hammer_lock *lock);
 790 void    hammer_lock_downgrade(struct hammer_lock *lock);
 791 void    hammer_unlock(struct hammer_lock *lock);
 792 void    hammer_ref(struct hammer_lock *lock);
 793 void    hammer_unref(struct hammer_lock *lock);
 794
 795 void    hammer_sync_lock_ex(hammer_transaction_t trans);
 796 void    hammer_sync_lock_sh(hammer_transaction_t trans);
 797 int     hammer_sync_lock_sh_try(hammer_transaction_t trans);
 798 void    hammer_sync_unlock(hammer_transaction_t trans);
 799
 800 u_int32_t hammer_to_unix_xid(uuid_t *uuid);
 801 void hammer_guid_to_uuid(uuid_t *uuid, u_int32_t guid);
 802 void    hammer_time_to_timespec(u_int64_t xtime, struct timespec *ts);
 803 u_int64_t hammer_timespec_to_time(struct timespec *ts);
 804 hammer_tid_t hammer_now_tid(void);
 805 hammer_tid_t hammer_str_to_tid(const char *str);
 806 hammer_tid_t hammer_alloc_objid(hammer_transaction_t trans, hammer_inode_t dip);
 807 void hammer_clear_objid(hammer_inode_t dip);
 808 void hammer_destroy_objid_cache(hammer_mount_t hmp);
 809
 810 int hammer_enter_undo_history(hammer_mount_t hmp, hammer_off_t offset,
 811                               int bytes);
 812 void hammer_clear_undo_history(hammer_mount_t hmp);
 813 enum vtype hammer_get_vnode_type(u_int8_t obj_type);
 814 int hammer_get_dtype(u_int8_t obj_type);
 815 u_int8_t hammer_get_obj_type(enum vtype vtype);
 816 int64_t hammer_directory_namekey(const void *name, int len);
 817 int     hammer_nohistory(hammer_inode_t ip);
 818
 819 int     hammer_init_cursor(hammer_transaction_t trans, hammer_cursor_t cursor,
 820                            hammer_node_cache_t cache, hammer_inode_t ip);
 821 int     hammer_reinit_cursor(hammer_cursor_t cursor);
 822 void    hammer_normalize_cursor(hammer_cursor_t cursor);
 823 void    hammer_done_cursor(hammer_cursor_t cursor);
 824 void    hammer_mem_done(hammer_cursor_t cursor);
 825
 826 int     hammer_btree_lookup(hammer_cursor_t cursor);
 827 int     hammer_btree_first(hammer_cursor_t cursor);
 828 int     hammer_btree_last(hammer_cursor_t cursor);
 829 int     hammer_btree_extract(hammer_cursor_t cursor, int flags);
 830 int     hammer_btree_iterate(hammer_cursor_t cursor);
 831 int     hammer_btree_iterate_reverse(hammer_cursor_t cursor);
 832 int     hammer_btree_insert(hammer_cursor_t cursor,
 833                             hammer_btree_leaf_elm_t elm);
 834 int     hammer_btree_delete(hammer_cursor_t cursor);
 835 int     hammer_btree_cmp(hammer_base_elm_t key1, hammer_base_elm_t key2);
 836 int     hammer_btree_chkts(hammer_tid_t ts, hammer_base_elm_t key);
 837 int     hammer_btree_correct_rhb(hammer_cursor_t cursor, hammer_tid_t tid);
 838 int     hammer_btree_correct_lhb(hammer_cursor_t cursor, hammer_tid_t tid);
 839
 840 int     btree_set_parent(hammer_transaction_t trans, hammer_node_t node,
 841                         hammer_btree_elm_t elm);
 842 int     hammer_btree_lock_children(hammer_cursor_t cursor,
 843                         struct hammer_node_locklist **locklistp);
 844 void    hammer_btree_unlock_children(struct hammer_node_locklist **locklistp);
 845 int     hammer_btree_search_node(hammer_base_elm_t elm, hammer_node_ondisk_t node);
 846
 847 void    hammer_print_btree_node(hammer_node_ondisk_t ondisk);
 848 void    hammer_print_btree_elm(hammer_btree_elm_t elm, u_int8_t type, int i);
 849
 850 void    *hammer_bread(struct hammer_mount *hmp, hammer_off_t off,
 851                         int *errorp, struct hammer_buffer **bufferp);
 852 void    *hammer_bnew(struct hammer_mount *hmp, hammer_off_t off,
 853                         int *errorp, struct hammer_buffer **bufferp);
 854 void    *hammer_bread_ext(struct hammer_mount *hmp, hammer_off_t off, int bytes,
 855                         int *errorp, struct hammer_buffer **bufferp);
 856 void    *hammer_bnew_ext(struct hammer_mount *hmp, hammer_off_t off, int bytes,
 857                         int *errorp, struct hammer_buffer **bufferp);
 858
 859 hammer_volume_t hammer_get_root_volume(hammer_mount_t hmp, int *errorp);
 860
 861 hammer_volume_t hammer_get_volume(hammer_mount_t hmp,
 862                         int32_t vol_no, int *errorp);
 863 hammer_buffer_t hammer_get_buffer(hammer_mount_t hmp, hammer_off_t buf_offset,
 864                         int bytes, int isnew, int *errorp);
 865 void            hammer_del_buffers(hammer_mount_t hmp, hammer_off_t base_offset,
 866                         hammer_off_t zone2_offset, int bytes);
 867
 868 int             hammer_ref_volume(hammer_volume_t volume);
 869 int             hammer_ref_buffer(hammer_buffer_t buffer);
 870 void            hammer_flush_buffer_nodes(hammer_buffer_t buffer);
 871
 872 void            hammer_rel_volume(hammer_volume_t volume, int flush);
 873 void            hammer_rel_buffer(hammer_buffer_t buffer, int flush);
 874
 875 int             hammer_vfs_export(struct mount *mp, int op,
 876                         const struct export_args *export);
 877 hammer_node_t   hammer_get_node(hammer_mount_t hmp, hammer_off_t node_offset,
 878                         int isnew, int *errorp);
 879 void            hammer_ref_node(hammer_node_t node);
 880 hammer_node_t   hammer_ref_node_safe(struct hammer_mount *hmp,
 881                         hammer_node_cache_t cache, int *errorp);
 882 void            hammer_rel_node(hammer_node_t node);
 883 void            hammer_delete_node(hammer_transaction_t trans,
 884                         hammer_node_t node);
 885 void            hammer_cache_node(hammer_node_cache_t cache,
 886                         hammer_node_t node);
 887 void            hammer_uncache_node(hammer_node_cache_t cache);
 888 void            hammer_flush_node(hammer_node_t node);
 889
 890 void hammer_dup_buffer(struct hammer_buffer **bufferp,
 891                         struct hammer_buffer *buffer);
 892 hammer_node_t hammer_alloc_btree(hammer_transaction_t trans, int *errorp);
 893 void *hammer_alloc_data(hammer_transaction_t trans, int32_t data_len,
 894                         u_int16_t rec_type, hammer_off_t *data_offsetp,
 895                         struct hammer_buffer **data_bufferp, int *errorp);
 896
 897 int hammer_generate_undo(hammer_transaction_t trans, hammer_io_t io,
 898                         hammer_off_t zone1_offset, void *base, int len);
 899
 900 void hammer_put_volume(struct hammer_volume *volume, int flush);
 901 void hammer_put_buffer(struct hammer_buffer *buffer, int flush);
 902
 903 hammer_off_t hammer_freemap_alloc(hammer_transaction_t trans,
 904                         hammer_off_t owner, int *errorp);
 905 void hammer_freemap_free(hammer_transaction_t trans, hammer_off_t phys_offset,
 906                         hammer_off_t owner, int *errorp);
 907 int hammer_checkspace(hammer_mount_t hmp);
 908 hammer_off_t hammer_blockmap_alloc(hammer_transaction_t trans, int zone,
 909                         int bytes, int *errorp);
 910 hammer_reserve_t hammer_blockmap_reserve(hammer_mount_t hmp, int zone,
 911                         int bytes, hammer_off_t *zone_offp, int *errorp);
 912 void hammer_blockmap_reserve_complete(hammer_mount_t hmp,
 913                         hammer_reserve_t resv);
 914 void hammer_reserve_setdelay(hammer_mount_t hmp, hammer_reserve_t resv,
 915                         hammer_off_t zone2_offset);
 916 void hammer_reserve_clrdelay(hammer_mount_t hmp, hammer_reserve_t resv);
 917 void hammer_blockmap_free(hammer_transaction_t trans,
 918                         hammer_off_t bmap_off, int bytes);
 919 void hammer_blockmap_finalize(hammer_transaction_t trans,
 920                         hammer_off_t bmap_off, int bytes);
 921 int hammer_blockmap_getfree(hammer_mount_t hmp, hammer_off_t bmap_off,
 922                         int *curp, int *errorp);
 923 hammer_off_t hammer_blockmap_lookup(hammer_mount_t hmp, hammer_off_t bmap_off,
 924                         int *errorp);
 925 hammer_off_t hammer_undo_lookup(hammer_mount_t hmp, hammer_off_t bmap_off,
 926                         int *errorp);
 927 int64_t hammer_undo_used(hammer_mount_t hmp);
 928 int64_t hammer_undo_space(hammer_mount_t hmp);
 929 int64_t hammer_undo_max(hammer_mount_t hmp);
 930
 931 void hammer_start_transaction(struct hammer_transaction *trans,
 932                               struct hammer_mount *hmp);
 933 void hammer_simple_transaction(struct hammer_transaction *trans,
 934                               struct hammer_mount *hmp);
 935 void hammer_start_transaction_fls(struct hammer_transaction *trans,
 936                                   struct hammer_mount *hmp);
 937 void hammer_done_transaction(struct hammer_transaction *trans);
 938
 939 void hammer_modify_inode(hammer_inode_t ip, int flags);
 940 void hammer_flush_inode(hammer_inode_t ip, int flags);
 941 void hammer_flush_inode_done(hammer_inode_t ip);
 942 void hammer_wait_inode(hammer_inode_t ip);
 943
 944 int  hammer_create_inode(struct hammer_transaction *trans, struct vattr *vap,
 945                         struct ucred *cred, struct hammer_inode *dip,
 946                         int pseudofs, struct hammer_inode **ipp);
 947 void hammer_rel_inode(hammer_inode_t ip, int flush);
 948 int hammer_reload_inode(hammer_inode_t ip, void *arg __unused);
 949 int hammer_ino_rb_compare(hammer_inode_t ip1, hammer_inode_t ip2);
 950
 951 int hammer_sync_inode(hammer_inode_t ip);
 952 void hammer_test_inode(hammer_inode_t ip);
 953 void hammer_inode_unloadable_check(hammer_inode_t ip, int getvp);
 954
 955 int  hammer_ip_add_directory(struct hammer_transaction *trans,
 956                         hammer_inode_t dip, const char *name, int bytes,
 957                         hammer_inode_t nip);
 958 int  hammer_ip_del_directory(struct hammer_transaction *trans,
 959                         hammer_cursor_t cursor, hammer_inode_t dip,
 960                         hammer_inode_t ip);
 961 hammer_record_t hammer_ip_add_bulk(hammer_inode_t ip, off_t file_offset,
 962                         void *data, int bytes, int *errorp);
 963 int  hammer_ip_frontend_trunc(struct hammer_inode *ip, off_t file_size);
 964 int  hammer_ip_add_record(struct hammer_transaction *trans,
 965                         hammer_record_t record);
 966 int  hammer_ip_delete_range(hammer_cursor_t cursor, hammer_inode_t ip,
 967                         int64_t ran_beg, int64_t ran_end, int truncating);
 968 int  hammer_ip_delete_range_all(hammer_cursor_t cursor, hammer_inode_t ip,
 969                         int *countp);
 970 int  hammer_ip_sync_data(hammer_cursor_t cursor, hammer_inode_t ip,
 971                         int64_t offset, void *data, int bytes);
 972 int  hammer_ip_sync_record(hammer_transaction_t trans, hammer_record_t rec);
 973 int  hammer_ip_sync_record_cursor(hammer_cursor_t cursor, hammer_record_t rec);
 974
 975 int hammer_ioctl(hammer_inode_t ip, u_long com, caddr_t data, int fflag,
 976                         struct ucred *cred);
 977
 978 void hammer_io_init(hammer_io_t io, hammer_mount_t hmp,
 979                         enum hammer_io_type type);
 980 int hammer_io_read(struct vnode *devvp, struct hammer_io *io,
 981                         hammer_off_t limit);
 982 int hammer_io_new(struct vnode *devvp, struct hammer_io *io);
 983 void hammer_io_inval(hammer_volume_t volume, hammer_off_t zone2_offset);
 984 void hammer_io_release(struct hammer_io *io, int flush);
 985 void hammer_io_flush(struct hammer_io *io);
 986 void hammer_io_waitdep(struct hammer_io *io);
 987 void hammer_io_wait_all(hammer_mount_t hmp, const char *ident);
 988 int hammer_io_direct_read(hammer_mount_t hmp, struct bio *bio);
 989 int hammer_io_direct_write(hammer_mount_t hmp, hammer_btree_leaf_elm_t leaf,
 990                           struct bio *bio);
 991 void hammer_io_direct_uncache(hammer_mount_t hmp, hammer_btree_leaf_elm_t leaf);
 992 void hammer_io_write_interlock(hammer_io_t io);
 993 void hammer_io_done_interlock(hammer_io_t io);
 994 void hammer_io_clear_modify(struct hammer_io *io, int inval);
 995 void hammer_io_clear_modlist(struct hammer_io *io);
 996 void hammer_modify_volume(hammer_transaction_t trans, hammer_volume_t volume,
 997                         void *base, int len);
 998 void hammer_modify_buffer(hammer_transaction_t trans, hammer_buffer_t buffer,
 999                         void *base, int len);
1000 void hammer_modify_volume_done(hammer_volume_t volume);
1001 void hammer_modify_buffer_done(hammer_buffer_t buffer);
1002
1003 int hammer_ioc_reblock(hammer_transaction_t trans, hammer_inode_t ip,
1004                         struct hammer_ioc_reblock *reblock);
1005 int hammer_ioc_prune(hammer_transaction_t trans, hammer_inode_t ip,
1006                         struct hammer_ioc_prune *prune);
1007
1008 int hammer_signal_check(hammer_mount_t hmp);
1009
1010 void hammer_flusher_create(hammer_mount_t hmp);
1011 void hammer_flusher_destroy(hammer_mount_t hmp);
1012 void hammer_flusher_sync(hammer_mount_t hmp);
1013 void hammer_flusher_async(hammer_mount_t hmp);
1014
1015 int hammer_recover(hammer_mount_t hmp, hammer_volume_t rootvol);
1016 void hammer_recover_flush_buffers(hammer_mount_t hmp,
1017                         hammer_volume_t root_volume);
1018
1019 void hammer_crc_set_blockmap(hammer_blockmap_t blockmap);
1020 void hammer_crc_set_volume(hammer_volume_ondisk_t ondisk);
1021 void hammer_crc_set_leaf(void *data, hammer_btree_leaf_elm_t leaf);
1022
1023 int hammer_crc_test_blockmap(hammer_blockmap_t blockmap);
1024 int hammer_crc_test_volume(hammer_volume_ondisk_t ondisk);
1025 int hammer_crc_test_btree(hammer_node_ondisk_t ondisk);
1026 int hammer_crc_test_leaf(void *data, hammer_btree_leaf_elm_t leaf);
1027 void hkprintf(const char *ctl, ...);
1028
1029 int hammer_blocksize(int64_t file_offset);
1030 int64_t hammer_blockdemarc(int64_t file_offset1, int64_t file_offset2);
1031
1032 #endif
1033
1034 static __inline void
1035 hammer_wait_mem_record(hammer_record_t record)
1036 {
1037         hammer_wait_mem_record_ident(record, "hmmwai");
1038 }
1039
1040 static __inline void
1041 hammer_lock_ex(struct hammer_lock *lock)
1042 {
1043         hammer_lock_ex_ident(lock, "hmrlck");
1044 }
1045
1046 /*
1047  * Indicate that a B-Tree node is being modified.
1048  */
1049 static __inline void
1050 hammer_modify_node_noundo(hammer_transaction_t trans, hammer_node_t node)
1051 {
1052         hammer_modify_buffer(trans, node->buffer, NULL, 0);
1053 }
1054
1055 static __inline void
1056 hammer_modify_node_all(hammer_transaction_t trans, struct hammer_node *node)
1057 {
1058         hammer_modify_buffer(trans, node->buffer,
1059                              node->ondisk, sizeof(*node->ondisk));
1060 }
1061
1062 static __inline void
1063 hammer_modify_node(hammer_transaction_t trans, hammer_node_t node,
1064                    void *base, int len)
1065 {
1066         hammer_crc_t *crcptr;
1067
1068         KKASSERT((char *)base >= (char *)node->ondisk &&
1069                  (char *)base + len <=
1070                     (char *)node->ondisk + sizeof(*node->ondisk));
1071         hammer_modify_buffer(trans, node->buffer, base, len);
1072         crcptr = &node->ondisk->crc;
1073         hammer_modify_buffer(trans, node->buffer, crcptr, sizeof(hammer_crc_t));
1074         --node->buffer->io.modify_refs; /* only want one ref */
1075 }
1076
1077 /*
1078  * Indicate that the specified modifications have been completed.
1079  *
1080  * Do not try to generate the crc here, it's very expensive to do and a
1081  * sequence of insertions or deletions can result in many calls to this
1082  * function on the same node.
1083  */
1084 static __inline void
1085 hammer_modify_node_done(hammer_node_t node)
1086 {
1087         node->flags |= HAMMER_NODE_CRCGOOD;
1088         if ((node->flags & HAMMER_NODE_NEEDSCRC) == 0) {
1089                 node->flags |= HAMMER_NODE_NEEDSCRC;
1090                 node->buffer->io.gencrc = 1;
1091                 hammer_ref_node(node);
1092         }
1093         hammer_modify_buffer_done(node->buffer);
1094 }
1095
1096 #define hammer_modify_volume_field(trans, vol, field)           \
1097         hammer_modify_volume(trans, vol, &(vol)->ondisk->field, \
1098                              sizeof((vol)->ondisk->field))
1099
1100 #define hammer_modify_node_field(trans, node, field)            \
1101         hammer_modify_node(trans, node, &(node)->ondisk->field, \
1102                              sizeof((node)->ondisk->field))
1103