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