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.52 2008/04/26 19:08:14 dillon Exp $
  35  */
  36 /*
  37  * This header file contains structures used internally by the HAMMERFS
  38  * implementation.  See hammer_disk.h for on-disk structures.
  39  */
  40
  41 #include <sys/param.h>
  42 #include <sys/types.h>
  43 #include <sys/kernel.h>
  44 #include <sys/conf.h>
  45 #include <sys/systm.h>
  46 #include <sys/tree.h>
  47 #include <sys/malloc.h>
  48 #include <sys/mount.h>
  49 #include <sys/mountctl.h>
  50 #include <sys/vnode.h>
  51 #include <sys/proc.h>
  52 #include <sys/globaldata.h>
  53 #include <sys/lockf.h>
  54 #include <sys/buf.h>
  55 #include <sys/queue.h>
  56 #include <sys/globaldata.h>
  57
  58 #include <sys/buf2.h>
  59 #include <sys/signal2.h>
  60 #include "hammer_disk.h"
  61 #include "hammer_mount.h"
  62 #include "hammer_ioctl.h"
  63
  64 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
  65
  66 MALLOC_DECLARE(M_HAMMER);
  67
  68 struct hammer_mount;
  69
  70 /*
  71  * Key structure used for custom RB tree inode lookups.  This prototypes
  72  * the function hammer_ino_rb_tree_RB_LOOKUP_INFO(root, info).
  73  */
  74 typedef struct hammer_inode_info {
  75         int64_t         obj_id;         /* (key) object identifier */
  76         hammer_tid_t    obj_asof;       /* (key) snapshot transid or 0 */
  77 } *hammer_inode_info_t;
  78
  79 typedef enum hammer_transaction_type {
  80         HAMMER_TRANS_RO,
  81         HAMMER_TRANS_STD,
  82         HAMMER_TRANS_FLS
  83 } hammer_transaction_type_t;
  84
  85 /*
  86  * HAMMER Transaction tracking
  87  */
  88 struct hammer_transaction {
  89         hammer_transaction_type_t type;
  90         struct hammer_mount *hmp;
  91         hammer_tid_t    tid;
  92         hammer_tid_t    time;
  93         struct hammer_volume *rootvol;
  94 };
  95
  96 typedef struct hammer_transaction *hammer_transaction_t;
  97
  98 /*
  99  * HAMMER locks
 100  */
 101 struct hammer_lock {
 102         int     refs;           /* active references delay writes */
 103         int     lockcount;      /* lock count for exclusive/shared access */
 104         int     wanted;
 105         struct thread *locktd;
 106 };
 107
 108 static __inline int
 109 hammer_islocked(struct hammer_lock *lock)
 110 {
 111         return(lock->lockcount != 0);
 112 }
 113
 114 static __inline int
 115 hammer_isactive(struct hammer_lock *lock)
 116 {
 117         return(lock->refs != 0);
 118 }
 119
 120 static __inline int
 121 hammer_islastref(struct hammer_lock *lock)
 122 {
 123         return(lock->refs == 1);
 124 }
 125
 126 /*
 127  * Return if we specifically own the lock exclusively.
 128  */
 129 static __inline int
 130 hammer_lock_excl_owned(struct hammer_lock *lock, thread_t td)
 131 {
 132         if (lock->lockcount > 0 && lock->locktd == td)
 133                 return(1);
 134         return(0);
 135 }
 136
 137 /*
 138  * inode->inode dependancy
 139  */
 140 typedef struct hammer_depend {
 141         TAILQ_ENTRY(hammer_depend) ip_entry;
 142         TAILQ_ENTRY(hammer_depend) rec_entry;
 143         struct hammer_inode *ip;
 144         struct hammer_record *record;
 145 } *hammer_depend_t;
 146
 147 TAILQ_HEAD(hammer_depend_list, hammer_depend);
 148
 149 /*
 150  * Structure used to represent an inode in-memory.
 151  *
 152  * The record and data associated with an inode may be out of sync with
 153  * the disk (xDIRTY flags), or not even on the disk at all (ONDISK flag
 154  * clear).
 155  *
 156  * An inode may also hold a cache of unsynchronized records, used for
 157  * database and directories only.  Unsynchronized regular file data is
 158  * stored in the buffer cache.
 159  *
 160  * NOTE: A file which is created and destroyed within the initial
 161  * synchronization period can wind up not doing any disk I/O at all.
 162  *
 163  * Finally, an inode may cache numerous disk-referencing B-Tree cursors.
 164  */
 165 struct hammer_ino_rb_tree;
 166 struct hammer_inode;
 167 RB_HEAD(hammer_ino_rb_tree, hammer_inode);
 168 RB_PROTOTYPEX(hammer_ino_rb_tree, INFO, hammer_inode, rb_node,
 169               hammer_ino_rb_compare, hammer_inode_info_t);
 170
 171 struct hammer_rec_rb_tree;
 172 struct hammer_record;
 173 RB_HEAD(hammer_rec_rb_tree, hammer_record);
 174 RB_PROTOTYPEX(hammer_rec_rb_tree, INFO, hammer_record, rb_node,
 175               hammer_rec_rb_compare, hammer_base_elm_t);
 176
 177 TAILQ_HEAD(hammer_node_list, hammer_node);
 178
 179 typedef enum hammer_inode_state {
 180         HAMMER_FST_IDLE,
 181         HAMMER_FST_SETUP,
 182         HAMMER_FST_FLUSH
 183 } hammer_inode_state_t;
 184
 185 struct hammer_inode {
 186         RB_ENTRY(hammer_inode) rb_node;
 187         hammer_inode_state_t flush_state;
 188         TAILQ_ENTRY(hammer_inode) flush_entry;
 189         struct hammer_depend_list depend_list;
 190         u_int64_t               obj_id;         /* (key) object identifier */
 191         hammer_tid_t            obj_asof;       /* (key) snapshot or 0 */
 192         struct hammer_mount     *hmp;
 193         int                     flags;
 194         int                     error;          /* flush error */
 195         int                     depend_count;
 196         int                     cursor_ip_refs; /* sanity */
 197         struct vnode            *vp;
 198         struct lockf            advlock;
 199         struct hammer_lock      lock;           /* sync copy interlock */
 200         TAILQ_HEAD(, bio)       bio_list;       /* BIOs to flush out */
 201         TAILQ_HEAD(, bio)       bio_alt_list;   /* BIOs to flush out */
 202         off_t                   trunc_off;
 203         struct hammer_inode_record ino_rec;     /* in-memory cache */
 204         struct hammer_inode_data ino_data;      /* in-memory cache */
 205         struct hammer_rec_rb_tree rec_tree;     /* in-memory cache */
 206         struct hammer_node      *cache[2];      /* search initiate cache */
 207
 208         /*
 209          * When a demark is created to synchronize an inode to
 210          * disk, certain fields are copied so the front-end VOPs
 211          * can continue to run in parallel with the synchronization
 212          * occuring in the background.
 213          */
 214         int             sync_flags;             /* to-sync flags cache */
 215         off_t           sync_trunc_off;         /* to-sync truncation */
 216         struct hammer_inode_record sync_ino_rec;/* to-sync cache */
 217         struct hammer_inode_data sync_ino_data; /* to-sync cache */
 218 };
 219
 220 typedef struct hammer_inode *hammer_inode_t;
 221
 222 #define VTOI(vp)        ((struct hammer_inode *)(vp)->v_data)
 223
 224 #define HAMMER_INODE_DDIRTY     0x0001  /* in-memory ino_data is dirty */
 225 #define HAMMER_INODE_RDIRTY     0x0002  /* in-memory ino_rec is dirty */
 226 #define HAMMER_INODE_ITIMES     0x0004  /* in-memory mtime/atime modified */
 227 #define HAMMER_INODE_XDIRTY     0x0008  /* in-memory records/flsbufs present */
 228 #define HAMMER_INODE_ONDISK     0x0010  /* inode is on-disk (else not yet) */
 229 #define HAMMER_INODE_FLUSH      0x0020  /* flush on last ref */
 230 #define HAMMER_INODE_DELETED    0x0080  /* inode ready for deletion */
 231 #define HAMMER_INODE_DELONDISK  0x0100  /* delete synchronized to disk */
 232 #define HAMMER_INODE_RO         0x0200  /* read-only (because of as-of) */
 233 #define HAMMER_INODE_GONE       0x0400  /* delete flushed out */
 234 #define HAMMER_INODE_DONDISK    0x0800  /* data records may be on disk */
 235 #define HAMMER_INODE_BUFS       0x1000  /* dirty high level bps present */
 236 #define HAMMER_INODE_REFLUSH    0x2000  /* pipelined flush during flush */
 237 #define HAMMER_INODE_UNUSED4000 0x4000
 238 #define HAMMER_INODE_FLUSHW     0x8000  /* Someone waiting for flush */
 239
 240 #define HAMMER_INODE_TRUNCATED  0x00010000
 241
 242 #define HAMMER_INODE_MODMASK    (HAMMER_INODE_DDIRTY|HAMMER_INODE_RDIRTY| \
 243                                  HAMMER_INODE_XDIRTY|HAMMER_INODE_BUFS|   \
 244                                  HAMMER_INODE_ITIMES|HAMMER_INODE_TRUNCATED)
 245
 246 #define HAMMER_MAX_INODE_CURSORS        4
 247
 248 #define HAMMER_FLUSH_SIGNAL     0x0001
 249 #define HAMMER_FLUSH_FORCE      0x0002
 250 #define HAMMER_FLUSH_RELEASE    0x0004
 251
 252 /*
 253  * Structure used to represent an unsynchronized record in-memory.  This
 254  * structure is orgranized in a per-inode RB-tree.  If the inode is not
 255  * on disk then neither are any records and the in-memory record tree
 256  * represents the entire contents of the inode.  If the inode is on disk
 257  * then the on-disk B-Tree is scanned in parallel with the in-memory
 258  * RB-Tree to synthesize the current state of the file.
 259  *
 260  * Only current (delete_tid == 0) unsynchronized records are kept in-memory.
 261  *
 262  * blocked is the count of the number of cursors (ip_first/ip_next) blocked
 263  * on the record waiting for a synchronization to complete.
 264  */
 265 struct hammer_record {
 266         RB_ENTRY(hammer_record)         rb_node;
 267         hammer_inode_state_t            state;
 268         struct hammer_lock              lock;
 269         struct hammer_inode             *ip;
 270         union hammer_record_ondisk      rec;
 271         union hammer_data_ondisk        *data;
 272         int                             flags;
 273         struct hammer_depend_list       depend_list;
 274 };
 275
 276 typedef struct hammer_record *hammer_record_t;
 277
 278 /*
 279  * Record flags.  Note that FE can only be set by the frontend if the
 280  * record has not been interlocked by the backend w/ BE.
 281  */
 282 #define HAMMER_RECF_ALLOCDATA           0x0001
 283 #define HAMMER_RECF_ONRBTREE            0x0002
 284 #define HAMMER_RECF_DELETED_FE          0x0004  /* deleted (frontend) */
 285 #define HAMMER_RECF_DELETED_BE          0x0008  /* deleted (backend) */
 286 #define HAMMER_RECF_INBAND              0x0010
 287 #define HAMMER_RECF_INTERLOCK_BE        0x0020  /* backend interlock */
 288 #define HAMMER_RECF_WANTED              0x0040
 289 #define HAMMER_RECF_DELETE_ONDISK       0x0080
 290 #define HAMMER_RECF_CONVERT_DELETE_ONDISK 0x0100 /* special case */
 291
 292 /*
 293  * In-memory structures representing on-disk structures.
 294  */
 295 struct hammer_volume;
 296 struct hammer_buffer;
 297 struct hammer_node;
 298 RB_HEAD(hammer_vol_rb_tree, hammer_volume);
 299 RB_HEAD(hammer_buf_rb_tree, hammer_buffer);
 300 RB_HEAD(hammer_nod_rb_tree, hammer_node);
 301
 302 RB_PROTOTYPE2(hammer_vol_rb_tree, hammer_volume, rb_node,
 303               hammer_vol_rb_compare, int32_t);
 304 RB_PROTOTYPE2(hammer_buf_rb_tree, hammer_buffer, rb_node,
 305               hammer_buf_rb_compare, hammer_off_t);
 306 RB_PROTOTYPE2(hammer_nod_rb_tree, hammer_node, rb_node,
 307               hammer_nod_rb_compare, hammer_off_t);
 308
 309 /*
 310  * IO management - embedded at the head of various in-memory structures
 311  *
 312  * VOLUME       - hammer_volume containing meta-data
 313  * META_BUFFER  - hammer_buffer containing meta-data
 314  * DATA_BUFFER  - hammer_buffer containing pure-data
 315  *
 316  * Dirty volume headers and dirty meta-data buffers are locked until the
 317  * flusher can sequence them out.  Dirty pure-data buffers can be written.
 318  * Clean buffers can be passively released.
 319  */
 320 typedef enum hammer_io_type {
 321         HAMMER_STRUCTURE_VOLUME,
 322         HAMMER_STRUCTURE_META_BUFFER,
 323         HAMMER_STRUCTURE_UNDO_BUFFER,
 324         HAMMER_STRUCTURE_DATA_BUFFER
 325 } hammer_io_type_t;
 326
 327 union hammer_io_structure;
 328 struct hammer_io;
 329
 330 struct worklist {
 331         LIST_ENTRY(worklist) node;
 332 };
 333
 334 TAILQ_HEAD(hammer_io_list, hammer_io);
 335 typedef struct hammer_io_list *hammer_io_list_t;
 336
 337 struct hammer_io {
 338         struct worklist         worklist;
 339         struct hammer_lock      lock;
 340         enum hammer_io_type     type;
 341         struct hammer_mount     *hmp;
 342         TAILQ_ENTRY(hammer_io)  mod_entry; /* list entry if modified */
 343         hammer_io_list_t        mod_list;
 344         struct buf              *bp;
 345         int64_t                 offset;
 346         int                     loading;   /* loading/unloading interlock */
 347         int                     modify_refs;
 348
 349         u_int           modified : 1;   /* bp's data was modified */
 350         u_int           released : 1;   /* bp released (w/ B_LOCKED set) */
 351         u_int           running : 1;    /* bp write IO in progress */
 352         u_int           waiting : 1;    /* someone is waiting on us */
 353         u_int           validated : 1;  /* ondisk has been validated */
 354         u_int           flush : 1;      /* flush on last release */
 355         u_int           waitdep : 1;    /* flush waits for dependancies */
 356 };
 357
 358 typedef struct hammer_io *hammer_io_t;
 359
 360 /*
 361  * In-memory volume representing on-disk buffer
 362  */
 363 struct hammer_volume {
 364         struct hammer_io io;
 365         RB_ENTRY(hammer_volume) rb_node;
 366         struct hammer_buf_rb_tree rb_bufs_root;
 367         struct hammer_volume_ondisk *ondisk;
 368         int32_t vol_no;
 369         int64_t nblocks;        /* note: special calculation for statfs */
 370         int64_t buffer_base;    /* base offset of buffer 0 */
 371         hammer_off_t maxbuf_off; /* Maximum buffer offset */
 372         char    *vol_name;
 373         struct vnode *devvp;
 374         int     vol_flags;
 375 };
 376
 377 typedef struct hammer_volume *hammer_volume_t;
 378
 379 /*
 380  * In-memory buffer (other then volume, super-cluster, or cluster),
 381  * representing an on-disk buffer.
 382  */
 383 struct hammer_buffer {
 384         struct hammer_io io;
 385         RB_ENTRY(hammer_buffer) rb_node;
 386         void *ondisk;
 387         struct hammer_volume *volume;
 388         hammer_off_t zone2_offset;
 389         hammer_off_t zoneX_offset;
 390         struct hammer_node_list clist;
 391 };
 392
 393 typedef struct hammer_buffer *hammer_buffer_t;
 394
 395 /*
 396  * In-memory B-Tree node, representing an on-disk B-Tree node.
 397  *
 398  * This is a hang-on structure which is backed by a hammer_buffer,
 399  * indexed by a hammer_cluster, and used for fine-grained locking of
 400  * B-Tree nodes in order to properly control lock ordering.  A hammer_buffer
 401  * can contain multiple nodes representing wildly disassociated portions
 402  * of the B-Tree so locking cannot be done on a buffer-by-buffer basis.
 403  *
 404  * This structure uses a cluster-relative index to reduce the number
 405  * of layers required to access it, and also because all on-disk B-Tree
 406  * references are cluster-relative offsets.
 407  */
 408 struct hammer_node {
 409         struct hammer_lock      lock;           /* node-by-node lock */
 410         TAILQ_ENTRY(hammer_node) entry;         /* per-buffer linkage */
 411         RB_ENTRY(hammer_node)   rb_node;        /* per-cluster linkage */
 412         hammer_off_t            node_offset;    /* full offset spec */
 413         struct hammer_mount     *hmp;
 414         struct hammer_buffer    *buffer;        /* backing buffer */
 415         hammer_node_ondisk_t    ondisk;         /* ptr to on-disk structure */
 416         struct hammer_node      **cache1;       /* passive cache(s) */
 417         struct hammer_node      **cache2;
 418         int                     flags;
 419         int                     loading;        /* load interlock */
 420 };
 421
 422 #define HAMMER_NODE_DELETED     0x0001
 423 #define HAMMER_NODE_FLUSH       0x0002
 424
 425 typedef struct hammer_node      *hammer_node_t;
 426
 427 /*
 428  * List of locked nodes.
 429  */
 430 struct hammer_node_locklist {
 431         struct hammer_node_locklist *next;
 432         hammer_node_t   node;
 433 };
 434
 435 typedef struct hammer_node_locklist *hammer_node_locklist_t;
 436
 437
 438 /*
 439  * Common I/O management structure - embedded in in-memory structures
 440  * which are backed by filesystem buffers.
 441  */
 442 union hammer_io_structure {
 443         struct hammer_io        io;
 444         struct hammer_volume    volume;
 445         struct hammer_buffer    buffer;
 446 };
 447
 448 typedef union hammer_io_structure *hammer_io_structure_t;
 449
 450 /*
 451  * Allocation holes are recorded for a short period of time in an attempt
 452  * to use up the space.
 453  */
 454
 455 #define HAMMER_MAX_HOLES        8
 456
 457 struct hammer_hole;
 458
 459 struct hammer_holes {
 460         TAILQ_HEAD(, hammer_hole) list;
 461         int     count;
 462 };
 463
 464 typedef struct hammer_holes *hammer_holes_t;
 465
 466 struct hammer_hole {
 467         TAILQ_ENTRY(hammer_hole) entry;
 468         hammer_off_t    offset;
 469         int             bytes;
 470 };
 471
 472 typedef struct hammer_hole *hammer_hole_t;
 473
 474 #include "hammer_cursor.h"
 475
 476 /*
 477  * Internal hammer mount data structure
 478  */
 479 struct hammer_mount {
 480         struct mount *mp;
 481         /*struct vnode *rootvp;*/
 482         struct hammer_ino_rb_tree rb_inos_root;
 483         struct hammer_vol_rb_tree rb_vols_root;
 484         struct hammer_nod_rb_tree rb_nods_root;
 485         struct hammer_volume *rootvol;
 486         struct hammer_base_elm root_btree_beg;
 487         struct hammer_base_elm root_btree_end;
 488         char    *zbuf;  /* HAMMER_BUFSIZE bytes worth of all-zeros */
 489         int     hflags;
 490         int     ronly;
 491         int     nvolumes;
 492         int     volume_iterator;
 493         int     flusher_seq;
 494         int     flusher_act;
 495         int     flusher_exiting;
 496         int     reclaim_count;
 497         thread_t flusher_td;
 498         u_int   check_interrupt;
 499         uuid_t  fsid;
 500         udev_t  fsid_udev;
 501         struct hammer_io_list volu_list;        /* dirty undo buffers */
 502         struct hammer_io_list undo_list;        /* dirty undo buffers */
 503         struct hammer_io_list data_list;        /* dirty data buffers */
 504         struct hammer_io_list meta_list;        /* dirty meta bufs    */
 505         struct hammer_io_list lose_list;        /* loose buffers      */
 506         int     locked_dirty_count;             /* meta/volu count    */
 507         int     io_running_count;
 508         hammer_tid_t asof;
 509         hammer_off_t next_tid;
 510         u_int32_t namekey_iterator;
 511         hammer_off_t zone_limits[HAMMER_MAX_ZONES];
 512         struct netexport export;
 513         struct lock blockmap_lock;
 514         struct hammer_holes holes[HAMMER_MAX_ZONES];
 515         TAILQ_HEAD(, hammer_inode) flush_list;
 516 };
 517
 518 typedef struct hammer_mount     *hammer_mount_t;
 519
 520 struct hammer_sync_info {
 521         int error;
 522         int waitfor;
 523 };
 524
 525 #endif
 526
 527 #if defined(_KERNEL)
 528
 529 extern struct vop_ops hammer_vnode_vops;
 530 extern struct vop_ops hammer_spec_vops;
 531 extern struct vop_ops hammer_fifo_vops;
 532 extern struct bio_ops hammer_bioops;
 533
 534 extern int hammer_debug_general;
 535 extern int hammer_debug_locks;
 536 extern int hammer_debug_btree;
 537 extern int hammer_debug_tid;
 538 extern int hammer_debug_recover;
 539 extern int hammer_debug_recover_faults;
 540 extern int hammer_count_inodes;
 541 extern int hammer_count_records;
 542 extern int hammer_count_record_datas;
 543 extern int hammer_count_volumes;
 544 extern int hammer_count_buffers;
 545 extern int hammer_count_nodes;
 546 extern int64_t hammer_contention_count;
 547
 548 int     hammer_vop_inactive(struct vop_inactive_args *);
 549 int     hammer_vop_reclaim(struct vop_reclaim_args *);
 550 int     hammer_get_vnode(struct hammer_inode *ip, int lktype,
 551                         struct vnode **vpp);
 552 struct hammer_inode *hammer_get_inode(hammer_transaction_t trans,
 553                         struct hammer_node **cache,
 554                         u_int64_t obj_id, hammer_tid_t asof, int flags,
 555                         int *errorp);
 556 void    hammer_put_inode(struct hammer_inode *ip);
 557 void    hammer_put_inode_ref(struct hammer_inode *ip);
 558
 559 int     hammer_unload_volume(hammer_volume_t volume, void *data __unused);
 560 int     hammer_unload_buffer(hammer_buffer_t buffer, void *data __unused);
 561 int     hammer_install_volume(hammer_mount_t hmp, const char *volname);
 562
 563 int     hammer_ip_lookup(hammer_cursor_t cursor, hammer_inode_t ip);
 564 int     hammer_ip_first(hammer_cursor_t cursor, hammer_inode_t ip);
 565 int     hammer_ip_next(hammer_cursor_t cursor);
 566 int     hammer_ip_resolve_record_and_data(hammer_cursor_t cursor);
 567 int     hammer_ip_resolve_data(hammer_cursor_t cursor);
 568 int     hammer_ip_delete_record(hammer_cursor_t cursor, hammer_tid_t tid);
 569 int     hammer_delete_at_cursor(hammer_cursor_t cursor, int64_t *stat_bytes);
 570 int     hammer_ip_check_directory_empty(hammer_transaction_t trans,
 571                         hammer_inode_t ip);
 572 int     hammer_sync_hmp(hammer_mount_t hmp, int waitfor);
 573
 574 hammer_record_t
 575         hammer_alloc_mem_record(hammer_inode_t ip);
 576 void    hammer_flush_record_done(hammer_record_t record, int error);
 577 void    hammer_wait_mem_record(hammer_record_t record);
 578 void    hammer_rel_mem_record(hammer_record_t record);
 579 void    hammer_cleardep_mem_record(struct hammer_record *record);
 580
 581 int     hammer_cursor_up(hammer_cursor_t cursor);
 582 int     hammer_cursor_down(hammer_cursor_t cursor);
 583 int     hammer_cursor_upgrade(hammer_cursor_t cursor);
 584 void    hammer_cursor_downgrade(hammer_cursor_t cursor);
 585 int     hammer_cursor_seek(hammer_cursor_t cursor, hammer_node_t node,
 586                         int index);
 587 void    hammer_lock_ex(struct hammer_lock *lock);
 588 int     hammer_lock_ex_try(struct hammer_lock *lock);
 589 void    hammer_lock_sh(struct hammer_lock *lock);
 590 int     hammer_lock_upgrade(struct hammer_lock *lock);
 591 void    hammer_lock_downgrade(struct hammer_lock *lock);
 592 void    hammer_unlock(struct hammer_lock *lock);
 593 void    hammer_ref(struct hammer_lock *lock);
 594 void    hammer_unref(struct hammer_lock *lock);
 595
 596 u_int32_t hammer_to_unix_xid(uuid_t *uuid);
 597 void hammer_guid_to_uuid(uuid_t *uuid, u_int32_t guid);
 598 void    hammer_to_timespec(hammer_tid_t tid, struct timespec *ts);
 599 hammer_tid_t hammer_timespec_to_transid(struct timespec *ts);
 600 hammer_tid_t hammer_alloc_tid(hammer_transaction_t trans);
 601 hammer_tid_t hammer_now_tid(void);
 602 hammer_tid_t hammer_str_to_tid(const char *str);
 603
 604 enum vtype hammer_get_vnode_type(u_int8_t obj_type);
 605 int hammer_get_dtype(u_int8_t obj_type);
 606 u_int8_t hammer_get_obj_type(enum vtype vtype);
 607 int64_t hammer_directory_namekey(void *name, int len);
 608
 609 int     hammer_init_cursor(hammer_transaction_t trans, hammer_cursor_t cursor,
 610                            struct hammer_node **cache);
 611
 612 void    hammer_done_cursor(hammer_cursor_t cursor);
 613 void    hammer_mem_done(hammer_cursor_t cursor);
 614
 615 int     hammer_btree_lookup(hammer_cursor_t cursor);
 616 int     hammer_btree_first(hammer_cursor_t cursor);
 617 int     hammer_btree_last(hammer_cursor_t cursor);
 618 int     hammer_btree_extract(hammer_cursor_t cursor, int flags);
 619 int     hammer_btree_iterate(hammer_cursor_t cursor);
 620 int     hammer_btree_iterate_reverse(hammer_cursor_t cursor);
 621 int     hammer_btree_insert(hammer_cursor_t cursor, hammer_btree_elm_t elm);
 622 int     hammer_btree_delete(hammer_cursor_t cursor);
 623 int     hammer_btree_cmp(hammer_base_elm_t key1, hammer_base_elm_t key2);
 624 int     hammer_btree_chkts(hammer_tid_t ts, hammer_base_elm_t key);
 625 int     hammer_btree_correct_rhb(hammer_cursor_t cursor, hammer_tid_t tid);
 626 int     hammer_btree_correct_lhb(hammer_cursor_t cursor, hammer_tid_t tid);
 627
 628
 629 int     hammer_btree_lock_children(hammer_cursor_t cursor,
 630                         struct hammer_node_locklist **locklistp);
 631
 632 void    hammer_print_btree_node(hammer_node_ondisk_t ondisk);
 633 void    hammer_print_btree_elm(hammer_btree_elm_t elm, u_int8_t type, int i);
 634
 635 void    *hammer_bread(struct hammer_mount *hmp, hammer_off_t off,
 636                         int *errorp, struct hammer_buffer **bufferp);
 637 void    *hammer_bnew(struct hammer_mount *hmp, hammer_off_t off,
 638                         int *errorp, struct hammer_buffer **bufferp);
 639
 640 hammer_volume_t hammer_get_root_volume(hammer_mount_t hmp, int *errorp);
 641 int     hammer_dowrite(hammer_transaction_t trans, hammer_inode_t ip,
 642                         struct bio *bio);
 643
 644 hammer_volume_t hammer_get_volume(hammer_mount_t hmp,
 645                         int32_t vol_no, int *errorp);
 646 hammer_buffer_t hammer_get_buffer(hammer_mount_t hmp,
 647                         hammer_off_t buf_offset, int isnew, int *errorp);
 648 void    hammer_uncache_buffer(struct hammer_mount *hmp, hammer_off_t off);
 649
 650 int             hammer_ref_volume(hammer_volume_t volume);
 651 int             hammer_ref_buffer(hammer_buffer_t buffer);
 652 void            hammer_flush_buffer_nodes(hammer_buffer_t buffer);
 653
 654 void            hammer_rel_volume(hammer_volume_t volume, int flush);
 655 void            hammer_rel_buffer(hammer_buffer_t buffer, int flush);
 656
 657 int             hammer_vfs_export(struct mount *mp, int op,
 658                         const struct export_args *export);
 659 hammer_node_t   hammer_get_node(hammer_mount_t hmp,
 660                         hammer_off_t node_offset, int *errorp);
 661 void            hammer_ref_node(hammer_node_t node);
 662 hammer_node_t   hammer_ref_node_safe(struct hammer_mount *hmp,
 663                         struct hammer_node **cache, int *errorp);
 664 void            hammer_rel_node(hammer_node_t node);
 665 void            hammer_delete_node(hammer_transaction_t trans,
 666                         hammer_node_t node);
 667 void            hammer_cache_node(hammer_node_t node,
 668                         struct hammer_node **cache);
 669 void            hammer_uncache_node(struct hammer_node **cache);
 670 void            hammer_flush_node(hammer_node_t node);
 671
 672 void hammer_dup_buffer(struct hammer_buffer **bufferp,
 673                         struct hammer_buffer *buffer);
 674 hammer_node_t hammer_alloc_btree(hammer_transaction_t trans, int *errorp);
 675 void *hammer_alloc_record(hammer_transaction_t trans,
 676                         hammer_off_t *rec_offp, u_int16_t rec_type,
 677                         struct hammer_buffer **rec_bufferp,
 678                         int32_t data_len, void **datap,
 679                         struct hammer_buffer **data_bufferp, int *errorp);
 680 void *hammer_alloc_data(hammer_transaction_t trans, int32_t data_len,
 681                         hammer_off_t *data_offsetp,
 682                         struct hammer_buffer **data_bufferp, int *errorp);
 683
 684 int hammer_generate_undo(hammer_transaction_t trans, hammer_io_t io,
 685                         hammer_off_t zone1_offset, void *base, int len);
 686
 687 void hammer_put_volume(struct hammer_volume *volume, int flush);
 688 void hammer_put_buffer(struct hammer_buffer *buffer, int flush);
 689
 690 hammer_off_t hammer_freemap_alloc(hammer_transaction_t trans,
 691                         hammer_off_t owner, int *errorp);
 692 void hammer_freemap_free(hammer_transaction_t trans, hammer_off_t phys_offset,
 693                         hammer_off_t owner, int *errorp);
 694 hammer_off_t hammer_blockmap_alloc(hammer_transaction_t trans, int zone,
 695                         int bytes, int *errorp);
 696 void hammer_blockmap_free(hammer_transaction_t trans,
 697                         hammer_off_t bmap_off, int bytes);
 698 int hammer_blockmap_getfree(hammer_mount_t hmp, hammer_off_t bmap_off,
 699                         int *curp, int *errorp);
 700 hammer_off_t hammer_blockmap_lookup(hammer_mount_t hmp, hammer_off_t bmap_off,
 701                         int *errorp);
 702 hammer_off_t hammer_undo_lookup(hammer_mount_t hmp, hammer_off_t bmap_off,
 703                         int *errorp);
 704
 705 void hammer_start_transaction(struct hammer_transaction *trans,
 706                               struct hammer_mount *hmp);
 707 void hammer_simple_transaction(struct hammer_transaction *trans,
 708                               struct hammer_mount *hmp);
 709 void hammer_start_transaction_fls(struct hammer_transaction *trans,
 710                                   struct hammer_mount *hmp);
 711 void hammer_done_transaction(struct hammer_transaction *trans);
 712
 713 void hammer_modify_inode(struct hammer_transaction *trans,
 714                         hammer_inode_t ip, int flags);
 715 void hammer_flush_inode(hammer_inode_t ip, int flags);
 716 void hammer_flush_inode_done(hammer_inode_t ip);
 717 void hammer_wait_inode(hammer_inode_t ip);
 718
 719 int  hammer_create_inode(struct hammer_transaction *trans, struct vattr *vap,
 720                         struct ucred *cred, struct hammer_inode *dip,
 721                         struct hammer_inode **ipp);
 722 void hammer_rel_inode(hammer_inode_t ip, int flush);
 723 int hammer_sync_inode(hammer_inode_t ip, int handle_delete);
 724
 725 int  hammer_ip_add_directory(struct hammer_transaction *trans,
 726                         hammer_inode_t dip, struct namecache *ncp,
 727                         hammer_inode_t nip);
 728 int  hammer_ip_del_directory(struct hammer_transaction *trans,
 729                         hammer_cursor_t cursor, hammer_inode_t dip,
 730                         hammer_inode_t ip);
 731 int  hammer_ip_add_record(struct hammer_transaction *trans,
 732                         hammer_record_t record);
 733 int  hammer_ip_delete_range(struct hammer_transaction *trans,
 734                         hammer_inode_t ip, int64_t ran_beg, int64_t ran_end);
 735 int  hammer_ip_delete_range_all(struct hammer_transaction *trans,
 736                         hammer_inode_t ip);
 737 int  hammer_ip_sync_data(struct hammer_transaction *trans,
 738                         hammer_inode_t ip, int64_t offset,
 739                         void *data, int bytes);
 740 int  hammer_ip_sync_record(hammer_transaction_t trans, hammer_record_t rec);
 741
 742 int hammer_ioctl(hammer_inode_t ip, u_long com, caddr_t data, int fflag,
 743                         struct ucred *cred);
 744
 745 void hammer_io_init(hammer_io_t io, hammer_mount_t hmp,
 746                         enum hammer_io_type type);
 747 void hammer_io_reinit(hammer_io_t io, enum hammer_io_type type);
 748 int hammer_io_read(struct vnode *devvp, struct hammer_io *io);
 749 int hammer_io_new(struct vnode *devvp, struct hammer_io *io);
 750 void hammer_io_release(struct hammer_io *io);
 751 void hammer_io_flush(struct hammer_io *io);
 752 int hammer_io_checkflush(hammer_io_t io);
 753 void hammer_io_clear_modify(struct hammer_io *io);
 754 void hammer_io_waitdep(struct hammer_io *io);
 755
 756 void hammer_modify_volume(hammer_transaction_t trans, hammer_volume_t volume,
 757                         void *base, int len);
 758 void hammer_modify_buffer(hammer_transaction_t trans, hammer_buffer_t buffer,
 759                         void *base, int len);
 760 void hammer_modify_volume_done(hammer_volume_t volume);
 761 void hammer_modify_buffer_done(hammer_buffer_t buffer);
 762
 763 int hammer_ioc_reblock(hammer_transaction_t trans, hammer_inode_t ip,
 764                         struct hammer_ioc_reblock *reblock);
 765
 766 void hammer_init_holes(hammer_mount_t hmp, hammer_holes_t holes);
 767 void hammer_free_holes(hammer_mount_t hmp, hammer_holes_t holes);
 768 int hammer_signal_check(hammer_mount_t hmp);
 769
 770 void hammer_flusher_create(hammer_mount_t hmp);
 771 void hammer_flusher_destroy(hammer_mount_t hmp);
 772 void hammer_flusher_sync(hammer_mount_t hmp);
 773 void hammer_flusher_async(hammer_mount_t hmp);
 774
 775 int hammer_recover(hammer_mount_t hmp, hammer_volume_t rootvol);
 776
 777 #endif
 778
 779 static __inline void
 780 hammer_modify_node_noundo(hammer_transaction_t trans, hammer_node_t node)
 781 {
 782         hammer_modify_buffer(trans, node->buffer, NULL, 0);
 783 }
 784
 785 static __inline void
 786 hammer_modify_node_all(hammer_transaction_t trans, struct hammer_node *node)
 787 {
 788         hammer_modify_buffer(trans, node->buffer,
 789                              node->ondisk, sizeof(*node->ondisk));
 790 }
 791
 792 static __inline void
 793 hammer_modify_node(hammer_transaction_t trans, hammer_node_t node,
 794                    void *base, int len)
 795 {
 796         KKASSERT((char *)base >= (char *)node->ondisk &&
 797                  (char *)base + len <=
 798                     (char *)node->ondisk + sizeof(*node->ondisk));
 799         hammer_modify_buffer(trans, node->buffer, base, len);
 800 }
 801
 802 static __inline void
 803 hammer_modify_node_done(hammer_node_t node)
 804 {
 805         hammer_modify_buffer_done(node->buffer);
 806 }
 807
 808 static __inline void
 809 hammer_modify_record(hammer_transaction_t trans, hammer_buffer_t buffer,
 810                      void *base, int len)
 811 {
 812         KKASSERT((char *)base >= (char *)buffer->ondisk &&
 813                  (char *)base + len <= (char *)buffer->ondisk + HAMMER_BUFSIZE);
 814         hammer_modify_buffer(trans, buffer, base, len);
 815 }
 816
 817 static __inline void
 818 hammer_modify_record_done(hammer_buffer_t buffer)
 819 {
 820         hammer_modify_buffer_done(buffer);
 821 }
 822