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