sys/vfs/hammer/hammer.h

   1 /*
   2  * Copyright (c) 2007 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.20 2008/01/09 00:46:22 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/systm.h>
  45 #include <sys/tree.h>
  46 #include <sys/malloc.h>
  47 #include <sys/mount.h>
  48 #include <sys/vnode.h>
  49 #include <sys/globaldata.h>
  50 #include <sys/lockf.h>
  51 #include <sys/buf.h>
  52 #include <sys/queue.h>
  53 #include <sys/globaldata.h>
  54
  55 #include <sys/buf2.h>
  56 #include "hammer_alist.h"
  57 #include "hammer_disk.h"
  58 #include "hammer_mount.h"
  59
  60 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
  61
  62 MALLOC_DECLARE(M_HAMMER);
  63
  64 struct hammer_mount;
  65
  66 /*
  67  * Key structure used for custom RB tree inode lookups.  This prototypes
  68  * the function hammer_ino_rb_tree_RB_LOOKUP_INFO(root, info).
  69  */
  70 typedef struct hammer_inode_info {
  71         u_int64_t       obj_id;         /* (key) object identifier */
  72         hammer_tid_t    obj_asof;       /* (key) snapshot transid or 0 */
  73 } *hammer_inode_info_t;
  74
  75 /*
  76  * HAMMER Transaction tracking
  77  */
  78 struct hammer_transaction {
  79         struct hammer_mount *hmp;
  80         hammer_tid_t    tid;
  81         struct hammer_volume *rootvol;
  82 };
  83
  84 typedef struct hammer_transaction *hammer_transaction_t;
  85
  86 /*
  87  * HAMMER locks
  88  */
  89 struct hammer_lock {
  90         int     refs;           /* active references delay writes */
  91         int     modifying;      /* indicates buffer being modified */
  92         int     lockcount;      /* lock count for exclusive/shared access */
  93         int     wanted;
  94         struct thread *locktd;
  95 };
  96
  97 static __inline int
  98 hammer_islocked(struct hammer_lock *lock)
  99 {
 100         return(lock->lockcount != 0);
 101 }
 102
 103 static __inline int
 104 hammer_isactive(struct hammer_lock *lock)
 105 {
 106         return(lock->refs != 0);
 107 }
 108
 109 static __inline int
 110 hammer_islastref(struct hammer_lock *lock)
 111 {
 112         return(lock->refs == 1);
 113 }
 114
 115 /*
 116  * Structure used to represent an inode in-memory.
 117  *
 118  * The record and data associated with an inode may be out of sync with
 119  * the disk (xDIRTY flags), or not even on the disk at all (ONDISK flag
 120  * clear).
 121  *
 122  * An inode may also hold a cache of unsynchronized records, used for
 123  * database and directories only.  Unsynchronized regular file data is
 124  * stored in the buffer cache.
 125  *
 126  * NOTE: A file which is created and destroyed within the initial
 127  * synchronization period can wind up not doing any disk I/O at all.
 128  *
 129  * Finally, an inode may cache numerous disk-referencing B-Tree cursors.
 130  */
 131 struct hammer_ino_rb_tree;
 132 struct hammer_inode;
 133 RB_HEAD(hammer_ino_rb_tree, hammer_inode);
 134 RB_PROTOTYPEX(hammer_ino_rb_tree, INFO, hammer_inode, rb_node,
 135               hammer_ino_rb_compare, hammer_inode_info_t);
 136
 137 struct hammer_rec_rb_tree;
 138 struct hammer_record;
 139 RB_HEAD(hammer_rec_rb_tree, hammer_record);
 140 RB_PROTOTYPEX(hammer_rec_rb_tree, INFO, hammer_record, rb_node,
 141               hammer_rec_rb_compare, hammer_base_elm_t);
 142
 143 TAILQ_HEAD(hammer_node_list, hammer_node);
 144
 145 struct hammer_inode {
 146         RB_ENTRY(hammer_inode) rb_node;
 147         u_int64_t       obj_id;         /* (key) object identifier */
 148         hammer_tid_t    obj_asof;       /* (key) snapshot transid or 0 */
 149         hammer_tid_t    last_tid;       /* last modified tid (for fsync) */
 150         struct hammer_mount *hmp;
 151         int             flags;
 152         struct vnode    *vp;
 153         struct lockf    advlock;
 154         struct hammer_lock lock;
 155         struct hammer_inode_record ino_rec;
 156         struct hammer_inode_data ino_data;
 157         struct hammer_rec_rb_tree rec_tree;     /* red-black record tree */
 158         struct hammer_node      *cache[2];      /* search initiate cache */
 159 };
 160
 161 typedef struct hammer_inode *hammer_inode_t;
 162
 163 #define VTOI(vp)        ((struct hammer_inode *)(vp)->v_data)
 164
 165 #define HAMMER_INODE_DDIRTY     0x0001  /* in-memory ino_data is dirty */
 166 #define HAMMER_INODE_RDIRTY     0x0002  /* in-memory ino_rec is dirty */
 167 #define HAMMER_INODE_ITIMES     0x0004  /* in-memory mtime/atime modified */
 168 #define HAMMER_INODE_XDIRTY     0x0008  /* in-memory records present */
 169 #define HAMMER_INODE_ONDISK     0x0010  /* inode is on-disk (else not yet) */
 170 #define HAMMER_INODE_FLUSH      0x0020  /* flush on last ref */
 171 #define HAMMER_INODE_DELETED    0x0080  /* inode ready for deletion */
 172 #define HAMMER_INODE_DELONDISK  0x0100  /* delete synchronized to disk */
 173 #define HAMMER_INODE_RO         0x0200  /* read-only (because of as-of) */
 174 #define HAMMER_INODE_GONE       0x0400  /* delete flushed out */
 175
 176 #define HAMMER_INODE_MODMASK    (HAMMER_INODE_DDIRTY|HAMMER_INODE_RDIRTY| \
 177                                  HAMMER_INODE_XDIRTY|\
 178                                  HAMMER_INODE_ITIMES|HAMMER_INODE_DELETED)
 179
 180 #define HAMMER_MAX_INODE_CURSORS        4
 181
 182 /*
 183  * Structure used to represent an unsynchronized record in-memory.  This
 184  * structure is orgranized in a per-inode RB-tree.  If the inode is not
 185  * on disk then neither are any records and the in-memory record tree
 186  * represents the entire contents of the inode.  If the inode is on disk
 187  * then the on-disk B-Tree is scanned in parallel with the in-memory
 188  * RB-Tree to synthesize the current state of the file.
 189  *
 190  * Only current (delete_tid == 0) unsynchronized records are kept in-memory.
 191  */
 192 struct hammer_record {
 193         RB_ENTRY(hammer_record)         rb_node;
 194         struct hammer_lock              lock;
 195         struct hammer_inode             *ip;
 196         union hammer_record_ondisk      rec;
 197         union hammer_data_ondisk        *data;
 198         int                             flags;
 199 };
 200
 201 typedef struct hammer_record *hammer_record_t;
 202
 203 #define HAMMER_RECF_ALLOCDATA           0x0001
 204 #define HAMMER_RECF_ONRBTREE            0x0002
 205 #define HAMMER_RECF_DELETED             0x0004
 206 #define HAMMER_RECF_EMBEDDED_DATA       0x0008
 207 #define HAMMER_RECF_SYNCING             0x0010
 208
 209 /*
 210  * Structures used to internally represent a volume and a cluster
 211  */
 212 struct hammer_volume;
 213 struct hammer_cluster;
 214 struct hammer_supercl;
 215 struct hammer_buffer;
 216 struct hammer_node;
 217 RB_HEAD(hammer_vol_rb_tree, hammer_volume);
 218 RB_HEAD(hammer_clu_rb_tree, hammer_cluster);
 219 RB_HEAD(hammer_scl_rb_tree, hammer_supercl);
 220 RB_HEAD(hammer_buf_rb_tree, hammer_buffer);
 221 RB_HEAD(hammer_nod_rb_tree, hammer_node);
 222
 223 RB_PROTOTYPE2(hammer_vol_rb_tree, hammer_volume, rb_node,
 224               hammer_vol_rb_compare, int32_t);
 225 RB_PROTOTYPE2(hammer_clu_rb_tree, hammer_cluster, rb_node,
 226               hammer_clu_rb_compare, int32_t);
 227 RB_PROTOTYPE2(hammer_scl_rb_tree, hammer_supercl, rb_node,
 228               hammer_scl_rb_compare, int32_t);
 229 RB_PROTOTYPE2(hammer_buf_rb_tree, hammer_buffer, rb_node,
 230               hammer_buf_rb_compare, int32_t);
 231 RB_PROTOTYPE2(hammer_nod_rb_tree, hammer_node, rb_node,
 232               hammer_nod_rb_compare, int32_t);
 233
 234 /*
 235  * IO management - embedded at the head of various in-memory structures
 236  */
 237 enum hammer_io_type { HAMMER_STRUCTURE_VOLUME,
 238                       HAMMER_STRUCTURE_SUPERCL,
 239                       HAMMER_STRUCTURE_CLUSTER,
 240                       HAMMER_STRUCTURE_BUFFER };
 241
 242 union hammer_io_structure;
 243
 244 struct worklist {
 245         LIST_ENTRY(worklist) node;
 246 };
 247
 248 struct hammer_io {
 249         struct worklist worklist;
 250         struct hammer_lock lock;
 251         enum hammer_io_type type;
 252         struct buf      *bp;
 253         int64_t         offset;
 254         u_int           modified : 1;   /* bp's data was modified */
 255         u_int           released : 1;   /* bp released (w/ B_LOCKED set) */
 256 };
 257
 258 typedef struct hammer_io *hammer_io_t;
 259
 260 /*
 261  * In-memory volume representing on-disk buffer
 262  */
 263 struct hammer_volume {
 264         struct hammer_io io;
 265         RB_ENTRY(hammer_volume) rb_node;
 266         struct hammer_clu_rb_tree rb_clus_root;
 267         struct hammer_scl_rb_tree rb_scls_root;
 268         struct hammer_volume_ondisk *ondisk;
 269         struct hammer_alist_live alist;
 270         int32_t vol_no;
 271         int32_t vol_clsize;
 272         int32_t clu_iterator;   /* cluster allocation iterator */
 273         int64_t nblocks;        /* note: special calculation for statfs */
 274         int64_t cluster_base;   /* base offset of cluster 0 */
 275         char    *vol_name;
 276         struct vnode *devvp;
 277         struct hammer_mount *hmp;
 278         int     vol_flags;
 279 };
 280
 281 typedef struct hammer_volume *hammer_volume_t;
 282
 283 /*
 284  * In-memory super-cluster representing on-disk buffer
 285  */
 286 struct hammer_supercl {
 287         struct hammer_io io;
 288         RB_ENTRY(hammer_supercl) rb_node;
 289         struct hammer_supercl_ondisk *ondisk;
 290         struct hammer_volume *volume;
 291         struct hammer_alist_live alist;
 292         int32_t scl_no;
 293 };
 294
 295 typedef struct hammer_supercl *hammer_supercl_t;
 296
 297 enum hammer_cluster_state {
 298         HAMMER_CLUSTER_IDLE,
 299         HAMMER_CLUSTER_ASYNC,
 300         HAMMER_CLUSTER_OPEN
 301 };
 302
 303 /*
 304  * In-memory cluster representing on-disk buffer
 305  *
 306  * The cluster's indexing range is cached in hammer_cluster, separate
 307  * from the ondisk info in order to allow cursors to point to it.
 308  */
 309 struct hammer_cluster {
 310         struct hammer_io io;
 311         RB_ENTRY(hammer_cluster) rb_node;
 312         struct hammer_buf_rb_tree rb_bufs_root;
 313         struct hammer_cluster_ondisk *ondisk;
 314         struct hammer_volume *volume;
 315         struct hammer_alist_live alist_master;
 316         struct hammer_alist_live alist_btree;
 317         struct hammer_alist_live alist_record;
 318         struct hammer_alist_live alist_mdata;
 319         struct hammer_nod_rb_tree rb_nods_root; /* cursors in cluster */
 320         struct hammer_base_elm clu_btree_beg;   /* copy of on-disk info */
 321         struct hammer_base_elm clu_btree_end;   /* copy of on-disk info */
 322         int32_t clu_no;
 323         enum hammer_cluster_state state;
 324 };
 325
 326 typedef struct hammer_cluster *hammer_cluster_t;
 327
 328 /*
 329  * In-memory buffer (other then volume, super-cluster, or cluster),
 330  * representing an on-disk buffer.
 331  */
 332 struct hammer_buffer {
 333         struct hammer_io io;
 334         RB_ENTRY(hammer_buffer) rb_node;
 335         hammer_fsbuf_ondisk_t ondisk;
 336         struct hammer_volume *volume;
 337         struct hammer_cluster *cluster;
 338         int32_t buf_no;
 339         u_int64_t buf_type;
 340         struct hammer_alist_live alist;
 341         struct hammer_node_list clist;
 342         struct hammer_node *save_scan;
 343 };
 344
 345 typedef struct hammer_buffer *hammer_buffer_t;
 346
 347 /*
 348  * In-memory B-Tree node, representing an on-disk B-Tree node.
 349  *
 350  * This is a hang-on structure which is backed by a hammer_buffer,
 351  * indexed by a hammer_cluster, and used for fine-grained locking of
 352  * B-Tree nodes in order to properly control lock ordering.  A hammer_buffer
 353  * can contain multiple nodes representing wildly disassociated portions
 354  * of the B-Tree so locking cannot be done on a buffer-by-buffer basis.
 355  *
 356  * This structure uses a cluster-relative index to reduce the number
 357  * of layers required to access it, and also because all on-disk B-Tree
 358  * references are cluster-relative offsets.
 359  */
 360 struct hammer_node {
 361         struct hammer_lock      lock;           /* node-by-node lock */
 362         TAILQ_ENTRY(hammer_node) entry;         /* per-buffer linkage */
 363         RB_ENTRY(hammer_node)   rb_node;        /* per-cluster linkage */
 364         int32_t                 node_offset;    /* cluster-rel offset */
 365         struct hammer_cluster   *cluster;
 366         struct hammer_buffer    *buffer;        /* backing buffer */
 367         hammer_node_ondisk_t    ondisk;         /* ptr to on-disk structure */
 368         struct hammer_node      **cache1;       /* passive cache(s) */
 369         struct hammer_node      **cache2;
 370         int                     flags;
 371 };
 372
 373 #define HAMMER_NODE_DELETED     0x0001
 374 #define HAMMER_NODE_FLUSH       0x0002
 375 #define HAMMER_NODE_MODIFIED    0x0004
 376
 377 typedef struct hammer_node      *hammer_node_t;
 378
 379 /*
 380  * Common I/O management structure - embedded in in-memory structures
 381  * which are backed by filesystem buffers.
 382  */
 383 union hammer_io_structure {
 384         struct hammer_io        io;
 385         struct hammer_volume    volume;
 386         struct hammer_supercl   supercl;
 387         struct hammer_cluster   cluster;
 388         struct hammer_buffer    buffer;
 389 };
 390
 391 #define HAMFS_CLUSTER_DIRTY     0x0001
 392
 393 #include "hammer_cursor.h"
 394
 395 /*
 396  * Internal hammer mount data structure
 397  */
 398 struct hammer_mount {
 399         struct mount *mp;
 400         /*struct vnode *rootvp;*/
 401         struct hammer_ino_rb_tree rb_inos_root;
 402         struct hammer_vol_rb_tree rb_vols_root;
 403         struct hammer_volume *rootvol;
 404         struct hammer_cluster *rootcl;
 405         char    *zbuf;  /* HAMMER_BUFSIZE bytes worth of all-zeros */
 406         int     hflags;
 407         int     ronly;
 408         int     nvolumes;
 409         int     volume_iterator;
 410         uuid_t  fsid;
 411         udev_t  fsid_udev;
 412         hammer_tid_t asof;
 413         u_int32_t namekey_iterator;
 414 };
 415
 416 typedef struct hammer_mount     *hammer_mount_t;
 417
 418 struct hammer_sync_info {
 419         int error;
 420         int waitfor;
 421 };
 422
 423 #endif
 424
 425 #if defined(_KERNEL)
 426
 427 extern struct vop_ops hammer_vnode_vops;
 428 extern struct vop_ops hammer_spec_vops;
 429 extern struct vop_ops hammer_fifo_vops;
 430 extern struct hammer_alist_config Buf_alist_config;
 431 extern struct hammer_alist_config Vol_normal_alist_config;
 432 extern struct hammer_alist_config Vol_super_alist_config;
 433 extern struct hammer_alist_config Supercl_alist_config;
 434 extern struct hammer_alist_config Clu_master_alist_config;
 435 extern struct hammer_alist_config Clu_slave_alist_config;
 436 extern struct bio_ops hammer_bioops;
 437
 438 extern int hammer_debug_btree;
 439 extern int hammer_debug_tid;
 440 extern int hammer_count_inodes;
 441 extern int hammer_count_records;
 442 extern int hammer_count_record_datas;
 443 extern int hammer_count_volumes;
 444 extern int hammer_count_supercls;
 445 extern int hammer_count_clusters;
 446 extern int hammer_count_buffers;
 447 extern int hammer_count_nodes;
 448 extern int hammer_count_spikes;
 449
 450 int     hammer_vop_inactive(struct vop_inactive_args *);
 451 int     hammer_vop_reclaim(struct vop_reclaim_args *);
 452 int     hammer_vfs_vget(struct mount *mp, ino_t ino, struct vnode **vpp);
 453 int     hammer_get_vnode(struct hammer_inode *ip, int lktype,
 454                         struct vnode **vpp);
 455 struct hammer_inode *hammer_get_inode(hammer_mount_t hmp,
 456                         struct hammer_node **cache,
 457                         u_int64_t obj_id, hammer_tid_t asof, int flags,
 458                         int *errorp);
 459 void    hammer_put_inode(struct hammer_inode *ip);
 460 void    hammer_put_inode_ref(struct hammer_inode *ip);
 461
 462 int     hammer_unload_inode(hammer_inode_t ip, void *data);
 463 int     hammer_unload_volume(hammer_volume_t volume, void *data __unused);
 464 int     hammer_unload_supercl(hammer_supercl_t supercl, void *data __unused);
 465 int     hammer_unload_cluster(hammer_cluster_t cluster, void *data __unused);
 466 void    hammer_update_syncid(hammer_cluster_t cluster, hammer_tid_t tid);
 467 int     hammer_unload_buffer(hammer_buffer_t buffer, void *data __unused);
 468 int     hammer_install_volume(hammer_mount_t hmp, const char *volname);
 469
 470 int     hammer_ip_lookup(hammer_cursor_t cursor, hammer_inode_t ip);
 471 int     hammer_ip_first(hammer_cursor_t cursor, hammer_inode_t ip);
 472 int     hammer_ip_next(hammer_cursor_t cursor);
 473 int     hammer_ip_resolve_data(hammer_cursor_t cursor);
 474 int     hammer_ip_delete_record(hammer_cursor_t cursor, hammer_tid_t tid);
 475 int     hammer_ip_check_directory_empty(hammer_transaction_t trans,
 476                         hammer_inode_t ip);
 477 int     hammer_sync_hmp(hammer_mount_t hmp, int waitfor);
 478 int     hammer_sync_volume(hammer_volume_t volume, void *data);
 479 int     hammer_sync_cluster(hammer_cluster_t cluster, void *data);
 480 int     hammer_sync_buffer(hammer_buffer_t buffer, void *data);
 481
 482 hammer_record_t
 483         hammer_alloc_mem_record(hammer_inode_t ip);
 484 void    hammer_rel_mem_record(hammer_record_t record);
 485
 486 int     hammer_cursor_up(hammer_cursor_t cursor, int nonblock);
 487 int     hammer_cursor_toroot(hammer_cursor_t cursor);
 488 int     hammer_cursor_down(hammer_cursor_t cursor);
 489
 490 void    hammer_lock_ex(struct hammer_lock *lock);
 491 int     hammer_lock_ex_try(struct hammer_lock *lock);
 492 void    hammer_lock_sh(struct hammer_lock *lock);
 493 void    hammer_unlock(struct hammer_lock *lock);
 494 void    hammer_ref(struct hammer_lock *lock);
 495 void    hammer_unref(struct hammer_lock *lock);
 496 void    hammer_downgrade(struct hammer_lock *lock);
 497
 498 u_int32_t hammer_to_unix_xid(uuid_t *uuid);
 499 void hammer_guid_to_uuid(uuid_t *uuid, u_int32_t guid);
 500 void    hammer_to_timespec(hammer_tid_t tid, struct timespec *ts);
 501 hammer_tid_t hammer_timespec_to_transid(struct timespec *ts);
 502 hammer_tid_t hammer_alloc_tid(hammer_transaction_t trans);
 503 hammer_tid_t hammer_now_tid(void);
 504 hammer_tid_t hammer_str_to_tid(const char *str);
 505 hammer_tid_t hammer_alloc_recid(hammer_transaction_t trans);
 506
 507 enum vtype hammer_get_vnode_type(u_int8_t obj_type);
 508 int hammer_get_dtype(u_int8_t obj_type);
 509 u_int8_t hammer_get_obj_type(enum vtype vtype);
 510 int64_t hammer_directory_namekey(void *name, int len);
 511
 512 int     hammer_init_cursor_hmp(hammer_cursor_t cursor, struct hammer_node **cache, hammer_mount_t hmp);
 513 int     hammer_init_cursor_cluster(hammer_cursor_t cursor, hammer_cluster_t cluster);
 514
 515 void    hammer_done_cursor(hammer_cursor_t cursor);
 516 void    hammer_mem_done(hammer_cursor_t cursor);
 517
 518 int     hammer_btree_lookup(hammer_cursor_t cursor);
 519 int     hammer_btree_first(hammer_cursor_t cursor);
 520 int     hammer_btree_extract(hammer_cursor_t cursor, int flags);
 521 int     hammer_btree_iterate(hammer_cursor_t cursor);
 522 int     hammer_btree_insert(hammer_cursor_t cursor, hammer_btree_elm_t elm);
 523 int     hammer_btree_delete(hammer_cursor_t cursor);
 524 int     hammer_btree_cmp(hammer_base_elm_t key1, hammer_base_elm_t key2);
 525 int     hammer_btree_chkts(hammer_tid_t ts, hammer_base_elm_t key);
 526 void    hammer_print_btree_node(hammer_node_ondisk_t ondisk);
 527 void    hammer_print_btree_elm(hammer_btree_elm_t elm, u_int8_t type, int i);
 528
 529 void    *hammer_bread(struct hammer_cluster *cluster, int32_t cloff,
 530                       u_int64_t buf_type, int *errorp,
 531                       struct hammer_buffer **bufferp);
 532
 533 hammer_volume_t hammer_get_root_volume(hammer_mount_t hmp, int *errorp);
 534 hammer_cluster_t hammer_get_root_cluster(hammer_mount_t hmp, int *errorp);
 535
 536 hammer_volume_t hammer_get_volume(hammer_mount_t hmp,
 537                         int32_t vol_no, int *errorp);
 538 hammer_supercl_t hammer_get_supercl(hammer_volume_t volume, int32_t scl_no,
 539                         int *errorp, hammer_alloc_state_t isnew);
 540 hammer_cluster_t hammer_get_cluster(hammer_volume_t volume, int32_t clu_no,
 541                         int *errorp, hammer_alloc_state_t isnew);
 542 hammer_buffer_t hammer_get_buffer(hammer_cluster_t cluster,
 543                         int32_t buf_no, u_int64_t buf_type, int *errorp);
 544
 545 int             hammer_ref_volume(hammer_volume_t volume);
 546 int             hammer_ref_cluster(hammer_cluster_t cluster);
 547 int             hammer_ref_buffer(hammer_buffer_t buffer);
 548 void            hammer_flush_buffer_nodes(hammer_buffer_t buffer);
 549
 550
 551 void            hammer_rel_volume(hammer_volume_t volume, int flush);
 552 void            hammer_rel_supercl(hammer_supercl_t supercl, int flush);
 553 void            hammer_rel_cluster(hammer_cluster_t cluster, int flush);
 554 void            hammer_rel_buffer(hammer_buffer_t buffer, int flush);
 555
 556 hammer_node_t   hammer_get_node(hammer_cluster_t cluster,
 557                         int32_t node_offset, int *errorp);
 558 int             hammer_ref_node(hammer_node_t node);
 559 void            hammer_rel_node(hammer_node_t node);
 560 void            hammer_cache_node(hammer_node_t node,
 561                         struct hammer_node **cache);
 562 void            hammer_uncache_node(struct hammer_node **cache);
 563 void            hammer_flush_node(hammer_node_t node);
 564
 565 void hammer_dup_buffer(struct hammer_buffer **bufferp,
 566                         struct hammer_buffer *buffer);
 567 void hammer_dup_cluster(struct hammer_cluster **clusterp,
 568                         struct hammer_cluster *cluster);
 569 hammer_cluster_t hammer_alloc_cluster(hammer_mount_t hmp,
 570                         hammer_cluster_t cluster_hint, int *errorp);
 571 void hammer_init_cluster(hammer_cluster_t cluster,
 572                         hammer_base_elm_t left_bound,
 573                         hammer_base_elm_t right_bound);
 574 hammer_node_t hammer_alloc_btree(struct hammer_cluster *cluster, int *errorp);
 575 void *hammer_alloc_data(struct hammer_cluster *cluster, int32_t bytes,
 576                         int *errorp, struct hammer_buffer **bufferp);
 577 void *hammer_alloc_record(struct hammer_cluster *cluster,
 578                         int *errorp, struct hammer_buffer **bufferp);
 579 void hammer_initbuffer(hammer_alist_t live, hammer_fsbuf_head_t head,
 580                         u_int64_t type);
 581 void hammer_free_data_ptr(struct hammer_buffer *buffer,
 582                         void *data, int bytes);
 583 void hammer_free_record_ptr(struct hammer_buffer *buffer,
 584                         union hammer_record_ondisk *rec);
 585 void hammer_free_cluster(hammer_cluster_t cluster);
 586 void hammer_free_btree(struct hammer_cluster *cluster, int32_t bclu_offset);
 587 void hammer_free_data(struct hammer_cluster *cluster, int32_t bclu_offset,
 588                         int32_t bytes);
 589 void hammer_free_record(struct hammer_cluster *cluster, int32_t bclu_offset);
 590
 591 void hammer_put_volume(struct hammer_volume *volume, int flush);
 592 void hammer_put_supercl(struct hammer_supercl *supercl, int flush);
 593 void hammer_put_cluster(struct hammer_cluster *cluster, int flush);
 594 void hammer_put_buffer(struct hammer_buffer *buffer, int flush);
 595
 596 void hammer_init_alist_config(void);
 597
 598 void hammer_start_transaction(struct hammer_transaction *trans,
 599                               struct hammer_mount *hmp);
 600 void hammer_start_transaction_tid(struct hammer_transaction *trans,
 601                                   struct hammer_mount *hmp, hammer_tid_t tid);
 602 void hammer_commit_transaction(struct hammer_transaction *trans);
 603 void hammer_abort_transaction(struct hammer_transaction *trans);
 604
 605 void hammer_modify_inode(struct hammer_transaction *trans,
 606                         hammer_inode_t ip, int flags);
 607 int  hammer_create_inode(struct hammer_transaction *trans, struct vattr *vap,
 608                         struct ucred *cred, struct hammer_inode *dip,
 609                         struct hammer_inode **ipp);
 610 void hammer_rel_inode(hammer_inode_t ip, int flush);
 611 int hammer_sync_inode(hammer_inode_t ip, int waitfor, int handle_delete);
 612
 613 int  hammer_ip_add_directory(struct hammer_transaction *trans,
 614                         hammer_inode_t dip, struct namecache *ncp,
 615                         hammer_inode_t nip);
 616 int  hammer_ip_del_directory(struct hammer_transaction *trans,
 617                         hammer_cursor_t cursor, hammer_inode_t dip,
 618                         hammer_inode_t ip);
 619 int  hammer_ip_add_record(struct hammer_transaction *trans,
 620                         hammer_record_t record);
 621 int  hammer_ip_delete_range(struct hammer_transaction *trans,
 622                         hammer_inode_t ip, int64_t ran_beg, int64_t ran_end,
 623                         struct hammer_cursor **spikep);
 624 int  hammer_ip_delete_range_all(struct hammer_transaction *trans,
 625                         hammer_inode_t ip);
 626 int  hammer_ip_sync_data(struct hammer_transaction *trans,
 627                         hammer_inode_t ip, int64_t offset,
 628                         void *data, int bytes, struct hammer_cursor **spikep);
 629 int  hammer_ip_sync_record(hammer_record_t rec, struct hammer_cursor **spikep);
 630 int  hammer_write_record(hammer_cursor_t cursor, hammer_record_ondisk_t rec,
 631                         void *data, int cursor_flags);
 632
 633 void hammer_load_spike(hammer_cursor_t cursor, struct hammer_cursor **spikep);
 634 int hammer_spike(struct hammer_cursor **spikep);
 635 int hammer_recover(struct hammer_cluster *cluster);
 636
 637 int hammer_io_read(struct vnode *devvp, struct hammer_io *io);
 638 int hammer_io_new(struct vnode *devvp, struct hammer_io *io);
 639 void hammer_io_release(struct hammer_io *io, int flush);
 640 int hammer_io_checkflush(hammer_io_t io);
 641 void hammer_io_notify_cluster(hammer_cluster_t cluster);
 642 void hammer_io_flush(struct hammer_io *io, struct hammer_sync_info *info);
 643 void hammer_io_intend_modify(struct hammer_io *io);
 644 void hammer_io_modify_done(struct hammer_io *io);
 645 void hammer_io_clear_modify(struct hammer_io *io);
 646
 647 #endif
 648
 649 /*
 650  * Inline support functions (not kernel specific)
 651  */
 652 static __inline void
 653 hammer_modify_volume(struct hammer_volume *volume)
 654 {
 655         volume->io.modified = 1;
 656         ++volume->io.lock.modifying;
 657         if (volume->io.released)
 658                 hammer_io_intend_modify(&volume->io);
 659 }
 660
 661 static __inline void
 662 hammer_modify_volume_done(struct hammer_volume *volume)
 663 {
 664         hammer_io_modify_done(&volume->io);
 665 }
 666
 667 static __inline void
 668 hammer_modify_supercl(struct hammer_supercl *supercl)
 669 {
 670         supercl->io.modified = 1;
 671         ++supercl->io.lock.modifying;
 672         if (supercl->io.released)
 673                 hammer_io_intend_modify(&supercl->io);
 674 }
 675
 676 static __inline void
 677 hammer_modify_supercl_done(struct hammer_supercl *supercl)
 678 {
 679         hammer_io_modify_done(&supercl->io);
 680 }
 681
 682 static __inline void
 683 hammer_modify_cluster(struct hammer_cluster *cluster)
 684 {
 685         cluster->io.modified = 1;
 686         ++cluster->io.lock.modifying;
 687         if (cluster->io.released)
 688                 hammer_io_intend_modify(&cluster->io);
 689 }
 690
 691 static __inline void
 692 hammer_modify_cluster_done(struct hammer_cluster *cluster)
 693 {
 694         hammer_io_modify_done(&cluster->io);
 695 }
 696
 697 static __inline void
 698 hammer_modify_buffer(struct hammer_buffer *buffer)
 699 {
 700         hammer_io_notify_cluster(buffer->cluster);
 701         buffer->io.modified = 1;
 702         ++buffer->io.lock.modifying;
 703         if (buffer->io.released)
 704                 hammer_io_intend_modify(&buffer->io);
 705 }
 706
 707 static __inline void
 708 hammer_modify_buffer_done(struct hammer_buffer *buffer)
 709 {
 710         hammer_io_modify_done(&buffer->io);
 711 }
 712
 713 static __inline void
 714 hammer_modify_node(struct hammer_node *node)
 715 {
 716         hammer_modify_buffer(node->buffer);
 717 }
 718
 719 static __inline void
 720 hammer_modify_node_done(struct hammer_node *node)
 721 {
 722         hammer_modify_buffer_done(node->buffer);
 723 }
 724
 725 /*
 726  * Return the cluster-relative byte offset of an element within a buffer
 727  */
 728 static __inline int
 729 hammer_bclu_offset(struct hammer_buffer *buffer, void *ptr)
 730 {
 731         int bclu_offset;
 732
 733         bclu_offset = buffer->buf_no * HAMMER_BUFSIZE +
 734                       ((char *)ptr - (char *)buffer->ondisk);
 735         return(bclu_offset);
 736 }
 737