Add definitions for LONG_BIT and WORD_BIT.
[dragonfly.git] / sys / vfs / hammer / hammer.h
CommitLineData
8750964d
MD
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 *
d113fda1 34 * $DragonFly: src/sys/vfs/hammer/hammer.h,v 1.18 2008/01/01 01:00:03 dillon Exp $
8750964d
MD
35 */
36/*
37 * This header file contains structures used internally by the HAMMERFS
c60bb2c5 38 * implementation. See hammer_disk.h for on-disk structures.
8750964d
MD
39 */
40
427e5fc6
MD
41#include <sys/param.h>
42#include <sys/types.h>
43#include <sys/kernel.h>
44#include <sys/systm.h>
8750964d
MD
45#include <sys/tree.h>
46#include <sys/malloc.h>
427e5fc6
MD
47#include <sys/mount.h>
48#include <sys/vnode.h>
49#include <sys/globaldata.h>
66325755
MD
50#include <sys/lockf.h>
51#include <sys/buf.h>
8cd0a023 52#include <sys/queue.h>
66325755
MD
53#include <sys/globaldata.h>
54
55#include <sys/buf2.h>
c60bb2c5 56#include "hammer_alist.h"
427e5fc6 57#include "hammer_disk.h"
8750964d
MD
58#include "hammer_mount.h"
59
60#if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
61
62MALLOC_DECLARE(M_HAMMER);
63
66325755
MD
64struct hammer_mount;
65
8750964d
MD
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 */
70typedef 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
66325755
MD
75/*
76 * HAMMER Transaction tracking
77 */
78struct hammer_transaction {
79 struct hammer_mount *hmp;
80 hammer_tid_t tid;
a89aec1b 81 struct hammer_volume *rootvol;
66325755
MD
82};
83
8cd0a023
MD
84typedef struct hammer_transaction *hammer_transaction_t;
85
66325755
MD
86/*
87 * HAMMER locks
88 */
427e5fc6 89struct hammer_lock {
0b075555
MD
90 int refs; /* active references delay writes */
91 int modifying; /* indicates buffer being modified */
92 int lockcount; /* lock count for exclusive/shared access */
427e5fc6
MD
93 int wanted;
94 struct thread *locktd;
8750964d
MD
95};
96
427e5fc6
MD
97static __inline int
98hammer_islocked(struct hammer_lock *lock)
99{
8cd0a023 100 return(lock->lockcount != 0);
427e5fc6
MD
101}
102
0b075555
MD
103static __inline int
104hammer_isactive(struct hammer_lock *lock)
105{
106 return(lock->refs != 0);
107}
108
427e5fc6
MD
109static __inline int
110hammer_islastref(struct hammer_lock *lock)
111{
112 return(lock->refs == 1);
113}
c60bb2c5 114
8750964d 115/*
8cd0a023
MD
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.
8750964d
MD
130 */
131struct hammer_ino_rb_tree;
132struct hammer_inode;
133RB_HEAD(hammer_ino_rb_tree, hammer_inode);
134RB_PROTOTYPEX(hammer_ino_rb_tree, INFO, hammer_inode, rb_node,
8cd0a023
MD
135 hammer_ino_rb_compare, hammer_inode_info_t);
136
137struct hammer_rec_rb_tree;
138struct hammer_record;
139RB_HEAD(hammer_rec_rb_tree, hammer_record);
140RB_PROTOTYPEX(hammer_rec_rb_tree, INFO, hammer_record, rb_node,
141 hammer_rec_rb_compare, hammer_base_elm_t);
142
143TAILQ_HEAD(hammer_node_list, hammer_node);
8750964d
MD
144
145struct 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 */
8cd0a023 149 hammer_tid_t last_tid; /* last modified tid (for fsync) */
66325755
MD
150 struct hammer_mount *hmp;
151 int flags;
c60bb2c5 152 struct vnode *vp;
66325755 153 struct lockf advlock;
8cd0a023 154 struct hammer_lock lock;
c60bb2c5
MD
155 struct hammer_inode_record ino_rec;
156 struct hammer_inode_data ino_data;
8cd0a023
MD
157 struct hammer_rec_rb_tree rec_tree; /* red-black record tree */
158 struct hammer_node *cache; /* cached B-Tree node shortcut */
8750964d
MD
159};
160
8cd0a023
MD
161typedef struct hammer_inode *hammer_inode_t;
162
66325755
MD
163#define VTOI(vp) ((struct hammer_inode *)(vp)->v_data)
164
8cd0a023
MD
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 */
d113fda1 168#define HAMMER_INODE_XDIRTY 0x0008 /* in-memory records present */
8cd0a023 169#define HAMMER_INODE_ONDISK 0x0010 /* inode is on-disk (else not yet) */
a89aec1b 170#define HAMMER_INODE_FLUSH 0x0020 /* flush on last ref */
c0ade690 171#define HAMMER_INODE_DELETED 0x0080 /* inode ready for deletion */
76376933 172#define HAMMER_INODE_DELONDISK 0x0100 /* delete synchronized to disk */
d113fda1
MD
173#define HAMMER_INODE_RO 0x0200 /* read-only (because of as-of) */
174#define HAMMER_INODE_GONE 0x0400 /* delete flushed out */
8cd0a023 175
0b075555 176#define HAMMER_INODE_MODMASK (HAMMER_INODE_DDIRTY|HAMMER_INODE_RDIRTY| \
d113fda1
MD
177 HAMMER_INODE_XDIRTY|\
178 HAMMER_INODE_ITIMES|HAMMER_INODE_DELETED)
0b075555 179
8cd0a023 180#define HAMMER_MAX_INODE_CURSORS 4
66325755 181
8750964d 182/*
8cd0a023
MD
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.
8750964d 191 */
8cd0a023
MD
192struct hammer_record {
193 RB_ENTRY(hammer_record) rb_node;
a89aec1b 194 struct hammer_lock lock;
8cd0a023
MD
195 struct hammer_inode *ip;
196 union hammer_record_ondisk rec;
197 union hammer_data_ondisk *data;
8cd0a023
MD
198 int flags;
199};
8750964d 200
8cd0a023
MD
201typedef struct hammer_record *hammer_record_t;
202
203#define HAMMER_RECF_ALLOCDATA 0x0001
204#define HAMMER_RECF_ONRBTREE 0x0002
a89aec1b 205#define HAMMER_RECF_DELETED 0x0004
c0ade690 206#define HAMMER_RECF_EMBEDDED_DATA 0x0008
b3deaf57 207#define HAMMER_RECF_SYNCING 0x0010
8cd0a023
MD
208
209/*
210 * Structures used to internally represent a volume and a cluster
211 */
8750964d
MD
212struct hammer_volume;
213struct hammer_cluster;
427e5fc6
MD
214struct hammer_supercl;
215struct hammer_buffer;
8cd0a023 216struct hammer_node;
8750964d
MD
217RB_HEAD(hammer_vol_rb_tree, hammer_volume);
218RB_HEAD(hammer_clu_rb_tree, hammer_cluster);
427e5fc6
MD
219RB_HEAD(hammer_scl_rb_tree, hammer_supercl);
220RB_HEAD(hammer_buf_rb_tree, hammer_buffer);
8cd0a023 221RB_HEAD(hammer_nod_rb_tree, hammer_node);
8750964d
MD
222
223RB_PROTOTYPE2(hammer_vol_rb_tree, hammer_volume, rb_node,
224 hammer_vol_rb_compare, int32_t);
225RB_PROTOTYPE2(hammer_clu_rb_tree, hammer_cluster, rb_node,
226 hammer_clu_rb_compare, int32_t);
427e5fc6
MD
227RB_PROTOTYPE2(hammer_scl_rb_tree, hammer_supercl, rb_node,
228 hammer_scl_rb_compare, int32_t);
229RB_PROTOTYPE2(hammer_buf_rb_tree, hammer_buffer, rb_node,
230 hammer_buf_rb_compare, int32_t);
8cd0a023
MD
231RB_PROTOTYPE2(hammer_nod_rb_tree, hammer_node, rb_node,
232 hammer_nod_rb_compare, int32_t);
8750964d 233
66325755
MD
234/*
235 * IO management - embedded at the head of various in-memory structures
236 */
237enum hammer_io_type { HAMMER_STRUCTURE_VOLUME,
238 HAMMER_STRUCTURE_SUPERCL,
239 HAMMER_STRUCTURE_CLUSTER,
240 HAMMER_STRUCTURE_BUFFER };
241
242union hammer_io_structure;
243
244struct worklist {
245 LIST_ENTRY(worklist) node;
246};
247
248struct 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
8cd0a023
MD
258typedef struct hammer_io *hammer_io_t;
259
66325755 260/*
8cd0a023 261 * In-memory volume representing on-disk buffer
66325755 262 */
8750964d 263struct hammer_volume {
66325755 264 struct hammer_io io;
8750964d
MD
265 RB_ENTRY(hammer_volume) rb_node;
266 struct hammer_clu_rb_tree rb_clus_root;
427e5fc6 267 struct hammer_scl_rb_tree rb_scls_root;
8750964d 268 struct hammer_volume_ondisk *ondisk;
427e5fc6 269 struct hammer_alist_live alist;
8750964d
MD
270 int32_t vol_no;
271 int32_t vol_clsize;
d26d0ae9 272 int32_t clu_iterator; /* cluster allocation iterator */
fbc6e32a 273 int64_t nblocks; /* note: special calculation for statfs */
8750964d 274 int64_t cluster_base; /* base offset of cluster 0 */
c60bb2c5 275 char *vol_name;
8750964d
MD
276 struct vnode *devvp;
277 struct hammer_mount *hmp;
427e5fc6 278 int vol_flags;
8750964d
MD
279};
280
8cd0a023
MD
281typedef struct hammer_volume *hammer_volume_t;
282
66325755 283/*
8cd0a023 284 * In-memory super-cluster representing on-disk buffer
66325755 285 */
427e5fc6 286struct hammer_supercl {
66325755 287 struct hammer_io io;
427e5fc6 288 RB_ENTRY(hammer_supercl) rb_node;
427e5fc6
MD
289 struct hammer_supercl_ondisk *ondisk;
290 struct hammer_volume *volume;
291 struct hammer_alist_live alist;
292 int32_t scl_no;
427e5fc6 293};
c60bb2c5 294
8cd0a023
MD
295typedef struct hammer_supercl *hammer_supercl_t;
296
fbc6e32a
MD
297enum hammer_cluster_state {
298 HAMMER_CLUSTER_IDLE,
299 HAMMER_CLUSTER_ASYNC,
300 HAMMER_CLUSTER_OPEN
301};
302
66325755 303/*
8cd0a023
MD
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.
66325755 308 */
8750964d 309struct hammer_cluster {
66325755 310 struct hammer_io io;
8750964d 311 RB_ENTRY(hammer_cluster) rb_node;
427e5fc6 312 struct hammer_buf_rb_tree rb_bufs_root;
8750964d
MD
313 struct hammer_cluster_ondisk *ondisk;
314 struct hammer_volume *volume;
427e5fc6
MD
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;
8cd0a023
MD
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 */
8750964d 322 int32_t clu_no;
fbc6e32a 323 enum hammer_cluster_state state;
427e5fc6
MD
324};
325
8cd0a023
MD
326typedef struct hammer_cluster *hammer_cluster_t;
327
66325755 328/*
8cd0a023
MD
329 * In-memory buffer (other then volume, super-cluster, or cluster),
330 * representing an on-disk buffer.
66325755 331 */
427e5fc6 332struct hammer_buffer {
66325755 333 struct hammer_io io;
427e5fc6 334 RB_ENTRY(hammer_buffer) rb_node;
427e5fc6 335 hammer_fsbuf_ondisk_t ondisk;
427e5fc6 336 struct hammer_volume *volume;
8cd0a023 337 struct hammer_cluster *cluster;
427e5fc6 338 int32_t buf_no;
8cd0a023
MD
339 u_int64_t buf_type;
340 struct hammer_alist_live alist;
341 struct hammer_node_list clist;
342 struct hammer_node *save_scan;
66325755
MD
343};
344
8cd0a023
MD
345typedef 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 */
360struct 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;
b3deaf57 370 int flags;
8cd0a023
MD
371};
372
b3deaf57
MD
373#define HAMMER_NODE_DELETED 0x0001
374#define HAMMER_NODE_FLUSH 0x0002
375#define HAMMER_NODE_MODIFIED 0x0004
376
8cd0a023
MD
377typedef 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 */
66325755
MD
383union 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;
8750964d
MD
389};
390
427e5fc6
MD
391#define HAMFS_CLUSTER_DIRTY 0x0001
392
8cd0a023
MD
393#include "hammer_cursor.h"
394
8750964d
MD
395/*
396 * Internal hammer mount data structure
397 */
398struct hammer_mount {
399 struct mount *mp;
27ea2398 400 /*struct vnode *rootvp;*/
8750964d
MD
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;
d26d0ae9 405 char *zbuf; /* HAMMER_BUFSIZE bytes worth of all-zeros */
195c19a1
MD
406 int hflags;
407 int ronly;
408 int nvolumes;
d26d0ae9 409 int volume_iterator;
8750964d 410 uuid_t fsid;
66325755 411 udev_t fsid_udev;
7f7c1f84 412 hammer_tid_t asof;
66325755 413 u_int32_t namekey_iterator;
8750964d
MD
414};
415
8cd0a023 416typedef struct hammer_mount *hammer_mount_t;
8750964d 417
fbc6e32a
MD
418struct hammer_sync_info {
419 int error;
420 int waitfor;
421};
422
8750964d
MD
423#endif
424
425#if defined(_KERNEL)
426
427extern struct vop_ops hammer_vnode_vops;
7a04d74f
MD
428extern struct vop_ops hammer_spec_vops;
429extern struct vop_ops hammer_fifo_vops;
427e5fc6
MD
430extern struct hammer_alist_config Buf_alist_config;
431extern struct hammer_alist_config Vol_normal_alist_config;
432extern struct hammer_alist_config Vol_super_alist_config;
433extern struct hammer_alist_config Supercl_alist_config;
434extern struct hammer_alist_config Clu_master_alist_config;
435extern struct hammer_alist_config Clu_slave_alist_config;
66325755 436extern struct bio_ops hammer_bioops;
427e5fc6 437
b3deaf57 438extern int hammer_debug_btree;
d113fda1 439extern int hammer_debug_tid;
b3deaf57
MD
440extern int hammer_count_inodes;
441extern int hammer_count_records;
442extern int hammer_count_record_datas;
443extern int hammer_count_volumes;
444extern int hammer_count_supercls;
445extern int hammer_count_clusters;
446extern int hammer_count_buffers;
447extern int hammer_count_nodes;
448extern int hammer_count_spikes;
449
8750964d
MD
450int hammer_vop_inactive(struct vop_inactive_args *);
451int hammer_vop_reclaim(struct vop_reclaim_args *);
7f7c1f84 452int hammer_vfs_vget(struct mount *mp, ino_t ino, struct vnode **vpp);
66325755
MD
453int hammer_get_vnode(struct hammer_inode *ip, int lktype,
454 struct vnode **vpp);
8cd0a023 455struct hammer_inode *hammer_get_inode(hammer_mount_t hmp,
d113fda1
MD
456 u_int64_t obj_id, hammer_tid_t asof, int flags,
457 int *errorp);
66325755
MD
458void hammer_put_inode(struct hammer_inode *ip);
459void hammer_put_inode_ref(struct hammer_inode *ip);
460
d113fda1 461int hammer_unload_inode(hammer_inode_t ip, void *data);
8cd0a023 462int hammer_unload_volume(hammer_volume_t volume, void *data __unused);
a89aec1b
MD
463int hammer_unload_supercl(hammer_supercl_t supercl, void *data __unused);
464int hammer_unload_cluster(hammer_cluster_t cluster, void *data __unused);
465int hammer_unload_buffer(hammer_buffer_t buffer, void *data __unused);
8cd0a023
MD
466int hammer_install_volume(hammer_mount_t hmp, const char *volname);
467
a89aec1b
MD
468int hammer_ip_lookup(hammer_cursor_t cursor, hammer_inode_t ip);
469int hammer_ip_first(hammer_cursor_t cursor, hammer_inode_t ip);
470int hammer_ip_next(hammer_cursor_t cursor);
8cd0a023 471int hammer_ip_resolve_data(hammer_cursor_t cursor);
195c19a1 472int hammer_ip_delete_record(hammer_cursor_t cursor, hammer_tid_t tid);
b3deaf57
MD
473int hammer_ip_check_directory_empty(hammer_transaction_t trans,
474 hammer_inode_t ip);
fbc6e32a
MD
475int hammer_sync_hmp(hammer_mount_t hmp, int waitfor);
476int hammer_sync_volume(hammer_volume_t volume, void *data);
477int hammer_sync_cluster(hammer_cluster_t cluster, void *data);
478int hammer_sync_buffer(hammer_buffer_t buffer, void *data);
479
8cd0a023 480hammer_record_t
7f7c1f84 481 hammer_alloc_mem_record(hammer_inode_t ip);
b3deaf57 482void hammer_rel_mem_record(hammer_record_t record);
8cd0a023 483
195c19a1 484int hammer_cursor_up(hammer_cursor_t cursor, int nonblock);
8cd0a023
MD
485int hammer_cursor_toroot(hammer_cursor_t cursor);
486int hammer_cursor_down(hammer_cursor_t cursor);
487
488void hammer_lock_ex(struct hammer_lock *lock);
489int hammer_lock_ex_try(struct hammer_lock *lock);
490void hammer_lock_sh(struct hammer_lock *lock);
427e5fc6 491void hammer_unlock(struct hammer_lock *lock);
66325755
MD
492void hammer_ref(struct hammer_lock *lock);
493void hammer_unref(struct hammer_lock *lock);
8cd0a023
MD
494void hammer_downgrade(struct hammer_lock *lock);
495
66325755 496u_int32_t hammer_to_unix_xid(uuid_t *uuid);
8cd0a023
MD
497void hammer_guid_to_uuid(uuid_t *uuid, u_int32_t guid);
498void hammer_to_timespec(hammer_tid_t tid, struct timespec *ts);
499hammer_tid_t hammer_timespec_to_transid(struct timespec *ts);
a89aec1b 500hammer_tid_t hammer_alloc_tid(hammer_transaction_t trans);
7f7c1f84 501hammer_tid_t hammer_now_tid(void);
d113fda1 502hammer_tid_t hammer_str_to_tid(const char *str);
a89aec1b 503hammer_tid_t hammer_alloc_recid(hammer_transaction_t trans);
8cd0a023 504
66325755 505enum vtype hammer_get_vnode_type(u_int8_t obj_type);
6b4f890b 506int hammer_get_dtype(u_int8_t obj_type);
66325755
MD
507u_int8_t hammer_get_obj_type(enum vtype vtype);
508int64_t hammer_directory_namekey(void *name, int len);
427e5fc6 509
8cd0a023 510int hammer_init_cursor_hmp(hammer_cursor_t cursor, hammer_mount_t hmp);
d26d0ae9 511int hammer_init_cursor_cluster(hammer_cursor_t cursor, hammer_cluster_t cluster);
8cd0a023 512int hammer_init_cursor_ip(hammer_cursor_t cursor, hammer_inode_t ip);
195c19a1 513
8cd0a023 514void hammer_done_cursor(hammer_cursor_t cursor);
6b4f890b 515void hammer_mem_done(hammer_cursor_t cursor);
8cd0a023
MD
516
517int hammer_btree_lookup(hammer_cursor_t cursor);
d26d0ae9 518int hammer_btree_first(hammer_cursor_t cursor);
8cd0a023
MD
519int hammer_btree_extract(hammer_cursor_t cursor, int flags);
520int hammer_btree_iterate(hammer_cursor_t cursor);
521int hammer_btree_insert(hammer_cursor_t cursor, hammer_btree_elm_t elm);
522int hammer_btree_delete(hammer_cursor_t cursor);
523int hammer_btree_cmp(hammer_base_elm_t key1, hammer_base_elm_t key2);
d26d0ae9 524int hammer_btree_chkts(hammer_tid_t ts, hammer_base_elm_t key);
c0ade690
MD
525void hammer_print_btree_node(hammer_node_ondisk_t ondisk);
526void hammer_print_btree_elm(hammer_btree_elm_t elm, u_int8_t type, int i);
8750964d 527
c60bb2c5 528void *hammer_bread(struct hammer_cluster *cluster, int32_t cloff,
8cd0a023
MD
529 u_int64_t buf_type, int *errorp,
530 struct hammer_buffer **bufferp);
531
532hammer_volume_t hammer_get_root_volume(hammer_mount_t hmp, int *errorp);
533hammer_cluster_t hammer_get_root_cluster(hammer_mount_t hmp, int *errorp);
427e5fc6 534
8cd0a023 535hammer_volume_t hammer_get_volume(hammer_mount_t hmp,
427e5fc6 536 int32_t vol_no, int *errorp);
8cd0a023 537hammer_supercl_t hammer_get_supercl(hammer_volume_t volume,
427e5fc6 538 int32_t scl_no, int *errorp, int isnew);
8cd0a023 539hammer_cluster_t hammer_get_cluster(hammer_volume_t volume,
427e5fc6 540 int32_t clu_no, int *errorp, int isnew);
8cd0a023
MD
541hammer_buffer_t hammer_get_buffer(hammer_cluster_t cluster,
542 int32_t buf_no, u_int64_t buf_type, int *errorp);
543
fbc6e32a 544int hammer_ref_volume(hammer_volume_t volume);
8cd0a023
MD
545int hammer_ref_cluster(hammer_cluster_t cluster);
546int hammer_ref_buffer(hammer_buffer_t buffer);
547void hammer_flush_buffer_nodes(hammer_buffer_t buffer);
548
549
550void hammer_rel_volume(hammer_volume_t volume, int flush);
551void hammer_rel_supercl(hammer_supercl_t supercl, int flush);
552void hammer_rel_cluster(hammer_cluster_t cluster, int flush);
553void hammer_rel_buffer(hammer_buffer_t buffer, int flush);
554
555hammer_node_t hammer_get_node(hammer_cluster_t cluster,
556 int32_t node_offset, int *errorp);
557int hammer_ref_node(hammer_node_t node);
558void hammer_rel_node(hammer_node_t node);
559void hammer_cache_node(hammer_node_t node,
560 struct hammer_node **cache);
561void hammer_uncache_node(struct hammer_node **cache);
562void hammer_flush_node(hammer_node_t node);
563
427e5fc6
MD
564void hammer_dup_buffer(struct hammer_buffer **bufferp,
565 struct hammer_buffer *buffer);
566void hammer_dup_cluster(struct hammer_cluster **clusterp,
567 struct hammer_cluster *cluster);
d26d0ae9
MD
568hammer_cluster_t hammer_alloc_cluster(hammer_mount_t hmp,
569 hammer_cluster_t cluster_hint, int *errorp);
570void hammer_init_cluster(hammer_cluster_t cluster,
571 hammer_base_elm_t left_bound,
572 hammer_base_elm_t right_bound);
8cd0a023 573hammer_node_t hammer_alloc_btree(struct hammer_cluster *cluster, int *errorp);
427e5fc6
MD
574void *hammer_alloc_data(struct hammer_cluster *cluster, int32_t bytes,
575 int *errorp, struct hammer_buffer **bufferp);
576void *hammer_alloc_record(struct hammer_cluster *cluster,
577 int *errorp, struct hammer_buffer **bufferp);
427e5fc6
MD
578void hammer_free_data_ptr(struct hammer_buffer *buffer,
579 void *data, int bytes);
580void hammer_free_record_ptr(struct hammer_buffer *buffer,
581 union hammer_record_ondisk *rec);
d26d0ae9 582void hammer_free_cluster(hammer_cluster_t cluster);
427e5fc6
MD
583void hammer_free_btree(struct hammer_cluster *cluster, int32_t bclu_offset);
584void hammer_free_data(struct hammer_cluster *cluster, int32_t bclu_offset,
585 int32_t bytes);
586void hammer_free_record(struct hammer_cluster *cluster, int32_t bclu_offset);
587
66325755
MD
588void hammer_put_volume(struct hammer_volume *volume, int flush);
589void hammer_put_supercl(struct hammer_supercl *supercl, int flush);
590void hammer_put_cluster(struct hammer_cluster *cluster, int flush);
591void hammer_put_buffer(struct hammer_buffer *buffer, int flush);
427e5fc6
MD
592
593void hammer_init_alist_config(void);
8750964d 594
8cd0a023
MD
595void hammer_start_transaction(struct hammer_transaction *trans,
596 struct hammer_mount *hmp);
d113fda1
MD
597void hammer_start_transaction_tid(struct hammer_transaction *trans,
598 struct hammer_mount *hmp, hammer_tid_t tid);
66325755
MD
599void hammer_commit_transaction(struct hammer_transaction *trans);
600void hammer_abort_transaction(struct hammer_transaction *trans);
601
602void hammer_modify_inode(struct hammer_transaction *trans,
8cd0a023
MD
603 hammer_inode_t ip, int flags);
604int hammer_create_inode(struct hammer_transaction *trans, struct vattr *vap,
605 struct ucred *cred, struct hammer_inode *dip,
606 struct hammer_inode **ipp);
a89aec1b 607void hammer_rel_inode(hammer_inode_t ip, int flush);
c0ade690 608int hammer_sync_inode(hammer_inode_t ip, int waitfor, int handle_delete);
8cd0a023 609
a89aec1b 610int hammer_ip_add_directory(struct hammer_transaction *trans,
8cd0a023
MD
611 hammer_inode_t dip, struct namecache *ncp,
612 hammer_inode_t nip);
a89aec1b 613int hammer_ip_del_directory(struct hammer_transaction *trans,
8cd0a023
MD
614 hammer_cursor_t cursor, hammer_inode_t dip,
615 hammer_inode_t ip);
7a04d74f
MD
616int hammer_ip_add_record(struct hammer_transaction *trans,
617 hammer_record_t record);
a89aec1b 618int hammer_ip_delete_range(struct hammer_transaction *trans,
d26d0ae9
MD
619 hammer_inode_t ip, int64_t ran_beg, int64_t ran_end,
620 struct hammer_cursor **spikep);
7a04d74f
MD
621int hammer_ip_delete_range_all(struct hammer_transaction *trans,
622 hammer_inode_t ip);
c0ade690 623int hammer_ip_sync_data(struct hammer_transaction *trans,
8cd0a023 624 hammer_inode_t ip, int64_t offset,
d26d0ae9
MD
625 void *data, int bytes, struct hammer_cursor **spikep);
626int hammer_ip_sync_record(hammer_record_t rec, struct hammer_cursor **spikep);
627int hammer_write_record(hammer_cursor_t cursor, hammer_record_ondisk_t rec,
628 void *data, int cursor_flags);
629
630void hammer_load_spike(hammer_cursor_t cursor, struct hammer_cursor **spikep);
631int hammer_spike(struct hammer_cursor **spikep);
66325755
MD
632
633int hammer_io_read(struct vnode *devvp, struct hammer_io *io);
634int hammer_io_new(struct vnode *devvp, struct hammer_io *io);
635void hammer_io_release(struct hammer_io *io, int flush);
8cd0a023 636int hammer_io_checkflush(hammer_io_t io);
fbc6e32a
MD
637void hammer_io_notify_cluster(hammer_cluster_t cluster);
638void hammer_io_flush(struct hammer_io *io, struct hammer_sync_info *info);
0b075555
MD
639void hammer_io_intend_modify(struct hammer_io *io);
640void hammer_io_modify_done(struct hammer_io *io);
66325755 641
8750964d
MD
642#endif
643
427e5fc6
MD
644/*
645 * Inline support functions (not kernel specific)
646 */
647static __inline void
648hammer_modify_volume(struct hammer_volume *volume)
649{
66325755 650 volume->io.modified = 1;
0b075555
MD
651 ++volume->io.lock.modifying;
652 if (volume->io.released)
653 hammer_io_intend_modify(&volume->io);
654}
655
656static __inline void
657hammer_modify_volume_done(struct hammer_volume *volume)
658{
659 hammer_io_modify_done(&volume->io);
427e5fc6
MD
660}
661
662static __inline void
663hammer_modify_supercl(struct hammer_supercl *supercl)
664{
66325755 665 supercl->io.modified = 1;
0b075555
MD
666 ++supercl->io.lock.modifying;
667 if (supercl->io.released)
668 hammer_io_intend_modify(&supercl->io);
669}
670
671static __inline void
672hammer_modify_supercl_done(struct hammer_supercl *supercl)
673{
674 hammer_io_modify_done(&supercl->io);
427e5fc6
MD
675}
676
677static __inline void
678hammer_modify_cluster(struct hammer_cluster *cluster)
679{
66325755 680 cluster->io.modified = 1;
0b075555
MD
681 ++cluster->io.lock.modifying;
682 if (cluster->io.released)
683 hammer_io_intend_modify(&cluster->io);
684}
685
686static __inline void
687hammer_modify_cluster_done(struct hammer_cluster *cluster)
688{
689 hammer_io_modify_done(&cluster->io);
427e5fc6
MD
690}
691
692static __inline void
693hammer_modify_buffer(struct hammer_buffer *buffer)
694{
fbc6e32a 695 hammer_io_notify_cluster(buffer->cluster);
66325755 696 buffer->io.modified = 1;
0b075555
MD
697 ++buffer->io.lock.modifying;
698 if (buffer->io.released)
699 hammer_io_intend_modify(&buffer->io);
700}
701
702static __inline void
703hammer_modify_buffer_done(struct hammer_buffer *buffer)
704{
705 hammer_io_modify_done(&buffer->io);
427e5fc6
MD
706}
707
8cd0a023
MD
708static __inline void
709hammer_modify_node(struct hammer_node *node)
710{
fbc6e32a 711 hammer_modify_buffer(node->buffer);
8cd0a023
MD
712}
713
0b075555
MD
714static __inline void
715hammer_modify_node_done(struct hammer_node *node)
716{
717 hammer_modify_buffer_done(node->buffer);
718}
719
427e5fc6
MD
720/*
721 * Return the cluster-relative byte offset of an element within a buffer
722 */
723static __inline int
724hammer_bclu_offset(struct hammer_buffer *buffer, void *ptr)
725{
726 int bclu_offset;
727
728 bclu_offset = buffer->buf_no * HAMMER_BUFSIZE +
729 ((char *)ptr - (char *)buffer->ondisk);
730 return(bclu_offset);
731}
732