e077daf91e437ff5815dbee3594b8e036179f5d6
[dragonfly.git] / 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.15 2007/12/30 00:47:22 dillon Exp $
35  */
36 /*
37  * This header file contains structures used internally by the HAMMERFS
38  * implementation.  See hammer_disk.h for on-disk structures.
39  */
40
41 #include <sys/param.h>
42 #include <sys/types.h>
43 #include <sys/kernel.h>
44 #include <sys/systm.h>
45 #include <sys/tree.h>
46 #include <sys/malloc.h>
47 #include <sys/mount.h>
48 #include <sys/vnode.h>
49 #include <sys/globaldata.h>
50 #include <sys/lockf.h>
51 #include <sys/buf.h>
52 #include <sys/queue.h>
53 #include <sys/globaldata.h>
54
55 #include <sys/buf2.h>
56 #include "hammer_alist.h"
57 #include "hammer_disk.h"
58 #include "hammer_mount.h"
59
60 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
61
62 MALLOC_DECLARE(M_HAMMER);
63
64 struct hammer_mount;
65
66 /*
67  * Key structure used for custom RB tree inode lookups.  This prototypes
68  * the function hammer_ino_rb_tree_RB_LOOKUP_INFO(root, info).
69  */
70 typedef struct hammer_inode_info {
71         u_int64_t       obj_id;         /* (key) object identifier */
72         hammer_tid_t    obj_asof;       /* (key) snapshot transid or 0 */
73 } *hammer_inode_info_t;
74
75 /*
76  * HAMMER Transaction tracking
77  */
78 struct hammer_transaction {
79         struct hammer_mount *hmp;
80         hammer_tid_t    tid;
81         struct hammer_volume *rootvol;
82 };
83
84 typedef struct hammer_transaction *hammer_transaction_t;
85
86 /*
87  * HAMMER locks
88  */
89 struct hammer_lock {
90         int     refs;
91         int     lockcount;
92         int     wanted;
93         struct thread *locktd;
94 };
95
96 static __inline int
97 hammer_islocked(struct hammer_lock *lock)
98 {
99         return(lock->lockcount != 0);
100 }
101
102 static __inline int
103 hammer_islastref(struct hammer_lock *lock)
104 {
105         return(lock->refs == 1);
106 }
107
108 /*
109  * Structure used to represent an inode in-memory.
110  *
111  * The record and data associated with an inode may be out of sync with
112  * the disk (xDIRTY flags), or not even on the disk at all (ONDISK flag
113  * clear).
114  *
115  * An inode may also hold a cache of unsynchronized records, used for
116  * database and directories only.  Unsynchronized regular file data is
117  * stored in the buffer cache.
118  *
119  * NOTE: A file which is created and destroyed within the initial
120  * synchronization period can wind up not doing any disk I/O at all.
121  *
122  * Finally, an inode may cache numerous disk-referencing B-Tree cursors.
123  */
124 struct hammer_ino_rb_tree;
125 struct hammer_inode;
126 RB_HEAD(hammer_ino_rb_tree, hammer_inode);
127 RB_PROTOTYPEX(hammer_ino_rb_tree, INFO, hammer_inode, rb_node,
128               hammer_ino_rb_compare, hammer_inode_info_t);
129
130 struct hammer_rec_rb_tree;
131 struct hammer_record;
132 RB_HEAD(hammer_rec_rb_tree, hammer_record);
133 RB_PROTOTYPEX(hammer_rec_rb_tree, INFO, hammer_record, rb_node,
134               hammer_rec_rb_compare, hammer_base_elm_t);
135
136 TAILQ_HEAD(hammer_node_list, hammer_node);
137
138 struct hammer_inode {
139         RB_ENTRY(hammer_inode) rb_node;
140         u_int64_t       obj_id;         /* (key) object identifier */
141         hammer_tid_t    obj_asof;       /* (key) snapshot transid or 0 */
142         hammer_tid_t    last_tid;       /* last modified tid (for fsync) */
143         struct hammer_mount *hmp;
144         int             flags;
145         struct vnode    *vp;
146         struct lockf    advlock;
147         struct hammer_lock lock;
148         struct hammer_inode_record ino_rec;
149         struct hammer_inode_data ino_data;
150         struct hammer_rec_rb_tree rec_tree;     /* red-black record tree */
151         struct hammer_node      *cache; /* cached B-Tree node shortcut */
152 };
153
154 typedef struct hammer_inode *hammer_inode_t;
155
156 #define VTOI(vp)        ((struct hammer_inode *)(vp)->v_data)
157
158 #define HAMMER_INODE_DDIRTY     0x0001  /* in-memory ino_data is dirty */
159 #define HAMMER_INODE_RDIRTY     0x0002  /* in-memory ino_rec is dirty */
160 #define HAMMER_INODE_ITIMES     0x0004  /* in-memory mtime/atime modified */
161 #define HAMMER_INODE_ONDISK     0x0010  /* inode is on-disk (else not yet) */
162 #define HAMMER_INODE_FLUSH      0x0020  /* flush on last ref */
163 #define HAMMER_INODE_TID        0x0040  /* update in-memory last_tid */
164 #define HAMMER_INODE_DELETED    0x0080  /* inode ready for deletion */
165 #define HAMMER_INODE_DELONDISK  0x0100  /* delete synchronized to disk */
166
167 #define HAMMER_MAX_INODE_CURSORS        4
168
169 /*
170  * Structure used to represent an unsynchronized record in-memory.  This
171  * structure is orgranized in a per-inode RB-tree.  If the inode is not
172  * on disk then neither are any records and the in-memory record tree
173  * represents the entire contents of the inode.  If the inode is on disk
174  * then the on-disk B-Tree is scanned in parallel with the in-memory
175  * RB-Tree to synthesize the current state of the file.
176  *
177  * Only current (delete_tid == 0) unsynchronized records are kept in-memory.
178  */
179 struct hammer_record {
180         RB_ENTRY(hammer_record)         rb_node;
181         struct hammer_lock              lock;
182         struct hammer_inode             *ip;
183         union hammer_record_ondisk      rec;
184         union hammer_data_ondisk        *data;
185         int                             flags;
186 };
187
188 typedef struct hammer_record *hammer_record_t;
189
190 #define HAMMER_RECF_ALLOCDATA           0x0001
191 #define HAMMER_RECF_ONRBTREE            0x0002
192 #define HAMMER_RECF_DELETED             0x0004
193 #define HAMMER_RECF_EMBEDDED_DATA       0x0008
194
195 /*
196  * Structures used to internally represent a volume and a cluster
197  */
198 struct hammer_volume;
199 struct hammer_cluster;
200 struct hammer_supercl;
201 struct hammer_buffer;
202 struct hammer_node;
203 RB_HEAD(hammer_vol_rb_tree, hammer_volume);
204 RB_HEAD(hammer_clu_rb_tree, hammer_cluster);
205 RB_HEAD(hammer_scl_rb_tree, hammer_supercl);
206 RB_HEAD(hammer_buf_rb_tree, hammer_buffer);
207 RB_HEAD(hammer_nod_rb_tree, hammer_node);
208
209 RB_PROTOTYPE2(hammer_vol_rb_tree, hammer_volume, rb_node,
210               hammer_vol_rb_compare, int32_t);
211 RB_PROTOTYPE2(hammer_clu_rb_tree, hammer_cluster, rb_node,
212               hammer_clu_rb_compare, int32_t);
213 RB_PROTOTYPE2(hammer_scl_rb_tree, hammer_supercl, rb_node,
214               hammer_scl_rb_compare, int32_t);
215 RB_PROTOTYPE2(hammer_buf_rb_tree, hammer_buffer, rb_node,
216               hammer_buf_rb_compare, int32_t);
217 RB_PROTOTYPE2(hammer_nod_rb_tree, hammer_node, rb_node,
218               hammer_nod_rb_compare, int32_t);
219
220 /*
221  * IO management - embedded at the head of various in-memory structures
222  */
223 enum hammer_io_type { HAMMER_STRUCTURE_VOLUME,
224                       HAMMER_STRUCTURE_SUPERCL,
225                       HAMMER_STRUCTURE_CLUSTER,
226                       HAMMER_STRUCTURE_BUFFER };
227
228 union hammer_io_structure;
229
230 struct worklist {
231         LIST_ENTRY(worklist) node;
232 };
233
234 struct hammer_io {
235         struct worklist worklist;
236         struct hammer_lock lock;
237         enum hammer_io_type type;
238         struct buf      *bp;
239         int64_t         offset;
240         u_int           modified : 1;   /* bp's data was modified */
241         u_int           released : 1;   /* bp released (w/ B_LOCKED set) */
242 };
243
244 typedef struct hammer_io *hammer_io_t;
245
246 /*
247  * In-memory volume representing on-disk buffer
248  */
249 struct hammer_volume {
250         struct hammer_io io;
251         RB_ENTRY(hammer_volume) rb_node;
252         struct hammer_clu_rb_tree rb_clus_root;
253         struct hammer_scl_rb_tree rb_scls_root;
254         struct hammer_volume_ondisk *ondisk;
255         struct hammer_alist_live alist;
256         int32_t vol_no;
257         int32_t vol_clsize;
258         int32_t clu_iterator;   /* cluster allocation iterator */
259         int64_t nblocks;        /* note: special calculation for statfs */
260         int64_t cluster_base;   /* base offset of cluster 0 */
261         char    *vol_name;
262         struct vnode *devvp;
263         struct hammer_mount *hmp;
264         int     vol_flags;
265 };
266
267 typedef struct hammer_volume *hammer_volume_t;
268
269 /*
270  * In-memory super-cluster representing on-disk buffer
271  */
272 struct hammer_supercl {
273         struct hammer_io io;
274         RB_ENTRY(hammer_supercl) rb_node;
275         struct hammer_supercl_ondisk *ondisk;
276         struct hammer_volume *volume;
277         struct hammer_alist_live alist;
278         int32_t scl_no;
279 };
280
281 typedef struct hammer_supercl *hammer_supercl_t;
282
283 enum hammer_cluster_state {
284         HAMMER_CLUSTER_IDLE,
285         HAMMER_CLUSTER_ASYNC,
286         HAMMER_CLUSTER_OPEN
287 };
288
289 /*
290  * In-memory cluster representing on-disk buffer
291  *
292  * The cluster's indexing range is cached in hammer_cluster, separate
293  * from the ondisk info in order to allow cursors to point to it.
294  */
295 struct hammer_cluster {
296         struct hammer_io io;
297         RB_ENTRY(hammer_cluster) rb_node;
298         struct hammer_buf_rb_tree rb_bufs_root;
299         struct hammer_cluster_ondisk *ondisk;
300         struct hammer_volume *volume;
301         struct hammer_alist_live alist_master;
302         struct hammer_alist_live alist_btree;
303         struct hammer_alist_live alist_record;
304         struct hammer_alist_live alist_mdata;
305         struct hammer_nod_rb_tree rb_nods_root; /* cursors in cluster */
306         struct hammer_base_elm clu_btree_beg;   /* copy of on-disk info */
307         struct hammer_base_elm clu_btree_end;   /* copy of on-disk info */
308         int32_t clu_no;
309         enum hammer_cluster_state state;
310 };
311
312 typedef struct hammer_cluster *hammer_cluster_t;
313
314 /*
315  * In-memory buffer (other then volume, super-cluster, or cluster),
316  * representing an on-disk buffer.
317  */
318 struct hammer_buffer {
319         struct hammer_io io;
320         RB_ENTRY(hammer_buffer) rb_node;
321         hammer_fsbuf_ondisk_t ondisk;
322         struct hammer_volume *volume;
323         struct hammer_cluster *cluster;
324         int32_t buf_no;
325         u_int64_t buf_type;
326         struct hammer_alist_live alist;
327         struct hammer_node_list clist;
328         struct hammer_node *save_scan;
329 };
330
331 typedef struct hammer_buffer *hammer_buffer_t;
332
333 /*
334  * In-memory B-Tree node, representing an on-disk B-Tree node.
335  *
336  * This is a hang-on structure which is backed by a hammer_buffer,
337  * indexed by a hammer_cluster, and used for fine-grained locking of
338  * B-Tree nodes in order to properly control lock ordering.  A hammer_buffer
339  * can contain multiple nodes representing wildly disassociated portions
340  * of the B-Tree so locking cannot be done on a buffer-by-buffer basis.
341  *
342  * This structure uses a cluster-relative index to reduce the number
343  * of layers required to access it, and also because all on-disk B-Tree
344  * references are cluster-relative offsets.
345  */
346 struct hammer_node {
347         struct hammer_lock      lock;           /* node-by-node lock */
348         TAILQ_ENTRY(hammer_node) entry;         /* per-buffer linkage */
349         RB_ENTRY(hammer_node)   rb_node;        /* per-cluster linkage */
350         int32_t                 node_offset;    /* cluster-rel offset */
351         struct hammer_cluster   *cluster;
352         struct hammer_buffer    *buffer;        /* backing buffer */
353         hammer_node_ondisk_t    ondisk;         /* ptr to on-disk structure */
354         struct hammer_node      **cache1;       /* passive cache(s) */
355         struct hammer_node      **cache2;
356 };
357
358 typedef struct hammer_node      *hammer_node_t;
359
360 /*
361  * Common I/O management structure - embedded in in-memory structures
362  * which are backed by filesystem buffers.
363  */
364 union hammer_io_structure {
365         struct hammer_io        io;
366         struct hammer_volume    volume;
367         struct hammer_supercl   supercl;
368         struct hammer_cluster   cluster;
369         struct hammer_buffer    buffer;
370 };
371
372 #define HAMFS_CLUSTER_DIRTY     0x0001
373
374 #include "hammer_cursor.h"
375
376 /*
377  * Internal hammer mount data structure
378  */
379 struct hammer_mount {
380         struct mount *mp;
381         /*struct vnode *rootvp;*/
382         struct hammer_ino_rb_tree rb_inos_root;
383         struct hammer_vol_rb_tree rb_vols_root;
384         struct hammer_volume *rootvol;
385         struct hammer_cluster *rootcl;
386         char    *zbuf;  /* HAMMER_BUFSIZE bytes worth of all-zeros */
387         int     hflags;
388         int     ronly;
389         int     nvolumes;
390         int     volume_iterator;
391         uuid_t  fsid;
392         udev_t  fsid_udev;
393         hammer_tid_t asof;
394         u_int32_t namekey_iterator;
395 };
396
397 typedef struct hammer_mount     *hammer_mount_t;
398
399 struct hammer_sync_info {
400         int error;
401         int waitfor;
402 };
403
404 #endif
405
406 #if defined(_KERNEL)
407
408 extern struct vop_ops hammer_vnode_vops;
409 extern struct vop_ops hammer_spec_vops;
410 extern struct vop_ops hammer_fifo_vops;
411 extern struct hammer_alist_config Buf_alist_config;
412 extern struct hammer_alist_config Vol_normal_alist_config;
413 extern struct hammer_alist_config Vol_super_alist_config;
414 extern struct hammer_alist_config Supercl_alist_config;
415 extern struct hammer_alist_config Clu_master_alist_config;
416 extern struct hammer_alist_config Clu_slave_alist_config;
417 extern struct bio_ops hammer_bioops;
418
419 int     hammer_vop_inactive(struct vop_inactive_args *);
420 int     hammer_vop_reclaim(struct vop_reclaim_args *);
421 int     hammer_vfs_vget(struct mount *mp, ino_t ino, struct vnode **vpp);
422 int     hammer_get_vnode(struct hammer_inode *ip, int lktype,
423                         struct vnode **vpp);
424 struct hammer_inode *hammer_get_inode(hammer_mount_t hmp,
425                         u_int64_t obj_id, hammer_tid_t asof, int *errorp);
426 int     hammer_update_inode(hammer_inode_t ip);
427 void    hammer_put_inode(struct hammer_inode *ip);
428 void    hammer_put_inode_ref(struct hammer_inode *ip);
429
430 int     hammer_unload_inode(hammer_inode_t ip, void *data __unused);
431 int     hammer_unload_volume(hammer_volume_t volume, void *data __unused);
432 int     hammer_unload_supercl(hammer_supercl_t supercl, void *data __unused);
433 int     hammer_unload_cluster(hammer_cluster_t cluster, void *data __unused);
434 int     hammer_unload_buffer(hammer_buffer_t buffer, void *data __unused);
435 int     hammer_install_volume(hammer_mount_t hmp, const char *volname);
436
437 int     hammer_ip_lookup(hammer_cursor_t cursor, hammer_inode_t ip);
438 int     hammer_ip_first(hammer_cursor_t cursor, hammer_inode_t ip);
439 int     hammer_ip_next(hammer_cursor_t cursor);
440 int     hammer_ip_resolve_data(hammer_cursor_t cursor);
441 int     hammer_ip_delete_record(hammer_cursor_t cursor, hammer_tid_t tid);
442
443 int     hammer_sync_hmp(hammer_mount_t hmp, int waitfor);
444 int     hammer_sync_volume(hammer_volume_t volume, void *data);
445 int     hammer_sync_cluster(hammer_cluster_t cluster, void *data);
446 int     hammer_sync_buffer(hammer_buffer_t buffer, void *data);
447
448 hammer_record_t
449         hammer_alloc_mem_record(hammer_inode_t ip);
450 void    hammer_rel_mem_record(struct hammer_record **recordp);
451 void    hammer_drop_mem_record(hammer_record_t record, int delete);
452
453 int     hammer_cursor_up(hammer_cursor_t cursor, int nonblock);
454 int     hammer_cursor_toroot(hammer_cursor_t cursor);
455 int     hammer_cursor_down(hammer_cursor_t cursor);
456
457 void    hammer_lock_ex(struct hammer_lock *lock);
458 int     hammer_lock_ex_try(struct hammer_lock *lock);
459 void    hammer_lock_sh(struct hammer_lock *lock);
460 void    hammer_unlock(struct hammer_lock *lock);
461 void    hammer_ref(struct hammer_lock *lock);
462 void    hammer_unref(struct hammer_lock *lock);
463 void    hammer_downgrade(struct hammer_lock *lock);
464
465 u_int32_t hammer_to_unix_xid(uuid_t *uuid);
466 void hammer_guid_to_uuid(uuid_t *uuid, u_int32_t guid);
467 void    hammer_to_timespec(hammer_tid_t tid, struct timespec *ts);
468 hammer_tid_t hammer_timespec_to_transid(struct timespec *ts);
469 hammer_tid_t hammer_alloc_tid(hammer_transaction_t trans);
470 hammer_tid_t hammer_now_tid(void);
471 hammer_tid_t hammer_alloc_recid(hammer_transaction_t trans);
472
473 enum vtype hammer_get_vnode_type(u_int8_t obj_type);
474 int hammer_get_dtype(u_int8_t obj_type);
475 u_int8_t hammer_get_obj_type(enum vtype vtype);
476 int64_t hammer_directory_namekey(void *name, int len);
477
478 int     hammer_init_cursor_hmp(hammer_cursor_t cursor, hammer_mount_t hmp);
479 int     hammer_init_cursor_cluster(hammer_cursor_t cursor, hammer_cluster_t cluster);
480 int     hammer_init_cursor_ip(hammer_cursor_t cursor, hammer_inode_t ip);
481
482 void    hammer_done_cursor(hammer_cursor_t cursor);
483 void    hammer_mem_done(hammer_cursor_t cursor);
484
485 int     hammer_btree_lookup(hammer_cursor_t cursor);
486 int     hammer_btree_first(hammer_cursor_t cursor);
487 int     hammer_btree_extract(hammer_cursor_t cursor, int flags);
488 int     hammer_btree_iterate(hammer_cursor_t cursor);
489 int     hammer_btree_insert(hammer_cursor_t cursor, hammer_btree_elm_t elm);
490 int     hammer_btree_delete(hammer_cursor_t cursor);
491 int     hammer_btree_cmp(hammer_base_elm_t key1, hammer_base_elm_t key2);
492 int     hammer_btree_chkts(hammer_tid_t ts, hammer_base_elm_t key);
493 void    hammer_print_btree_node(hammer_node_ondisk_t ondisk);
494 void    hammer_print_btree_elm(hammer_btree_elm_t elm, u_int8_t type, int i);
495
496 void    *hammer_bread(struct hammer_cluster *cluster, int32_t cloff,
497                       u_int64_t buf_type, int *errorp,
498                       struct hammer_buffer **bufferp);
499
500 hammer_volume_t hammer_get_root_volume(hammer_mount_t hmp, int *errorp);
501 hammer_cluster_t hammer_get_root_cluster(hammer_mount_t hmp, int *errorp);
502
503 hammer_volume_t hammer_get_volume(hammer_mount_t hmp,
504                         int32_t vol_no, int *errorp);
505 hammer_supercl_t hammer_get_supercl(hammer_volume_t volume,
506                         int32_t scl_no, int *errorp, int isnew);
507 hammer_cluster_t hammer_get_cluster(hammer_volume_t volume,
508                         int32_t clu_no, int *errorp, int isnew);
509 hammer_buffer_t hammer_get_buffer(hammer_cluster_t cluster,
510                         int32_t buf_no, u_int64_t buf_type, int *errorp);
511
512 int             hammer_ref_volume(hammer_volume_t volume);
513 int             hammer_ref_cluster(hammer_cluster_t cluster);
514 int             hammer_ref_buffer(hammer_buffer_t buffer);
515 void            hammer_flush_buffer_nodes(hammer_buffer_t buffer);
516
517
518 void            hammer_rel_volume(hammer_volume_t volume, int flush);
519 void            hammer_rel_supercl(hammer_supercl_t supercl, int flush);
520 void            hammer_rel_cluster(hammer_cluster_t cluster, int flush);
521 void            hammer_rel_buffer(hammer_buffer_t buffer, int flush);
522
523 hammer_node_t   hammer_get_node(hammer_cluster_t cluster,
524                         int32_t node_offset, int *errorp);
525 int             hammer_ref_node(hammer_node_t node);
526 void            hammer_rel_node(hammer_node_t node);
527 void            hammer_cache_node(hammer_node_t node,
528                         struct hammer_node **cache);
529 void            hammer_uncache_node(struct hammer_node **cache);
530 void            hammer_flush_node(hammer_node_t node);
531
532 void hammer_dup_buffer(struct hammer_buffer **bufferp,
533                         struct hammer_buffer *buffer);
534 void hammer_dup_cluster(struct hammer_cluster **clusterp,
535                         struct hammer_cluster *cluster);
536 hammer_cluster_t hammer_alloc_cluster(hammer_mount_t hmp,
537                         hammer_cluster_t cluster_hint, int *errorp);
538 void hammer_init_cluster(hammer_cluster_t cluster,
539                         hammer_base_elm_t left_bound,
540                         hammer_base_elm_t right_bound);
541 hammer_node_t hammer_alloc_btree(struct hammer_cluster *cluster, int *errorp);
542 void *hammer_alloc_data(struct hammer_cluster *cluster, int32_t bytes,
543                         int *errorp, struct hammer_buffer **bufferp);
544 void *hammer_alloc_record(struct hammer_cluster *cluster,
545                         int *errorp, struct hammer_buffer **bufferp);
546 void hammer_free_data_ptr(struct hammer_buffer *buffer, 
547                         void *data, int bytes);
548 void hammer_free_record_ptr(struct hammer_buffer *buffer,
549                         union hammer_record_ondisk *rec);
550 void hammer_free_cluster(hammer_cluster_t cluster);
551 void hammer_free_btree(struct hammer_cluster *cluster, int32_t bclu_offset);
552 void hammer_free_data(struct hammer_cluster *cluster, int32_t bclu_offset,
553                         int32_t bytes);
554 void hammer_free_record(struct hammer_cluster *cluster, int32_t bclu_offset);
555
556 void hammer_put_volume(struct hammer_volume *volume, int flush);
557 void hammer_put_supercl(struct hammer_supercl *supercl, int flush);
558 void hammer_put_cluster(struct hammer_cluster *cluster, int flush);
559 void hammer_put_buffer(struct hammer_buffer *buffer, int flush);
560
561 void hammer_init_alist_config(void);
562
563 void hammer_start_transaction(struct hammer_transaction *trans,
564                               struct hammer_mount *hmp);
565 void hammer_commit_transaction(struct hammer_transaction *trans);
566 void hammer_abort_transaction(struct hammer_transaction *trans);
567
568 void hammer_modify_inode(struct hammer_transaction *trans,
569                         hammer_inode_t ip, int flags);
570 int  hammer_create_inode(struct hammer_transaction *trans, struct vattr *vap,
571                         struct ucred *cred, struct hammer_inode *dip,
572                         struct hammer_inode **ipp);
573 void hammer_rel_inode(hammer_inode_t ip, int flush);
574 int hammer_sync_inode(hammer_inode_t ip, int waitfor, int handle_delete);
575
576 int  hammer_ip_add_directory(struct hammer_transaction *trans,
577                         hammer_inode_t dip, struct namecache *ncp,
578                         hammer_inode_t nip);
579 int  hammer_ip_del_directory(struct hammer_transaction *trans,
580                         hammer_cursor_t cursor, hammer_inode_t dip,
581                         hammer_inode_t ip);
582 int  hammer_ip_add_record(struct hammer_transaction *trans,
583                         hammer_record_t record);
584 int  hammer_ip_delete_range(struct hammer_transaction *trans,
585                         hammer_inode_t ip, int64_t ran_beg, int64_t ran_end,
586                         struct hammer_cursor **spikep);
587 int  hammer_ip_delete_range_all(struct hammer_transaction *trans,
588                         hammer_inode_t ip);
589 int  hammer_ip_sync_data(struct hammer_transaction *trans,
590                         hammer_inode_t ip, int64_t offset,
591                         void *data, int bytes, struct hammer_cursor **spikep);
592 int  hammer_ip_sync_record(hammer_record_t rec, struct hammer_cursor **spikep);
593 int  hammer_write_record(hammer_cursor_t cursor, hammer_record_ondisk_t rec,
594                         void *data, int cursor_flags);
595
596 void hammer_load_spike(hammer_cursor_t cursor, struct hammer_cursor **spikep);
597 int hammer_spike(struct hammer_cursor **spikep);
598
599 int hammer_io_read(struct vnode *devvp, struct hammer_io *io);
600 int hammer_io_new(struct vnode *devvp, struct hammer_io *io);
601 void hammer_io_release(struct hammer_io *io, int flush);
602 int hammer_io_checkflush(hammer_io_t io);
603 void hammer_io_notify_cluster(hammer_cluster_t cluster);
604 void hammer_io_flush(struct hammer_io *io, struct hammer_sync_info *info);
605
606 #endif
607
608 /*
609  * Inline support functions (not kernel specific)
610  */
611 static __inline void
612 hammer_modify_volume(struct hammer_volume *volume)
613 {
614         volume->io.modified = 1;
615 }
616
617 static __inline void
618 hammer_modify_supercl(struct hammer_supercl *supercl)
619 {
620         supercl->io.modified = 1;
621 }
622
623 static __inline void
624 hammer_modify_cluster(struct hammer_cluster *cluster)
625 {
626         cluster->io.modified = 1;
627 }
628
629 static __inline void
630 hammer_modify_buffer(struct hammer_buffer *buffer)
631 {
632         hammer_io_notify_cluster(buffer->cluster);
633         buffer->io.modified = 1;
634 }
635
636 static __inline void
637 hammer_modify_node(struct hammer_node *node)
638 {
639         hammer_modify_buffer(node->buffer);
640 }
641
642 /*
643  * Return the cluster-relative byte offset of an element within a buffer
644  */
645 static __inline int
646 hammer_bclu_offset(struct hammer_buffer *buffer, void *ptr)
647 {
648         int bclu_offset;
649
650         bclu_offset = buffer->buf_no * HAMMER_BUFSIZE + 
651                       ((char *)ptr - (char *)buffer->ondisk);
652         return(bclu_offset);
653 }
654