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 35 #ifndef HAMMER_UTIL_H_ 36 #define HAMMER_UTIL_H_ 37 38 #include <sys/types.h> 39 #include <sys/stat.h> 40 #include <sys/time.h> 41 #include <sys/tree.h> 42 #include <sys/queue.h> 43 #include <sys/mount.h> 44 45 #include <assert.h> 46 #include <stdio.h> 47 #include <stdlib.h> 48 #include <stdarg.h> 49 #include <string.h> 50 #include <unistd.h> 51 #include <stddef.h> 52 #include <err.h> 53 #include <errno.h> 54 #include <fcntl.h> 55 56 #include <vfs/hammer/hammer_disk.h> 57 #include <vfs/hammer/hammer_ioctl.h> 58 #include <uuid.h> 59 60 /* 61 * pidfile management - common definitions so code is more robust 62 */ 63 64 #define PIDFILE_BUFSIZE 64 65 static const char pidfile_loc[] = "/var/run"; 66 67 /* 68 * Cache management - so the user code can keep its memory use under control 69 */ 70 struct volume_info; 71 struct buffer_info; 72 73 TAILQ_HEAD(volume_list, volume_info); 74 75 struct cache_info { 76 TAILQ_ENTRY(cache_info) entry; 77 union { 78 struct volume_info *volume; 79 struct buffer_info *buffer; 80 } u; 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 */ 85 }; 86 87 #define HAMMER_BUFLISTS 64 88 #define HAMMER_BUFLISTMASK (HAMMER_BUFLISTS - 1) 89 90 /* 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. 94 */ 95 struct volume_info { 96 struct cache_info cache; 97 TAILQ_ENTRY(volume_info) entry; 98 int vol_no; 99 hammer_off_t vol_free_off; /* zone-2 offset */ 100 hammer_off_t vol_free_end; /* zone-2 offset */ 101 102 char *name; 103 int fd; 104 off_t size; 105 off_t device_offset; 106 const char *type; 107 108 struct hammer_volume_ondisk *ondisk; 109 110 TAILQ_HEAD(, buffer_info) buffer_lists[HAMMER_BUFLISTS]; 111 }; 112 113 struct buffer_info { 114 struct cache_info cache; 115 TAILQ_ENTRY(buffer_info) entry; 116 hammer_off_t buf_offset; /* full hammer offset spec */ 117 int64_t raw_offset; /* physical offset */ 118 int flags; /* origination flags */ 119 int use_count; /* read count */ 120 struct volume_info *volume; 121 void *ondisk; 122 }; 123 124 struct softprune { 125 struct softprune *next; 126 struct statfs fs; 127 char *filesystem; 128 struct hammer_ioc_prune prune; 129 int maxelms; 130 int prune_min; 131 }; 132 133 /* 134 * Data structure for zone statistics. 135 */ 136 struct zone_stat { 137 int zone; /* zone index, not used */ 138 hammer_off_t blocks; /* number of big-blocks */ 139 hammer_off_t items; /* number of items */ 140 hammer_off_t used; /* bytes used */ 141 }; 142 143 extern uuid_t Hammer_FSType; 144 extern uuid_t Hammer_FSId; 145 extern int64_t BootAreaSize; 146 extern int64_t MemAreaSize; 147 extern int64_t UndoBufferSize; 148 extern int DebugOpt; 149 extern const char *ScoreBoardFile; 150 extern const char *RestrictTarget; 151 extern int RootVolNo; 152 extern struct volume_list VolList; 153 extern int UseReadBehind; 154 extern int UseReadAhead; 155 extern int AssertOnFailure; 156 157 uint32_t crc32(const void *buf, size_t size); 158 uint32_t crc32_ext(const void *buf, size_t size, uint32_t ocrc); 159 160 struct volume_info *setup_volume(int32_t vol_no, const char *filename, 161 int isnew, int oflags); 162 void check_volume(struct volume_info *vol); 163 struct volume_info *get_volume(int32_t vol_no); 164 struct buffer_info *get_buffer(hammer_off_t buf_offset, int isnew); 165 void *get_buffer_data(hammer_off_t buf_offset, struct buffer_info **bufferp, 166 int isnew); 167 hammer_node_ondisk_t get_node(hammer_off_t node_offset, 168 struct buffer_info **bufp); 169 170 void rel_volume(struct volume_info *volume); 171 void rel_buffer(struct buffer_info *buffer); 172 173 hammer_off_t alloc_bigblock(struct volume_info *volume, int zone); 174 void *alloc_blockmap(int zone, int bytes, hammer_off_t *result_offp, 175 struct buffer_info **bufferp); 176 hammer_off_t blockmap_lookup(hammer_off_t bmap_off, 177 struct hammer_blockmap_layer1 *layer1, 178 struct hammer_blockmap_layer2 *layer2, 179 int *errorp); 180 void format_blockmap(hammer_blockmap_t blockmap, int zone, hammer_off_t offset); 181 void format_undomap(struct volume_info *root_vol); 182 183 void *alloc_btree_element(hammer_off_t *offp, 184 struct buffer_info **data_bufferp); 185 void *alloc_meta_element(hammer_off_t *offp, int32_t data_len, 186 struct buffer_info **data_bufferp); 187 void *alloc_data_element(hammer_off_t *offp, int32_t data_len, 188 struct buffer_info **data_bufferp); 189 190 int hammer_btree_cmp(hammer_base_elm_t key1, hammer_base_elm_t key2); 191 void hammer_key_beg_init(hammer_base_elm_t base); 192 void hammer_key_end_init(hammer_base_elm_t base); 193 int hammer_crc_test_leaf(void *data, hammer_btree_leaf_elm_t leaf); 194 195 void format_freemap(struct volume_info *root_vol); 196 int64_t initialize_freemap(struct volume_info *vol); 197 int64_t count_freemap(struct volume_info *vol); 198 199 void flush_all_volumes(void); 200 void flush_volume(struct volume_info *vol); 201 void flush_buffer(struct buffer_info *buf); 202 203 int64_t init_boot_area_size(int64_t value, off_t avg_vol_size); 204 int64_t init_mem_area_size(int64_t value, off_t avg_vol_size); 205 206 void hammer_cache_set(int bytes); 207 void hammer_cache_add(struct cache_info *cache, enum cache_type type); 208 void hammer_cache_del(struct cache_info *cache); 209 void hammer_cache_used(struct cache_info *cache); 210 void hammer_cache_flush(void); 211 212 void score_printf(size_t i, size_t w, const char *ctl, ...) __printflike(3, 4); 213 214 struct zone_stat *hammer_init_zone_stat(void); 215 struct zone_stat *hammer_init_zone_stat_bits(void); 216 void hammer_cleanup_zone_stat(struct zone_stat *stats); 217 void hammer_add_zone_stat(struct zone_stat *stats, hammer_off_t offset, 218 hammer_off_t bytes); 219 void hammer_add_zone_stat_layer2(struct zone_stat *stats, 220 struct hammer_blockmap_layer2 *layer2); 221 void hammer_print_zone_stat(const struct zone_stat *stats); 222 223 #endif /* !HAMMER_UTIL_H_ */ 224