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 #include <sys/types.h>
37 #include <sys/queue.h>
39 #include <vfs/hammer/hammer_disk.h>
43 * Cache management - so the user code can keep its memory use under control
48 TAILQ_HEAD(volume_list, volume_info);
51 TAILQ_ENTRY(cache_info) entry;
53 struct volume_info *volume;
54 struct buffer_info *buffer;
56 enum cache_type { ISVOLUME, ISBUFFER } type;
57 int refs; /* structural references */
58 int modified; /* ondisk modified flag */
59 int delete; /* delete flag - delete on last ref */
62 #define HAMMER_BUFLISTS 64
63 #define HAMMER_BUFLISTMASK (HAMMER_BUFLISTS - 1)
66 * These structures are used by newfs_hammer to track the filesystem
67 * buffers it constructs while building the filesystem. No attempt
68 * is made to try to make this efficient.
71 struct cache_info cache;
72 TAILQ_ENTRY(volume_info) entry;
74 hammer_off_t vol_alloc; /* volume-relative offset */
75 hammer_off_t vol_free_off; /* zone-2 offset */
76 hammer_off_t vol_free_end; /* zone-2 offset */
84 struct hammer_volume_ondisk *ondisk;
86 TAILQ_HEAD(, buffer_info) buffer_lists[HAMMER_BUFLISTS];
90 struct cache_info cache;
91 TAILQ_ENTRY(buffer_info) entry;
92 hammer_off_t buf_offset; /* full hammer offset spec */
93 int64_t raw_offset; /* physical offset */
94 int flags; /* origination flags */
95 int use_count; /* read count */
96 struct volume_info *volume;
100 #define HAMMER_BUFINFO_READAHEAD 0x0001
102 extern uuid_t Hammer_FSType;
103 extern uuid_t Hammer_FSId;
104 extern int64_t BootAreaSize;
105 extern int64_t MemAreaSize;
106 extern int64_t UndoBufferSize;
108 extern const char *ScoreBoardFile;
109 extern const char *RestrictTarget;
110 extern int NumVolumes;
111 extern int RootVolNo;
112 extern struct volume_list VolList;
113 extern int UseReadBehind;
114 extern int UseReadAhead;
115 extern int AssertOnFailure;
117 uint32_t crc32(const void *buf, size_t size);
118 uint32_t crc32_ext(const void *buf, size_t size, uint32_t ocrc);
120 struct volume_info *setup_volume(int32_t vol_no, const char *filename,
121 int isnew, int oflags);
122 struct volume_info *get_volume(int32_t vol_no);
123 struct volume_info *test_volume(int32_t vol_no);
124 struct buffer_info *get_buffer(hammer_off_t buf_offset, int isnew);
125 void *get_buffer_data(hammer_off_t buf_offset, struct buffer_info **bufferp,
127 hammer_node_ondisk_t get_node(hammer_off_t node_offset,
128 struct buffer_info **bufp);
130 void rel_volume(struct volume_info *volume);
131 void rel_buffer(struct buffer_info *buffer);
133 hammer_off_t blockmap_lookup(hammer_off_t bmap_off,
134 struct hammer_blockmap_layer1 *layer1,
135 struct hammer_blockmap_layer2 *layer2,
137 void format_blockmap(hammer_blockmap_t blockmap, hammer_off_t zone_base);
138 void format_undomap(hammer_volume_ondisk_t ondisk);
140 void *alloc_btree_element(hammer_off_t *offp);
141 void *alloc_data_element(hammer_off_t *offp, int32_t data_len,
142 struct buffer_info **data_bufferp);
144 int hammer_btree_cmp(hammer_base_elm_t key1, hammer_base_elm_t key2);
145 void hammer_key_beg_init(hammer_base_elm_t base);
146 void hammer_key_end_init(hammer_base_elm_t base);
147 int hammer_crc_test_leaf(void *data, hammer_btree_leaf_elm_t leaf);
149 void format_freemap(struct volume_info *root_vol, hammer_blockmap_t blockmap);
150 int64_t initialize_freemap(struct volume_info *vol);
152 void flush_all_volumes(void);
153 void flush_volume(struct volume_info *vol);
154 void flush_buffer(struct buffer_info *buf);
156 void hammer_cache_set(int bytes);
157 void hammer_cache_add(struct cache_info *cache, enum cache_type type);
158 void hammer_cache_del(struct cache_info *cache);
159 void hammer_cache_used(struct cache_info *cache);
160 void hammer_cache_flush(void);
162 void score_printf(size_t i, size_t w, const char *ctl, ...) __printflike(3, 4);
164 void panic(const char *ctl, ...) __printflike(1, 2);