Fix buffer cache deadlocks by splitting dirty buffers into two categories:
[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 *
0a72edae 34 * $DragonFly: src/sys/vfs/hammer/hammer.h,v 1.21 2008/01/09 04:05:37 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 157 struct hammer_rec_rb_tree rec_tree; /* red-black record tree */
61aeeb33 158 struct hammer_node *cache[2]; /* search initiate cache */
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 */
0a72edae 175#define HAMMER_INODE_DONDISK 0x0800 /* data records may be on disk */
8cd0a023 176
0b075555 177#define HAMMER_INODE_MODMASK (HAMMER_INODE_DDIRTY|HAMMER_INODE_RDIRTY| \
d113fda1
MD
178 HAMMER_INODE_XDIRTY|\
179 HAMMER_INODE_ITIMES|HAMMER_INODE_DELETED)
0b075555 180
8cd0a023 181#define HAMMER_MAX_INODE_CURSORS 4
66325755 182
8750964d 183/*
8cd0a023
MD
184 * Structure used to represent an unsynchronized record in-memory. This
185 * structure is orgranized in a per-inode RB-tree. If the inode is not
186 * on disk then neither are any records and the in-memory record tree
187 * represents the entire contents of the inode. If the inode is on disk
188 * then the on-disk B-Tree is scanned in parallel with the in-memory
189 * RB-Tree to synthesize the current state of the file.
190 *
191 * Only current (delete_tid == 0) unsynchronized records are kept in-memory.
8750964d 192 */
8cd0a023
MD
193struct hammer_record {
194 RB_ENTRY(hammer_record) rb_node;
a89aec1b 195 struct hammer_lock lock;
8cd0a023
MD
196 struct hammer_inode *ip;
197 union hammer_record_ondisk rec;
198 union hammer_data_ondisk *data;
8cd0a023
MD
199 int flags;
200};
8750964d 201
8cd0a023
MD
202typedef struct hammer_record *hammer_record_t;
203
204#define HAMMER_RECF_ALLOCDATA 0x0001
205#define HAMMER_RECF_ONRBTREE 0x0002
a89aec1b 206#define HAMMER_RECF_DELETED 0x0004
c0ade690 207#define HAMMER_RECF_EMBEDDED_DATA 0x0008
b3deaf57 208#define HAMMER_RECF_SYNCING 0x0010
8cd0a023
MD
209
210/*
211 * Structures used to internally represent a volume and a cluster
212 */
8750964d
MD
213struct hammer_volume;
214struct hammer_cluster;
427e5fc6
MD
215struct hammer_supercl;
216struct hammer_buffer;
8cd0a023 217struct hammer_node;
8750964d
MD
218RB_HEAD(hammer_vol_rb_tree, hammer_volume);
219RB_HEAD(hammer_clu_rb_tree, hammer_cluster);
427e5fc6
MD
220RB_HEAD(hammer_scl_rb_tree, hammer_supercl);
221RB_HEAD(hammer_buf_rb_tree, hammer_buffer);
8cd0a023 222RB_HEAD(hammer_nod_rb_tree, hammer_node);
8750964d
MD
223
224RB_PROTOTYPE2(hammer_vol_rb_tree, hammer_volume, rb_node,
225 hammer_vol_rb_compare, int32_t);
226RB_PROTOTYPE2(hammer_clu_rb_tree, hammer_cluster, rb_node,
227 hammer_clu_rb_compare, int32_t);
427e5fc6
MD
228RB_PROTOTYPE2(hammer_scl_rb_tree, hammer_supercl, rb_node,
229 hammer_scl_rb_compare, int32_t);
230RB_PROTOTYPE2(hammer_buf_rb_tree, hammer_buffer, rb_node,
231 hammer_buf_rb_compare, int32_t);
8cd0a023
MD
232RB_PROTOTYPE2(hammer_nod_rb_tree, hammer_node, rb_node,
233 hammer_nod_rb_compare, int32_t);
8750964d 234
66325755
MD
235/*
236 * IO management - embedded at the head of various in-memory structures
237 */
238enum hammer_io_type { HAMMER_STRUCTURE_VOLUME,
239 HAMMER_STRUCTURE_SUPERCL,
240 HAMMER_STRUCTURE_CLUSTER,
241 HAMMER_STRUCTURE_BUFFER };
242
243union hammer_io_structure;
244
245struct worklist {
246 LIST_ENTRY(worklist) node;
247};
248
249struct hammer_io {
250 struct worklist worklist;
251 struct hammer_lock lock;
252 enum hammer_io_type type;
253 struct buf *bp;
254 int64_t offset;
255 u_int modified : 1; /* bp's data was modified */
256 u_int released : 1; /* bp released (w/ B_LOCKED set) */
257};
258
8cd0a023
MD
259typedef struct hammer_io *hammer_io_t;
260
66325755 261/*
8cd0a023 262 * In-memory volume representing on-disk buffer
66325755 263 */
8750964d 264struct hammer_volume {
66325755 265 struct hammer_io io;
8750964d
MD
266 RB_ENTRY(hammer_volume) rb_node;
267 struct hammer_clu_rb_tree rb_clus_root;
427e5fc6 268 struct hammer_scl_rb_tree rb_scls_root;
8750964d 269 struct hammer_volume_ondisk *ondisk;
427e5fc6 270 struct hammer_alist_live alist;
8750964d
MD
271 int32_t vol_no;
272 int32_t vol_clsize;
d26d0ae9 273 int32_t clu_iterator; /* cluster allocation iterator */
fbc6e32a 274 int64_t nblocks; /* note: special calculation for statfs */
8750964d 275 int64_t cluster_base; /* base offset of cluster 0 */
c60bb2c5 276 char *vol_name;
8750964d
MD
277 struct vnode *devvp;
278 struct hammer_mount *hmp;
427e5fc6 279 int vol_flags;
8750964d
MD
280};
281
8cd0a023
MD
282typedef struct hammer_volume *hammer_volume_t;
283
66325755 284/*
8cd0a023 285 * In-memory super-cluster representing on-disk buffer
66325755 286 */
427e5fc6 287struct hammer_supercl {
66325755 288 struct hammer_io io;
427e5fc6 289 RB_ENTRY(hammer_supercl) rb_node;
427e5fc6
MD
290 struct hammer_supercl_ondisk *ondisk;
291 struct hammer_volume *volume;
292 struct hammer_alist_live alist;
293 int32_t scl_no;
427e5fc6 294};
c60bb2c5 295
8cd0a023
MD
296typedef struct hammer_supercl *hammer_supercl_t;
297
fbc6e32a
MD
298enum hammer_cluster_state {
299 HAMMER_CLUSTER_IDLE,
300 HAMMER_CLUSTER_ASYNC,
301 HAMMER_CLUSTER_OPEN
302};
303
66325755 304/*
8cd0a023
MD
305 * In-memory cluster representing on-disk buffer
306 *
307 * The cluster's indexing range is cached in hammer_cluster, separate
308 * from the ondisk info in order to allow cursors to point to it.
66325755 309 */
8750964d 310struct hammer_cluster {
66325755 311 struct hammer_io io;
8750964d 312 RB_ENTRY(hammer_cluster) rb_node;
427e5fc6 313 struct hammer_buf_rb_tree rb_bufs_root;
8750964d
MD
314 struct hammer_cluster_ondisk *ondisk;
315 struct hammer_volume *volume;
427e5fc6
MD
316 struct hammer_alist_live alist_master;
317 struct hammer_alist_live alist_btree;
318 struct hammer_alist_live alist_record;
319 struct hammer_alist_live alist_mdata;
8cd0a023
MD
320 struct hammer_nod_rb_tree rb_nods_root; /* cursors in cluster */
321 struct hammer_base_elm clu_btree_beg; /* copy of on-disk info */
322 struct hammer_base_elm clu_btree_end; /* copy of on-disk info */
8750964d 323 int32_t clu_no;
fbc6e32a 324 enum hammer_cluster_state state;
427e5fc6
MD
325};
326
8cd0a023
MD
327typedef struct hammer_cluster *hammer_cluster_t;
328
66325755 329/*
8cd0a023
MD
330 * In-memory buffer (other then volume, super-cluster, or cluster),
331 * representing an on-disk buffer.
66325755 332 */
427e5fc6 333struct hammer_buffer {
66325755 334 struct hammer_io io;
427e5fc6 335 RB_ENTRY(hammer_buffer) rb_node;
427e5fc6 336 hammer_fsbuf_ondisk_t ondisk;
427e5fc6 337 struct hammer_volume *volume;
8cd0a023 338 struct hammer_cluster *cluster;
427e5fc6 339 int32_t buf_no;
8cd0a023
MD
340 u_int64_t buf_type;
341 struct hammer_alist_live alist;
342 struct hammer_node_list clist;
343 struct hammer_node *save_scan;
66325755
MD
344};
345
8cd0a023
MD
346typedef struct hammer_buffer *hammer_buffer_t;
347
348/*
349 * In-memory B-Tree node, representing an on-disk B-Tree node.
350 *
351 * This is a hang-on structure which is backed by a hammer_buffer,
352 * indexed by a hammer_cluster, and used for fine-grained locking of
353 * B-Tree nodes in order to properly control lock ordering. A hammer_buffer
354 * can contain multiple nodes representing wildly disassociated portions
355 * of the B-Tree so locking cannot be done on a buffer-by-buffer basis.
356 *
357 * This structure uses a cluster-relative index to reduce the number
358 * of layers required to access it, and also because all on-disk B-Tree
359 * references are cluster-relative offsets.
360 */
361struct hammer_node {
362 struct hammer_lock lock; /* node-by-node lock */
363 TAILQ_ENTRY(hammer_node) entry; /* per-buffer linkage */
364 RB_ENTRY(hammer_node) rb_node; /* per-cluster linkage */
365 int32_t node_offset; /* cluster-rel offset */
366 struct hammer_cluster *cluster;
367 struct hammer_buffer *buffer; /* backing buffer */
368 hammer_node_ondisk_t ondisk; /* ptr to on-disk structure */
369 struct hammer_node **cache1; /* passive cache(s) */
370 struct hammer_node **cache2;
b3deaf57 371 int flags;
8cd0a023
MD
372};
373
b3deaf57
MD
374#define HAMMER_NODE_DELETED 0x0001
375#define HAMMER_NODE_FLUSH 0x0002
376#define HAMMER_NODE_MODIFIED 0x0004
377
8cd0a023
MD
378typedef struct hammer_node *hammer_node_t;
379
380/*
381 * Common I/O management structure - embedded in in-memory structures
382 * which are backed by filesystem buffers.
383 */
66325755
MD
384union hammer_io_structure {
385 struct hammer_io io;
386 struct hammer_volume volume;
387 struct hammer_supercl supercl;
388 struct hammer_cluster cluster;
389 struct hammer_buffer buffer;
8750964d
MD
390};
391
427e5fc6
MD
392#define HAMFS_CLUSTER_DIRTY 0x0001
393
8cd0a023
MD
394#include "hammer_cursor.h"
395
8750964d
MD
396/*
397 * Internal hammer mount data structure
398 */
399struct hammer_mount {
400 struct mount *mp;
27ea2398 401 /*struct vnode *rootvp;*/
8750964d
MD
402 struct hammer_ino_rb_tree rb_inos_root;
403 struct hammer_vol_rb_tree rb_vols_root;
404 struct hammer_volume *rootvol;
405 struct hammer_cluster *rootcl;
d26d0ae9 406 char *zbuf; /* HAMMER_BUFSIZE bytes worth of all-zeros */
195c19a1
MD
407 int hflags;
408 int ronly;
409 int nvolumes;
d26d0ae9 410 int volume_iterator;
8750964d 411 uuid_t fsid;
66325755 412 udev_t fsid_udev;
7f7c1f84 413 hammer_tid_t asof;
66325755 414 u_int32_t namekey_iterator;
8750964d
MD
415};
416
8cd0a023 417typedef struct hammer_mount *hammer_mount_t;
8750964d 418
fbc6e32a
MD
419struct hammer_sync_info {
420 int error;
421 int waitfor;
422};
423
8750964d
MD
424#endif
425
426#if defined(_KERNEL)
427
428extern struct vop_ops hammer_vnode_vops;
7a04d74f
MD
429extern struct vop_ops hammer_spec_vops;
430extern struct vop_ops hammer_fifo_vops;
427e5fc6
MD
431extern struct hammer_alist_config Buf_alist_config;
432extern struct hammer_alist_config Vol_normal_alist_config;
433extern struct hammer_alist_config Vol_super_alist_config;
434extern struct hammer_alist_config Supercl_alist_config;
435extern struct hammer_alist_config Clu_master_alist_config;
436extern struct hammer_alist_config Clu_slave_alist_config;
66325755 437extern struct bio_ops hammer_bioops;
427e5fc6 438
b3deaf57 439extern int hammer_debug_btree;
d113fda1 440extern int hammer_debug_tid;
b3deaf57
MD
441extern int hammer_count_inodes;
442extern int hammer_count_records;
443extern int hammer_count_record_datas;
444extern int hammer_count_volumes;
445extern int hammer_count_supercls;
446extern int hammer_count_clusters;
447extern int hammer_count_buffers;
448extern int hammer_count_nodes;
449extern int hammer_count_spikes;
450
8750964d
MD
451int hammer_vop_inactive(struct vop_inactive_args *);
452int hammer_vop_reclaim(struct vop_reclaim_args *);
7f7c1f84 453int hammer_vfs_vget(struct mount *mp, ino_t ino, struct vnode **vpp);
66325755
MD
454int hammer_get_vnode(struct hammer_inode *ip, int lktype,
455 struct vnode **vpp);
8cd0a023 456struct hammer_inode *hammer_get_inode(hammer_mount_t hmp,
61aeeb33 457 struct hammer_node **cache,
d113fda1
MD
458 u_int64_t obj_id, hammer_tid_t asof, int flags,
459 int *errorp);
66325755
MD
460void hammer_put_inode(struct hammer_inode *ip);
461void hammer_put_inode_ref(struct hammer_inode *ip);
462
d113fda1 463int hammer_unload_inode(hammer_inode_t ip, void *data);
8cd0a023 464int hammer_unload_volume(hammer_volume_t volume, void *data __unused);
a89aec1b
MD
465int hammer_unload_supercl(hammer_supercl_t supercl, void *data __unused);
466int hammer_unload_cluster(hammer_cluster_t cluster, void *data __unused);
4d75d829 467void hammer_update_syncid(hammer_cluster_t cluster, hammer_tid_t tid);
a89aec1b 468int hammer_unload_buffer(hammer_buffer_t buffer, void *data __unused);
8cd0a023
MD
469int hammer_install_volume(hammer_mount_t hmp, const char *volname);
470
a89aec1b
MD
471int hammer_ip_lookup(hammer_cursor_t cursor, hammer_inode_t ip);
472int hammer_ip_first(hammer_cursor_t cursor, hammer_inode_t ip);
473int hammer_ip_next(hammer_cursor_t cursor);
8cd0a023 474int hammer_ip_resolve_data(hammer_cursor_t cursor);
195c19a1 475int hammer_ip_delete_record(hammer_cursor_t cursor, hammer_tid_t tid);
b3deaf57
MD
476int hammer_ip_check_directory_empty(hammer_transaction_t trans,
477 hammer_inode_t ip);
fbc6e32a
MD
478int hammer_sync_hmp(hammer_mount_t hmp, int waitfor);
479int hammer_sync_volume(hammer_volume_t volume, void *data);
480int hammer_sync_cluster(hammer_cluster_t cluster, void *data);
481int hammer_sync_buffer(hammer_buffer_t buffer, void *data);
482
8cd0a023 483hammer_record_t
7f7c1f84 484 hammer_alloc_mem_record(hammer_inode_t ip);
b3deaf57 485void hammer_rel_mem_record(hammer_record_t record);
8cd0a023 486
195c19a1 487int hammer_cursor_up(hammer_cursor_t cursor, int nonblock);
8cd0a023
MD
488int hammer_cursor_toroot(hammer_cursor_t cursor);
489int hammer_cursor_down(hammer_cursor_t cursor);
490
491void hammer_lock_ex(struct hammer_lock *lock);
492int hammer_lock_ex_try(struct hammer_lock *lock);
493void hammer_lock_sh(struct hammer_lock *lock);
427e5fc6 494void hammer_unlock(struct hammer_lock *lock);
66325755
MD
495void hammer_ref(struct hammer_lock *lock);
496void hammer_unref(struct hammer_lock *lock);
8cd0a023
MD
497void hammer_downgrade(struct hammer_lock *lock);
498
66325755 499u_int32_t hammer_to_unix_xid(uuid_t *uuid);
8cd0a023
MD
500void hammer_guid_to_uuid(uuid_t *uuid, u_int32_t guid);
501void hammer_to_timespec(hammer_tid_t tid, struct timespec *ts);
502hammer_tid_t hammer_timespec_to_transid(struct timespec *ts);
a89aec1b 503hammer_tid_t hammer_alloc_tid(hammer_transaction_t trans);
7f7c1f84 504hammer_tid_t hammer_now_tid(void);
d113fda1 505hammer_tid_t hammer_str_to_tid(const char *str);
a89aec1b 506hammer_tid_t hammer_alloc_recid(hammer_transaction_t trans);
8cd0a023 507
66325755 508enum vtype hammer_get_vnode_type(u_int8_t obj_type);
6b4f890b 509int hammer_get_dtype(u_int8_t obj_type);
66325755
MD
510u_int8_t hammer_get_obj_type(enum vtype vtype);
511int64_t hammer_directory_namekey(void *name, int len);
427e5fc6 512
61aeeb33 513int hammer_init_cursor_hmp(hammer_cursor_t cursor, struct hammer_node **cache, hammer_mount_t hmp);
d26d0ae9 514int hammer_init_cursor_cluster(hammer_cursor_t cursor, hammer_cluster_t cluster);
195c19a1 515
8cd0a023 516void hammer_done_cursor(hammer_cursor_t cursor);
6b4f890b 517void hammer_mem_done(hammer_cursor_t cursor);
8cd0a023
MD
518
519int hammer_btree_lookup(hammer_cursor_t cursor);
d26d0ae9 520int hammer_btree_first(hammer_cursor_t cursor);
8cd0a023
MD
521int hammer_btree_extract(hammer_cursor_t cursor, int flags);
522int hammer_btree_iterate(hammer_cursor_t cursor);
523int hammer_btree_insert(hammer_cursor_t cursor, hammer_btree_elm_t elm);
524int hammer_btree_delete(hammer_cursor_t cursor);
525int hammer_btree_cmp(hammer_base_elm_t key1, hammer_base_elm_t key2);
d26d0ae9 526int hammer_btree_chkts(hammer_tid_t ts, hammer_base_elm_t key);
c0ade690
MD
527void hammer_print_btree_node(hammer_node_ondisk_t ondisk);
528void hammer_print_btree_elm(hammer_btree_elm_t elm, u_int8_t type, int i);
8750964d 529
c60bb2c5 530void *hammer_bread(struct hammer_cluster *cluster, int32_t cloff,
8cd0a023
MD
531 u_int64_t buf_type, int *errorp,
532 struct hammer_buffer **bufferp);
533
534hammer_volume_t hammer_get_root_volume(hammer_mount_t hmp, int *errorp);
535hammer_cluster_t hammer_get_root_cluster(hammer_mount_t hmp, int *errorp);
427e5fc6 536
8cd0a023 537hammer_volume_t hammer_get_volume(hammer_mount_t hmp,
427e5fc6 538 int32_t vol_no, int *errorp);
61aeeb33
MD
539hammer_supercl_t hammer_get_supercl(hammer_volume_t volume, int32_t scl_no,
540 int *errorp, hammer_alloc_state_t isnew);
541hammer_cluster_t hammer_get_cluster(hammer_volume_t volume, int32_t clu_no,
542 int *errorp, hammer_alloc_state_t isnew);
8cd0a023
MD
543hammer_buffer_t hammer_get_buffer(hammer_cluster_t cluster,
544 int32_t buf_no, u_int64_t buf_type, int *errorp);
545
fbc6e32a 546int hammer_ref_volume(hammer_volume_t volume);
8cd0a023
MD
547int hammer_ref_cluster(hammer_cluster_t cluster);
548int hammer_ref_buffer(hammer_buffer_t buffer);
549void hammer_flush_buffer_nodes(hammer_buffer_t buffer);
550
551
552void hammer_rel_volume(hammer_volume_t volume, int flush);
553void hammer_rel_supercl(hammer_supercl_t supercl, int flush);
554void hammer_rel_cluster(hammer_cluster_t cluster, int flush);
555void hammer_rel_buffer(hammer_buffer_t buffer, int flush);
556
557hammer_node_t hammer_get_node(hammer_cluster_t cluster,
558 int32_t node_offset, int *errorp);
559int hammer_ref_node(hammer_node_t node);
560void hammer_rel_node(hammer_node_t node);
561void hammer_cache_node(hammer_node_t node,
562 struct hammer_node **cache);
563void hammer_uncache_node(struct hammer_node **cache);
564void hammer_flush_node(hammer_node_t node);
565
427e5fc6
MD
566void hammer_dup_buffer(struct hammer_buffer **bufferp,
567 struct hammer_buffer *buffer);
568void hammer_dup_cluster(struct hammer_cluster **clusterp,
569 struct hammer_cluster *cluster);
d26d0ae9
MD
570hammer_cluster_t hammer_alloc_cluster(hammer_mount_t hmp,
571 hammer_cluster_t cluster_hint, int *errorp);
572void hammer_init_cluster(hammer_cluster_t cluster,
573 hammer_base_elm_t left_bound,
574 hammer_base_elm_t right_bound);
8cd0a023 575hammer_node_t hammer_alloc_btree(struct hammer_cluster *cluster, int *errorp);
427e5fc6
MD
576void *hammer_alloc_data(struct hammer_cluster *cluster, int32_t bytes,
577 int *errorp, struct hammer_buffer **bufferp);
578void *hammer_alloc_record(struct hammer_cluster *cluster,
579 int *errorp, struct hammer_buffer **bufferp);
4d75d829
MD
580void hammer_initbuffer(hammer_alist_t live, hammer_fsbuf_head_t head,
581 u_int64_t type);
427e5fc6
MD
582void hammer_free_data_ptr(struct hammer_buffer *buffer,
583 void *data, int bytes);
584void hammer_free_record_ptr(struct hammer_buffer *buffer,
585 union hammer_record_ondisk *rec);
d26d0ae9 586void hammer_free_cluster(hammer_cluster_t cluster);
427e5fc6
MD
587void hammer_free_btree(struct hammer_cluster *cluster, int32_t bclu_offset);
588void hammer_free_data(struct hammer_cluster *cluster, int32_t bclu_offset,
589 int32_t bytes);
590void hammer_free_record(struct hammer_cluster *cluster, int32_t bclu_offset);
591
66325755
MD
592void hammer_put_volume(struct hammer_volume *volume, int flush);
593void hammer_put_supercl(struct hammer_supercl *supercl, int flush);
594void hammer_put_cluster(struct hammer_cluster *cluster, int flush);
595void hammer_put_buffer(struct hammer_buffer *buffer, int flush);
427e5fc6
MD
596
597void hammer_init_alist_config(void);
8750964d 598
8cd0a023
MD
599void hammer_start_transaction(struct hammer_transaction *trans,
600 struct hammer_mount *hmp);
d113fda1
MD
601void hammer_start_transaction_tid(struct hammer_transaction *trans,
602 struct hammer_mount *hmp, hammer_tid_t tid);
66325755
MD
603void hammer_commit_transaction(struct hammer_transaction *trans);
604void hammer_abort_transaction(struct hammer_transaction *trans);
605
606void hammer_modify_inode(struct hammer_transaction *trans,
8cd0a023
MD
607 hammer_inode_t ip, int flags);
608int hammer_create_inode(struct hammer_transaction *trans, struct vattr *vap,
609 struct ucred *cred, struct hammer_inode *dip,
610 struct hammer_inode **ipp);
a89aec1b 611void hammer_rel_inode(hammer_inode_t ip, int flush);
c0ade690 612int hammer_sync_inode(hammer_inode_t ip, int waitfor, int handle_delete);
8cd0a023 613
a89aec1b 614int hammer_ip_add_directory(struct hammer_transaction *trans,
8cd0a023
MD
615 hammer_inode_t dip, struct namecache *ncp,
616 hammer_inode_t nip);
a89aec1b 617int hammer_ip_del_directory(struct hammer_transaction *trans,
8cd0a023
MD
618 hammer_cursor_t cursor, hammer_inode_t dip,
619 hammer_inode_t ip);
7a04d74f
MD
620int hammer_ip_add_record(struct hammer_transaction *trans,
621 hammer_record_t record);
a89aec1b 622int hammer_ip_delete_range(struct hammer_transaction *trans,
d26d0ae9
MD
623 hammer_inode_t ip, int64_t ran_beg, int64_t ran_end,
624 struct hammer_cursor **spikep);
7a04d74f
MD
625int hammer_ip_delete_range_all(struct hammer_transaction *trans,
626 hammer_inode_t ip);
c0ade690 627int hammer_ip_sync_data(struct hammer_transaction *trans,
8cd0a023 628 hammer_inode_t ip, int64_t offset,
d26d0ae9
MD
629 void *data, int bytes, struct hammer_cursor **spikep);
630int hammer_ip_sync_record(hammer_record_t rec, struct hammer_cursor **spikep);
631int hammer_write_record(hammer_cursor_t cursor, hammer_record_ondisk_t rec,
632 void *data, int cursor_flags);
633
634void hammer_load_spike(hammer_cursor_t cursor, struct hammer_cursor **spikep);
635int hammer_spike(struct hammer_cursor **spikep);
4d75d829 636int hammer_recover(struct hammer_cluster *cluster);
66325755
MD
637
638int hammer_io_read(struct vnode *devvp, struct hammer_io *io);
639int hammer_io_new(struct vnode *devvp, struct hammer_io *io);
640void hammer_io_release(struct hammer_io *io, int flush);
8cd0a023 641int hammer_io_checkflush(hammer_io_t io);
fbc6e32a
MD
642void hammer_io_notify_cluster(hammer_cluster_t cluster);
643void hammer_io_flush(struct hammer_io *io, struct hammer_sync_info *info);
0b075555
MD
644void hammer_io_intend_modify(struct hammer_io *io);
645void hammer_io_modify_done(struct hammer_io *io);
61aeeb33 646void hammer_io_clear_modify(struct hammer_io *io);
66325755 647
8750964d
MD
648#endif
649
427e5fc6
MD
650/*
651 * Inline support functions (not kernel specific)
652 */
653static __inline void
654hammer_modify_volume(struct hammer_volume *volume)
655{
66325755 656 volume->io.modified = 1;
0b075555
MD
657 ++volume->io.lock.modifying;
658 if (volume->io.released)
659 hammer_io_intend_modify(&volume->io);
660}
661
662static __inline void
663hammer_modify_volume_done(struct hammer_volume *volume)
664{
665 hammer_io_modify_done(&volume->io);
427e5fc6
MD
666}
667
668static __inline void
669hammer_modify_supercl(struct hammer_supercl *supercl)
670{
66325755 671 supercl->io.modified = 1;
0b075555
MD
672 ++supercl->io.lock.modifying;
673 if (supercl->io.released)
674 hammer_io_intend_modify(&supercl->io);
675}
676
677static __inline void
678hammer_modify_supercl_done(struct hammer_supercl *supercl)
679{
680 hammer_io_modify_done(&supercl->io);
427e5fc6
MD
681}
682
683static __inline void
684hammer_modify_cluster(struct hammer_cluster *cluster)
685{
66325755 686 cluster->io.modified = 1;
0b075555
MD
687 ++cluster->io.lock.modifying;
688 if (cluster->io.released)
689 hammer_io_intend_modify(&cluster->io);
690}
691
692static __inline void
693hammer_modify_cluster_done(struct hammer_cluster *cluster)
694{
695 hammer_io_modify_done(&cluster->io);
427e5fc6
MD
696}
697
698static __inline void
699hammer_modify_buffer(struct hammer_buffer *buffer)
700{
fbc6e32a 701 hammer_io_notify_cluster(buffer->cluster);
66325755 702 buffer->io.modified = 1;
0b075555
MD
703 ++buffer->io.lock.modifying;
704 if (buffer->io.released)
705 hammer_io_intend_modify(&buffer->io);
706}
707
708static __inline void
709hammer_modify_buffer_done(struct hammer_buffer *buffer)
710{
711 hammer_io_modify_done(&buffer->io);
427e5fc6
MD
712}
713
8cd0a023
MD
714static __inline void
715hammer_modify_node(struct hammer_node *node)
716{
fbc6e32a 717 hammer_modify_buffer(node->buffer);
8cd0a023
MD
718}
719
0b075555
MD
720static __inline void
721hammer_modify_node_done(struct hammer_node *node)
722{
723 hammer_modify_buffer_done(node->buffer);
724}
725
427e5fc6
MD
726/*
727 * Return the cluster-relative byte offset of an element within a buffer
728 */
729static __inline int
730hammer_bclu_offset(struct hammer_buffer *buffer, void *ptr)
731{
732 int bclu_offset;
733
734 bclu_offset = buffer->buf_no * HAMMER_BUFSIZE +
735 ((char *)ptr - (char *)buffer->ondisk);
736 return(bclu_offset);
737}
738