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