2 * Copyright (c) 2007 The DragonFly Project. All rights reserved.
4 * This code is derived from software contributed to The DragonFly Project
5 * by Matthew Dillon <dillon@backplane.com>
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
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
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.
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
34 * $DragonFly: src/sbin/hammer/hammer_util.h,v 1.19 2008/07/10 04:44:58 dillon Exp $
37 #include <sys/types.h>
39 #include <sys/queue.h>
41 #include <vfs/hammer/hammer_disk.h>
45 * Cache management - so the user code can keep its memory use under control
50 TAILQ_HEAD(volume_list
, volume_info
);
53 TAILQ_ENTRY(cache_info
) entry
;
55 struct volume_info
*volume
;
56 struct buffer_info
*buffer
;
58 enum cache_type
{ ISVOLUME
, ISBUFFER
} type
;
59 int refs
; /* structural references */
60 int modified
; /* ondisk modified flag */
61 int delete; /* delete flag - delete on last ref */
64 #define HAMMER_BUFLISTS 64
65 #define HAMMER_BUFLISTMASK (HAMMER_BUFLISTS - 1)
68 * These structures are used by newfs_hammer to track the filesystem
69 * buffers it constructs while building the filesystem. No attempt
70 * is made to try to make this efficient.
73 struct cache_info cache
;
74 TAILQ_ENTRY(volume_info
) entry
;
76 hammer_off_t vol_alloc
; /* volume-relative offset */
77 hammer_off_t vol_free_off
; /* zone-2 offset */
78 hammer_off_t vol_free_end
; /* zone-2 offset */
85 struct hammer_volume_ondisk
*ondisk
;
87 TAILQ_HEAD(, buffer_info
) buffer_lists
[HAMMER_BUFLISTS
];
91 struct cache_info cache
;
92 TAILQ_ENTRY(buffer_info
) entry
;
93 hammer_off_t buf_offset
; /* full hammer offset spec */
94 int64_t buf_disk_offset
;/* relative to blkdev */
95 struct volume_info
*volume
;
99 extern uuid_t Hammer_FSType
;
100 extern uuid_t Hammer_FSId
;
101 extern int64_t BootAreaSize
;
102 extern int64_t MemAreaSize
;
103 extern int64_t UndoBufferSize
;
105 extern int NumVolumes
;
106 extern int RootVolNo
;
107 extern struct volume_list VolList
;
109 uint32_t crc32(const void *buf
, size_t size
);
110 uint32_t crc32_ext(const void *buf
, size_t size
, uint32_t ocrc
);
112 struct volume_info
*setup_volume(int32_t vol_no
, const char *filename
,
113 int isnew
, int oflags
);
114 struct volume_info
*get_volume(int32_t vol_no
);
115 struct buffer_info
*get_buffer(hammer_off_t buf_offset
, int isnew
);
116 void *get_buffer_data(hammer_off_t buf_offset
, struct buffer_info
**bufferp
,
118 hammer_node_ondisk_t
get_node(hammer_off_t node_offset
,
119 struct buffer_info
**bufp
);
121 void rel_volume(struct volume_info
*volume
);
122 void rel_buffer(struct buffer_info
*buffer
);
124 hammer_off_t
blockmap_lookup(hammer_off_t bmap_off
,
125 struct hammer_blockmap_layer1
*layer1
,
126 struct hammer_blockmap_layer2
*layer2
);
127 void format_blockmap(hammer_blockmap_t blockmap
, hammer_off_t zone_base
);
128 void format_undomap(hammer_volume_ondisk_t ondisk
);
130 void *alloc_btree_element(hammer_off_t
*offp
);
131 void *alloc_data_element(hammer_off_t
*offp
, int32_t data_len
,
132 struct buffer_info
**data_bufferp
);
134 int hammer_btree_cmp(hammer_base_elm_t key1
, hammer_base_elm_t key2
);
135 void hammer_key_beg_init(hammer_base_elm_t base
);
136 void hammer_key_end_init(hammer_base_elm_t base
);
137 int hammer_crc_test_leaf(void *data
, hammer_btree_leaf_elm_t leaf
);
139 void format_freemap(struct volume_info
*root_vol
, hammer_blockmap_t blockmap
);
140 int64_t initialize_freemap(struct volume_info
*vol
);
142 void flush_all_volumes(void);
143 void flush_volume(struct volume_info
*vol
);
144 void flush_buffer(struct buffer_info
*buf
);
146 void hammer_cache_set(int bytes
);
147 void hammer_cache_add(struct cache_info
*cache
, enum cache_type type
);
148 void hammer_cache_del(struct cache_info
*cache
);
149 void hammer_cache_flush(void);
151 void panic(const char *ctl
, ...);