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
35 #ifndef HAMMER_UTIL_H_
36 #define HAMMER_UTIL_H_
38 #include <sys/types.h>
42 #include <sys/queue.h>
43 #include <sys/mount.h>
56 #include <vfs/hammer/hammer_disk.h>
57 #include <vfs/hammer/hammer_ioctl.h>
61 * pidfile management - common definitions so code is more robust
64 #define PIDFILE_BUFSIZE 64
65 static const char pidfile_loc[] = "/var/run";
68 * Cache management - so the user code can keep its memory use under control
73 TAILQ_HEAD(volume_list, volume_info);
76 TAILQ_ENTRY(cache_info) entry;
78 struct volume_info *volume;
79 struct buffer_info *buffer;
81 enum cache_type { ISVOLUME, ISBUFFER } type;
82 int refs; /* structural references */
83 int modified; /* ondisk modified flag */
84 int delete; /* delete flag - delete on last ref */
87 #define HAMMER_BUFLISTS 64
88 #define HAMMER_BUFLISTMASK (HAMMER_BUFLISTS - 1)
91 * These structures are used by newfs_hammer to track the filesystem
92 * buffers it constructs while building the filesystem. No attempt
93 * is made to try to make this efficient.
96 struct cache_info cache;
97 TAILQ_ENTRY(volume_info) entry;
99 hammer_off_t vol_alloc; /* volume-relative offset */
100 hammer_off_t vol_free_off; /* zone-2 offset */
101 hammer_off_t vol_free_end; /* zone-2 offset */
109 struct hammer_volume_ondisk *ondisk;
111 TAILQ_HEAD(, buffer_info) buffer_lists[HAMMER_BUFLISTS];
115 struct cache_info cache;
116 TAILQ_ENTRY(buffer_info) entry;
117 hammer_off_t buf_offset; /* full hammer offset spec */
118 int64_t raw_offset; /* physical offset */
119 int flags; /* origination flags */
120 int use_count; /* read count */
121 struct volume_info *volume;
126 struct softprune *next;
129 struct hammer_ioc_prune prune;
135 * Data structure for zone statistics.
138 int zone; /* zone index, not used */
139 hammer_off_t blocks; /* number of big-blocks */
140 hammer_off_t items; /* number of items */
141 hammer_off_t used; /* bytes used */
144 extern uuid_t Hammer_FSType;
145 extern uuid_t Hammer_FSId;
146 extern int64_t BootAreaSize;
147 extern int64_t MemAreaSize;
148 extern int64_t UndoBufferSize;
150 extern const char *ScoreBoardFile;
151 extern const char *RestrictTarget;
152 extern int RootVolNo;
153 extern struct volume_list VolList;
154 extern int UseReadBehind;
155 extern int UseReadAhead;
156 extern int AssertOnFailure;
158 uint32_t crc32(const void *buf, size_t size);
159 uint32_t crc32_ext(const void *buf, size_t size, uint32_t ocrc);
161 struct volume_info *setup_volume(int32_t vol_no, const char *filename,
162 int isnew, int oflags);
163 void check_volume(struct volume_info *vol);
164 struct volume_info *get_volume(int32_t vol_no);
165 struct buffer_info *get_buffer(hammer_off_t buf_offset, int isnew);
166 void *get_buffer_data(hammer_off_t buf_offset, struct buffer_info **bufferp,
168 hammer_node_ondisk_t get_node(hammer_off_t node_offset,
169 struct buffer_info **bufp);
171 void rel_volume(struct volume_info *volume);
172 void rel_buffer(struct buffer_info *buffer);
174 hammer_off_t alloc_bigblock(struct volume_info *volume, int zone);
175 void *alloc_blockmap(int zone, int bytes, hammer_off_t *result_offp,
176 struct buffer_info **bufferp);
177 hammer_off_t blockmap_lookup(hammer_off_t bmap_off,
178 struct hammer_blockmap_layer1 *layer1,
179 struct hammer_blockmap_layer2 *layer2,
181 void format_blockmap(hammer_blockmap_t blockmap, int zone, hammer_off_t offset);
182 void format_undomap(struct volume_info *root_vol);
184 void *alloc_btree_element(hammer_off_t *offp,
185 struct buffer_info **data_bufferp);
186 void *alloc_meta_element(hammer_off_t *offp, int32_t data_len,
187 struct buffer_info **data_bufferp);
188 void *alloc_data_element(hammer_off_t *offp, int32_t data_len,
189 struct buffer_info **data_bufferp);
191 int hammer_btree_cmp(hammer_base_elm_t key1, hammer_base_elm_t key2);
192 void hammer_key_beg_init(hammer_base_elm_t base);
193 void hammer_key_end_init(hammer_base_elm_t base);
194 int hammer_crc_test_leaf(void *data, hammer_btree_leaf_elm_t leaf);
196 void format_freemap(struct volume_info *root_vol);
197 int64_t initialize_freemap(struct volume_info *vol);
198 int64_t count_freemap(struct volume_info *vol);
200 void flush_all_volumes(void);
201 void flush_volume(struct volume_info *vol);
202 void flush_buffer(struct buffer_info *buf);
204 int64_t init_boot_area_size(int64_t value, off_t avg_vol_size);
205 int64_t init_mem_area_size(int64_t value, off_t avg_vol_size);
207 void hammer_cache_set(int bytes);
208 void hammer_cache_add(struct cache_info *cache, enum cache_type type);
209 void hammer_cache_del(struct cache_info *cache);
210 void hammer_cache_used(struct cache_info *cache);
211 void hammer_cache_flush(void);
213 void score_printf(size_t i, size_t w, const char *ctl, ...) __printflike(3, 4);
215 struct zone_stat *hammer_init_zone_stat(void);
216 struct zone_stat *hammer_init_zone_stat_bits(void);
217 void hammer_cleanup_zone_stat(struct zone_stat *stats);
218 void hammer_add_zone_stat(struct zone_stat *stats, hammer_off_t offset,
220 void hammer_add_zone_stat_layer2(struct zone_stat *stats,
221 struct hammer_blockmap_layer2 *layer2);
222 void hammer_print_zone_stat(const struct zone_stat *stats);
224 #endif /* !HAMMER_UTIL_H_ */