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