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>
58 #include <vfs/hammer/hammer_crc.h>
62 TAILQ_ENTRY(cache_info) entry;
63 int refs; /* structural references */
64 int modified; /* ondisk modified flag */
65 int delete; /* delete flag - delete on last ref */
68 #define HAMMER_BUFLISTS 64
69 #define HAMMER_BUFLISTMASK (HAMMER_BUFLISTS - 1)
72 * These structures are used by hammer(8) and newfs_hammer(8)
73 * to track the filesystem buffers.
75 * vol_free_off and vol_free_end are zone-2 offsets.
76 * These two are initialized only when newly creating a filesystem.
79 TAILQ_ENTRY(volume_info) entry;
88 hammer_off_t vol_free_off;
89 hammer_off_t vol_free_end;
91 hammer_volume_ondisk_t ondisk;
93 TAILQ_HEAD(, buffer_info) buffer_lists[HAMMER_BUFLISTS];
97 struct cache_info cache; /* must be at offset 0 */
98 TAILQ_ENTRY(buffer_info) entry;
99 hammer_off_t zone2_offset; /* zone-2 offset */
100 int64_t raw_offset; /* physical offset */
101 struct volume_info *volume;
106 * Data structure for zone statistics.
109 int64_t blocks; /* number of big-blocks */
110 int64_t items; /* number of items */
111 int64_t used; /* bytes used */
114 extern uuid_t Hammer_FSType;
115 extern uuid_t Hammer_FSId;
116 extern int UseReadBehind;
117 extern int UseReadAhead;
119 extern const char *zone_labels[];
121 struct volume_info *init_volume(const char *filename, int oflags, int32_t vol_no);
122 struct volume_info *load_volume(const char *filename, int oflags, int verify);
123 void assert_volume_offset(struct volume_info *volume);
124 struct volume_info *get_volume(int32_t vol_no);
125 struct volume_info *get_root_volume(void);
126 void *get_buffer_data(hammer_off_t buf_offset, struct buffer_info **bufferp,
128 void rel_buffer(struct buffer_info *buffer);
130 hammer_off_t bootstrap_bigblock(struct volume_info *volume);
131 hammer_off_t alloc_undo_bigblock(struct volume_info *volume);
132 void *alloc_blockmap(int zone, int bytes, hammer_off_t *result_offp,
133 struct buffer_info **bufferp);
134 hammer_off_t blockmap_lookup(hammer_off_t bmap_off, int *errorp);
135 hammer_off_t blockmap_lookup_save(hammer_off_t bmap_off,
136 hammer_blockmap_layer1_t layer1,
137 hammer_blockmap_layer2_t layer2,
139 void format_undomap(struct volume_info *root_vol, int64_t *undo_buffer_size);
141 hammer_node_ondisk_t alloc_btree_node(hammer_off_t *offp,
142 struct buffer_info **data_bufferp);
143 void *alloc_meta_element(hammer_off_t *offp, int32_t data_len,
144 struct buffer_info **data_bufferp);
146 void format_blockmap(struct volume_info *root_vol, int zone, hammer_off_t offset);
147 void format_freemap(struct volume_info *root_vol);
148 int64_t initialize_freemap(struct volume_info *volume);
149 int64_t count_freemap(struct volume_info *volume);
150 void print_blockmap(const struct volume_info *volume);
152 void flush_all_volumes(void);
153 void flush_volume(struct volume_info *volume);
154 void flush_buffer(struct buffer_info *buffer);
156 int64_t init_boot_area_size(int64_t value, off_t avg_vol_size);
157 int64_t init_memory_log_size(int64_t value, off_t avg_vol_size);
159 int hammer_parse_cache_size(const char *arg);
160 void hammer_cache_add(struct cache_info *cache);
161 void hammer_cache_del(struct cache_info *cache);
162 void hammer_cache_used(struct cache_info *cache);
163 void hammer_cache_flush(void);
165 void hammer_key_beg_init(hammer_base_elm_t base);
166 void hammer_key_end_init(hammer_base_elm_t base);
168 const char *sizetostr(off_t size);
169 int hammer_fs_to_vol(const char *fs, struct hammer_ioc_volume_list *iocp);
170 int hammer_fs_to_rootvol(const char *fs, char *buf, int len);
172 struct zone_stat *hammer_init_zone_stat(void);
173 struct zone_stat *hammer_init_zone_stat_bits(void);
174 void hammer_cleanup_zone_stat(struct zone_stat *stats);
175 void hammer_add_zone_stat(struct zone_stat *stats, hammer_off_t offset,
177 void hammer_add_zone_stat_layer2(struct zone_stat *stats,
178 hammer_blockmap_layer2_t layer2);
179 void hammer_print_zone_stat(const struct zone_stat *stats);
181 #define hwarn(format, args...) warn("WARNING: "format,## args)
182 #define hwarnx(format, args...) warnx("WARNING: "format,## args)
184 #endif /* !HAMMER_UTIL_H_ */